How to fix messaging/invalid-argument: Invalid method parameters in Firebase

// Correct usage for messaging.send()
const messaging = admin.messaging();

// Method signature: send(message: Message, dryRun?: boolean): Promise<string>
const message = {
  token: registrationToken,
  notification: {
    title: 'Notification Title',
    body: 'Notification Body'
  }
};

// Correct call
const response = await messaging.send(message);

// Common incorrect calls that cause this error:
// await messaging.send(); // Missing required parameter
// await messaging.send('token-string'); // Wrong parameter type (string instead of object)
// await messaging.send({}); // Missing required fields in message object

// TypeScript example with proper typing
import * as admin from 'firebase-admin';

interface Message {
  token: string;
  notification?: {
    title: string;
    body: string;
  };
  data?: Record<string, string>;
  // ... other fields
}

const message: Message = {
  token: registrationToken,
  notification: {
    title: 'Test Title',
    body: 'Test Body'
  }
};

// JavaScript validation example
function validateMessage(message) {
  if (!message || typeof message !== 'object') {
    throw new Error('Message must be an object');
  }

  if (!message.token || typeof message.token !== 'string') {
    throw new Error('Message must have a string token field');
  }

  if (message.notification) {
    if (!message.notification.title || !message.notification.body) {
      throw new Error('Notification must have title and body fields');
    }
  }

  return true;
}

// Validate before sending
validateMessage(message);
const response = await messaging.send(message);

// Old deprecated signature (example)
// messaging.sendToDevice(token, payload, options)

// New signature
// messaging.send(message)

// Migration example:
// OLD (deprecated):
// messaging.sendToDevice(token, { notification: { title: 'Hello' } }, { priority: 'high' });

// NEW:
const message = {
  token: token,
  notification: { title: 'Hello' },
  android: { priority: 'high' }
};
await messaging.send(message);

// Check the Firebase Admin SDK release notes:
// https://github.com/firebase/firebase-admin-node/releases

// Common breaking changes:
// - Method signature changes
// - Parameter renaming
// - New required fields
// - Changed return types

// Minimal valid message for testing
const testMessage = {
  token: 'test-token-here', // Use a valid test token
  notification: {
    title: 'Test',
    body: 'Test message'
  }
};

try {
  console.log('Testing with minimal message:', JSON.stringify(testMessage, null, 2));
  const response = await messaging.send(testMessage);
  console.log('Success! Response:', response);
} catch (error) {
  console.error('Error with minimal message:', error.message);
  console.error('Full error:', error);

  // Check if it's the "invalid method parameters" error
  if (error.code === 'messaging/invalid-argument' &&
      error.message.includes('Invalid method parameters')) {
    console.error('This confirms the issue is with method parameters, not the message content');
  }
}

// If minimal works, gradually add your original parameters back
// to identify which specific parameter causes the error
const originalMessage = { /* your original message */ };

// Add fields one by one
const testMessage2 = {
  token: testMessage.token,
  notification: testMessage.notification
  // Add one field from originalMessage at a time
};

// Test each variation to isolate the problematic parameter

// Enable Firebase Admin SDK debug logging
process.env.DEBUG = 'firebase-admin:*';

// Or enable Node.js debug for specific modules
process.env.DEBUG = 'firebase-admin:messaging';

// Reinitialize after setting DEBUG
const admin = require('firebase-admin');
admin.initializeApp({ /* config */ });

// Check the SDK source for validation logic
// The error often comes from parameter validation in:
// - node_modules/firebase-admin/lib/messaging/messaging.js
// - node_modules/firebase-admin/lib/messaging/messaging-api-request.js

// You can also add your own validation before calling the SDK:
function validateSendParameters(message, dryRun) {
  // Check parameter count
  if (arguments.length < 1) {
    throw new Error('messaging.send() requires at least 1 argument');
  }

  // Check message type
  if (!message || typeof message !== 'object') {
    throw new Error('First parameter must be a message object');
  }

  // Check dryRun type if provided
  if (dryRun !== undefined && typeof dryRun !== 'boolean') {
    throw new Error('Second parameter (dryRun) must be a boolean if provided');
  }

  return true;
}

// Use before calling the SDK method
validateSendParameters(message, dryRun);
const response = await messaging.send(message, dryRun);