adding in tests & fixing remote config tsdoc strings

Author: colerogers

spec/v2/providers/testLab.spec.ts

@@ -0,0 +1,74 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2022 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import { expect } from "chai";
+import * as testLab from "../../../src/v2/providers/testLab";
+import * as options from "../../../src/v2/options";
+
+describe("onTestMatrixCompleted", () => {
+  afterEach(() => {
+    options.setGlobalOptions({});
+  });
+
+  it("should create a function with a handler", () => {
+    const fn = testLab.onTestMatrixCompleted(() => 2);
+
+    expect(fn.__endpoint).to.deep.eq({
+      platform: "gcfv2",
+      labels: {},
+      eventTrigger: {
+        eventType: testLab.eventType,
+        eventFilters: {},
+        retry: false,
+      },
+    });
+    expect(fn.run(1 as any)).to.eq(2);
+  });
+
+  it("should create a function with opts and a handler", () => {
+    options.setGlobalOptions({
+      memory: "512MiB",
+      region: "us-west1",
+    });
+
+    const fn = testLab.onTestMatrixCompleted(
+      {
+        region: "us-central1",
+        retry: true,
+      },
+      () => 2
+    );
+
+    expect(fn.__endpoint).to.deep.eq({
+      platform: "gcfv2",
+      availableMemoryMb: 512,
+      region: ["us-central1"],
+      labels: {},
+      eventTrigger: {
+        eventType: testLab.eventType,
+        eventFilters: {},
+        retry: true,
+      },
+    });
+    expect(fn.run(1 as any)).to.eq(2);
+  });
+});

src/v2/providers/remoteConfig.ts

@@ -27,61 +27,61 @@ import { EventHandlerOptions, getGlobalOptions, optionsToEndpoint } from "../opt
 /** @internal */
 export const eventType = "google.firebase.remoteconfig.remoteConfig.v1.updated";
 
-/* All the fields associated with the person/service account that wrote a Remote Config template. */
+/** All the fields associated with the person/service account that wrote a Remote Config template. */
 export interface ConfigUser {
-  /* Display name. */
+  /** Display name. */
   name: string;
 
-  /* Email address. */
+  /** Email address. */
   email: string;
 
-  /* Image URL. */
+  /** Image URL. */
   imageUrl: string;
 }
 
-/* What type of update was associated with the Remote Config template version. */
+/** What type of update was associated with the Remote Config template version. */
 export type ConfigUpdateOrigin =
-  /* Catch-all for unrecognized values. */
+  /** Catch-all for unrecognized values. */
   | "REMOTE_CONFIG_UPDATE_ORIGIN_UNSPECIFIED"
-  /* The update came from the Firebase UI. */
+  /** The update came from the Firebase UI. */
   | "CONSOLE"
-  /* The update came from the Remote Config REST API. */
+  /** The update came from the Remote Config REST API. */
   | "REST_API"
-  /* The update came from the Firebase Admin Node SDK. */
+  /** The update came from the Firebase Admin Node SDK. */
   | "ADMIN_SDK_NODE";
 
-/* Where the Remote Config update action originated. */
+/** Where the Remote Config update action originated. */
 export type ConfigUpdateType =
-  /* Catch-all for unrecognized enum values */
+  /** Catch-all for unrecognized enum values */
   | "REMOTE_CONFIG_UPDATE_TYPE_UNSPECIFIED"
-  /* A regular incremental update */
+  /** A regular incremental update */
   | "INCREMENTAL_UPDATE"
-  /* A forced update. The ETag was specified as "*" in an UpdateRemoteConfigRequest request or the "Force Update" button was pressed on the console */
+  /** A forced update. The ETag was specified as "*" in an UpdateRemoteConfigRequest request or the "Force Update" button was pressed on the console */
   | "FORCED_UPDATE"
-  /* A rollback to a previous Remote Config template */
+  /** A rollback to a previous Remote Config template */
   | "ROLLBACK";
 
-/* The data within Firebase Remote Config update events. */
+/** The data within Firebase Remote Config update events. */
 export interface ConfigUpdateData {
-  /* The version number of the version's corresponding Remote Config template. */
+  /** The version number of the version's corresponding Remote Config template. */
   versionNumber: number;
 
-  /* When the Remote Config template was written to the Remote Config server. */
+  /** When the Remote Config template was written to the Remote Config server. */
   updateTime: string;
 
-  /* Aggregation of all metadata fields about the account that performed the update. */
+  /** Aggregation of all metadata fields about the account that performed the update. */
   updateUser: ConfigUser;
 
-  /* The user-provided description of the corresponding Remote Config template. */
+  /** The user-provided description of the corresponding Remote Config template. */
   description: string;
 
-  /* Where the update action originated. */
+  /** Where the update action originated. */
   updateOrigin: ConfigUpdateOrigin;
 
-  /* What type of update was made. */
+  /** What type of update was made. */
   updateType: ConfigUpdateType;
 
-  /* Only present if this version is the result of a rollback, and will be the version number of the Remote Config template that was rolled-back to. */
+  /** Only present if this version is the result of a rollback, and will be the version number of the Remote Config template that was rolled-back to. */
   rollbackSource: number;
 }