Adding X-Firebase-Client header to rules API calls (#651)

* Adding X-Firebase-Client header to Rules API calls

* Removed test resources

Author: hiranya911

src/security-rules/security-rules-api-client.ts

@@ -20,6 +20,9 @@ import { FirebaseSecurityRulesError, SecurityRulesErrorCode } from './security-r
 import * as validator from '../utils/validator';
 
 const RULES_V1_API = 'https://firebaserules.googleapis.com/v1';
+const FIREBASE_VERSION_HEADER = {
+  'X-Firebase-Client': 'fire-admin-node/<XXX_SDK_VERSION_XXX>',
+};
 
 export interface Release {
   readonly name: string;
@@ -30,7 +33,7 @@ export interface Release {
 
 export interface RulesetContent {
   readonly source: {
-    readonly files: Array<{name: string, content: string}>;
+    readonly files: Array<{ name: string, content: string }>;
   };
 }
 
@@ -40,7 +43,7 @@ export interface RulesetResponse extends RulesetContent {
 }
 
 export interface ListRulesetsResponse {
-  readonly rulesets: Array<{name: string, createTime: string}>;
+  readonly rulesets: Array<{ name: string, createTime: string }>;
   readonly nextPageToken?: string;
 }
 
@@ -64,8 +67,8 @@ export class SecurityRulesApiClient {
       throw new FirebaseSecurityRulesError(
         'invalid-argument',
         'Failed to determine project ID. Initialize the SDK with service account credentials, or '
-          + 'set project ID as an app option. Alternatively, set the GOOGLE_CLOUD_PROJECT '
-          + 'environment variable.');
+        + 'set project ID as an app option. Alternatively, set the GOOGLE_CLOUD_PROJECT '
+        + 'environment variable.');
     }
 
     this.projectIdPrefix = `projects/${projectId}`;
@@ -209,6 +212,7 @@ export class SecurityRulesApiClient {
   }
 
   private sendRequest<T>(request: HttpRequestConfig): Promise<T> {
+    request.headers = FIREBASE_VERSION_HEADER;
     return this.httpClient.send(request)
       .then((resp) => {
         return resp.data as T;
@@ -247,7 +251,7 @@ interface Error {
   status?: string;
 }
 
-const ERROR_CODE_MAPPING: {[key: string]: SecurityRulesErrorCode} = {
+const ERROR_CODE_MAPPING: { [key: string]: SecurityRulesErrorCode } = {
   INVALID_ARGUMENT: 'invalid-argument',
   NOT_FOUND: 'not-found',
   RESOURCE_EXHAUSTED: 'resource-exhausted',

test/unit/security-rules/security-rules-api-client.spec.ts

@@ -38,6 +38,9 @@ describe('SecurityRulesApiClient', () => {
       status: 'NOT_FOUND',
     },
   };
+  const EXPECTED_HEADERS = {
+    'X-Firebase-Client': 'fire-admin-node/<XXX_SDK_VERSION_XXX>',
+  };
 
   const apiClient: SecurityRulesApiClient = new SecurityRulesApiClient(
     new HttpClient(), 'test-project');
@@ -87,14 +90,15 @@ describe('SecurityRulesApiClient', () => {
     it('should resolve with the requested ruleset on success', () => {
       const stub = sinon
         .stub(HttpClient.prototype, 'send')
-        .resolves(utils.responseFrom({name: 'bar'}));
+        .resolves(utils.responseFrom({ name: 'bar' }));
       stubs.push(stub);
       return apiClient.getRuleset(RULESET_NAME)
         .then((resp) => {
           expect(resp.name).to.equal('bar');
           expect(stub).to.have.been.calledOnce.and.calledWith({
             method: 'GET',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/rulesets/ruleset-id',
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -153,7 +157,7 @@ describe('SecurityRulesApiClient', () => {
       },
     };
 
-    const invalidContent: any[] = [null, undefined, {}, {source: {}}];
+    const invalidContent: any[] = [null, undefined, {}, { source: {} }];
     invalidContent.forEach((content) => {
       it(`should reject when called with: ${JSON.stringify(content)}`, () => {
         return apiClient.createRuleset(content)
@@ -162,7 +166,7 @@ describe('SecurityRulesApiClient', () => {
       });
     });
 
-    const invalidFiles: any[] = [null, undefined, 'test', {}, {name: 'test'}, {content: 'test'}];
+    const invalidFiles: any[] = [null, undefined, 'test', {}, { name: 'test' }, { content: 'test' }];
     invalidFiles.forEach((file) => {
       it(`should reject when called with: ${JSON.stringify(file)}`, () => {
         const ruleset: RulesetContent = {
@@ -190,7 +194,7 @@ describe('SecurityRulesApiClient', () => {
     it('should resolve with the created resource on success', () => {
       const stub = sinon
         .stub(HttpClient.prototype, 'send')
-        .resolves(utils.responseFrom({name: 'some-name', ...RULES_CONTENT}));
+        .resolves(utils.responseFrom({ name: 'some-name', ...RULES_CONTENT }));
       stubs.push(stub);
       return apiClient.createRuleset(RULES_CONTENT)
         .then((resp) => {
@@ -200,6 +204,7 @@ describe('SecurityRulesApiClient', () => {
             method: 'POST',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/rulesets',
             data: RULES_CONTENT,
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -312,7 +317,8 @@ describe('SecurityRulesApiClient', () => {
           expect(stub).to.have.been.calledOnce.and.calledWith({
             method: 'GET',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/rulesets',
-            data: {pageSize: 100},
+            data: { pageSize: 100 },
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -328,7 +334,8 @@ describe('SecurityRulesApiClient', () => {
           expect(stub).to.have.been.calledOnce.and.calledWith({
             method: 'GET',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/rulesets',
-            data: {pageSize: 50},
+            data: { pageSize: 50 },
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -344,7 +351,8 @@ describe('SecurityRulesApiClient', () => {
           expect(stub).to.have.been.calledOnce.and.calledWith({
             method: 'GET',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/rulesets',
-            data: {pageSize: 50, pageToken: 'next'},
+            data: { pageSize: 50, pageToken: 'next' },
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -395,14 +403,15 @@ describe('SecurityRulesApiClient', () => {
     it('should resolve with the requested release on success', () => {
       const stub = sinon
         .stub(HttpClient.prototype, 'send')
-        .resolves(utils.responseFrom({name: 'bar'}));
+        .resolves(utils.responseFrom({ name: 'bar' }));
       stubs.push(stub);
       return apiClient.getRelease(RELEASE_NAME)
         .then((resp) => {
           expect(resp.name).to.equal('bar');
           expect(stub).to.have.been.calledOnce.and.calledWith({
             method: 'GET',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/releases/test.service',
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -453,7 +462,7 @@ describe('SecurityRulesApiClient', () => {
     it('should resolve with the updated release on success', () => {
       const stub = sinon
         .stub(HttpClient.prototype, 'send')
-        .resolves(utils.responseFrom({name: 'bar'}));
+        .resolves(utils.responseFrom({ name: 'bar' }));
       stubs.push(stub);
       return apiClient.updateRelease(RELEASE_NAME, RULESET_NAME)
         .then((resp) => {
@@ -467,6 +476,7 @@ describe('SecurityRulesApiClient', () => {
                 rulesetName: 'projects/test-project/rulesets/ruleset-id',
               },
             },
+            headers: EXPECTED_HEADERS,
           });
         });
     });
@@ -539,6 +549,7 @@ describe('SecurityRulesApiClient', () => {
           expect(stub).to.have.been.calledOnce.and.calledWith({
             method: 'DELETE',
             url: 'https://firebaserules.googleapis.com/v1/projects/test-project/rulesets/ruleset-id',
+            headers: EXPECTED_HEADERS,
           });
         });
     });