Adding common headers to all sub requests in FCM batch API (#492)

* Adding common headers to all sub requests in FCM batch API

* Adding the access_token_auth header back

* Minor variable rename

Author: hiranya911

src/messaging/batch-request.ts

@@ -59,6 +59,10 @@ export class BatchRequestClient {
    * @return {Promise<HttpResponse[]>} A promise that resolves when the send operation is complete.
    */
   public send(requests: SubRequest[]): Promise<HttpResponse[]> {
+    requests = requests.map((req) => {
+      req.headers = Object.assign({}, this.commonHeaders, req.headers);
+      return req;
+    });
     const requestHeaders = {
       'Content-Type': `multipart/mixed; boundary=${PART_BOUNDARY}`,
     };

src/messaging/messaging-api-request.ts

@@ -28,6 +28,9 @@ const FIREBASE_MESSAGING_BATCH_URL = 'https://fcm.googleapis.com/batch';
 const FIREBASE_MESSAGING_HTTP_METHOD: HttpMethod = 'POST';
 const FIREBASE_MESSAGING_HEADERS = {
   'X-Firebase-Client': 'fire-admin-node/<XXX_SDK_VERSION_XXX>',
+};
+const LEGACY_FIREBASE_MESSAGING_HEADERS = {
+  'X-Firebase-Client': 'fire-admin-node/<XXX_SDK_VERSION_XXX>',
   'access_token_auth': 'true',
 };
 
@@ -62,7 +65,7 @@ export class FirebaseMessagingRequestHandler {
       method: FIREBASE_MESSAGING_HTTP_METHOD,
       url: `https://${host}${path}`,
       data: requestData,
-      headers: FIREBASE_MESSAGING_HEADERS,
+      headers: LEGACY_FIREBASE_MESSAGING_HEADERS,
       timeout: FIREBASE_MESSAGING_TIMEOUT,
     };
     return this.httpClient.send(request).then((response) => {

test/unit/messaging/batch-requests.spec.ts

@@ -169,12 +169,13 @@ describe('BatchRequestClient', () => {
     }
   });
 
-  it('should add common headers to the batch requests', async () => {
+  it('should add common headers to the parent and sub requests in a batch', async () => {
     const stub = sinon.stub(httpClient, 'send').resolves(
       createMultipartResponse([responseObject]));
     stubs.push(stub);
     const requests: SubRequest[] = [
       {url: 'https://example.com', body: {foo: 1}},
+      {url: 'https://example.com', body: {foo: 2}},
     ];
     const commonHeaders = {'X-Custom-Header': 'value'};
     const batch = new BatchRequestClient(httpClient, batchUrl, commonHeaders);
@@ -185,9 +186,39 @@ describe('BatchRequestClient', () => {
     expect(stub).to.have.been.calledOnce;
     const args: HttpRequestConfig = stub.getCall(0).args[0];
     expect(args.headers).to.have.property('X-Custom-Header', 'value');
+
+    const parsedRequest = parseHttpRequest(args.data as Buffer);
+    expect(parsedRequest.multipart.length).to.equal(requests.length);
+    parsedRequest.multipart.forEach((sub: {body: Buffer}) => {
+      const parsedSubRequest: {headers: object} = parseHttpRequest(sub.body.toString().trim());
+      expect(parsedSubRequest.headers).to.have.property('X-Custom-Header', 'value');
+    });
   });
 
   it('should add sub request headers to the payload', async () => {
+    const stub = sinon.stub(httpClient, 'send').resolves(
+      createMultipartResponse([responseObject]));
+    stubs.push(stub);
+    const requests: SubRequest[] = [
+      {url: 'https://example.com', body: {foo: 1}, headers: {'X-Custom-Header': 'value'}},
+      {url: 'https://example.com', body: {foo: 1}, headers: {'X-Custom-Header': 'value'}},
+    ];
+    const batch = new BatchRequestClient(httpClient, batchUrl);
+
+    const responses: HttpResponse[] = await batch.send(requests);
+
+    expect(responses.length).to.equal(1);
+    expect(stub).to.have.been.calledOnce;
+    const args: HttpRequestConfig = stub.getCall(0).args[0];
+    const parsedRequest = parseHttpRequest(args.data as Buffer);
+    expect(parsedRequest.multipart.length).to.equal(requests.length);
+    parsedRequest.multipart.forEach((sub: {body: Buffer}) => {
+      const parsedSubRequest: {headers: object} = parseHttpRequest(sub.body.toString().trim());
+      expect(parsedSubRequest.headers).to.have.property('X-Custom-Header', 'value');
+    });
+  });
+
+  it('sub request headers should get precedence', async () => {
     const stub = sinon.stub(httpClient, 'send').resolves(
       createMultipartResponse([responseObject]));
     stubs.push(stub);