Firebase Functions ships with a binary #1003

taeold · 2021-11-09T23:03:38Z

We introduce a bin associated with the firebase-functions SDK! The binary exposes a simple server on localhost that describes the Firebase Functions defined in the current directory:

$ STACK_CONTROL_API_PORT=8181 npx firebase-functions  # Optionally can pass in a FUNCTIONS_DIR as first arg 
Serving at port 8181

$ curl localhost:8181/__/stack.yaml | jq
{
  "endpoints": {
    "onreqv2": {
      "platform": "gcfv2",
      "labels": {},
      "httpsTrigger": {},
      "entryPoint": "onreqv2"
    },
    "onRequest": {
      "platform": "gcfv1",
      "httpsTrigger": {},
      "entryPoint": "onRequest"
    }
  },
  "specVersion": "v1alpha1",
  "requiredAPIs": []
}

…se-functions into dl-endpoint-prop

… into dl-endpoint-prop

inlined

I like it, but let's get the port/Env var + the requiredAPIs stuff sorted out.

All in all though, this is much better than I could have done myself. We're really lucky that you've got experience with ESM modules vs pacakges.

spec/fixtures/sources/commonjs-grouped/g1.js

spec/fixtures/sources/commonjs-grouped/index.js

spec/runtime/loader.spec.ts

src/bin/firebase-functions.ts

src/runtime/loader.ts

Follows up #999 to annotate each funuctions with `__endpoint` property. Highlight of changes: * Extend unit test coverage for all v1 providers * Add `__endpoint` annotation to v1 task queue functions * Add `__requiredAPIs` annotation to task queue and scheduler functions * Explicitly set `__endpoint` to undefined in the handler namespace * No SDK-level label setting in the __endpoint annotation.

…irebase-functions into dl-ff-runtime

colerogers

looks good, just one thing that I had a question on

src/runtime/manifest.ts

inlined

Still looking good.

spec/runtime/loader.spec.ts

spec/v1/providers/analytics.spec.ts

src/bin/firebase-functions.ts

inlined · 2022-01-21T07:05:31Z

src/bin/firebase-functions.ts

    res.setHeader('content-type', 'text/yaml');
-    res.send(JSON.stringify(backend));
+    res.send(JSON.stringify(stack));


I mean.... technically JSON is YAML?

inlined · 2022-01-21T07:07:10Z

src/cloud-functions.ts

      {
        api: 'cloudscheduler.googleapis.com',
-        reason: 'Needed for v1 scheduled functions.',


here's a case where I could argue for using "v1" because v2 will not use Pub/Sub.

Alternatively you can just remove this required API because it's part of the APIs that get enabled with Cloud Functions.

I don't think Cloud Scheduler gets enabled as part of GCF, but I'm not sure what enables it since I do see it enabled when creating a new GCP project 🤔 . I'm going to add 'v1' to err on side of being safe, but can remove later when I dig in and figure out if we can rely on the cloud scheduler API being enabled on users project by some means.

…#1033) Follows up #1032 for V2 API to fix #1031. While rebasing the branch that moved the location of manifest definition (#1003), the original file was not removed and cleaned up. Having long-lasting PR is dangeroud 🤦🏼‍♂️ .

taeold and others added 25 commits October 26, 2021 22:33

WIP.

72c66ef

It's v1alpha1

fb5af88

Finish writing test. Cleanup.

3c58ff3

Prettier.

5b369f1

Nits.

2db4640

Prettier

306c269

Merge branch 'master' into dl-endpoint-prop

f5b0e35

Unroll v1alpha manifest out of dir.

584ff6d

Merge branch 'dl-endpoint-prop' of https://github.com/firebase/fireba…

11a08fc

…se-functions into dl-endpoint-prop

Prefer timeoutSeconds over timeout.

e1d9003

Prefer topic over generic resource.

69a8846

Whoops this shouldn't go.

8d7cbee

Refactor vpc option.

eb0a9b0

Finalize refactor.

105cc7c

Don't transform SA, consistent fn name.

3de212b

Unroll trigger options.

c765db5

Make callable its own trigger, fix tests.

08cde7a

No need for dynamic props.

fafcbd5

Prettier.

7864635

Better types.

4ca1d44

Few more fixes.

3f47fdc

One mo nit.

726b4eb

No getters if unncessary.

5eda9cd

Prettier.

cec015f

Merge branch 'master' of https://github.com/firebase/firebase-functions…

10f88da

… into dl-endpoint-prop

google-cla bot added the cla: yes label Nov 9, 2021

taeold changed the base branch from dl-container-contract to dl-endpoint-prop November 9, 2021 23:16

taeold requested a review from inlined November 9, 2021 23:30

inlined reviewed Nov 12, 2021

View reviewed changes

Rely on default converter function.

11f18e8

taeold added 3 commits November 29, 2021 10:16

WIP - write better tests.

995b140

Merge branch 'dl-endoint-prop-2' into dl-ff-runtime

9a9f0f0

Fix broken test

c2de5b4

taeold force-pushed the dl-ff-runtime branch from 8b88c52 to c2de5b4 Compare December 7, 2021 21:44

Better merge strategy for required apis.

6f2219c

inlined reviewed Dec 9, 2021

View reviewed changes

src/runtime/loader.ts Show resolved Hide resolved

taeold and others added 4 commits December 9, 2021 21:18

Merge branch 'dl-container-contract' of https://github.com/firebase/f…

732a8a8

…irebase-functions into dl-ff-runtime

Prettier.

3a0c353

Fix bug merging requiredAPIs, add tests.

f3297f4

taeold changed the base branch from dl-endpoint-prop to dl-container-contract December 10, 2021 05:39

taeold added 3 commits December 9, 2021 21:43

Remove unnecessary imports.

1d61a4c

Some style nits.

2a7d78d

It's stack not backend.

f756646

taeold requested a review from colerogers December 10, 2021 05:54

taeold added 2 commits December 9, 2021 22:07

Assume current dir if arg is missing.

fe536d2

Prettier.

20faaea

taeold marked this pull request as ready for review December 10, 2021 19:29

taeold requested a review from inlined December 14, 2021 06:46

colerogers reviewed Jan 18, 2022

View reviewed changes

src/runtime/manifest.ts Show resolved Hide resolved

Base automatically changed from dl-container-contract to master January 19, 2022 18:18

inlined approved these changes Jan 21, 2022

View reviewed changes

taeold added 4 commits February 2, 2022 04:28

Merge remote-tracking branch 'origin/master' into dl-ff-runtime

5512e15

PR feedbacks.

7560cf4

Prettier.

7d0be1e

Cloud scheduler is needed for both v1 and v2 scheduled fns.

1510689

taeold merged commit f3ed261 into master Feb 2, 2022

taeold deleted the dl-ff-runtime branch February 2, 2022 13:21

taeold mentioned this pull request Feb 7, 2022

Unbreak v2 TS users by safely removing duplicated manifest definition #1033

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Firebase Functions ships with a binary #1003

Firebase Functions ships with a binary #1003

taeold commented Nov 9, 2021 •

edited

inlined left a comment

colerogers left a comment

inlined left a comment

inlined Jan 21, 2022

inlined Jan 21, 2022

taeold Feb 2, 2022

Firebase Functions ships with a binary #1003

Firebase Functions ships with a binary #1003

Conversation

taeold commented Nov 9, 2021 • edited

inlined left a comment

Choose a reason for hiding this comment

colerogers left a comment

Choose a reason for hiding this comment

inlined left a comment

Choose a reason for hiding this comment

inlined Jan 21, 2022

Choose a reason for hiding this comment

inlined Jan 21, 2022

Choose a reason for hiding this comment

taeold Feb 2, 2022

Choose a reason for hiding this comment

taeold commented Nov 9, 2021 •

edited