Add startup lifecycle hook (#1531)

* checkpoint

* Finish missing tests; remove redundant v1 tests

* Fix linter error

* Fix import error

* Add changelog; fix exports of v2/core

Author: inlined

CHANGELOG.md

@@ -0,0 +1 @@
+Add onInit callback function for global variable initialization (#1531)

package.json

@@ -110,6 +110,9 @@
       "v2": [
         "lib/v2"
       ],
+      "v2/core": [
+        "lib/v2/core"
+      ],
       "v2/alerts": [
         "lib/v2/providers/alerts"
       ],
@@ -250,4 +253,4 @@
   "engines": {
     "node": ">=14.10.0"
   }
-}
+}

spec/v1/cloud-functions.spec.ts

@@ -23,6 +23,7 @@
 import { expect } from "chai";
 
 import {
+  onInit,
   Event,
   EventContext,
   makeCloudFunction,
@@ -41,6 +42,34 @@ describe("makeCloudFunction", () => {
     legacyEventType: "providers/provider/eventTypes/event",
   };
 
+  it("calls init function", async () => {
+    const test: Event = {
+      context: {
+        eventId: "00000",
+        timestamp: "2016-11-04T21:29:03.496Z",
+        eventType: "provider.event",
+        resource: {
+          service: "provider",
+          name: "resource",
+        },
+      },
+      data: "data",
+    };
+    const cf = makeCloudFunction({
+      provider: "mock.provider",
+      eventType: "mock.event",
+      service: "service",
+      triggerResource: () => "resource",
+      handler: () => null,
+    });
+
+    let hello;
+    onInit(() => (hello = "world"));
+    expect(hello).is.undefined;
+    await cf(test.data, test.context);
+    expect(hello).equals("world");
+  });
+
   it("should put a __trigger/__endpoint on the returned CloudFunction", () => {
     const cf = makeCloudFunction({
       provider: "mock.provider",

spec/v1/providers/analytics.spec.ts

@@ -85,7 +85,7 @@ describe("Analytics Functions", () => {
     });
 
     describe("#dataConstructor", () => {
-      it("should handle an event with the appropriate fields", () => {
+      it("should handle an event with the appropriate fields", async () => {
         const cloudFunction = analytics
           .event("first_open")
           .onLog((data: analytics.AnalyticsEvent) => data);
@@ -109,7 +109,7 @@ describe("Analytics Functions", () => {
           },
         };
 
-        return expect(cloudFunction(event.data, event.context)).to.eventually.deep.equal({
+        await expect(cloudFunction(event.data, event.context)).to.eventually.deep.equal({
           params: {},
           user: {
             userId: "hi!",

spec/v1/providers/https.spec.ts

@@ -35,6 +35,7 @@ import {
 import { runHandler } from "../../helper";
 import { MINIMAL_V1_ENDPOINT } from "../../fixtures";
 import { CALLABLE_AUTH_HEADER, ORIGINAL_AUTH_HEADER } from "../../../src/common/providers/https";
+import { onInit } from "../../../src/v1";
 
 describe("CloudHttpsBuilder", () => {
   describe("#onRequest", () => {
@@ -70,6 +71,26 @@ describe("CloudHttpsBuilder", () => {
       expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90);
       expect(fn.__endpoint.httpsTrigger.invoker).to.deep.equal(["private"]);
     });
+
+    it("calls init function", async () => {
+      let hello;
+      onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      const fn = functions.https.onRequest((_req, res) => {
+        res.send(200);
+      });
+      const req = new MockRequest(
+        {
+          data: { foo: "bar" },
+        },
+        {
+          "content-type": "application/json",
+        }
+      );
+      req.method = "POST";
+      await runHandler(fn, req as any);
+      expect(hello).to.equal("world");
+    });
   });
 });
 
@@ -114,7 +135,7 @@ describe("#onCall", () => {
     expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90);
   });
 
-  it("has a .run method", () => {
+  it("has a .run method", async () => {
     const cf = https.onCall((d, c) => {
       return { data: d, context: c };
     });
@@ -127,7 +148,8 @@ describe("#onCall", () => {
         token: "token",
       },
     };
-    expect(cf.run(data, context)).to.deep.equal({ data, context });
+
+    await expect(cf.run(data, context)).to.eventually.deep.equal({ data, context });
   });
 
   // Regression test for firebase-functions#947
@@ -152,6 +174,25 @@ describe("#onCall", () => {
     expect(gotData).to.deep.equal({ foo: "bar" });
   });
 
+  it("should call initializer", async () => {
+    const func = https.onCall(() => null);
+    const req = new MockRequest(
+      {
+        data: {},
+      },
+      {
+        "content-type": "application/json",
+      }
+    );
+    req.method = "POST";
+
+    let hello;
+    onInit(() => (hello = "world"));
+    expect(hello).to.be.undefined;
+    await runHandler(func, req as any);
+    expect(hello).to.equal("world");
+  });
+
   // Test for firebase-tools#5210
   it("should create context.auth for v1 emulated functions", async () => {
     sinon.stub(debug, "isDebugFeatureEnabled").withArgs("skipTokenVerification").returns(true);

spec/v1/providers/remoteConfig.spec.ts

@@ -122,12 +122,14 @@ describe("RemoteConfig Functions", () => {
       delete process.env.GCLOUD_PROJECT;
     });
 
-    it("should unwrap the version in the event", () => {
-      return Promise.all([
-        cloudFunctionUpdate(event.data, event.context).then((data: any) => {
-          expect(data).to.deep.equal(constructVersion());
-        }),
-      ]);
+    it("should unwrap the version in the event", async () => {
+      let hello;
+      functions.onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      await cloudFunctionUpdate(event.data, event.context).then((data: any) => {
+        expect(data).to.deep.equal(constructVersion());
+      });
+      expect(hello).to.equal("world");
     });
   });
 });

spec/v2/providers/alerts/alerts.spec.ts

@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import { CloudEvent } from "../../../../src/v2";
+import { CloudEvent, onInit } from "../../../../src/v2";
 import * as options from "../../../../src/v2/options";
 import * as alerts from "../../../../src/v2/providers/alerts";
 import { FULL_OPTIONS } from "../fixtures";
@@ -211,4 +211,21 @@ describe("alerts", () => {
       });
     });
   });
+
+  it("calls init function", async () => {
+    const event: CloudEvent<string> = {
+      specversion: "1.0",
+      id: "id",
+      source: "source",
+      type: "type",
+      time: "now",
+      data: "data",
+    };
+
+    let hello;
+    onInit(() => (hello = "world"));
+    expect(hello).to.be.undefined;
+    await alerts.onAlertPublished("alert", () => null)(event);
+    expect(hello).to.equal("world");
+  });
 });

spec/v2/providers/alerts/appDistribution.spec.ts

@@ -3,6 +3,7 @@ import * as alerts from "../../../../src/v2/providers/alerts";
 import * as appDistribution from "../../../../src/v2/providers/alerts/appDistribution";
 import { FULL_OPTIONS } from "../fixtures";
 import { FULL_ENDPOINT, MINIMAL_V2_ENDPOINT } from "../../../fixtures";
+import { onInit } from "../../../../src/v2/core";
 
 const APPID = "123456789";
 const myHandler = () => 42;
@@ -91,6 +92,16 @@ describe("appDistribution", () => {
 
       expect(res).to.equal("input");
     });
+
+    it("calls init function", async () => {
+      const func = appDistribution.onNewTesterIosDevicePublished(APPID, (event) => event);
+
+      let hello;
+      onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      await func({ data: "test" } as any);
+      expect(hello).to.equal("world");
+    });
   });
 
   describe("onInAppfeedbackPublished", () => {
@@ -172,6 +183,16 @@ describe("appDistribution", () => {
 
       expect(res).to.equal("input");
     });
+
+    it("calls init function", async () => {
+      const func = appDistribution.onInAppFeedbackPublished(APPID, (event) => event);
+
+      let hello;
+      onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      await func({ data: "test" } as any);
+      expect(hello).to.equal("world");
+    });
   });
 
   describe("getOptsAndApp", () => {

spec/v2/providers/alerts/billing.spec.ts

@@ -3,6 +3,7 @@ import * as alerts from "../../../../src/v2/providers/alerts";
 import * as billing from "../../../../src/v2/providers/alerts/billing";
 import { FULL_OPTIONS } from "../fixtures";
 import { FULL_ENDPOINT, MINIMAL_V2_ENDPOINT } from "../../../fixtures";
+import { onInit } from "../../../../src/v2/core";
 
 const ALERT_TYPE = "new-alert-type";
 const myHandler = () => 42;
@@ -41,6 +42,16 @@ describe("billing", () => {
         },
       });
     });
+
+    it("calls init function", async () => {
+      const func = billing.onPlanAutomatedUpdatePublished((event) => event);
+
+      let hello;
+      onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      await func({ data: "test" } as any);
+      expect(hello).to.equal("world");
+    });
   });
 
   describe("onPlanAutomatedUpdatePublished", () => {
@@ -76,6 +87,16 @@ describe("billing", () => {
         },
       });
     });
+
+    it("calls init function", async () => {
+      const func = billing.onPlanAutomatedUpdatePublished((event) => event);
+
+      let hello;
+      onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      await func({ data: "test" } as any);
+      expect(hello).to.equal("world");
+    });
   });
 
   describe("onOperation", () => {
@@ -119,5 +140,15 @@ describe("billing", () => {
 
       expect(res).to.equal("input");
     });
+
+    it("calls init function", async () => {
+      const func = billing.onOperation(ALERT_TYPE, (event) => event, undefined);
+
+      let hello;
+      onInit(() => (hello = "world"));
+      expect(hello).to.be.undefined;
+      await func({ data: "test" } as any);
+      expect(hello).to.equal("world");
+    });
   });
 });

spec/v2/providers/alerts/crashlytics.spec.ts

@@ -3,6 +3,7 @@ import * as alerts from "../../../../src/v2/providers/alerts";
 import * as crashlytics from "../../../../src/v2/providers/alerts/crashlytics";
 import { FULL_OPTIONS } from "../fixtures";
 import { FULL_ENDPOINT, MINIMAL_V2_ENDPOINT } from "../../../fixtures";
+import { onInit } from "../../../../src/v2/core";
 
 const ALERT_TYPE = "new-alert-type";
 const APPID = "123456789";
@@ -104,6 +105,16 @@ describe("crashlytics", () => {
           },
         });
       });
+
+      it("calls init function", async () => {
+        const func = crashlytics[method](APPID, myHandler);
+
+        let hello;
+        onInit(() => (hello = "world"));
+        expect(hello).to.be.undefined;
+        await func({ data: "crash" } as any);
+        expect(hello).to.equal("world");
+      });
     });
   }
 

spec/v2/providers/alerts/performance.spec.ts

@@ -3,6 +3,7 @@ import * as alerts from "../../../../src/v2/providers/alerts";
 import * as performance from "../../../../src/v2/providers/alerts/performance";
 import { FULL_OPTIONS } from "../fixtures";
 import { FULL_ENDPOINT, MINIMAL_V2_ENDPOINT } from "../../../fixtures";
+import { CloudEvent, onInit } from "../../../../src/v2/core";
 
 const APPID = "123456789";
 const myHandler = () => 42;
@@ -45,6 +46,23 @@ describe("performance", () => {
           retry: false,
         },
       });
+
+      it("calls init function", async () => {
+        const event: CloudEvent<string> = {
+          specversion: "1.0",
+          id: "id",
+          source: "source",
+          type: "type",
+          time: "now",
+          data: "data",
+        };
+
+        let hello: string;
+        onInit(() => (hello = "world"));
+        expect(hello).to.be.undefined;
+        await performance.onThresholdAlertPublished(() => null)(event);
+        expect(hello).to.equal("world");
+      });
     });
 
     it("should create a function with appid in opts", () => {