Move functionality from #load to #set

Author: trekforever

etc/firebase-admin.remote-config.api.md

@@ -176,7 +176,8 @@ export type ServerConfig = {
 // @public
 export interface ServerTemplate {
     evaluate(context?: EvaluationContext): ServerConfig;
-    load(template?: ServerTemplateData | string): Promise<void>;
+    load(): Promise<void>;
+    set(template: ServerTemplateData | string): void;
     // (undocumented)
     toJSON(): ServerTemplateData;
 }

src/remote-config/remote-config-api.ts

@@ -390,11 +390,17 @@ export interface ServerTemplate {
    */
   evaluate(context?: EvaluationContext): ServerConfig;
 
+  /**
+   * Sets and caches a {@link ServerTemplateData} or a JSON string representing
+   * the server template
+   */
+  set(template: ServerTemplateData | string): void;
+
   /**
    * Fetches and caches the current active version of the
    * project's {@link ServerTemplate}.
    */
-  load(template?: ServerTemplateData | string): Promise<void>;
+  load(): Promise<void>;
 
   /**
    * @returns JSON representation of {@link ServerTemplateData}

src/remote-config/remote-config.ts

@@ -322,32 +322,34 @@ class ServerTemplateImpl implements ServerTemplate {
   }
 
   /**
-   * Fetches and caches the current active version of the project's {@link ServerTemplate}.
+   * Takes in either a {@link ServerTemplateData} or a JSON string
+   * representing the template, parses it, and caches it.
    */
-  public load(template?: ServerTemplateData | string): Promise<void> {
-    if (template) {
-      // Check and instantiates the template via a json string
-      if (isString(template)) {
-        try {
-          this.cache = new ServerTemplateDataImpl(JSON.parse(template));
-        } catch (e) {
-          throw new FirebaseRemoteConfigError(
-            'invalid-argument',
-            `Failed to parse the JSON string: ${template}. ` + e
-          );
-        }
-      } else {
-        this.cache = template;
+  public set(template: ServerTemplateData | string): void {
+    if (isString(template)) {
+      try {
+        this.cache = new ServerTemplateDataImpl(JSON.parse(template));
+      } catch (e) {
+        throw new FirebaseRemoteConfigError(
+          'invalid-argument',
+          `Failed to parse the JSON string: ${template}. ` + e
+        );
       }
-      return Promise.resolve();
     } else {
-      return this.apiClient.getServerTemplate()
-        .then((template) => {
-          this.cache = new ServerTemplateDataImpl(template);
-        });
+      this.cache = template;
     }
   }
 
+  /**
+   * Fetches and caches the current active version of the project's {@link ServerTemplate}.
+   */
+  public load(): Promise<void> {
+    return this.apiClient.getServerTemplate()
+      .then((template) => {
+        this.cache = new ServerTemplateDataImpl(template);
+      });
+  }
+
   /**
    * Evaluates the current template in cache to produce a {@link ServerConfig}.
    */

test/unit/remote-config/remote-config.spec.ts

@@ -752,8 +752,7 @@ describe('RemoteConfig', () => {
       }
     };
 
-    describe('load', () => {
-      const operationName = 'getServerTemplate';
+    describe('set', () => {
       const INVALID_PARAMETERS: any[] = [null, '', 'abc', 1, true, []];
       const INVALID_CONDITIONS: any[] = [null, '', 'abc', 1, true, {}];
       let sourceTemplate = deepCopy(SERVER_REMOTE_CONFIG_RESPONSE);
@@ -770,7 +769,7 @@ describe('RemoteConfig', () => {
           }
         };
         const initializedTemplate = remoteConfig.initServerTemplate();
-        initializedTemplate.load(template);
+        initializedTemplate.set(template);
         const parsed = initializedTemplate.toJSON();
         const expectedVersion = deepCopy(VERSION_INFO);
         expectedVersion.updateTime = new Date(expectedVersion.updateTime).toUTCString();
@@ -791,7 +790,7 @@ describe('RemoteConfig', () => {
         };
         const templateJson = JSON.stringify(template);
         const initializedTemplate = remoteConfig.initServerTemplate();
-        initializedTemplate.load(templateJson);
+        initializedTemplate.set(templateJson);
         const parsed = initializedTemplate.toJSON();
         const expectedVersion = deepCopy(VERSION_INFO);
         expectedVersion.updateTime = new Date(expectedVersion.updateTime).toUTCString();
@@ -802,7 +801,7 @@ describe('RemoteConfig', () => {
       it('should throw if template is an invalid JSON', () => {
         const jsonString = '{invalidJson: null}';
         const initializedTemplate = remoteConfig.initServerTemplate();
-        expect(() => initializedTemplate.load(jsonString))
+        expect(() => initializedTemplate.set(jsonString))
           .to.throw(/Failed to parse the JSON string: ([\D\w]*)\./);
       });
 
@@ -811,7 +810,7 @@ describe('RemoteConfig', () => {
         it(`should throw if the parameters is ${JSON.stringify(invalidParameter)}`, () => {
           const jsonString = JSON.stringify(sourceTemplate);
           const initializedTemplate = remoteConfig.initServerTemplate();
-          expect(() => initializedTemplate.load(jsonString))
+          expect(() => initializedTemplate.set(jsonString))
             .to.throw(/Failed to parse the JSON string: ([\D\w]*)\./);
         });
       });
@@ -822,11 +821,16 @@ describe('RemoteConfig', () => {
         it(`should throw if the conditions is ${JSON.stringify(invalidConditions)}`, () => {
           const jsonString = JSON.stringify(sourceTemplate);
           const initializedTemplate = remoteConfig.initServerTemplate();
-          expect(() => initializedTemplate.load(jsonString))
+          expect(() => initializedTemplate.set(jsonString))
             .to.throw(/Failed to parse the JSON string: ([\D\w]*)\./);
         });
       });
 
+    });
+
+    describe('load', () => {
+      const operationName = 'getServerTemplate';
+
       it('should propagate API errors', () => {
         const stub = sinon
           .stub(RemoteConfigApiClient.prototype, operationName)
@@ -1248,7 +1252,7 @@ describe('RemoteConfig', () => {
           },
         }
 
-        template.load(response as ServerTemplateData);
+        template.set(response as ServerTemplateData);
 
         let config = template.evaluate();
 
@@ -1263,7 +1267,7 @@ describe('RemoteConfig', () => {
           },
         }
 
-        template.load(response as ServerTemplateData);
+        template.set(response as ServerTemplateData);
 
         config = template.evaluate();