Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dynamically invoke correct trigger when running functions emulator with --inspect-functions flag #4232

Merged
merged 7 commits into from
Mar 2, 2022
Merged

Dynamically invoke correct trigger when running functions emulator with --inspect-functions flag #4232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ee27529
Dynamically invoke correct trigger when running functions emulator in…
taeold Mar 1, 2022
488b1cc
Update comments, renaming for hygiene.
taeold Mar 1, 2022
84cb9f9
Merge branch 'master' of https://github.com/firebase/firebase-tools i…
taeold Mar 1, 2022
a16f062
Add changelog.
taeold Mar 1, 2022
4f5d953
Update CHANGELOG.md
taeold Mar 1, 2022
b93d270
Merge branch 'master' into dl-cf3-emulator-debug
taeold Mar 2, 2022
7a25064
Merge branch 'master' into dl-cf3-emulator-debug
taeold Mar 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
- Fixes Storage Emulator rules resource evaluation (#4214).
- Fixes bug where securityLevel is overwritten on https function re-deploys (#4208).
- Fixes bug where functions emulator ignored functions.runtime option in firebase.json (#4207).
- Fixes bug where functions emulator triggered wrong functions when started with --inspect-functions flag (#4232).
- Updates functions init template to use latest versions of dependencies of functions init (#4177).
6 changes: 3 additions & 3 deletions scripts/emulator-tests/functionsEmulator.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,18 +123,18 @@ functionsEmulator.setTriggersForTesting(
);

// TODO(samstern): This is an ugly way to just override the InvokeRuntimeOpts on each call
const startFunctionRuntime = functionsEmulator.startFunctionRuntime.bind(functionsEmulator);
const invokeTrigger = functionsEmulator.invokeTrigger.bind(functionsEmulator);
function useFunctions(triggers: () => {}): void {
const serializedTriggers = triggers.toString();

// eslint-disable-next-line @typescript-eslint/unbound-method
functionsEmulator.startFunctionRuntime = (
functionsEmulator.invokeTrigger = (
backend: EmulatableBackend,
trigger: EmulatedTriggerDefinition,
proto?: any,
runtimeOpts?: InvokeRuntimeOpts
): Promise<RuntimeWorker> => {
return startFunctionRuntime(testBackend, trigger, proto, {
return invokeTrigger(testBackend, trigger, proto, {
nodeBinary: process.execPath,
serializedTriggers,
});
Expand Down
64 changes: 32 additions & 32 deletions scripts/emulator-tests/functionsEmulatorRuntime.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ async function countLogEntries(worker: RuntimeWorker): Promise<{ [key: string]:
return counts;
}

async function startRuntimeWithFunctions(
async function invokeFunction(
frb: FunctionsRuntimeBundle,
triggers: () => {},
signatureType: SignatureType,
Expand All @@ -67,7 +67,7 @@ async function startRuntimeWithFunctions(
entryPoint: "function_id",
platform: "gcfv1" as const,
};
return functionsEmulator.startFunctionRuntime(
return functionsEmulator.invokeTrigger(
testBackend,
{
...dummyTriggerDef,
Expand Down Expand Up @@ -129,7 +129,7 @@ describe("FunctionsEmulator-Runtime", () => {
describe("Stubs, Mocks, and Helpers (aka Magic, Glee, and Awesomeness)", () => {
describe("_InitializeNetworkFiltering(...)", () => {
it("should log outgoing unknown HTTP requests via 'http'", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp();
Expand All @@ -152,7 +152,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_LONG);

it("should log outgoing unknown HTTP requests via 'https'", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp();
Expand All @@ -175,7 +175,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_LONG);

it("should log outgoing Google API requests", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -210,7 +210,7 @@ describe("FunctionsEmulator-Runtime", () => {
});

it("should provide stubbed default app from initializeApp", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp();
Expand All @@ -228,7 +228,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_MED);

it("should provide a stubbed app with custom options", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp({
Expand Down Expand Up @@ -258,7 +258,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_MED);

it("should provide non-stubbed non-default app from initializeApp", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp(); // We still need to initialize default for snapshots
Expand All @@ -276,7 +276,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_MED);

it("should route all sub-fields accordingly", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -308,7 +308,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should expose Firestore prod when the emulator is not running", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
const admin = require("firebase-admin");
Expand Down Expand Up @@ -340,7 +340,7 @@ describe("FunctionsEmulator-Runtime", () => {
port: 9090,
});

const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
const admin = require("firebase-admin");
Expand All @@ -367,7 +367,7 @@ describe("FunctionsEmulator-Runtime", () => {
it("should expose RTDB prod when the emulator is not running", async () => {
const frb = FunctionRuntimeBundles.onRequest;

const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
const admin = require("firebase-admin");
Expand Down Expand Up @@ -397,7 +397,7 @@ describe("FunctionsEmulator-Runtime", () => {
port: 9090,
});

const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
const admin = require("firebase-admin");
Expand Down Expand Up @@ -427,7 +427,7 @@ describe("FunctionsEmulator-Runtime", () => {
port: 9090,
});

const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
const admin = require("firebase-admin");
Expand All @@ -449,7 +449,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should return a real databaseURL when RTDB emulator is not running", async () => {
const frb = _.cloneDeep(FunctionRuntimeBundles.onRequest);
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
const admin = require("firebase-admin");
Expand Down Expand Up @@ -484,7 +484,7 @@ describe("FunctionsEmulator-Runtime", () => {
});

it("should tell the user if they've accessed a non-existent function field", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onCreate,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -513,7 +513,7 @@ describe("FunctionsEmulator-Runtime", () => {
describe("HTTPS", () => {
it("should handle a GET request", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand All @@ -533,7 +533,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should handle a POST request with form data", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -564,7 +564,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should handle a POST request with JSON data", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -595,7 +595,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should handle a POST request with text data", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -626,7 +626,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should handle a POST request with any other type", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -658,7 +658,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should handle a POST request and store rawBody", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -689,7 +689,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should forward request to Express app", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -717,7 +717,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should handle `x-forwarded-host`", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand All @@ -741,7 +741,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("should report GMT time zone", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
return {
Expand All @@ -761,7 +761,7 @@ describe("FunctionsEmulator-Runtime", () => {

describe("Cloud Firestore", () => {
it("should provide Change for firestore.onWrite()", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onWrite,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -795,7 +795,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_MED);

it("should provide Change for firestore.onUpdate()", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onUpdate,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -828,7 +828,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_MED);

it("should provide DocumentSnapshot for firestore.onDelete()", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onDelete,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -860,7 +860,7 @@ describe("FunctionsEmulator-Runtime", () => {
}).timeout(TIMEOUT_MED);

it("should provide DocumentSnapshot for firestore.onCreate()", async () => {
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
FunctionRuntimeBundles.onWrite,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -895,7 +895,7 @@ describe("FunctionsEmulator-Runtime", () => {
describe("Error handling", () => {
it("Should handle regular functions for Express handlers", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand All @@ -921,7 +921,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("Should handle async functions for Express handlers", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down Expand Up @@ -950,7 +950,7 @@ describe("FunctionsEmulator-Runtime", () => {

it("Should handle async/runWith functions for Express handlers", async () => {
const frb = FunctionRuntimeBundles.onRequest;
const worker = await startRuntimeWithFunctions(
const worker = await invokeFunction(
frb,
() => {
require("firebase-admin").initializeApp();
Expand Down