Finish refactor of HTTPS code #917
Conversation
The actual encoding/decoding/error logic etc. of callable functions will stay the same between v1 and v2, so they should be in a /common file. The rest of /v1 is about trigger options, cors, etc. onCall's CORS options are part of the v1 namespace because v2 adds a "cors" option to HttpsOptions. In the v2 API, we will default to `"cors": true`, but a customer could say `"cors": "my.firebase.app"` and we will respsect it. I wish there was a way to make this diff not so noisy. Most of this is cut & paste.
Builds upon #915 Creates the first bits of v2/ setGlobalOptions allows customers to set options that will be preserved across any function written in the v2 API. v2/https has webhook and callable function support. In addition to previous features, customers can now specifiy `cors` as a shorthand for using CORS middleware. We will probably eventually support scheduled functions in the HTTPS namespace but that will have to wait for another day.
| "./v2/options": "./lib/v2/options.js", | ||
| "./v2/https": "./lib/v2/providers/https.js" | ||
| }, | ||
| "typesVersions": { |
There was a problem hiding this comment.
This fixes the submodule exports for typescript. TS imports don't actually support submodule exports yet, but typesVersion allows us to do a rewrite of the lookup paths for .d.ts files. The Admin and Web SDK use this hack.
| /** | ||
| * List of all regions supported by Cloud Functions v2 | ||
| */ | ||
| export const SUPPORTED_REGIONS = ['us-west1'] as const; |
There was a problem hiding this comment.
I assume we can blame lauren for this one. I just copied the existing code from v1
| */ | ||
| export function setGlobalOptions(options: GlobalOptions) { | ||
| if (globalOptions) { | ||
| logger.warn('Calling setGlobalOptions twice leads to undefined behavior'); |
There was a problem hiding this comment.
Is this actually true? Looks pretty clear that it just overwrite all previous global options.
There was a problem hiding this comment.
Undefined doesn't mean unpredictable. I just want to set expectations that this is not an OK thing to do. The warning might also be interesting if someone is surprised that it's being set twice. E.g. If they have multiple files they're importing which each set global options. Or if some malicious codebase decided it would be funny to call setGlobalOptions({minInstances: 100})
|
RE removing the packages section of |
|
Ahhh, I didn't realize - as long as it is still correct, I think its totally fine to include those changes in this PR. I didnt approve just to be sure it was something we wanted to do |
Builds upon #915
Creates the first bits of v2/
setGlobalOptionsallows customers to set options that will be preserved across any function written in the v2 API.v2/httpshas webhook and callable function support. In addition to previous features, customers can now specifiycorsas a shorthand for using CORS middleware.We will probably eventually support scheduled functions in the HTTPS namespace but that will have to wait for another day.