diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md deleted file mode 100644 index 93f7d6de1..000000000 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: "\U0001F4A1 Feature Request" -about: - Have a feature you'd like to see in the functions SDK? Request it through our - support channel. -title: '' -labels: '' -assignees: '' ---- - - - -Great, we love hearing how we can improve our products! However, GitHub is not the place to submit them. Please submit your feature requests to: -https://firebase.google.com/support/contact/bugs-features/ diff --git a/.github/ISSUE_TEMPLATE/---report-a-bug.md b/.github/ISSUE_TEMPLATE/---report-a-bug.md index 694c4aedf..3ad82bf60 100644 --- a/.github/ISSUE_TEMPLATE/---report-a-bug.md +++ b/.github/ISSUE_TEMPLATE/---report-a-bug.md @@ -1,6 +1,6 @@ --- name: '⚠️ Report a Bug' -about: Think you found a bug in the SDK? Report it here. +about: Think you found a bug in the firebase-functions SDK? Report it here. Please do not use this form if your function is deployed successfully but not working as you expected. title: '' labels: '' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..918e205f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 💻 Bug in the Firebase CLI + url: https://github.com/firebase/firebase-tools/issues/new/choose + about: Have you found a bug in the Firebase CLI? + - name: 🔥 Firebase Support + url: https://firebase.google.com/support/ + about: If you have an issue with your functions in production, please contact support. diff --git a/.github/workflows/postmerge.yaml b/.github/workflows/postmerge.yaml new file mode 100644 index 000000000..f5105958c --- /dev/null +++ b/.github/workflows/postmerge.yaml @@ -0,0 +1,55 @@ +# Copyright 2022 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +name: Post-merge tests + +on: + workflow_dispatch: + workflow_run: + workflows: ['CI Tests'] + types: [completed] + branches: [master] + +concurrency: + group: postmerge-${{ github.ref }} + cancel-in-progress: true + +env: + CI: true + +jobs: + postmerge: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 16 + + - uses: google-github-actions/auth@v0 + with: + credentials_json: '${{ secrets.CF3_INTEGRATION_TEST_GOOGLE_CREDENTIALS }}' + create_credentials_file: true + + - name: 'Set up Cloud SDK' + uses: google-github-actions/setup-gcloud@v0 + + - name: 'Setup Firebase CLI' + run: npm i -g firebase-tools + + - name: 'Run integration test' + run: npm run test:postmerge + + - name: Print debug logs + if: failure() + run: find . -type f -name "*debug.log" | xargs cat diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml new file mode 100644 index 000000000..33242e9b8 --- /dev/null +++ b/.github/workflows/test.yaml @@ -0,0 +1,57 @@ +name: CI Tests + +on: + - pull_request + - push + +env: + CI: true + +jobs: + unit: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: + - 10.x + - 12.x + - 14.x + - 16.x + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v1 + with: + node-version: ${{ matrix.node-version }} + + - name: Cache npm + uses: actions/cache@v1 + with: + path: ~/.npm + key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }} + + - run: npm ci + - run: npm run lint + - run: npm run format + - run: npm run test + integration: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: + - 12.x + - 14.x + - 16.x + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v1 + with: + node-version: ${{ matrix.node-version }} + + - name: Cache npm + uses: actions/cache@v1 + with: + path: ~/.npm + key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }} + + - run: npm install + - run: npm run test:bin diff --git a/.gitignore b/.gitignore index ba3cdeec5..017bc9f40 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,12 @@ .tmp .vscode/ coverage +dist/ docgen/html +docgen/*/temp +docgen/*/markdown +docgen/*/*.json +docgen/*/*.md firebase-functions-*.tgz integration_test/.firebaserc integration_test/*.log @@ -14,3 +19,4 @@ node_modules npm-debug.log typings yarn.lock +.DS_Store diff --git a/.mocharc.yaml b/.mocharc.yaml index 932144124..2bb78edfc 100644 --- a/.mocharc.yaml +++ b/.mocharc.yaml @@ -1,10 +1,8 @@ exit: true extension: - ts -file: - - mocha/setup.ts package: ./package.json reporter: spec require: - 'ts-node/register' -spec: spec/**/*.spec.ts + - 'source-map-support/register' diff --git a/.npmrc b/.npmrc deleted file mode 100644 index 43c97e719..000000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -package-lock=false diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 18dff4114..000000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -cache: npm -jobs: - include: - - name: lint - script: npm run lint - stage: verify - - name: format - script: npm run format - stage: verify -language: node_js -node_js: - - '8' - - '10' -sudo: false diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..f6a8ba1bc --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ +- Fix reference docs for performance monitoring. +- Fix bug where function configuration wil null values couldn't be deployed. (#1246) diff --git a/README.md b/README.md index 59c5c0936..33fbaa746 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ const notifyUsers = require('./notify-users'); exports.newPost = functions.database .ref('/posts/{postId}') .onCreate((snapshot, context) => { - console.log('Received new post with ID:', context.params.postId); + functions.logger.info('Received new post with ID:', context.params.postId); return notifyUsers(snapshot.val()); }); ``` diff --git a/changelog.txt b/changelog.txt deleted file mode 100644 index c3be06fd4..000000000 --- a/changelog.txt +++ /dev/null @@ -1 +0,0 @@ -feature - Add a helper function for the Firebase Emulator suite. \ No newline at end of file diff --git a/deploy_key.enc b/deploy_key.enc new file mode 100644 index 000000000..4451e042b Binary files /dev/null and b/deploy_key.enc differ diff --git a/docgen/api-extractor.base.json b/docgen/api-extractor.base.json new file mode 100644 index 000000000..2938a396f --- /dev/null +++ b/docgen/api-extractor.base.json @@ -0,0 +1,364 @@ +/** + * Config file for API Extractor. For more info, please visit: https://api-extractor.com + */ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + /** + * Optionally specifies another JSON config file that this file extends from. This provides a way for + * standard settings to be shared across multiple projects. + * + * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains + * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be + * resolved using NodeJS require(). + * + * SUPPORTED TOKENS: none + * DEFAULT VALUE: "" + */ + // "extends": "./shared/api-extractor-base.json" + // "extends": "my-package/include/api-extractor-base.json" + + /** + * Determines the "" token that can be used with other config file settings. The project folder + * typically contains the tsconfig.json and package.json config files, but the path is user-defined. + * + * The path is resolved relative to the folder of the config file that contains the setting. + * + * The default value for "projectFolder" is the token "", which means the folder is determined by traversing + * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder + * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error + * will be reported. + * + * SUPPORTED TOKENS: + * DEFAULT VALUE: "" + */ + "projectFolder": "..", + + /** + * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor + * analyzes the symbols exported by this module. + * + * The file extension must be ".d.ts" and not ".ts". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + */ + "mainEntryPointFilePath": "/lib/index.d.ts", + + /** + * A list of NPM package names whose exports should be treated as part of this package. + * + * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", + * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part + * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly + * imports library2. To avoid this, we can specify: + * + * "bundledPackages": [ "library2" ], + * + * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been + * local files for library1. + */ + "bundledPackages": [], + + /** + * Determines how the TypeScript compiler engine will be invoked by API Extractor. + */ + "compiler": { + /** + * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * Note: This setting will be ignored if "overrideTsconfig" is used. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/tsconfig.json" + */ + "tsconfigFilePath": "/tsconfig.release.json" + /** + * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + * The object must conform to the TypeScript tsconfig schema: + * + * http://json.schemastore.org/tsconfig + * + * If omitted, then the tsconfig.json file will be read from the "projectFolder". + * + * DEFAULT VALUE: no overrideTsconfig section + */ + // "overrideTsconfig": { + // . . . + // } + /** + * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended + * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when + * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses + * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + * + * DEFAULT VALUE: false + */ + // "skipLibCheck": true, + }, + + /** + * Configures how the API report file (*.api.md) will be generated. + */ + "apiReport": { + /** + * (REQUIRED) Whether to generate an API report. + */ + "enabled": true, + + /** + * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce + * a full file path. + * + * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". + * + * SUPPORTED TOKENS: , + * DEFAULT VALUE: ".api.md" + */ + // "reportFileName": ".api.md", + + /** + * Specifies the folder where the API report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, + * e.g. for an API review. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/etc/" + */ + "reportFolder": "/docgen/etc/", + + /** + * Specifies the folder where the temporary report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * After the temporary file is written to disk, it is compared with the file in the "reportFolder". + * If they are different, a production build will fail. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/" + */ + "reportTempFolder": "/docgen/temp/" + }, + + /** + * Configures how the doc model file (*.api.json) will be generated. + */ + "docModel": { + /** + * (REQUIRED) Whether to generate a doc model file. + */ + "enabled": true, + + /** + * The output path for the doc model file. The file extension should be ".api.json". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/.api.json" + */ + "apiJsonFilePath": "/docgen/.api.json" + }, + + /** + * Configures how the .d.ts rollup file will be generated. + */ + "dtsRollup": { + /** + * (REQUIRED) Whether to generate the .d.ts rollup file. + */ + "enabled": true + + /** + * Specifies the output path for a .d.ts rollup file to be generated without any trimming. + * This file will include all declarations that are exported by the main entry point. + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/dist/.d.ts" + */ + // "untrimmedFilePath": "/dist/.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + * This file will include only declarations that are marked as "@public" or "@beta". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "betaTrimmedFilePath": "/dist/-beta.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + * This file will include only declarations that are marked as "@public". + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "publicTrimmedFilePath": "/dist/-public.d.ts", + + /** + * When a declaration is trimmed, by default it will be replaced by a code comment such as + * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the + * declaration completely. + * + * DEFAULT VALUE: false + */ + // "omitTrimmingComments": true + }, + + /** + * Configures how the tsdoc-metadata.json file will be generated. + */ + "tsdocMetadata": { + /** + * Whether to generate the tsdoc-metadata.json file. + * + * DEFAULT VALUE: true + */ + // "enabled": true, + /** + * Specifies where the TSDoc metadata file should be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", + * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup + * falls back to "tsdoc-metadata.json" in the package folder. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" + }, + + /** + * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files + * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. + * To use the OS's default newline kind, specify "os". + * + * DEFAULT VALUE: "crlf" + */ + // "newlineKind": "crlf", + + /** + * Configures how API Extractor reports error and warning messages produced during analysis. + * + * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. + */ + "messages": { + /** + * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing + * the input .d.ts files. + * + * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "compilerMessageReporting": { + /** + * Configures the default routing for messages that don't match an explicit rule in this table. + */ + "default": { + /** + * Specifies whether the message should be written to the the tool's output log. Note that + * the "addToApiReportFile" property may supersede this option. + * + * Possible values: "error", "warning", "none" + * + * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail + * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes + * the "--local" option), the warning is displayed but the build will not fail. + * + * DEFAULT VALUE: "warning" + */ + "logLevel": "warning" + + /** + * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), + * then the message will be written inside that file; otherwise, the message is instead logged according to + * the "logLevel" option. + * + * DEFAULT VALUE: false + */ + // "addToApiReportFile": false + } + + // "TS2551": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by API Extractor during its analysis. + * + * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" + * + * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings + */ + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "ae-extra-release-tag": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by the TSDoc parser when analyzing code comments. + * + * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "tsdoc-link-tag-unescaped-text": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + } + } +} diff --git a/docgen/api-extractor.v1.json b/docgen/api-extractor.v1.json new file mode 100644 index 000000000..f03058f13 --- /dev/null +++ b/docgen/api-extractor.v1.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "extends": "./api-extractor.base.json", + "mainEntryPointFilePath": "/lib/index.d.ts", + "docModel": { + "enabled": true, + "apiJsonFilePath": "/docgen/v1/firebase-functions.api.json" + }, + "apiReport": { + "enabled": true, + "reportTempFolder": "/docgen/v1/temp", + "reportFolder": "/docgen/v1" + } +} diff --git a/docgen/api-extractor.v2.json b/docgen/api-extractor.v2.json new file mode 100644 index 000000000..2cf0596b7 --- /dev/null +++ b/docgen/api-extractor.v2.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "extends": "./api-extractor.base.json", + "mainEntryPointFilePath": "/lib/v2/index.d.ts", + "docModel": { + "enabled": true, + "apiJsonFilePath": "/docgen/v2/firebase-functions.api.json" + }, + "apiReport": { + "enabled": true, + "reportTempFolder": "/docgen/v2/temp", + "reportFolder": "/docgen/v2" + } +} diff --git a/docgen/content-sources/HOME.md b/docgen/content-sources/HOME.md deleted file mode 100644 index c89df0a57..000000000 --- a/docgen/content-sources/HOME.md +++ /dev/null @@ -1,3 +0,0 @@ -# Firebase Functions SDK Reference - -Functions SDK!!! diff --git a/docgen/content-sources/toc.yaml b/docgen/content-sources/toc.yaml deleted file mode 100644 index 9ba761c15..000000000 --- a/docgen/content-sources/toc.yaml +++ /dev/null @@ -1,116 +0,0 @@ -toc: - - title: 'functions' - path: /docs/reference/functions/cloud_functions_.html - section: - - title: 'CloudFunction' - path: /docs/reference/functions/cloud_functions_.html#cloudfunction - - title: 'HttpsFunction' - path: /docs/reference/functions/cloud_functions_.html#httpsfunction - - title: 'EventContext' - path: /docs/reference/functions/cloud_functions_.eventcontext.html - - title: 'FunctionBuilder' - path: /docs/reference/functions/function_builder_.functionbuilder.html - - title: 'Change' - path: /docs/reference/functions/cloud_functions_.change.html - - title: 'ChangeJson' - path: /docs/reference/functions/cloud_functions_.changejson.html - - - title: 'functions.config' - path: /docs/reference/functions/config_.html - section: - - title: 'Config' - path: /docs/reference/functions/config_.config.html - - - title: 'functions.analytics' - path: /docs/reference/functions/providers_analytics_.html - section: - - title: 'AnalyticsEvent' - path: /docs/reference/functions/providers_analytics_.analyticsevent.html - - title: 'AnalyticsEventBuilder' - path: /docs/reference/functions/providers_analytics_.analyticseventbuilder.html - - title: 'AppInfo' - path: /docs/reference/functions/providers_analytics_.appinfo.html - - title: 'DeviceInfo' - path: /docs/reference/functions/providers_analytics_.deviceinfo.html - - title: 'ExportBundleInfo' - path: /docs/reference/functions/providers_analytics_.exportbundleinfo.html - - title: 'GeoInfo' - path: /docs/reference/functions/providers_analytics_.geoinfo.html - - title: 'UserDimensions' - path: /docs/reference/functions/providers_analytics_.userdimensions.html - - title: 'UserPropertyValue' - path: /docs/reference/functions/providers_analytics_.userpropertyvalue.html - - - title: 'functions.auth' - path: /docs/reference/functions/providers_auth_.html - section: - - title: 'UserBuilder' - path: /docs/reference/functions/providers_auth_.userbuilder.html - - title: 'UserInfo' - path: /docs/reference/functions/providers_auth_.html#userinfo - - title: 'UserRecordMetadata' - path: /docs/reference/functions/providers_auth_.userrecordmetadata.html - - title: 'UserRecord' - path: /docs/reference/functions/providers_auth_.html#userrecord - - - title: 'functions.crashlytics' - path: /docs/reference/functions/providers_crashlytics_.html - section: - - title: 'Issue' - path: /docs/reference/functions/providers_crashlytics_.issue.html - - title: 'IssueBuilder' - path: /docs/reference/functions/providers_crashlytics_.issuebuilder.html - - title: 'AppInfo' - path: /docs/reference/functions/providers_crashlytics_.appinfo.html - - title: 'VelocityAlert' - path: /docs/reference/functions/providers_crashlytics_.velocityalert.html - - - title: 'functions.firestore' - path: /docs/reference/functions/providers_firestore_.html - section: - - title: 'DocumentBuilder' - path: /docs/reference/functions/providers_firestore_.documentbuilder.html - - title: 'DocumentSnapshot' - path: /docs/reference/functions/providers_firestore_.html#documentsnapshot - - - title: 'functions.database' - path: /docs/reference/functions/providers_database_.html - section: - - title: 'DataSnapshot' - path: /docs/reference/functions/providers_database_.datasnapshot.html - - title: 'RefBuilder' - path: /docs/reference/functions/providers_database_.refbuilder.html - - title: 'InstanceBuilder' - path: /docs/reference/functions/providers_database_.instancebuilder.html - - - title: 'functions.https' - path: /docs/reference/functions/providers_https_.html - section: - - title: 'HttpsError' - path: /docs/reference/functions/providers_https_.httpserror.html - - - title: 'functions.pubsub' - path: /docs/reference/functions/providers_pubsub_.html - section: - - title: 'Message' - path: /docs/reference/functions/providers_pubsub_.message.html - - title: 'TopicBuilder' - path: /docs/reference/functions/providers_pubsub_.topicbuilder.html - - - title: 'functions.remoteconfig' - path: /docs/reference/functions/providers_remoteconfig_.html - section: - - title: 'RemoteConfigUser' - path: /docs/reference/functions/providers_remoteconfig_.remoteconfiguser.html - - title: 'TemplateVersion' - path: /docs/reference/functions/providers_remoteconfig_.templateversion.html - - - title: 'functions.storage' - path: /docs/reference/functions/providers_storage_.html - section: - - title: 'BucketBuilder' - path: /docs/reference/functions/providers_storage_.bucketbuilder.html - - title: 'ObjectBuilder' - path: /docs/reference/functions/providers_storage_.objectbuilder.html - - title: 'ObjectMetadata' - path: /docs/reference/functions/providers_storage_.objectmetadata.html diff --git a/docgen/content-sources/v1/HOME.md b/docgen/content-sources/v1/HOME.md new file mode 100644 index 000000000..00d2090a0 --- /dev/null +++ b/docgen/content-sources/v1/HOME.md @@ -0,0 +1,8 @@ +# Firebase Functions SDK Reference + +The `firebase-functions` package provides an SDK for defining Cloud Functions for Firebase. + +To get started using Cloud Functions, see +[Get started: write, test, and deploy your first functions](/docs/functions/get-started). + +For source code, see the [Cloud Functions for Firebase GitHub repo](https://github.com/firebase/firebase-functions). diff --git a/docgen/content-sources/v1/toc.yaml b/docgen/content-sources/v1/toc.yaml new file mode 100644 index 000000000..59e380458 --- /dev/null +++ b/docgen/content-sources/v1/toc.yaml @@ -0,0 +1,176 @@ +toc: + - title: 'functions' + path: /docs/reference/functions/cloud_functions.html + section: + - title: 'CloudFunction' + path: /docs/reference/functions/cloud_functions.html#cloudfunction + - title: 'HttpsFunction' + path: /docs/reference/functions/cloud_functions.html#httpsfunction + - title: 'EventContext' + path: /docs/reference/functions/cloud_functions.eventcontext.html + - title: 'FunctionBuilder' + path: /docs/reference/functions/function_builder.functionbuilder.html + - title: 'Change' + path: /docs/reference/functions/cloud_functions.change.html + - title: 'ChangeJson' + path: /docs/reference/functions/cloud_functions.changejson.html + - title: 'BlockingFunction' + path: /docs/reference/functions/cloud_functions.blockingfunction.html + + - title: 'functions.config' + path: /docs/reference/functions/config.html + section: + - title: 'Config' + path: /docs/reference/functions/config.config-1.html + - title: 'config.Config' + path: /docs/reference/functions/config.config-1.config.html + + - title: 'functions.function-configuration' + path: /docs/reference/functions/function_configuration.html + section: + - title: 'config.DeploymentOptions' + path: /docs/reference/functions/function_configuration.deploymentoptions.html + - title: 'config.FailurePolicy' + path: /docs/reference/functions/function_configuration.failurepolicy.html + - title: 'config.RuntimeOptions' + path: /docs/reference/functions/function_configuration.runtimeoptions.html + - title: 'config.Schedule' + path: /docs/reference/functions/function_configuration.schedule.html + - title: 'config.ScheduleRetryConfig' + path: /docs/reference/functions/function_configuration.scheduleretryconfig.html + + - title: 'functions.analytics' + path: /docs/reference/functions/providers_analytics.html + section: + - title: 'AnalyticsEvent' + path: /docs/reference/functions/providers_analytics.analyticsevent.html + - title: 'AnalyticsEventBuilder' + path: /docs/reference/functions/providers_analytics.analyticseventbuilder.html + - title: 'AppInfo' + path: /docs/reference/functions/providers_analytics.appinfo.html + - title: 'DeviceInfo' + path: /docs/reference/functions/providers_analytics.deviceinfo.html + - title: 'ExportBundleInfo' + path: /docs/reference/functions/providers_analytics.exportbundleinfo.html + - title: 'GeoInfo' + path: /docs/reference/functions/providers_analytics.geoinfo.html + - title: 'UserDimensions' + path: /docs/reference/functions/providers_analytics.userdimensions.html + - title: 'UserPropertyValue' + path: /docs/reference/functions/providers_analytics.userpropertyvalue.html + + - title: 'functions.auth' + path: /docs/reference/functions/providers_auth.html + section: + - title: 'UserBuilder' + path: /docs/reference/functions/providers_auth.userbuilder.html + - title: 'UserInfo' + path: /docs/reference/functions/providers_auth.html#userinfo + - title: 'UserRecordMetadata' + path: /docs/reference/functions/providers_auth.userrecordmetadata.html + - title: 'UserRecord' + path: /docs/reference/functions/providers_auth.html#userrecord + + - title: 'functions.firestore' + path: /docs/reference/functions/providers_firestore.html + section: + - title: 'DocumentBuilder' + path: /docs/reference/functions/providers_firestore.documentbuilder.html + - title: 'DocumentSnapshot' + path: /docs/reference/functions/providers_firestore.html#documentsnapshot + + - title: 'functions.database' + path: /docs/reference/functions/providers_database.html + section: + - title: 'DataSnapshot' + path: /docs/reference/functions/providers_database.datasnapshot.html + - title: 'RefBuilder' + path: /docs/reference/functions/providers_database.refbuilder.html + - title: 'InstanceBuilder' + path: /docs/reference/functions/providers_database.instancebuilder.html + + - title: 'functions.https' + path: /docs/reference/functions/providers_https.html + section: + - title: 'HttpsError' + path: /docs/reference/functions/common_providers_https.httpserror.html + - title: 'CallableRequest' + path: /docs/reference/functions/common_providers_https.callablerequest.html + - title: 'CallableContext' + path: /docs/reference/functions/common_providers_https.callablecontext.html + - title: 'AuthData' + path: /docs/reference/functions/common_providers_https.authdata.html + - title: 'AppCheckData' + path: /docs/reference/functions/common_providers_https.appcheckdata.html + + - title: 'functions.logger' + path: /docs/reference/functions/logger.html + section: + - title: 'LogEntry' + path: /docs/reference/functions/logger.logentry.html + + - title: 'functions.pubsub' + path: /docs/reference/functions/providers_pubsub.html + section: + - title: 'Message' + path: /docs/reference/functions/providers_pubsub.message.html + - title: 'TopicBuilder' + path: /docs/reference/functions/providers_pubsub.topicbuilder.html + - title: 'ScheduleBuilder' + path: /docs/reference/functions/providers_pubsub.schedulebuilder.html + + - title: 'functions.remoteconfig' + path: /docs/reference/functions/providers_remoteconfig.html + section: + - title: 'RemoteConfigUser' + path: /docs/reference/functions/providers_remoteconfig.remoteconfiguser.html + - title: 'TemplateVersion' + path: /docs/reference/functions/providers_remoteconfig.templateversion.html + - title: 'UpdateBuilder' + path: /docs/reference/functions/providers_remoteconfig.updatebuilder.html + + - title: 'functions.storage' + path: /docs/reference/functions/providers_storage.html + section: + - title: 'BucketBuilder' + path: /docs/reference/functions/providers_storage.bucketbuilder.html + - title: 'ObjectBuilder' + path: /docs/reference/functions/providers_storage.objectbuilder.html + - title: 'ObjectMetadata' + path: /docs/reference/functions/providers_storage.objectmetadata.html + + - title: 'functions.tasks' + path: /docs/reference/functions/providers_tasks.html + section: + - title: AuthData + path: /docs/reference/functions/common_providers_tasks.authdata.html + - title: RateLimits + path: /docs/reference/functions/common_providers_tasks.ratelimits.html + - title: RetryConfig + path: /docs/reference/functions/common_providers_tasks.retryconfig.html + - title: TaskContext + path: /docs/reference/functions/common_providers_tasks.taskcontext.html + - title: TaskQueueBuilder + path: /docs/reference/functions/providers_tasks.taskqueuebuilder.html + - title: TaskQueueFunction + path: /docs/reference/functions/providers_tasks.taskqueuefunction.html + - title: TaskQueueOptions + path: /docs/reference/functions/providers_tasks.taskqueueoptions.html + + - title: 'functions.testLab' + path: /docs/reference/functions/providers_testlab.html + section: + - title: 'testLab.clientInfo' + path: /docs/reference/functions/providers_testlab.clientinfo.html + - title: 'testLab.resultStorage' + path: /docs/reference/functions/providers_testlab.resultstorage.html + - title: 'testLab.testMatrix' + path: /docs/reference/functions/providers_testlab.testmatrix.html + - title: 'testLab.testMatrixBuilder' + path: /docs/reference/functions/providers_testlab.testmatrixbuilder.html + + - title: 'functions.handler' + path: /docs/reference/functions/handler_builder.html + section: + - title: 'HandlerBuilder' + path: /docs/reference/functions/handler_builder.handlerbuilder.html diff --git a/docgen/content-sources/v2/HOME.md b/docgen/content-sources/v2/HOME.md new file mode 100644 index 000000000..dc6fe541f --- /dev/null +++ b/docgen/content-sources/v2/HOME.md @@ -0,0 +1,8 @@ +# Firebase Functions v2 SDK Reference + +This package provides an SDK for defining Cloud Functions for Firebase v2. + +To get started using Cloud Functions v2, see +the early access guide you were provided when you joined the EAP program. + +**Important:** This API reference is confidential. Do not share or discuss until authorized to do so. diff --git a/docgen/content-sources/v2/toc.yaml b/docgen/content-sources/v2/toc.yaml new file mode 100644 index 000000000..61e330865 --- /dev/null +++ b/docgen/content-sources/v2/toc.yaml @@ -0,0 +1,44 @@ +toc: + - title: 'functions' + path: /docs/functions/alpha/index.html + - title: 'functions.core' + path: /docs/functions/alpha/v2_core.html + section: + - title: 'Functions v2' + path: /docs/functions/alpha/v2.html + - title: 'functions.CloudEvent' + path: /docs/functions/alpha/v2_core.CloudEvent.html + - title: 'functions.CloudFunction' + path: /docs/functions/alpha/v2_core.CloudFunction.html + - title: 'functions.https' + path: /docs/functions/alpha/v2_providers_https.html + section: + - title: 'functions.https.CallableFunction' + path: /docs/functions/alpha/v2_providers_https.CallableFunction.html + - title: 'functions.https.CallableRequest' + path: /docs/functions/alpha/v2_providers_https.CallableRequest.html + - title: 'functions.https.error' + path: /docs/functions/alpha/v2_providers_https.HttpsError.html + - title: 'functions.https.options' + path: /docs/functions/alpha/v2_providers_https.HttpsOptions.html + - title: 'functions.logger' + path: /docs/functions/alpha/logger.html + section: + - title: 'LogEntry' + path: /docs/functions/alpha/logger.LogEntry.html + - title: 'functions.options' + path: /docs/functions/alpha/v2_options.html + section: + - title: 'functions.options.GlobalOptions' + path: /docs/functions/alpha/v2_options.GlobalOptions.html + - title: 'functions.options.EventHandlerOptions' + path: /docs/functions/alpha/v2_options.EventHandlerOptions.html + - title: 'functions.pubsub' + path: /docs/functions/alpha/v2_providers_pubsub.html + section: + - title: 'Message' + path: /docs/functions/alpha/v2_providers_pubsub.Message.html + - title: 'MessagePublishedData' + path: /docs/functions/alpha/v2_providers_pubsub.MessagePublishedData.html + - title: 'PubSubOptions' + path: /docs/functions/alpha/v2_providers_pubsub.PubSubOptions.html diff --git a/docgen/generate-docs.js b/docgen/generate-docs.js index 299250e64..bf07f3881 100644 --- a/docgen/generate-docs.js +++ b/docgen/generate-docs.js @@ -20,24 +20,45 @@ const fs = require('mz/fs'); const path = require('path'); const yargs = require('yargs'); const yaml = require('js-yaml'); -const _ = require('lodash'); const repoPath = path.resolve(`${__dirname}/..`); // Command-line options. -const { source: sourceFile } = yargs - .option('source', { - default: `${repoPath}/src`, +const { api: apiVersion } = yargs + .option('api', { + default: 'v1', describe: 'Typescript source file(s)', - type: 'string' + type: 'string', }) .version(false) .help().argv; +let sourceFile, devsitePath, exclude; +switch (apiVersion) { + case 'v1': + sourceFile = `${repoPath}/src`; + devsitePath = '/docs/reference/functions/'; + exclude = ['"**/v2/**/*.ts"', '"src/index.ts"']; + break; + case 'v2': + sourceFile = `${repoPath}/src/{v2,logger}`; + devsitePath = '/docs/functions/alpha/'; + exclude = []; + break; + default: + throw new Error( + `Unrecognized version ${apiVersion}, must be one of v1 or v2` + ); +} + const docPath = path.resolve(`${__dirname}/html`); -const contentPath = path.resolve(`${__dirname}/content-sources`); +const contentPath = path.resolve(`${__dirname}/content-sources/${apiVersion}`); const tempHomePath = path.resolve(`${contentPath}/HOME_TEMP.md`); -const devsitePath = `/docs/reference/functions/`; + +const { JSDOM } = require('jsdom'); + +const typeMap = require('./type-aliases.json'); +const { existsSync } = require('fs'); /** * Strips path prefix and returns only filename. @@ -56,6 +77,7 @@ function stripPath(path) { function runTypedoc() { const command = `${repoPath}/node_modules/.bin/typedoc ${sourceFile} \ --out ${docPath} \ + ${exclude.map(ex => "--exclude " + ex).join(" ")} \ --readme ${tempHomePath} \ --options ${__dirname}/typedoc.js \ --theme ${__dirname}/theme`; @@ -68,55 +90,82 @@ function runTypedoc() { * Moves files from subdir to root. * @param {string} subdir Subdir to move files out of. */ -function moveFilesToRoot(subdir) { - return exec(`mv ${docPath}/${subdir}/* ${docPath}`) - .then(() => { - exec(`rmdir ${docPath}/${subdir}`); - }) - .catch(e => console.error(e)); +async function moveFilesToRoot(subdir) { + if (existsSync(`${docPath}/${subdir}`)) { + await exec(`mv ${docPath}/${subdir}/* ${docPath}`); + await exec(`rmdir ${docPath}/${subdir}`); + } } /** * Renames files to remove the leading underscores. * We need to do this because devsite hides these files. - * Example: + * Example: * _cloud_functions_.resource.html => cloud_functions_.resource.html */ -function renameFiles() { - return fs.readdir(docPath).then(files => { - console.log(files); - files.forEach(file => { - let newFileName = file; - if (_.startsWith(file, "_") && _.endsWith(file, "html")) { - newFileName = _.trimStart(file, "_"); - fs.rename(`${docPath}/${file}`, `${docPath}/${newFileName}`, (err) => { - if (err) console.log(err) - }); - } - }) - }) +async function renameFiles() { + const files = await fs.readdir(docPath); + const renames = []; + for (const file of files) { + if (file.startsWith('_') && file.endsWith('html')) { + let newFileName = file.substring(1); + renames.push( + fs.rename(`${docPath}/${file}`, `${docPath}/${newFileName}`) + ); + } + } + await Promise.all(renames); } /** * Reformat links to match flat structure. * @param {string} file File to fix links in. */ -function fixLinks(file) { - return fs.readFile(file, 'utf8').then(data => { - const flattenedLinks = data - .replace(/\.\.\//g, '') - .replace(/(modules|interfaces|classes)\//g, '') - .replace(/\"_/g, '"'); - let caseFixedLinks = flattenedLinks; - for (const lower in lowerToUpperLookup) { - const re = new RegExp(lower, 'g'); - caseFixedLinks = caseFixedLinks.replace(re, lowerToUpperLookup[lower]); - } - return fs.writeFile(file, caseFixedLinks); - }); +async function fixLinks(file) { + let data = await fs.readFile(file, 'utf8'); + data = addTypeAliasLinks(data); + const flattenedLinks = data + .replace(/\.\.\//g, '') + .replace(/(modules|interfaces|classes)\//g, '') + .replace(/\"_/g, '"'); + let caseFixedLinks = flattenedLinks; + for (const lower in lowerToUpperLookup) { + const re = new RegExp(lower, 'g'); + caseFixedLinks = caseFixedLinks.replace(re, lowerToUpperLookup[lower]); + } + return fs.writeFile(file, caseFixedLinks); } -let tocText = ''; +/** + * Adds links to external documentation for type aliases that + * reference an external library. + * + * @param data File data to add external library links to. + */ +function addTypeAliasLinks(data) { + const htmlDom = new JSDOM(data); + /** + * Select .tsd-signature-type because all potential external + * links will have this identifier. + */ + const fileTags = htmlDom.window.document.querySelectorAll( + '.tsd-signature-type' + ); + for (const tag of fileTags) { + const mapping = typeMap[tag.textContent]; + if (mapping) { + console.log('Adding link to ' + tag.textContent + ' documentation.'); + + // Add the corresponding document link to this type + const linkChild = htmlDom.window.document.createElement('a'); + linkChild.setAttribute('href', mapping); + linkChild.textContent = tag.textContent; + tag.textContent = null; + tag.appendChild(linkChild); + } + } + return htmlDom.serialize(); +} /** * Generates temporary markdown file that will be sourced by Typedoc to @@ -128,13 +177,13 @@ let tocText = ''; function generateTempHomeMdFile(tocRaw, homeRaw) { const { toc } = yaml.safeLoad(tocRaw); let tocPageLines = [homeRaw, '# API Reference']; - toc.forEach(group => { + for (const group of toc) { tocPageLines.push(`\n## [${group.title}](${stripPath(group.path)})`); const section = group.section || []; - section.forEach(item => { + for (const item of section) { tocPageLines.push(`- [${item.title}](${stripPath(item.path)})`); - }); - }); + } + } return fs.writeFile(tempHomePath, tocPageLines.join('\n')); } @@ -148,37 +197,36 @@ const lowerToUpperLookup = {}; * Checks to see if any files listed in toc.yaml were not generated. * If files exist, fixes filename case to match toc.yaml version. */ -function checkForMissingFilesAndFixFilenameCase() { +async function checkForMissingFilesAndFixFilenameCase(tocText) { // Get filenames from toc.yaml. const filenames = tocText .split('\n') - .filter(line => line.includes('path:')) - .map(line => line.split(devsitePath)[1]); + .filter((line) => line.includes('path:')) + .map((line) => { + parts = line.split('/'); + return parts[parts.length - 1].replace(/#.*$/, ''); + }); // Logs warning to console if a file from TOC is not found. - // console.log(filenames); - const fileCheckPromises = filenames.map(filename => { + const fileCheckPromises = filenames.map(async (filename) => { // Warns if file does not exist, fixes filename case if it does. // Preferred filename for devsite should be capitalized and taken from // toc.yaml. const tocFilePath = `${docPath}/${filename}`; // Generated filename from Typedoc will be lowercase. const generatedFilePath = `${docPath}/${filename.toLowerCase()}`; - return fs.exists(generatedFilePath).then(exists => { - if (exists) { - // Store in a lookup table for link fixing. - lowerToUpperLookup[ - `${filename.toLowerCase()}` - ] = `${filename}`; - return fs.rename(generatedFilePath, tocFilePath); - } else { - console.warn( - `Missing file: ${filename} requested ` + - `in toc.yaml but not found in ${docPath}` - ); - } - }); + if (await fs.exists(generatedFilePath)) { + // Store in a lookup table for link fixing. + lowerToUpperLookup[filename.toLowerCase()] = filename; + return fs.rename(generatedFilePath, tocFilePath); + } else { + console.warn( + `Missing file: ${filename} requested ` + + `in toc.yaml but not found in ${docPath}` + ); + } }); - return Promise.all(fileCheckPromises).then(() => filenames); + await Promise.all(fileCheckPromises); + return filenames; } /** @@ -189,40 +237,30 @@ function checkForMissingFilesAndFixFilenameCase() { * @param {Array} filenamesFromToc Filenames pulled from toc.yaml * @param {boolean} shouldRemove Should just remove the file */ -function checkForUnlistedFiles(filenamesFromToc, shouldRemove) { - return fs.readdir(docPath).then(files => { - const htmlFiles = files - .filter(filename => filename.slice(-4) === 'html'); - const removePromises = []; - htmlFiles.forEach(filename => { - if ( - !filenamesFromToc.includes(filename) && - filename !== 'index' && - filename !== 'globals' - ) { - if (shouldRemove) { - console.log( - `REMOVING ${docPath}/${filename} - not listed in toc.yaml.` - ); - removePromises.push(fs.unlink(`${docPath}/${filename}`)); - } else { - // This is just a warning, it doesn't need to finish before - // the process continues. - console.warn( - `Unlisted file: ${filename} generated ` + - `but not listed in toc.yaml.` - ); - } - } - }); - if (shouldRemove) { - return Promise.all(removePromises).then(() => - htmlFiles.filter(filename => filenamesFromToc.includes(filename)) - ); - } else { - return htmlFiles; - } - }); +async function checkForUnlistedFiles(filenamesFromToc, shouldRemove) { + const files = await fs.readdir(docPath); + const htmlFiles = files.filter((filename) => filename.slice(-4) === 'html'); + const removePromises = []; + const filesToRemove = htmlFiles + .filter((filename) => !filenamesFromToc.includes(filename)) + .filter((filename) => filename !== 'index' && filename != 'globals'); + if (filesToRemove.length && !shouldRemove) { + // This is just a warning, it doesn't need to finish before + // the process continues. + console.warn( + `Unlisted files: ${filesToRemove.join(', ')} generated ` + + `but not listed in toc.yaml.` + ); + return htmlFiles; + } + + await Promise.all( + filesToRemove.map((filename) => { + console.log(`REMOVING ${docPath}/${filename} - not listed in toc.yaml.`); + return fs.unlink(`${docPath}/${filename})`); + }) + ); + return htmlFiles.filter((filename) => filenamesFromToc.includes(filename)); } /** @@ -231,17 +269,16 @@ function checkForUnlistedFiles(filenamesFromToc, shouldRemove) { * * @param {Array} htmlFiles List of html files found in generated dir. */ -function writeGeneratedFileList(htmlFiles) { - const fileList = htmlFiles.map(filename => { +async function writeGeneratedFileList(htmlFiles) { + const fileList = htmlFiles.map((filename) => { return { title: filename, - path: `${devsitePath}${filename}` + path: `${devsitePath}${filename}`, }; }); const generatedTocYAML = yaml.safeDump({ toc: fileList }); - return fs - .writeFile(`${docPath}/_toc_autogenerated.yaml`, generatedTocYAML) - .then(() => htmlFiles); + await fs.writeFile(`${docPath}/_toc_autogenerated.yaml`, generatedTocYAML); + return htmlFiles; } /** @@ -252,10 +289,10 @@ function writeGeneratedFileList(htmlFiles) { */ function fixAllLinks(htmlFiles) { const writePromises = []; - htmlFiles.forEach(file => { + for (const file of htmlFiles) { // Update links in each html file to match flattened file structure. writePromises.push(fixLinks(`${docPath}/${file}`)); - }); + } return Promise.all(writePromises); } @@ -271,69 +308,76 @@ function fixAllLinks(htmlFiles) { * links as needed. * 5) Check for mismatches between TOC list and generated file list. */ -Promise.all([ - fs.readFile(`${contentPath}/toc.yaml`, 'utf8'), - fs.readFile(`${contentPath}/HOME.md`, 'utf8') -]) - // Read TOC and homepage text and assemble a homepage markdown file. - // This file will be sourced by Typedoc to generate index.html. - .then(([tocRaw, homeRaw]) => { - tocText = tocRaw; - return generateTempHomeMdFile(tocRaw, homeRaw); - }) - // Run main Typedoc process (uses index.d.ts and generated temp file above). - .then(runTypedoc) - .then(output => { +(async function () { + try { + const [tocRaw, homeRaw] = await Promise.all([ + fs.readFile(`${contentPath}/toc.yaml`, 'utf8'), + fs.readFile(`${contentPath}/HOME.md`, 'utf8'), + ]); + + // Run main Typedoc process (uses index.d.ts and generated temp file above). + await generateTempHomeMdFile(tocRaw, homeRaw); + const output = await runTypedoc(); + // Typedoc output. console.log(output.stdout); - // Clean up temp home markdown file. (Nothing needs to wait for this.) - fs.unlink(tempHomePath); - // Devsite doesn't like css.map files. - return fs.unlink(`${docPath}/assets/css/main.css.map`); - }) - // Write out TOC file. Do this after Typedoc step to prevent Typedoc - // erroring when it finds an unexpected file in the target dir. - .then(() => fs.writeFile(`${docPath}/_toc.yaml`, tocText)) - // Flatten file structure. These categories don't matter to us and it makes - // it easier to manage the docs directory. - .then(() => { - return Promise.all([ + await Promise.all([ + // Clean up temp home markdown file. (Nothing needs to wait for this.) + fs.unlink(tempHomePath), + + // Devsite doesn't like css.map files. + // NOTE: This doesn't seem to actually get generated anymore, but we'll keep this here just in case. + async () => { + const cssMap = `${docPath}/assets/css/main.css.map`; + if (await fs.exists(cssMap)) { + await fs.unlink(); + } + }, + + // Write out TOC file. Do this after Typedoc step to prevent Typedoc + // erroring when it finds an unexpected file in the target dir. + fs.writeFile(`${docPath}/_toc.yaml`, tocRaw), + ]); + + // Flatten file structure. These categories don't matter to us and it makes + // it easier to manage the docs directory. + await Promise.all([ moveFilesToRoot('classes'), moveFilesToRoot('modules'), moveFilesToRoot('interfaces'), ]); - }) - // Rename files to remove the underscores since devsite hides those. - .then(renameFiles) - // Check for files listed in TOC that are missing and warn if so. - // Not blocking. - .then(checkForMissingFilesAndFixFilenameCase) - // Check for files that exist but aren't listed in the TOC and warn. - // (If API is node, actually remove the file.) - // Removal is blocking, warnings aren't. - .then(filenamesFromToc => - checkForUnlistedFiles(filenamesFromToc, false) - ) - // Write a _toc_autogenerated.yaml to record what files were created. - .then(htmlFiles => writeGeneratedFileList(htmlFiles)) - // Correct the links in all the generated html files now that files have - // all been moved to top level. - // .then(removeUnderscores) - .then(fixAllLinks) - .then(() => { - fs.readFile(`${docPath}/index.html`, 'utf8').then(data => { - // String to include devsite local variables. - const localVariablesIncludeString = `{% include "docs/web/_local_variables.html" %}\n`; - return fs.writeFile( - `${docPath}/index.html`, - localVariablesIncludeString + data - ); - }); - }) - .catch(e => { - if (e.stdout) { - console.error(e.stdout); + // Rename files to remove the underscores since devsite hides those. + await renameFiles(); + + // Check for files listed in TOC that are missing and warn if so. + // Not blocking. + const filenamesFromToc = await checkForMissingFilesAndFixFilenameCase( + tocRaw + ); + + // Check for files that exist but aren't listed in the TOC and warn. + // (If API is node, actually remove the file.) + // Removal is blocking, warnings aren't. + const htmlFiles = await checkForUnlistedFiles(filenamesFromToc, false); + + // Write a _toc_autogenerated.yaml to record what files were created. + const fileList = await writeGeneratedFileList(htmlFiles); + + // Correct the links in all the generated html files now that files have + // all been moved to top level. + await fixAllLinks(fileList); + const data = await fs.readFile(`${docPath}/index.html`, 'utf8'); + // String to include devsite local variables. + const localVariablesIncludeString = `{% include "docs/web/_local_variables.html" %}\n`; + await fs.writeFile( + `${docPath}/index.html`, + localVariablesIncludeString + data + ); + } catch (err) { + if (err.stdout) { + console.error(err.stdout); } else { - console.error(e); + console.error(err); } - }); + } +})(); diff --git a/docgen/theme/helpers/cleanBreadcrumb.js b/docgen/theme/helpers/cleanBreadcrumb.js new file mode 100644 index 000000000..ad52e64a7 --- /dev/null +++ b/docgen/theme/helpers/cleanBreadcrumb.js @@ -0,0 +1,4 @@ +exports.cleanBreadcrumb = function (value) { + const parts = value.replace(/"/g, '').split('/'); + return parts[parts.length - 1]; +}; diff --git a/docgen/theme/layouts/default.hbs b/docgen/theme/layouts/default.hbs index 72111fb4e..17106e8d8 100644 --- a/docgen/theme/layouts/default.hbs +++ b/docgen/theme/layouts/default.hbs @@ -7,6 +7,8 @@ + + {{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}} diff --git a/docgen/theme/partials/breadcrumb.hbs b/docgen/theme/partials/breadcrumb.hbs index db115163f..6a2147724 100644 --- a/docgen/theme/partials/breadcrumb.hbs +++ b/docgen/theme/partials/breadcrumb.hbs @@ -3,7 +3,7 @@ {{#with parent}}{{> breadcrumb}}{{/with}}
  • {{#if url}} - {{name}}. + {{cleanBreadcrumb name}}. {{else}} {{name}} {{/if}} diff --git a/docgen/theme/partials/header.hbs b/docgen/theme/partials/header.hbs index 4aee65a6b..edb115a07 100644 --- a/docgen/theme/partials/header.hbs +++ b/docgen/theme/partials/header.hbs @@ -6,7 +6,7 @@ {{else}}
      {{#with model.parent}}{{> breadcrumb}}{{/with}} -
    • {{model.name}}
      • +
    • {{cleanBreadcrumb model.name}}
      • {{#if model.typeParameters}} < {{#each model.typeParameters}} diff --git a/docgen/toc.ts b/docgen/toc.ts new file mode 100644 index 000000000..24cc58092 --- /dev/null +++ b/docgen/toc.ts @@ -0,0 +1,124 @@ +/** + * @license + * Copyright 2022 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Forked of https://github.com/firebase/firebase-js-sdk/blob/5ce06766303b92fea969c58172a7c1ab8695e21e/repo-scripts/api-documenter/src/toc.ts. + */ +import { writeFileSync } from 'fs'; +import { resolve } from 'path'; + +import { FileSystem } from '@rushstack/node-core-library'; +import * as yaml from 'js-yaml'; +import yargs from 'yargs'; + +export interface TocGenerationOptions { + inputFolder: string; + outputFolder: string; + g3Path: string; +} + +interface TocItem { + title: string; + path: string; + section?: TocItem[]; + status?: 'experimental'; +} + +function fileExt(f: string) { + const parts = f.split('.'); + if (parts.length < 2) { + return ''; + } + return parts.pop(); +} + +export function generateToc({ + inputFolder, + g3Path, + outputFolder, +}: TocGenerationOptions) { + const asObj = FileSystem.readFolder(inputFolder) + .filter((f) => fileExt(f) === 'md') + .reduce((acc, f) => { + const parts = f.split('.'); + parts.pop(); // Get rid of file extenion (.md) + + let cursor = acc; + for (const p of parts) { + cursor[p] = cursor[p] || {}; + cursor = cursor[p]; + } + return acc; + }, {} as any); + + function toToc(obj, prefix = ''): TocItem[] { + const toc: TocItem[] = []; + for (const key of Object.keys(obj)) { + const path = prefix?.length ? `${prefix}.${key}` : key; + const section = toToc(obj[key], path); + const tic: TocItem = { + title: key, + path: `${g3Path}/${path}.md`, + }; + if (section.length > 0) { + tic.section = section; + } + toc.push(tic); + } + return toc; + } + + const toc: TocItem[] = [ + { + title: 'firebase-functions', + status: 'experimental', + path: `${g3Path}/firebase-functions.md`, + }, + ...toToc(asObj['firebase-functions'], 'firebase-functions'), + ]; + + writeFileSync( + resolve(outputFolder, 'toc.yaml'), + yaml.dump( + { toc }, + { + quotingType: '"', + } + ) + ); +} + +const { input, output, path } = yargs(process.argv.slice(2)) + .option('input', { + alias: 'i', + describe: 'input folder containing the *.api.json files to be processed.', + default: './input', + }) + .option('output', { + alias: 'o', + describe: 'destination for the generated toc content.', + default: './toc', + }) + .option('path', { + alias: 'p', + describe: 'specifies the path where the reference docs resides (e.g. g3)', + default: '/', + }) + .help().argv; + +FileSystem.ensureFolder(output); +generateToc({ inputFolder: input, g3Path: path, outputFolder: output }); diff --git a/docgen/tsconfig.json b/docgen/tsconfig.json deleted file mode 100644 index 3c43903cf..000000000 --- a/docgen/tsconfig.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "../tsconfig.json" -} diff --git a/docgen/type-aliases.json b/docgen/type-aliases.json new file mode 100644 index 000000000..240c50269 --- /dev/null +++ b/docgen/type-aliases.json @@ -0,0 +1,5 @@ +{ + "firebase.firestore.DocumentSnapshot": "https://googleapis.dev/nodejs/firestore/latest/DocumentSnapshot.html", + "firebase.auth.UserRecord": "https://firebase.google.com/docs/reference/admin/node/admin.auth.UserRecord.html", + "firebase.auth.UserInfo": "https://firebase.google.com/docs/reference/admin/node/admin.auth.UserInfo.html" +} diff --git a/docgen/typedoc.js b/docgen/typedoc.js index 58156ff59..332e19b0f 100644 --- a/docgen/typedoc.js +++ b/docgen/typedoc.js @@ -16,12 +16,11 @@ */ const options = { - // includeDeclarations: true, + tsconfig: '../tsconfig.release.json', excludeExternals: true, - ignoreCompilerErrors: true, + exclude: ['../spec/**/*.ts', '../integration_test/**/*.ts'], name: 'Firebase Functions SDK', - mode: 'modules', - hideGenerator: true + hideGenerator: true, }; module.exports = options; diff --git a/integration_test/README.md b/integration_test/README.md index c6a0ca32d..3b0f5413f 100644 --- a/integration_test/README.md +++ b/integration_test/README.md @@ -8,6 +8,15 @@ Run the integration test as follows: ./run_tests.sh [] ``` -If just one project_id is provided, the both the node6 and node8 tests will be run on that project, in series. If two project_ids are provided, the node6 tests will be run on the first project and the node8 tests will be run on the second one, in parallel. +Test runs cycles of testing, once for Node.js 14 and another for Node.js 16. -The tests run fully automatically, and will print the result on standard out. The integration test for HTTPS is that it properly kicks off other integration tests and returns a result. From there the other integration test suites will write their results back to the database, where you can check the detailed results if you'd like. +Test uses locally installed firebase to invoke commands for deploying function. The test also requires that you have +gcloud CLI installed and authenticated (`gcloud auth login`). + +Integration test is triggered by invoking HTTP function integrationTest which in turns invokes each function trigger +by issuing actions necessary to trigger it (e.g. write to storage bucket). + +### Debugging + +The status and result of each test is stored in RTDB of the project used for testing. You can also inspect Cloud Logging +for more clues. diff --git a/integration_test/firebase.json b/integration_test/firebase.json index ce496e265..382d79c84 100644 --- a/integration_test/firebase.json +++ b/integration_test/firebase.json @@ -5,5 +5,8 @@ "firestore": { "rules": "firestore.rules", "indexes": "firestore.indexes.json" + }, + "functions": { + "predeploy": ["npm --prefix \"$RESOURCE_DIR\" run build"] } } diff --git a/integration_test/firestore.rules b/integration_test/firestore.rules index e8f8d7997..d9df6d5d1 100644 --- a/integration_test/firestore.rules +++ b/integration_test/firestore.rules @@ -1,3 +1,5 @@ +rules_version = "2"; + service cloud.firestore { match /databases/{database}/documents { match /{document=**} { diff --git a/integration_test/functions/src/auth-tests.ts b/integration_test/functions/src/auth-tests.ts deleted file mode 100644 index 2c1e1d4e6..000000000 --- a/integration_test/functions/src/auth-tests.ts +++ /dev/null @@ -1,70 +0,0 @@ -import * as admin from 'firebase-admin'; -import * as functions from 'firebase-functions'; -import { expectEq, TestSuite } from './testing'; -import UserMetadata = admin.auth.UserRecord; - -export const createUserTests: any = functions.auth.user().onCreate((u, c) => { - const testId: string = u.displayName; - console.log(`testId is ${testId}`); - - return new TestSuite('auth user onCreate') - .it('should have a project as resource', (user, context) => - expectEq(context.resource.name, `projects/${process.env.GCLOUD_PROJECT}`) - ) - - .it('should not have a path', (user, context) => - expectEq((context as any).path, undefined) - ) - - .it('should have the correct eventType', (user, context) => - expectEq(context.eventType, 'google.firebase.auth.user.create') - ) - - .it('should have an eventId', (user, context) => context.eventId) - - .it('should have a timestamp', (user, context) => context.timestamp) - - .it('should not have auth', (user, context) => - expectEq((context as any).auth, undefined) - ) - - .it('should not have action', (user, context) => - expectEq((context as any).action, undefined) - ) - - .it('should have properly defined meta', (user, context) => user.metadata) - - .run(testId, u, c); -}); - -export const deleteUserTests: any = functions.auth.user().onDelete((u, c) => { - const testId: string = u.displayName; - console.log(`testId is ${testId}`); - - return new TestSuite('auth user onDelete') - .it('should have a project as resource', (user, context) => - expectEq(context.resource.name, `projects/${process.env.GCLOUD_PROJECT}`) - ) - - .it('should not have a path', (user, context) => - expectEq((context as any).path, undefined) - ) - - .it('should have the correct eventType', (user, context) => - expectEq(context.eventType, 'google.firebase.auth.user.delete') - ) - - .it('should have an eventId', (user, context) => context.eventId) - - .it('should have a timestamp', (user, context) => context.timestamp) - - .it('should not have auth', (user, context) => - expectEq((context as any).auth, undefined) - ) - - .it('should not have action', (user, context) => - expectEq((context as any).action, undefined) - ) - - .run(testId, u, c); -}); diff --git a/integration_test/functions/src/https-tests.ts b/integration_test/functions/src/https-tests.ts deleted file mode 100644 index 55c7df983..000000000 --- a/integration_test/functions/src/https-tests.ts +++ /dev/null @@ -1,11 +0,0 @@ -import * as functions from 'firebase-functions'; -import * as _ from 'lodash'; -import { expectEq, TestSuite } from './testing'; - -export const callableTests: any = functions.https.onCall((d) => { - return new TestSuite('https onCall') - .it('should have the correct data', (data) => - expectEq(_.get(data, 'foo'), 'bar') - ) - .run(d.testId, d); -}); diff --git a/integration_test/functions/src/index.ts b/integration_test/functions/src/index.ts index 9988fe636..43378bf42 100644 --- a/integration_test/functions/src/index.ts +++ b/integration_test/functions/src/index.ts @@ -1,78 +1,214 @@ +import { PubSub } from '@google-cloud/pubsub'; import { Request, Response } from 'express'; import * as admin from 'firebase-admin'; import * as functions from 'firebase-functions'; import * as fs from 'fs'; -import * as https from 'https'; +import { GoogleAuth } from 'google-auth-library'; +import fetch from 'node-fetch'; -export * from './pubsub-tests'; -export * from './database-tests'; -export * from './auth-tests'; -export * from './firestore-tests'; -export * from './https-tests'; -export * from './remoteConfig-tests'; -export * from './storage-tests'; -export * from './testLab-tests'; -const numTests = Object.keys(exports).length; // Assumption: every exported function is its own test. +import * as v1 from './v1'; +import * as v2 from './v2'; +const getNumTests = (m: object): number => { + return Object.keys(m).filter((k) => + ({}.hasOwnProperty.call(m[k], '__endpoint')) + ).length; +}; +const numTests = getNumTests(v1) + getNumTests(v2); +export { v1, v2 }; -import * as utils from './test-utils'; -import * as testLab from './testLab-utils'; +import { REGION } from './region'; +import * as testLab from './v1/testLab-utils'; -import 'firebase-functions'; // temporary shim until process.env.FIREBASE_CONFIG available natively in GCF(BUG 63586213) const firebaseConfig = JSON.parse(process.env.FIREBASE_CONFIG); admin.initializeApp(); -// TODO(klimt): Get rid of this once the JS client SDK supports callable triggers. -function callHttpsTrigger(name: string, data: any, baseUrl) { - return utils.makeRequest( +async function callHttpsTrigger(name: string, data: any) { + const url = `https://${REGION}-${firebaseConfig.projectId}.cloudfunctions.net/${name}`; + const client = await new GoogleAuth().getIdTokenClient( + '32555940559.apps.googleusercontent.com' + ); + const resp = await client.request({ + url, + method: 'POST', + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ data }), + }); + if (resp.status > 200) { + throw Error(resp.statusText); + } +} + +async function callV2HttpsTrigger( + name: string, + data: any, + accessToken: string +) { + const getFnResp = await fetch( + `https://cloudfunctions.googleapis.com/v2beta/projects/${firebaseConfig.projectId}/locations/${REGION}/functions/${name}`, + { + headers: { + Authorization: `Bearer ${accessToken}`, + }, + } + ); + if (!getFnResp.ok) { + throw new Error(getFnResp.statusText); + } + const fn = await getFnResp.json(); + const uri = fn.serviceConfig?.uri; + if (!uri) { + throw new Error(`Cannot call v2 https trigger ${name} - no uri found`); + } + + const client = await new GoogleAuth().getIdTokenClient( + '32555940559.apps.googleusercontent.com' + ); + const invokeFnREsp = await client.request({ + url: uri, + method: 'POST', + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ data }), + }); + if (invokeFnREsp.status > 200) { + throw Error(invokeFnREsp.statusText); + } +} + +async function callScheduleTrigger( + functionName: string, + region: string, + accessToken: string +) { + const response = await fetch( + `https://cloudscheduler.googleapis.com/v1/projects/${firebaseConfig.projectId}/locations/us-central1/jobs/firebase-schedule-${functionName}-${region}:run`, { method: 'POST', - host: 'us-central1-' + firebaseConfig.projectId + '.' + baseUrl, - path: '/' + name, headers: { 'Content-Type': 'application/json', + Authorization: `Bearer ${accessToken}`, }, - }, - JSON.stringify({ data }) + } ); + if (!response.ok) { + throw new Error(`Failed request with status ${response.status}!`); + } + const data = await response.text(); + functions.logger.log(`Successfully scheduled function ${functionName}`, data); + return; } -function callScheduleTrigger(functionName: string, region: string) { - return new Promise((resolve, reject) => { - const request = https.request( - { - method: 'POST', - host: 'cloudscheduler.googleapis.com', - path: `projects/${firebaseConfig.projectId}/locations/us-central1/jobs/firebase-schedule-${functionName}-${region}:run`, - headers: { - 'Content-Type': 'application/json', - }, +async function callV2ScheduleTrigger( + functionName: string, + region: string, + accessToken: string +) { + const response = await fetch( + `https://cloudscheduler.googleapis.com/v1/projects/${firebaseConfig.projectId}/locations/us-central1/jobs/firebase-schedule-${functionName}-${region}:run`, + { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + Authorization: `Bearer ${accessToken}`, }, - (response) => { - let body = ''; - response.on('data', (chunk) => { - body += chunk; - }); - response.on('end', () => resolve(body)); - } - ); - request.on('error', reject); - request.write('{}'); - request.end(); - }); + } + ); + if (!response.ok) { + throw new Error(`Failed request with status ${response.status}!`); + } + const data = await response.text(); + functions.logger.log( + `Successfully scheduled v2 function ${functionName}`, + data + ); + return; +} + +async function updateRemoteConfig( + testId: string, + accessToken: string +): Promise { + const resp = await fetch( + `https://firebaseremoteconfig.googleapis.com/v1/projects/${firebaseConfig.projectId}/remoteConfig`, + { + method: 'PUT', + headers: { + Authorization: `Bearer ${accessToken}`, + 'Content-Type': 'application/json; UTF-8', + 'Accept-Encoding': 'gzip', + 'If-Match': '*', + }, + body: JSON.stringify({ version: { description: testId } }), + } + ); + if (!resp.ok) { + throw new Error(resp.statusText); + } +} + +function v1Tests(testId: string, accessToken: string): Array> { + return [ + // A database write to trigger the Firebase Realtime Database tests. + admin + .database() + .ref(`dbTests/${testId}/start`) + .set({ '.sv': 'timestamp' }), + // A Pub/Sub publish to trigger the Cloud Pub/Sub tests. + new PubSub() + .topic('pubsubTests') + .publish(Buffer.from(JSON.stringify({ testId }))), + // A user creation to trigger the Firebase Auth user creation tests. + admin + .auth() + .createUser({ + email: `${testId}@fake.com`, + password: 'secret', + displayName: `${testId}`, + }) + .then((userRecord) => { + // A user deletion to trigger the Firebase Auth user deletion tests. + admin.auth().deleteUser(userRecord.uid); + }), + // A firestore write to trigger the Cloud Firestore tests. + admin + .firestore() + .collection('tests') + .doc(testId) + .set({ test: testId }), + // Invoke a callable HTTPS trigger. + callHttpsTrigger('v1-callableTests', { foo: 'bar', testId }), + // A Remote Config update to trigger the Remote Config tests. + updateRemoteConfig(testId, accessToken), + // A storage upload to trigger the Storage tests + admin + .storage() + .bucket() + .upload('/tmp/' + testId + '.txt'), + testLab.startTestRun(firebaseConfig.projectId, testId, accessToken), + // Invoke the schedule for our scheduled function to fire + callScheduleTrigger('v1-schedule', 'us-central1', accessToken), + ]; +} + +function v2Tests(testId: string, accessToken: string): Array> { + return [ + // Invoke a callable HTTPS trigger. + callV2HttpsTrigger('v2-callabletests', { foo: 'bar', testId }, accessToken), + // Invoke a scheduled trigger. + callV2ScheduleTrigger('v2-schedule', 'us-central1', accessToken), + ]; } export const integrationTests: any = functions + .region(REGION) .runWith({ timeoutSeconds: 540, + invoker: 'private', }) - .https.onRequest((req: Request, resp: Response) => { - // We take the base url for our https call (cloudfunctions.net, txckloud.net, etc) from the request - // so that it changes with the environment that the tests are run in - const baseUrl = req.hostname - .split('.') - .slice(1) - .join('.'); - const pubsub: any = require('@google-cloud/pubsub')(); + .https.onRequest(async (req: Request, resp: Response) => { const testId = admin .database() .ref() @@ -81,114 +217,57 @@ export const integrationTests: any = functions .database() .ref(`testRuns/${testId}/timestamp`) .set(Date.now()); - console.log('testId is: ', testId); + const testIdRef = admin.database().ref(`testRuns/${testId}`); + functions.logger.info('testId is: ', testId); fs.writeFile('/tmp/' + testId + '.txt', 'test', () => {}); - return Promise.all([ - // A database write to trigger the Firebase Realtime Database tests. - admin - .database() - .ref(`dbTests/${testId}/start`) - .set({ '.sv': 'timestamp' }), - // A Pub/Sub publish to trigger the Cloud Pub/Sub tests. - pubsub - .topic('pubsubTests') - .publisher() - .publish(Buffer.from(JSON.stringify({ testId }))), - // A user creation to trigger the Firebase Auth user creation tests. - admin - .auth() - .createUser({ - email: `${testId}@fake.com`, - password: 'secret', - displayName: `${testId}`, - }) - .then((userRecord) => { - // A user deletion to trigger the Firebase Auth user deletion tests. - admin.auth().deleteUser(userRecord.uid); - }), - // A firestore write to trigger the Cloud Firestore tests. - admin - .firestore() - .collection('tests') - .doc(testId) - .set({ test: testId }), - // Invoke a callable HTTPS trigger. - callHttpsTrigger('callableTests', { foo: 'bar', testId }, baseUrl), - // A Remote Config update to trigger the Remote Config tests. - admin.credential + try { + const accessToken = await admin.credential .applicationDefault() - .getAccessToken() - .then((accessToken) => { - const options = { - hostname: 'firebaseremoteconfig.googleapis.com', - path: `/v1/projects/${firebaseConfig.projectId}/remoteConfig`, - method: 'PUT', - headers: { - Authorization: 'Bearer ' + accessToken.access_token, - 'Content-Type': 'application/json; UTF-8', - 'Accept-Encoding': 'gzip', - 'If-Match': '*', - }, - }; - const request = https.request(options, (resp) => {}); - request.write(JSON.stringify({ version: { description: testId } })); - request.end(); - }), - // A storage upload to trigger the Storage tests - admin - .storage() - .bucket() - .upload('/tmp/' + testId + '.txt'), - testLab.startTestRun(firebaseConfig.projectId, testId), - // Invoke the schedule for our scheduled function to fire - callScheduleTrigger('schedule', 'us-central1'), - ]) - .then(() => { - // On test completion, check that all tests pass and reply "PASS", or provide further details. - console.log('Waiting for all tests to report they pass...'); - const ref = admin.database().ref(`testRuns/${testId}`); - return new Promise((resolve, reject) => { - let testsExecuted = 0; - ref.on('child_added', (snapshot) => { - testsExecuted += 1; - if (snapshot.key != 'timestamp' && !snapshot.val().passed) { - reject( - new Error( - `test ${snapshot.key} failed; see database for details.` - ) - ); - return; - } - console.log( - `${snapshot.key} passed (${testsExecuted} of ${numTests})` + .getAccessToken(); + await Promise.all([ + ...v1Tests(testId, accessToken.access_token), + ...v2Tests(testId, accessToken.access_token), + ]); + // On test completion, check that all tests pass and reply "PASS", or provide further details. + functions.logger.info('Waiting for all tests to report they pass...'); + await new Promise((resolve, reject) => { + setTimeout(() => reject(new Error('Timeout')), 5 * 60 * 1000); + let testsExecuted = 0; + testIdRef.on('child_added', (snapshot) => { + if (snapshot.key === 'timestamp') { + return; + } + testsExecuted += 1; + if (!snapshot.val().passed) { + reject( + new Error( + `test ${snapshot.key} failed; see database for details.` + ) ); - if (testsExecuted < numTests) { - // Not all tests have completed. Wait longer. - return; - } - // All tests have passed! - resolve(); - }); - }) - .then(() => { - ref.off(); // No more need to listen. - return Promise.resolve(); - }) - .catch((err) => { - ref.off(); // No more need to listen. - return Promise.reject(err); - }); - }) - .then(() => { - console.log('All tests pass!'); - resp.status(200).send('PASS \n'); - }) - .catch((err) => { - console.log(`Some tests failed: ${err}`); - resp - .status(500) - .send( - `FAIL - details at https://${process.env.GCLOUD_PROJECT}.firebaseio.com/testRuns/${testId}` + return; + } + functions.logger.info( + `${snapshot.key} passed (${testsExecuted} of ${numTests})` ); + if (testsExecuted < numTests) { + // Not all tests have completed. Wait longer. + return; + } + // All tests have passed! + resolve(); + }); }); + functions.logger.info('All tests pass!'); + resp.status(200).send('PASS \n'); + } catch (err) { + functions.logger.info(`Some tests failed: ${err}`, err); + resp + .status(500) + .send( + `FAIL - details at ${functions.firebaseConfig() + .databaseURL!}/testRuns/${testId}` + ); + } finally { + testIdRef.off('child_added'); + } }); diff --git a/integration_test/functions/src/region.ts b/integration_test/functions/src/region.ts new file mode 100644 index 000000000..4252a4672 --- /dev/null +++ b/integration_test/functions/src/region.ts @@ -0,0 +1,2 @@ +// TODO: Add back support for selecting region for integration test once params is ready. +export const REGION = 'us-central1'; diff --git a/integration_test/functions/src/test-utils.ts b/integration_test/functions/src/test-utils.ts deleted file mode 100644 index eda799a67..000000000 --- a/integration_test/functions/src/test-utils.ts +++ /dev/null @@ -1,38 +0,0 @@ -import * as https from 'https'; - -/** - * Makes an http request asynchronously and returns the response data. - * - * This function wraps the callback-based `http.request()` function with a - * Promise. The returned Promise will be rejected in case the request fails with an - * error, or the response code is not in the 200-299 range. - * - * @param options Request options for the request. - * @param body Optional body to send as part of the request. - * @returns Promise returning the response data as string. - */ -export function makeRequest( - options: https.RequestOptions, - body?: string -): Promise { - return new Promise((resolve, reject) => { - const request = https.request(options, (response) => { - let body = ''; - response.on('data', (chunk) => { - body += chunk; - }); - response.on('end', () => { - if (response.statusCode < 200 || response.statusCode > 299) { - reject(body); - return; - } - resolve(body); - }); - }); - if (body) { - request.write(body); - } - request.on('error', reject); - request.end(); - }); -} diff --git a/integration_test/functions/src/testing.ts b/integration_test/functions/src/testing.ts index 43d3e69d5..1054c7f01 100644 --- a/integration_test/functions/src/testing.ts +++ b/integration_test/functions/src/testing.ts @@ -1,8 +1,7 @@ import * as firebase from 'firebase-admin'; -import { EventContext } from 'firebase-functions'; -import * as _ from 'lodash'; +import * as functions from 'firebase-functions'; -export type TestCase = (data: T, context?: EventContext) => any; +export type TestCase = (data: T, context?: functions.EventContext) => any; export interface TestCaseMap { [key: string]: TestCase; } @@ -21,7 +20,7 @@ export class TestSuite { return this; } - run(testId: string, data: T, context?: EventContext): Promise { + run(testId: string, data: T, context?: functions.EventContext): Promise { const running: Array> = []; for (const testName in this.tests) { if (!this.tests.hasOwnProperty(testName)) { @@ -31,7 +30,7 @@ export class TestSuite { .then(() => this.tests[testName](data, context)) .then( (result) => { - console.log( + functions.logger.info( `${result ? 'Passed' : 'Failed with successful op'}: ${testName}` ); return { name: testName, passed: !!result }; @@ -48,7 +47,7 @@ export class TestSuite { results.forEach((val) => (sum = sum + val.passed)); const summary = `passed ${sum} of ${running.length}`; const passed = sum === running.length; - console.log(summary); + functions.logger.info(summary); const result = { passed, summary, tests: results }; return firebase .database() @@ -66,43 +65,70 @@ function failure(reason: string) { return Promise.reject(reason); } -export function evaluate(value, errMsg) { +export function evaluate(value: boolean, errMsg: string) { if (value) { return success(); } return failure(errMsg); } -export function expectEq(left, right) { +export function expectEq(left: any, right: any) { return evaluate( - left === right, + left == right, JSON.stringify(left) + ' does not equal ' + JSON.stringify(right) ); } -export function expectDeepEq(left, right) { +function deepEq(left: any, right: any) { + if (left === right) { + return true; + } + + if (!(left instanceof Object && right instanceof Object)) { + return false; + } + + if (Object.keys(left).length != Object.keys(right).length) { + return false; + } + + for (const key in left) { + if (!right.hasOwnProperty(key)) { + return false; + } + if (!deepEq(left[key], right[key])) { + return false; + } + } + + return true; +} + +export function expectDeepEq(left: any, right: any) { return evaluate( - _.isEqual(left, right), - JSON.stringify(left) + ' does not equal ' + JSON.stringify(right) + deepEq(left, right), + `${JSON.stringify(left)} does not deep equal ${JSON.stringify(right)}` ); } -export function expectMatches(input: string, regexp) { +export function expectMatches(input: string, regexp: RegExp) { return evaluate( - input.match(regexp), + input.match(regexp) !== null, "Input '" + input + "' did not match regexp '" + regexp + "'" ); } -export function expectReject(f) { - return function(event) { - return Promise.resolve() - .then(() => f(event)) - .then( - () => { - throw new Error('Test should have returned a rejected promise'); - }, - () => true // A rejection is what we expected, and so is a positive result. - ); +export function expectReject(f: (e: EventType) => Promise) { + return async (event: EventType) => { + let rejected = false; + try { + await f(event); + } catch { + rejected = true; + } + + if (!rejected) { + throw new Error('Test should have returned a rejected promise'); + } }; } diff --git a/integration_test/functions/src/v1/auth-tests.ts b/integration_test/functions/src/v1/auth-tests.ts new file mode 100644 index 000000000..e6daf5162 --- /dev/null +++ b/integration_test/functions/src/v1/auth-tests.ts @@ -0,0 +1,83 @@ +import * as admin from 'firebase-admin'; +import * as functions from 'firebase-functions'; +import { REGION } from '../region'; +import { expectEq, TestSuite } from '../testing'; +import UserMetadata = admin.auth.UserRecord; + +export const createUserTests: any = functions + .region(REGION) + .auth.user() + .onCreate((u, c) => { + const testId: string = u.displayName; + functions.logger.info(`testId is ${testId}`); + + return new TestSuite('auth user onCreate') + .it('should have a project as resource', (user, context) => + expectEq( + context.resource.name, + `projects/${process.env.GCLOUD_PROJECT}` + ) + ) + + .it('should not have a path', (user, context) => + expectEq((context as any).path, undefined) + ) + + .it('should have the correct eventType', (user, context) => + expectEq(context.eventType, 'google.firebase.auth.user.create') + ) + + .it('should have an eventId', (user, context) => context.eventId) + + .it('should have a timestamp', (user, context) => context.timestamp) + + .it('should not have auth', (user, context) => + expectEq((context as any).auth, undefined) + ) + + .it('should not have action', (user, context) => + expectEq((context as any).action, undefined) + ) + + .it('should have properly defined meta', (user, context) => user.metadata) + + .run(testId, u, c); + }); + +export const deleteUserTests: any = functions + .region(REGION) + .auth.user() + .onDelete((u, c) => { + const testId: string = u.displayName; + functions.logger.info(`testId is ${testId}`); + + return new TestSuite('auth user onDelete') + .it('should have a project as resource', (user, context) => + expectEq( + context.resource.name, + `projects/${process.env.GCLOUD_PROJECT}` + ) + ) + + .it('should not have a path', (user, context) => + expectEq((context as any).path, undefined) + ) + + .it('should have the correct eventType', (user, context) => + expectEq(context.eventType, 'google.firebase.auth.user.delete') + ) + + .it('should have an eventId', (user, context) => context.eventId) + + .it('should have a timestamp', (user, context) => context.timestamp) + + .it('should not have auth', (user, context) => + expectEq((context as any).auth, undefined) + ) + + .it('should not have action', (user, context) => + expectEq((context as any).action, undefined) + ) + + .run(testId, u, c); + }); diff --git a/integration_test/functions/src/database-tests.ts b/integration_test/functions/src/v1/database-tests.ts similarity index 79% rename from integration_test/functions/src/database-tests.ts rename to integration_test/functions/src/v1/database-tests.ts index de3030d3a..fe3e29f17 100644 --- a/integration_test/functions/src/database-tests.ts +++ b/integration_test/functions/src/v1/database-tests.ts @@ -1,15 +1,17 @@ import * as admin from 'firebase-admin'; import * as functions from 'firebase-functions'; -import { expectEq, expectMatches, TestSuite } from './testing'; +import { REGION } from '../region'; +import { expectEq, expectMatches, TestSuite } from '../testing'; import DataSnapshot = admin.database.DataSnapshot; const testIdFieldName = 'testId'; -export const databaseTests: any = functions.database - .ref('dbTests/{testId}/start') +export const databaseTests: any = functions + .region(REGION) + .database.ref('dbTests/{testId}/start') .onWrite((ch, ctx) => { if (ch.after.val() === null) { - console.log( + functions.logger.info( 'Event for ' + ctx.params[testIdFieldName] + ' is null; presuming data cleanup, so skipping.' @@ -38,7 +40,7 @@ export const databaseTests: any = functions.database return expectMatches( url, new RegExp( - `^https://${process.env.GCLOUD_PROJECT}.firebaseio.com/dbTests` + `^https://${process.env.GCLOUD_PROJECT}(-default-rtdb)*.firebaseio.com/dbTests` ) ); }) @@ -48,9 +50,11 @@ export const databaseTests: any = functions.database }) .it('should have refs resources', (change, context) => - expectEq( + expectMatches( context.resource.name, - `projects/_/instances/${process.env.GCLOUD_PROJECT}/refs/dbTests/${context.params.testId}/start` + new RegExp( + `^projects/_/instances/${process.env.GCLOUD_PROJECT}(-default-rtdb)*/refs/dbTests/${context.params.testId}/start$` + ) ) ) diff --git a/integration_test/functions/src/firestore-tests.ts b/integration_test/functions/src/v1/firestore-tests.ts similarity index 92% rename from integration_test/functions/src/firestore-tests.ts rename to integration_test/functions/src/v1/firestore-tests.ts index 49d1ae919..51a93d021 100644 --- a/integration_test/functions/src/firestore-tests.ts +++ b/integration_test/functions/src/v1/firestore-tests.ts @@ -1,6 +1,7 @@ import * as admin from 'firebase-admin'; import * as functions from 'firebase-functions'; -import { expectDeepEq, expectEq, TestSuite } from './testing'; +import { REGION } from '../region'; +import { expectDeepEq, expectEq, TestSuite } from '../testing'; import DocumentSnapshot = admin.firestore.DocumentSnapshot; const testIdFieldName = 'documentId'; @@ -9,6 +10,7 @@ export const firestoreTests: any = functions .runWith({ timeoutSeconds: 540, }) + .region(REGION) .firestore.document('tests/{documentId}') .onCreate((s, c) => { return new TestSuite('firestore document onWrite') diff --git a/integration_test/functions/src/v1/https-tests.ts b/integration_test/functions/src/v1/https-tests.ts new file mode 100644 index 000000000..bce05f341 --- /dev/null +++ b/integration_test/functions/src/v1/https-tests.ts @@ -0,0 +1,14 @@ +import * as functions from 'firebase-functions'; +import { REGION } from '../region'; +import { expectEq, TestSuite } from '../testing'; + +export const callableTests: any = functions + .runWith({ invoker: 'private' }) + .region(REGION) + .https.onCall((d) => { + return new TestSuite('https onCall') + .it('should have the correct data', (data: any) => + expectEq(data?.foo, 'bar') + ) + .run(d.testId, d); + }); diff --git a/integration_test/functions/src/v1/index.ts b/integration_test/functions/src/v1/index.ts new file mode 100644 index 000000000..6e6717b15 --- /dev/null +++ b/integration_test/functions/src/v1/index.ts @@ -0,0 +1,8 @@ +export * from './pubsub-tests'; +export * from './database-tests'; +export * from './auth-tests'; +export * from './firestore-tests'; +export * from './https-tests'; +export * from './remoteConfig-tests'; +export * from './storage-tests'; +export * from './testLab-tests'; diff --git a/integration_test/functions/src/pubsub-tests.ts b/integration_test/functions/src/v1/pubsub-tests.ts similarity index 72% rename from integration_test/functions/src/pubsub-tests.ts rename to integration_test/functions/src/v1/pubsub-tests.ts index 3c1b1ecc7..515708e07 100644 --- a/integration_test/functions/src/pubsub-tests.ts +++ b/integration_test/functions/src/v1/pubsub-tests.ts @@ -1,12 +1,14 @@ import * as admin from 'firebase-admin'; import * as functions from 'firebase-functions'; -import { evaluate, expectEq, success, TestSuite } from './testing'; +import { REGION } from '../region'; +import { evaluate, expectEq, success, TestSuite } from '../testing'; import PubsubMessage = functions.pubsub.Message; // TODO(inlined) use multiple queues to run inline. // Expected message data: {"hello": "world"} -export const pubsubTests: any = functions.pubsub - .topic('pubsubTests') +export const pubsubTests: any = functions + .region(REGION) + .pubsub.topic('pubsubTests') .onPublish((m, c) => { let testId: string; try { @@ -59,23 +61,19 @@ export const pubsubTests: any = functions.pubsub .run(testId, m, c); }); -export const schedule: any = functions.pubsub - .schedule('every 10 hours') // This is a dummy schedule, since we need to put a valid one in. +export const schedule: any = functions + .region(REGION) + .pubsub.schedule('every 10 hours') // This is a dummy schedule, since we need to put a valid one in. // For the test, the job is triggered by the jobs:run api - .onRun((context) => { - let testId; + .onRun(async (context) => { const db = admin.database(); - return new Promise(async (resolve, reject) => { - await db - .ref('testRuns') - .orderByChild('timestamp') - .limitToLast(1) - .on('value', (snap) => { - testId = Object.keys(snap.val())[0]; - new TestSuite('pubsub scheduleOnRun') - .it('should trigger when the scheduler fires', () => success()) - .run(testId, null); - }); - resolve(); - }); + const snap = await db + .ref('testRuns') + .orderByChild('timestamp') + .limitToLast(1) + .once('value'); + const testId = Object.keys(snap.val())[0]; + return new TestSuite('pubsub scheduleOnRun') + .it('should trigger when the scheduler fires', () => success()) + .run(testId, null); }); diff --git a/integration_test/functions/src/remoteConfig-tests.ts b/integration_test/functions/src/v1/remoteConfig-tests.ts similarity index 80% rename from integration_test/functions/src/remoteConfig-tests.ts rename to integration_test/functions/src/v1/remoteConfig-tests.ts index 3474e1fc2..47e70461b 100644 --- a/integration_test/functions/src/remoteConfig-tests.ts +++ b/integration_test/functions/src/v1/remoteConfig-tests.ts @@ -1,9 +1,11 @@ import * as functions from 'firebase-functions'; -import { expectEq, TestSuite } from './testing'; +import { REGION } from '../region'; +import { expectEq, TestSuite } from '../testing'; import TemplateVersion = functions.remoteConfig.TemplateVersion; -export const remoteConfigTests: any = functions.remoteConfig.onUpdate( - (v, c) => { +export const remoteConfigTests: any = functions + .region(REGION) + .remoteConfig.onUpdate((v, c) => { return new TestSuite('remoteConfig onUpdate') .it('should have a project as resource', (version, context) => expectEq( @@ -25,5 +27,4 @@ export const remoteConfigTests: any = functions.remoteConfig.onUpdate( ) .run(v.description, v, c); - } -); + }); diff --git a/integration_test/functions/src/storage-tests.ts b/integration_test/functions/src/v1/storage-tests.ts similarity index 88% rename from integration_test/functions/src/storage-tests.ts rename to integration_test/functions/src/v1/storage-tests.ts index 43cdef5e2..51b947293 100644 --- a/integration_test/functions/src/storage-tests.ts +++ b/integration_test/functions/src/v1/storage-tests.ts @@ -1,11 +1,13 @@ import * as functions from 'firebase-functions'; -import { expectEq, TestSuite } from './testing'; +import { REGION } from '../region'; +import { expectEq, TestSuite } from '../testing'; import ObjectMetadata = functions.storage.ObjectMetadata; export const storageTests: any = functions .runWith({ timeoutSeconds: 540, }) + .region(REGION) .storage.bucket() .object() .onFinalize((s, c) => { diff --git a/integration_test/functions/src/testLab-tests.ts b/integration_test/functions/src/v1/testLab-tests.ts similarity index 73% rename from integration_test/functions/src/testLab-tests.ts rename to integration_test/functions/src/v1/testLab-tests.ts index a6350c57d..8e1986ce0 100644 --- a/integration_test/functions/src/testLab-tests.ts +++ b/integration_test/functions/src/v1/testLab-tests.ts @@ -1,19 +1,18 @@ import * as functions from 'firebase-functions'; -import * as _ from 'lodash'; -import { TestSuite, expectEq } from './testing'; +import { REGION } from '../region'; +import { expectEq, TestSuite } from '../testing'; import TestMatrix = functions.testLab.TestMatrix; export const testLabTests: any = functions .runWith({ timeoutSeconds: 540, }) + .region(REGION) .testLab.testMatrix() .onComplete((matrix, context) => { return new TestSuite('test matrix complete') .it('should have eventId', (snap, context) => context.eventId) - .it('should have timestamp', (snap, context) => context.timestamp) - .it('should have right eventType', (_, context) => expectEq(context.eventType, 'google.testing.testMatrix.complete') ) @@ -22,5 +21,5 @@ export const testLabTests: any = functions expectEq(matrix.state, 'INVALID') ) - .run(_.get(matrix, 'clientInfo.details.testId'), matrix, context); + .run(matrix?.clientInfo?.details?.testId, matrix, context); }); diff --git a/integration_test/functions/src/testLab-utils.ts b/integration_test/functions/src/v1/testLab-utils.ts similarity index 57% rename from integration_test/functions/src/testLab-utils.ts rename to integration_test/functions/src/v1/testLab-utils.ts index 2f457e70d..870c9b8ec 100644 --- a/integration_test/functions/src/testLab-utils.ts +++ b/integration_test/functions/src/v1/testLab-utils.ts @@ -1,8 +1,5 @@ -import * as http from 'http'; -import * as https from 'https'; import * as admin from 'firebase-admin'; -import * as _ from 'lodash'; -import * as utils from './test-utils'; +import fetch from 'node-fetch'; interface AndroidDevice { androidModelId: string; @@ -19,23 +16,32 @@ const TESTING_API_SERVICE_NAME = 'testing.googleapis.com'; * * @param projectId Project for which the test run will be created * @param testId Test id which will be encoded in client info details + * @param accessToken accessToken to attach to requested for authentication */ -export async function startTestRun(projectId: string, testId: string) { - const accessToken = await admin.credential - .applicationDefault() - .getAccessToken(); +export async function startTestRun( + projectId: string, + testId: string, + accessToken: string +) { const device = await fetchDefaultDevice(accessToken); return await createTestMatrix(accessToken, projectId, testId, device); } -async function fetchDefaultDevice( - accessToken: admin.GoogleOAuthAccessToken -): Promise { - const response = await utils.makeRequest( - requestOptions(accessToken, 'GET', '/v1/testEnvironmentCatalog/ANDROID') +async function fetchDefaultDevice(accessToken: string): Promise { + const resp = await fetch( + `https://${TESTING_API_SERVICE_NAME}/v1/testEnvironmentCatalog/ANDROID`, + { + headers: { + Authorization: 'Bearer ' + accessToken, + 'Content-Type': 'application/json', + }, + } ); - const data = JSON.parse(response); - const models = _.get(data, 'androidDeviceCatalog.models', []); + if (!resp.ok) { + throw new Error(resp.statusText); + } + const data = await resp.json(); + const models = data?.androidDeviceCatalog?.models || []; const defaultModels = models.filter( (m) => m.tags !== undefined && @@ -51,27 +57,22 @@ async function fetchDefaultDevice( const model = defaultModels[0]; const versions = model.supportedVersionIds; - return { + return { androidModelId: model.id, androidVersionId: versions[versions.length - 1], locale: 'en', orientation: 'portrait', - }; + } as AndroidDevice; } -function createTestMatrix( - accessToken: admin.GoogleOAuthAccessToken, +async function createTestMatrix( + accessToken: string, projectId: string, testId: string, device: AndroidDevice -): Promise { - const options = requestOptions( - accessToken, - 'POST', - '/v1/projects/' + projectId + '/testMatrices' - ); +): Promise { const body = { - projectId: projectId, + projectId, testSpecification: { androidRoboTest: { appApk: { @@ -97,21 +98,19 @@ function createTestMatrix( }, }, }; - return utils.makeRequest(options, JSON.stringify(body)); -} - -function requestOptions( - accessToken: admin.GoogleOAuthAccessToken, - method: string, - path: string -): https.RequestOptions { - return { - method: method, - hostname: TESTING_API_SERVICE_NAME, - path: path, - headers: { - Authorization: 'Bearer ' + accessToken.access_token, - 'Content-Type': 'application/json', - }, - }; + const resp = await fetch( + `https://${TESTING_API_SERVICE_NAME}/v1/projects/${projectId}/testMatrices`, + { + method: 'POST', + headers: { + Authorization: 'Bearer ' + accessToken, + 'Content-Type': 'application/json', + }, + body: JSON.stringify(body), + } + ); + if (!resp.ok) { + throw new Error(resp.statusText); + } + return; } diff --git a/integration_test/functions/src/v2/https-tests.ts b/integration_test/functions/src/v2/https-tests.ts new file mode 100644 index 000000000..448464ef0 --- /dev/null +++ b/integration_test/functions/src/v2/https-tests.ts @@ -0,0 +1,10 @@ +import { onCall } from 'firebase-functions/v2/https'; +import { expectEq, TestSuite } from '../testing'; + +export const callabletests = onCall({ invoker: 'private' }, (req) => { + return new TestSuite('v2 https onCall') + .it('should have the correct data', (data: any) => + expectEq(data?.foo, 'bar') + ) + .run(req.data.testId, req.data); +}); diff --git a/integration_test/functions/src/v2/index.ts b/integration_test/functions/src/v2/index.ts new file mode 100644 index 000000000..6b8f55e2a --- /dev/null +++ b/integration_test/functions/src/v2/index.ts @@ -0,0 +1,6 @@ +import { setGlobalOptions } from 'firebase-functions/v2'; +import { REGION } from '../region'; +setGlobalOptions({ region: REGION }); + +export * from './https-tests'; +export * from './scheduled-tests'; diff --git a/integration_test/functions/src/v2/scheduled-tests.ts b/integration_test/functions/src/v2/scheduled-tests.ts new file mode 100644 index 000000000..ffffb386c --- /dev/null +++ b/integration_test/functions/src/v2/scheduled-tests.ts @@ -0,0 +1,23 @@ +import * as admin from 'firebase-admin'; +import { onSchedule } from 'firebase-functions/v2/scheduler'; +import { REGION } from '../region'; +import { success, TestSuite } from '../testing'; + +export const schedule: any = onSchedule( + { + schedule: 'every 10 hours', + region: REGION, + }, + async (event) => { + const db = admin.database(); + const snap = await db + .ref('testRuns') + .orderByChild('timestamp') + .limitToLast(1) + .once('value'); + const testId = Object.keys(snap.val())[0]; + return new TestSuite('scheduler scheduleOnRun') + .it('should trigger when the scheduler fires', () => success()) + .run(testId, null); + } +); diff --git a/integration_test/functions/tsconfig.json b/integration_test/functions/tsconfig.json index a5bd57033..77fb279d5 100644 --- a/integration_test/functions/tsconfig.json +++ b/integration_test/functions/tsconfig.json @@ -2,7 +2,7 @@ "compilerOptions": { "lib": ["es6", "dom"], "module": "commonjs", - "target": "es6", + "target": "es2020", "noImplicitAny": false, "outDir": "lib", "declaration": true, diff --git a/integration_test/package.node8.json b/integration_test/package.json.template similarity index 51% rename from integration_test/package.node8.json rename to integration_test/package.json.template index 777c11a89..07585cbe2 100644 --- a/integration_test/package.node8.json +++ b/integration_test/package.json.template @@ -5,19 +5,18 @@ "build": "./node_modules/.bin/tsc" }, "dependencies": { - "@google-cloud/pubsub": "~0.19.0", - "@types/google-cloud__pubsub": "^0.18.0", - "@types/lodash": "~4.14.41", - "firebase-admin": "^8.0.0", - "firebase-functions": "./firebase-functions.tgz", - "lodash": "~4.17.2" + "@google-cloud/pubsub": "^2.10.0", + "firebase-admin": "__FIREBASE_ADMIN__", + "firebase-functions": "__SDK_TARBALL__", + "node-fetch": "^2.6.7" }, "main": "lib/index.js", "devDependencies": { - "typescript": "~3.5.0" + "@types/node-fetch": "^2.6.1", + "typescript": "~4.2.2" }, "engines": { - "node": "8" + "node": "__NODE_VERSION__" }, "private": true } diff --git a/integration_test/package.node10.json b/integration_test/package.node10.json deleted file mode 100644 index f45bab456..000000000 --- a/integration_test/package.node10.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "name": "functions", - "description": "Integration test for the Firebase SDK for Google Cloud Functions", - "scripts": { - "build": "./node_modules/.bin/tsc" - }, - "dependencies": { - "@google-cloud/pubsub": "~0.19.0", - "@types/google-cloud__pubsub": "^0.18.0", - "@types/lodash": "~4.14.41", - "firebase-admin": "^8.0.0", - "firebase-functions": "./firebase-functions.tgz", - "lodash": "~4.17.2" - }, - "main": "lib/index.js", - "devDependencies": { - "typescript": "~3.5.0" - }, - "engines": { - "node": "10" - }, - "private": true -} diff --git a/integration_test/run_tests.sh b/integration_test/run_tests.sh index 903936b13..681d2dc1e 100755 --- a/integration_test/run_tests.sh +++ b/integration_test/run_tests.sh @@ -3,26 +3,14 @@ # Exit immediately if a command exits with a non-zero status. set -e -function usage { - echo "Usage: ${0} []" - exit 1 -} +PROJECT_ID="${GCLOUD_PROJECT}" +TIMESTAMP=$(date +%s) -# This script takes in one required argument specifying a project_id and an -# optional arguement for a CI token that can be obtained by running -# `firebase login:ci` -# Example usage (from root dir) without token: -# ./integration_test/run_tests.sh chenky-test-proj -# Example usage (from root dir) with token: -# ./integration_test/run_tests.sh chenky-test-proj $TOKEN -if [[ "${1}" == "" ]]; then - usage +if [[ "${PROJECT_ID}" == "" ]]; then + echo "process.env.GCLOUD_PROJECT cannot be empty" + exit 1 fi -PROJECT_ID="${1}" -TIMESTAMP=$(date +%s) -TOKEN="${2}" - # Directory where this script lives. DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" @@ -38,21 +26,17 @@ function build_sdk { mv firebase-functions-*.tgz "integration_test/functions/firebase-functions-${TIMESTAMP}.tgz" } -function pick_node8 { +# Creates a Package.json from package.json.template +# @param timestmap of the current SDK build +# @param Node version to test under +function create_package_json { cd "${DIR}" - cp package.node8.json functions/package.json + cp package.json.template functions/package.json # we have to do the -e flag here so that it work both on linux and mac os, but that creates an extra # backup file called package.json-e that we should clean up afterwards. - sed -i -e "s/firebase-functions.tgz/firebase-functions-${TIMESTAMP}.tgz/g" functions/package.json - rm -f functions/package.json-e -} - -function pick_node10 { - cd "${DIR}" - cp package.node10.json functions/package.json - # we have to do the -e flag here so that it work both on linux and mac os, but that creates an extra - # backup file called package.json-e that we should clean up afterwards. - sed -i -e "s/firebase-functions.tgz/firebase-functions-${TIMESTAMP}.tgz/g" functions/package.json + sed -i -e "s/__SDK_TARBALL__/firebase-functions-$1.tgz/g" functions/package.json + sed -i -e "s/__NODE_VERSION__/$2/g" functions/package.json + sed -i -e "s/__FIREBASE_ADMIN__/$3/g" functions/package.json rm -f functions/package.json-e } @@ -68,24 +52,14 @@ function delete_all_functions { cd "${DIR}" # Try to delete, if there are errors it is because the project is already empty, # in that case do nothing. - if [[ "${TOKEN}" == "" ]]; then - firebase functions:delete callableTests createUserTests databaseTests deleteUserTests firestoreTests integrationTests pubsubTests remoteConfigTests testLabTests --force --project=$PROJECT_ID || : & - else - firebase functions:delete callableTests createUserTests databaseTests deleteUserTests firestoreTests integrationTests pubsubTests remoteConfigTests testLabTests --force --project=$PROJECT_ID --token=$TOKEN || : & - fi + firebase functions:delete integrationTests v1 v2 --force --project=$PROJECT_ID || : & wait announce "Project emptied." } function deploy { - cd "${DIR}" - ./functions/node_modules/.bin/tsc -p functions/ # Deploy functions, and security rules for database and Firestore. If the deploy fails, retry twice - if [[ "${TOKEN}" == "" ]]; then - for i in 1 2 3; do firebase deploy --project="${PROJECT_ID}" --only functions,database,firestore && break; done - else - for i in 1 2 3; do firebase deploy --project="${PROJECT_ID}" --token="${TOKEN}" --only functions,database,firestore && break; done - fi + for i in 1 2; do firebase deploy --project="${PROJECT_ID}" --only functions,database,firestore && break; done } function run_tests { @@ -95,13 +69,13 @@ function run_tests { # causing this script to start failing, but currently we don't have a very # reliable way of determining the URL dynamically. TEST_DOMAIN="cloudfunctions.net" - if [[ "${FIREBASE_FUNCTIONS_URL}" == "https://preprod-cloudfunctions.sandbox.googleapis.com" ]]; then - TEST_DOMAIN="txcloud.net" + if [[ "${FIREBASE_FUNCTIONS_TEST_REGION}" == "" ]]; then + FIREBASE_FUNCTIONS_TEST_REGION="us-central1" fi - TEST_URL="https://us-central1-${PROJECT_ID}.${TEST_DOMAIN}/integrationTests" + TEST_URL="https://${FIREBASE_FUNCTIONS_TEST_REGION}-${PROJECT_ID}.${TEST_DOMAIN}/integrationTests" echo "${TEST_URL}" - curl --fail "${TEST_URL}" + curl --fail -H "Authorization: Bearer $(gcloud auth print-identity-token)" "${TEST_URL}" } function cleanup { @@ -118,19 +92,13 @@ function cleanup { build_sdk delete_all_functions -# Node 8 tests -pick_node8 -install_deps -announce "Deploying functions to Node 8 runtime ..." -deploy -run_tests - -# Node 10 tests -pick_node10 -install_deps -announce "Re-deploying the same functions to Node 10 runtime ..." -deploy -run_tests +for version in 14 16; do + create_package_json $TIMESTAMP $version "^10.0.0" + install_deps + announce "Re-deploying the same functions to Node $version runtime ..." + deploy + run_tests +done # Cleanup cleanup diff --git a/logger/compat.js b/logger/compat.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/logger/compat.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/logger/index.js b/logger/index.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/logger/index.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 000000000..9c9e905c8 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,9872 @@ +{ + "name": "firebase-functions", + "version": "3.24.1", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "firebase-functions", + "version": "3.24.1", + "license": "MIT", + "dependencies": { + "@types/cors": "^2.8.5", + "@types/express": "4.17.3", + "cors": "^2.8.5", + "express": "^4.17.1", + "lodash": "^4.17.14", + "node-fetch": "^2.6.7" + }, + "bin": { + "firebase-functions": "lib/bin/firebase-functions.js" + }, + "devDependencies": { + "@firebase/api-documenter": "^0.2.0", + "@microsoft/api-documenter": "^7.13.45", + "@microsoft/api-extractor": "^7.18.7", + "@types/chai": "^4.1.7", + "@types/chai-as-promised": "^7.1.0", + "@types/jsonwebtoken": "^8.3.2", + "@types/lodash": "^4.14.135", + "@types/mocha": "^5.2.7", + "@types/mock-require": "^2.0.0", + "@types/nock": "^10.0.3", + "@types/node": "^8.10.50", + "@types/node-fetch": "^3.0.3", + "@types/sinon": "^7.0.13", + "api-extractor-model-me": "^0.1.1", + "chai": "^4.2.0", + "chai-as-promised": "^7.1.1", + "child-process-promise": "^2.2.1", + "firebase-admin": "^10.3.0", + "js-yaml": "^3.13.1", + "jsdom": "^16.2.1", + "jsonwebtoken": "^8.5.1", + "jwk-to-pem": "^2.0.5", + "mocha": "^6.1.4", + "mock-require": "^3.0.3", + "mz": "^2.7.0", + "nock": "^10.0.6", + "node-fetch": "^2.6.7", + "portfinder": "^1.0.28", + "prettier": "^1.18.2", + "semver": "^7.3.5", + "sinon": "^7.3.2", + "ts-node": "^10.4.0", + "tslint": "^5.18.0", + "tslint-config-prettier": "^1.18.0", + "tslint-no-unused-expression-chai": "^0.1.4", + "tslint-plugin-prettier": "^2.0.1", + "typedoc": "0.23.7", + "typescript": "^4.3.5", + "yargs": "^15.3.1" + }, + "engines": { + "node": "^8.13.0 || >=10.10.0" + }, + "peerDependencies": { + "firebase-admin": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.16.7", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/highlight": "^7.16.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.16.7", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.17.9", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.16.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@cspotcode/source-map-consumer": { + "version": "0.8.0", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">= 12" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspotcode/source-map-consumer": "0.8.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@fastify/busboy": { + "version": "1.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "text-decoding": "^1.0.0" + }, + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/@firebase/api-documenter": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@firebase/api-documenter/-/api-documenter-0.2.0.tgz", + "integrity": "sha512-WQcOP5TvtRWMfGkpJpKpyVDjcB2UYCZWFmQm/nXUYUdI6PZ/Im1yb2YydgpnSlhrZxz6C1YkYFGLYCrltks1Yw==", + "dev": true, + "dependencies": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.45.5", + "@rushstack/ts-command-line": "4.11.0", + "api-extractor-model-me": "0.1.1", + "colors": "~1.4.0", + "js-yaml": "4.1.0", + "resolve": "~1.22.0", + "tslib": "^2.1.0" + }, + "bin": { + "api-documenter-fire": "dist/start.js" + } + }, + "node_modules/@firebase/api-documenter/node_modules/@rushstack/node-core-library": { + "version": "3.45.5", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.5.tgz", + "integrity": "sha512-KbN7Hp9vH3bD3YJfv6RnVtzzTAwGYIBl7y2HQLY4WEQqRbvE3LgI78W9l9X+cTAXCX//p0EeoiUYNTFdqJrMZg==", + "dev": true, + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@firebase/api-documenter/node_modules/@rushstack/node-core-library/node_modules/colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@firebase/api-documenter/node_modules/@rushstack/node-core-library/node_modules/resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@firebase/api-documenter/node_modules/@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "node_modules/@firebase/api-documenter/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/@firebase/api-documenter/node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@firebase/api-documenter/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@firebase/api-documenter/node_modules/validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@firebase/api-documenter/node_modules/z-schema": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.3.tgz", + "integrity": "sha512-sGvEcBOTNum68x9jCpCVGPFJ6mWnkD0YxOcddDlJHRx3tKdB2q8pCHExMVZo/AV/6geuVJXG7hljDaWG8+5GDw==", + "dev": true, + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.20.3" + } + }, + "node_modules/@firebase/app-types": { + "version": "0.7.0", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/@firebase/auth-interop-types": { + "version": "0.1.6", + "dev": true, + "license": "Apache-2.0", + "peerDependencies": { + "@firebase/app-types": "0.x", + "@firebase/util": "1.x" + } + }, + "node_modules/@firebase/component": { + "version": "0.5.17", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@firebase/util": "1.6.3", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/database": { + "version": "0.13.3", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@firebase/auth-interop-types": "0.1.6", + "@firebase/component": "0.5.17", + "@firebase/logger": "0.3.3", + "@firebase/util": "1.6.3", + "faye-websocket": "0.11.4", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/database-compat": { + "version": "0.2.3", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@firebase/component": "0.5.17", + "@firebase/database": "0.13.3", + "@firebase/database-types": "0.9.11", + "@firebase/logger": "0.3.3", + "@firebase/util": "1.6.3", + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/database-types": { + "version": "0.9.11", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@firebase/app-types": "0.7.0", + "@firebase/util": "1.6.3" + } + }, + "node_modules/@firebase/logger": { + "version": "0.3.3", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@firebase/util": { + "version": "1.6.3", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "tslib": "^2.1.0" + } + }, + "node_modules/@google-cloud/firestore": { + "version": "4.15.1", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "functional-red-black-tree": "^1.0.1", + "google-gax": "^2.24.1", + "protobufjs": "^6.8.6" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@google-cloud/paginator": { + "version": "3.0.7", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "arrify": "^2.0.0", + "extend": "^3.0.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@google-cloud/projectify": { + "version": "2.1.1", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@google-cloud/promisify": { + "version": "2.0.4", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@google-cloud/storage": { + "version": "5.20.5", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@google-cloud/paginator": "^3.0.7", + "@google-cloud/projectify": "^2.0.0", + "@google-cloud/promisify": "^2.0.0", + "abort-controller": "^3.0.0", + "arrify": "^2.0.0", + "async-retry": "^1.3.3", + "compressible": "^2.0.12", + "configstore": "^5.0.0", + "duplexify": "^4.0.0", + "ent": "^2.2.0", + "extend": "^3.0.2", + "gaxios": "^4.0.0", + "google-auth-library": "^7.14.1", + "hash-stream-validation": "^0.2.2", + "mime": "^3.0.0", + "mime-types": "^2.0.8", + "p-limit": "^3.0.1", + "pumpify": "^2.0.0", + "retry-request": "^4.2.2", + "stream-events": "^1.0.4", + "teeny-request": "^7.1.3", + "uuid": "^8.0.0", + "xdg-basedir": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@google-cloud/storage/node_modules/mime": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/@grpc/grpc-js": { + "version": "1.6.7", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@grpc/proto-loader": "^0.6.4", + "@types/node": ">=12.12.47" + }, + "engines": { + "node": "^8.13.0 || >=10.10.0" + } + }, + "node_modules/@grpc/grpc-js/node_modules/@types/node": { + "version": "18.0.4", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/@grpc/proto-loader": { + "version": "0.6.13", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@types/long": "^4.0.1", + "lodash.camelcase": "^4.3.0", + "long": "^4.0.0", + "protobufjs": "^6.11.3", + "yargs": "^16.2.0" + }, + "bin": { + "proto-loader-gen-types": "build/bin/proto-loader-gen-types.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/@grpc/proto-loader/node_modules/yargs": { + "version": "16.2.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@microsoft/api-documenter": { + "version": "7.17.11", + "dev": true, + "license": "MIT", + "dependencies": { + "@microsoft/api-extractor-model": "7.17.2", + "@microsoft/tsdoc": "0.14.1", + "@rushstack/node-core-library": "3.45.4", + "@rushstack/ts-command-line": "4.10.10", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "bin": { + "api-documenter": "bin/api-documenter" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/api-documenter/node_modules/@rushstack/node-core-library": { + "version": "3.45.4", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@rushstack/ts-command-line": { + "version": "4.10.10", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/@types/node": { + "version": "12.20.24", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/api-documenter/node_modules/js-yaml": { + "version": "3.13.1", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/resolve": { + "version": "1.17.0", + "dev": true, + "license": "MIT", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/validator": { + "version": "13.7.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/z-schema": { + "version": "5.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.20.3" + } + }, + "node_modules/@microsoft/api-extractor": { + "version": "7.23.0", + "dev": true, + "license": "MIT", + "dependencies": { + "@microsoft/api-extractor-model": "7.17.2", + "@microsoft/tsdoc": "0.14.1", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.45.4", + "@rushstack/rig-package": "0.3.11", + "@rushstack/ts-command-line": "4.10.10", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.6.3" + }, + "bin": { + "api-extractor": "bin/api-extractor" + } + }, + "node_modules/@microsoft/api-extractor-model": { + "version": "7.17.2", + "dev": true, + "license": "MIT", + "dependencies": { + "@microsoft/tsdoc": "0.14.1", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.45.4" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@rushstack/node-core-library": { + "version": "3.45.4", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/@types/node": { + "version": "12.20.24", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/api-extractor-model/node_modules/resolve": { + "version": "1.17.0", + "dev": true, + "license": "MIT", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/validator": { + "version": "13.7.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@microsoft/api-extractor-model/node_modules/z-schema": { + "version": "5.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.20.3" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/api-extractor/node_modules/@rushstack/node-core-library": { + "version": "3.45.4", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@rushstack/ts-command-line": { + "version": "4.10.10", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/@types/node": { + "version": "12.20.24", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/api-extractor/node_modules/resolve": { + "version": "1.17.0", + "dev": true, + "license": "MIT", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/validator": { + "version": "13.7.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/z-schema": { + "version": "5.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "engines": { + "node": ">=8.0.0" + }, + "optionalDependencies": { + "commander": "^2.20.3" + } + }, + "node_modules/@microsoft/tsdoc": { + "version": "0.12.24", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/tsdoc-config": { + "version": "0.16.1", + "dev": true, + "license": "MIT", + "dependencies": { + "@microsoft/tsdoc": "0.14.1", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + } + }, + "node_modules/@microsoft/tsdoc-config/node_modules/@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@microsoft/tsdoc-config/node_modules/resolve": { + "version": "1.19.0", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@panva/asn1.js": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/@protobufjs/aspromise": { + "version": "1.1.2", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/base64": { + "version": "1.1.2", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/codegen": { + "version": "2.0.4", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/eventemitter": { + "version": "1.1.0", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/fetch": { + "version": "1.1.0", + "dev": true, + "license": "BSD-3-Clause", + "optional": true, + "dependencies": { + "@protobufjs/aspromise": "^1.1.1", + "@protobufjs/inquire": "^1.1.0" + } + }, + "node_modules/@protobufjs/float": { + "version": "1.0.2", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/inquire": { + "version": "1.1.0", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/path": { + "version": "1.1.2", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/pool": { + "version": "1.1.0", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@protobufjs/utf8": { + "version": "1.1.0", + "dev": true, + "license": "BSD-3-Clause", + "optional": true + }, + "node_modules/@rushstack/node-core-library": { + "version": "3.36.0", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/@types/node": { + "version": "10.17.13", + "dev": true, + "license": "MIT" + }, + "node_modules/@rushstack/node-core-library/node_modules/resolve": { + "version": "1.17.0", + "dev": true, + "license": "MIT", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@rushstack/rig-package": { + "version": "0.3.11", + "dev": true, + "license": "MIT", + "dependencies": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + } + }, + "node_modules/@rushstack/rig-package/node_modules/resolve": { + "version": "1.17.0", + "dev": true, + "license": "MIT", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@rushstack/rig-package/node_modules/strip-json-comments": { + "version": "3.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@rushstack/ts-command-line": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.11.0.tgz", + "integrity": "sha512-ptG9L0mjvJ5QtK11GsAFY+jGfsnqHDS6CY6Yw1xT7a9bhjfNYnf6UPwjV+pF6UgiucfNcMDNW9lkDLxvZKKxMg==", + "dev": true, + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "node_modules/@sinonjs/commons": { + "version": "1.8.3", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "type-detect": "4.0.8" + } + }, + "node_modules/@sinonjs/formatio": { + "version": "3.2.2", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^1", + "@sinonjs/samsam": "^3.1.0" + } + }, + "node_modules/@sinonjs/samsam": { + "version": "3.3.3", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^1.3.0", + "array-from": "^2.1.1", + "lodash": "^4.17.15" + } + }, + "node_modules/@sinonjs/text-encoding": { + "version": "0.7.1", + "dev": true, + "license": "(Unlicense OR Apache-2.0)" + }, + "node_modules/@tootallnate/once": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">= 10" + } + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.8", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.9", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.2", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/argparse": { + "version": "1.0.38", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/body-parser": { + "version": "1.19.2", + "license": "MIT", + "dependencies": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "node_modules/@types/body-parser/node_modules/@types/node": { + "version": "17.0.29", + "license": "MIT" + }, + "node_modules/@types/chai": { + "version": "4.3.1", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/chai-as-promised": { + "version": "7.1.5", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "*" + } + }, + "node_modules/@types/connect": { + "version": "3.4.35", + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/connect/node_modules/@types/node": { + "version": "17.0.29", + "license": "MIT" + }, + "node_modules/@types/cors": { + "version": "2.8.12", + "license": "MIT" + }, + "node_modules/@types/express": { + "version": "4.17.3", + "license": "MIT", + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "*", + "@types/serve-static": "*" + } + }, + "node_modules/@types/express-serve-static-core": { + "version": "4.17.28", + "license": "MIT", + "dependencies": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*" + } + }, + "node_modules/@types/express-serve-static-core/node_modules/@types/node": { + "version": "17.0.29", + "license": "MIT" + }, + "node_modules/@types/jsonwebtoken": { + "version": "8.5.8", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/lodash": { + "version": "4.14.182", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/long": { + "version": "4.0.2", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/@types/mime": { + "version": "1.3.2", + "license": "MIT" + }, + "node_modules/@types/mocha": { + "version": "5.2.7", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/mock-require": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/nock": { + "version": "10.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/node": { + "version": "8.10.66", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/node-fetch": { + "version": "3.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "node-fetch": "*" + } + }, + "node_modules/@types/qs": { + "version": "6.9.7", + "license": "MIT" + }, + "node_modules/@types/range-parser": { + "version": "1.2.4", + "license": "MIT" + }, + "node_modules/@types/serve-static": { + "version": "1.13.10", + "license": "MIT", + "dependencies": { + "@types/mime": "^1", + "@types/node": "*" + } + }, + "node_modules/@types/serve-static/node_modules/@types/node": { + "version": "17.0.29", + "license": "MIT" + }, + "node_modules/@types/sinon": { + "version": "7.5.2", + "dev": true, + "license": "MIT" + }, + "node_modules/abab": { + "version": "2.0.6", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/abort-controller": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "event-target-shim": "^5.0.0" + }, + "engines": { + "node": ">=6.5" + } + }, + "node_modules/accepts": { + "version": "1.3.8", + "license": "MIT", + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/acorn": { + "version": "8.7.1", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-globals": { + "version": "6.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "acorn": "^7.1.1", + "acorn-walk": "^7.1.1" + } + }, + "node_modules/acorn-globals/node_modules/acorn": { + "version": "7.4.1", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "7.2.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/agent-base": { + "version": "6.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "4" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/agent-base/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/agent-base/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT" + }, + "node_modules/ajv": { + "version": "6.12.6", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-colors": { + "version": "3.2.3", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/any-promise": { + "version": "1.3.0", + "dev": true, + "license": "MIT" + }, + "node_modules/api-extractor-model-me": { + "version": "0.1.1", + "dev": true, + "license": "MIT", + "dependencies": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0" + } + }, + "node_modules/arg": { + "version": "4.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/argparse": { + "version": "1.0.10", + "dev": true, + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/array-flatten": { + "version": "1.1.1", + "license": "MIT" + }, + "node_modules/array-from": { + "version": "2.1.1", + "dev": true, + "license": "MIT" + }, + "node_modules/arrify": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/asn1.js": { + "version": "5.4.1", + "dev": true, + "license": "MIT", + "dependencies": { + "bn.js": "^4.0.0", + "inherits": "^2.0.1", + "minimalistic-assert": "^1.0.0", + "safer-buffer": "^2.1.0" + } + }, + "node_modules/assertion-error": { + "version": "1.1.0", + "dev": true, + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/async": { + "version": "2.6.4", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash": "^4.17.14" + } + }, + "node_modules/async-retry": { + "version": "1.3.3", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "retry": "0.13.1" + } + }, + "node_modules/asynckit": { + "version": "0.4.0", + "dev": true, + "license": "MIT" + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "dev": true, + "license": "MIT" + }, + "node_modules/base64-js": { + "version": "1.5.1", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "optional": true + }, + "node_modules/bignumber.js": { + "version": "9.0.2", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": "*" + } + }, + "node_modules/bn.js": { + "version": "4.12.0", + "dev": true, + "license": "MIT" + }, + "node_modules/body-parser": { + "version": "1.20.0", + "license": "MIT", + "dependencies": { + "bytes": "3.1.2", + "content-type": "~1.0.4", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.10.3", + "raw-body": "2.5.1", + "type-is": "~1.6.18", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/brorand": { + "version": "1.1.0", + "dev": true, + "license": "MIT" + }, + "node_modules/browser-process-hrtime": { + "version": "1.0.0", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/browser-stdout": { + "version": "1.3.1", + "dev": true, + "license": "ISC" + }, + "node_modules/buffer-equal-constant-time": { + "version": "1.0.1", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/builtin-modules": { + "version": "1.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/bytes": { + "version": "3.1.2", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/call-bind": { + "version": "1.0.2", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/chai": { + "version": "4.3.6", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^1.1.0", + "check-error": "^1.0.2", + "deep-eql": "^3.0.1", + "get-func-name": "^2.0.0", + "loupe": "^2.3.1", + "pathval": "^1.1.1", + "type-detect": "^4.0.5" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/chai-as-promised": { + "version": "7.1.1", + "dev": true, + "license": "WTFPL", + "dependencies": { + "check-error": "^1.0.2" + }, + "peerDependencies": { + "chai": ">= 2.1.2 < 5" + } + }, + "node_modules/chalk": { + "version": "2.4.2", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/chalk/node_modules/ansi-styles": { + "version": "3.2.1", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/chalk/node_modules/color-convert": { + "version": "1.9.3", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/chalk/node_modules/color-name": { + "version": "1.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/chalk/node_modules/supports-color": { + "version": "5.5.0", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/check-error": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/child-process-promise": { + "version": "2.2.1", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^4.0.2", + "node-version": "^1.0.0", + "promise-polyfill": "^6.0.1" + } + }, + "node_modules/cliui": { + "version": "7.0.4", + "dev": true, + "license": "ISC", + "optional": true, + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "dev": true, + "license": "MIT" + }, + "node_modules/colors": { + "version": "1.2.5", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "dev": true, + "license": "MIT", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/commander": { + "version": "2.20.3", + "dev": true, + "license": "MIT" + }, + "node_modules/compressible": { + "version": "2.0.18", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "mime-db": ">= 1.43.0 < 2" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/concat-map": { + "version": "0.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/configstore": { + "version": "5.0.1", + "dev": true, + "license": "BSD-2-Clause", + "optional": true, + "dependencies": { + "dot-prop": "^5.2.0", + "graceful-fs": "^4.1.2", + "make-dir": "^3.0.0", + "unique-string": "^2.0.0", + "write-file-atomic": "^3.0.0", + "xdg-basedir": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/content-disposition": { + "version": "0.5.4", + "license": "MIT", + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.4", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie": { + "version": "0.5.0", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.6", + "license": "MIT" + }, + "node_modules/cors": { + "version": "2.8.5", + "license": "MIT", + "dependencies": { + "object-assign": "^4", + "vary": "^1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/create-require": { + "version": "1.1.1", + "dev": true, + "license": "MIT" + }, + "node_modules/cross-spawn": { + "version": "4.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "lru-cache": "^4.0.1", + "which": "^1.2.9" + } + }, + "node_modules/crypto-random-string": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/cssom": { + "version": "0.4.4", + "dev": true, + "license": "MIT" + }, + "node_modules/cssstyle": { + "version": "2.3.0", + "dev": true, + "license": "MIT", + "dependencies": { + "cssom": "~0.3.6" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cssstyle/node_modules/cssom": { + "version": "0.3.8", + "dev": true, + "license": "MIT" + }, + "node_modules/data-urls": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "abab": "^2.0.3", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/data-urls/node_modules/tr46": { + "version": "2.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/data-urls/node_modules/webidl-conversions": { + "version": "6.1.0", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=10.4" + } + }, + "node_modules/data-urls/node_modules/whatwg-url": { + "version": "8.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash": "^4.7.0", + "tr46": "^2.1.0", + "webidl-conversions": "^6.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/debug": { + "version": "2.6.9", + "license": "MIT", + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/decamelize": { + "version": "1.2.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/decimal.js": { + "version": "10.3.1", + "dev": true, + "license": "MIT" + }, + "node_modules/deep-eql": { + "version": "3.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "type-detect": "^4.0.0" + }, + "engines": { + "node": ">=0.12" + } + }, + "node_modules/deep-equal": { + "version": "1.1.1", + "dev": true, + "license": "MIT", + "dependencies": { + "is-arguments": "^1.0.4", + "is-date-object": "^1.0.1", + "is-regex": "^1.0.4", + "object-is": "^1.0.1", + "object-keys": "^1.1.1", + "regexp.prototype.flags": "^1.2.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/deep-is": { + "version": "0.1.4", + "dev": true, + "license": "MIT" + }, + "node_modules/define-properties": { + "version": "1.1.4", + "dev": true, + "license": "MIT", + "dependencies": { + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "license": "MIT", + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/diff": { + "version": "3.5.0", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/domexception": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "webidl-conversions": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/domexception/node_modules/webidl-conversions": { + "version": "5.0.0", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/dot-prop": { + "version": "5.3.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "is-obj": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/duplexify": { + "version": "4.1.2", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "end-of-stream": "^1.4.1", + "inherits": "^2.0.3", + "readable-stream": "^3.1.1", + "stream-shift": "^1.0.0" + } + }, + "node_modules/ecdsa-sig-formatter": { + "version": "1.0.11", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "safe-buffer": "^5.0.1" + } + }, + "node_modules/ee-first": { + "version": "1.1.1", + "license": "MIT" + }, + "node_modules/elliptic": { + "version": "6.5.4", + "dev": true, + "license": "MIT", + "dependencies": { + "bn.js": "^4.11.9", + "brorand": "^1.1.0", + "hash.js": "^1.0.0", + "hmac-drbg": "^1.0.1", + "inherits": "^2.0.4", + "minimalistic-assert": "^1.0.1", + "minimalistic-crypto-utils": "^1.0.1" + } + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "dev": true, + "license": "MIT" + }, + "node_modules/encodeurl": { + "version": "1.0.2", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/end-of-stream": { + "version": "1.4.4", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "once": "^1.4.0" + } + }, + "node_modules/ent": { + "version": "2.2.0", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/es-abstract": { + "version": "1.19.5", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "get-symbol-description": "^1.0.0", + "has": "^1.0.3", + "has-symbols": "^1.0.3", + "internal-slot": "^1.0.3", + "is-callable": "^1.2.4", + "is-negative-zero": "^2.0.2", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "is-string": "^1.0.7", + "is-weakref": "^1.0.2", + "object-inspect": "^1.12.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-abstract/node_modules/object.assign": { + "version": "4.1.2", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escalade": { + "version": "3.1.1", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "license": "MIT" + }, + "node_modules/escape-string-regexp": { + "version": "1.0.5", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/escodegen": { + "version": "2.0.0", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esprima": "^4.0.1", + "estraverse": "^5.2.0", + "esutils": "^2.0.2", + "optionator": "^0.8.1" + }, + "bin": { + "escodegen": "bin/escodegen.js", + "esgenerate": "bin/esgenerate.js" + }, + "engines": { + "node": ">=6.0" + }, + "optionalDependencies": { + "source-map": "~0.6.1" + } + }, + "node_modules/eslint-plugin-prettier": { + "version": "2.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-diff": "^1.1.1", + "jest-docblock": "^21.0.0" + }, + "engines": { + "node": ">=4.0.0" + }, + "peerDependencies": { + "prettier": ">= 0.11.0" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "dev": true, + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esutils": { + "version": "2.0.3", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/etag": { + "version": "1.8.1", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/event-target-shim": { + "version": "5.0.1", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/express": { + "version": "4.18.0", + "license": "MIT", + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "1.20.0", + "content-disposition": "0.5.4", + "content-type": "~1.0.4", + "cookie": "0.5.0", + "cookie-signature": "1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "1.2.0", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "merge-descriptors": "1.0.1", + "methods": "~1.1.2", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "0.1.7", + "proxy-addr": "~2.0.7", + "qs": "6.10.3", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "0.18.0", + "serve-static": "1.15.0", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-diff": { + "version": "1.2.0", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-text-encoding": { + "version": "1.0.4", + "dev": true, + "license": "Apache-2.0", + "optional": true + }, + "node_modules/faye-websocket": { + "version": "0.11.4", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "websocket-driver": ">=0.5.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/finalhandler": { + "version": "1.2.0", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "statuses": "2.0.1", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/find-up": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/firebase-admin": { + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/firebase-admin/-/firebase-admin-10.3.0.tgz", + "integrity": "sha512-A0wgMLEjyVyUE+heyMJYqHRkPVjpebhOYsa47RHdrTM4ltApcx8Tn86sUmjqxlfh09gNnILAm7a8q5+FmgBYpg==", + "dev": true, + "dependencies": { + "@fastify/busboy": "^1.1.0", + "@firebase/database-compat": "^0.2.0", + "@firebase/database-types": "^0.9.7", + "@types/node": ">=12.12.47", + "jsonwebtoken": "^8.5.1", + "jwks-rsa": "^2.0.2", + "node-forge": "^1.3.1", + "uuid": "^8.3.2" + }, + "engines": { + "node": ">=12.7.0" + }, + "optionalDependencies": { + "@google-cloud/firestore": "^4.15.1", + "@google-cloud/storage": "^5.18.3" + } + }, + "node_modules/firebase-admin/node_modules/@types/node": { + "version": "18.0.4", + "dev": true, + "license": "MIT" + }, + "node_modules/flat": { + "version": "4.1.1", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "is-buffer": "~2.0.3" + }, + "bin": { + "flat": "cli.js" + } + }, + "node_modules/form-data": { + "version": "3.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/forwarded": { + "version": "0.2.0", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fs-extra": { + "version": "7.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "dev": true, + "license": "ISC" + }, + "node_modules/function-bind": { + "version": "1.1.1", + "license": "MIT" + }, + "node_modules/functional-red-black-tree": { + "version": "1.0.1", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gaxios": { + "version": "4.3.3", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "abort-controller": "^3.0.0", + "extend": "^3.0.2", + "https-proxy-agent": "^5.0.0", + "is-stream": "^2.0.0", + "node-fetch": "^2.6.7" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/gcp-metadata": { + "version": "4.3.1", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "gaxios": "^4.0.0", + "json-bigint": "^1.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "dev": true, + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-func-name": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.1.1", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-symbol-description": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/glob": { + "version": "7.1.3", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + } + }, + "node_modules/google-auth-library": { + "version": "7.14.1", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "arrify": "^2.0.0", + "base64-js": "^1.3.0", + "ecdsa-sig-formatter": "^1.0.11", + "fast-text-encoding": "^1.0.0", + "gaxios": "^4.0.0", + "gcp-metadata": "^4.2.0", + "gtoken": "^5.0.4", + "jws": "^4.0.0", + "lru-cache": "^6.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/google-auth-library/node_modules/lru-cache": { + "version": "6.0.0", + "dev": true, + "license": "ISC", + "optional": true, + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/google-auth-library/node_modules/yallist": { + "version": "4.0.0", + "dev": true, + "license": "ISC", + "optional": true + }, + "node_modules/google-gax": { + "version": "2.30.5", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "@grpc/grpc-js": "~1.6.0", + "@grpc/proto-loader": "^0.6.12", + "@types/long": "^4.0.0", + "abort-controller": "^3.0.0", + "duplexify": "^4.0.0", + "fast-text-encoding": "^1.0.3", + "google-auth-library": "^7.14.0", + "is-stream-ended": "^0.1.4", + "node-fetch": "^2.6.1", + "object-hash": "^3.0.0", + "proto3-json-serializer": "^0.1.8", + "protobufjs": "6.11.3", + "retry-request": "^4.0.0" + }, + "bin": { + "compileProtos": "build/tools/compileProtos.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/google-p12-pem": { + "version": "3.1.4", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "node-forge": "^1.3.1" + }, + "bin": { + "gp12-pem": "build/src/bin/gp12-pem.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.10", + "dev": true, + "license": "ISC" + }, + "node_modules/growl": { + "version": "1.10.5", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4.x" + } + }, + "node_modules/gtoken": { + "version": "5.3.2", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "gaxios": "^4.0.0", + "google-p12-pem": "^3.1.3", + "jws": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/has": { + "version": "1.0.3", + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-bigints": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.1.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hash-stream-validation": { + "version": "0.2.4", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/hash.js": { + "version": "1.1.7", + "dev": true, + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "minimalistic-assert": "^1.0.1" + } + }, + "node_modules/he": { + "version": "1.2.0", + "dev": true, + "license": "MIT", + "bin": { + "he": "bin/he" + } + }, + "node_modules/hmac-drbg": { + "version": "1.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "hash.js": "^1.0.3", + "minimalistic-assert": "^1.0.0", + "minimalistic-crypto-utils": "^1.0.1" + } + }, + "node_modules/html-encoding-sniffer": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-encoding": "^1.0.5" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/http-errors": { + "version": "2.0.0", + "license": "MIT", + "dependencies": { + "depd": "2.0.0", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "toidentifier": "1.0.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/http-parser-js": { + "version": "0.5.8", + "dev": true, + "license": "MIT" + }, + "node_modules/http-proxy-agent": { + "version": "5.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "@tootallnate/once": "2", + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/http-proxy-agent/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/http-proxy-agent/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/https-proxy-agent": { + "version": "5.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/https-proxy-agent/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/https-proxy-agent/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT" + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/import-lazy": { + "version": "4.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "dev": true, + "license": "ISC", + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "license": "ISC" + }, + "node_modules/internal-slot": { + "version": "1.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.1.0", + "has": "^1.0.3", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ipaddr.js": { + "version": "1.9.1", + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/is-arguments": { + "version": "1.1.1", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-bigint": { + "version": "1.0.4", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-buffer": { + "version": "2.0.5", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/is-callable": { + "version": "1.2.4", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-core-module": { + "version": "2.9.0", + "dev": true, + "license": "MIT", + "dependencies": { + "has": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.5", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-negative-zero": { + "version": "2.0.2", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number-object": { + "version": "1.0.7", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-obj": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-potential-custom-element-name": { + "version": "1.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/is-regex": { + "version": "1.1.4", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-stream-ended": { + "version": "0.1.4", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/is-string": { + "version": "1.0.7", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/is-weakref": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "0.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/isexe": { + "version": "2.0.0", + "dev": true, + "license": "ISC" + }, + "node_modules/jest-docblock": { + "version": "21.2.0", + "dev": true, + "license": "MIT" + }, + "node_modules/jju": { + "version": "1.4.0", + "dev": true, + "license": "MIT" + }, + "node_modules/jose": { + "version": "2.0.5", + "dev": true, + "license": "MIT", + "dependencies": { + "@panva/asn1.js": "^1.0.0" + }, + "engines": { + "node": ">=10.13.0 < 13 || >=13.7.0" + }, + "funding": { + "url": "https://github.com/sponsors/panva" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "dev": true, + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "3.14.1", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsdom": { + "version": "16.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "abab": "^2.0.5", + "acorn": "^8.2.4", + "acorn-globals": "^6.0.0", + "cssom": "^0.4.4", + "cssstyle": "^2.3.0", + "data-urls": "^2.0.0", + "decimal.js": "^10.2.1", + "domexception": "^2.0.1", + "escodegen": "^2.0.0", + "form-data": "^3.0.0", + "html-encoding-sniffer": "^2.0.1", + "http-proxy-agent": "^4.0.1", + "https-proxy-agent": "^5.0.0", + "is-potential-custom-element-name": "^1.0.1", + "nwsapi": "^2.2.0", + "parse5": "6.0.1", + "saxes": "^5.0.1", + "symbol-tree": "^3.2.4", + "tough-cookie": "^4.0.0", + "w3c-hr-time": "^1.0.2", + "w3c-xmlserializer": "^2.0.0", + "webidl-conversions": "^6.1.0", + "whatwg-encoding": "^1.0.5", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.5.0", + "ws": "^7.4.6", + "xml-name-validator": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "peerDependencies": { + "canvas": "^2.5.0" + }, + "peerDependenciesMeta": { + "canvas": { + "optional": true + } + } + }, + "node_modules/jsdom/node_modules/@tootallnate/once": { + "version": "1.1.2", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/jsdom/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/jsdom/node_modules/http-proxy-agent": { + "version": "4.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "@tootallnate/once": "1", + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/jsdom/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT" + }, + "node_modules/jsdom/node_modules/tr46": { + "version": "2.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/jsdom/node_modules/webidl-conversions": { + "version": "6.1.0", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=10.4" + } + }, + "node_modules/jsdom/node_modules/whatwg-url": { + "version": "8.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash": "^4.7.0", + "tr46": "^2.1.0", + "webidl-conversions": "^6.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/json-bigint": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "bignumber.js": "^9.0.0" + } + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "dev": true, + "license": "MIT" + }, + "node_modules/json-stringify-safe": { + "version": "5.0.1", + "dev": true, + "license": "ISC" + }, + "node_modules/jsonc-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.1.0.tgz", + "integrity": "sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==", + "dev": true + }, + "node_modules/jsonfile": { + "version": "4.0.0", + "dev": true, + "license": "MIT", + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsonwebtoken": { + "version": "8.5.1", + "dev": true, + "license": "MIT", + "dependencies": { + "jws": "^3.2.2", + "lodash.includes": "^4.3.0", + "lodash.isboolean": "^3.0.3", + "lodash.isinteger": "^4.0.4", + "lodash.isnumber": "^3.0.3", + "lodash.isplainobject": "^4.0.6", + "lodash.isstring": "^4.0.1", + "lodash.once": "^4.0.0", + "ms": "^2.1.1", + "semver": "^5.6.0" + }, + "engines": { + "node": ">=4", + "npm": ">=1.4.28" + } + }, + "node_modules/jsonwebtoken/node_modules/jwa": { + "version": "1.4.1", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-equal-constant-time": "1.0.1", + "ecdsa-sig-formatter": "1.0.11", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/jsonwebtoken/node_modules/jws": { + "version": "3.2.2", + "dev": true, + "license": "MIT", + "dependencies": { + "jwa": "^1.4.1", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/jsonwebtoken/node_modules/ms": { + "version": "2.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/jsonwebtoken/node_modules/semver": { + "version": "5.7.1", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/just-extend": { + "version": "4.2.1", + "dev": true, + "license": "MIT" + }, + "node_modules/jwa": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "buffer-equal-constant-time": "1.0.1", + "ecdsa-sig-formatter": "1.0.11", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/jwk-to-pem": { + "version": "2.0.5", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "asn1.js": "^5.3.0", + "elliptic": "^6.5.4", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/jwks-rsa": { + "version": "2.1.4", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/express": "^4.17.13", + "@types/jsonwebtoken": "^8.5.8", + "debug": "^4.3.4", + "jose": "^2.0.5", + "limiter": "^1.1.5", + "lru-memoizer": "^2.1.4" + }, + "engines": { + "node": ">=10 < 13 || >=14" + } + }, + "node_modules/jwks-rsa/node_modules/@types/express": { + "version": "4.17.13", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.18", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "node_modules/jwks-rsa/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/jwks-rsa/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT" + }, + "node_modules/jws": { + "version": "4.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "jwa": "^2.0.0", + "safe-buffer": "^5.0.1" + } + }, + "node_modules/levn": { + "version": "0.3.0", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "~1.1.2", + "type-check": "~0.3.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/limiter": { + "version": "1.1.5", + "dev": true + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "dev": true, + "license": "MIT" + }, + "node_modules/locate-path": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "license": "MIT" + }, + "node_modules/lodash.camelcase": { + "version": "4.3.0", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/lodash.clonedeep": { + "version": "4.5.0", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.get": { + "version": "4.4.2", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.includes": { + "version": "4.3.0", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.isboolean": { + "version": "3.0.3", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.isinteger": { + "version": "4.0.4", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.isnumber": { + "version": "3.0.3", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.isplainobject": { + "version": "4.0.6", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.isstring": { + "version": "4.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.once": { + "version": "4.1.1", + "dev": true, + "license": "MIT" + }, + "node_modules/log-symbols": { + "version": "2.2.0", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^2.0.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/lolex": { + "version": "4.2.0", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/long": { + "version": "4.0.0", + "dev": true, + "license": "Apache-2.0", + "optional": true + }, + "node_modules/loupe": { + "version": "2.3.4", + "dev": true, + "license": "MIT", + "dependencies": { + "get-func-name": "^2.0.0" + } + }, + "node_modules/lru-cache": { + "version": "4.1.5", + "dev": true, + "license": "ISC", + "dependencies": { + "pseudomap": "^1.0.2", + "yallist": "^2.1.2" + } + }, + "node_modules/lru-memoizer": { + "version": "2.1.4", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash.clonedeep": "^4.5.0", + "lru-cache": "~4.0.0" + } + }, + "node_modules/lru-memoizer/node_modules/lru-cache": { + "version": "4.0.2", + "dev": true, + "license": "ISC", + "dependencies": { + "pseudomap": "^1.0.1", + "yallist": "^2.0.0" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "dev": true, + "license": "MIT" + }, + "node_modules/make-dir": { + "version": "3.1.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "semver": "^6.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/make-dir/node_modules/semver": { + "version": "6.3.0", + "dev": true, + "license": "ISC", + "optional": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/make-error": { + "version": "1.3.6", + "dev": true, + "license": "ISC" + }, + "node_modules/marked": { + "version": "4.0.18", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.0.18.tgz", + "integrity": "sha512-wbLDJ7Zh0sqA0Vdg6aqlbT+yPxqLblpAZh1mK2+AO2twQkPywvvqQNfEPVwSSRjZ7dZcdeVBIAgiO7MMp3Dszw==", + "dev": true, + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, + "node_modules/media-typer": { + "version": "0.3.0", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.1", + "license": "MIT" + }, + "node_modules/methods": { + "version": "1.1.2", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "license": "MIT", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/minimalistic-assert": { + "version": "1.0.1", + "dev": true, + "license": "ISC" + }, + "node_modules/minimalistic-crypto-utils": { + "version": "1.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/minimatch": { + "version": "3.0.4", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.6", + "dev": true, + "license": "MIT" + }, + "node_modules/mkdirp": { + "version": "0.5.4", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.5" + }, + "bin": { + "mkdirp": "bin/cmd.js" + } + }, + "node_modules/mocha": { + "version": "6.2.3", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-colors": "3.2.3", + "browser-stdout": "1.3.1", + "debug": "3.2.6", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "find-up": "3.0.0", + "glob": "7.1.3", + "growl": "1.10.5", + "he": "1.2.0", + "js-yaml": "3.13.1", + "log-symbols": "2.2.0", + "minimatch": "3.0.4", + "mkdirp": "0.5.4", + "ms": "2.1.1", + "node-environment-flags": "1.0.5", + "object.assign": "4.1.0", + "strip-json-comments": "2.0.1", + "supports-color": "6.0.0", + "which": "1.3.1", + "wide-align": "1.1.3", + "yargs": "13.3.2", + "yargs-parser": "13.1.2", + "yargs-unparser": "1.6.0" + }, + "bin": { + "_mocha": "bin/_mocha", + "mocha": "bin/mocha" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/mocha/node_modules/ansi-regex": { + "version": "4.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/ansi-styles": { + "version": "3.2.1", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mocha/node_modules/cliui": { + "version": "5.0.0", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "node_modules/mocha/node_modules/color-convert": { + "version": "1.9.3", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/mocha/node_modules/color-name": { + "version": "1.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/mocha/node_modules/debug": { + "version": "3.2.6", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/mocha/node_modules/emoji-regex": { + "version": "7.0.3", + "dev": true, + "license": "MIT" + }, + "node_modules/mocha/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/mocha/node_modules/js-yaml": { + "version": "3.13.1", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/mocha/node_modules/ms": { + "version": "2.1.1", + "dev": true, + "license": "MIT" + }, + "node_modules/mocha/node_modules/string-width": { + "version": "3.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/strip-ansi": { + "version": "5.2.0", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/wrap-ansi": { + "version": "5.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/mocha/node_modules/y18n": { + "version": "4.0.3", + "dev": true, + "license": "ISC" + }, + "node_modules/mocha/node_modules/yargs": { + "version": "13.3.2", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" + } + }, + "node_modules/mocha/node_modules/yargs-parser": { + "version": "13.1.2", + "dev": true, + "license": "ISC", + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + }, + "node_modules/mock-require": { + "version": "3.0.3", + "dev": true, + "license": "MIT", + "dependencies": { + "get-caller-file": "^1.0.2", + "normalize-path": "^2.1.1" + }, + "engines": { + "node": ">=4.3.0" + } + }, + "node_modules/mock-require/node_modules/get-caller-file": { + "version": "1.0.3", + "dev": true, + "license": "ISC" + }, + "node_modules/ms": { + "version": "2.0.0", + "license": "MIT" + }, + "node_modules/mz": { + "version": "2.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "any-promise": "^1.0.0", + "object-assign": "^4.0.1", + "thenify-all": "^1.0.0" + } + }, + "node_modules/negotiator": { + "version": "0.6.3", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/nise": { + "version": "1.5.3", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/formatio": "^3.2.1", + "@sinonjs/text-encoding": "^0.7.1", + "just-extend": "^4.0.2", + "lolex": "^5.0.1", + "path-to-regexp": "^1.7.0" + } + }, + "node_modules/nise/node_modules/lolex": { + "version": "5.1.2", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^1.7.0" + } + }, + "node_modules/nise/node_modules/path-to-regexp": { + "version": "1.8.0", + "dev": true, + "license": "MIT", + "dependencies": { + "isarray": "0.0.1" + } + }, + "node_modules/nock": { + "version": "10.0.6", + "dev": true, + "license": "MIT", + "dependencies": { + "chai": "^4.1.2", + "debug": "^4.1.0", + "deep-equal": "^1.0.0", + "json-stringify-safe": "^5.0.1", + "lodash": "^4.17.5", + "mkdirp": "^0.5.0", + "propagate": "^1.0.0", + "qs": "^6.5.1", + "semver": "^5.5.0" + }, + "engines": { + "node": ">= 6.0" + } + }, + "node_modules/nock/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/nock/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT" + }, + "node_modules/nock/node_modules/semver": { + "version": "5.7.1", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/node-environment-flags": { + "version": "1.0.5", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" + } + }, + "node_modules/node-environment-flags/node_modules/semver": { + "version": "5.7.1", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/node-fetch": { + "version": "2.6.7", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/node-forge": { + "version": "1.3.1", + "dev": true, + "license": "(BSD-3-Clause OR GPL-2.0)", + "engines": { + "node": ">= 6.13.0" + } + }, + "node_modules/node-version": { + "version": "1.2.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/normalize-path": { + "version": "2.1.1", + "dev": true, + "license": "MIT", + "dependencies": { + "remove-trailing-separator": "^1.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/nwsapi": { + "version": "2.2.0", + "dev": true, + "license": "MIT" + }, + "node_modules/object-assign": { + "version": "4.1.1", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-hash": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">= 6" + } + }, + "node_modules/object-inspect": { + "version": "1.12.0", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.5", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.getownpropertydescriptors": { + "version": "2.1.3", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/on-finished": { + "version": "2.4.1", + "license": "MIT", + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/once": { + "version": "1.4.0", + "dev": true, + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/optionator": { + "version": "0.8.3", + "dev": true, + "license": "MIT", + "dependencies": { + "deep-is": "~0.1.3", + "fast-levenshtein": "~2.0.6", + "levn": "~0.3.0", + "prelude-ls": "~1.1.2", + "type-check": "~0.3.2", + "word-wrap": "~1.2.3" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/p-limit": { + "version": "3.1.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/p-locate/node_modules/p-limit": { + "version": "2.3.0", + "dev": true, + "license": "MIT", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/parse5": { + "version": "6.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/parseurl": { + "version": "1.3.3", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/path-exists": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "dev": true, + "license": "MIT" + }, + "node_modules/path-to-regexp": { + "version": "0.1.7", + "license": "MIT" + }, + "node_modules/pathval": { + "version": "1.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": "*" + } + }, + "node_modules/portfinder": { + "version": "1.0.28", + "dev": true, + "license": "MIT", + "dependencies": { + "async": "^2.6.2", + "debug": "^3.1.1", + "mkdirp": "^0.5.5" + }, + "engines": { + "node": ">= 0.12.0" + } + }, + "node_modules/portfinder/node_modules/debug": { + "version": "3.2.7", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/portfinder/node_modules/mkdirp": { + "version": "0.5.6", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.6" + }, + "bin": { + "mkdirp": "bin/cmd.js" + } + }, + "node_modules/portfinder/node_modules/ms": { + "version": "2.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/prelude-ls": { + "version": "1.1.2", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/prettier": { + "version": "1.19.1", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin-prettier.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/promise-polyfill": { + "version": "6.1.0", + "dev": true, + "license": "MIT" + }, + "node_modules/propagate": { + "version": "1.0.0", + "dev": true, + "engines": [ + "node >= 0.8.1" + ], + "license": "MIT" + }, + "node_modules/proto3-json-serializer": { + "version": "0.1.9", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "protobufjs": "^6.11.2" + } + }, + "node_modules/protobufjs": { + "version": "6.11.3", + "dev": true, + "hasInstallScript": true, + "license": "BSD-3-Clause", + "optional": true, + "dependencies": { + "@protobufjs/aspromise": "^1.1.2", + "@protobufjs/base64": "^1.1.2", + "@protobufjs/codegen": "^2.0.4", + "@protobufjs/eventemitter": "^1.1.0", + "@protobufjs/fetch": "^1.1.0", + "@protobufjs/float": "^1.0.2", + "@protobufjs/inquire": "^1.1.0", + "@protobufjs/path": "^1.1.2", + "@protobufjs/pool": "^1.1.0", + "@protobufjs/utf8": "^1.1.0", + "@types/long": "^4.0.1", + "@types/node": ">=13.7.0", + "long": "^4.0.0" + }, + "bin": { + "pbjs": "bin/pbjs", + "pbts": "bin/pbts" + } + }, + "node_modules/protobufjs/node_modules/@types/node": { + "version": "18.0.4", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "license": "MIT", + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/pseudomap": { + "version": "1.0.2", + "dev": true, + "license": "ISC" + }, + "node_modules/psl": { + "version": "1.8.0", + "dev": true, + "license": "MIT" + }, + "node_modules/pump": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, + "node_modules/pumpify": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "duplexify": "^4.1.1", + "inherits": "^2.0.3", + "pump": "^3.0.0" + } + }, + "node_modules/punycode": { + "version": "2.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/qs": { + "version": "6.10.3", + "license": "BSD-3-Clause", + "dependencies": { + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/range-parser": { + "version": "1.2.1", + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.1", + "license": "MIT", + "dependencies": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/readable-stream": { + "version": "3.6.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/regexp.prototype.flags": { + "version": "1.4.3", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "functions-have-names": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/remove-trailing-separator": { + "version": "1.1.0", + "dev": true, + "license": "ISC" + }, + "node_modules/require-directory": { + "version": "2.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-main-filename": { + "version": "2.0.0", + "dev": true, + "license": "ISC" + }, + "node_modules/resolve": { + "version": "1.22.0", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.8.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/retry": { + "version": "0.13.1", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/retry-request": { + "version": "4.2.2", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "debug": "^4.1.1", + "extend": "^3.0.2" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/retry-request/node_modules/debug": { + "version": "4.3.4", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/retry-request/node_modules/ms": { + "version": "2.1.2", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "license": "MIT" + }, + "node_modules/saxes": { + "version": "5.0.1", + "dev": true, + "license": "ISC", + "dependencies": { + "xmlchars": "^2.2.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "7.3.7", + "dev": true, + "license": "ISC", + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver/node_modules/lru-cache": { + "version": "6.0.0", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver/node_modules/yallist": { + "version": "4.0.0", + "dev": true, + "license": "ISC" + }, + "node_modules/send": { + "version": "0.18.0", + "license": "MIT", + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "2.4.1", + "range-parser": "~1.2.1", + "statuses": "2.0.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/ms": { + "version": "2.1.3", + "license": "MIT" + }, + "node_modules/serve-static": { + "version": "1.15.0", + "license": "MIT", + "dependencies": { + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "0.18.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/set-blocking": { + "version": "2.0.0", + "dev": true, + "license": "ISC" + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "license": "ISC" + }, + "node_modules/shiki": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.10.1.tgz", + "integrity": "sha512-VsY7QJVzU51j5o1+DguUd+6vmCmZ5v/6gYu4vyYAhzjuNQU6P/vmSy4uQaOhvje031qQMiW0d2BwgMH52vqMng==", + "dev": true, + "dependencies": { + "jsonc-parser": "^3.0.0", + "vscode-oniguruma": "^1.6.1", + "vscode-textmate": "5.2.0" + } + }, + "node_modules/side-channel": { + "version": "1.0.4", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "dev": true, + "license": "ISC", + "optional": true + }, + "node_modules/sinon": { + "version": "7.5.0", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^1.4.0", + "@sinonjs/formatio": "^3.2.1", + "@sinonjs/samsam": "^3.3.3", + "diff": "^3.5.0", + "lolex": "^4.2.0", + "nise": "^1.5.2", + "supports-color": "^5.5.0" + } + }, + "node_modules/sinon/node_modules/supports-color": { + "version": "5.5.0", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/statuses": { + "version": "2.0.1", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/stream-events": { + "version": "1.0.5", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "stubs": "^3.0.0" + } + }, + "node_modules/stream-shift": { + "version": "1.0.1", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/string_decoder": { + "version": "1.3.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "safe-buffer": "~5.2.0" + } + }, + "node_modules/string-argv": { + "version": "0.3.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.6.19" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.4", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.4", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-json-comments": { + "version": "2.0.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stubs": { + "version": "3.0.0", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/supports-color": { + "version": "6.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/symbol-tree": { + "version": "3.2.4", + "dev": true, + "license": "MIT" + }, + "node_modules/teeny-request": { + "version": "7.2.0", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "http-proxy-agent": "^5.0.0", + "https-proxy-agent": "^5.0.0", + "node-fetch": "^2.6.1", + "stream-events": "^1.0.5", + "uuid": "^8.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/text-decoding": { + "version": "1.0.0", + "dev": true, + "license": "MIT" + }, + "node_modules/thenify": { + "version": "3.3.1", + "dev": true, + "license": "MIT", + "dependencies": { + "any-promise": "^1.0.0" + } + }, + "node_modules/thenify-all": { + "version": "1.6.0", + "dev": true, + "license": "MIT", + "dependencies": { + "thenify": ">= 3.1.0 < 4" + }, + "engines": { + "node": ">=0.8" + } + }, + "node_modules/timsort": { + "version": "0.3.0", + "dev": true, + "license": "MIT" + }, + "node_modules/toidentifier": { + "version": "1.0.1", + "license": "MIT", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/tough-cookie": { + "version": "4.0.0", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "psl": "^1.1.33", + "punycode": "^2.1.1", + "universalify": "^0.1.2" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/tr46": { + "version": "0.0.3", + "dev": true, + "license": "MIT" + }, + "node_modules/ts-node": { + "version": "10.7.0", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspotcode/source-map-support": "0.7.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.0", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/ts-node/node_modules/acorn-walk": { + "version": "8.2.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/ts-node/node_modules/diff": { + "version": "4.0.2", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/tslib": { + "version": "2.4.0", + "dev": true, + "license": "0BSD" + }, + "node_modules/tslint": { + "version": "5.20.1", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "builtin-modules": "^1.1.1", + "chalk": "^2.3.0", + "commander": "^2.12.1", + "diff": "^4.0.1", + "glob": "^7.1.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "mkdirp": "^0.5.1", + "resolve": "^1.3.2", + "semver": "^5.3.0", + "tslib": "^1.8.0", + "tsutils": "^2.29.0" + }, + "bin": { + "tslint": "bin/tslint" + }, + "engines": { + "node": ">=4.8.0" + }, + "peerDependencies": { + "typescript": ">=2.3.0-dev || >=2.4.0-dev || >=2.5.0-dev || >=2.6.0-dev || >=2.7.0-dev || >=2.8.0-dev || >=2.9.0-dev || >=3.0.0-dev || >= 3.1.0-dev || >= 3.2.0-dev" + } + }, + "node_modules/tslint-config-prettier": { + "version": "1.18.0", + "dev": true, + "license": "MIT", + "bin": { + "tslint-config-prettier-check": "bin/check.js" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/tslint-no-unused-expression-chai": { + "version": "0.1.4", + "dev": true, + "license": "MIT", + "dependencies": { + "tsutils": "^3.0.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "tslint": ">=5.1.0" + } + }, + "node_modules/tslint-no-unused-expression-chai/node_modules/tslib": { + "version": "1.14.1", + "dev": true, + "license": "0BSD" + }, + "node_modules/tslint-no-unused-expression-chai/node_modules/tsutils": { + "version": "3.21.0", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^1.8.1" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" + } + }, + "node_modules/tslint-plugin-prettier": { + "version": "2.3.0", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-plugin-prettier": "^2.2.0", + "lines-and-columns": "^1.1.6", + "tslib": "^1.7.1" + }, + "engines": { + "node": ">= 4" + }, + "peerDependencies": { + "prettier": "^1.9.0 || ^2.0.0", + "tslint": "^5.0.0 || ^6.0.0" + } + }, + "node_modules/tslint-plugin-prettier/node_modules/tslib": { + "version": "1.14.1", + "dev": true, + "license": "0BSD" + }, + "node_modules/tslint/node_modules/diff": { + "version": "4.0.2", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, + "node_modules/tslint/node_modules/semver": { + "version": "5.7.1", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/tslint/node_modules/tslib": { + "version": "1.14.1", + "dev": true, + "license": "0BSD" + }, + "node_modules/tsutils": { + "version": "2.29.0", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^1.8.1" + }, + "peerDependencies": { + "typescript": ">=2.1.0 || >=2.1.0-dev || >=2.2.0-dev || >=2.3.0-dev || >=2.4.0-dev || >=2.5.0-dev || >=2.6.0-dev || >=2.7.0-dev || >=2.8.0-dev || >=2.9.0-dev || >= 3.0.0-dev || >= 3.1.0-dev" + } + }, + "node_modules/tsutils/node_modules/tslib": { + "version": "1.14.1", + "dev": true, + "license": "0BSD" + }, + "node_modules/type-check": { + "version": "0.3.2", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "~1.1.2" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-detect": { + "version": "4.0.8", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/type-is": { + "version": "1.6.18", + "license": "MIT", + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/typedarray-to-buffer": { + "version": "3.1.5", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "is-typedarray": "^1.0.0" + } + }, + "node_modules/typedoc": { + "version": "0.23.7", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.7.tgz", + "integrity": "sha512-Vl/Yh4KYBaxQQOYImBgLQDX61hfaA7XaP/DZVd/w7rQvaqLEsdQH6gEMK8CMjyHo0bSzVnNYwxtD1KPSENoWug==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "marked": "^4.0.16", + "minimatch": "^5.1.0", + "shiki": "^0.10.1" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 14.14" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.0.tgz", + "integrity": "sha512-9TPBGGak4nHfGZsPBohm9AWg6NoT7QTCehS3BIJABslyZbzxfV78QM2Y6+i741OPZIafFAaiiEMh5OyIrJPgtg==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/typescript": { + "version": "4.6.3", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/unique-string": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "crypto-random-string": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/universalify": { + "version": "0.1.2", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "optional": true + }, + "node_modules/utils-merge": { + "version": "1.0.1", + "license": "MIT", + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/uuid": { + "version": "8.3.2", + "dev": true, + "license": "MIT", + "bin": { + "uuid": "dist/bin/uuid" + } + }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "dev": true, + "license": "MIT" + }, + "node_modules/validator": { + "version": "8.2.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/vary": { + "version": "1.1.2", + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/vscode-oniguruma": { + "version": "1.6.2", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.6.2.tgz", + "integrity": "sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==", + "dev": true + }, + "node_modules/vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", + "dev": true + }, + "node_modules/w3c-hr-time": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "browser-process-hrtime": "^1.0.0" + } + }, + "node_modules/w3c-xmlserializer": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "xml-name-validator": "^3.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/webidl-conversions": { + "version": "3.0.1", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/websocket-driver": { + "version": "0.7.4", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "http-parser-js": ">=0.5.1", + "safe-buffer": ">=5.1.0", + "websocket-extensions": ">=0.1.1" + }, + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/websocket-extensions": { + "version": "0.1.4", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/whatwg-encoding": { + "version": "1.0.5", + "dev": true, + "license": "MIT", + "dependencies": { + "iconv-lite": "0.4.24" + } + }, + "node_modules/whatwg-mimetype": { + "version": "2.3.0", + "dev": true, + "license": "MIT" + }, + "node_modules/whatwg-url": { + "version": "5.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "node_modules/which": { + "version": "1.3.1", + "dev": true, + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "which": "bin/which" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-module": { + "version": "2.0.0", + "dev": true, + "license": "ISC" + }, + "node_modules/wide-align": { + "version": "1.1.3", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^1.0.2 || 2" + } + }, + "node_modules/wide-align/node_modules/ansi-regex": { + "version": "3.0.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/string-width": { + "version": "2.1.1", + "dev": true, + "license": "MIT", + "dependencies": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/wide-align/node_modules/strip-ansi": { + "version": "4.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/word-wrap": { + "version": "1.2.3", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "dev": true, + "license": "ISC" + }, + "node_modules/write-file-atomic": { + "version": "3.0.3", + "dev": true, + "license": "ISC", + "optional": true, + "dependencies": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "node_modules/ws": { + "version": "7.5.7", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/xdg-basedir": { + "version": "4.0.0", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/xml-name-validator": { + "version": "3.0.0", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/xmlchars": { + "version": "2.2.0", + "dev": true, + "license": "MIT" + }, + "node_modules/y18n": { + "version": "5.0.8", + "dev": true, + "license": "ISC", + "optional": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/yallist": { + "version": "2.1.2", + "dev": true, + "license": "ISC" + }, + "node_modules/yargs": { + "version": "15.4.1", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^6.0.0", + "decamelize": "^1.2.0", + "find-up": "^4.1.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^4.2.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^18.1.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs-parser": { + "version": "20.2.9", + "dev": true, + "license": "ISC", + "optional": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/yargs-unparser": { + "version": "1.6.0", + "dev": true, + "license": "MIT", + "dependencies": { + "flat": "^4.1.0", + "lodash": "^4.17.15", + "yargs": "^13.3.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs-unparser/node_modules/ansi-regex": { + "version": "4.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs-unparser/node_modules/ansi-styles": { + "version": "3.2.1", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/yargs-unparser/node_modules/cliui": { + "version": "5.0.0", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "node_modules/yargs-unparser/node_modules/color-convert": { + "version": "1.9.3", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/yargs-unparser/node_modules/color-name": { + "version": "1.1.3", + "dev": true, + "license": "MIT" + }, + "node_modules/yargs-unparser/node_modules/emoji-regex": { + "version": "7.0.3", + "dev": true, + "license": "MIT" + }, + "node_modules/yargs-unparser/node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/yargs-unparser/node_modules/string-width": { + "version": "3.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs-unparser/node_modules/strip-ansi": { + "version": "5.2.0", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs-unparser/node_modules/wrap-ansi": { + "version": "5.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yargs-unparser/node_modules/y18n": { + "version": "4.0.3", + "dev": true, + "license": "ISC" + }, + "node_modules/yargs-unparser/node_modules/yargs": { + "version": "13.3.2", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" + } + }, + "node_modules/yargs-unparser/node_modules/yargs-parser": { + "version": "13.1.2", + "dev": true, + "license": "ISC", + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + }, + "node_modules/yargs/node_modules/cliui": { + "version": "6.0.0", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^6.2.0" + } + }, + "node_modules/yargs/node_modules/find-up": { + "version": "4.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/locate-path": { + "version": "5.0.0", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/p-limit": { + "version": "2.3.0", + "dev": true, + "license": "MIT", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/yargs/node_modules/p-locate": { + "version": "4.1.0", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/path-exists": { + "version": "4.0.0", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/wrap-ansi": { + "version": "6.2.0", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/yargs/node_modules/y18n": { + "version": "4.0.3", + "dev": true, + "license": "ISC" + }, + "node_modules/yargs/node_modules/yargs-parser": { + "version": "18.1.3", + "dev": true, + "license": "ISC", + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/yn": { + "version": "3.1.1", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/yocto-queue": { + "version": "0.1.0", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/z-schema": { + "version": "3.18.4", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "optionalDependencies": { + "commander": "^2.7.1" + } + } + }, + "dependencies": { + "@babel/code-frame": { + "version": "7.16.7", + "dev": true, + "requires": { + "@babel/highlight": "^7.16.7" + } + }, + "@babel/helper-validator-identifier": { + "version": "7.16.7", + "dev": true + }, + "@babel/highlight": { + "version": "7.17.9", + "dev": true, + "requires": { + "@babel/helper-validator-identifier": "^7.16.7", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + } + }, + "@cspotcode/source-map-consumer": { + "version": "0.8.0", + "dev": true + }, + "@cspotcode/source-map-support": { + "version": "0.7.0", + "dev": true, + "requires": { + "@cspotcode/source-map-consumer": "0.8.0" + } + }, + "@fastify/busboy": { + "version": "1.1.0", + "dev": true, + "requires": { + "text-decoding": "^1.0.0" + } + }, + "@firebase/api-documenter": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@firebase/api-documenter/-/api-documenter-0.2.0.tgz", + "integrity": "sha512-WQcOP5TvtRWMfGkpJpKpyVDjcB2UYCZWFmQm/nXUYUdI6PZ/Im1yb2YydgpnSlhrZxz6C1YkYFGLYCrltks1Yw==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.45.5", + "@rushstack/ts-command-line": "4.11.0", + "api-extractor-model-me": "0.1.1", + "colors": "~1.4.0", + "js-yaml": "4.1.0", + "resolve": "~1.22.0", + "tslib": "^2.1.0" + }, + "dependencies": { + "@rushstack/node-core-library": { + "version": "3.45.5", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.45.5.tgz", + "integrity": "sha512-KbN7Hp9vH3bD3YJfv6RnVtzzTAwGYIBl7y2HQLY4WEQqRbvE3LgI78W9l9X+cTAXCX//p0EeoiUYNTFdqJrMZg==", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + } + } + }, + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==", + "dev": true + }, + "argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true + }, + "js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "requires": { + "argparse": "^2.0.1" + } + }, + "validator": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz", + "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.3.tgz", + "integrity": "sha512-sGvEcBOTNum68x9jCpCVGPFJ6mWnkD0YxOcddDlJHRx3tKdB2q8pCHExMVZo/AV/6geuVJXG7hljDaWG8+5GDw==", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@firebase/app-types": { + "version": "0.7.0", + "dev": true + }, + "@firebase/auth-interop-types": { + "version": "0.1.6", + "dev": true, + "requires": {} + }, + "@firebase/component": { + "version": "0.5.17", + "dev": true, + "requires": { + "@firebase/util": "1.6.3", + "tslib": "^2.1.0" + } + }, + "@firebase/database": { + "version": "0.13.3", + "dev": true, + "requires": { + "@firebase/auth-interop-types": "0.1.6", + "@firebase/component": "0.5.17", + "@firebase/logger": "0.3.3", + "@firebase/util": "1.6.3", + "faye-websocket": "0.11.4", + "tslib": "^2.1.0" + } + }, + "@firebase/database-compat": { + "version": "0.2.3", + "dev": true, + "requires": { + "@firebase/component": "0.5.17", + "@firebase/database": "0.13.3", + "@firebase/database-types": "0.9.11", + "@firebase/logger": "0.3.3", + "@firebase/util": "1.6.3", + "tslib": "^2.1.0" + } + }, + "@firebase/database-types": { + "version": "0.9.11", + "dev": true, + "requires": { + "@firebase/app-types": "0.7.0", + "@firebase/util": "1.6.3" + } + }, + "@firebase/logger": { + "version": "0.3.3", + "dev": true, + "requires": { + "tslib": "^2.1.0" + } + }, + "@firebase/util": { + "version": "1.6.3", + "dev": true, + "requires": { + "tslib": "^2.1.0" + } + }, + "@google-cloud/firestore": { + "version": "4.15.1", + "dev": true, + "optional": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "functional-red-black-tree": "^1.0.1", + "google-gax": "^2.24.1", + "protobufjs": "^6.8.6" + } + }, + "@google-cloud/paginator": { + "version": "3.0.7", + "dev": true, + "optional": true, + "requires": { + "arrify": "^2.0.0", + "extend": "^3.0.2" + } + }, + "@google-cloud/projectify": { + "version": "2.1.1", + "dev": true, + "optional": true + }, + "@google-cloud/promisify": { + "version": "2.0.4", + "dev": true, + "optional": true + }, + "@google-cloud/storage": { + "version": "5.20.5", + "dev": true, + "optional": true, + "requires": { + "@google-cloud/paginator": "^3.0.7", + "@google-cloud/projectify": "^2.0.0", + "@google-cloud/promisify": "^2.0.0", + "abort-controller": "^3.0.0", + "arrify": "^2.0.0", + "async-retry": "^1.3.3", + "compressible": "^2.0.12", + "configstore": "^5.0.0", + "duplexify": "^4.0.0", + "ent": "^2.2.0", + "extend": "^3.0.2", + "gaxios": "^4.0.0", + "google-auth-library": "^7.14.1", + "hash-stream-validation": "^0.2.2", + "mime": "^3.0.0", + "mime-types": "^2.0.8", + "p-limit": "^3.0.1", + "pumpify": "^2.0.0", + "retry-request": "^4.2.2", + "stream-events": "^1.0.4", + "teeny-request": "^7.1.3", + "uuid": "^8.0.0", + "xdg-basedir": "^4.0.0" + }, + "dependencies": { + "mime": { + "version": "3.0.0", + "dev": true, + "optional": true + } + } + }, + "@grpc/grpc-js": { + "version": "1.6.7", + "dev": true, + "optional": true, + "requires": { + "@grpc/proto-loader": "^0.6.4", + "@types/node": ">=12.12.47" + }, + "dependencies": { + "@types/node": { + "version": "18.0.4", + "dev": true, + "optional": true + } + } + }, + "@grpc/proto-loader": { + "version": "0.6.13", + "dev": true, + "optional": true, + "requires": { + "@types/long": "^4.0.1", + "lodash.camelcase": "^4.3.0", + "long": "^4.0.0", + "protobufjs": "^6.11.3", + "yargs": "^16.2.0" + }, + "dependencies": { + "yargs": { + "version": "16.2.0", + "dev": true, + "optional": true, + "requires": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + } + } + } + }, + "@microsoft/api-documenter": { + "version": "7.17.11", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.17.2", + "@microsoft/tsdoc": "0.14.1", + "@rushstack/node-core-library": "3.45.4", + "@rushstack/ts-command-line": "4.10.10", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.4", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.10", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "12.20.24", + "dev": true + }, + "js-yaml": { + "version": "3.13.1", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "resolve": { + "version": "1.17.0", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "validator": { + "version": "13.7.0", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/api-extractor": { + "version": "7.23.0", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.17.2", + "@microsoft/tsdoc": "0.14.1", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.45.4", + "@rushstack/rig-package": "0.3.11", + "@rushstack/ts-command-line": "4.10.10", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.6.3" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.4", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.10", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@types/node": { + "version": "12.20.24", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "validator": { + "version": "13.7.0", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.17.2", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.1", + "@microsoft/tsdoc-config": "~0.16.1", + "@rushstack/node-core-library": "3.45.4" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true + }, + "@rushstack/node-core-library": { + "version": "3.45.4", + "dev": true, + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~5.0.2" + } + }, + "@types/node": { + "version": "12.20.24", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "validator": { + "version": "13.7.0", + "dev": true + }, + "z-schema": { + "version": "5.0.3", + "dev": true, + "requires": { + "commander": "^2.20.3", + "lodash.get": "^4.4.2", + "lodash.isequal": "^4.5.0", + "validator": "^13.7.0" + } + } + } + }, + "@microsoft/tsdoc": { + "version": "0.12.24", + "dev": true + }, + "@microsoft/tsdoc-config": { + "version": "0.16.1", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.14.1", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "@microsoft/tsdoc": { + "version": "0.14.1", + "dev": true + }, + "resolve": { + "version": "1.19.0", + "dev": true, + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } + } + }, + "@panva/asn1.js": { + "version": "1.0.0", + "dev": true + }, + "@protobufjs/aspromise": { + "version": "1.1.2", + "dev": true, + "optional": true + }, + "@protobufjs/base64": { + "version": "1.1.2", + "dev": true, + "optional": true + }, + "@protobufjs/codegen": { + "version": "2.0.4", + "dev": true, + "optional": true + }, + "@protobufjs/eventemitter": { + "version": "1.1.0", + "dev": true, + "optional": true + }, + "@protobufjs/fetch": { + "version": "1.1.0", + "dev": true, + "optional": true, + "requires": { + "@protobufjs/aspromise": "^1.1.1", + "@protobufjs/inquire": "^1.1.0" + } + }, + "@protobufjs/float": { + "version": "1.0.2", + "dev": true, + "optional": true + }, + "@protobufjs/inquire": { + "version": "1.1.0", + "dev": true, + "optional": true + }, + "@protobufjs/path": { + "version": "1.1.2", + "dev": true, + "optional": true + }, + "@protobufjs/pool": { + "version": "1.1.0", + "dev": true, + "optional": true + }, + "@protobufjs/utf8": { + "version": "1.1.0", + "dev": true, + "optional": true + }, + "@rushstack/node-core-library": { + "version": "3.36.0", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + }, + "dependencies": { + "@types/node": { + "version": "10.17.13", + "dev": true + }, + "resolve": { + "version": "1.17.0", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + } + } + }, + "@rushstack/rig-package": { + "version": "0.3.11", + "dev": true, + "requires": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + }, + "dependencies": { + "resolve": { + "version": "1.17.0", + "dev": true, + "requires": { + "path-parse": "^1.0.6" + } + }, + "strip-json-comments": { + "version": "3.1.1", + "dev": true + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.11.0", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.11.0.tgz", + "integrity": "sha512-ptG9L0mjvJ5QtK11GsAFY+jGfsnqHDS6CY6Yw1xT7a9bhjfNYnf6UPwjV+pF6UgiucfNcMDNW9lkDLxvZKKxMg==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "@sinonjs/commons": { + "version": "1.8.3", + "dev": true, + "requires": { + "type-detect": "4.0.8" + } + }, + "@sinonjs/formatio": { + "version": "3.2.2", + "dev": true, + "requires": { + "@sinonjs/commons": "^1", + "@sinonjs/samsam": "^3.1.0" + } + }, + "@sinonjs/samsam": { + "version": "3.3.3", + "dev": true, + "requires": { + "@sinonjs/commons": "^1.3.0", + "array-from": "^2.1.1", + "lodash": "^4.17.15" + } + }, + "@sinonjs/text-encoding": { + "version": "0.7.1", + "dev": true + }, + "@tootallnate/once": { + "version": "2.0.0", + "dev": true, + "optional": true + }, + "@tsconfig/node10": { + "version": "1.0.8", + "dev": true + }, + "@tsconfig/node12": { + "version": "1.0.9", + "dev": true + }, + "@tsconfig/node14": { + "version": "1.0.1", + "dev": true + }, + "@tsconfig/node16": { + "version": "1.0.2", + "dev": true + }, + "@types/argparse": { + "version": "1.0.38", + "dev": true + }, + "@types/body-parser": { + "version": "1.19.2", + "requires": { + "@types/connect": "*", + "@types/node": "*" + }, + "dependencies": { + "@types/node": { + "version": "17.0.29" + } + } + }, + "@types/chai": { + "version": "4.3.1", + "dev": true + }, + "@types/chai-as-promised": { + "version": "7.1.5", + "dev": true, + "requires": { + "@types/chai": "*" + } + }, + "@types/connect": { + "version": "3.4.35", + "requires": { + "@types/node": "*" + }, + "dependencies": { + "@types/node": { + "version": "17.0.29" + } + } + }, + "@types/cors": { + "version": "2.8.12" + }, + "@types/express": { + "version": "4.17.3", + "requires": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "*", + "@types/serve-static": "*" + } + }, + "@types/express-serve-static-core": { + "version": "4.17.28", + "requires": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*" + }, + "dependencies": { + "@types/node": { + "version": "17.0.29" + } + } + }, + "@types/jsonwebtoken": { + "version": "8.5.8", + "dev": true, + "requires": { + "@types/node": "*" + } + }, + "@types/lodash": { + "version": "4.14.182", + "dev": true + }, + "@types/long": { + "version": "4.0.2", + "dev": true, + "optional": true + }, + "@types/mime": { + "version": "1.3.2" + }, + "@types/mocha": { + "version": "5.2.7", + "dev": true + }, + "@types/mock-require": { + "version": "2.0.1", + "dev": true, + "requires": { + "@types/node": "*" + } + }, + "@types/nock": { + "version": "10.0.3", + "dev": true, + "requires": { + "@types/node": "*" + } + }, + "@types/node": { + "version": "8.10.66", + "dev": true + }, + "@types/node-fetch": { + "version": "3.0.3", + "dev": true, + "requires": { + "node-fetch": "*" + } + }, + "@types/qs": { + "version": "6.9.7" + }, + "@types/range-parser": { + "version": "1.2.4" + }, + "@types/serve-static": { + "version": "1.13.10", + "requires": { + "@types/mime": "^1", + "@types/node": "*" + }, + "dependencies": { + "@types/node": { + "version": "17.0.29" + } + } + }, + "@types/sinon": { + "version": "7.5.2", + "dev": true + }, + "abab": { + "version": "2.0.6", + "dev": true + }, + "abort-controller": { + "version": "3.0.0", + "dev": true, + "optional": true, + "requires": { + "event-target-shim": "^5.0.0" + } + }, + "accepts": { + "version": "1.3.8", + "requires": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + } + }, + "acorn": { + "version": "8.7.1", + "dev": true + }, + "acorn-globals": { + "version": "6.0.0", + "dev": true, + "requires": { + "acorn": "^7.1.1", + "acorn-walk": "^7.1.1" + }, + "dependencies": { + "acorn": { + "version": "7.4.1", + "dev": true + } + } + }, + "acorn-walk": { + "version": "7.2.0", + "dev": true + }, + "agent-base": { + "version": "6.0.2", + "dev": true, + "requires": { + "debug": "4" + }, + "dependencies": { + "debug": { + "version": "4.3.4", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "dev": true + } + } + }, + "ajv": { + "version": "6.12.6", + "dev": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "ansi-colors": { + "version": "3.2.3", + "dev": true + }, + "ansi-regex": { + "version": "5.0.1", + "dev": true + }, + "ansi-styles": { + "version": "4.3.0", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "any-promise": { + "version": "1.3.0", + "dev": true + }, + "api-extractor-model-me": { + "version": "0.1.1", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.24", + "@rushstack/node-core-library": "3.36.0" + } + }, + "arg": { + "version": "4.1.3", + "dev": true + }, + "argparse": { + "version": "1.0.10", + "dev": true, + "requires": { + "sprintf-js": "~1.0.2" + } + }, + "array-flatten": { + "version": "1.1.1" + }, + "array-from": { + "version": "2.1.1", + "dev": true + }, + "arrify": { + "version": "2.0.1", + "dev": true, + "optional": true + }, + "asn1.js": { + "version": "5.4.1", + "dev": true, + "requires": { + "bn.js": "^4.0.0", + "inherits": "^2.0.1", + "minimalistic-assert": "^1.0.0", + "safer-buffer": "^2.1.0" + } + }, + "assertion-error": { + "version": "1.1.0", + "dev": true + }, + "async": { + "version": "2.6.4", + "dev": true, + "requires": { + "lodash": "^4.17.14" + } + }, + "async-retry": { + "version": "1.3.3", + "dev": true, + "optional": true, + "requires": { + "retry": "0.13.1" + } + }, + "asynckit": { + "version": "0.4.0", + "dev": true + }, + "balanced-match": { + "version": "1.0.2", + "dev": true + }, + "base64-js": { + "version": "1.5.1", + "dev": true, + "optional": true + }, + "bignumber.js": { + "version": "9.0.2", + "dev": true, + "optional": true + }, + "bn.js": { + "version": "4.12.0", + "dev": true + }, + "body-parser": { + "version": "1.20.0", + "requires": { + "bytes": "3.1.2", + "content-type": "~1.0.4", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.10.3", + "raw-body": "2.5.1", + "type-is": "~1.6.18", + "unpipe": "1.0.0" + } + }, + "brace-expansion": { + "version": "1.1.11", + "dev": true, + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "brorand": { + "version": "1.1.0", + "dev": true + }, + "browser-process-hrtime": { + "version": "1.0.0", + "dev": true + }, + "browser-stdout": { + "version": "1.3.1", + "dev": true + }, + "buffer-equal-constant-time": { + "version": "1.0.1", + "dev": true + }, + "builtin-modules": { + "version": "1.1.1", + "dev": true + }, + "bytes": { + "version": "3.1.2" + }, + "call-bind": { + "version": "1.0.2", + "requires": { + "function-bind": "^1.1.1", + "get-intrinsic": "^1.0.2" + } + }, + "camelcase": { + "version": "5.3.1", + "dev": true + }, + "chai": { + "version": "4.3.6", + "dev": true, + "requires": { + "assertion-error": "^1.1.0", + "check-error": "^1.0.2", + "deep-eql": "^3.0.1", + "get-func-name": "^2.0.0", + "loupe": "^2.3.1", + "pathval": "^1.1.1", + "type-detect": "^4.0.5" + } + }, + "chai-as-promised": { + "version": "7.1.1", + "dev": true, + "requires": { + "check-error": "^1.0.2" + } + }, + "chalk": { + "version": "2.4.2", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "color-convert": { + "version": "1.9.3", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "check-error": { + "version": "1.0.2", + "dev": true + }, + "child-process-promise": { + "version": "2.2.1", + "dev": true, + "requires": { + "cross-spawn": "^4.0.2", + "node-version": "^1.0.0", + "promise-polyfill": "^6.0.1" + } + }, + "cliui": { + "version": "7.0.4", + "dev": true, + "optional": true, + "requires": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "color-convert": { + "version": "2.0.1", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "dev": true + }, + "colors": { + "version": "1.2.5", + "dev": true + }, + "combined-stream": { + "version": "1.0.8", + "dev": true, + "requires": { + "delayed-stream": "~1.0.0" + } + }, + "commander": { + "version": "2.20.3", + "dev": true + }, + "compressible": { + "version": "2.0.18", + "dev": true, + "optional": true, + "requires": { + "mime-db": ">= 1.43.0 < 2" + } + }, + "concat-map": { + "version": "0.0.1", + "dev": true + }, + "configstore": { + "version": "5.0.1", + "dev": true, + "optional": true, + "requires": { + "dot-prop": "^5.2.0", + "graceful-fs": "^4.1.2", + "make-dir": "^3.0.0", + "unique-string": "^2.0.0", + "write-file-atomic": "^3.0.0", + "xdg-basedir": "^4.0.0" + } + }, + "content-disposition": { + "version": "0.5.4", + "requires": { + "safe-buffer": "5.2.1" + } + }, + "content-type": { + "version": "1.0.4" + }, + "cookie": { + "version": "0.5.0" + }, + "cookie-signature": { + "version": "1.0.6" + }, + "cors": { + "version": "2.8.5", + "requires": { + "object-assign": "^4", + "vary": "^1" + } + }, + "create-require": { + "version": "1.1.1", + "dev": true + }, + "cross-spawn": { + "version": "4.0.2", + "dev": true, + "requires": { + "lru-cache": "^4.0.1", + "which": "^1.2.9" + } + }, + "crypto-random-string": { + "version": "2.0.0", + "dev": true, + "optional": true + }, + "cssom": { + "version": "0.4.4", + "dev": true + }, + "cssstyle": { + "version": "2.3.0", + "dev": true, + "requires": { + "cssom": "~0.3.6" + }, + "dependencies": { + "cssom": { + "version": "0.3.8", + "dev": true + } + } + }, + "data-urls": { + "version": "2.0.0", + "dev": true, + "requires": { + "abab": "^2.0.3", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.0.0" + }, + "dependencies": { + "tr46": { + "version": "2.1.0", + "dev": true, + "requires": { + "punycode": "^2.1.1" + } + }, + "webidl-conversions": { + "version": "6.1.0", + "dev": true + }, + "whatwg-url": { + "version": "8.7.0", + "dev": true, + "requires": { + "lodash": "^4.7.0", + "tr46": "^2.1.0", + "webidl-conversions": "^6.1.0" + } + } + } + }, + "debug": { + "version": "2.6.9", + "requires": { + "ms": "2.0.0" + } + }, + "decamelize": { + "version": "1.2.0", + "dev": true + }, + "decimal.js": { + "version": "10.3.1", + "dev": true + }, + "deep-eql": { + "version": "3.0.1", + "dev": true, + "requires": { + "type-detect": "^4.0.0" + } + }, + "deep-equal": { + "version": "1.1.1", + "dev": true, + "requires": { + "is-arguments": "^1.0.4", + "is-date-object": "^1.0.1", + "is-regex": "^1.0.4", + "object-is": "^1.0.1", + "object-keys": "^1.1.1", + "regexp.prototype.flags": "^1.2.0" + } + }, + "deep-is": { + "version": "0.1.4", + "dev": true + }, + "define-properties": { + "version": "1.1.4", + "dev": true, + "requires": { + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + } + }, + "delayed-stream": { + "version": "1.0.0", + "dev": true + }, + "depd": { + "version": "2.0.0" + }, + "destroy": { + "version": "1.2.0" + }, + "diff": { + "version": "3.5.0", + "dev": true + }, + "domexception": { + "version": "2.0.1", + "dev": true, + "requires": { + "webidl-conversions": "^5.0.0" + }, + "dependencies": { + "webidl-conversions": { + "version": "5.0.0", + "dev": true + } + } + }, + "dot-prop": { + "version": "5.3.0", + "dev": true, + "optional": true, + "requires": { + "is-obj": "^2.0.0" + } + }, + "duplexify": { + "version": "4.1.2", + "dev": true, + "optional": true, + "requires": { + "end-of-stream": "^1.4.1", + "inherits": "^2.0.3", + "readable-stream": "^3.1.1", + "stream-shift": "^1.0.0" + } + }, + "ecdsa-sig-formatter": { + "version": "1.0.11", + "dev": true, + "requires": { + "safe-buffer": "^5.0.1" + } + }, + "ee-first": { + "version": "1.1.1" + }, + "elliptic": { + "version": "6.5.4", + "dev": true, + "requires": { + "bn.js": "^4.11.9", + "brorand": "^1.1.0", + "hash.js": "^1.0.0", + "hmac-drbg": "^1.0.1", + "inherits": "^2.0.4", + "minimalistic-assert": "^1.0.1", + "minimalistic-crypto-utils": "^1.0.1" + } + }, + "emoji-regex": { + "version": "8.0.0", + "dev": true + }, + "encodeurl": { + "version": "1.0.2" + }, + "end-of-stream": { + "version": "1.4.4", + "dev": true, + "optional": true, + "requires": { + "once": "^1.4.0" + } + }, + "ent": { + "version": "2.2.0", + "dev": true, + "optional": true + }, + "es-abstract": { + "version": "1.19.5", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "get-intrinsic": "^1.1.1", + "get-symbol-description": "^1.0.0", + "has": "^1.0.3", + "has-symbols": "^1.0.3", + "internal-slot": "^1.0.3", + "is-callable": "^1.2.4", + "is-negative-zero": "^2.0.2", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "is-string": "^1.0.7", + "is-weakref": "^1.0.2", + "object-inspect": "^1.12.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.2", + "string.prototype.trimend": "^1.0.4", + "string.prototype.trimstart": "^1.0.4", + "unbox-primitive": "^1.0.1" + }, + "dependencies": { + "object.assign": { + "version": "4.1.2", + "dev": true, + "requires": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3", + "has-symbols": "^1.0.1", + "object-keys": "^1.1.1" + } + } + } + }, + "es-to-primitive": { + "version": "1.2.1", + "dev": true, + "requires": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + } + }, + "escalade": { + "version": "3.1.1", + "dev": true, + "optional": true + }, + "escape-html": { + "version": "1.0.3" + }, + "escape-string-regexp": { + "version": "1.0.5", + "dev": true + }, + "escodegen": { + "version": "2.0.0", + "dev": true, + "requires": { + "esprima": "^4.0.1", + "estraverse": "^5.2.0", + "esutils": "^2.0.2", + "optionator": "^0.8.1", + "source-map": "~0.6.1" + } + }, + "eslint-plugin-prettier": { + "version": "2.7.0", + "dev": true, + "requires": { + "fast-diff": "^1.1.1", + "jest-docblock": "^21.0.0" + } + }, + "esprima": { + "version": "4.0.1", + "dev": true + }, + "estraverse": { + "version": "5.3.0", + "dev": true + }, + "esutils": { + "version": "2.0.3", + "dev": true + }, + "etag": { + "version": "1.8.1" + }, + "event-target-shim": { + "version": "5.0.1", + "dev": true, + "optional": true + }, + "express": { + "version": "4.18.0", + "requires": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "1.20.0", + "content-disposition": "0.5.4", + "content-type": "~1.0.4", + "cookie": "0.5.0", + "cookie-signature": "1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "1.2.0", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "merge-descriptors": "1.0.1", + "methods": "~1.1.2", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "0.1.7", + "proxy-addr": "~2.0.7", + "qs": "6.10.3", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "0.18.0", + "serve-static": "1.15.0", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + } + }, + "extend": { + "version": "3.0.2", + "dev": true, + "optional": true + }, + "fast-deep-equal": { + "version": "3.1.3", + "dev": true + }, + "fast-diff": { + "version": "1.2.0", + "dev": true + }, + "fast-json-stable-stringify": { + "version": "2.1.0", + "dev": true + }, + "fast-levenshtein": { + "version": "2.0.6", + "dev": true + }, + "fast-text-encoding": { + "version": "1.0.4", + "dev": true, + "optional": true + }, + "faye-websocket": { + "version": "0.11.4", + "dev": true, + "requires": { + "websocket-driver": ">=0.5.1" + } + }, + "finalhandler": { + "version": "1.2.0", + "requires": { + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "statuses": "2.0.1", + "unpipe": "~1.0.0" + } + }, + "find-up": { + "version": "3.0.0", + "dev": true, + "requires": { + "locate-path": "^3.0.0" + } + }, + "firebase-admin": { + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/firebase-admin/-/firebase-admin-10.3.0.tgz", + "integrity": "sha512-A0wgMLEjyVyUE+heyMJYqHRkPVjpebhOYsa47RHdrTM4ltApcx8Tn86sUmjqxlfh09gNnILAm7a8q5+FmgBYpg==", + "dev": true, + "requires": { + "@fastify/busboy": "^1.1.0", + "@firebase/database-compat": "^0.2.0", + "@firebase/database-types": "^0.9.7", + "@google-cloud/firestore": "^4.15.1", + "@google-cloud/storage": "^5.18.3", + "@types/node": ">=12.12.47", + "jsonwebtoken": "^8.5.1", + "jwks-rsa": "^2.0.2", + "node-forge": "^1.3.1", + "uuid": "^8.3.2" + }, + "dependencies": { + "@types/node": { + "version": "18.0.4", + "dev": true + } + } + }, + "flat": { + "version": "4.1.1", + "dev": true, + "requires": { + "is-buffer": "~2.0.3" + } + }, + "form-data": { + "version": "3.0.1", + "dev": true, + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + } + }, + "forwarded": { + "version": "0.2.0" + }, + "fresh": { + "version": "0.5.2" + }, + "fs-extra": { + "version": "7.0.1", + "dev": true, + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, + "fs.realpath": { + "version": "1.0.0", + "dev": true + }, + "function-bind": { + "version": "1.1.1" + }, + "functional-red-black-tree": { + "version": "1.0.1", + "dev": true, + "optional": true + }, + "functions-have-names": { + "version": "1.2.3", + "dev": true + }, + "gaxios": { + "version": "4.3.3", + "dev": true, + "optional": true, + "requires": { + "abort-controller": "^3.0.0", + "extend": "^3.0.2", + "https-proxy-agent": "^5.0.0", + "is-stream": "^2.0.0", + "node-fetch": "^2.6.7" + } + }, + "gcp-metadata": { + "version": "4.3.1", + "dev": true, + "optional": true, + "requires": { + "gaxios": "^4.0.0", + "json-bigint": "^1.0.0" + } + }, + "get-caller-file": { + "version": "2.0.5", + "dev": true + }, + "get-func-name": { + "version": "2.0.0", + "dev": true + }, + "get-intrinsic": { + "version": "1.1.1", + "requires": { + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1" + } + }, + "get-symbol-description": { + "version": "1.0.0", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + } + }, + "glob": { + "version": "7.1.3", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "google-auth-library": { + "version": "7.14.1", + "dev": true, + "optional": true, + "requires": { + "arrify": "^2.0.0", + "base64-js": "^1.3.0", + "ecdsa-sig-formatter": "^1.0.11", + "fast-text-encoding": "^1.0.0", + "gaxios": "^4.0.0", + "gcp-metadata": "^4.2.0", + "gtoken": "^5.0.4", + "jws": "^4.0.0", + "lru-cache": "^6.0.0" + }, + "dependencies": { + "lru-cache": { + "version": "6.0.0", + "dev": true, + "optional": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "dev": true, + "optional": true + } + } + }, + "google-gax": { + "version": "2.30.5", + "dev": true, + "optional": true, + "requires": { + "@grpc/grpc-js": "~1.6.0", + "@grpc/proto-loader": "^0.6.12", + "@types/long": "^4.0.0", + "abort-controller": "^3.0.0", + "duplexify": "^4.0.0", + "fast-text-encoding": "^1.0.3", + "google-auth-library": "^7.14.0", + "is-stream-ended": "^0.1.4", + "node-fetch": "^2.6.1", + "object-hash": "^3.0.0", + "proto3-json-serializer": "^0.1.8", + "protobufjs": "6.11.3", + "retry-request": "^4.0.0" + } + }, + "google-p12-pem": { + "version": "3.1.4", + "dev": true, + "optional": true, + "requires": { + "node-forge": "^1.3.1" + } + }, + "graceful-fs": { + "version": "4.2.10", + "dev": true + }, + "growl": { + "version": "1.10.5", + "dev": true + }, + "gtoken": { + "version": "5.3.2", + "dev": true, + "optional": true, + "requires": { + "gaxios": "^4.0.0", + "google-p12-pem": "^3.1.3", + "jws": "^4.0.0" + } + }, + "has": { + "version": "1.0.3", + "requires": { + "function-bind": "^1.1.1" + } + }, + "has-bigints": { + "version": "1.0.2", + "dev": true + }, + "has-flag": { + "version": "3.0.0", + "dev": true + }, + "has-property-descriptors": { + "version": "1.0.0", + "dev": true, + "requires": { + "get-intrinsic": "^1.1.1" + } + }, + "has-symbols": { + "version": "1.0.3" + }, + "has-tostringtag": { + "version": "1.0.0", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + }, + "hash-stream-validation": { + "version": "0.2.4", + "dev": true, + "optional": true + }, + "hash.js": { + "version": "1.1.7", + "dev": true, + "requires": { + "inherits": "^2.0.3", + "minimalistic-assert": "^1.0.1" + } + }, + "he": { + "version": "1.2.0", + "dev": true + }, + "hmac-drbg": { + "version": "1.0.1", + "dev": true, + "requires": { + "hash.js": "^1.0.3", + "minimalistic-assert": "^1.0.0", + "minimalistic-crypto-utils": "^1.0.1" + } + }, + "html-encoding-sniffer": { + "version": "2.0.1", + "dev": true, + "requires": { + "whatwg-encoding": "^1.0.5" + } + }, + "http-errors": { + "version": "2.0.0", + "requires": { + "depd": "2.0.0", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "toidentifier": "1.0.1" + } + }, + "http-parser-js": { + "version": "0.5.8", + "dev": true + }, + "http-proxy-agent": { + "version": "5.0.0", + "dev": true, + "optional": true, + "requires": { + "@tootallnate/once": "2", + "agent-base": "6", + "debug": "4" + }, + "dependencies": { + "debug": { + "version": "4.3.4", + "dev": true, + "optional": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "dev": true, + "optional": true + } + } + }, + "https-proxy-agent": { + "version": "5.0.1", + "dev": true, + "requires": { + "agent-base": "6", + "debug": "4" + }, + "dependencies": { + "debug": { + "version": "4.3.4", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "dev": true + } + } + }, + "iconv-lite": { + "version": "0.4.24", + "requires": { + "safer-buffer": ">= 2.1.2 < 3" + } + }, + "import-lazy": { + "version": "4.0.0", + "dev": true + }, + "imurmurhash": { + "version": "0.1.4", + "dev": true, + "optional": true + }, + "inflight": { + "version": "1.0.6", + "dev": true, + "requires": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "inherits": { + "version": "2.0.4" + }, + "internal-slot": { + "version": "1.0.3", + "dev": true, + "requires": { + "get-intrinsic": "^1.1.0", + "has": "^1.0.3", + "side-channel": "^1.0.4" + } + }, + "ipaddr.js": { + "version": "1.9.1" + }, + "is-arguments": { + "version": "1.1.1", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-bigint": { + "version": "1.0.4", + "dev": true, + "requires": { + "has-bigints": "^1.0.1" + } + }, + "is-boolean-object": { + "version": "1.1.2", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-buffer": { + "version": "2.0.5", + "dev": true + }, + "is-callable": { + "version": "1.2.4", + "dev": true + }, + "is-core-module": { + "version": "2.9.0", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, + "is-date-object": { + "version": "1.0.5", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-fullwidth-code-point": { + "version": "3.0.0", + "dev": true + }, + "is-negative-zero": { + "version": "2.0.2", + "dev": true + }, + "is-number-object": { + "version": "1.0.7", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-obj": { + "version": "2.0.0", + "dev": true, + "optional": true + }, + "is-potential-custom-element-name": { + "version": "1.0.1", + "dev": true + }, + "is-regex": { + "version": "1.1.4", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + } + }, + "is-shared-array-buffer": { + "version": "1.0.2", + "dev": true, + "requires": { + "call-bind": "^1.0.2" + } + }, + "is-stream": { + "version": "2.0.1", + "dev": true, + "optional": true + }, + "is-stream-ended": { + "version": "0.1.4", + "dev": true, + "optional": true + }, + "is-string": { + "version": "1.0.7", + "dev": true, + "requires": { + "has-tostringtag": "^1.0.0" + } + }, + "is-symbol": { + "version": "1.0.4", + "dev": true, + "requires": { + "has-symbols": "^1.0.2" + } + }, + "is-typedarray": { + "version": "1.0.0", + "dev": true, + "optional": true + }, + "is-weakref": { + "version": "1.0.2", + "dev": true, + "requires": { + "call-bind": "^1.0.2" + } + }, + "isarray": { + "version": "0.0.1", + "dev": true + }, + "isexe": { + "version": "2.0.0", + "dev": true + }, + "jest-docblock": { + "version": "21.2.0", + "dev": true + }, + "jju": { + "version": "1.4.0", + "dev": true + }, + "jose": { + "version": "2.0.5", + "dev": true, + "requires": { + "@panva/asn1.js": "^1.0.0" + } + }, + "js-tokens": { + "version": "4.0.0", + "dev": true + }, + "js-yaml": { + "version": "3.14.1", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "jsdom": { + "version": "16.7.0", + "dev": true, + "requires": { + "abab": "^2.0.5", + "acorn": "^8.2.4", + "acorn-globals": "^6.0.0", + "cssom": "^0.4.4", + "cssstyle": "^2.3.0", + "data-urls": "^2.0.0", + "decimal.js": "^10.2.1", + "domexception": "^2.0.1", + "escodegen": "^2.0.0", + "form-data": "^3.0.0", + "html-encoding-sniffer": "^2.0.1", + "http-proxy-agent": "^4.0.1", + "https-proxy-agent": "^5.0.0", + "is-potential-custom-element-name": "^1.0.1", + "nwsapi": "^2.2.0", + "parse5": "6.0.1", + "saxes": "^5.0.1", + "symbol-tree": "^3.2.4", + "tough-cookie": "^4.0.0", + "w3c-hr-time": "^1.0.2", + "w3c-xmlserializer": "^2.0.0", + "webidl-conversions": "^6.1.0", + "whatwg-encoding": "^1.0.5", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.5.0", + "ws": "^7.4.6", + "xml-name-validator": "^3.0.0" + }, + "dependencies": { + "@tootallnate/once": { + "version": "1.1.2", + "dev": true + }, + "debug": { + "version": "4.3.4", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "http-proxy-agent": { + "version": "4.0.1", + "dev": true, + "requires": { + "@tootallnate/once": "1", + "agent-base": "6", + "debug": "4" + } + }, + "ms": { + "version": "2.1.2", + "dev": true + }, + "tr46": { + "version": "2.1.0", + "dev": true, + "requires": { + "punycode": "^2.1.1" + } + }, + "webidl-conversions": { + "version": "6.1.0", + "dev": true + }, + "whatwg-url": { + "version": "8.7.0", + "dev": true, + "requires": { + "lodash": "^4.7.0", + "tr46": "^2.1.0", + "webidl-conversions": "^6.1.0" + } + } + } + }, + "json-bigint": { + "version": "1.0.0", + "dev": true, + "optional": true, + "requires": { + "bignumber.js": "^9.0.0" + } + }, + "json-schema-traverse": { + "version": "0.4.1", + "dev": true + }, + "json-stringify-safe": { + "version": "5.0.1", + "dev": true + }, + "jsonc-parser": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.1.0.tgz", + "integrity": "sha512-DRf0QjnNeCUds3xTjKlQQ3DpJD51GvDjJfnxUVWg6PZTo2otSm+slzNAxU/35hF8/oJIKoG9slq30JYOsF2azg==", + "dev": true + }, + "jsonfile": { + "version": "4.0.0", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6" + } + }, + "jsonwebtoken": { + "version": "8.5.1", + "dev": true, + "requires": { + "jws": "^3.2.2", + "lodash.includes": "^4.3.0", + "lodash.isboolean": "^3.0.3", + "lodash.isinteger": "^4.0.4", + "lodash.isnumber": "^3.0.3", + "lodash.isplainobject": "^4.0.6", + "lodash.isstring": "^4.0.1", + "lodash.once": "^4.0.0", + "ms": "^2.1.1", + "semver": "^5.6.0" + }, + "dependencies": { + "jwa": { + "version": "1.4.1", + "dev": true, + "requires": { + "buffer-equal-constant-time": "1.0.1", + "ecdsa-sig-formatter": "1.0.11", + "safe-buffer": "^5.0.1" + } + }, + "jws": { + "version": "3.2.2", + "dev": true, + "requires": { + "jwa": "^1.4.1", + "safe-buffer": "^5.0.1" + } + }, + "ms": { + "version": "2.1.3", + "dev": true + }, + "semver": { + "version": "5.7.1", + "dev": true + } + } + }, + "just-extend": { + "version": "4.2.1", + "dev": true + }, + "jwa": { + "version": "2.0.0", + "dev": true, + "optional": true, + "requires": { + "buffer-equal-constant-time": "1.0.1", + "ecdsa-sig-formatter": "1.0.11", + "safe-buffer": "^5.0.1" + } + }, + "jwk-to-pem": { + "version": "2.0.5", + "dev": true, + "requires": { + "asn1.js": "^5.3.0", + "elliptic": "^6.5.4", + "safe-buffer": "^5.0.1" + } + }, + "jwks-rsa": { + "version": "2.1.4", + "dev": true, + "requires": { + "@types/express": "^4.17.13", + "@types/jsonwebtoken": "^8.5.8", + "debug": "^4.3.4", + "jose": "^2.0.5", + "limiter": "^1.1.5", + "lru-memoizer": "^2.1.4" + }, + "dependencies": { + "@types/express": { + "version": "4.17.13", + "dev": true, + "requires": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.18", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "debug": { + "version": "4.3.4", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "dev": true + } + } + }, + "jws": { + "version": "4.0.0", + "dev": true, + "optional": true, + "requires": { + "jwa": "^2.0.0", + "safe-buffer": "^5.0.1" + } + }, + "levn": { + "version": "0.3.0", + "dev": true, + "requires": { + "prelude-ls": "~1.1.2", + "type-check": "~0.3.2" + } + }, + "limiter": { + "version": "1.1.5", + "dev": true + }, + "lines-and-columns": { + "version": "1.2.4", + "dev": true + }, + "locate-path": { + "version": "3.0.0", + "dev": true, + "requires": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + } + }, + "lodash": { + "version": "4.17.21" + }, + "lodash.camelcase": { + "version": "4.3.0", + "dev": true, + "optional": true + }, + "lodash.clonedeep": { + "version": "4.5.0", + "dev": true + }, + "lodash.get": { + "version": "4.4.2", + "dev": true + }, + "lodash.includes": { + "version": "4.3.0", + "dev": true + }, + "lodash.isboolean": { + "version": "3.0.3", + "dev": true + }, + "lodash.isequal": { + "version": "4.5.0", + "dev": true + }, + "lodash.isinteger": { + "version": "4.0.4", + "dev": true + }, + "lodash.isnumber": { + "version": "3.0.3", + "dev": true + }, + "lodash.isplainobject": { + "version": "4.0.6", + "dev": true + }, + "lodash.isstring": { + "version": "4.0.1", + "dev": true + }, + "lodash.once": { + "version": "4.1.1", + "dev": true + }, + "log-symbols": { + "version": "2.2.0", + "dev": true, + "requires": { + "chalk": "^2.0.1" + } + }, + "lolex": { + "version": "4.2.0", + "dev": true + }, + "long": { + "version": "4.0.0", + "dev": true, + "optional": true + }, + "loupe": { + "version": "2.3.4", + "dev": true, + "requires": { + "get-func-name": "^2.0.0" + } + }, + "lru-cache": { + "version": "4.1.5", + "dev": true, + "requires": { + "pseudomap": "^1.0.2", + "yallist": "^2.1.2" + } + }, + "lru-memoizer": { + "version": "2.1.4", + "dev": true, + "requires": { + "lodash.clonedeep": "^4.5.0", + "lru-cache": "~4.0.0" + }, + "dependencies": { + "lru-cache": { + "version": "4.0.2", + "dev": true, + "requires": { + "pseudomap": "^1.0.1", + "yallist": "^2.0.0" + } + } + } + }, + "lunr": { + "version": "2.3.9", + "dev": true + }, + "make-dir": { + "version": "3.1.0", + "dev": true, + "optional": true, + "requires": { + "semver": "^6.0.0" + }, + "dependencies": { + "semver": { + "version": "6.3.0", + "dev": true, + "optional": true + } + } + }, + "make-error": { + "version": "1.3.6", + "dev": true + }, + "marked": { + "version": "4.0.18", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.0.18.tgz", + "integrity": "sha512-wbLDJ7Zh0sqA0Vdg6aqlbT+yPxqLblpAZh1mK2+AO2twQkPywvvqQNfEPVwSSRjZ7dZcdeVBIAgiO7MMp3Dszw==", + "dev": true + }, + "media-typer": { + "version": "0.3.0" + }, + "merge-descriptors": { + "version": "1.0.1" + }, + "methods": { + "version": "1.1.2" + }, + "mime": { + "version": "1.6.0" + }, + "mime-db": { + "version": "1.52.0" + }, + "mime-types": { + "version": "2.1.35", + "requires": { + "mime-db": "1.52.0" + } + }, + "minimalistic-assert": { + "version": "1.0.1", + "dev": true + }, + "minimalistic-crypto-utils": { + "version": "1.0.1", + "dev": true + }, + "minimatch": { + "version": "3.0.4", + "dev": true, + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "minimist": { + "version": "1.2.6", + "dev": true + }, + "mkdirp": { + "version": "0.5.4", + "dev": true, + "requires": { + "minimist": "^1.2.5" + } + }, + "mocha": { + "version": "6.2.3", + "dev": true, + "requires": { + "ansi-colors": "3.2.3", + "browser-stdout": "1.3.1", + "debug": "3.2.6", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "find-up": "3.0.0", + "glob": "7.1.3", + "growl": "1.10.5", + "he": "1.2.0", + "js-yaml": "3.13.1", + "log-symbols": "2.2.0", + "minimatch": "3.0.4", + "mkdirp": "0.5.4", + "ms": "2.1.1", + "node-environment-flags": "1.0.5", + "object.assign": "4.1.0", + "strip-json-comments": "2.0.1", + "supports-color": "6.0.0", + "which": "1.3.1", + "wide-align": "1.1.3", + "yargs": "13.3.2", + "yargs-parser": "13.1.2", + "yargs-unparser": "1.6.0" + }, + "dependencies": { + "ansi-regex": { + "version": "4.1.1", + "dev": true + }, + "ansi-styles": { + "version": "3.2.1", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "cliui": { + "version": "5.0.0", + "dev": true, + "requires": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "color-convert": { + "version": "1.9.3", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "dev": true + }, + "debug": { + "version": "3.2.6", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + }, + "emoji-regex": { + "version": "7.0.3", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "2.0.0", + "dev": true + }, + "js-yaml": { + "version": "3.13.1", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "ms": { + "version": "2.1.1", + "dev": true + }, + "string-width": { + "version": "3.1.0", + "dev": true, + "requires": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + } + }, + "strip-ansi": { + "version": "5.2.0", + "dev": true, + "requires": { + "ansi-regex": "^4.1.0" + } + }, + "wrap-ansi": { + "version": "5.1.0", + "dev": true, + "requires": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + } + }, + "y18n": { + "version": "4.0.3", + "dev": true + }, + "yargs": { + "version": "13.3.2", + "dev": true, + "requires": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" + } + }, + "yargs-parser": { + "version": "13.1.2", + "dev": true, + "requires": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + } + } + }, + "mock-require": { + "version": "3.0.3", + "dev": true, + "requires": { + "get-caller-file": "^1.0.2", + "normalize-path": "^2.1.1" + }, + "dependencies": { + "get-caller-file": { + "version": "1.0.3", + "dev": true + } + } + }, + "ms": { + "version": "2.0.0" + }, + "mz": { + "version": "2.7.0", + "dev": true, + "requires": { + "any-promise": "^1.0.0", + "object-assign": "^4.0.1", + "thenify-all": "^1.0.0" + } + }, + "negotiator": { + "version": "0.6.3" + }, + "nise": { + "version": "1.5.3", + "dev": true, + "requires": { + "@sinonjs/formatio": "^3.2.1", + "@sinonjs/text-encoding": "^0.7.1", + "just-extend": "^4.0.2", + "lolex": "^5.0.1", + "path-to-regexp": "^1.7.0" + }, + "dependencies": { + "lolex": { + "version": "5.1.2", + "dev": true, + "requires": { + "@sinonjs/commons": "^1.7.0" + } + }, + "path-to-regexp": { + "version": "1.8.0", + "dev": true, + "requires": { + "isarray": "0.0.1" + } + } + } + }, + "nock": { + "version": "10.0.6", + "dev": true, + "requires": { + "chai": "^4.1.2", + "debug": "^4.1.0", + "deep-equal": "^1.0.0", + "json-stringify-safe": "^5.0.1", + "lodash": "^4.17.5", + "mkdirp": "^0.5.0", + "propagate": "^1.0.0", + "qs": "^6.5.1", + "semver": "^5.5.0" + }, + "dependencies": { + "debug": { + "version": "4.3.4", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "dev": true + }, + "semver": { + "version": "5.7.1", + "dev": true + } + } + }, + "node-environment-flags": { + "version": "1.0.5", + "dev": true, + "requires": { + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" + }, + "dependencies": { + "semver": { + "version": "5.7.1", + "dev": true + } + } + }, + "node-fetch": { + "version": "2.6.7", + "dev": true, + "requires": { + "whatwg-url": "^5.0.0" + } + }, + "node-forge": { + "version": "1.3.1", + "dev": true + }, + "node-version": { + "version": "1.2.0", + "dev": true + }, + "normalize-path": { + "version": "2.1.1", + "dev": true, + "requires": { + "remove-trailing-separator": "^1.0.1" + } + }, + "nwsapi": { + "version": "2.2.0", + "dev": true + }, + "object-assign": { + "version": "4.1.1" + }, + "object-hash": { + "version": "3.0.0", + "dev": true, + "optional": true + }, + "object-inspect": { + "version": "1.12.0" + }, + "object-is": { + "version": "1.1.5", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "object-keys": { + "version": "1.1.1", + "dev": true + }, + "object.assign": { + "version": "4.1.0", + "dev": true, + "requires": { + "define-properties": "^1.1.2", + "function-bind": "^1.1.1", + "has-symbols": "^1.0.0", + "object-keys": "^1.0.11" + } + }, + "object.getownpropertydescriptors": { + "version": "2.1.3", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "es-abstract": "^1.19.1" + } + }, + "on-finished": { + "version": "2.4.1", + "requires": { + "ee-first": "1.1.1" + } + }, + "once": { + "version": "1.4.0", + "dev": true, + "requires": { + "wrappy": "1" + } + }, + "optionator": { + "version": "0.8.3", + "dev": true, + "requires": { + "deep-is": "~0.1.3", + "fast-levenshtein": "~2.0.6", + "levn": "~0.3.0", + "prelude-ls": "~1.1.2", + "type-check": "~0.3.2", + "word-wrap": "~1.2.3" + } + }, + "p-limit": { + "version": "3.1.0", + "dev": true, + "optional": true, + "requires": { + "yocto-queue": "^0.1.0" + } + }, + "p-locate": { + "version": "3.0.0", + "dev": true, + "requires": { + "p-limit": "^2.0.0" + }, + "dependencies": { + "p-limit": { + "version": "2.3.0", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + } + } + }, + "p-try": { + "version": "2.2.0", + "dev": true + }, + "parse5": { + "version": "6.0.1", + "dev": true + }, + "parseurl": { + "version": "1.3.3" + }, + "path-exists": { + "version": "3.0.0", + "dev": true + }, + "path-is-absolute": { + "version": "1.0.1", + "dev": true + }, + "path-parse": { + "version": "1.0.7", + "dev": true + }, + "path-to-regexp": { + "version": "0.1.7" + }, + "pathval": { + "version": "1.1.1", + "dev": true + }, + "portfinder": { + "version": "1.0.28", + "dev": true, + "requires": { + "async": "^2.6.2", + "debug": "^3.1.1", + "mkdirp": "^0.5.5" + }, + "dependencies": { + "debug": { + "version": "3.2.7", + "dev": true, + "requires": { + "ms": "^2.1.1" + } + }, + "mkdirp": { + "version": "0.5.6", + "dev": true, + "requires": { + "minimist": "^1.2.6" + } + }, + "ms": { + "version": "2.1.3", + "dev": true + } + } + }, + "prelude-ls": { + "version": "1.1.2", + "dev": true + }, + "prettier": { + "version": "1.19.1", + "dev": true + }, + "promise-polyfill": { + "version": "6.1.0", + "dev": true + }, + "propagate": { + "version": "1.0.0", + "dev": true + }, + "proto3-json-serializer": { + "version": "0.1.9", + "dev": true, + "optional": true, + "requires": { + "protobufjs": "^6.11.2" + } + }, + "protobufjs": { + "version": "6.11.3", + "dev": true, + "optional": true, + "requires": { + "@protobufjs/aspromise": "^1.1.2", + "@protobufjs/base64": "^1.1.2", + "@protobufjs/codegen": "^2.0.4", + "@protobufjs/eventemitter": "^1.1.0", + "@protobufjs/fetch": "^1.1.0", + "@protobufjs/float": "^1.0.2", + "@protobufjs/inquire": "^1.1.0", + "@protobufjs/path": "^1.1.2", + "@protobufjs/pool": "^1.1.0", + "@protobufjs/utf8": "^1.1.0", + "@types/long": "^4.0.1", + "@types/node": ">=13.7.0", + "long": "^4.0.0" + }, + "dependencies": { + "@types/node": { + "version": "18.0.4", + "dev": true, + "optional": true + } + } + }, + "proxy-addr": { + "version": "2.0.7", + "requires": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + } + }, + "pseudomap": { + "version": "1.0.2", + "dev": true + }, + "psl": { + "version": "1.8.0", + "dev": true + }, + "pump": { + "version": "3.0.0", + "dev": true, + "optional": true, + "requires": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, + "pumpify": { + "version": "2.0.1", + "dev": true, + "optional": true, + "requires": { + "duplexify": "^4.1.1", + "inherits": "^2.0.3", + "pump": "^3.0.0" + } + }, + "punycode": { + "version": "2.1.1", + "dev": true + }, + "qs": { + "version": "6.10.3", + "requires": { + "side-channel": "^1.0.4" + } + }, + "range-parser": { + "version": "1.2.1" + }, + "raw-body": { + "version": "2.5.1", + "requires": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + } + }, + "readable-stream": { + "version": "3.6.0", + "dev": true, + "optional": true, + "requires": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + } + }, + "regexp.prototype.flags": { + "version": "1.4.3", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3", + "functions-have-names": "^1.2.2" + } + }, + "remove-trailing-separator": { + "version": "1.1.0", + "dev": true + }, + "require-directory": { + "version": "2.1.1", + "dev": true + }, + "require-main-filename": { + "version": "2.0.0", + "dev": true + }, + "resolve": { + "version": "1.22.0", + "dev": true, + "requires": { + "is-core-module": "^2.8.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + } + }, + "retry": { + "version": "0.13.1", + "dev": true, + "optional": true + }, + "retry-request": { + "version": "4.2.2", + "dev": true, + "optional": true, + "requires": { + "debug": "^4.1.1", + "extend": "^3.0.2" + }, + "dependencies": { + "debug": { + "version": "4.3.4", + "dev": true, + "optional": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "dev": true, + "optional": true + } + } + }, + "safe-buffer": { + "version": "5.2.1" + }, + "safer-buffer": { + "version": "2.1.2" + }, + "saxes": { + "version": "5.0.1", + "dev": true, + "requires": { + "xmlchars": "^2.2.0" + } + }, + "semver": { + "version": "7.3.7", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + }, + "dependencies": { + "lru-cache": { + "version": "6.0.0", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "dev": true + } + } + }, + "send": { + "version": "0.18.0", + "requires": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "2.4.1", + "range-parser": "~1.2.1", + "statuses": "2.0.1" + }, + "dependencies": { + "ms": { + "version": "2.1.3" + } + } + }, + "serve-static": { + "version": "1.15.0", + "requires": { + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "0.18.0" + } + }, + "set-blocking": { + "version": "2.0.0", + "dev": true + }, + "setprototypeof": { + "version": "1.2.0" + }, + "shiki": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.10.1.tgz", + "integrity": "sha512-VsY7QJVzU51j5o1+DguUd+6vmCmZ5v/6gYu4vyYAhzjuNQU6P/vmSy4uQaOhvje031qQMiW0d2BwgMH52vqMng==", + "dev": true, + "requires": { + "jsonc-parser": "^3.0.0", + "vscode-oniguruma": "^1.6.1", + "vscode-textmate": "5.2.0" + } + }, + "side-channel": { + "version": "1.0.4", + "requires": { + "call-bind": "^1.0.0", + "get-intrinsic": "^1.0.2", + "object-inspect": "^1.9.0" + } + }, + "signal-exit": { + "version": "3.0.7", + "dev": true, + "optional": true + }, + "sinon": { + "version": "7.5.0", + "dev": true, + "requires": { + "@sinonjs/commons": "^1.4.0", + "@sinonjs/formatio": "^3.2.1", + "@sinonjs/samsam": "^3.3.3", + "diff": "^3.5.0", + "lolex": "^4.2.0", + "nise": "^1.5.2", + "supports-color": "^5.5.0" + }, + "dependencies": { + "supports-color": { + "version": "5.5.0", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "source-map": { + "version": "0.6.1", + "dev": true + }, + "sprintf-js": { + "version": "1.0.3", + "dev": true + }, + "statuses": { + "version": "2.0.1" + }, + "stream-events": { + "version": "1.0.5", + "dev": true, + "optional": true, + "requires": { + "stubs": "^3.0.0" + } + }, + "stream-shift": { + "version": "1.0.1", + "dev": true, + "optional": true + }, + "string_decoder": { + "version": "1.3.0", + "dev": true, + "optional": true, + "requires": { + "safe-buffer": "~5.2.0" + } + }, + "string-argv": { + "version": "0.3.1", + "dev": true + }, + "string-width": { + "version": "4.2.3", + "dev": true, + "requires": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + } + }, + "string.prototype.trimend": { + "version": "1.0.4", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "string.prototype.trimstart": { + "version": "1.0.4", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "define-properties": "^1.1.3" + } + }, + "strip-ansi": { + "version": "6.0.1", + "dev": true, + "requires": { + "ansi-regex": "^5.0.1" + } + }, + "strip-json-comments": { + "version": "2.0.1", + "dev": true + }, + "stubs": { + "version": "3.0.0", + "dev": true, + "optional": true + }, + "supports-color": { + "version": "6.0.0", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + }, + "supports-preserve-symlinks-flag": { + "version": "1.0.0", + "dev": true + }, + "symbol-tree": { + "version": "3.2.4", + "dev": true + }, + "teeny-request": { + "version": "7.2.0", + "dev": true, + "optional": true, + "requires": { + "http-proxy-agent": "^5.0.0", + "https-proxy-agent": "^5.0.0", + "node-fetch": "^2.6.1", + "stream-events": "^1.0.5", + "uuid": "^8.0.0" + } + }, + "text-decoding": { + "version": "1.0.0", + "dev": true + }, + "thenify": { + "version": "3.3.1", + "dev": true, + "requires": { + "any-promise": "^1.0.0" + } + }, + "thenify-all": { + "version": "1.6.0", + "dev": true, + "requires": { + "thenify": ">= 3.1.0 < 4" + } + }, + "timsort": { + "version": "0.3.0", + "dev": true + }, + "toidentifier": { + "version": "1.0.1" + }, + "tough-cookie": { + "version": "4.0.0", + "dev": true, + "requires": { + "psl": "^1.1.33", + "punycode": "^2.1.1", + "universalify": "^0.1.2" + } + }, + "tr46": { + "version": "0.0.3", + "dev": true + }, + "ts-node": { + "version": "10.7.0", + "dev": true, + "requires": { + "@cspotcode/source-map-support": "0.7.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.0", + "yn": "3.1.1" + }, + "dependencies": { + "acorn-walk": { + "version": "8.2.0", + "dev": true + }, + "diff": { + "version": "4.0.2", + "dev": true + } + } + }, + "tslib": { + "version": "2.4.0", + "dev": true + }, + "tslint": { + "version": "5.20.1", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "builtin-modules": "^1.1.1", + "chalk": "^2.3.0", + "commander": "^2.12.1", + "diff": "^4.0.1", + "glob": "^7.1.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "mkdirp": "^0.5.1", + "resolve": "^1.3.2", + "semver": "^5.3.0", + "tslib": "^1.8.0", + "tsutils": "^2.29.0" + }, + "dependencies": { + "diff": { + "version": "4.0.2", + "dev": true + }, + "semver": { + "version": "5.7.1", + "dev": true + }, + "tslib": { + "version": "1.14.1", + "dev": true + } + } + }, + "tslint-config-prettier": { + "version": "1.18.0", + "dev": true + }, + "tslint-no-unused-expression-chai": { + "version": "0.1.4", + "dev": true, + "requires": { + "tsutils": "^3.0.0" + }, + "dependencies": { + "tslib": { + "version": "1.14.1", + "dev": true + }, + "tsutils": { + "version": "3.21.0", + "dev": true, + "requires": { + "tslib": "^1.8.1" + } + } + } + }, + "tslint-plugin-prettier": { + "version": "2.3.0", + "dev": true, + "requires": { + "eslint-plugin-prettier": "^2.2.0", + "lines-and-columns": "^1.1.6", + "tslib": "^1.7.1" + }, + "dependencies": { + "tslib": { + "version": "1.14.1", + "dev": true + } + } + }, + "tsutils": { + "version": "2.29.0", + "dev": true, + "requires": { + "tslib": "^1.8.1" + }, + "dependencies": { + "tslib": { + "version": "1.14.1", + "dev": true + } + } + }, + "type-check": { + "version": "0.3.2", + "dev": true, + "requires": { + "prelude-ls": "~1.1.2" + } + }, + "type-detect": { + "version": "4.0.8", + "dev": true + }, + "type-is": { + "version": "1.6.18", + "requires": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + } + }, + "typedarray-to-buffer": { + "version": "3.1.5", + "dev": true, + "optional": true, + "requires": { + "is-typedarray": "^1.0.0" + } + }, + "typedoc": { + "version": "0.23.7", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.23.7.tgz", + "integrity": "sha512-Vl/Yh4KYBaxQQOYImBgLQDX61hfaA7XaP/DZVd/w7rQvaqLEsdQH6gEMK8CMjyHo0bSzVnNYwxtD1KPSENoWug==", + "dev": true, + "requires": { + "lunr": "^2.3.9", + "marked": "^4.0.16", + "minimatch": "^5.1.0", + "shiki": "^0.10.1" + }, + "dependencies": { + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.0.tgz", + "integrity": "sha512-9TPBGGak4nHfGZsPBohm9AWg6NoT7QTCehS3BIJABslyZbzxfV78QM2Y6+i741OPZIafFAaiiEMh5OyIrJPgtg==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, + "typescript": { + "version": "4.6.3", + "dev": true + }, + "unbox-primitive": { + "version": "1.0.2", + "dev": true, + "requires": { + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", + "which-boxed-primitive": "^1.0.2" + } + }, + "unique-string": { + "version": "2.0.0", + "dev": true, + "optional": true, + "requires": { + "crypto-random-string": "^2.0.0" + } + }, + "universalify": { + "version": "0.1.2", + "dev": true + }, + "unpipe": { + "version": "1.0.0" + }, + "uri-js": { + "version": "4.4.1", + "dev": true, + "requires": { + "punycode": "^2.1.0" + } + }, + "util-deprecate": { + "version": "1.0.2", + "dev": true, + "optional": true + }, + "utils-merge": { + "version": "1.0.1" + }, + "uuid": { + "version": "8.3.2", + "dev": true + }, + "v8-compile-cache-lib": { + "version": "3.0.1", + "dev": true + }, + "validator": { + "version": "8.2.0", + "dev": true + }, + "vary": { + "version": "1.1.2" + }, + "vscode-oniguruma": { + "version": "1.6.2", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.6.2.tgz", + "integrity": "sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==", + "dev": true + }, + "vscode-textmate": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", + "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", + "dev": true + }, + "w3c-hr-time": { + "version": "1.0.2", + "dev": true, + "requires": { + "browser-process-hrtime": "^1.0.0" + } + }, + "w3c-xmlserializer": { + "version": "2.0.0", + "dev": true, + "requires": { + "xml-name-validator": "^3.0.0" + } + }, + "webidl-conversions": { + "version": "3.0.1", + "dev": true + }, + "websocket-driver": { + "version": "0.7.4", + "dev": true, + "requires": { + "http-parser-js": ">=0.5.1", + "safe-buffer": ">=5.1.0", + "websocket-extensions": ">=0.1.1" + } + }, + "websocket-extensions": { + "version": "0.1.4", + "dev": true + }, + "whatwg-encoding": { + "version": "1.0.5", + "dev": true, + "requires": { + "iconv-lite": "0.4.24" + } + }, + "whatwg-mimetype": { + "version": "2.3.0", + "dev": true + }, + "whatwg-url": { + "version": "5.0.0", + "dev": true, + "requires": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "which": { + "version": "1.3.1", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } + }, + "which-boxed-primitive": { + "version": "1.0.2", + "dev": true, + "requires": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + } + }, + "which-module": { + "version": "2.0.0", + "dev": true + }, + "wide-align": { + "version": "1.1.3", + "dev": true, + "requires": { + "string-width": "^1.0.2 || 2" + }, + "dependencies": { + "ansi-regex": { + "version": "3.0.1", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "2.0.0", + "dev": true + }, + "string-width": { + "version": "2.1.1", + "dev": true, + "requires": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" + } + }, + "strip-ansi": { + "version": "4.0.0", + "dev": true, + "requires": { + "ansi-regex": "^3.0.0" + } + } + } + }, + "word-wrap": { + "version": "1.2.3", + "dev": true + }, + "wrap-ansi": { + "version": "7.0.0", + "dev": true, + "optional": true, + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + }, + "wrappy": { + "version": "1.0.2", + "dev": true + }, + "write-file-atomic": { + "version": "3.0.3", + "dev": true, + "optional": true, + "requires": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "ws": { + "version": "7.5.7", + "dev": true, + "requires": {} + }, + "xdg-basedir": { + "version": "4.0.0", + "dev": true, + "optional": true + }, + "xml-name-validator": { + "version": "3.0.0", + "dev": true + }, + "xmlchars": { + "version": "2.2.0", + "dev": true + }, + "y18n": { + "version": "5.0.8", + "dev": true, + "optional": true + }, + "yallist": { + "version": "2.1.2", + "dev": true + }, + "yargs": { + "version": "15.4.1", + "dev": true, + "requires": { + "cliui": "^6.0.0", + "decamelize": "^1.2.0", + "find-up": "^4.1.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^4.2.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^18.1.2" + }, + "dependencies": { + "cliui": { + "version": "6.0.0", + "dev": true, + "requires": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^6.2.0" + } + }, + "find-up": { + "version": "4.1.0", + "dev": true, + "requires": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + } + }, + "locate-path": { + "version": "5.0.0", + "dev": true, + "requires": { + "p-locate": "^4.1.0" + } + }, + "p-limit": { + "version": "2.3.0", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "4.1.0", + "dev": true, + "requires": { + "p-limit": "^2.2.0" + } + }, + "path-exists": { + "version": "4.0.0", + "dev": true + }, + "wrap-ansi": { + "version": "6.2.0", + "dev": true, + "requires": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + } + }, + "y18n": { + "version": "4.0.3", + "dev": true + }, + "yargs-parser": { + "version": "18.1.3", + "dev": true, + "requires": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + } + } + }, + "yargs-parser": { + "version": "20.2.9", + "dev": true, + "optional": true + }, + "yargs-unparser": { + "version": "1.6.0", + "dev": true, + "requires": { + "flat": "^4.1.0", + "lodash": "^4.17.15", + "yargs": "^13.3.0" + }, + "dependencies": { + "ansi-regex": { + "version": "4.1.1", + "dev": true + }, + "ansi-styles": { + "version": "3.2.1", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "cliui": { + "version": "5.0.0", + "dev": true, + "requires": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "color-convert": { + "version": "1.9.3", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "dev": true + }, + "emoji-regex": { + "version": "7.0.3", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "2.0.0", + "dev": true + }, + "string-width": { + "version": "3.1.0", + "dev": true, + "requires": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + } + }, + "strip-ansi": { + "version": "5.2.0", + "dev": true, + "requires": { + "ansi-regex": "^4.1.0" + } + }, + "wrap-ansi": { + "version": "5.1.0", + "dev": true, + "requires": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + } + }, + "y18n": { + "version": "4.0.3", + "dev": true + }, + "yargs": { + "version": "13.3.2", + "dev": true, + "requires": { + "cliui": "^5.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^13.1.2" + } + }, + "yargs-parser": { + "version": "13.1.2", + "dev": true, + "requires": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + } + } + }, + "yn": { + "version": "3.1.1", + "dev": true + }, + "yocto-queue": { + "version": "0.1.0", + "dev": true, + "optional": true + }, + "z-schema": { + "version": "3.18.4", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + } + } + } +} diff --git a/package.json b/package.json index 70edbc1ab..56e1ce4f7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "firebase-functions", - "version": "3.3.0", + "version": "3.24.1", "description": "Firebase SDK for Cloud Functions", "keywords": [ "firebase", @@ -14,7 +14,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/firebase/firebase-functions.git" + "url": "https://github.com/firebase/firebase-functions.git" }, "license": "MIT", "author": "Firebase Team", @@ -22,59 +22,224 @@ "lib" ], "main": "lib/index.js", + "bin": { + "firebase-functions": "./lib/bin/firebase-functions.js" + }, "types": "lib/index.d.ts", + "exports": { + ".": "./lib/index.js", + "./logger/compat": "./lib/logger/compat.js", + "./lib/logger/compat": "./lib/logger/compat.js", + "./logger": "./lib/logger/index.js", + "./lib/logger": "./lib/logger/index.js", + "./lib/providers/auth": "./lib/providers/auth.js", + "./lib/providers/analytics": "./lib/providers/analytics.js", + "./lib/providers/database": "./lib/providers/database.js", + "./lib/providers/firestore": "./lib/providers/firestore.js", + "./lib/providers/https": "./lib/providers/https.js", + "./lib/providers/pubsub": "./lib/providers/pubsub.js", + "./lib/providers/remoteConfig": "./lib/providers/remoteConfig.js", + "./lib/providers/storage": "./lib/providers/storage.js", + "./lib/providers/tasks": "./lib/providers/tasks.js", + "./lib/providers/testLab": "./lib/providers/testLab.js", + "./v1": "./lib/index.js", + "./v1/analytics": "./lib/providers/analytics.js", + "./v1/auth": "./lib/providers/auth.js", + "./v1/database": "./lib/providers/database.js", + "./v1/firestore": "./lib/providers/firestore.js", + "./v1/https": "./lib/providers/https.js", + "./v1/pubsub": "./lib/providers/pubsub.js", + "./v1/remoteConfig": "./lib/providers/remoteConfig.js", + "./v1/storage": "./lib/providers/storage.js", + "./v1/testLab": "./lib/providers/testLab.js", + "./v2": "./lib/v2/index.js", + "./v2/core": "./lib/v2/core.js", + "./v2/options": "./lib/v2/options.js", + "./v2/https": "./lib/v2/providers/https.js", + "./v2/params": "./lib/v2/params/index.js", + "./v2/pubsub": "./lib/v2/providers/pubsub.js", + "./v2/storage": "./lib/v2/providers/storage.js", + "./v2/tasks": "./lib/v2/providers/tasks.js", + "./v2/alerts": "./lib/v2/providers/alerts/index.js", + "./v2/alerts/appDistribution": "./lib/v2/providers/alerts/appDistribution.js", + "./v2/alerts/billing": "./lib/v2/providers/alerts/billing.js", + "./v2/alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js", + "./v2/alerts/performance": "./lib/v2/providers/alerts/performance.js", + "./v2/eventarc": "./lib/v2/providers/eventarc.js", + "./v2/identity": "./lib/v2/providers/identity.js", + "./v2/database": "./lib/v2/providers/database.js", + "./v2/scheduler": "./lib/v2/providers/scheduler.js" + }, + "typesVersions": { + "*": { + "logger": [ + "lib/logger" + ], + "logger/compat": [ + "lib/logger/compat" + ], + "v1": [ + "lib" + ], + "v1/analytics": [ + "lib/providers/analytics" + ], + "v1/auth": [ + "lib/providers/auth" + ], + "v1/database": [ + "lib/providers/database" + ], + "v1/firestore": [ + "lib/providers/firestore" + ], + "v1/https": [ + "lib/providers/https" + ], + "v1/pubsub": [ + "lib/providers/pubsub" + ], + "v1/remoteConfig": [ + "lib/providers/remoteConfig" + ], + "v1/storage": [ + "lib/providers/storage" + ], + "v1/tasks": [ + "lib/providers/tasks" + ], + "v1/testLab": [ + "lib/providers/testLab" + ], + "v2": [ + "lib/v2" + ], + "v2/alerts": [ + "lib/v2/providers/alerts" + ], + "v2/alerts/appDistribution": [ + "lib/v2/providers/alerts/appDistribution" + ], + "v2/alerts/billing": [ + "lib/v2/providers/alerts/billing" + ], + "v2/alerts/crashlytics": [ + "lib/v2/providers/alerts/crashlytics" + ], + "v2/alerts/performance": [ + "lib/v2/providers/alerts/performance" + ], + "v2/base": [ + "lib/v2/base" + ], + "v2/database": [ + "lib/v2/providers/database" + ], + "v2/eventarc": [ + "lib/v2/providers/eventarc" + ], + "v2/identity": [ + "lib/v2/providers/identity" + ], + "v2/options": [ + "lib/v2/options" + ], + "v2/https": [ + "lib/v2/providers/https" + ], + "v2/params": [ + "lib/v2/params" + ], + "v2/pubsub": [ + "lib/v2/providers/pubsub" + ], + "v2/storage": [ + "lib/v2/providers/storage" + ], + "v2/tasks": [ + "lib/v2/providers/tasks" + ], + "v2/scheduler": [ + "lib/v2/providers/scheduler" + ] + } + }, + "publishConfig": { + "registry": "https://wombat-dressing-room.appspot.com" + }, "scripts": { "apidocs": "node docgen/generate-docs.js", + "docgen:v1:extract": "api-extractor run -c docgen/api-extractor.v1.json --local", + "docgen:v1:toc": "ts-node docgen/toc.ts --input docgen/v1/markdown --output docgen/v1/markdown/toc --path /docs/reference/functions", + "docgen:v1:gen": "api-documenter-fire markdown -i docgen/v1 -o docgen/v1/markdown --project functions && npm run docgen:v1:toc", + "docgen:v1": "npm run build && npm run docgen:v1:extract && npm run docgen:v1:gen", + "docgen:v2:extract": "api-extractor run -c docgen/api-extractor.v2.json --local", + "docgen:v2:toc": "ts-node docgen/toc.ts --input docgen/v2/markdown --output docgen/v2/markdown/toc --path /docs/functions/beta/reference", + "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown --project functions && npm run docgen:v2:toc", + "docgen:v2": "npm run build && npm run docgen:v2:extract && npm run docgen:v2:gen", "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack", - "build:release": "npm install --production && npm install typescript firebase-admin && tsc -p tsconfig.release.json", + "build:release": "npm ci --production && npm install --no-save typescript firebase-admin && tsc -p tsconfig.release.json", "build": "tsc -p tsconfig.release.json", + "build:watch": "npm run build -- -w", "format": "prettier --check '**/*.{json,md,ts,yml,yaml}'", "format:fix": "prettier --write '**/*.{json,md,ts,yml,yaml}'", "lint": "tslint --config tslint.json --project tsconfig.json ", "lint:fix": "tslint --config tslint.json --fix --project tsconfig.json", - "test": "mocha" + "test": "mocha --file ./mocha/setup.ts \"spec/**/*.spec.ts\"", + "test:bin": "./scripts/bin-test/run.sh", + "test:postmerge": "./integration_test/run_tests.sh" }, "dependencies": { - "@types/express": "^4.17.0", + "@types/cors": "^2.8.5", + "@types/express": "4.17.3", "cors": "^2.8.5", "express": "^4.17.1", - "jsonwebtoken": "^8.5.1", - "lodash": "^4.17.14" + "lodash": "^4.17.14", + "node-fetch": "^2.6.7" }, "devDependencies": { + "@firebase/api-documenter": "^0.2.0", + "@microsoft/api-documenter": "^7.13.45", + "@microsoft/api-extractor": "^7.18.7", "@types/chai": "^4.1.7", "@types/chai-as-promised": "^7.1.0", - "@types/cors": "^2.8.5", "@types/jsonwebtoken": "^8.3.2", "@types/lodash": "^4.14.135", "@types/mocha": "^5.2.7", "@types/mock-require": "^2.0.0", "@types/nock": "^10.0.3", "@types/node": "^8.10.50", + "@types/node-fetch": "^3.0.3", "@types/sinon": "^7.0.13", + "api-extractor-model-me": "^0.1.1", "chai": "^4.2.0", "chai-as-promised": "^7.1.1", "child-process-promise": "^2.2.1", - "firebase-admin": "^8.2.0", - "istanbul": "^0.4.5", + "firebase-admin": "^10.3.0", "js-yaml": "^3.13.1", + "jsdom": "^16.2.1", + "jsonwebtoken": "^8.5.1", + "jwk-to-pem": "^2.0.5", "mocha": "^6.1.4", "mock-require": "^3.0.3", "mz": "^2.7.0", "nock": "^10.0.6", + "node-fetch": "^2.6.7", + "portfinder": "^1.0.28", "prettier": "^1.18.2", + "semver": "^7.3.5", "sinon": "^7.3.2", - "ts-node": "^8.3.0", + "ts-node": "^10.4.0", "tslint": "^5.18.0", "tslint-config-prettier": "^1.18.0", "tslint-no-unused-expression-chai": "^0.1.4", "tslint-plugin-prettier": "^2.0.1", - "typedoc": "^0.14.2", - "typescript": "^3.5.2", - "yargs": "^13.2.4" + "typedoc": "0.23.7", + "typescript": "^4.3.5", + "yargs": "^15.3.1" }, "peerDependencies": { - "firebase-admin": "^8.0.0" + "firebase-admin": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0" }, "engines": { "node": "^8.13.0 || >=10.10.0" diff --git a/scripts/bin-test/mocha-setup.ts b/scripts/bin-test/mocha-setup.ts new file mode 100644 index 000000000..6dfdc7f9d --- /dev/null +++ b/scripts/bin-test/mocha-setup.ts @@ -0,0 +1,4 @@ +import * as chai from 'chai'; +import * as chaiAsPromised from 'chai-as-promised'; + +chai.use(chaiAsPromised); diff --git a/scripts/bin-test/run.sh b/scripts/bin-test/run.sh new file mode 100755 index 000000000..c3e3da673 --- /dev/null +++ b/scripts/bin-test/run.sh @@ -0,0 +1,20 @@ +#!/bin/bash +set -ex # Immediately exit on failure + +# Link the Functions SDK for the testing environment. +npm run build +npm link + +# Link local SDK to all test sources. +for f in scripts/bin-test/sources/*; do + if [ -d "$f" ]; then + (cd "$f" && npm link firebase-functions) + fi +done + +## DEBUG +ls -la scripts/bin-test/sources/commonjs/node_modules + +mocha \ + --file ./scripts/bin-test/mocha-setup.ts \ + ./scripts/bin-test/test.ts diff --git a/scripts/bin-test/sources/commonjs-grouped/g1.js b/scripts/bin-test/sources/commonjs-grouped/g1.js new file mode 100644 index 000000000..57766af02 --- /dev/null +++ b/scripts/bin-test/sources/commonjs-grouped/g1.js @@ -0,0 +1,9 @@ +const functions = require("firebase-functions"); + +exports.groupedhttp = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.groupedcallable = functions.https.onCall(() => { + return "PASS"; +}); diff --git a/scripts/bin-test/sources/commonjs-grouped/index.js b/scripts/bin-test/sources/commonjs-grouped/index.js new file mode 100644 index 000000000..b00828de0 --- /dev/null +++ b/scripts/bin-test/sources/commonjs-grouped/index.js @@ -0,0 +1,20 @@ +const functions = require("firebase-functions"); +const functionsv2 = require("firebase-functions/v2"); + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); + +exports.g1 = require("./g1"); diff --git a/scripts/bin-test/sources/commonjs-grouped/package.json b/scripts/bin-test/sources/commonjs-grouped/package.json new file mode 100644 index 000000000..1ec99f52f --- /dev/null +++ b/scripts/bin-test/sources/commonjs-grouped/package.json @@ -0,0 +1,3 @@ +{ + "name": "commonjs-grouped" +} diff --git a/scripts/bin-test/sources/commonjs-main/functions.js b/scripts/bin-test/sources/commonjs-main/functions.js new file mode 100644 index 000000000..9122f9223 --- /dev/null +++ b/scripts/bin-test/sources/commonjs-main/functions.js @@ -0,0 +1,18 @@ +const functions = require("firebase-functions"); +const functionsv2 = require("firebase-functions/v2"); + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/scripts/bin-test/sources/commonjs-main/package.json b/scripts/bin-test/sources/commonjs-main/package.json new file mode 100644 index 000000000..a781259f8 --- /dev/null +++ b/scripts/bin-test/sources/commonjs-main/package.json @@ -0,0 +1,4 @@ +{ + "name": "commonjs-main", + "main": "functions.js" +} diff --git a/scripts/bin-test/sources/commonjs/index.js b/scripts/bin-test/sources/commonjs/index.js new file mode 100644 index 000000000..9122f9223 --- /dev/null +++ b/scripts/bin-test/sources/commonjs/index.js @@ -0,0 +1,18 @@ +const functions = require("firebase-functions"); +const functionsv2 = require("firebase-functions/v2"); + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/scripts/bin-test/sources/commonjs/package.json b/scripts/bin-test/sources/commonjs/package.json new file mode 100644 index 000000000..30e1b1b27 --- /dev/null +++ b/scripts/bin-test/sources/commonjs/package.json @@ -0,0 +1,3 @@ +{ + "name": "commonjs" +} diff --git a/scripts/bin-test/sources/esm-ext/index.mjs b/scripts/bin-test/sources/esm-ext/index.mjs new file mode 100644 index 000000000..91e974d93 --- /dev/null +++ b/scripts/bin-test/sources/esm-ext/index.mjs @@ -0,0 +1,18 @@ +import * as functions from "firebase-functions"; +import * as functionsv2 from "firebase-functions/v2"; + +export const v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +export const v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +export const v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +export const v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/scripts/bin-test/sources/esm-ext/package.json b/scripts/bin-test/sources/esm-ext/package.json new file mode 100644 index 000000000..facb175c2 --- /dev/null +++ b/scripts/bin-test/sources/esm-ext/package.json @@ -0,0 +1,4 @@ +{ + "name": "esm-ext", + "main": "index.mjs" +} diff --git a/scripts/bin-test/sources/esm-main/functions.js b/scripts/bin-test/sources/esm-main/functions.js new file mode 100644 index 000000000..b09186731 --- /dev/null +++ b/scripts/bin-test/sources/esm-main/functions.js @@ -0,0 +1,18 @@ +import * as functions from "firebase-functions"; +import * as functionsv2 from "firebase-functions/v2"; + +export const v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +export const v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +export const v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +export const v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/scripts/bin-test/sources/esm-main/package.json b/scripts/bin-test/sources/esm-main/package.json new file mode 100644 index 000000000..6c0840b1d --- /dev/null +++ b/scripts/bin-test/sources/esm-main/package.json @@ -0,0 +1,5 @@ +{ + "name": "esm-main", + "main": "functions.js", + "type": "module" +} diff --git a/scripts/bin-test/sources/esm/index.js b/scripts/bin-test/sources/esm/index.js new file mode 100644 index 000000000..b09186731 --- /dev/null +++ b/scripts/bin-test/sources/esm/index.js @@ -0,0 +1,18 @@ +import * as functions from "firebase-functions"; +import * as functionsv2 from "firebase-functions/v2"; + +export const v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +export const v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +export const v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +export const v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/scripts/bin-test/sources/esm/package.json b/scripts/bin-test/sources/esm/package.json new file mode 100644 index 000000000..9cb65cb9f --- /dev/null +++ b/scripts/bin-test/sources/esm/package.json @@ -0,0 +1,4 @@ +{ + "name": "esm", + "type": "module" +} diff --git a/scripts/bin-test/test.ts b/scripts/bin-test/test.ts new file mode 100644 index 000000000..154c2295c --- /dev/null +++ b/scripts/bin-test/test.ts @@ -0,0 +1,236 @@ +import * as subprocess from 'child_process'; +import * as path from 'path'; +import { promisify } from 'util'; + +import { expect } from 'chai'; +import * as yaml from 'js-yaml'; +import fetch from 'node-fetch'; +import * as portfinder from 'portfinder'; +import * as semver from 'semver'; + +const TIMEOUT_XL = 20_000; +const TIMEOUT_L = 10_000; +const TIMEOUT_M = 5_000; +const TIMEOUT_S = 1_000; + +const BASE_STACK = { + endpoints: { + v1http: { + platform: 'gcfv1', + entryPoint: 'v1http', + httpsTrigger: {}, + }, + v1callable: { + platform: 'gcfv1', + entryPoint: 'v1callable', + labels: {}, + callableTrigger: {}, + }, + v2http: { + platform: 'gcfv2', + entryPoint: 'v2http', + labels: {}, + httpsTrigger: {}, + }, + v2callable: { + platform: 'gcfv2', + entryPoint: 'v2callable', + labels: {}, + callableTrigger: {}, + }, + }, + requiredAPIs: [], + specVersion: 'v1alpha1', +}; + +interface Testcase { + name: string; + modulePath: string; + expected: Record; +} + +async function retryUntil( + fn: () => Promise, + timeoutMs: number, + sleepMs: number = TIMEOUT_S +) { + const sleep = () => { + return new Promise((resolve) => { + setTimeout(() => resolve(), sleepMs); + }); + }; + const timedOut = new Promise((resolve, reject) => { + setTimeout(() => { + reject(new Error('retry timeout')); + }, timeoutMs); + }); + const retry = (async () => { + while (true) { + if (await fn()) { + break; + } + await sleep(); + } + })(); + await Promise.race([retry, timedOut]); +} + +async function startBin( + tc: Testcase, + debug?: boolean +): Promise<{ port: number; cleanup: () => Promise }> { + const getPort = promisify(portfinder.getPort) as () => Promise; + const port = await getPort(); + + const proc = subprocess.spawn('./node_modules/.bin/firebase-functions', [], { + cwd: path.resolve(tc.modulePath), + env: { + PATH: process.env.PATH, + GLCOUD_PROJECT: 'test-project', + PORT: port, + FUNCTIONS_CONTROL_API: 'true', + }, + }); + + if (!proc) { + throw new Error('Failed to start firebase functions'); + } + + await retryUntil(async () => { + try { + await fetch(`http://localhost:${port}/__/functions.yaml`); + } catch (e) { + if (e?.code === 'ECONNREFUSED') { + return false; + } + throw e; + } + return true; + }, TIMEOUT_M); + + if (debug) { + proc.stdout?.on('data', (data: unknown) => { + console.log(`[${tc.name} stdout] ` + data); + }); + + proc.stderr?.on('data', (data: unknown) => { + console.log(`[${tc.name} stderr] ` + data); + }); + } + + return { + port, + cleanup: async () => { + process.kill(proc.pid); + await retryUntil(async () => { + try { + process.kill(proc.pid, 0); + } catch { + // process.kill w/ signal 0 will throw an error if the pid no longer exists. + return true; + } + return false; + }, TIMEOUT_M); + }, + }; +} + +describe('functions.yaml', () => { + async function runTests(tc: Testcase) { + let port: number; + let cleanup: () => Promise; + + before(async () => { + const r = await startBin(tc); + port = r.port; + cleanup = r.cleanup; + }); + + after(async () => { + await cleanup?.(); + }); + + it('functions.yaml returns expected Manifest', async () => { + const res = await fetch(`http://localhost:${port}/__/functions.yaml`); + const text = await res.text(); + let parsed: any; + try { + parsed = yaml.load(text); + } catch (err) { + throw new Error('Failed to parse functions.yaml ' + err); + } + expect(parsed).to.be.deep.equal(tc.expected); + }); + } + + describe('commonjs', () => { + const testcases: Testcase[] = [ + { + name: 'basic', + modulePath: './scripts/bin-test/sources/commonjs', + expected: BASE_STACK, + }, + { + name: 'has main', + modulePath: './scripts/bin-test/sources/commonjs-main', + expected: BASE_STACK, + }, + { + name: 'grouped', + modulePath: './scripts/bin-test/sources/commonjs-grouped', + expected: { + ...BASE_STACK, + endpoints: { + ...BASE_STACK.endpoints, + 'g1-groupedhttp': { + platform: 'gcfv1', + entryPoint: 'g1.groupedhttp', + httpsTrigger: {}, + }, + 'g1-groupedcallable': { + platform: 'gcfv1', + entryPoint: 'g1.groupedcallable', + labels: {}, + callableTrigger: {}, + }, + }, + }, + }, + ]; + + for (const tc of testcases) { + describe(tc.name, async () => { + await runTests(tc); + }); + } + }).timeout(TIMEOUT_L); + + if (semver.gt(process.versions.node, '13.2.0')) { + describe('esm', () => { + const testcases: Testcase[] = [ + { + name: 'basic', + modulePath: './scripts/bin-test/sources/esm', + expected: BASE_STACK, + }, + { + name: 'with main', + + modulePath: './scripts/bin-test/sources/esm-main', + expected: BASE_STACK, + }, + { + name: 'with .m extension', + modulePath: './scripts/bin-test/sources/esm-ext', + expected: BASE_STACK, + }, + ]; + + for (const tc of testcases) { + describe(tc.name, async () => { + await runTests(tc); + }); + } + }).timeout(TIMEOUT_L); + } +}).timeout(TIMEOUT_XL); diff --git a/scripts/fetch-regions b/scripts/fetch-regions new file mode 100755 index 000000000..d529cdf9b --- /dev/null +++ b/scripts/fetch-regions @@ -0,0 +1,7 @@ +#!/bin/bash + +if [ -z $1 ]; then + echo "Must provide a project id as first argument." && exit 1 +fi; + +gcloud functions regions list --project $1 --format=json | jq 'map(.locationId)' \ No newline at end of file diff --git a/scripts/publish-container/Dockerfile b/scripts/publish-container/Dockerfile new file mode 100644 index 000000000..02b15bf11 --- /dev/null +++ b/scripts/publish-container/Dockerfile @@ -0,0 +1,12 @@ +FROM node:14 + +# Install dependencies +RUN apt-get update && \ + apt-get install -y curl git jq + +# Install npm at latest. +RUN npm install --global npm@latest + +# Install hub +RUN curl -fsSL --output hub.tgz https://github.com/github/hub/releases/download/v2.13.0/hub-linux-amd64-2.13.0.tgz +RUN tar --strip-components=2 -C /usr/bin -xf hub.tgz hub-linux-amd64-2.13.0/bin/hub diff --git a/scripts/publish-container/cloudbuild.yaml b/scripts/publish-container/cloudbuild.yaml new file mode 100644 index 000000000..7a99a8cab --- /dev/null +++ b/scripts/publish-container/cloudbuild.yaml @@ -0,0 +1,4 @@ +steps: + - name: 'gcr.io/cloud-builders/docker' + args: ['build', '-t', 'gcr.io/$PROJECT_ID/package-builder', '.'] +images: ['gcr.io/$PROJECT_ID/package-builder'] diff --git a/scripts/publish.sh b/scripts/publish.sh new file mode 100644 index 000000000..a7574a15a --- /dev/null +++ b/scripts/publish.sh @@ -0,0 +1,140 @@ +#!/bin/bash +set -e + +printusage() { + echo "publish.sh " + echo "REPOSITORY_ORG and REPOSITORY_NAME should be set in the environment." + echo "e.g. REPOSITORY_ORG=user, REPOSITORY_NAME=repo" + echo "" + echo "Arguments:" + echo " version: 'patch', 'minor', or 'major'." +} + +VERSION=$1 +if [[ $VERSION == "" ]]; then + printusage + exit 1 +elif [[ ! ($VERSION == "patch" || $VERSION == "minor" || $VERSION == "major") ]]; then + printusage + exit 1 +fi + +if [[ $REPOSITORY_ORG == "" ]]; then + printusage + exit 1 +fi +if [[ $REPOSITORY_NAME == "" ]]; then + printusage + exit 1 +fi + +WDIR=$(pwd) + +echo "Checking for commands..." +trap "echo 'Missing hub.'; exit 1" ERR +which hub &> /dev/null +trap - ERR + +trap "echo 'Missing node.'; exit 1" ERR +which node &> /dev/null +trap - ERR + +trap "echo 'Missing jq.'; exit 1" ERR +which jq &> /dev/null +trap - ERR +echo "Checked for commands." + +echo "Checking for Twitter credentials..." +trap "echo 'Missing Twitter credentials.'; exit 1" ERR +test -f "${WDIR}/scripts/twitter.json" +trap - ERR +echo "Checked for Twitter credentials..." + +echo "Checking for logged-in npm user..." +trap "echo 'Please login to npm using \`npm login --registry https://wombat-dressing-room.appspot.com\`'; exit 1" ERR +npm whoami --registry https://wombat-dressing-room.appspot.com +trap - ERR +echo "Checked for logged-in npm user." + +echo "Moving to temporary directory.." +TEMPDIR=$(mktemp -d) +echo "[DEBUG] ${TEMPDIR}" +cd "${TEMPDIR}" +echo "Moved to temporary directory." + +echo "Cloning repository..." +git clone "git@github.com:${REPOSITORY_ORG}/${REPOSITORY_NAME}.git" +cd "${REPOSITORY_NAME}" +echo "Cloned repository." + +echo "Making sure there is a changelog..." +if [ ! -s CHANGELOG.md ]; then + echo "CHANGELOG.md is empty. aborting." + exit 1 +fi +echo "Made sure there is a changelog." + +echo "Running npm ci..." +npm ci +echo "Ran npm ci." + +echo "Running tests..." +npm test +npm run test:bin +echo "Ran tests." + +echo "Running publish build..." +npm run build:release +echo "Ran publish build." + +echo "Making a $VERSION version..." +# TODO: Remove the following command. +# npm version command had previously failed claiming unclean git repo, and we don't know why. +echo "DEBUG: Running git status to show dirty files..." +git status +npm version $VERSION +NEW_VERSION=$(jq -r ".version" package.json) +echo "Made a $VERSION version." + +echo "Making the release notes..." +RELEASE_NOTES_FILE=$(mktemp) +echo "[DEBUG] ${RELEASE_NOTES_FILE}" +echo "v${NEW_VERSION}" >> "${RELEASE_NOTES_FILE}" +echo "" >> "${RELEASE_NOTES_FILE}" +cat CHANGELOG.md >> "${RELEASE_NOTES_FILE}" +echo "Made the release notes." + +echo "Publishing to npm..." +if [[ $DRY_RUN == "" ]]; then + npm publish +else + echo "DRY RUN: running publish with --dry-run" + npm publish --dry-run +fi +echo "Published to npm." + +if [[ $DRY_RUN != "" ]]; then + echo "All other commands are mutations, and we are doing a dry run." + echo "Terminating." + exit +fi + +echo "Cleaning up release notes..." +rm CHANGELOG.md +touch CHANGELOG.md +git commit -m "[firebase-release] Removed change log and reset repo after ${NEW_VERSION} release" CHANGELOG.md +echo "Cleaned up release notes." + +echo "Pushing to GitHub..." +git push origin master --tags +echo "Pushed to GitHub." + +echo "Publishing release notes..." +hub release create --file "${RELEASE_NOTES_FILE}" "v${NEW_VERSION}" +echo "Published release notes." + +echo "Making the tweet..." +npm install --no-save twitter@1.7.1 +cp -v "${WDIR}/scripts/twitter.json" "${TEMPDIR}/${REPOSITORY_NAME}/scripts/" +node ./scripts/tweet.js ${NEW_VERSION} +echo "Made the tweet." diff --git a/scripts/publish/cloudbuild.yaml b/scripts/publish/cloudbuild.yaml new file mode 100644 index 000000000..d04fec25c --- /dev/null +++ b/scripts/publish/cloudbuild.yaml @@ -0,0 +1,114 @@ +steps: + # Decrypt the SSH key. + - name: 'gcr.io/cloud-builders/gcloud' + args: + [ + 'kms', + 'decrypt', + '--ciphertext-file=deploy_key.enc', + '--plaintext-file=/root/.ssh/id_rsa', + '--location=global', + '--keyring=${_KEY_RING}', + '--key=${_KEY_NAME}', + ] + + # Decrypt the Twitter credentials. + - name: 'gcr.io/cloud-builders/gcloud' + args: + [ + 'kms', + 'decrypt', + '--ciphertext-file=twitter.json.enc', + '--plaintext-file=twitter.json', + '--location=global', + '--keyring=${_KEY_RING}', + '--key=${_KEY_NAME}', + ] + + # Decrypt the npm credentials. + - name: 'gcr.io/cloud-builders/gcloud' + args: + [ + 'kms', + 'decrypt', + '--ciphertext-file=npmrc.enc', + '--plaintext-file=npmrc', + '--location=global', + '--keyring=${_KEY_RING}', + '--key=${_KEY_NAME}', + ] + + # Decrypt the hub (GitHub) credentials. + - name: 'gcr.io/cloud-builders/gcloud' + args: + [ + 'kms', + 'decrypt', + '--ciphertext-file=hub.enc', + '--plaintext-file=hub', + '--location=global', + '--keyring=${_KEY_RING}', + '--key=${_KEY_NAME}', + ] + + # Set up git with key and domain. + - name: 'gcr.io/cloud-builders/git' + entrypoint: 'bash' + args: + - '-c' + - | + chmod 600 /root/.ssh/id_rsa + cat </root/.ssh/config + Hostname github.com + IdentityFile /root/.ssh/id_rsa + EOF + ssh-keyscan github.com >> /root/.ssh/known_hosts + + # Clone the repository. + - name: 'gcr.io/cloud-builders/git' + args: ['clone', 'git@github.com:${_REPOSITORY_ORG}/${_REPOSITORY_NAME}'] + + # Set up the Git configuration. + - name: 'gcr.io/cloud-builders/git' + dir: '${_REPOSITORY_NAME}' + args: ['config', '--global', 'user.email', 'firebase-oss-bot@google.com'] + - name: 'gcr.io/cloud-builders/git' + dir: '${_REPOSITORY_NAME}' + args: ['config', '--global', 'user.name', 'Google Open Source Bot'] + + # Set up the Twitter credentials. + - name: 'gcr.io/$PROJECT_ID/package-builder' + entrypoint: 'cp' + args: ['-v', 'twitter.json', '${_REPOSITORY_NAME}/scripts/twitter.json'] + + # Set up the npm credentials. + - name: 'gcr.io/$PROJECT_ID/package-builder' + entrypoint: 'bash' + args: ['-c', 'cp -v npmrc ~/.npmrc'] + + # Set up the hub credentials for package-builder. + - name: 'gcr.io/$PROJECT_ID/package-builder' + entrypoint: 'bash' + args: ['-c', 'mkdir -vp ~/.config && cp -v hub ~/.config/hub'] + + # Publish the package. + - name: 'gcr.io/$PROJECT_ID/package-builder' + dir: '${_REPOSITORY_NAME}' + args: ['bash', './scripts/publish.sh', '${_VERSION}'] + env: + - 'REPOSITORY_ORG=${_REPOSITORY_ORG}' + - 'REPOSITORY_NAME=${_REPOSITORY_NAME}' + - 'DRY_RUN=${_DRY_RUN}' + +options: + volumes: + - name: 'ssh' + path: /root/.ssh + +substitutions: + _VERSION: '' + _DRY_RUN: '' + _KEY_RING: 'npm-publish-keyring' + _KEY_NAME: 'publish' + _REPOSITORY_ORG: 'firebase' + _REPOSITORY_NAME: 'firebase-functions' diff --git a/scripts/publish/deploy_key.enc b/scripts/publish/deploy_key.enc new file mode 100644 index 000000000..127551f08 Binary files /dev/null and b/scripts/publish/deploy_key.enc differ diff --git a/scripts/publish/hub.enc b/scripts/publish/hub.enc new file mode 100644 index 000000000..a20ac3378 Binary files /dev/null and b/scripts/publish/hub.enc differ diff --git a/scripts/publish/npmrc.enc b/scripts/publish/npmrc.enc new file mode 100644 index 000000000..da8ea49bb Binary files /dev/null and b/scripts/publish/npmrc.enc differ diff --git a/scripts/publish/twitter.json.enc b/scripts/publish/twitter.json.enc new file mode 100644 index 000000000..82123a04d Binary files /dev/null and b/scripts/publish/twitter.json.enc differ diff --git a/scripts/tweet.js b/scripts/tweet.js new file mode 100644 index 000000000..be6229574 --- /dev/null +++ b/scripts/tweet.js @@ -0,0 +1,52 @@ +"use strict"; + +const fs = require("fs"); +const Twitter = require("twitter"); + +function printUsage() { + console.error( + ` +Usage: tweet.js + +Credentials must be stored in "twitter.json" in this directory. + +Arguments: + - version: Version of module that was released. e.g. "1.2.3" +` + ); + process.exit(1); +} + +function getUrl(version) { + return `https://github.com/firebase/firebase-functions/releases/tag/v${version}`; +} + +if (process.argv.length !== 3) { + console.error("Missing arguments."); + printUsage(); +} + +const version = process.argv.pop(); +if (!version.match(/^\d+\.\d+\.\d+$/)) { + console.error(`Version "${version}" not a version number.`); + printUsage(); +} + +if (!fs.existsSync(`${__dirname}/twitter.json`)) { + console.error("Missing credentials."); + printUsage(); +} +const creds = require("./twitter.json"); + +const client = new Twitter(creds); + +client.post( + "statuses/update", + { status: `v${version} of @Firebase SDK for Cloud Functions is available. Release notes: ${getUrl(version)}` }, + (err) => { + if (err) { + console.error(err); + process.exit(1); + } + } +); diff --git a/spec/common/change.spec.ts b/spec/common/change.spec.ts new file mode 100644 index 000000000..258fc8463 --- /dev/null +++ b/spec/common/change.spec.ts @@ -0,0 +1,120 @@ +// 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 change from '../../src/common/change'; + +describe('Change', () => { + describe('applyFieldMask', () => { + const after = { + foo: 'bar', + num: 2, + obj: { + a: 1, + b: 2, + }, + }; + + it('should handle deleted values', () => { + const sparseBefore = { baz: 'qux' }; + const fieldMask = 'baz'; + expect( + change.applyFieldMask(sparseBefore, after, fieldMask) + ).to.deep.equal({ + foo: 'bar', + num: 2, + obj: { + a: 1, + b: 2, + }, + baz: 'qux', + }); + }); + + it('should handle created values', () => { + const sparseBefore = {}; + const fieldMask = 'num,obj.a'; + expect( + change.applyFieldMask(sparseBefore, after, fieldMask) + ).to.deep.equal({ + foo: 'bar', + obj: { + b: 2, + }, + }); + }); + + it('should handle mutated values', () => { + const sparseBefore = { + num: 3, + obj: { + a: 3, + }, + }; + const fieldMask = 'num,obj.a'; + expect( + change.applyFieldMask(sparseBefore, after, fieldMask) + ).to.deep.equal({ + foo: 'bar', + num: 3, + obj: { + a: 3, + b: 2, + }, + }); + }); + }); + + describe('fromJSON', () => { + it('should create a Change object with a `before` and `after`', () => { + const created = change.Change.fromJSON({ + before: { foo: 'bar' }, + after: { foo: 'faz' }, + }); + expect(created instanceof change.Change).to.equal(true); + expect(created.before).to.deep.equal({ foo: 'bar' }); + expect(created.after).to.deep.equal({ foo: 'faz' }); + }); + + it('should apply the customizer function to `before` and `after`', () => { + function customizer(input: any) { + input.another = 'value'; + return input as T; + } + const created = change.Change.fromJSON( + { + before: { foo: 'bar' }, + after: { foo: 'faz' }, + }, + customizer + ); + expect(created.before).to.deep.equal({ + foo: 'bar', + another: 'value', + }); + expect(created.after).to.deep.equal({ + foo: 'faz', + another: 'value', + }); + }); + }); +}); diff --git a/spec/common/encoding.spec.ts b/spec/common/encoding.spec.ts new file mode 100644 index 000000000..388a6681c --- /dev/null +++ b/spec/common/encoding.spec.ts @@ -0,0 +1,48 @@ +import { expect } from 'chai'; +import { convertInvoker } from '../../src/common/encoding'; + +describe('convertInvoker', () => { + it('should raise an error on empty array', () => { + expect(() => convertInvoker([])).to.throw; + }); + + it('should raise an error on empty string', () => { + expect(() => convertInvoker('')).to.throw; + }); + + it('should raise an error on empty string with service accounts', () => { + expect(() => convertInvoker(['service-account@', ''])).to.throw; + }); + + it('should raise an error on mixing public and service accounts', () => { + expect(() => convertInvoker(['public', 'service-account@'])).to.throw; + }); + + it('should raise an error on mixing private and service accounts', () => { + expect(() => convertInvoker(['private', 'service-account@'])).to.throw; + }); + + it('should return the correct public invoker', () => { + const invoker = convertInvoker('public'); + + expect(invoker).to.deep.equal(['public']); + }); + + it('should return the correct private invoker', () => { + const invoker = convertInvoker('private'); + + expect(invoker).to.deep.equal(['private']); + }); + + it('should return the correct scalar invoker', () => { + const invoker = convertInvoker('service-account@'); + + expect(invoker).to.deep.equal(['service-account@']); + }); + + it('should return the correct array invoker', () => { + const invoker = convertInvoker(['service-account1@', 'service-account2@']); + + expect(invoker).to.deep.equal(['service-account1@', 'service-account2@']); + }); +}); diff --git a/spec/common/providers/https.spec.ts b/spec/common/providers/https.spec.ts new file mode 100644 index 000000000..a87aa844d --- /dev/null +++ b/spec/common/providers/https.spec.ts @@ -0,0 +1,682 @@ +import { expect } from 'chai'; +import * as firebase from 'firebase-admin'; +import * as sinon from 'sinon'; + +import { apps as appsNamespace } from '../../../src/apps'; +import * as debug from '../../../src/common/debug'; +import * as https from '../../../src/common/providers/https'; +import * as mocks from '../../fixtures/credential/key.json'; +import { + expectedResponseHeaders, + generateAppCheckToken, + generateIdToken, + generateUnsignedAppCheckToken, + generateUnsignedIdToken, + mockFetchAppCheckPublicJwks, + mockFetchPublicKeys, + mockRequest, +} from '../../fixtures/mockrequest'; +import { + checkAppCheckContext, + checkAuthContext, + runHandler, + RunHandlerResult, +} from '../../helper'; + +/** + * A CallTest is a specification for a test of a callable function that + * simulates triggering the http endpoint, and checks that the request + * and response are properly converted to their http equivalents. + */ +interface CallTest { + // An http request, mocking a subset of https.Request. + httpRequest: any; + + // The expected format of the request passed to the handler. + expectedData: any; + + // The function to execute with the request. + callableFunction: (data: any, context: https.CallableContext) => any; + + callableFunction2: (request: https.CallableRequest) => any; + + callableOption?: https.CallableOptions; + + // The expected shape of the http response returned to the callable SDK. + expectedHttpResponse: RunHandlerResult; +} + +// Runs a CallTest test. +async function runCallableTest(test: CallTest): Promise { + const opts = { + cors: { origin: true, methods: 'POST' }, + ...test.callableOption, + }; + const callableFunctionV1 = https.onCallHandler(opts, (data, context) => { + expect(data).to.deep.equal(test.expectedData); + return test.callableFunction(data, context); + }); + + const responseV1 = await runHandler(callableFunctionV1, test.httpRequest); + + expect(responseV1.body).to.deep.equal(test.expectedHttpResponse.body); + expect(responseV1.headers).to.deep.equal(test.expectedHttpResponse.headers); + expect(responseV1.status).to.equal(test.expectedHttpResponse.status); + + const callableFunctionV2 = https.onCallHandler(opts, (request) => { + expect(request.data).to.deep.equal(test.expectedData); + return test.callableFunction2(request); + }); + + const responseV2 = await runHandler(callableFunctionV2, test.httpRequest); + + expect(responseV2.body).to.deep.equal(test.expectedHttpResponse.body); + expect(responseV2.headers).to.deep.equal(test.expectedHttpResponse.headers); + expect(responseV2.status).to.equal(test.expectedHttpResponse.status); +} + +describe('onCallHandler', () => { + let app: firebase.app.App; + + before(() => { + const credential = { + getAccessToken: () => { + return Promise.resolve({ + expires_in: 1000, + access_token: 'fake', + }); + }, + getCertificate: () => { + return { + projectId: 'aProjectId', + }; + }, + }; + app = firebase.initializeApp({ + projectId: 'aProjectId', + credential, + }); + Object.defineProperty(appsNamespace(), 'admin', { get: () => app }); + }); + + after(() => { + app.delete(); + delete appsNamespace.singleton; + }); + + it('should handle success', () => { + return runCallableTest({ + httpRequest: mockRequest({ foo: 'bar' }), + expectedData: { foo: 'bar' }, + callableFunction: (data, context) => ({ baz: 'qux' }), + callableFunction2: (request) => ({ baz: 'qux' }), + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: { baz: 'qux' } }, + }, + }); + }); + + it('should handle null data and return', () => { + return runCallableTest({ + httpRequest: mockRequest(null), + expectedData: null, + callableFunction: (data, context) => null, + callableFunction2: (request) => null, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + it('should handle void return', () => { + return runCallableTest({ + httpRequest: mockRequest(null), + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + it('should reject bad method', () => { + const req = mockRequest(null); + req.method = 'GET'; + return runCallableTest({ + httpRequest: req, + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 400, + headers: expectedResponseHeaders, + body: { + error: { status: 'INVALID_ARGUMENT', message: 'Bad Request' }, + }, + }, + }); + }); + + it('should ignore charset', () => { + return runCallableTest({ + httpRequest: mockRequest(null, 'application/json; charset=utf-8'), + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + it('should reject bad content type', () => { + return runCallableTest({ + httpRequest: mockRequest(null, 'text/plain'), + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 400, + headers: expectedResponseHeaders, + body: { + error: { status: 'INVALID_ARGUMENT', message: 'Bad Request' }, + }, + }, + }); + }); + + it('should reject extra body fields', () => { + const req = mockRequest(null); + req.body.extra = 'bad'; + return runCallableTest({ + httpRequest: req, + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 400, + headers: expectedResponseHeaders, + body: { + error: { status: 'INVALID_ARGUMENT', message: 'Bad Request' }, + }, + }, + }); + }); + + it('should handle unhandled error', () => { + return runCallableTest({ + httpRequest: mockRequest(null), + expectedData: null, + callableFunction: (data, context) => { + throw new Error(`ceci n'est pas une error`); + }, + callableFunction2: (request) => { + throw new Error(`cece n'est pas une error`); + }, + expectedHttpResponse: { + status: 500, + headers: expectedResponseHeaders, + body: { error: { status: 'INTERNAL', message: 'INTERNAL' } }, + }, + }); + }); + + it('should handle unknown error status', () => { + return runCallableTest({ + httpRequest: mockRequest(null), + expectedData: null, + callableFunction: (data, context) => { + throw new https.HttpsError('THIS_IS_NOT_VALID' as any, 'nope'); + }, + callableFunction2: (request) => { + throw new https.HttpsError('THIS_IS_NOT_VALID' as any, 'nope'); + }, + expectedHttpResponse: { + status: 500, + headers: expectedResponseHeaders, + body: { error: { status: 'INTERNAL', message: 'INTERNAL' } }, + }, + }); + }); + + it('should handle well-formed error', () => { + return runCallableTest({ + httpRequest: mockRequest(null), + expectedData: null, + callableFunction: (data, context) => { + throw new https.HttpsError('not-found', 'i am error'); + }, + callableFunction2: (request) => { + throw new https.HttpsError('not-found', 'i am error'); + }, + expectedHttpResponse: { + status: 404, + headers: expectedResponseHeaders, + body: { error: { status: 'NOT_FOUND', message: 'i am error' } }, + }, + }); + }); + + it('should handle auth', async () => { + const mock = mockFetchPublicKeys(); + const projectId = appsNamespace().admin.options.projectId; + const idToken = generateIdToken(projectId); + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { + authorization: 'Bearer ' + idToken, + }), + expectedData: null, + callableFunction: (data, context) => { + checkAuthContext(context, projectId, mocks.user_id); + return null; + }, + callableFunction2: (request) => { + checkAuthContext(request, projectId, mocks.user_id); + return null; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + mock.done(); + }); + + it('should reject bad auth', async () => { + const projectId = appsNamespace().admin.options.projectId; + const idToken = generateUnsignedIdToken(projectId); + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { + authorization: 'Bearer ' + idToken, + }), + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 401, + headers: expectedResponseHeaders, + body: { + error: { + status: 'UNAUTHENTICATED', + message: 'Unauthenticated', + }, + }, + }, + }); + }); + + it('should handle AppCheck token', async () => { + const mock = mockFetchAppCheckPublicJwks(); + const projectId = appsNamespace().admin.options.projectId; + const appId = '123:web:abc'; + const appCheckToken = generateAppCheckToken(projectId, appId); + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { appCheckToken }), + expectedData: null, + callableFunction: (data, context) => { + checkAppCheckContext(context, projectId, appId); + return null; + }, + callableFunction2: (request) => { + checkAppCheckContext(request, projectId, appId); + return null; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + expect(mock.isDone()).to.be.true; + }); + + it('should reject bad AppCheck token', async () => { + const projectId = appsNamespace().admin.options.projectId; + const appId = '123:web:abc'; + const appCheckToken = generateUnsignedAppCheckToken(projectId, appId); + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { appCheckToken }), + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + expectedHttpResponse: { + status: 401, + headers: expectedResponseHeaders, + body: { + error: { + status: 'UNAUTHENTICATED', + message: 'Unauthenticated', + }, + }, + }, + }); + }); + + it('should handle bad AppCheck token with callable option', async () => { + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { + appCheckToken: 'FAKE', + }), + expectedData: null, + callableFunction: (data, context) => { + return; + }, + callableFunction2: (request) => { + return; + }, + callableOption: { + cors: { origin: true, methods: 'POST' }, + allowInvalidAppCheckToken: true, + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + it('should handle instance id', async () => { + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { + instanceIdToken: 'iid-token', + }), + expectedData: null, + callableFunction: (data, context) => { + expect(context.auth).to.be.undefined; + expect(context.instanceIdToken).to.equal('iid-token'); + return null; + }, + callableFunction2: (request) => { + expect(request.auth).to.be.undefined; + expect(request.instanceIdToken).to.equal('iid-token'); + return null; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + it('should expose raw request', async () => { + const mockReq = mockRequest(null, 'application/json', {}); + await runCallableTest({ + httpRequest: mockReq, + expectedData: null, + callableFunction: (data, context) => { + expect(context.rawRequest).to.not.be.undefined; + expect(context.rawRequest).to.equal(mockReq); + return null; + }, + callableFunction2: (request) => { + expect(request.rawRequest).to.not.be.undefined; + expect(request.rawRequest).to.equal(mockReq); + return null; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + describe('skip token verification debug mode support', () => { + before(() => { + sinon + .stub(debug, 'isDebugFeatureEnabled') + .withArgs('skipTokenVerification') + .returns(true); + }); + + after(() => { + sinon.verifyAndRestore(); + }); + + it('should skip auth token verification', async () => { + const projectId = appsNamespace().admin.options.projectId; + const idToken = generateUnsignedIdToken(projectId); + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { + authorization: 'Bearer ' + idToken, + }), + expectedData: null, + callableFunction: (data, context) => { + checkAuthContext(context, projectId, mocks.user_id); + return null; + }, + callableFunction2: (request) => { + checkAuthContext(request, projectId, mocks.user_id); + return null; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + + it('should skip app check token verification', async () => { + const projectId = appsNamespace().admin.options.projectId; + const appId = '123:web:abc'; + const appCheckToken = generateUnsignedAppCheckToken(projectId, appId); + await runCallableTest({ + httpRequest: mockRequest(null, 'application/json', { appCheckToken }), + expectedData: null, + callableFunction: (data, context) => { + checkAppCheckContext(context, projectId, appId); + return null; + }, + callableFunction2: (request) => { + checkAppCheckContext(request, projectId, appId); + return null; + }, + expectedHttpResponse: { + status: 200, + headers: expectedResponseHeaders, + body: { result: null }, + }, + }); + }); + }); +}); + +describe('encoding/decoding', () => { + it('encodes null', () => { + expect(https.encode(null)).to.be.null; + expect(https.encode(undefined)).to.be.null; + }); + + it('encodes int', () => { + expect(https.encode(1)).to.equal(1); + // Number isn't allowed in our own codebase, but we need to test it, in case + // a user passes one in. There's no reason not to support it, and we don't + // want to unintentionally encode them as {}. + // tslint:disable-next-line + expect(https.encode(new Number(1))).to.equal(1); + }); + + it('decodes int', () => { + expect(https.decode(1)).to.equal(1); + }); + + it('encodes long', () => { + expect(https.encode(-9223372036854775000)).to.equal(-9223372036854775000); + }); + + it('decodes long', () => { + expect( + https.decode({ + '@type': 'type.googleapis.com/google.protobuf.Int64Value', + value: '-9223372036854775000', + }) + ).to.equal(-9223372036854775000); + }); + + it('encodes unsigned long', () => { + expect(https.encode(9223372036854800000)).to.equal(9223372036854800000); + }); + + it('decodes unsigned long', () => { + expect( + https.decode({ + '@type': 'type.googleapis.com/google.protobuf.UInt64Value', + value: '9223372036854800000', + }) + ).to.equal(9223372036854800000); + }); + + it('encodes double', () => { + expect(https.encode(1.2)).to.equal(1.2); + }); + it('decodes double', () => { + expect(https.decode(1.2)).to.equal(1.2); + }); + + it('encodes string', () => { + expect(https.encode('hello')).to.equal('hello'); + }); + + it('decodes string', () => { + expect(https.decode('hello')).to.equal('hello'); + }); + + it('encodes array', () => { + // TODO(klimt): Make this test more interesting once there's some type + // that needs encoding that can be created from JavaScript. + expect(https.encode([1, '2', [3, 4]])).to.deep.equal([1, '2', [3, 4]]); + }); + + it('decodes array', () => { + expect( + https.decode([ + 1, + '2', + [ + 3, + { + value: '1099511627776', + '@type': 'type.googleapis.com/google.protobuf.Int64Value', + }, + ], + ]) + ).to.deep.equal([1, '2', [3, 1099511627776]]); + }); + + it('encodes object', () => { + // TODO(klimt): Make this test more interesting once there's some type + // that needs encoding that can be created from JavaScript. + expect( + https.encode({ + foo: 1, + bar: 'hello', + baz: [1, 2, 3], + }) + ).to.deep.equal({ + foo: 1, + bar: 'hello', + baz: [1, 2, 3], + }); + }); + + it('decodes object', () => { + expect( + https.decode({ + foo: 1, + bar: 'hello', + baz: [ + 1, + 2, + { + value: '1099511627776', + '@type': 'type.googleapis.com/google.protobuf.Int64Value', + }, + ], + }) + ).to.deep.equal({ + foo: 1, + bar: 'hello', + baz: [1, 2, 1099511627776], + }); + }); + + it('encodes function as an empty object', () => { + expect(https.encode(() => 'foo')).to.deep.equal({}); + }); +}); + +describe('decode tokens', () => { + const projectId = 'myproject'; + const appId = '123:web:abc'; + + it('decodes valid Auth ID Token', () => { + const idToken = https.unsafeDecodeIdToken(generateIdToken(projectId)); + expect(idToken.uid).to.equal(mocks.user_id); + expect(idToken.sub).to.equal(mocks.user_id); + }); + + it('decodes invalid Auth ID Token', () => { + const idToken = https.unsafeDecodeIdToken( + generateUnsignedIdToken(projectId) + ); + expect(idToken.uid).to.equal(mocks.user_id); + expect(idToken.sub).to.equal(mocks.user_id); + }); + + it('decodes valid App Check Token', () => { + const idToken = https.unsafeDecodeAppCheckToken( + generateAppCheckToken(projectId, appId) + ); + expect(idToken.app_id).to.equal(appId); + expect(idToken.sub).to.equal(appId); + }); + + it('decodes invalid App Check Token', () => { + const idToken = https.unsafeDecodeAppCheckToken( + generateUnsignedAppCheckToken(projectId, appId) + ); + expect(idToken.app_id).to.equal(appId); + expect(idToken.sub).to.equal(appId); + }); +}); diff --git a/spec/common/providers/identity.spec.ts b/spec/common/providers/identity.spec.ts new file mode 100644 index 000000000..2b2ea71e9 --- /dev/null +++ b/spec/common/providers/identity.spec.ts @@ -0,0 +1,787 @@ +// 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 express from 'express'; +import * as identity from '../../../src/common/providers/identity'; + +const EVENT = 'EVENT_TYPE'; +const now = new Date(); + +describe('identity', () => { + describe('userRecordConstructor', () => { + it('will provide falsey values for fields that are not in raw wire data', () => { + const record = identity.userRecordConstructor({ uid: '123' }); + expect(record.toJSON()).to.deep.equal({ + uid: '123', + email: null, + emailVerified: false, + displayName: null, + photoURL: null, + phoneNumber: null, + disabled: false, + providerData: [], + customClaims: {}, + passwordSalt: null, + passwordHash: null, + tokensValidAfterTime: null, + metadata: { + creationTime: null, + lastSignInTime: null, + }, + }); + }); + + it('will not interfere with fields that are in raw wire data', () => { + const raw: any = { + uid: '123', + email: 'email@gmail.com', + emailVerified: true, + displayName: 'User', + photoURL: 'url', + phoneNumber: '1233332222', + disabled: true, + providerData: [], + customClaims: {}, + passwordSalt: 'abc', + passwordHash: 'def', + tokensValidAfterTime: '2027-02-02T23:01:19.797Z', + metadata: { + creationTime: '2017-02-02T23:06:26.124Z', + lastSignInTime: '2017-02-02T23:01:19.797Z', + }, + }; + const record = identity.userRecordConstructor(raw); + expect(record.toJSON()).to.deep.equal(raw); + }); + + it('will convert raw wire fields createdAt and lastSignedInAt to creationTime and lastSignInTime', () => { + const raw: any = { + uid: '123', + metadata: { + createdAt: '2017-02-02T23:06:26.124Z', + lastSignedInAt: '2017-02-02T23:01:19.797Z', + }, + }; + const record = identity.userRecordConstructor(raw); + expect(record.metadata).to.deep.equal({ + creationTime: '2017-02-02T23:06:26.124Z', + lastSignInTime: '2017-02-02T23:01:19.797Z', + }); + }); + + it('should stringify the record', () => { + const raw: any = { + uid: '123', + email: 'email@gmail.com', + emailVerified: true, + displayName: 'User', + photoURL: 'url', + phoneNumber: '1233332222', + disabled: true, + providerData: ['something'], + customClaims: { + claim: 'value', + another: { + inner: 'value', + }, + }, + passwordSalt: 'abc', + passwordHash: 'def', + tokensValidAfterTime: '2027-02-02T23:01:19.797Z', + metadata: { + creationTime: '2017-02-02T23:06:26.124Z', + lastSignInTime: '2017-02-02T23:01:19.797Z', + }, + }; + const record = identity.userRecordConstructor(raw); + expect(() => JSON.stringify(record)).to.not.throw; + }); + }); + + describe('isValidRequest', () => { + it('should error on non-post', () => { + const req = ({ + method: 'GET', + header: { + 'Content-Type': 'application/json', + }, + body: { + data: { + jwt: '1.2.3', + }, + }, + } as unknown) as express.Request; + + expect(identity.isValidRequest(req)).to.be.false; + }); + + it('should error on bad Content-Type', () => { + const req = ({ + method: 'POST', + header(val: string) { + return 'text/css'; + }, + body: { + data: { + jwt: '1.2.3', + }, + }, + } as unknown) as express.Request; + + expect(identity.isValidRequest(req)).to.be.false; + }); + + it('should error without req body', () => { + const req = ({ + method: 'POST', + header(val: string) { + return 'application/json'; + }, + } as unknown) as express.Request; + + expect(identity.isValidRequest(req)).to.be.false; + }); + + it('should error without req body data', () => { + const req = ({ + method: 'POST', + header(val: string) { + return 'application/json'; + }, + body: {}, + } as unknown) as express.Request; + + expect(identity.isValidRequest(req)).to.be.false; + }); + + it('should error without req body', () => { + const req = ({ + method: 'POST', + header(val: string) { + return 'application/json'; + }, + body: { + data: {}, + }, + } as unknown) as express.Request; + + expect(identity.isValidRequest(req)).to.be.false; + }); + + it('should not error on valid request', () => { + const req = ({ + method: 'POST', + header(val: string) { + return 'application/json'; + }, + body: { + data: { + jwt: '1.2.3', + }, + }, + } as unknown) as express.Request; + + expect(identity.isValidRequest(req)).to.be.true; + }); + }); + + describe('parseMetadata', () => { + const decodedMetadata = { + last_sign_in_time: 1476235905, + creation_time: 1476136676, + }; + const metadata = { + lastSignInTime: new Date(1476235905000).toUTCString(), + creationTime: new Date(1476136676000).toUTCString(), + }; + + it('should parse an undefined object', () => { + expect(identity.parseMetadata({})).to.deep.equal({ + creationTime: null, + lastSignInTime: null, + }); + }); + + it('should parse a decoded metadata object', () => { + const md = identity.parseMetadata(decodedMetadata); + + expect(md).to.deep.equal(metadata); + }); + }); + + describe('parseProviderData', () => { + const decodedUserInfo = { + provider_id: 'google.com', + display_name: 'John Doe', + photo_url: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + uid: '1234567890', + email: 'user@gmail.com', + }; + const userInfo = { + providerId: 'google.com', + displayName: 'John Doe', + photoURL: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + uid: '1234567890', + email: 'user@gmail.com', + phoneNumber: undefined, + }; + const decodedUserInfoPhone = { + provider_id: 'phone', + phone_number: '+11234567890', + uid: '+11234567890', + }; + const userInfoPhone = { + providerId: 'phone', + displayName: undefined, + photoURL: undefined, + uid: '+11234567890', + email: undefined, + phoneNumber: '+11234567890', + }; + + it('should parse the user info', () => { + expect(identity.parseProviderData([decodedUserInfo])).to.deep.equal([ + userInfo, + ]); + }); + + it('should parse the user info with phone', () => { + expect(identity.parseProviderData([decodedUserInfoPhone])).to.deep.equal([ + userInfoPhone, + ]); + }); + }); + + describe('parseDate', () => { + it('should return null if tokens undefined', () => { + expect(identity.parseDate()).to.be.null; + }); + + it('should parse the date', () => { + expect(identity.parseDate(1476136676)).to.equal( + new Date(1476136676000).toUTCString() + ); + }); + }); + + describe('parseMultiFactor', () => { + const decodedMultiFactors = { + enrolled_factors: [ + { + uid: 'enrollmentId1', + display_name: 'displayName1', + enrollment_time: now.toISOString(), + phone_number: '+16505551234', + }, + { + uid: 'enrollmentId2', + enrollment_time: now.toISOString(), + }, + ], + }; + const multiFactors = { + enrolledFactors: [ + { + uid: 'enrollmentId1', + displayName: 'displayName1', + enrollmentTime: now.toUTCString(), + phoneNumber: '+16505551234', + factorId: 'phone', + }, + { + uid: 'enrollmentId2', + displayName: undefined, + enrollmentTime: now.toUTCString(), + factorId: undefined, + phoneNumber: undefined, + }, + ], + }; + + it('should return null on undefined factor', () => { + expect(identity.parseMultiFactor()).to.be.null; + }); + + it('should return null without enrolled factors', () => { + expect(identity.parseMultiFactor({})).to.be.null; + }); + + it('should error on an invalid factor', () => { + const factors = { + enrolled_factors: [{} as identity.DecodedPayloadMfaInfo], + }; + + expect(() => identity.parseMultiFactor(factors)).to.throw( + 'INTERNAL ASSERT FAILED: Invalid multi-factor info response' + ); + }); + + it('should correctly parse factors', () => { + expect(identity.parseMultiFactor(decodedMultiFactors)).to.deep.equal( + multiFactors + ); + }); + }); + + describe('parseUserRecord', () => { + const decodedUserRecord = { + uid: 'abcdefghijklmnopqrstuvwxyz', + email: 'user@gmail.com', + email_verified: true, + display_name: 'John Doe', + phone_number: '+11234567890', + provider_data: [ + { + provider_id: 'google.com', + display_name: 'John Doe', + photo_url: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + email: 'user@gmail.com', + uid: '1234567890', + }, + { + provider_id: 'facebook.com', + display_name: 'John Smith', + photo_url: 'https://facebook.com/0987654321/photo.jpg', + email: 'user@facebook.com', + uid: '0987654321', + }, + { + provider_id: 'phone', + uid: '+11234567890', + phone_number: '+11234567890', + }, + { + provider_id: 'password', + email: 'user@gmail.com', + uid: 'user@gmail.com', + display_name: 'John Doe', + }, + ], + password_hash: 'passwordHash', + password_salt: 'passwordSalt', + photo_url: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + tokens_valid_after_time: 1476136676, + metadata: { + last_sign_in_time: 1476235905, + creation_time: 1476136676, + }, + custom_claims: { + admin: true, + group_id: 'group123', + }, + tenant_id: 'TENANT_ID', + multi_factor: { + enrolled_factors: [ + { + uid: 'enrollmentId1', + display_name: 'displayName1', + enrollment_time: now.toISOString(), + phone_number: '+16505551234', + factor_id: 'phone', + }, + { + uid: 'enrollmentId2', + enrollment_time: now.toISOString(), + phone_number: '+16505556789', + factor_id: 'phone', + }, + ], + }, + }; + + const userRecord = { + uid: 'abcdefghijklmnopqrstuvwxyz', + email: 'user@gmail.com', + phoneNumber: '+11234567890', + emailVerified: true, + disabled: false, + displayName: 'John Doe', + providerData: [ + { + providerId: 'google.com', + displayName: 'John Doe', + photoURL: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + email: 'user@gmail.com', + uid: '1234567890', + phoneNumber: undefined, + }, + { + providerId: 'facebook.com', + displayName: 'John Smith', + photoURL: 'https://facebook.com/0987654321/photo.jpg', + email: 'user@facebook.com', + uid: '0987654321', + phoneNumber: undefined, + }, + { + providerId: 'phone', + displayName: undefined, + photoURL: undefined, + email: undefined, + uid: '+11234567890', + phoneNumber: '+11234567890', + }, + { + providerId: 'password', + displayName: 'John Doe', + photoURL: undefined, + email: 'user@gmail.com', + uid: 'user@gmail.com', + phoneNumber: undefined, + }, + ], + passwordHash: 'passwordHash', + passwordSalt: 'passwordSalt', + photoURL: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + metadata: { + lastSignInTime: new Date(1476235905000).toUTCString(), + creationTime: new Date(1476136676000).toUTCString(), + }, + customClaims: { + admin: true, + group_id: 'group123', + }, + tokensValidAfterTime: new Date(1476136676000).toUTCString(), + tenantId: 'TENANT_ID', + multiFactor: { + enrolledFactors: [ + { + uid: 'enrollmentId1', + displayName: 'displayName1', + enrollmentTime: now.toUTCString(), + phoneNumber: '+16505551234', + factorId: 'phone', + }, + { + uid: 'enrollmentId2', + displayName: undefined, + enrollmentTime: now.toUTCString(), + phoneNumber: '+16505556789', + factorId: 'phone', + }, + ], + }, + }; + + it('should error if decoded does not have uid', () => { + expect(() => + identity.parseAuthUserRecord({} as identity.DecodedPayloadUserRecord) + ).to.throw('INTERNAL ASSERT FAILED: Invalid user response'); + }); + + it('should parse user record', () => { + const ur = identity.parseAuthUserRecord(decodedUserRecord); + + expect(ur).to.deep.equal(userRecord); + }); + }); + + describe('parseAuthEventContext', () => { + const rawUserInfo = { + name: 'John Doe', + granted_scopes: + 'openid https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile', + id: '123456789', + verified_email: true, + given_name: 'John', + locale: 'en', + family_name: 'Doe', + email: 'johndoe@gmail.com', + picture: 'https://lh3.googleusercontent.com/1233456789/mo/photo.jpg', + }; + + it('should parse an unknown event', () => { + const decodedJwt = { + aud: 'https://us-east1-project_id.cloudfunctions.net/function-1', + exp: 60 * 60 + 1, + iat: 1, + iss: 'https://securetoken.google.com/project_id', + sub: 'someUid', + uid: 'someUid', + event_id: 'EVENT_ID', + event_type: EVENT, + ip_address: '1.2.3.4', + user_agent: 'USER_AGENT', + locale: 'en', + raw_user_info: JSON.stringify(rawUserInfo), + }; + const context = { + locale: 'en', + ipAddress: '1.2.3.4', + userAgent: 'USER_AGENT', + eventId: 'EVENT_ID', + eventType: EVENT, + authType: 'UNAUTHENTICATED', + resource: { + service: 'identitytoolkit.googleapis.com', + name: 'projects/project-id', + }, + timestamp: new Date(1000).toUTCString(), + additionalUserInfo: { + providerId: undefined, + profile: rawUserInfo, + username: undefined, + isNewUser: false, + }, + credential: null, + params: {}, + }; + + expect( + identity.parseAuthEventContext(decodedJwt, 'project-id') + ).to.deep.equal(context); + }); + + it('should parse a beforeSignIn event', () => { + const time = now.getTime(); + const decodedJwt = { + aud: 'https://us-east1-project_id.cloudfunctions.net/function-1', + exp: 60 * 60 + 1, + iat: 1, + iss: 'https://securetoken.google.com/project_id', + sub: 'someUid', + uid: 'someUid', + event_id: 'EVENT_ID', + event_type: 'beforeSignIn', + ip_address: '1.2.3.4', + user_agent: 'USER_AGENT', + locale: 'en', + sign_in_method: 'password', + raw_user_info: JSON.stringify(rawUserInfo), + oauth_id_token: 'ID_TOKEN', + oauth_access_token: 'ACCESS_TOKEN', + oauth_refresh_token: 'REFRESH_TOKEN', + oauth_token_secret: 'OAUTH_TOKEN_SECRET', + oauth_expires_in: 3600, + }; + const context = { + locale: 'en', + ipAddress: '1.2.3.4', + userAgent: 'USER_AGENT', + eventId: 'EVENT_ID', + eventType: 'providers/cloud.auth/eventTypes/user.beforeSignIn:password', + authType: 'UNAUTHENTICATED', + resource: { + service: 'identitytoolkit.googleapis.com', + name: 'projects/project-id', + }, + timestamp: new Date(1000).toUTCString(), + additionalUserInfo: { + providerId: 'password', + profile: rawUserInfo, + username: undefined, + isNewUser: false, + }, + credential: { + claims: undefined, + idToken: 'ID_TOKEN', + accessToken: 'ACCESS_TOKEN', + refreshToken: 'REFRESH_TOKEN', + expirationTime: new Date(time + 3600 * 1000).toUTCString(), + secret: 'OAUTH_TOKEN_SECRET', + providerId: 'password', + signInMethod: 'password', + }, + params: {}, + }; + + expect( + identity.parseAuthEventContext(decodedJwt, 'project-id', time) + ).to.deep.equal(context); + }); + + it('should parse a beforeCreate event', () => { + const time = now.getTime(); + // beforeCreate + const decodedJwt = { + aud: 'https://us-east1-project_id.cloudfunctions.net/beforeCreate', + exp: 60 * 60 + 1, + iat: 1, + iss: 'https://securetoken.google.com/project_id', + sub: 'abcdefghijklmnopqrstuvwxyz', + uid: 'abcdefghijklmnopqrstuvwxyz', + event_id: 'EVENT_ID', + event_type: 'beforeCreate', + ip_address: '1.2.3.4', + user_agent: 'USER_AGENT', + locale: 'en', + sign_in_method: 'oidc.provider', + tenant_id: 'TENANT_ID', + user_record: { + uid: 'abcdefghijklmnopqrstuvwxyz', + email: 'user@gmail.com', + email_verified: true, + display_name: 'John Doe', + phone_number: '+11234567890', + provider_data: [ + { + provider_id: 'oidc.provider', + email: 'user@gmail.com', + uid: 'user@gmail.com', + display_name: 'John Doe', + }, + ], + photo_url: 'https://lh3.googleusercontent.com/1234567890/photo.jpg', + tokens_valid_after_time: 1476136676, + metadata: { + last_sign_in_time: 1476235905, + creation_time: 1476136676, + }, + custom_claims: { + admin: true, + group_id: 'group123', + }, + tenant_id: 'TENANT_ID', + }, + oauth_id_token: 'ID_TOKEN', + oauth_access_token: 'ACCESS_TOKEN', + oauth_refresh_token: 'REFRESH_TOKEN', + oauth_token_secret: 'OAUTH_TOKEN_SECRET', + oauth_expires_in: 3600, + raw_user_info: JSON.stringify(rawUserInfo), + }; + const context = { + locale: 'en', + ipAddress: '1.2.3.4', + userAgent: 'USER_AGENT', + eventId: 'EVENT_ID', + eventType: + 'providers/cloud.auth/eventTypes/user.beforeCreate:oidc.provider', + authType: 'USER', + resource: { + service: 'identitytoolkit.googleapis.com', + name: 'projects/project-id/tenants/TENANT_ID', + }, + timestamp: new Date(1000).toUTCString(), + additionalUserInfo: { + username: undefined, + providerId: 'oidc.provider', + profile: rawUserInfo, + isNewUser: true, + }, + credential: { + claims: undefined, + accessToken: 'ACCESS_TOKEN', + expirationTime: new Date(time + 3600 * 1000).toUTCString(), + idToken: 'ID_TOKEN', + providerId: 'oidc.provider', + refreshToken: 'REFRESH_TOKEN', + secret: 'OAUTH_TOKEN_SECRET', + signInMethod: 'oidc.provider', + }, + params: {}, + }; + + expect( + identity.parseAuthEventContext(decodedJwt, 'project-id', time) + ).to.deep.equal(context); + }); + }); + + describe('validateAuthResponse', () => { + it('should not throw on undefined request', () => { + expect(() => identity.validateAuthResponse('event', undefined)).to.not + .throw; + }); + + it('should throw an error if customClaims have a blocked claim', () => { + expect(() => + identity.validateAuthResponse('beforeCreate', { + customClaims: { acr: 'something' }, + }) + ).to.throw( + 'The customClaims claims "acr" are reserved and cannot be specified.' + ); + }); + + it('should throw an error if customClaims size is too big', () => { + const str = 'x'.repeat(1000); + + expect(() => + identity.validateAuthResponse('beforeCreate', { + customClaims: { idk: str }, + }) + ).to.throw('The customClaims payload should not exceed 1000 characters.'); + }); + + it('should throw an error if sessionClaims have a blocked claim', () => { + expect(() => + identity.validateAuthResponse('beforeSignIn', { + sessionClaims: { acr: 'something' }, + }) + ).to.throw( + 'The sessionClaims claims "acr" are reserved and cannot be specified.' + ); + }); + + it('should throw an error if sessionClaims size is too big', () => { + const str = 'x'.repeat(1000); + + expect(() => + identity.validateAuthResponse('beforeSignIn', { + sessionClaims: { idk: str }, + }) + ).to.throw( + 'The sessionClaims payload should not exceed 1000 characters.' + ); + }); + + it('should throw an error if the combined customClaims & sessionClaims size is too big', () => { + const str = 'x'.repeat(501); + + expect(() => + identity.validateAuthResponse('beforeSignIn', { + customClaims: { cc: str }, + sessionClaims: { sc: str }, + }) + ).to.throw( + 'The customClaims and sessionClaims payloads should not exceed 1000 characters combined.' + ); + }); + }); + + describe('getUpdateMask', () => { + it('should return empty string on undefined response', () => { + expect(identity.getUpdateMask()).to.eq(''); + }); + + it('should return the right claims on a response', () => { + const response = { + displayName: 'john', + disabled: false, + emailVerified: true, + photoURL: 'google.com', + customClaims: { + claim1: 'abc', + }, + sessionClaims: { + claim2: 'def', + }, + }; + + expect(identity.getUpdateMask(response)).to.eq( + 'displayName,disabled,emailVerified,photoURL,customClaims,sessionClaims' + ); + }); + }); +}); diff --git a/spec/common/providers/tasks.spec.ts b/spec/common/providers/tasks.spec.ts new file mode 100644 index 000000000..6811f0b2a --- /dev/null +++ b/spec/common/providers/tasks.spec.ts @@ -0,0 +1,262 @@ +// 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 firebase from 'firebase-admin'; + +import { apps as appsNamespace } from '../../../src/apps'; +import * as https from '../../../src/common/providers/https'; +import { + onDispatchHandler, + Request, + TaskContext, +} from '../../../src/common/providers/tasks'; +import * as mocks from '../../fixtures/credential/key.json'; +import { + generateIdToken, + generateUnsignedIdToken, + mockRequest, +} from '../../fixtures/mockrequest'; +import { checkAuthContext, runHandler } from '../../helper'; + +/** Represents a test case for a Task Queue Function */ +interface TaskTest { + // An http request, mocking a subset of https.Request. + httpRequest: any; + + // The expected format of the request passed to the handler. + expectedData: any; + + taskFunction?: (data: any, context: TaskContext) => void | Promise; + + taskFunction2?: (request: Request) => void | Promise; + + // The expected shape of the http response returned to the callable SDK. + expectedStatus: number; +} + +// Runs a TaskTest test. +export async function runTaskTest(test: TaskTest): Promise { + const taskQueueFunctionV1 = onDispatchHandler((data, context) => { + expect(data).to.deep.equal(test.expectedData); + if (test.taskFunction) { + test.taskFunction(data, context); + } + }); + + const responseV1 = await runHandler(taskQueueFunctionV1, test.httpRequest); + expect(responseV1.status).to.equal(test.expectedStatus); + + const taskQueueFunctionV2 = onDispatchHandler((request) => { + expect(request.data).to.deep.equal(test.expectedData); + if (test.taskFunction2) { + test.taskFunction2(request); + } + }); + + const responseV2 = await runHandler(taskQueueFunctionV2, test.httpRequest); + expect(responseV2.status).to.equal(test.expectedStatus); +} + +describe('onEnqueueHandler', () => { + let app: firebase.app.App; + + function mockEnqueueRequest( + data: unknown, + contentType: string = 'application/json', + context: { authorization?: string } = { authorization: 'Bearer abc' } + ): ReturnType { + return mockRequest(data, contentType, context); + } + + before(() => { + const credential = { + getAccessToken: () => { + return Promise.resolve({ + expires_in: 1000, + access_token: 'fake', + }); + }, + getCertificate: () => { + return { + projectId: 'aProjectId', + }; + }, + }; + app = firebase.initializeApp({ + projectId: 'aProjectId', + credential, + }); + Object.defineProperty(appsNamespace(), 'admin', { get: () => app }); + }); + + after(() => { + app.delete(); + delete appsNamespace.singleton; + }); + + it('should handle success', () => { + return runTaskTest({ + httpRequest: mockEnqueueRequest({ foo: 'bar' }), + expectedData: { foo: 'bar' }, + expectedStatus: 204, + }); + }); + + it('should reject bad method', () => { + const req = mockRequest(null); + req.method = 'GET'; + return runTaskTest({ + httpRequest: req, + expectedData: null, + expectedStatus: 400, + }); + }); + + it('should ignore charset', () => { + return runTaskTest({ + httpRequest: mockEnqueueRequest(null, 'application/json; charset=utf-8'), + expectedData: null, + expectedStatus: 204, + }); + }); + + it('should reject bad content type', () => { + return runTaskTest({ + httpRequest: mockEnqueueRequest(null, 'text/plain'), + expectedData: null, + expectedStatus: 400, + }); + }); + + it('should reject extra body fields', () => { + const req = mockEnqueueRequest(null); + req.body.extra = 'bad'; + return runTaskTest({ + httpRequest: req, + expectedData: null, + expectedStatus: 400, + }); + }); + + it('should handle unhandled error', () => { + return runTaskTest({ + httpRequest: mockEnqueueRequest(null), + expectedData: null, + taskFunction: (data, context) => { + throw new Error(`ceci n'est pas une error`); + }, + taskFunction2: (request) => { + throw new Error(`cece n'est pas une error`); + }, + expectedStatus: 500, + }); + }); + + it('should handle unknown error status', () => { + return runTaskTest({ + httpRequest: mockEnqueueRequest(null), + expectedData: null, + taskFunction: (data, context) => { + throw new https.HttpsError('THIS_IS_NOT_VALID' as any, 'nope'); + }, + taskFunction2: (request) => { + throw new https.HttpsError('THIS_IS_NOT_VALID' as any, 'nope'); + }, + expectedStatus: 500, + }); + }); + + it('should handle well-formed error', () => { + return runTaskTest({ + httpRequest: mockEnqueueRequest(null), + expectedData: null, + taskFunction: (data, context) => { + throw new https.HttpsError('not-found', 'i am error'); + }, + taskFunction2: (request) => { + throw new https.HttpsError('not-found', 'i am error'); + }, + expectedStatus: 404, + }); + }); + + it('should handle auth', async () => { + const projectId = appsNamespace().admin.options.projectId; + const idToken = generateIdToken(projectId); + await runTaskTest({ + httpRequest: mockEnqueueRequest(null, 'application/json', { + authorization: 'Bearer ' + idToken, + }), + expectedData: null, + taskFunction: (data, context) => { + checkAuthContext(context, projectId, mocks.user_id); + return null; + }, + taskFunction2: (request) => { + checkAuthContext(request, projectId, mocks.user_id); + return null; + }, + expectedStatus: 204, + }); + }); + + it('should accept unsigned auth too', async () => { + const projectId = appsNamespace().admin.options.projectId; + const idToken = generateUnsignedIdToken(projectId); + await runTaskTest({ + httpRequest: mockEnqueueRequest(null, 'application/json', { + authorization: 'Bearer ' + idToken, + }), + expectedData: null, + taskFunction: (data, context) => { + checkAuthContext(context, projectId, mocks.user_id); + return null; + }, + taskFunction2: (request) => { + checkAuthContext(request, projectId, mocks.user_id); + return null; + }, + expectedStatus: 204, + }); + }); + + it('should skip auth in emulated environment', async () => { + const restore = process.env.FUNCTIONS_EMULATOR; + process.env.FUNCTIONS_EMULATOR = 'true'; + + await runTaskTest({ + httpRequest: mockEnqueueRequest(null, 'application/json', {}), + expectedData: null, + taskFunction: (data, context) => { + expect(context.auth).to.be.undefined; + return null; + }, + taskFunction2: (request) => { + expect(request.auth).to.be.undefined; + }, + expectedStatus: 204, + }); + + process.env.FUNCTIONS_EMULATOR = restore; + }); +}); diff --git a/spec/config.spec.ts b/spec/config.spec.ts deleted file mode 100644 index 64963be4e..000000000 --- a/spec/config.spec.ts +++ /dev/null @@ -1,77 +0,0 @@ -// The MIT License (MIT) -// -// Copyright (c) 2017 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 mockRequire from 'mock-require'; -import { config, firebaseConfig } from '../src/config'; - -describe('config()', () => { - afterEach(() => { - mockRequire.stopAll(); - delete config.singleton; - delete process.env.FIREBASE_CONFIG; - delete process.env.CLOUD_RUNTIME_CONFIG; - }); - - it('loads config values from .runtimeconfig.json', () => { - mockRequire('../../../.runtimeconfig.json', { foo: 'bar', firebase: {} }); - const loaded = config(); - expect(loaded).to.not.have.property('firebase'); - expect(loaded).to.have.property('foo', 'bar'); - }); - - it('does not provide firebase config if .runtimeconfig.json not invalid', () => { - mockRequire('../../../.runtimeconfig.json', 'does-not-exist'); - expect(firebaseConfig()).to.be.null; - }); - - it('does not provide firebase config if .ruuntimeconfig.json has no firebase property', () => { - mockRequire('../../../.runtimeconfig.json', {}); - expect(firebaseConfig()).to.be.null; - }); - - it('loads Firebase configs from FIREBASE_CONFIG env variable', () => { - process.env.FIREBASE_CONFIG = JSON.stringify({ - databaseURL: 'foo@firebaseio.com', - }); - expect(firebaseConfig()).to.have.property( - 'databaseURL', - 'foo@firebaseio.com' - ); - }); - - it('accepts alternative locations for config file', () => { - process.env.CLOUD_RUNTIME_CONFIG = 'another.json'; - mockRequire('another.json', { foo: 'bar', firebase: {} }); - expect(firebaseConfig()).to.not.be.null; - expect(config()).to.have.property('foo', 'bar'); - }); - - it('accepts full JSON in env.CLOUD_RUNTIME_CONFIG', () => { - process.env.CLOUD_RUNTIME_CONFIG = JSON.stringify({ - foo: 'bar', - firebase: {}, - }); - expect(firebaseConfig()).to.not.be.null; - expect(config()).to.have.property('foo', 'bar'); - }); -}); diff --git a/spec/fixtures/credential/jwk.json b/spec/fixtures/credential/jwk.json new file mode 100644 index 000000000..cde44767e --- /dev/null +++ b/spec/fixtures/credential/jwk.json @@ -0,0 +1,14 @@ +{ + "p": "9cTVRzGXbDfhIMQW9gXtWveDW0u_Hvwnbjx7TRPgSfawZ0MjgKfSbnyHTDXiqM1ifcN_Nk58KJ-PG9eZ7V7_mfTUnPv2puDaecn-kgHobnTJMoBR9hpzyyMpyNJuMvX4kqE7Qh8iFMBK_-p8ICiW15gK5WykswIKfIOkUZc52XM", + "kty": "RSA", + "q": "pYdUNL244sCoc4XrONKlu787AiHrjFFLHdTjoFLbvxSpszXM8iSjoiFAM_MCF-uWks2iBVDw9wlG4MB7MfNf_fD0i1wqyknSOtfMxknU7D4eU_Sp6tI99Jl8f_GAzODK__k_0MpqqXgZmJbUvYuIXMiha-5lddz8ENa4pYpbr7M", + "d": "MpkXqjmjvzwfmlq3o0uZAXjeeAnBlYQSNaSllBWKepgPjg4FxFIt_BlXex1NeP0npNy_oCgaM_x7NiALaaPhwPK52lhYThc-xomCic1KDkyPecODTPXi4Iw94Q_gp442SYMWz2ZktS-2DgXc3599fGHkY80u0rHNSO8ptdk8SUDUIZ82ZQ3pBhClF_uY3c1jZLuqVgCwKksInZmNPnv3ge088wmQC26t0Ph5u1HU6lISgaqZ8ol23iNWJPf4UEi8Twy1a73nphQS-y1yK9UC3c5Knk-WI2TMmjlxqC02ZjKqnRDxElTj9kpodasPRHRV_KJI8rTaStgxd7peMFODzQ", + "e": "AQAB", + "use": "sig", + "kid": "a12KBE", + "qi": "aJCrZVWeOjxYmMBTTI7aJhxcvvfS3I5Q7wwN4Oyb1rJZ4fgGYjDohlzeZz_3fNantPAgcDbzJfa3XS327sHJGaAVqvDugZUgyHeLZGzXGs-_mlL72wzcfvTa1C9_lIndLNZJle5_mg3xJAqRKV0s7kymSdYt0wL5fDaqo5SDNqQ", + "dp": "haBk2hWzoApt5HPZjCDC4g_rosr3enBdPAm0fL8O1whC95JAjmYw-xPIOH6f42nwYDLYSv23chr3I4tBTRe2382HgGdav3dIMqnKOTbCWrQy5LtyVN4jEVLoGCGZ-ylT4t25K4Vj8WZwIN8saAvJoCUx33YHwrCcZQDqadZQhNM", + "alg": "RS256", + "dq": "j6NdeN7hnzMbehPNyGNSmhcZd4JDymGI03w3gpokQi4GDJM1IzKUJE7CTdIkEOnIod97Jy3TzCrqrIGa5f-RXuVG79-s6hkhKxq0gaTz9YT6AFShVjnWtXizRrskz6SJw5JgxCfCYwjq_TR1q313eTxIh0Y6GQsIWPxbApuLcG0", + "n": "nunJGpOcPvVsP3q-NLgf3H6OycPhnXUxywMR2_H_JJP7BUIDSsYcOGBTFe7OphHYfyb1Gs14yAER243swndpNbQkuDJhj9a9kK6dJZmPGmvCySk_E5URj6MimZg1MBbwhsVAbRp2uerESZuoRrfdTdV87E3pGyg6Irl0IXRjy5w9SsFjjIi7E-Qxpf3TcNNjfVRLj9V2bSzmS7hlsPKBhDon0tWecuNKoNNMiGI46mz_MSUa2y1lPV6Cqhf1su_TRd7N7u9eP7xWArr7wqtqHiFTZ3qp1xoA_dr_xv_Ao2kBtohZiAFLV-PQShprSN5fafztRZFkSEF0m2tUkvmoaQ" +} diff --git a/spec/fixtures/mockrequest.ts b/spec/fixtures/mockrequest.ts index 2139c71ce..a1f55c8e1 100644 --- a/spec/fixtures/mockrequest.ts +++ b/spec/fixtures/mockrequest.ts @@ -1,7 +1,9 @@ import * as jwt from 'jsonwebtoken'; +import * as jwkToPem from 'jwk-to-pem'; import * as _ from 'lodash'; import * as nock from 'nock'; -import * as mocks from '../fixtures/credential/key.json'; +import * as mockJWK from '../fixtures/credential/jwk.json'; +import * as mockKey from '../fixtures/credential/key.json'; // MockRequest mocks an https.Request. export class MockRequest { @@ -26,6 +28,7 @@ export function mockRequest( context: { authorization?: string; instanceIdToken?: string; + appCheckToken?: string; } = {} ) { const body: any = {}; @@ -37,6 +40,7 @@ export function mockRequest( 'content-type': contentType, authorization: context.authorization, 'firebase-instance-id-token': context.instanceIdToken, + 'x-firebase-appcheck': context.appCheckToken, origin: 'example.com', }; @@ -53,7 +57,7 @@ export const expectedResponseHeaders = { * verifying an id token. */ export function mockFetchPublicKeys(): nock.Scope { - const mockedResponse = { [mocks.key_id]: mocks.public_key }; + const mockedResponse = { [mockKey.key_id]: mockKey.public_key }; const headers = { 'cache-control': 'public, max-age=1, must-revalidate, no-transform', }; @@ -68,15 +72,84 @@ export function mockFetchPublicKeys(): nock.Scope { */ export function generateIdToken(projectId: string): string { const claims = {}; - const options = { + const options: jwt.SignOptions = { audience: projectId, expiresIn: 60 * 60, // 1 hour in seconds issuer: 'https://securetoken.google.com/' + projectId, - subject: mocks.user_id, + subject: mockKey.user_id, algorithm: 'RS256', header: { - kid: mocks.key_id, + kid: mockKey.key_id, + alg: 'RS256', }, }; - return jwt.sign(claims, mocks.private_key, options); + return jwt.sign(claims, mockKey.private_key, options); +} + +/** + * Generates a mocked, unsigned Firebase ID token. + */ +export function generateUnsignedIdToken(projectId: string): string { + return [ + { alg: 'RS256', typ: 'JWT' }, + { aud: projectId, sub: mockKey.user_id }, + 'Invalid signature', + ] + .map((str) => JSON.stringify(str)) + .map((str) => Buffer.from(str).toString('base64')) + .join('.'); +} + +/** + * Mocks out the http request used by the firebase-admin SDK to get the jwks for + * verifying an AppCheck token. + */ +export function mockFetchAppCheckPublicJwks(): nock.Scope { + const { kty, use, alg, kid, n, e } = mockJWK; + const mockedResponse = { + keys: [{ kty, use, alg, kid, n, e }], + }; + + return nock('https://firebaseappcheck.googleapis.com:443') + .get('/v1/jwks') + .reply(200, mockedResponse); +} + +/** + * Generates a mocked AppCheck token. + */ +export function generateAppCheckToken( + projectId: string, + appId: string +): string { + const claims = {}; + const options: jwt.SignOptions = { + audience: [`projects/${projectId}`], + expiresIn: 60 * 60, // 1 hour in seconds + issuer: `https://firebaseappcheck.googleapis.com/${projectId}`, + subject: appId, + header: { + alg: 'RS256', + typ: 'JWT', + kid: mockJWK.kid, + }, + }; + return jwt.sign(claims, jwkToPem(mockJWK, { private: true }), options); +} + +/** + * Generates a mocked, unsigned AppCheck token. + */ +export function generateUnsignedAppCheckToken( + projectId: string, + appId: string +): string { + return [ + { alg: 'RS256', typ: 'JWT' }, + { aud: [`projects/${projectId}`], sub: appId }, + 'Invalid signature', + ] + .map((component) => JSON.stringify(component)) + .map((str) => Buffer.from(str).toString('base64')) + .join('.'); } diff --git a/spec/fixtures/sources/commonjs-grouped/g1.js b/spec/fixtures/sources/commonjs-grouped/g1.js new file mode 100644 index 000000000..7250c863d --- /dev/null +++ b/spec/fixtures/sources/commonjs-grouped/g1.js @@ -0,0 +1,9 @@ +const functions = require("../../../../src/index"); + +exports.groupedhttp = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.groupedcallable = functions.https.onCall(() => { + return "PASS"; +}); diff --git a/spec/fixtures/sources/commonjs-grouped/index.js b/spec/fixtures/sources/commonjs-grouped/index.js new file mode 100644 index 000000000..aafcf8145 --- /dev/null +++ b/spec/fixtures/sources/commonjs-grouped/index.js @@ -0,0 +1,20 @@ +const functions = require("../../../../src/index"); +const functionsv2 = require("../../../../src/v2/index"); + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); + +exports.g1 = require("./g1"); diff --git a/spec/fixtures/sources/commonjs-grouped/package.json b/spec/fixtures/sources/commonjs-grouped/package.json new file mode 100644 index 000000000..1ec99f52f --- /dev/null +++ b/spec/fixtures/sources/commonjs-grouped/package.json @@ -0,0 +1,3 @@ +{ + "name": "commonjs-grouped" +} diff --git a/spec/fixtures/sources/commonjs-main/functions.js b/spec/fixtures/sources/commonjs-main/functions.js new file mode 100644 index 000000000..526599142 --- /dev/null +++ b/spec/fixtures/sources/commonjs-main/functions.js @@ -0,0 +1,18 @@ +const functions = require("../../../../src/index"); +const functionsv2 = require("../../../../src/v2/index"); + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/spec/fixtures/sources/commonjs-main/package.json b/spec/fixtures/sources/commonjs-main/package.json new file mode 100644 index 000000000..a781259f8 --- /dev/null +++ b/spec/fixtures/sources/commonjs-main/package.json @@ -0,0 +1,4 @@ +{ + "name": "commonjs-main", + "main": "functions.js" +} diff --git a/spec/fixtures/sources/commonjs-params/index.js b/spec/fixtures/sources/commonjs-params/index.js new file mode 100644 index 000000000..5c783dd18 --- /dev/null +++ b/spec/fixtures/sources/commonjs-params/index.js @@ -0,0 +1,29 @@ +const functions = require("../../../../src/index"); +const functionsv2 = require("../../../../src/v2/index"); +const params = require("../../../../src/v2/params"); + +params.defineString("BORING"); +params.defineString("FOO", {input: {text: {validationRegex:"\w+"}}}); +params.defineString("BAR", {default: "{{ params.FOO }}", label: "asdf"}); +params.defineString("BAZ", {input: {select: {options: [{value: "a"}, {value: "b"}]}}}); + +params.defineInt("AN_INT", {default: 22}); +params.defineInt("ANOTHER_INT", {input: {select: {options:[{label: "a", value: -2}, {"label": "b", value: 2}]}}}); + +params.defineSecret("SUPER_SECRET_FLAG") + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/spec/fixtures/sources/commonjs-params/package.json b/spec/fixtures/sources/commonjs-params/package.json new file mode 100644 index 000000000..91f8c11da --- /dev/null +++ b/spec/fixtures/sources/commonjs-params/package.json @@ -0,0 +1,3 @@ +{ + "name": "commonjs-params" +} diff --git a/spec/fixtures/sources/commonjs/index.js b/spec/fixtures/sources/commonjs/index.js new file mode 100644 index 000000000..526599142 --- /dev/null +++ b/spec/fixtures/sources/commonjs/index.js @@ -0,0 +1,18 @@ +const functions = require("../../../../src/index"); +const functionsv2 = require("../../../../src/v2/index"); + +exports.v1http = functions.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v1callable = functions.https.onCall(() => { + return "PASS"; +}); + +exports.v2http = functionsv2.https.onRequest((req, resp) => { + resp.status(200).send("PASS"); +}); + +exports.v2callable = functionsv2.https.onCall(() => { + return "PASS"; +}); diff --git a/spec/fixtures/sources/commonjs/package.json b/spec/fixtures/sources/commonjs/package.json new file mode 100644 index 000000000..30e1b1b27 --- /dev/null +++ b/spec/fixtures/sources/commonjs/package.json @@ -0,0 +1,3 @@ +{ + "name": "commonjs" +} diff --git a/spec/function-builder.spec.ts b/spec/function-builder.spec.ts deleted file mode 100644 index b0c4d4c28..000000000 --- a/spec/function-builder.spec.ts +++ /dev/null @@ -1,199 +0,0 @@ -// The MIT License (MIT) -// -// Copyright (c) 2017 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 functions from '../src/index'; - -describe('FunctionBuilder', () => { - before(() => { - process.env.GCLOUD_PROJECT = 'not-a-project'; - }); - - after(() => { - delete process.env.GCLOUD_PROJECT; - }); - - it('should allow supported region to be set', () => { - const fn = functions - .region('us-east1') - .auth.user() - .onCreate((user) => user); - - expect(fn.__trigger.regions).to.deep.equal(['us-east1']); - }); - - it('should allow multiple supported regions to be set', () => { - const fn = functions - .region('us-east1', 'us-central1') - .auth.user() - .onCreate((user) => user); - - expect(fn.__trigger.regions).to.deep.equal(['us-east1', 'us-central1']); - }); - - it('should allow all supported regions to be set', () => { - const fn = functions - .region( - 'us-central1', - 'us-east1', - 'us-east4', - 'europe-west1', - 'europe-west2', - 'asia-east2', - 'asia-northeast1' - ) - .auth.user() - .onCreate((user) => user); - - expect(fn.__trigger.regions).to.deep.equal([ - 'us-central1', - 'us-east1', - 'us-east4', - 'europe-west1', - 'europe-west2', - 'asia-east2', - 'asia-northeast1', - ]); - }); - - it('should allow valid runtime options to be set', () => { - const fn = functions - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .auth.user() - .onCreate((user) => user); - - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - it('should allow both supported region and valid runtime options to be set', () => { - const fn = functions - .region('europe-west2') - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .auth.user() - .onCreate((user) => user); - - expect(fn.__trigger.regions).to.deep.equal(['europe-west2']); - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - it('should allow both valid runtime options and supported region to be set in reverse order', () => { - const fn = functions - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .region('europe-west1') - .auth.user() - .onCreate((user) => user); - - expect(fn.__trigger.regions).to.deep.equal(['europe-west1']); - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - it('should fail if valid runtime options but unsupported region are set (reverse order)', () => { - expect(() => { - functions - .runWith({ timeoutSeconds: 90, memory: '256MB' }) - .region('unsupported' as any); - }).to.throw(Error, 'region'); - }); - - it('should fail if supported region but invalid runtime options are set (reverse order)', () => { - expect(() => { - functions - .region('asia-northeast1') - .runWith({ timeoutSeconds: 600, memory: '256MB' }); - }).to.throw(Error, 'TimeoutSeconds'); - }); - - it('should throw an error if user chooses an invalid memory allocation', () => { - expect(() => { - return functions.runWith({ - memory: 'unsupported', - } as any); - }).to.throw(Error, 'memory'); - - expect(() => { - return functions.region('us-east1').runWith({ - memory: 'unsupported', - } as any); - }).to.throw(Error, 'memory'); - }); - - it('should throw an error if user chooses an invalid timeoutSeconds', () => { - expect(() => { - return functions.runWith({ - timeoutSeconds: 1000000, - } as any); - }).to.throw(Error, 'TimeoutSeconds'); - - expect(() => { - return functions.region('asia-east2').runWith({ - timeoutSeconds: 1000000, - } as any); - }).to.throw(Error, 'TimeoutSeconds'); - }); - - it('should throw an error if user chooses an invalid region', () => { - expect(() => { - return functions.region('unsupported' as any); - }).to.throw(Error, 'region'); - - expect(() => { - return functions.region('unsupported' as any).runWith({ - timeoutSeconds: 500, - } as any); - }).to.throw(Error, 'region'); - - expect(() => { - return functions.region('unsupported' as any, 'us-east1'); - }).to.throw(Error, 'region'); - - expect(() => { - return functions.region('unsupported' as any, 'us-east1').runWith({ - timeoutSeconds: 500, - } as any); - }).to.throw(Error, 'region'); - }); - - it('should throw an error if user chooses no region when using .region()', () => { - expect(() => { - return functions.region(); - }).to.throw(Error, 'at least one region'); - - expect(() => { - return functions.region().runWith({ - timeoutSeconds: 500, - } as any); - }).to.throw(Error, 'at least one region'); - }); -}); diff --git a/spec/helper.ts b/spec/helper.ts new file mode 100644 index 000000000..a0cb57db3 --- /dev/null +++ b/spec/helper.ts @@ -0,0 +1,127 @@ +// 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 express from 'express'; + +import * as https from '../src/common/providers/https'; +import * as tasks from '../src/common/providers/tasks'; + +/** + * RunHandlerResult contains the data from an express.Response. + */ +export interface RunHandlerResult { + status: number; + headers: { [name: string]: string }; + body: any; +} + +/** + * Runs an express handler with a given request asynchronously and returns the + * data populated into the response. + */ +export function runHandler( + handler: express.Handler, + request: https.Request +): Promise { + return new Promise((resolve, reject) => { + // MockResponse mocks an express.Response. + // This class lives here so it can reference resolve and reject. + class MockResponse { + private statusCode = 0; + private headers: { [name: string]: string } = {}; + private callback: Function; + + public status(code: number) { + this.statusCode = code; + return this; + } + + // Headers are only set by the cors handler. + public setHeader(name: string, value: string) { + this.headers[name] = value; + } + + public getHeader(name: string): string { + return this.headers[name]; + } + + public send(body: any) { + resolve({ + status: this.statusCode, + headers: this.headers, + body, + }); + if (this.callback) { + this.callback(); + } + } + + public end() { + this.send(undefined); + } + + public on(event: string, callback: Function) { + if (event !== 'finish') { + throw new Error('MockResponse only implements the finish event'); + } + this.callback = callback; + } + } + + const response = new MockResponse(); + handler(request, response as any, () => undefined); + }); +} + +export function checkAuthContext( + context: https.CallableContext | https.CallableRequest | tasks.TaskContext, + projectId: string, + userId: string +) { + expect(context.auth).to.not.be.undefined; + expect(context.auth).to.not.be.null; + expect(context.auth.uid).to.equal(userId); + expect(context.auth.token.uid).to.equal(userId); + expect(context.auth.token.sub).to.equal(userId); + expect(context.auth.token.aud).to.equal(projectId); + + // TaskContext & TaskRequest don't have instanceIdToken + if ({}.hasOwnProperty.call(context, 'instanceIdToken')) { + expect((context as https.CallableContext).instanceIdToken).to.be.undefined; + } +} + +export function checkAppCheckContext( + context: https.CallableContext | https.CallableRequest, + projectId: string, + appId: string +) { + expect(context.app).to.not.be.undefined; + expect(context.app).to.not.be.null; + expect(context.app.appId).to.equal(appId); + expect(context.app.token.app_id).to.be.equal(appId); + expect(context.app.token.sub).to.be.equal(appId); + expect(context.app.token.aud).to.be.deep.equal([`projects/${projectId}`]); + expect(context.auth).to.be.undefined; + expect(context.instanceIdToken).to.be.undefined; +} diff --git a/spec/logger.spec.ts b/spec/logger.spec.ts new file mode 100644 index 000000000..c82497d31 --- /dev/null +++ b/spec/logger.spec.ts @@ -0,0 +1,175 @@ +import { expect } from 'chai'; + +import * as logger from '../src/logger'; + +const SUPPORTS_STRUCTURED_LOGS = + parseInt(process.versions?.node?.split('.')?.[0] || '8', 10) >= 10; + +describe(`logger (${ + SUPPORTS_STRUCTURED_LOGS ? 'structured' : 'unstructured' +})`, () => { + const stdoutWrite = process.stdout.write.bind(process.stdout); + const stderrWrite = process.stderr.write.bind(process.stderr); + let lastOut: string; + let lastErr: string; + + beforeEach(() => { + process.stdout.write = (msg: Buffer | string, cb?: any): boolean => { + lastOut = msg as string; + return stdoutWrite(msg, cb); + }; + process.stderr.write = (msg: Buffer | string, cb?: any): boolean => { + lastErr = msg as string; + return stderrWrite(msg, cb); + }; + }); + + afterEach(() => { + process.stdout.write = stdoutWrite; + process.stderr.write = stderrWrite; + }); + + function expectOutput(last: string, entry: any) { + if (SUPPORTS_STRUCTURED_LOGS) { + return expect(JSON.parse(last.trim())).to.deep.eq(entry); + } else { + // legacy logging is not structured, but do a sanity check + return expect(last).to.include(entry.message); + } + } + + function expectStdout(entry: any) { + return expectOutput(lastOut, entry); + } + + function expectStderr(entry: any) { + return expectOutput(lastErr, entry); + } + + describe('logging methods', () => { + it('should coalesce arguments into the message', () => { + logger.log('hello', { middle: 'obj' }, 'end message'); + expectStdout({ + severity: 'INFO', + message: "hello { middle: 'obj' } end message", + }); + }); + + it('should merge structured data from the last argument', () => { + logger.log('hello', 'world', { additional: 'context' }); + expectStdout({ + severity: 'INFO', + message: 'hello world', + additional: 'context', + }); + }); + + it('should not recognize null as a structured logging object', () => { + logger.log('hello', 'world', null); + expectStdout({ + severity: 'INFO', + message: 'hello world null', + }); + }); + }); + + describe('write', () => { + describe('structured logging', () => { + describe('write', () => { + it('should remove circular references', () => { + const circ: any = { b: 'foo' }; + circ.circ = circ; + + const entry: logger.LogEntry = { + severity: 'ERROR', + message: 'testing circular', + circ, + }; + logger.write(entry); + expectStderr({ + severity: 'ERROR', + message: 'testing circular', + circ: { b: 'foo', circ: '[Circular]' }, + }); + }); + + it('should remove circular references in arrays', () => { + const circ: any = { b: 'foo' }; + circ.circ = [circ]; + + const entry: logger.LogEntry = { + severity: 'ERROR', + message: 'testing circular', + circ, + }; + logger.write(entry); + expectStderr({ + severity: 'ERROR', + message: 'testing circular', + circ: { b: 'foo', circ: ['[Circular]'] }, + }); + }); + + it('should not break on objects that override toJSON', () => { + const obj: any = { a: new Date('August 26, 1994 12:24:00Z') }; + + const entry: logger.LogEntry = { + severity: 'ERROR', + message: 'testing toJSON', + obj, + }; + logger.write(entry); + expectStderr({ + severity: 'ERROR', + message: 'testing toJSON', + obj: { a: '1994-08-26T12:24:00.000Z' }, + }); + }); + + it('should not alter parameters that are logged', () => { + const circ: any = { b: 'foo' }; + circ.array = [circ]; + circ.object = circ; + const entry: logger.LogEntry = { + severity: 'ERROR', + message: 'testing circular', + circ, + }; + logger.write(entry); + + expect(circ.array[0].b).to.equal('foo'); + expect(circ.object.b).to.equal('foo'); + expect(circ.object.array[0].object.array[0].b).to.equal('foo'); + }); + + for (const severity of ['DEBUG', 'INFO', 'NOTICE']) { + it(`should output ${severity} severity to stdout`, () => { + const entry: logger.LogEntry = { + severity: severity as logger.LogSeverity, + message: 'test', + }; + logger.write(entry); + expectStdout(entry); + }); + } + + for (const severity of [ + 'WARNING', + 'ERROR', + 'CRITICAL', + 'ALERT', + 'EMERGENCY', + ]) { + it(`should output ${severity} severity to stderr`, () => { + const entry: logger.LogEntry = { + severity: severity as logger.LogSeverity, + message: 'test', + }; + logger.write(entry); + expectStderr(entry); + }); + } + }); + }); + }); +}); diff --git a/spec/providers/auth.spec.ts b/spec/providers/auth.spec.ts deleted file mode 100644 index 769bc03bf..000000000 --- a/spec/providers/auth.spec.ts +++ /dev/null @@ -1,243 +0,0 @@ -// The MIT License (MIT) -// -// Copyright (c) 2017 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 firebase from 'firebase-admin'; - -import { CloudFunction, Event, EventContext } from '../../src/cloud-functions'; -import * as functions from '../../src/index'; -import * as auth from '../../src/providers/auth'; - -describe('Auth Functions', () => { - const event: Event = { - data: { - metadata: { - creationTime: '2016-12-15T19:37:37.059Z', - lastSignInTime: '2017-01-01T00:00:00.000Z', - }, - }, - context: { - eventId: '70172329041928', - timestamp: '2018-04-09T07:56:12.975Z', - eventType: 'providers/firebase.auth/eventTypes/user.delete', - resource: { - service: 'firebaseauth.googleapis.com', - name: 'projects/project1', - }, - }, - }; - - describe('AuthBuilder', () => { - const handler = (user: firebase.auth.UserRecord) => { - return Promise.resolve(); - }; - - before(() => { - process.env.GCLOUD_PROJECT = 'project1'; - }); - - after(() => { - delete process.env.GCLOUD_PROJECT; - }); - - it('should allow both region and runtime options to be set', () => { - const fn = functions - .region('us-east1') - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .auth.user() - .onCreate(() => null); - - expect(fn.__trigger.regions).to.deep.equal(['us-east1']); - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - describe('#onCreate', () => { - it('should return a TriggerDefinition with appropriate values', () => { - const cloudFunction = auth.user().onCreate(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'providers/firebase.auth/eventTypes/user.create', - resource: 'projects/project1', - service: 'firebaseauth.googleapis.com', - }, - }); - }); - }); - - describe('#onDelete', () => { - it('should return a TriggerDefinition with appropriate values', () => { - const cloudFunction = auth.user().onDelete(handler); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'providers/firebase.auth/eventTypes/user.delete', - resource: 'projects/project1', - service: 'firebaseauth.googleapis.com', - }, - }); - }); - }); - - describe('#_dataConstructor', () => { - let cloudFunctionDelete: CloudFunction; - - before(() => { - cloudFunctionDelete = auth - .user() - .onDelete( - (data: firebase.auth.UserRecord, context: EventContext) => data - ); - }); - - it('should handle wire format as of v5.0.0 of firebase-admin', () => { - return cloudFunctionDelete(event.data, event.context).then( - (data: any) => { - expect(data.metadata.creationTime).to.equal( - '2016-12-15T19:37:37.059Z' - ); - expect(data.metadata.lastSignInTime).to.equal( - '2017-01-01T00:00:00.000Z' - ); - } - ); - }); - }); - }); - - describe('userRecordConstructor', () => { - it('will provide falsey values for fields that are not in raw wire data', () => { - const record = auth.userRecordConstructor({ uid: '123' }); - expect(record.toJSON()).to.deep.equal({ - uid: '123', - email: null, - emailVerified: false, - displayName: null, - photoURL: null, - phoneNumber: null, - disabled: false, - providerData: [], - customClaims: {}, - passwordSalt: null, - passwordHash: null, - tokensValidAfterTime: null, - metadata: { - creationTime: null, - lastSignInTime: null, - }, - }); - }); - - it('will not interfere with fields that are in raw wire data', () => { - const raw: any = { - uid: '123', - email: 'email@gmail.com', - emailVerified: true, - displayName: 'User', - photoURL: 'url', - phoneNumber: '1233332222', - disabled: true, - providerData: [], - customClaims: {}, - passwordSalt: 'abc', - passwordHash: 'def', - tokensValidAfterTime: '2027-02-02T23:01:19.797Z', - metadata: { - creationTime: '2017-02-02T23:06:26.124Z', - lastSignInTime: '2017-02-02T23:01:19.797Z', - }, - }; - const record = auth.userRecordConstructor(raw); - expect(record.toJSON()).to.deep.equal(raw); - }); - - it('will convert raw wire fields createdAt and lastSignedInAt to creationTime and lastSignInTime', () => { - const raw: any = { - uid: '123', - metadata: { - createdAt: '2017-02-02T23:06:26.124Z', - lastSignedInAt: '2017-02-02T23:01:19.797Z', - }, - }; - const record = auth.userRecordConstructor(raw); - expect(record.metadata).to.deep.equal({ - creationTime: '2017-02-02T23:06:26.124Z', - lastSignInTime: '2017-02-02T23:01:19.797Z', - }); - }); - }); - - describe('handler namespace', () => { - describe('#onCreate', () => { - it('should return an empty trigger', () => { - const cloudFunction = functions.handler.auth.user.onCreate(() => null); - expect(cloudFunction.__trigger).to.deep.equal({}); - }); - }); - - describe('#onDelete', () => { - const cloudFunctionDelete: CloudFunction< - firebase.auth.UserRecord - > = functions.handler.auth.user.onDelete( - (data: firebase.auth.UserRecord) => data - ); - - it('should return an empty trigger', () => { - const handler = (user: firebase.auth.UserRecord) => { - return Promise.resolve(); - }; - const cloudFunction = functions.handler.auth.user.onDelete(handler); - expect(cloudFunction.__trigger).to.deep.equal({}); - }); - - it('should handle wire format as of v5.0.0 of firebase-admin', () => { - return cloudFunctionDelete(event.data, event.context).then( - (data: any) => { - expect(data.metadata.creationTime).to.equal( - '2016-12-15T19:37:37.059Z' - ); - expect(data.metadata.lastSignInTime).to.equal( - '2017-01-01T00:00:00.000Z' - ); - } - ); - }); - }); - }); - - describe('process.env.GCLOUD_PROJECT not set', () => { - it('should not throw if __trigger is not accessed', () => { - expect(() => auth.user().onCreate(() => null)).to.not.throw(Error); - }); - - it('should throw when trigger is accessed', () => { - expect(() => auth.user().onCreate(() => null).__trigger).to.throw(Error); - }); - - it('should not throw when #run is called', () => { - const cf = auth.user().onCreate(() => null); - expect(cf.run).to.not.throw(Error); - }); - }); -}); diff --git a/spec/providers/crashlytics.spec.ts b/spec/providers/crashlytics.spec.ts deleted file mode 100644 index 59e745dfa..000000000 --- a/spec/providers/crashlytics.spec.ts +++ /dev/null @@ -1,157 +0,0 @@ -// The MIT License (MIT) -// -// Copyright (c) 2017 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 { apps as appsNamespace } from '../../src/apps'; -import * as functions from '../../src/index'; -import * as crashlytics from '../../src/providers/crashlytics'; - -describe('Crashlytics Functions', () => { - describe('Issue Builder', () => { - before(() => { - appsNamespace.init(); - process.env.GCLOUD_PROJECT = 'project1'; - }); - - after(() => { - delete appsNamespace.singleton; - delete process.env.GCLOUD_PROJECT; - }); - - it('should allow both region and runtime options to be set', () => { - const fn = functions - .region('us-east1') - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .crashlytics.issue() - .onNew((issue) => issue); - - expect(fn.__trigger.regions).to.deep.equal(['us-east1']); - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - describe('#onNew', () => { - it('should return a TriggerDefinition with appropriate values', () => { - const cloudFunction = crashlytics.issue().onNew((data) => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'providers/firebase.crashlytics/eventTypes/issue.new', - resource: 'projects/project1', - service: 'fabric.io', - }, - }); - }); - }); - - describe('#onRegressed', () => { - it('should return a TriggerDefinition with appropriate values', () => { - const cloudFunction = crashlytics.issue().onRegressed((data) => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: - 'providers/firebase.crashlytics/eventTypes/issue.regressed', - resource: 'projects/project1', - service: 'fabric.io', - }, - }); - }); - }); - - describe('#onVelocityAlert', () => { - it('should return a TriggerDefinition with appropriate values', () => { - const cloudFunction = crashlytics - .issue() - .onVelocityAlert((data) => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: - 'providers/firebase.crashlytics/eventTypes/issue.velocityAlert', - resource: 'projects/project1', - service: 'fabric.io', - }, - }); - }); - }); - - describe('HandlerBuilder', () => { - describe('#onNew', () => { - it('should return a CloudFunction with appropriate values', () => { - const cloudFunction = functions.handler.crashlytics.issue.onNew( - (testIssue) => { - return ( - testIssue.issueId + testIssue.issueTitle + testIssue.createTime - ); - } - ); - expect(cloudFunction.__trigger).to.deep.equal({}); - }); - }); - - describe('#onRegressed', () => { - it('should return a CloudFunction with appropriate values', () => { - const cloudFunction = functions.handler.crashlytics.issue.onRegressed( - (testIssue) => { - return ( - testIssue.issueId + testIssue.issueTitle + testIssue.createTime - ); - } - ); - expect(cloudFunction.__trigger).to.deep.equal({}); - }); - }); - - describe('#onVelocityAlert', () => { - it('should return a CloudFunction with appropriate values', () => { - const cloudFunction = functions.handler.crashlytics.issue.onVelocityAlert( - (testIssue) => { - return ( - testIssue.issueId + testIssue.issueTitle + testIssue.createTime - ); - } - ); - expect(cloudFunction.__trigger).to.deep.equal({}); - }); - }); - }); - }); - - describe('process.env.GCLOUD_PROJECT not set', () => { - it('should not throw if __trigger is not accessed', () => { - expect(() => crashlytics.issue().onNew(() => null)).to.not.throw(Error); - }); - - it('should throw if __trigger is accessed', () => { - expect(() => crashlytics.issue().onNew(() => null).__trigger).to.throw( - Error - ); - }); - - it('should not throw when #run is called', () => { - const cf = crashlytics.issue().onNew(() => null); - expect(cf.run).to.not.throw(Error); - }); - }); -}); diff --git a/spec/providers/https.spec.ts b/spec/providers/https.spec.ts deleted file mode 100644 index f858d5923..000000000 --- a/spec/providers/https.spec.ts +++ /dev/null @@ -1,635 +0,0 @@ -// The MIT License (MIT) -// -// Copyright (c) 2017 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 express from 'express'; -import * as firebase from 'firebase-admin'; -import * as _ from 'lodash'; -import { apps as appsNamespace } from '../../src/apps'; -import * as functions from '../../src/index'; -import * as https from '../../src/providers/https'; -import * as mocks from '../fixtures/credential/key.json'; -import { - expectedResponseHeaders, - generateIdToken, - mockFetchPublicKeys, - MockRequest, - mockRequest, -} from '../fixtures/mockrequest'; - -describe('CloudHttpsBuilder', () => { - describe('#onRequest', () => { - it('should return a Trigger with appropriate values', () => { - const result = https.onRequest((req, resp) => { - resp.send(200); - }); - expect(result.__trigger).to.deep.equal({ httpsTrigger: {} }); - }); - - it('should allow both region and runtime options to be set', () => { - const fn = functions - .region('us-east1') - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .https.onRequest(() => null); - - expect(fn.__trigger.regions).to.deep.equal(['us-east1']); - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - }); -}); - -describe('handler namespace', () => { - describe('#onRequest', () => { - it('should return an empty trigger', () => { - const result = functions.handler.https.onRequest((req, res) => { - res.send(200); - }); - expect(result.__trigger).to.deep.equal({}); - }); - }); - - describe('#onCall', () => { - it('should return an empty trigger', () => { - const result = functions.handler.https.onCall(() => null); - expect(result.__trigger).to.deep.equal({}); - }); - }); -}); - -/** - * RunHandlerResult contains the data from an express.Response. - */ -interface RunHandlerResult { - status: number; - headers: { [name: string]: string }; - body: any; -} - -/** - * A CallTest is a specification for a test of a callable function that - * simulates triggering the http endpoint, and checks that the request - * and response are properly converted to their http equivalents. - */ -interface CallTest { - // An http request, mocking a subset of https.Request. - httpRequest: any; - - // The expected format of the request passed to the handler. - expectedData: any; - - // The function to execute with the request. - callableFunction: (data: any, context: https.CallableContext) => any; - - // The expected shape of the http response returned to the callable SDK. - expectedHttpResponse: RunHandlerResult; -} - -/** - * Runs an express handler with a given request asynchronously and returns the - * data populated into the response. - */ -function runHandler( - handler: express.Handler, - request: https.Request -): Promise { - return new Promise((resolve, reject) => { - // MockResponse mocks an express.Response. - // This class lives here so it can reference resolve and reject. - class MockResponse { - private statusCode = 0; - private headers: { [name: string]: string } = {}; - - public status(code: number) { - this.statusCode = code; - return this; - } - - // Headers are only set by the cors handler. - public setHeader(name: string, value: string) { - this.headers[name] = value; - } - - public getHeader(name: string): string { - return this.headers[name]; - } - - public send(body: any) { - resolve({ - status: this.statusCode, - headers: this.headers, - body, - }); - } - - public end() { - this.send(undefined); - } - } - - const response = new MockResponse(); - handler(request, response as any, () => undefined); - }); -} - -// Runs a CallTest test. -async function runTest(test: CallTest): Promise { - const callableFunction = https.onCall((data, context) => { - expect(data).to.deep.equal(test.expectedData); - return test.callableFunction(data, context); - }); - - const response = await runHandler(callableFunction, test.httpRequest); - - expect(response.body).to.deep.equal(test.expectedHttpResponse.body); - expect(response.headers).to.deep.equal(test.expectedHttpResponse.headers); - expect(response.status).to.equal(test.expectedHttpResponse.status); -} - -describe('callable.FunctionBuilder', () => { - let app: firebase.app.App; - - before(() => { - const credential = { - getAccessToken: () => { - return Promise.resolve({ - expires_in: 1000, - access_token: 'fake', - }); - }, - getCertificate: () => { - return { - projectId: 'aProjectId', - }; - }, - }; - app = firebase.initializeApp({ - projectId: 'aProjectId', - credential, - }); - Object.defineProperty(appsNamespace(), 'admin', { get: () => app }); - }); - - after(() => { - app.delete(); - delete appsNamespace.singleton; - }); - - describe('#onCall', () => { - it('should return a Trigger with appropriate values', () => { - const result = https.onCall((data) => { - return 'response'; - }); - expect(result.__trigger).to.deep.equal({ - httpsTrigger: {}, - labels: { 'deployment-callable': 'true' }, - }); - }); - - it('should handle success', () => { - return runTest({ - httpRequest: mockRequest({ foo: 'bar' }), - expectedData: { foo: 'bar' }, - callableFunction: (data, context) => ({ baz: 'qux' }), - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: { baz: 'qux' } }, - }, - }); - }); - - it('should handle null data and return', () => { - return runTest({ - httpRequest: mockRequest(null), - expectedData: null, - callableFunction: (data, context) => null, - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: null }, - }, - }); - }); - - it('should handle void return', () => { - return runTest({ - httpRequest: mockRequest(null), - expectedData: null, - callableFunction: (data, context) => { - return; - }, - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: null }, - }, - }); - }); - - it('should reject bad method', () => { - const req = mockRequest(null); - req.method = 'GET'; - return runTest({ - httpRequest: req, - expectedData: null, - callableFunction: (data, context) => { - return; - }, - expectedHttpResponse: { - status: 400, - headers: expectedResponseHeaders, - body: { - error: { status: 'INVALID_ARGUMENT', message: 'Bad Request' }, - }, - }, - }); - }); - - it('should ignore charset', () => { - return runTest({ - httpRequest: mockRequest(null, 'application/json; charset=utf-8'), - expectedData: null, - callableFunction: (data, context) => { - return; - }, - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: null }, - }, - }); - }); - - it('should reject bad content type', () => { - return runTest({ - httpRequest: mockRequest(null, 'text/plain'), - expectedData: null, - callableFunction: (data, context) => { - return; - }, - expectedHttpResponse: { - status: 400, - headers: expectedResponseHeaders, - body: { - error: { status: 'INVALID_ARGUMENT', message: 'Bad Request' }, - }, - }, - }); - }); - - it('should reject extra body fields', () => { - const req = mockRequest(null); - req.body.extra = 'bad'; - return runTest({ - httpRequest: req, - expectedData: null, - callableFunction: (data, context) => { - return; - }, - expectedHttpResponse: { - status: 400, - headers: expectedResponseHeaders, - body: { - error: { status: 'INVALID_ARGUMENT', message: 'Bad Request' }, - }, - }, - }); - }); - - it('should handle unhandled error', () => { - return runTest({ - httpRequest: mockRequest(null), - expectedData: null, - callableFunction: (data, context) => { - throw new Error(`ceci n'est pas une error`); - }, - expectedHttpResponse: { - status: 500, - headers: expectedResponseHeaders, - body: { error: { status: 'INTERNAL', message: 'INTERNAL' } }, - }, - }); - }); - - it('should handle unknown error status', () => { - return runTest({ - httpRequest: mockRequest(null), - expectedData: null, - callableFunction: (data, context) => { - throw new https.HttpsError('THIS_IS_NOT_VALID' as any, 'nope'); - }, - expectedHttpResponse: { - status: 500, - headers: expectedResponseHeaders, - body: { error: { status: 'INTERNAL', message: 'INTERNAL' } }, - }, - }); - }); - - it('should handle well-formed error', () => { - return runTest({ - httpRequest: mockRequest(null), - expectedData: null, - callableFunction: (data, context) => { - throw new https.HttpsError('not-found', 'i am error'); - }, - expectedHttpResponse: { - status: 404, - headers: expectedResponseHeaders, - body: { error: { status: 'NOT_FOUND', message: 'i am error' } }, - }, - }); - }); - - it('should handle auth', async () => { - const mock = mockFetchPublicKeys(); - const projectId = appsNamespace().admin.options.projectId; - const idToken = generateIdToken(projectId); - await runTest({ - httpRequest: mockRequest(null, 'application/json', { - authorization: 'Bearer ' + idToken, - }), - expectedData: null, - callableFunction: (data, context) => { - expect(context.auth).to.not.be.undefined; - expect(context.auth).to.not.be.null; - expect(context.auth.uid).to.equal(mocks.user_id); - expect(context.auth.token.uid).to.equal(mocks.user_id); - expect(context.auth.token.sub).to.equal(mocks.user_id); - expect(context.auth.token.aud).to.equal(projectId); - expect(context.instanceIdToken).to.be.undefined; - return null; - }, - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: null }, - }, - }); - mock.done(); - }); - - it('should reject bad auth', async () => { - await runTest({ - httpRequest: mockRequest(null, 'application/json', { - authorization: 'Bearer FAKE', - }), - expectedData: null, - callableFunction: (data, context) => { - return; - }, - expectedHttpResponse: { - status: 401, - headers: expectedResponseHeaders, - body: { - error: { - status: 'UNAUTHENTICATED', - message: 'Unauthenticated', - }, - }, - }, - }); - }); - - it('should handle instance id', async () => { - await runTest({ - httpRequest: mockRequest(null, 'application/json', { - instanceIdToken: 'iid-token', - }), - expectedData: null, - callableFunction: (data, context) => { - expect(context.auth).to.be.undefined; - expect(context.instanceIdToken).to.equal('iid-token'); - return null; - }, - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: null }, - }, - }); - }); - - it('should expose raw request', async () => { - const mockReq = mockRequest(null, 'application/json', {}); - await runTest({ - httpRequest: mockReq, - expectedData: null, - callableFunction: (data, context) => { - expect(context.rawRequest).to.not.be.undefined; - expect(context.rawRequest).to.equal(mockReq); - return null; - }, - expectedHttpResponse: { - status: 200, - headers: expectedResponseHeaders, - body: { result: null }, - }, - }); - }); - - it('should allow both region and runtime options to be set', () => { - const fn = functions - .region('us-east1') - .runWith({ - timeoutSeconds: 90, - memory: '256MB', - }) - .https.onCall(() => null); - - expect(fn.__trigger.regions).to.deep.equal(['us-east1']); - expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); - expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - it('has a .run method', () => { - const cf = https.onCall((d, c) => { - return { data: d, context: c }; - }); - - const data = 'data'; - const context = { - instanceIdToken: 'token', - auth: { - uid: 'abc', - token: 'token', - }, - }; - expect(cf.run(data, context)).to.deep.equal({ data, context }); - }); - }); -}); - -describe('callable CORS', () => { - it('handles OPTIONS preflight', async () => { - const func = https.onCall((data, context) => { - throw new Error( - `This shouldn't have gotten called for an OPTIONS preflight.` - ); - }); - - const req = new MockRequest( - {}, - { - 'Access-Control-Request-Method': 'POST', - 'Access-Control-Request-Headers': 'origin', - Origin: 'example.com', - } - ); - req.method = 'OPTIONS'; - - const response = await runHandler(func, req as any); - - expect(response.status).to.equal(204); - expect(response.body).to.be.undefined; - expect(response.headers).to.deep.equal({ - 'Access-Control-Allow-Methods': 'POST', - 'Content-Length': '0', - Vary: 'Origin, Access-Control-Request-Headers', - }); - }); -}); - -describe('callable', () => { - it('encodes null', () => { - expect(https.encode(null)).to.be.null; - expect(https.encode(undefined)).to.be.null; - }); - - it('encodes int', () => { - expect(https.encode(1)).to.equal(1); - // Number isn't allowed in our own codebase, but we need to test it, in case - // a user passes one in. There's no reason not to support it, and we don't - // want to unintentionally encode them as {}. - // tslint:disable-next-line - expect(https.encode(new Number(1))).to.equal(1); - }); - - it('decodes int', () => { - expect(https.decode(1)).to.equal(1); - }); - - it('encodes long', () => { - expect(https.encode(-9223372036854775000)).to.equal(-9223372036854775000); - }); - - it('decodes long', () => { - expect( - https.decode({ - '@type': 'type.googleapis.com/google.protobuf.Int64Value', - value: '-9223372036854775000', - }) - ).to.equal(-9223372036854775000); - }); - - it('encodes unsigned long', () => { - expect(https.encode(9223372036854800000)).to.equal(9223372036854800000); - }); - - it('decodes unsigned long', () => { - expect( - https.decode({ - '@type': 'type.googleapis.com/google.protobuf.UInt64Value', - value: '9223372036854800000', - }) - ).to.equal(9223372036854800000); - }); - - it('encodes double', () => { - expect(https.encode(1.2)).to.equal(1.2); - }); - - it('decodes double', () => { - expect(https.decode(1.2)).to.equal(1.2); - }); - - it('encodes string', () => { - expect(https.encode('hello')).to.equal('hello'); - }); - - it('decodes string', () => { - expect(https.decode('hello')).to.equal('hello'); - }); - - it('encodes array', () => { - // TODO(klimt): Make this test more interesting once there's some type - // that needs encoding that can be created from JavaScript. - expect(https.encode([1, '2', [3, 4]])).to.deep.equal([1, '2', [3, 4]]); - }); - - it('decodes array', () => { - expect( - https.decode([ - 1, - '2', - [ - 3, - { - value: '1099511627776', - '@type': 'type.googleapis.com/google.protobuf.Int64Value', - }, - ], - ]) - ).to.deep.equal([1, '2', [3, 1099511627776]]); - }); - - it('encodes object', () => { - // TODO(klimt): Make this test more interesting once there's some type - // that needs encoding that can be created from JavaScript. - expect( - https.encode({ - foo: 1, - bar: 'hello', - baz: [1, 2, 3], - }) - ).to.deep.equal({ - foo: 1, - bar: 'hello', - baz: [1, 2, 3], - }); - }); - - it('decodes object', () => { - expect( - https.decode({ - foo: 1, - bar: 'hello', - baz: [ - 1, - 2, - { - value: '1099511627776', - '@type': 'type.googleapis.com/google.protobuf.Int64Value', - }, - ], - }) - ).to.deep.equal({ - foo: 1, - bar: 'hello', - baz: [1, 2, 1099511627776], - }); - }); -}); diff --git a/spec/runtime/loader.spec.ts b/spec/runtime/loader.spec.ts new file mode 100644 index 000000000..caae16d14 --- /dev/null +++ b/spec/runtime/loader.spec.ts @@ -0,0 +1,365 @@ +import { expect } from 'chai'; +import * as path from 'path'; + +import * as functions from '../../src/index'; +import * as loader from '../../src/runtime/loader'; +import { + ManifestEndpoint, + ManifestRequiredAPI, + ManifestStack, +} from '../../src/runtime/manifest'; +import { clearParams } from '../../src/v2/params'; + +describe('extractStack', () => { + const httpFn = functions.https.onRequest(() => {}); + const httpEndpoint = { + platform: 'gcfv1', + httpsTrigger: {}, + }; + + const callableFn = functions.https.onCall(() => {}); + const callableEndpoint = { + platform: 'gcfv1', + labels: {}, // TODO: empty labels? + callableTrigger: {}, + }; + + it('extracts stack from a simple module', () => { + const module = { + http: httpFn, + callable: callableFn, + }; + + const endpoints: Record = {}; + const requiredAPIs: ManifestRequiredAPI[] = []; + + loader.extractStack(module, endpoints, requiredAPIs); + + expect(endpoints).to.be.deep.equal({ + http: { entryPoint: 'http', ...httpEndpoint }, + callable: { entryPoint: 'callable', ...callableEndpoint }, + }); + + expect(requiredAPIs).to.be.empty; + }); + + it('extracts stack with required APIs', () => { + const module = { + taskq: functions.tasks.taskQueue().onDispatch(() => {}), + }; + + const endpoints: Record = {}; + const requiredAPIs: ManifestRequiredAPI[] = []; + + loader.extractStack(module, endpoints, requiredAPIs); + + expect(endpoints).to.be.deep.equal({ + taskq: { + entryPoint: 'taskq', + platform: 'gcfv1', + taskQueueTrigger: {}, + }, + }); + + expect(requiredAPIs).to.be.deep.equal([ + { + api: 'cloudtasks.googleapis.com', + reason: 'Needed for task queue functions', + }, + ]); + }); + + it('extracts stack from a module with group functions', () => { + const module = { + fn1: httpFn, + g1: { + fn2: httpFn, + }, + }; + + const endpoints: Record = {}; + const requiredAPIs: ManifestRequiredAPI[] = []; + + loader.extractStack(module, endpoints, requiredAPIs); + + expect(endpoints).to.be.deep.equal({ + fn1: { + entryPoint: 'fn1', + ...httpEndpoint, + }, + 'g1-fn2': { + entryPoint: 'g1.fn2', + ...httpEndpoint, + }, + }); + }); + + describe('with GCLOUD_PROJECT env var', () => { + const project = 'my-project'; + let prev; + + beforeEach(() => { + prev = process.env.GCLOUD_PROJECT; + process.env.GCLOUD_PROJECT = project; + }); + + afterEach(() => { + process.env.GCLOUD_PROJECT = prev; + clearParams(); + }); + + it('extracts stack from a simple module', () => { + const module = { + fn: functions.pubsub.topic('my-topic').onPublish(() => {}), + }; + + const endpoints: Record = {}; + const requiredAPIs: ManifestRequiredAPI[] = []; + + loader.extractStack(module, endpoints, requiredAPIs); + + expect(endpoints).to.be.deep.equal({ + fn: { + entryPoint: 'fn', + platform: 'gcfv1', + eventTrigger: { + eventType: 'google.pubsub.topic.publish', + eventFilters: { + resource: 'projects/my-project/topics/my-topic', + }, + retry: false, + }, + labels: {}, + }, + }); + }); + + it('extracts stack with required APIs', () => { + const module = { + scheduled: functions.pubsub.schedule('every 5 minutes').onRun(() => {}), + }; + + const endpoints: Record = {}; + const requiredAPIs: ManifestRequiredAPI[] = []; + + loader.extractStack(module, endpoints, requiredAPIs); + + expect(endpoints).to.be.deep.equal({ + scheduled: { + entryPoint: 'scheduled', + platform: 'gcfv1', + // TODO: This label should not exist? + labels: {}, + scheduleTrigger: { schedule: 'every 5 minutes' }, + }, + }); + + expect(requiredAPIs).to.be.deep.equal([ + { + api: 'cloudscheduler.googleapis.com', + reason: 'Needed for scheduled functions.', + }, + ]); + }); + }); +}); + +describe('mergedRequiredAPIs', () => { + it('leaves required APIs unchanged if nothing to merge', () => { + expect( + loader.mergeRequiredAPIs([ + { api: 'example1.com', reason: 'example1' }, + { api: 'example2.com', reason: 'example2' }, + ]) + ).to.be.deep.equal([ + { api: 'example1.com', reason: 'example1' }, + { api: 'example2.com', reason: 'example2' }, + ]); + }); + + it('merges reasons given overlapping required api', () => { + expect( + loader.mergeRequiredAPIs([ + { api: 'example1.com', reason: 'example1a' }, + { api: 'example1.com', reason: 'example1b' }, + { api: 'example2.com', reason: 'example2' }, + ]) + ).to.be.deep.equal([ + { api: 'example1.com', reason: 'example1a example1b' }, + { api: 'example2.com', reason: 'example2' }, + ]); + }); + + it('merges reasons given overlapping required api', () => { + expect( + loader.mergeRequiredAPIs([ + { api: 'example1.com', reason: 'example1a' }, + { api: 'example1.com', reason: 'example1b' }, + { api: 'example2.com', reason: 'example2' }, + ]) + ).to.be.deep.equal([ + { api: 'example1.com', reason: 'example1a example1b' }, + { api: 'example2.com', reason: 'example2' }, + ]); + }); + + it('does not repeat the same reason', () => { + expect( + loader.mergeRequiredAPIs([ + { api: 'example1.com', reason: 'example1a' }, + { api: 'example1.com', reason: 'example1a' }, + { api: 'example2.com', reason: 'example2' }, + ]) + ).to.be.deep.equal([ + { api: 'example1.com', reason: 'example1a' }, + { api: 'example2.com', reason: 'example2' }, + ]); + }); +}); + +describe('loadStack', () => { + const expected: ManifestStack = { + endpoints: { + v1http: { + platform: 'gcfv1', + entryPoint: 'v1http', + httpsTrigger: {}, + }, + v1callable: { + platform: 'gcfv1', + entryPoint: 'v1callable', + labels: {}, + callableTrigger: {}, + }, + v2http: { + platform: 'gcfv2', + entryPoint: 'v2http', + labels: {}, + httpsTrigger: {}, + }, + v2callable: { + platform: 'gcfv2', + entryPoint: 'v2callable', + labels: {}, + callableTrigger: {}, + }, + }, + requiredAPIs: [], + specVersion: 'v1alpha1', + }; + + interface Testcase { + name: string; + modulePath: string; + expected: ManifestStack; + } + function runTests(tc: Testcase) { + it('loads stack given relative path', async () => { + await expect(loader.loadStack(tc.modulePath)).to.eventually.deep.equal( + tc.expected + ); + }); + + it('loads stack given absolute path', async () => { + await expect( + loader.loadStack(path.join(process.cwd(), tc.modulePath)) + ).to.eventually.deep.equal(tc.expected); + }); + } + + let prev; + + beforeEach(() => { + // TODO: When __trigger annotation is removed and GCLOUD_PROJECT is not required at runtime, remove this. + prev = process.env.GCLOUD_PROJECT; + process.env.GCLOUD_PROJECT = 'test-project'; + }); + + afterEach(() => { + process.env.GCLOUD_PROJECT = prev; + }); + + describe('commonjs', () => { + const testcases: Testcase[] = [ + { + name: 'basic', + modulePath: './spec/fixtures/sources/commonjs', + expected, + }, + { + name: 'has main', + modulePath: './spec/fixtures/sources/commonjs-main', + expected, + }, + { + name: 'grouped', + modulePath: './spec/fixtures/sources/commonjs-grouped', + expected: { + ...expected, + endpoints: { + ...expected.endpoints, + 'g1-groupedhttp': { + platform: 'gcfv1', + entryPoint: 'g1.groupedhttp', + httpsTrigger: {}, + }, + 'g1-groupedcallable': { + platform: 'gcfv1', + entryPoint: 'g1.groupedcallable', + labels: {}, + callableTrigger: {}, + }, + }, + }, + }, + { + name: 'has params', + modulePath: './spec/fixtures/sources/commonjs-params', + expected: { + ...expected, + params: [ + { name: 'BORING', type: 'string' }, + { + name: 'FOO', + type: 'string', + input: { text: { validationRegex: 'w+' } }, + }, + { + name: 'BAR', + type: 'string', + default: '{{ params.FOO }}', + label: 'asdf', + }, + { + name: 'BAZ', + type: 'string', + input: { + select: { options: [{ value: 'a' }, { value: 'b' }] }, + }, + }, + { name: 'AN_INT', type: 'int', default: 22 }, + { + name: 'ANOTHER_INT', + type: 'int', + input: { + select: { + options: [ + { label: 'a', value: -2 }, + { label: 'b', value: 2 }, + ], + }, + }, + }, + { name: 'SUPER_SECRET_FLAG', type: 'secret' }, + ], + }, + }, + ]; + + for (const tc of testcases) { + describe(tc.name, () => { + runTests(tc); + }); + } + }); +}); diff --git a/spec/runtime/manifest.spec.ts b/spec/runtime/manifest.spec.ts new file mode 100644 index 000000000..382a0b41e --- /dev/null +++ b/spec/runtime/manifest.spec.ts @@ -0,0 +1,97 @@ +import { expect } from 'chai'; +import { ManifestStack, stackToWire } from '../../src/runtime/manifest'; +import * as params from '../../src/v2/params'; + +describe('stackToWire', () => { + afterEach(() => { + params.clearParams(); + }); + + it('converts stack with null values values', () => { + const stack: ManifestStack = { + endpoints: { + v2http: { + platform: 'gcfv2', + entryPoint: 'v2http', + labels: {}, + httpsTrigger: {}, + maxInstances: null, + }, + }, + requiredAPIs: [], + specVersion: 'v1alpha1', + }; + const expected = { + endpoints: { + v2http: { + platform: 'gcfv2', + entryPoint: 'v2http', + labels: {}, + httpsTrigger: {}, + maxInstances: null, + }, + }, + requiredAPIs: [], + specVersion: 'v1alpha1', + }; + expect(stackToWire(stack)).to.deep.equal(expected); + }); + + it('converts Expression types in endpoint options to CEL', () => { + const intParam = params.defineInt('foo', { default: 11 }); + const stringParam = params.defineString('bar', { + default: 'America/Los_Angeles', + }); + + const stack: ManifestStack = { + endpoints: { + v2http: { + platform: 'gcfv2', + entryPoint: 'v2http', + labels: {}, + httpsTrigger: {}, + concurrency: intParam, + maxInstances: intParam.equals(24).then(-1, 1), + }, + v2schedule: { + platform: 'gcfv2', + entryPoint: 'v2callable', + labels: {}, + scheduleTrigger: { + schedule: stringParam + .equals('America/Mexico_City') + .then('mexico', 'usa'), + timeZone: stringParam, + }, + }, + }, + requiredAPIs: [], + specVersion: 'v1alpha1', + }; + const expected = { + endpoints: { + v2http: { + platform: 'gcfv2', + entryPoint: 'v2http', + labels: {}, + httpsTrigger: {}, + concurrency: '{{ params.foo }}', + maxInstances: '{{ params.foo == 24 ? -1 : 1 }}', + }, + v2schedule: { + platform: 'gcfv2', + entryPoint: 'v2callable', + labels: {}, + scheduleTrigger: { + schedule: + '{{ params.bar == "America/Mexico_City" ? "mexico" : "usa" }}', + timeZone: '{{ params.bar }}', + }, + }, + }, + requiredAPIs: [], + specVersion: 'v1alpha1', + }; + expect(stackToWire(stack)).to.deep.equal(expected); + }); +}); diff --git a/spec/utilities/path-pattern.spec.ts b/spec/utilities/path-pattern.spec.ts new file mode 100644 index 000000000..8fe513284 --- /dev/null +++ b/spec/utilities/path-pattern.spec.ts @@ -0,0 +1,145 @@ +// 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 pathPattern from '../../src/utilities/path-pattern'; + +describe('path-pattern', () => { + describe('trimParam', () => { + it('should trim a capture param without equals', () => { + expect(pathPattern.trimParam('{something}')).to.equal('something'); + }); + + it('should trim a capture param with equals', () => { + expect(pathPattern.trimParam('{something=*}')).to.equal('something'); + }); + }); + + describe('extractMatches', () => { + it('should parse without multi segment', () => { + const pp = new pathPattern.PathPattern('{a}/something/else/{b}/end/{c}'); + + expect( + pp.extractMatches('match_a/something/else/match_b/end/match_c') + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + c: 'match_c', + }); + }); + + it('should parse multi segment with params after', () => { + const pp = new pathPattern.PathPattern( + 'something/**/else/{a}/hello/{b}/world' + ); + + expect( + pp.extractMatches('something/is/a/thing/else/nothing/hello/user/world') + ).to.deep.equal({ + a: 'nothing', + b: 'user', + }); + }); + + it('should parse multi segment param with params after', () => { + const pp = new pathPattern.PathPattern( + 'something/{path=**}/else/{a}/hello/{b}/world' + ); + + expect( + pp.extractMatches('something/is/a/thing/else/nothing/hello/user/world') + ).to.deep.equal({ + path: 'is/a/thing', + a: 'nothing', + b: 'user', + }); + }); + + it('should parse multi segment with params before', () => { + const pp = new pathPattern.PathPattern('{a}/something/{b}/**/end'); + + expect( + pp.extractMatches( + 'match_a/something/match_b/thing/else/nothing/hello/user/end' + ) + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + }); + }); + + it('should parse multi segment param with params before', () => { + const pp = new pathPattern.PathPattern('{a}/something/{b}/{path=**}/end'); + + expect( + pp.extractMatches( + 'match_a/something/match_b/thing/else/nothing/hello/user/end' + ) + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + path: 'thing/else/nothing/hello/user', + }); + }); + + it('should parse multi segment with params before and after', () => { + const pp = new pathPattern.PathPattern('{a}/something/**/{b}/end'); + + expect( + pp.extractMatches( + 'match_a/something/thing/else/nothing/hello/user/match_b/end' + ) + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + }); + }); + + it('should parse multi segment param with params before', () => { + const pp = new pathPattern.PathPattern('{a}/something/{path=**}/{b}/end'); + + expect( + pp.extractMatches( + 'match_a/something/thing/else/nothing/hello/user/match_b/end' + ) + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + path: 'thing/else/nothing/hello/user', + }); + }); + + // handle an instance param + it('should parse an instance', () => { + const pp = new pathPattern.PathPattern('{a}-something-{b}-else-{c}'); + + expect( + pp.extractMatches('match_a-something-match_b-else-match_c') + ).to.deep.equal({}); + + const anotherPP = new pathPattern.PathPattern('{a}'); + + expect(anotherPP.extractMatches('match_a')).to.deep.equal({ + a: 'match_a', + }); + }); + }); +}); diff --git a/spec/apps.spec.ts b/spec/v1/apps.spec.ts similarity index 98% rename from spec/apps.spec.ts rename to spec/v1/apps.spec.ts index 9fff98c71..89a1b3f5b 100644 --- a/spec/apps.spec.ts +++ b/spec/v1/apps.spec.ts @@ -21,7 +21,7 @@ // SOFTWARE. import { expect } from 'chai'; -import { apps as appsNamespace } from '../src/apps'; +import { apps as appsNamespace } from '../../src/apps'; import * as firebase from 'firebase-admin'; import * as _ from 'lodash'; diff --git a/spec/cloud-functions.spec.ts b/spec/v1/cloud-functions.spec.ts similarity index 71% rename from spec/cloud-functions.spec.ts rename to spec/v1/cloud-functions.spec.ts index ab17fbc3e..336c00282 100644 --- a/spec/cloud-functions.spec.ts +++ b/spec/v1/cloud-functions.spec.ts @@ -24,12 +24,11 @@ import { expect } from 'chai'; import * as _ from 'lodash'; import { - Change, Event, EventContext, makeCloudFunction, MakeCloudFunctionArgs, -} from '../src/cloud-functions'; +} from '../../src'; describe('makeCloudFunction', () => { const cloudFunctionArgs: MakeCloudFunctionArgs = { @@ -41,7 +40,7 @@ describe('makeCloudFunction', () => { legacyEventType: 'providers/provider/eventTypes/event', }; - it('should put a __trigger on the returned CloudFunction', () => { + it('should put a __trigger/__endpoint on the returned CloudFunction', () => { const cf = makeCloudFunction({ provider: 'mock.provider', eventType: 'mock.event', @@ -49,6 +48,7 @@ describe('makeCloudFunction', () => { triggerResource: () => 'resource', handler: () => null, }); + expect(cf.__trigger).to.deep.equal({ eventTrigger: { eventType: 'mock.provider.mock.event', @@ -56,10 +56,23 @@ describe('makeCloudFunction', () => { service: 'service', }, }); + + expect(cf.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventType: 'mock.provider.mock.event', + eventFilters: { + resource: 'resource', + }, + retry: false, + }, + labels: {}, + }); }); - it('should have legacy event type in __trigger if provided', () => { + it('should have legacy event type in __trigger/__endpoint if provided', () => { const cf = makeCloudFunction(cloudFunctionArgs); + expect(cf.__trigger).to.deep.equal({ eventTrigger: { eventType: 'providers/provider/eventTypes/event', @@ -67,6 +80,98 @@ describe('makeCloudFunction', () => { service: 'service', }, }); + + expect(cf.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventType: 'providers/provider/eventTypes/event', + eventFilters: { + resource: 'resource', + }, + retry: false, + }, + labels: {}, + }); + }); + + it('should include converted options in __endpoint', () => { + const cf = makeCloudFunction({ + provider: 'mock.provider', + eventType: 'mock.event', + service: 'service', + triggerResource: () => 'resource', + handler: () => null, + options: { + timeoutSeconds: 10, + regions: ['us-central1'], + memory: '128MB', + serviceAccount: 'foo@google.com', + secrets: ['MY_SECRET'], + }, + }); + + expect(cf.__endpoint).to.deep.equal({ + platform: 'gcfv1', + timeoutSeconds: 10, + region: ['us-central1'], + availableMemoryMb: 128, + serviceAccountEmail: 'foo@google.com', + eventTrigger: { + eventType: 'mock.provider.mock.event', + eventFilters: { + resource: 'resource', + }, + retry: false, + }, + secretEnvironmentVariables: [{ key: 'MY_SECRET' }], + labels: {}, + }); + }); + + it('should set retry given failure policy in __endpoint', () => { + const cf = makeCloudFunction({ + provider: 'mock.provider', + eventType: 'mock.event', + service: 'service', + triggerResource: () => 'resource', + handler: () => null, + options: { failurePolicy: { retry: {} } }, + }); + + expect(cf.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventType: 'mock.provider.mock.event', + eventFilters: { + resource: 'resource', + }, + retry: true, + }, + labels: {}, + }); + }); + + it('should setup a scheduleTrigger in __endpoint given a schedule', () => { + const schedule = { + schedule: 'every 5 minutes', + retryConfig: { retryCount: 3 }, + timeZone: 'America/New_York', + }; + const cf = makeCloudFunction({ + provider: 'mock.provider', + eventType: 'mock.event', + service: 'service', + triggerResource: () => 'resource', + handler: () => null, + options: { + schedule, + }, + }); + expect(cf.__endpoint).to.deep.equal({ + platform: 'gcfv1', + scheduleTrigger: schedule, + labels: {}, + }); }); it('should construct the right context for event', () => { @@ -248,99 +353,3 @@ describe('makeAuth and makeAuthType', () => { }); }); }); - -describe('Change', () => { - describe('applyFieldMask', () => { - const after = { - foo: 'bar', - num: 2, - obj: { - a: 1, - b: 2, - }, - }; - - it('should handle deleted values', () => { - const sparseBefore = { baz: 'qux' }; - const fieldMask = 'baz'; - expect( - Change.applyFieldMask(sparseBefore, after, fieldMask) - ).to.deep.equal({ - foo: 'bar', - num: 2, - obj: { - a: 1, - b: 2, - }, - baz: 'qux', - }); - }); - - it('should handle created values', () => { - const sparseBefore = {}; - const fieldMask = 'num,obj.a'; - expect( - Change.applyFieldMask(sparseBefore, after, fieldMask) - ).to.deep.equal({ - foo: 'bar', - obj: { - b: 2, - }, - }); - }); - - it('should handle mutated values', () => { - const sparseBefore = { - num: 3, - obj: { - a: 3, - }, - }; - const fieldMask = 'num,obj.a'; - expect( - Change.applyFieldMask(sparseBefore, after, fieldMask) - ).to.deep.equal({ - foo: 'bar', - num: 3, - obj: { - a: 3, - b: 2, - }, - }); - }); - }); - - describe('fromJSON', () => { - it('should create a Change object with a `before` and `after`', () => { - const created = Change.fromJSON({ - before: { foo: 'bar' }, - after: { foo: 'faz' }, - }); - expect(created instanceof Change).to.equal(true); - expect(created.before).to.deep.equal({ foo: 'bar' }); - expect(created.after).to.deep.equal({ foo: 'faz' }); - }); - - it('should apply the customizer function to `before` and `after`', () => { - function customizer(input: any) { - _.set(input, 'another', 'value'); - return input as T; - } - const created = Change.fromJSON( - { - before: { foo: 'bar' }, - after: { foo: 'faz' }, - }, - customizer - ); - expect(created.before).to.deep.equal({ - foo: 'bar', - another: 'value', - }); - expect(created.after).to.deep.equal({ - foo: 'faz', - another: 'value', - }); - }); - }); -}); diff --git a/spec/v1/config.spec.ts b/spec/v1/config.spec.ts new file mode 100644 index 000000000..8341d6a34 --- /dev/null +++ b/spec/v1/config.spec.ts @@ -0,0 +1,139 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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 fs from 'fs'; +import * as process from 'process'; +import Sinon = require('sinon'); + +import * as config from '../../src/config'; + +describe('config()', () => { + let readFileSync: Sinon.SinonStub; + let cwdStub: Sinon.SinonStub; + + before(() => { + readFileSync = Sinon.stub(fs, 'readFileSync'); + readFileSync.throws('Unexpected call'); + cwdStub = Sinon.stub(process, 'cwd'); + cwdStub.returns('/srv'); + }); + + after(() => { + Sinon.verifyAndRestore(); + }); + + afterEach(() => { + delete config.config.singleton; + (config as any).firebaseConfigCache = null; + delete process.env.FIREBASE_CONFIG; + delete process.env.CLOUD_RUNTIME_CONFIG; + delete process.env.K_CONFIGURATION; + }); + + it('will never load in GCFv2', () => { + const json = JSON.stringify({ + foo: 'bar', + firebase: {}, + }); + readFileSync + .withArgs('/srv/.runtimeconfig.json') + .returns(Buffer.from(json)); + + process.env.K_CONFIGURATION = 'my-service'; + expect(() => config.config()).to.throw( + Error, + /transition to using environment variables/ + ); + }); + + it('loads config values from .runtimeconfig.json', () => { + const json = JSON.stringify({ + foo: 'bar', + firebase: {}, + }); + readFileSync + .withArgs('/srv/.runtimeconfig.json') + .returns(Buffer.from(json)); + const loaded = config.config(); + expect(loaded).to.not.have.property('firebase'); + expect(loaded).to.have.property('foo', 'bar'); + }); + + it('does not provide firebase config if .runtimeconfig.json not invalid', () => { + readFileSync.withArgs('/srv/.runtimeconfig.json').returns('invalid JSON'); + expect(config.firebaseConfig()).to.be.null; + }); + + it('does not provide firebase config if .ruuntimeconfig.json has no firebase property', () => { + readFileSync + .withArgs('/srv/.runtimeconfig.json') + .returns(Buffer.from('{}')); + expect(config.firebaseConfig()).to.be.null; + }); + + it('loads Firebase configs from FIREBASE_CONFIG env variable', () => { + process.env.FIREBASE_CONFIG = JSON.stringify({ + databaseURL: 'foo@firebaseio.com', + }); + expect(config.firebaseConfig()).to.have.property( + 'databaseURL', + 'foo@firebaseio.com' + ); + }); + + it('loads Firebase configs from FIREBASE_CONFIG env variable pointing to a file', () => { + const oldEnv = process.env; + (process as any).env = { + ...oldEnv, + FIREBASE_CONFIG: '.firebaseconfig.json', + }; + try { + readFileSync.returns( + Buffer.from('{"databaseURL": "foo@firebaseio.com"}') + ); + expect(config.firebaseConfig()).to.have.property( + 'databaseURL', + 'foo@firebaseio.com' + ); + } finally { + (process as any).env = oldEnv; + } + }); + + it('accepts alternative locations for config file', () => { + process.env.CLOUD_RUNTIME_CONFIG = 'another.json'; + const json = JSON.stringify({ foo: 'bar', firebase: {} }); + readFileSync.withArgs('another.json').returns(Buffer.from(json)); + expect(config.firebaseConfig()).to.not.be.null; + expect(config.config()).to.have.property('foo', 'bar'); + }); + + it('accepts full JSON in env.CLOUD_RUNTIME_CONFIG', () => { + process.env.CLOUD_RUNTIME_CONFIG = JSON.stringify({ + foo: 'bar', + firebase: {}, + }); + expect(config.firebaseConfig()).to.not.be.null; + expect(config.config()).to.have.property('foo', 'bar'); + }); +}); diff --git a/spec/v1/function-builder.spec.ts b/spec/v1/function-builder.spec.ts new file mode 100644 index 000000000..8e01cd87a --- /dev/null +++ b/spec/v1/function-builder.spec.ts @@ -0,0 +1,516 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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 functions from '../../src'; + +describe('FunctionBuilder', () => { + before(() => { + process.env.GCLOUD_PROJECT = 'not-a-project'; + }); + + after(() => { + delete process.env.GCLOUD_PROJECT; + }); + + it('should allow supported region to be set', () => { + const fn = functions + .region('us-east1') + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.regions).to.deep.equal(['us-east1']); + }); + + it('should allow multiple supported regions to be set', () => { + const fn = functions + .region('us-east1', 'us-central1') + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.regions).to.deep.equal(['us-east1', 'us-central1']); + }); + + it('should allow all supported regions to be set', () => { + const fn = functions + .region( + 'us-central1', + 'us-east1', + 'us-east4', + 'europe-west1', + 'europe-west2', + 'europe-west3', + 'asia-east2', + 'asia-northeast1' + ) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.regions).to.deep.equal([ + 'us-central1', + 'us-east1', + 'us-east4', + 'europe-west1', + 'europe-west2', + 'europe-west3', + 'asia-east2', + 'asia-northeast1', + ]); + }); + + it('should allow valid runtime options to be set', () => { + const fn = functions + .runWith({ + timeoutSeconds: 90, + failurePolicy: { retry: {} }, + memory: '256MB', + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); + expect(fn.__trigger.timeout).to.deep.equal('90s'); + expect(fn.__trigger.failurePolicy).to.deep.equal({ retry: {} }); + }); + + it("should apply a default failure policy if it's aliased with `true`", () => { + const fn = functions + .runWith({ + failurePolicy: true, + memory: '256MB', + timeoutSeconds: 90, + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.failurePolicy).to.deep.equal({ retry: {} }); + }); + + it('should allow both supported region and valid runtime options to be set', () => { + const fn = functions + .region('europe-west2') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.regions).to.deep.equal(['europe-west2']); + expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); + expect(fn.__trigger.timeout).to.deep.equal('90s'); + }); + + it('should allow both valid runtime options and supported region to be set in reverse order', () => { + const fn = functions + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .region('europe-west1') + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.regions).to.deep.equal(['europe-west1']); + expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); + expect(fn.__trigger.timeout).to.deep.equal('90s'); + }); + + it('should fail if supported region but invalid runtime options are set (reverse order)', () => { + expect(() => { + functions + .region('asia-northeast1') + .runWith({ timeoutSeconds: 600, memory: '256MB' }); + }).to.throw(Error, 'TimeoutSeconds'); + }); + + it('should throw an error if user chooses a failurePolicy which is neither an object nor a boolean', () => { + expect(() => + functions.runWith({ + failurePolicy: (1234 as unknown) as functions.RuntimeOptions['failurePolicy'], + }) + ).to.throw(Error, 'failurePolicy must be a boolean or an object'); + }); + + it('should throw an error if user chooses a failurePolicy.retry which is not an object', () => { + expect(() => + functions.runWith({ + failurePolicy: { retry: (1234 as unknown) as object }, + }) + ).to.throw(Error, 'failurePolicy.retry'); + }); + + it('should throw an error if user chooses an invalid memory allocation', () => { + expect(() => { + return functions.runWith({ + memory: 'unsupported', + } as any); + }).to.throw(Error, 'memory'); + + expect(() => { + return functions.region('us-east1').runWith({ + memory: 'unsupported', + } as any); + }).to.throw(Error, 'memory'); + }); + + it('should throw an error if user chooses an invalid timeoutSeconds', () => { + expect(() => { + return functions.runWith({ + timeoutSeconds: 1000000, + } as any); + }).to.throw(Error, 'TimeoutSeconds'); + + expect(() => { + return functions.region('asia-east2').runWith({ + timeoutSeconds: 1000000, + } as any); + }).to.throw(Error, 'TimeoutSeconds'); + }); + + it('should throw an error if user chooses no region when using .region()', () => { + expect(() => { + return functions.region(); + }).to.throw(Error, 'at least one region'); + + expect(() => { + return functions.region().runWith({ + timeoutSeconds: 500, + } as any); + }).to.throw(Error, 'at least one region'); + }); + + it('should allow a ingressSettings to be set', () => { + const fn = functions + .runWith({ ingressSettings: 'ALLOW_INTERNAL_ONLY' }) + .https.onRequest(() => {}); + + expect(fn.__trigger.ingressSettings).to.equal('ALLOW_INTERNAL_ONLY'); + }); + + it('should throw an error if user chooses an invalid ingressSettings', () => { + expect(() => { + return functions.runWith({ + ingressSettings: 'INVALID_OPTION', + } as any); + }).to.throw( + Error, + `The only valid ingressSettings values are: ${functions.INGRESS_SETTINGS_OPTIONS.join( + ',' + )}` + ); + }); + + it('should allow a vpcConnector to be set', () => { + const fn = functions + .runWith({ + vpcConnector: 'test-connector', + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.vpcConnector).to.equal('test-connector'); + }); + + it('should allow a vpcConnectorEgressSettings to be set', () => { + const fn = functions + .runWith({ + vpcConnector: 'test-connector', + vpcConnectorEgressSettings: 'PRIVATE_RANGES_ONLY', + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.vpcConnectorEgressSettings).to.equal( + 'PRIVATE_RANGES_ONLY' + ); + }); + + it('should throw an error if user chooses an invalid vpcConnectorEgressSettings', () => { + expect(() => { + return functions.runWith({ + vpcConnector: 'test-connector', + vpcConnectorEgressSettings: 'INCORRECT_OPTION', + } as any); + }).to.throw( + Error, + `The only valid vpcConnectorEgressSettings values are: ${functions.VPC_EGRESS_SETTINGS_OPTIONS.join( + ',' + )}` + ); + }); + + it('should allow a serviceAccount to be set as-is', () => { + const serviceAccount = 'test-service-account@test.iam.gserviceaccount.com'; + const fn = functions + .runWith({ + serviceAccount, + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.serviceAccountEmail).to.equal(serviceAccount); + }); + + it('should allow a serviceAccount to be set with generated service account email', () => { + const serviceAccount = 'test-service-account@'; + const projectId = process.env.GCLOUD_PROJECT; + const fn = functions + .runWith({ + serviceAccount, + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.serviceAccountEmail).to.equal( + `test-service-account@${projectId}.iam.gserviceaccount.com` + ); + }); + + it('should set a null serviceAccountEmail if service account is set to `default`', () => { + const serviceAccount = 'default'; + const fn = functions + .runWith({ + serviceAccount, + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.serviceAccountEmail).to.be.null; + }); + + it('should throw an error if serviceAccount is set to an invalid value', () => { + const serviceAccount = 'test-service-account'; + expect(() => { + functions.runWith({ + serviceAccount, + }); + }).to.throw(); + }); + + it('should allow setting 4GB memory option', () => { + const fn = functions + .runWith({ + memory: '4GB', + }) + .region('europe-west1') + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.availableMemoryMb).to.deep.equal(4096); + }); + + it('should allow labels to be set', () => { + const fn = functions + .runWith({ + labels: { + 'valid-key': 'valid-value', + }, + }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.labels).to.deep.equal({ + 'valid-key': 'valid-value', + }); + }); + + it('should throw an error if more than 58 labels are set', () => { + const labels = {}; + for (let i = 0; i < 59; i++) { + labels[`label${i}`] = 'value'; + } + + expect(() => + functions.runWith({ + labels, + }) + ).to.throw(); + }); + + it('should throw an error if labels has a key that is too long', () => { + expect(() => + functions.runWith({ + labels: { + 'a-very-long-key-that-is-more-than-the-maximum-allowed-length-for-keys': + 'value', + }, + }) + ).to.throw(); + }); + + it('should throw an error if labels has key that is too short', () => { + expect(() => + functions.runWith({ + labels: { '': 'value' }, + }) + ).to.throw(); + }); + + it('should throw an error if labels has a value that is too long', () => { + expect(() => + functions.runWith({ + labels: { + key: + 'a-very-long-value-that-is-more-than-the-maximum-allowed-length-for-values', + }, + }) + ).to.throw(); + }); + + it('should throw an error if labels has a key that contains invalid characters', () => { + expect(() => + functions.runWith({ + labels: { + Key: 'value', + }, + }) + ).to.throw(); + + expect(() => + functions.runWith({ + labels: { + 'key ': 'value', + }, + }) + ).to.throw(); + + expect(() => + functions.runWith({ + labels: { + '1key': 'value', + }, + }) + ).to.throw(); + }); + + it('should throw an error if labels has a value that contains invalid characters', () => { + expect(() => + functions.runWith({ + labels: { + key: 'Value', + }, + }) + ).to.throw(); + + expect(() => + functions.runWith({ + labels: { + 'key ': 'va lue', + }, + }) + ).to.throw(); + }); + + it('should throw an error if a label key starts with a reserved namespace', () => { + expect(() => + functions.runWith({ + labels: { + 'firebase-foo': 'value', + }, + }) + ).to.throw(); + + expect(() => + functions.runWith({ + labels: { + 'deployment-bar': 'value', + }, + }) + ).to.throw(); + }); + + it('should throw an error if invoker is an empty string', () => { + expect(() => + functions.runWith({ + invoker: '', + }) + ).to.throw(); + }); + + it('should throw an error if invoker is an empty array', () => { + expect(() => + functions.runWith({ + invoker: [''], + }) + ).to.throw(); + }); + + it('should throw an error if invoker has an empty string', () => { + expect(() => + functions.runWith({ + invoker: ['service-account1', '', 'service-account2'], + }) + ).to.throw(); + }); + + it('should throw an error if public identifier is in the invoker array', () => { + expect(() => + functions.runWith({ + invoker: ['service-account1', 'public', 'service-account2'], + }) + ).to.throw(); + }); + + it('should throw an error if private identifier is in the invoker array', () => { + expect(() => + functions.runWith({ + invoker: ['service-account1', 'private', 'service-account2'], + }) + ).to.throw(); + }); + + it('should allow valid secret config expressed using short form', () => { + const secrets = ['API_KEY']; + const fn = functions + .runWith({ secrets }) + .auth.user() + .onCreate((user) => user); + + expect(fn.__trigger.secrets).to.deep.equal(secrets); + }); + + it('should throw error given secrets expressed with full resource name', () => { + expect(() => + functions.runWith({ + secrets: ['projects/my-project/secrets/API_KEY'], + }) + ).to.throw(); + }); + + it('should throw error given invalid secret config', () => { + expect(() => + functions.runWith({ + secrets: ['ABC/efg'], + }) + ).to.throw(); + }); + + it('should throw error given invalid secret with versions', () => { + expect(() => + functions.runWith({ + secrets: ['ABC@3'], + }) + ).to.throw(); + }); +}); diff --git a/spec/providers/analytics.spec.input.ts b/spec/v1/providers/analytics.spec.input.ts similarity index 98% rename from spec/providers/analytics.spec.input.ts rename to spec/v1/providers/analytics.spec.input.ts index bd9768b16..b4a6505f5 100644 --- a/spec/providers/analytics.spec.input.ts +++ b/spec/v1/providers/analytics.spec.input.ts @@ -21,7 +21,7 @@ // SOFTWARE. /* tslint:disable:max-line-length */ -import { AnalyticsEvent } from '../../src/providers/analytics'; +import { AnalyticsEvent } from '../../../src/providers/analytics'; // A payload, as it might arrive over the wire. Every possible field is filled out at least once. export const fullPayload = JSON.parse(`{ diff --git a/spec/providers/analytics.spec.ts b/spec/v1/providers/analytics.spec.ts similarity index 92% rename from spec/providers/analytics.spec.ts rename to spec/v1/providers/analytics.spec.ts index 4a5e84a0c..ead39554f 100644 --- a/spec/providers/analytics.spec.ts +++ b/spec/v1/providers/analytics.spec.ts @@ -22,9 +22,9 @@ import { expect } from 'chai'; -import { Event, EventContext } from '../../src/cloud-functions'; -import * as functions from '../../src/index'; -import * as analytics from '../../src/providers/analytics'; +import * as functions from '../../../src'; +import { Event, EventContext } from '../../../src/cloud-functions'; +import * as analytics from '../../../src/providers/analytics'; import * as analytics_spec_input from './analytics.spec.input'; describe('Analytics Functions', () => { @@ -50,10 +50,14 @@ describe('Analytics Functions', () => { expect(fn.__trigger.regions).to.deep.equal(['us-east1']); expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); expect(fn.__trigger.timeout).to.deep.equal('90s'); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); }); describe('#onLog', () => { - it('should return a TriggerDefinition with appropriate values', () => { + it('should return a trigger/endpoint with appropriate values', () => { const cloudFunction = analytics.event('first_open').onLog(() => null); expect(cloudFunction.__trigger).to.deep.equal({ @@ -64,6 +68,19 @@ describe('Analytics Functions', () => { service: 'app-measurement.com', }, }); + + expect(cloudFunction.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventFilters: { + resource: 'projects/project1/events/first_open', + }, + eventType: + 'providers/google.firebase.analytics/eventTypes/event.log', + retry: false, + }, + labels: {}, + }); }); }); @@ -305,11 +322,12 @@ describe('Analytics Functions', () => { describe('handler namespace', () => { describe('#onLog', () => { - it('should return an empty trigger', () => { + it('should return an empty trigger/endpoint', () => { const cloudFunction = functions.handler.analytics.event.onLog( () => null ); expect(cloudFunction.__trigger).to.deep.equal({}); + expect(cloudFunction.__endpoint).to.be.undefined; }); it('should handle an event with the appropriate fields', () => { diff --git a/spec/v1/providers/auth.spec.ts b/spec/v1/providers/auth.spec.ts new file mode 100644 index 000000000..91e394bc7 --- /dev/null +++ b/spec/v1/providers/auth.spec.ts @@ -0,0 +1,399 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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 { + CloudFunction, + Event, + EventContext, +} from '../../../src/cloud-functions'; +import { UserRecord } from '../../../src/common/providers/identity'; +import * as functions from '../../../src/index'; +import * as auth from '../../../src/providers/auth'; + +describe('Auth Functions', () => { + const event: Event = { + data: { + metadata: { + creationTime: '2016-12-15T19:37:37.059Z', + lastSignInTime: '2017-01-01T00:00:00.000Z', + }, + }, + context: { + eventId: '70172329041928', + timestamp: '2018-04-09T07:56:12.975Z', + eventType: 'providers/firebase.auth/eventTypes/user.delete', + resource: { + service: 'firebaseauth.googleapis.com', + name: 'projects/project1', + }, + }, + }; + + describe('AuthBuilder', () => { + function expectedTrigger(project: string, eventType: string) { + return { + eventTrigger: { + resource: `projects/${project}`, + eventType: `providers/firebase.auth/eventTypes/${eventType}`, + service: 'firebaseauth.googleapis.com', + }, + }; + } + + function expectedEndpoint(project: string, eventType: string) { + return { + platform: 'gcfv1', + eventTrigger: { + eventFilters: { + resource: `projects/${project}`, + }, + eventType: `providers/firebase.auth/eventTypes/${eventType}`, + retry: false, + }, + labels: {}, + }; + } + + const handler = (user: UserRecord) => { + return Promise.resolve(); + }; + + const project = 'project1'; + + before(() => { + process.env.GCLOUD_PROJECT = project; + }); + + after(() => { + delete process.env.GCLOUD_PROJECT; + }); + + it('should allow both region and runtime options to be set', () => { + const fn = functions + .region('us-east1') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .auth.user() + .onCreate(() => null); + + expect(fn.__trigger.regions).to.deep.equal(['us-east1']); + expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); + expect(fn.__trigger.timeout).to.deep.equal('90s'); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); + }); + + describe('#onCreate', () => { + it('should return a trigger/endpoint with appropriate values', () => { + const cloudFunction = auth.user().onCreate(() => null); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger(project, 'user.create') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(project, 'user.create') + ); + }); + }); + + describe('#onDelete', () => { + it('should return a trigger/endpoint with appropriate values', () => { + const cloudFunction = auth.user().onDelete(handler); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger(project, 'user.delete') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(project, 'user.delete') + ); + }); + }); + + describe('beforeCreate', () => { + it('should create the function without options', () => { + const fn = auth.user().beforeCreate((u, c) => Promise.resolve()); + + expect(fn.__trigger).to.deep.equal({ + labels: {}, + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeCreate', + options: { + accessToken: false, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv1', + labels: {}, + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeCreate', + options: { + accessToken: false, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should create the function with options', () => { + const fn = functions + .region('us-east1') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .auth.user({ + blockingOptions: { + accessToken: true, + refreshToken: false, + }, + }) + .beforeCreate((u, c) => Promise.resolve()); + + expect(fn.__trigger).to.deep.equal({ + labels: {}, + regions: ['us-east1'], + availableMemoryMb: 256, + timeout: '90s', + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeCreate', + options: { + accessToken: true, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv1', + labels: {}, + region: ['us-east1'], + availableMemoryMb: 256, + timeoutSeconds: 90, + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeCreate', + options: { + accessToken: true, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + }); + + describe('beforeSignIn', () => { + it('should create the function without options', () => { + const fn = auth.user().beforeSignIn((u, c) => Promise.resolve()); + + expect(fn.__trigger).to.deep.equal({ + labels: {}, + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeSignIn', + options: { + accessToken: false, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv1', + labels: {}, + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeSignIn', + options: { + accessToken: false, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should create the function with options', () => { + const fn = functions + .region('us-east1') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .auth.user({ + blockingOptions: { + accessToken: true, + refreshToken: false, + }, + }) + .beforeSignIn((u, c) => Promise.resolve()); + + expect(fn.__trigger).to.deep.equal({ + labels: {}, + regions: ['us-east1'], + availableMemoryMb: 256, + timeout: '90s', + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeSignIn', + options: { + accessToken: true, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv1', + labels: {}, + region: ['us-east1'], + availableMemoryMb: 256, + timeoutSeconds: 90, + blockingTrigger: { + eventType: 'providers/cloud.auth/eventTypes/user.beforeSignIn', + options: { + accessToken: true, + idToken: false, + refreshToken: false, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + }); + + describe('#_dataConstructor', () => { + let cloudFunctionDelete: CloudFunction; + + before(() => { + cloudFunctionDelete = auth + .user() + .onDelete((data: UserRecord, context: EventContext) => data); + }); + + it('should handle wire format as of v5.0.0 of firebase-admin', () => { + return cloudFunctionDelete(event.data, event.context).then( + (data: any) => { + expect(data.metadata.creationTime).to.equal( + '2016-12-15T19:37:37.059Z' + ); + expect(data.metadata.lastSignInTime).to.equal( + '2017-01-01T00:00:00.000Z' + ); + } + ); + }); + }); + }); + + describe('handler namespace', () => { + describe('#onCreate', () => { + it('should return an empty trigger', () => { + const cloudFunction = functions.handler.auth.user.onCreate(() => null); + expect(cloudFunction.__trigger).to.deep.equal({}); + }); + + it('should return an empty endpoint', () => { + const cloudFunction = functions.handler.auth.user.onCreate(() => null); + expect(cloudFunction.__endpoint).to.be.undefined; + }); + }); + + describe('#onDelete', () => { + const cloudFunctionDelete: CloudFunction = functions.handler.auth.user.onDelete( + (data: UserRecord) => data + ); + + it('should return an empty trigger', () => { + const cloudFunction = functions.handler.auth.user.onDelete(() => null); + expect(cloudFunction.__trigger).to.deep.equal({}); + }); + + it('should return an empty endpoint', () => { + const cloudFunction = functions.handler.auth.user.onDelete(() => null); + expect(cloudFunction.__endpoint).to.be.undefined; + }); + + it('should handle wire format as of v5.0.0 of firebase-admin', () => { + return cloudFunctionDelete(event.data, event.context).then( + (data: any) => { + expect(data.metadata.creationTime).to.equal( + '2016-12-15T19:37:37.059Z' + ); + expect(data.metadata.lastSignInTime).to.equal( + '2017-01-01T00:00:00.000Z' + ); + } + ); + }); + }); + }); + + describe('process.env.GCLOUD_PROJECT not set', () => { + it('should not throw if __trigger is not accessed', () => { + expect(() => auth.user().onCreate(() => null)).to.not.throw(Error); + }); + + it('should throw when trigger is accessed', () => { + expect(() => auth.user().onCreate(() => null).__trigger).to.throw(Error); + }); + + it('should throw when endpoint is accessed', () => { + expect(() => auth.user().onCreate(() => null).__endpoint).to.throw(Error); + }); + + it('should not throw when #run is called', () => { + const cf = auth.user().onCreate(() => null); + expect(cf.run).to.not.throw(Error); + }); + }); +}); diff --git a/spec/providers/database.spec.ts b/spec/v1/providers/database.spec.ts similarity index 70% rename from spec/providers/database.spec.ts rename to spec/v1/providers/database.spec.ts index 25293ac11..304c1d1fd 100644 --- a/spec/providers/database.spec.ts +++ b/spec/v1/providers/database.spec.ts @@ -21,24 +21,49 @@ // SOFTWARE. import { expect } from 'chai'; -import { apps as appsNamespace } from '../../src/apps'; -import * as functions from '../../src/index'; -import * as database from '../../src/providers/database'; -import { applyChange } from '../../src/utils'; +import { apps as appsNamespace } from '../../../src/apps'; +import * as config from '../../../src/config'; +import * as functions from '../../../src/index'; +import * as database from '../../../src/providers/database'; +import { applyChange } from '../../../src/utils'; describe('Database Functions', () => { describe('DatabaseBuilder', () => { // TODO add tests for building a data or change based on the type of operation + function expectedTrigger(resource: string, eventType: string) { + return { + eventTrigger: { + resource, + eventType: `providers/google.firebase.database/eventTypes/${eventType}`, + service: 'firebaseio.com', + }, + }; + } + + function expectedEndpoint(resource: string, eventType: string) { + return { + platform: 'gcfv1', + eventTrigger: { + eventFilters: { + resource, + }, + eventType: `providers/google.firebase.database/eventTypes/${eventType}`, + retry: false, + }, + labels: {}, + }; + } + before(() => { - process.env.FIREBASE_CONFIG = JSON.stringify({ - databaseURL: 'https://subdomain.firebaseio.com', - }); + (config as any).firebaseConfigCache = { + databaseURL: 'https://subdomain.apse.firebasedatabase.app', + }; appsNamespace.init(); }); after(() => { - delete process.env.FIREBASE_CONFIG; + (config as any).firebaseConfigCache = null; delete appsNamespace.singleton; }); @@ -55,21 +80,29 @@ describe('Database Functions', () => { expect(fn.__trigger.regions).to.deep.equal(['us-east1']); expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); expect(fn.__trigger.timeout).to.deep.equal('90s'); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); }); describe('#onWrite()', () => { - it('should return "ref.write" as the event type', () => { - const eventType = database.ref('foo').onWrite(() => null).__trigger - .eventTrigger.eventType; - expect(eventType).to.eq( - 'providers/google.firebase.database/eventTypes/ref.write' + it('should return a trigger/endpoint with appropriate values', () => { + const func = database.ref('foo').onWrite(() => null); + + expect(func.__trigger).to.deep.equal( + expectedTrigger( + 'projects/_/instances/subdomain/refs/foo', + 'ref.write' + ) ); - }); - it('should construct a proper resource path', () => { - const resource = database.ref('foo').onWrite(() => null).__trigger - .eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/subdomain/refs/foo'); + expect(func.__endpoint).to.deep.equal( + expectedEndpoint( + 'projects/_/instances/subdomain/refs/foo', + 'ref.write' + ) + ); }); it('should let developers choose a database instance', () => { @@ -77,8 +110,14 @@ describe('Database Functions', () => { .instance('custom') .ref('foo') .onWrite(() => null); - const resource = func.__trigger.eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/custom/refs/foo'); + + expect(func.__trigger).to.deep.equal( + expectedTrigger('projects/_/instances/custom/refs/foo', 'ref.write') + ); + + expect(func.__endpoint).to.deep.equal( + expectedEndpoint('projects/_/instances/custom/refs/foo', 'ref.write') + ); }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -106,18 +145,22 @@ describe('Database Functions', () => { }); describe('#onCreate()', () => { - it('should return "ref.create" as the event type', () => { - const eventType = database.ref('foo').onCreate(() => null).__trigger - .eventTrigger.eventType; - expect(eventType).to.eq( - 'providers/google.firebase.database/eventTypes/ref.create' + it('should return a trigger/endpoint with appropriate values', () => { + const func = database.ref('foo').onCreate(() => null); + + expect(func.__trigger).to.deep.equal( + expectedTrigger( + 'projects/_/instances/subdomain/refs/foo', + 'ref.create' + ) ); - }); - it('should construct a proper resource path', () => { - const resource = database.ref('foo').onCreate(() => null).__trigger - .eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/subdomain/refs/foo'); + expect(func.__endpoint).to.deep.equal( + expectedEndpoint( + 'projects/_/instances/subdomain/refs/foo', + 'ref.create' + ) + ); }); it('should let developers choose a database instance', () => { @@ -125,8 +168,14 @@ describe('Database Functions', () => { .instance('custom') .ref('foo') .onCreate(() => null); - const resource = func.__trigger.eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/custom/refs/foo'); + + expect(func.__trigger).to.deep.equal( + expectedTrigger('projects/_/instances/custom/refs/foo', 'ref.create') + ); + + expect(func.__endpoint).to.deep.equal( + expectedEndpoint('projects/_/instances/custom/refs/foo', 'ref.create') + ); }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -155,18 +204,22 @@ describe('Database Functions', () => { }); describe('#onUpdate()', () => { - it('should return "ref.update" as the event type', () => { - const eventType = database.ref('foo').onUpdate(() => null).__trigger - .eventTrigger.eventType; - expect(eventType).to.eq( - 'providers/google.firebase.database/eventTypes/ref.update' + it('should return a trigger/endpoint with appropriate values', () => { + const func = database.ref('foo').onUpdate(() => null); + + expect(func.__trigger).to.deep.equal( + expectedTrigger( + 'projects/_/instances/subdomain/refs/foo', + 'ref.update' + ) ); - }); - it('should construct a proper resource path', () => { - const resource = database.ref('foo').onUpdate(() => null).__trigger - .eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/subdomain/refs/foo'); + expect(func.__endpoint).to.deep.equal( + expectedEndpoint( + 'projects/_/instances/subdomain/refs/foo', + 'ref.update' + ) + ); }); it('should let developers choose a database instance', () => { @@ -174,8 +227,14 @@ describe('Database Functions', () => { .instance('custom') .ref('foo') .onUpdate(() => null); - const resource = func.__trigger.eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/custom/refs/foo'); + + expect(func.__trigger).to.deep.equal( + expectedTrigger('projects/_/instances/custom/refs/foo', 'ref.update') + ); + + expect(func.__endpoint).to.deep.equal( + expectedEndpoint('projects/_/instances/custom/refs/foo', 'ref.update') + ); }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -204,18 +263,22 @@ describe('Database Functions', () => { }); describe('#onDelete()', () => { - it('should return "ref.delete" as the event type', () => { - const eventType = database.ref('foo').onDelete(() => null).__trigger - .eventTrigger.eventType; - expect(eventType).to.eq( - 'providers/google.firebase.database/eventTypes/ref.delete' + it('should return a trigger/endpoint with appropriate values', () => { + const func = database.ref('foo').onDelete(() => null); + + expect(func.__trigger).to.deep.equal( + expectedTrigger( + 'projects/_/instances/subdomain/refs/foo', + 'ref.delete' + ) ); - }); - it('should construct a proper resource path', () => { - const resource = database.ref('foo').onDelete(() => null).__trigger - .eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/subdomain/refs/foo'); + expect(func.__endpoint).to.deep.equal( + expectedEndpoint( + 'projects/_/instances/subdomain/refs/foo', + 'ref.delete' + ) + ); }); it('should let developers choose a database instance', () => { @@ -223,8 +286,14 @@ describe('Database Functions', () => { .instance('custom') .ref('foo') .onDelete(() => null); - const resource = func.__trigger.eventTrigger.resource; - expect(resource).to.eq('projects/_/instances/custom/refs/foo'); + + expect(func.__trigger).to.deep.equal( + expectedTrigger('projects/_/instances/custom/refs/foo', 'ref.delete') + ); + + expect(func.__endpoint).to.deep.equal( + expectedEndpoint('projects/_/instances/custom/refs/foo', 'ref.delete') + ); }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -258,6 +327,7 @@ describe('Database Functions', () => { it('correctly sets trigger to {}', () => { const cf = functions.handler.database.ref.onWrite(() => null); expect(cf.__trigger).to.deep.equal({}); + expect(cf.__endpoint).to.be.undefined; }); it('should be able to use the instance entry point', () => { @@ -265,6 +335,7 @@ describe('Database Functions', () => { () => null ); expect(func.__trigger).to.deep.equal({}); + expect(func.__endpoint).to.be.undefined; }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -295,7 +366,8 @@ describe('Database Functions', () => { describe('#onCreate()', () => { it('correctly sets trigger to {}', () => { const cf = functions.handler.database.ref.onCreate(() => null); - return expect(cf.__trigger).to.deep.equal({}); + expect(cf.__trigger).to.deep.equal({}); + expect(cf.__endpoint).to.be.undefined; }); it('should be able to use the instance entry point', () => { @@ -303,6 +375,7 @@ describe('Database Functions', () => { () => null ); expect(func.__trigger).to.deep.equal({}); + expect(func.__endpoint).to.be.undefined; }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -332,7 +405,8 @@ describe('Database Functions', () => { describe('#onUpdate()', () => { it('correctly sets trigger to {}', () => { const cf = functions.handler.database.ref.onUpdate(() => null); - return expect(cf.__trigger).to.deep.equal({}); + expect(cf.__trigger).to.deep.equal({}); + expect(cf.__endpoint).to.be.undefined; }); it('should be able to use the instance entry point', () => { @@ -340,6 +414,7 @@ describe('Database Functions', () => { () => null ); expect(func.__trigger).to.deep.equal({}); + expect(func.__endpoint).to.be.undefined; }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -369,7 +444,8 @@ describe('Database Functions', () => { describe('#onDelete()', () => { it('correctly sets trigger to {}', () => { const cf = functions.handler.database.ref.onDelete(() => null); - return expect(cf.__trigger).to.deep.equal({}); + expect(cf.__trigger).to.deep.equal({}); + expect(cf.__endpoint).to.be.undefined; }); it('should be able to use the instance entry point', () => { @@ -377,6 +453,7 @@ describe('Database Functions', () => { () => null ); expect(func.__trigger).to.deep.equal({}); + expect(func.__endpoint).to.be.undefined; }); it('should return a handler that emits events with a proper DataSnapshot', () => { @@ -418,38 +495,93 @@ describe('Database Functions', () => { ).to.throw(Error); }); + it('should throw when endpoint is accessed', () => { + expect( + () => database.ref('/path').onWrite(() => null).__endpoint + ).to.throw(Error); + }); + it('should not throw when #run is called', () => { const cf = database.ref('/path').onWrite(() => null); expect(cf.run).to.not.throw(Error); }); }); - describe('resourceToInstanceAndPath', () => { - it('should return the correct instance and path strings', () => { - const [instance, path] = database.resourceToInstanceAndPath( - 'projects/_/instances/foo/refs/bar' + describe('extractInstanceAndPath', () => { + it('should return correct us-central prod instance and path strings if domain is missing', () => { + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/bar', + undefined ); expect(instance).to.equal('https://foo.firebaseio.com'); expect(path).to.equal('/bar'); }); + it('should return the correct staging instance and path strings if domain is present', () => { + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/bar', + 'firebaseio-staging.com' + ); + expect(instance).to.equal('https://foo.firebaseio-staging.com'); + expect(path).to.equal('/bar'); + }); + + it('should return the correct instance and path strings if root path is /refs', () => { + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/refs' + ); + expect(instance).to.equal('https://foo.firebaseio.com'); + expect(path).to.equal('/refs'); + }); + + it('should return the correct instance and path strings if a child path contain /refs', () => { + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/root/refs' + ); + expect(instance).to.equal('https://foo.firebaseio.com'); + expect(path).to.equal('/root/refs'); + }); + + it('should return the correct multi-region instance and path strings if domain is present', () => { + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/bar', + 'euw1.firebasedatabase.app' + ); + expect(instance).to.equal('https://foo.euw1.firebasedatabase.app'); + expect(path).to.equal('/bar'); + }); + it('should throw an error if the given instance name contains anything except alphanumerics and dashes', () => { expect(() => { - return database.resourceToInstanceAndPath( - 'projects/_/instances/a.bad.name/refs/bar' + return database.extractInstanceAndPath( + 'projects/_/instances/a.bad.name/refs/bar', + undefined ); }).to.throw(Error); expect(() => { - return database.resourceToInstanceAndPath( - 'projects/_/instances/a_different_bad_name/refs/bar' + return database.extractInstanceAndPath( + 'projects/_/instances/a_different_bad_name/refs/bar', + undefined ); }).to.throw(Error); expect(() => { - return database.resourceToInstanceAndPath( - 'projects/_/instances/BAD!!!!/refs/bar' + return database.extractInstanceAndPath( + 'projects/_/instances/BAD!!!!/refs/bar', + undefined ); }).to.throw(Error); }); + + it('should use the emulator host when present', () => { + process.env.FIREBASE_DATABASE_EMULATOR_HOST = 'localhost:1234'; + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/bar', + 'firebaseio-staging.com' + ); + expect(instance).to.equal('http://localhost:1234/?ns=foo'); + expect(path).to.equal('/bar'); + delete process.env.FIREBASE_DATABASE_EMULATOR_HOST; + }); }); describe('DataSnapshot', () => { @@ -457,8 +589,9 @@ describe('Database Functions', () => { const apps = new appsNamespace.Apps(); const populate = (data: any) => { - const [instance, path] = database.resourceToInstanceAndPath( - 'projects/_/instances/other-subdomain/refs/foo' + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/other-subdomain/refs/foo', + 'firebaseio-staging.com' ); subject = new database.DataSnapshot(data, path, apps.admin, instance); }; @@ -467,7 +600,7 @@ describe('Database Functions', () => { it('should return a ref for correct instance, not the default instance', () => { populate({}); expect(subject.ref.toJSON()).to.equal( - 'https://other-subdomain.firebaseio.com/foo' + 'https://other-subdomain.firebaseio-staging.com/foo' ); }); }); @@ -648,8 +781,9 @@ describe('Database Functions', () => { }); it('should return null for the root', () => { - const [instance, path] = database.resourceToInstanceAndPath( - 'projects/_/instances/foo/refs/' + const [instance, path] = database.extractInstanceAndPath( + 'projects/_/instances/foo/refs/', + undefined ); const snapshot = new database.DataSnapshot( null, diff --git a/spec/providers/firestore.spec.ts b/spec/v1/providers/firestore.spec.ts similarity index 91% rename from spec/providers/firestore.spec.ts rename to spec/v1/providers/firestore.spec.ts index 42cdf97f7..3f9f07fbe 100644 --- a/spec/providers/firestore.spec.ts +++ b/spec/v1/providers/firestore.spec.ts @@ -24,8 +24,8 @@ import { expect } from 'chai'; import * as admin from 'firebase-admin'; import * as _ from 'lodash'; -import * as functions from '../../src/index'; -import * as firestore from '../../src/providers/firestore'; +import * as functions from '../../../src/index'; +import * as firestore from '../../../src/providers/firestore'; describe('Firestore Functions', () => { function constructValue(fields: any) { @@ -103,6 +103,20 @@ describe('Firestore Functions', () => { }; } + function expectedEndpoint(resource: string, eventType: string) { + return { + platform: 'gcfv1', + eventTrigger: { + eventFilters: { + resource, + }, + eventType: `providers/cloud.firestore/eventTypes/${eventType}`, + retry: false, + }, + labels: {}, + }; + } + before(() => { process.env.GCLOUD_PROJECT = 'project1'; }); @@ -117,9 +131,14 @@ describe('Firestore Functions', () => { const cloudFunction = firestore .document('users/{uid}') .onWrite(() => null); + expect(cloudFunction.__trigger).to.deep.equal( expectedTrigger(resource, 'document.write') ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(resource, 'document.write') + ); }); it('should allow custom namespaces', () => { @@ -129,9 +148,14 @@ describe('Firestore Functions', () => { .namespace('v2') .document('users/{uid}') .onWrite(() => null); + expect(cloudFunction.__trigger).to.deep.equal( expectedTrigger(resource, 'document.write') ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(resource, 'document.write') + ); }); it('should allow custom databases', () => { @@ -140,9 +164,14 @@ describe('Firestore Functions', () => { .database('myDB') .document('users/{uid}') .onWrite(() => null); + expect(cloudFunction.__trigger).to.deep.equal( expectedTrigger(resource, 'document.write') ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(resource, 'document.write') + ); }); it('should allow both custom database and namespace', () => { @@ -153,9 +182,14 @@ describe('Firestore Functions', () => { .namespace('v2') .document('users/{uid}') .onWrite(() => null); + expect(cloudFunction.__trigger).to.deep.equal( expectedTrigger(resource, 'document.write') ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(resource, 'document.write') + ); }); it('should allow both region and runtime options to be set', () => { @@ -171,36 +205,10 @@ describe('Firestore Functions', () => { expect(fn.__trigger.regions).to.deep.equal(['us-east1']); expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); expect(fn.__trigger.timeout).to.deep.equal('90s'); - }); - - it('onCreate should have the "document.create" eventType', () => { - const resource = - 'projects/project1/databases/(default)/documents/users/{uid}'; - const eventType = firestore.document('users/{uid}').onCreate(() => null) - .__trigger.eventTrigger.eventType; - expect(eventType).to.eq( - expectedTrigger(resource, 'document.create').eventTrigger.eventType - ); - }); - it('onUpdate should have the "document.update" eventType', () => { - const resource = - 'projects/project1/databases/(default)/documents/users/{uid}'; - const eventType = firestore.document('users/{uid}').onUpdate(() => null) - .__trigger.eventTrigger.eventType; - expect(eventType).to.eq( - expectedTrigger(resource, 'document.update').eventTrigger.eventType - ); - }); - - it('onDelete should have the "document.delete" eventType', () => { - const resource = - 'projects/project1/databases/(default)/documents/users/{uid}'; - const eventType = firestore.document('users/{uid}').onDelete(() => null) - .__trigger.eventTrigger.eventType; - expect(eventType).to.eq( - expectedTrigger(resource, 'document.delete').eventTrigger.eventType - ); + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); }); }); @@ -217,6 +225,12 @@ describe('Firestore Functions', () => { ).to.throw(Error); }); + it('should throw when endpoint is accessed', () => { + expect( + () => firestore.document('input').onCreate(() => null).__endpoint + ).to.throw(Error); + }); + it('should not throw when #run is called', () => { const cf = firestore.document('input').onCreate(() => null); expect(cf.run).to.not.throw(Error); @@ -559,13 +573,14 @@ describe('Firestore Functions', () => { }) ); expect(snapshot.data()).to.deep.equal({ - binaryVal: new Buffer('foobar'), + binaryVal: Buffer.from('foobar'), }); }); }); describe('Other DocumentSnapshot methods', () => { let snapshot: FirebaseFirestore.DocumentSnapshot; + let newSnapshot: FirebaseFirestore.DocumentSnapshot; before(() => { snapshot = firestore.snapshotConstructor( @@ -579,6 +594,16 @@ describe('Firestore Functions', () => { }, }) ); + newSnapshot = firestore.snapshotConstructor( + makeEvent({ + value: { + fields: { key: { integerValue: '2' } }, + createTime: '2017-06-17T14:45:17.876479Z', + updateTime: '2017-06-17T14:45:17.876479Z', + name: 'projects/pid/databases/(default)/documents/collection/124', + }, + }) + ); }); it('should support #exists', () => { @@ -606,6 +631,8 @@ describe('Firestore Functions', () => { it('should support #readTime', () => { expect(snapshot.readTime.seconds).to.be.a('number'); expect(snapshot.readTime.nanoseconds).to.be.a('number'); + expect(newSnapshot.readTime.seconds).to.be.a('number'); + expect(newSnapshot.readTime.nanoseconds).to.be.a('number'); }); }); diff --git a/spec/v1/providers/https.spec.ts b/spec/v1/providers/https.spec.ts new file mode 100644 index 000000000..7046ad25e --- /dev/null +++ b/spec/v1/providers/https.spec.ts @@ -0,0 +1,212 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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 functions from '../../../src/index'; +import * as https from '../../../src/providers/https'; +import { + expectedResponseHeaders, + MockRequest, +} from '../../fixtures/mockrequest'; +import { runHandler } from '../../helper'; + +describe('CloudHttpsBuilder', () => { + describe('#onRequest', () => { + it('should return a trigger with appropriate values', () => { + const result = https.onRequest((req, resp) => { + resp.send(200); + }); + expect(result.__trigger).to.deep.equal({ httpsTrigger: {} }); + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv1', + httpsTrigger: {}, + }); + }); + + it('should allow both region and runtime options to be set', () => { + const fn = functions + .region('us-east1') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + invoker: 'private', + }) + .https.onRequest(() => null); + + expect(fn.__trigger.regions).to.deep.equal(['us-east1']); + expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); + expect(fn.__trigger.timeout).to.deep.equal('90s'); + expect(fn.__trigger.httpsTrigger.invoker).to.deep.equal(['private']); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); + expect(fn.__endpoint.httpsTrigger.invoker).to.deep.equal(['private']); + }); + }); +}); + +describe('handler namespace', () => { + describe('#onRequest', () => { + it('should return an empty trigger', () => { + const result = functions.handler.https.onRequest((req, res) => { + res.send(200); + }); + expect(result.__trigger).to.deep.equal({}); + expect(result.__endpoint).to.be.undefined; + }); + }); + + describe('#onCall', () => { + it('should return an empty trigger', () => { + const result = functions.handler.https.onCall(() => null); + expect(result.__trigger).to.deep.equal({}); + expect(result.__endpoint).to.be.undefined; + }); + }); +}); + +describe('#onCall', () => { + it('should return a trigger/endpoint with appropriate values', () => { + const result = https.onCall((data) => { + return 'response'; + }); + + expect(result.__trigger).to.deep.equal({ + httpsTrigger: {}, + labels: { 'deployment-callable': 'true' }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv1', + callableTrigger: {}, + labels: {}, + }); + }); + + it('should allow both region and runtime options to be set', () => { + const fn = functions + .region('us-east1') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .https.onCall(() => null); + + expect(fn.__trigger.regions).to.deep.equal(['us-east1']); + expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); + expect(fn.__trigger.timeout).to.deep.equal('90s'); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); + }); + + it('has a .run method', () => { + const cf = https.onCall((d, c) => { + return { data: d, context: c }; + }); + + const data = 'data'; + const context = { + instanceIdToken: 'token', + auth: { + uid: 'abc', + token: 'token', + }, + }; + expect(cf.run(data, context)).to.deep.equal({ data, context }); + }); + + // Regression test for firebase-functions#947 + it('should lock to the v1 API even with function.length == 1', async () => { + let gotData: Record; + const func = https.onCall((data) => { + gotData = data; + }); + + const req = new MockRequest( + { + data: { foo: 'bar' }, + }, + { + 'content-type': 'application/json', + } + ); + req.method = 'POST'; + + const response = await runHandler(func, req as any); + expect(response.status).to.equal(200); + expect(gotData).to.deep.equal({ foo: 'bar' }); + }); +}); + +describe('callable CORS', () => { + it('handles OPTIONS preflight', async () => { + const func = https.onCall((data, context) => { + throw new Error( + `This shouldn't have gotten called for an OPTIONS preflight.` + ); + }); + + const req = new MockRequest( + {}, + { + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'origin', + Origin: 'example.com', + } + ); + req.method = 'OPTIONS'; + + const response = await runHandler(func, req as any); + + expect(response.status).to.equal(204); + expect(response.body).to.be.undefined; + expect(response.headers).to.deep.equal({ + 'Access-Control-Allow-Methods': 'POST', + 'Content-Length': '0', + Vary: 'Origin, Access-Control-Request-Headers', + }); + }); + + it('adds CORS headers', async () => { + const func = https.onCall((data, context) => 42); + const req = new MockRequest( + { + data: {}, + }, + { + 'content-type': 'application/json', + origin: 'example.com', + } + ); + req.method = 'POST'; + + const response = await runHandler(func, req as any); + + expect(response.status).to.equal(200); + expect(response.body).to.be.deep.equal({ result: 42 }); + expect(response.headers).to.deep.equal(expectedResponseHeaders); + }); +}); diff --git a/spec/providers/pubsub.spec.ts b/spec/v1/providers/pubsub.spec.ts similarity index 62% rename from spec/providers/pubsub.spec.ts rename to spec/v1/providers/pubsub.spec.ts index 53776c357..5547515ab 100644 --- a/spec/providers/pubsub.spec.ts +++ b/spec/v1/providers/pubsub.spec.ts @@ -21,9 +21,9 @@ // SOFTWARE. import { expect } from 'chai'; -import { Event } from '../../src/index'; -import * as functions from '../../src/index'; -import * as pubsub from '../../src/providers/pubsub'; +import { Event } from '../../../src/index'; +import * as functions from '../../../src/index'; +import * as pubsub from '../../../src/providers/pubsub'; describe('Pubsub Functions', () => { describe('pubsub.Message', () => { @@ -85,12 +85,17 @@ describe('Pubsub Functions', () => { expect(fn.__trigger.regions).to.deep.equal(['us-east1']); expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); expect(fn.__trigger.timeout).to.deep.equal('90s'); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); }); describe('#onPublish', () => { - it('should return a TriggerDefinition with appropriate values', () => { + it('should return a trigger/endpoint with appropriate values', () => { // Pick up project from process.env.GCLOUD_PROJECT const result = pubsub.topic('toppy').onPublish(() => null); + expect(result.__trigger).to.deep.equal({ eventTrigger: { eventType: 'google.pubsub.topic.publish', @@ -98,6 +103,18 @@ describe('Pubsub Functions', () => { service: 'pubsub.googleapis.com', }, }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventType: 'google.pubsub.topic.publish', + eventFilters: { + resource: 'projects/project1/topics/toppy', + }, + retry: false, + }, + labels: {}, + }); }); it('should throw with improperly formatted topics', () => { @@ -143,27 +160,38 @@ describe('Pubsub Functions', () => { }); describe('#schedule', () => { - it('should return a trigger with schedule', () => { + it('should return a trigger/endpoint with schedule', () => { const result = pubsub .schedule('every 5 minutes') .onRun((context) => null); + expect(result.__trigger.schedule).to.deep.equal({ schedule: 'every 5 minutes', }); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + }); }); - it('should return a trigger with schedule and timeZone when one is chosen', () => { + it('should return a trigger/endpoint with schedule and timeZone when one is chosen', () => { const result = pubsub .schedule('every 5 minutes') .timeZone('America/New_York') .onRun((context) => null); + expect(result.__trigger.schedule).to.deep.equal({ schedule: 'every 5 minutes', timeZone: 'America/New_York', }); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + timeZone: 'America/New_York', + }); }); - it('should return a trigger with schedule and retry config when called with retryConfig', () => { + it('should return a trigger/endpoint with schedule and retry config when called with retryConfig', () => { const retryConfig = { retryCount: 3, maxRetryDuration: '10 minutes', @@ -175,6 +203,7 @@ describe('Pubsub Functions', () => { .schedule('every 5 minutes') .retryConfig(retryConfig) .onRun(() => null); + expect(result.__trigger.schedule).to.deep.equal({ schedule: 'every 5 minutes', retryConfig, @@ -182,10 +211,16 @@ describe('Pubsub Functions', () => { expect(result.__trigger.labels).to.deep.equal({ 'deployment-scheduled': 'true', }); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + retryConfig, + }); + expect(result.__endpoint.labels).to.be.empty; }); it( - 'should return a trigger with schedule, timeZone and retry config' + + 'should return a trigger/endpoint with schedule, timeZone and retry config' + 'when called with retryConfig and timeout', () => { const retryConfig = { @@ -200,6 +235,7 @@ describe('Pubsub Functions', () => { .timeZone('America/New_York') .retryConfig(retryConfig) .onRun(() => null); + expect(result.__trigger.schedule).to.deep.equal({ schedule: 'every 5 minutes', retryConfig, @@ -208,10 +244,17 @@ describe('Pubsub Functions', () => { expect(result.__trigger.labels).to.deep.equal({ 'deployment-scheduled': 'true', }); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + retryConfig, + timeZone: 'America/New_York', + }); + expect(result.__endpoint.labels).to.be.empty; } ); - it('should return an appropriate trigger when called with region and options', () => { + it('should return an appropriate trigger/endpoint when called with region and options', () => { const result = functions .region('us-east1') .runWith({ @@ -226,9 +269,16 @@ describe('Pubsub Functions', () => { expect(result.__trigger.regions).to.deep.equal(['us-east1']); expect(result.__trigger.availableMemoryMb).to.deep.equal(256); expect(result.__trigger.timeout).to.deep.equal('90s'); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + }); + expect(result.__endpoint.region).to.deep.equal(['us-east1']); + expect(result.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(result.__endpoint.timeoutSeconds).to.deep.equal(90); }); - it('should return an appropriate trigger when called with region, timeZone, and options', () => { + it('should return an appropriate trigger/endpoint when called with region, timeZone, and options', () => { const result = functions .region('us-east1') .runWith({ @@ -245,9 +295,17 @@ describe('Pubsub Functions', () => { expect(result.__trigger.regions).to.deep.equal(['us-east1']); expect(result.__trigger.availableMemoryMb).to.deep.equal(256); expect(result.__trigger.timeout).to.deep.equal('90s'); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + timeZone: 'America/New_York', + }); + expect(result.__endpoint.region).to.deep.equal(['us-east1']); + expect(result.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(result.__endpoint.timeoutSeconds).to.deep.equal(90); }); - it('should return an appropriate trigger when called with region, options and retryConfig', () => { + it('should return an appropriate trigger/endpoint when called with region, options and retryConfig', () => { const retryConfig = { retryCount: 3, maxRetryDuration: '10 minutes', @@ -274,9 +332,17 @@ describe('Pubsub Functions', () => { expect(result.__trigger.regions).to.deep.equal(['us-east1']); expect(result.__trigger.availableMemoryMb).to.deep.equal(256); expect(result.__trigger.timeout).to.deep.equal('90s'); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + retryConfig, + }); + expect(result.__endpoint.region).to.deep.equal(['us-east1']); + expect(result.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(result.__endpoint.timeoutSeconds).to.deep.equal(90); }); - it('should return an appropriate trigger when called with region, options, retryConfig, and timeZone', () => { + it('should return an appropriate trigger/endpoint when called with region, options, retryConfig, and timeZone', () => { const retryConfig = { retryCount: 3, maxRetryDuration: '10 minutes', @@ -305,51 +371,99 @@ describe('Pubsub Functions', () => { expect(result.__trigger.regions).to.deep.equal(['us-east1']); expect(result.__trigger.availableMemoryMb).to.deep.equal(256); expect(result.__trigger.timeout).to.deep.equal('90s'); + + expect(result.__endpoint.scheduleTrigger).to.deep.equal({ + schedule: 'every 5 minutes', + timeZone: 'America/New_York', + retryConfig, + }); + expect(result.__endpoint.region).to.deep.equal(['us-east1']); + expect(result.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(result.__endpoint.timeoutSeconds).to.deep.equal(90); }); }); }); describe('handler namespace', () => { describe('#onPublish', () => { - it('should return an empty trigger', () => { - const result = functions.handler.pubsub.topic.onPublish(() => null); - expect(result.__trigger).to.deep.equal({}); - }); + describe('#topic', () => { + it('should return an empty trigger', () => { + const result = functions.handler.pubsub.topic.onPublish(() => null); + expect(result.__trigger).to.deep.equal({}); + expect(result.__endpoint).to.be.undefined; + }); - it('should properly handle a new-style event', () => { - const raw = new Buffer('{"hello":"world"}', 'utf8').toString('base64'); - const event = { - data: { - data: raw, - attributes: { - foo: 'bar', + it('should properly handle a new-style event', () => { + const raw = new Buffer('{"hello":"world"}', 'utf8').toString( + 'base64' + ); + const event = { + data: { + data: raw, + attributes: { + foo: 'bar', + }, }, - }, - context: { - eventId: '70172329041928', - timestamp: '2018-04-09T07:56:12.975Z', - eventType: 'google.pubsub.topic.publish', - resource: { - service: 'pubsub.googleapis.com', - name: 'projects/project1/topics/toppy', + context: { + eventId: '70172329041928', + timestamp: '2018-04-09T07:56:12.975Z', + eventType: 'google.pubsub.topic.publish', + resource: { + service: 'pubsub.googleapis.com', + name: 'projects/project1/topics/toppy', + }, }, - }, - }; - - const result = functions.handler.pubsub.topic.onPublish((data) => { - return { - raw: data.data, - json: data.json, - attributes: data.attributes, }; - }); - return expect( - result(event.data, event.context) - ).to.eventually.deep.equal({ - raw, - json: { hello: 'world' }, - attributes: { foo: 'bar' }, + const result = functions.handler.pubsub.topic.onPublish((data) => { + return { + raw: data.data, + json: data.json, + attributes: data.attributes, + }; + }); + + return expect( + result(event.data, event.context) + ).to.eventually.deep.equal({ + raw, + json: { hello: 'world' }, + attributes: { foo: 'bar' }, + }); + }); + }); + describe('#schedule', () => { + it('should return an empty trigger', () => { + const result = functions.handler.pubsub.schedule.onRun(() => null); + expect(result.__trigger).to.deep.equal({}); + }); + it('should return a handler with a proper event context', () => { + const raw = new Buffer('{"hello":"world"}', 'utf8').toString( + 'base64' + ); + const event = { + data: { + data: raw, + attributes: { + foo: 'bar', + }, + }, + context: { + eventId: '70172329041928', + timestamp: '2018-04-09T07:56:12.975Z', + eventType: 'google.pubsub.topic.publish', + resource: { + service: 'pubsub.googleapis.com', + name: 'projects/project1/topics/toppy', + }, + }, + }; + const result = functions.handler.pubsub.schedule.onRun( + (context) => context.eventId + ); + return expect(result(event.data, event.context)).to.eventually.equal( + '70172329041928' + ); }); }); }); @@ -368,6 +482,12 @@ describe('Pubsub Functions', () => { ).to.throw(Error); }); + it('should throw when endpoint is accessed', () => { + expect( + () => pubsub.topic('toppy').onPublish(() => null).__endpoint + ).to.throw(Error); + }); + it('should not throw when #run is called', () => { const cf = pubsub.topic('toppy').onPublish(() => null); expect(cf.run).to.not.throw(Error); diff --git a/spec/providers/remoteConfig.spec.ts b/spec/v1/providers/remoteConfig.spec.ts similarity index 83% rename from spec/providers/remoteConfig.spec.ts rename to spec/v1/providers/remoteConfig.spec.ts index ef6d68572..f3fde2043 100644 --- a/spec/providers/remoteConfig.spec.ts +++ b/spec/v1/providers/remoteConfig.spec.ts @@ -20,16 +20,14 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. import { expect } from 'chai'; -import * as _ from 'lodash'; import { CloudFunction, Event, EventContext, - TriggerAnnotated, -} from '../../src/cloud-functions'; -import * as functions from '../../src/index'; -import * as remoteConfig from '../../src/providers/remoteConfig'; +} from '../../../src/cloud-functions'; +import * as functions from '../../../src/index'; +import * as remoteConfig from '../../../src/providers/remoteConfig'; describe('RemoteConfig Functions', () => { function constructVersion() { @@ -47,18 +45,6 @@ describe('RemoteConfig Functions', () => { } describe('#onUpdate', () => { - function expectedTrigger(): TriggerAnnotated { - return { - __trigger: { - eventTrigger: { - resource: 'projects/project1', - eventType: 'google.firebase.remoteconfig.update', - service: 'firebaseremoteconfig.googleapis.com', - }, - }, - }; - } - before(() => { process.env.GCLOUD_PROJECT = 'project1'; }); @@ -69,9 +55,26 @@ describe('RemoteConfig Functions', () => { it('should have the correct trigger', () => { const cloudFunction = remoteConfig.onUpdate(() => null); - expect(cloudFunction.__trigger).to.deep.equal( - expectedTrigger().__trigger - ); + + expect(cloudFunction.__trigger).to.deep.equal({ + eventTrigger: { + resource: 'projects/project1', + eventType: 'google.firebase.remoteconfig.update', + service: 'firebaseremoteconfig.googleapis.com', + }, + }); + + expect(cloudFunction.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventType: 'google.firebase.remoteconfig.update', + eventFilters: { + resource: 'projects/project1', + }, + retry: false, + }, + labels: {}, + }); }); it('should allow both region and runtime options to be set', () => { @@ -86,6 +89,10 @@ describe('RemoteConfig Functions', () => { expect(cloudFunction.__trigger.regions).to.deep.equal(['us-east1']); expect(cloudFunction.__trigger.availableMemoryMb).to.deep.equal(256); expect(cloudFunction.__trigger.timeout).to.deep.equal('90s'); + + expect(cloudFunction.__endpoint.region).to.deep.equal(['us-east1']); + expect(cloudFunction.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(cloudFunction.__endpoint.timeoutSeconds).to.deep.equal(90); }); }); @@ -135,7 +142,9 @@ describe('RemoteConfig Functions', () => { const cloudFunction = functions.handler.remoteConfig.onUpdate( () => null ); + expect(cloudFunction.__trigger).to.deep.equal({}); + expect(cloudFunction.__endpoint).to.be.undefined; }); it('should correctly unwrap the event', () => { diff --git a/spec/providers/storage.spec.ts b/spec/v1/providers/storage.spec.ts similarity index 74% rename from spec/providers/storage.spec.ts rename to spec/v1/providers/storage.spec.ts index 18326eab8..d96b131b9 100644 --- a/spec/providers/storage.spec.ts +++ b/spec/v1/providers/storage.spec.ts @@ -21,20 +21,47 @@ // SOFTWARE. import { expect } from 'chai'; -import { Event, EventContext } from '../../src/index'; -import * as functions from '../../src/index'; -import * as storage from '../../src/providers/storage'; +import { Event, EventContext } from '../../../src'; +import * as functions from '../../../src'; +import * as config from '../../../src/config'; +import * as storage from '../../../src/providers/storage'; describe('Storage Functions', () => { describe('ObjectBuilder', () => { + function expectedTrigger(bucket: string, eventType: string) { + return { + eventTrigger: { + resource: `projects/_/buckets/${bucket}`, + eventType: `google.storage.object.${eventType}`, + service: 'storage.googleapis.com', + }, + }; + } + + function expectedEndpoint(bucket: string, eventType: string) { + return { + platform: 'gcfv1', + eventTrigger: { + eventFilters: { + resource: `projects/_/buckets/${bucket}`, + }, + eventType: `google.storage.object.${eventType}`, + retry: false, + }, + labels: {}, + }; + } + + const defaultBucket = 'bucket'; + before(() => { - process.env.FIREBASE_CONFIG = JSON.stringify({ - storageBucket: 'bucket', - }); + (config as any).firebaseConfigCache = { + storageBucket: defaultBucket, + }; }); after(() => { - delete process.env.FIREBASE_CONFIG; + (config as any).firebaseConfigcache = null; }); it('should allow both region and runtime options to be set', () => { @@ -50,6 +77,10 @@ describe('Storage Functions', () => { expect(fn.__trigger.regions).to.deep.equal(['us-east1']); expect(fn.__trigger.availableMemoryMb).to.deep.equal(256); expect(fn.__trigger.timeout).to.deep.equal('90s'); + + expect(fn.__endpoint.region).to.deep.equal(['us-east1']); + expect(fn.__endpoint.availableMemoryMb).to.deep.equal(256); + expect(fn.__endpoint.timeoutSeconds).to.deep.equal(90); }); describe('#onArchive', () => { @@ -58,24 +89,26 @@ describe('Storage Functions', () => { .bucket('bucky') .object() .onArchive(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.archive', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger('bucky', 'archive') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'archive') + ); }); it('should use the default bucket when none is provided', () => { const cloudFunction = storage.object().onArchive(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.archive', - resource: 'projects/_/buckets/bucket', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger(defaultBucket, 'archive') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(defaultBucket, 'archive') + ); }); it('should allow fully qualified bucket names', () => { @@ -84,13 +117,14 @@ describe('Storage Functions', () => { {} ); const result = subjectQualified.onArchive(() => null); - expect(result.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.archive', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(result.__trigger).to.deep.equal( + expectedTrigger('bucky', 'archive') + ); + + expect(result.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'archive') + ); }); it('should throw with improperly formatted buckets', () => { @@ -101,6 +135,14 @@ describe('Storage Functions', () => { .object() .onArchive(() => null).__trigger ).to.throw(Error); + + expect( + () => + storage + .bucket('bad/bucket/format') + .object() + .onArchive(() => null).__endpoint + ).to.throw(Error); }); it('should not mess with media links using non-literal slashes', () => { @@ -138,24 +180,26 @@ describe('Storage Functions', () => { .bucket('bucky') .object() .onDelete(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.delete', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger('bucky', 'delete') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'delete') + ); }); it('should use the default bucket when none is provided', () => { const cloudFunction = storage.object().onDelete(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.delete', - resource: 'projects/_/buckets/bucket', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger(defaultBucket, 'delete') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(defaultBucket, 'delete') + ); }); it('should allow fully qualified bucket names', () => { @@ -164,23 +208,25 @@ describe('Storage Functions', () => { {} ); const result = subjectQualified.onDelete(() => null); - expect(result.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.delete', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(result.__trigger).to.deep.equal( + expectedTrigger('bucky', 'delete') + ); + + expect(result.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'delete') + ); }); it('should throw with improperly formatted buckets', () => { - expect( - () => - storage - .bucket('bad/bucket/format') - .object() - .onDelete(() => null).__trigger - ).to.throw(Error); + const fn = storage + .bucket('bad/bucket/format') + .object() + .onDelete(() => null); + + expect(() => fn.__trigger).to.throw(Error); + + expect(() => fn.__endpoint).to.throw(Error); }); it('should not mess with media links using non-literal slashes', () => { @@ -218,24 +264,26 @@ describe('Storage Functions', () => { .bucket('bucky') .object() .onFinalize(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.finalize', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger('bucky', 'finalize') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'finalize') + ); }); it('should use the default bucket when none is provided', () => { const cloudFunction = storage.object().onFinalize(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.finalize', - resource: 'projects/_/buckets/bucket', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger(defaultBucket, 'finalize') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(defaultBucket, 'finalize') + ); }); it('should allow fully qualified bucket names', () => { @@ -244,23 +292,25 @@ describe('Storage Functions', () => { {} ); const result = subjectQualified.onFinalize(() => null); - expect(result.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.finalize', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(result.__trigger).to.deep.equal( + expectedTrigger('bucky', 'finalize') + ); + + expect(result.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'finalize') + ); }); it('should throw with improperly formatted buckets', () => { - expect( - () => - storage - .bucket('bad/bucket/format') - .object() - .onFinalize(() => null).__trigger - ).to.throw(Error); + const fn = storage + .bucket('bad/bucket/format') + .object() + .onFinalize(() => null); + + expect(() => fn.__trigger).to.throw(Error); + + expect(() => fn.__endpoint).to.throw(Error); }); it('should not mess with media links using non-literal slashes', () => { @@ -298,24 +348,26 @@ describe('Storage Functions', () => { .bucket('bucky') .object() .onMetadataUpdate(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.metadataUpdate', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger('bucky', 'metadataUpdate') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'metadataUpdate') + ); }); it('should use the default bucket when none is provided', () => { const cloudFunction = storage.object().onMetadataUpdate(() => null); - expect(cloudFunction.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.metadataUpdate', - resource: 'projects/_/buckets/bucket', - service: 'storage.googleapis.com', - }, - }); + + expect(cloudFunction.__trigger).to.deep.equal( + expectedTrigger(defaultBucket, 'metadataUpdate') + ); + + expect(cloudFunction.__endpoint).to.deep.equal( + expectedEndpoint(defaultBucket, 'metadataUpdate') + ); }); it('should allow fully qualified bucket names', () => { @@ -324,23 +376,24 @@ describe('Storage Functions', () => { {} ); const result = subjectQualified.onMetadataUpdate(() => null); - expect(result.__trigger).to.deep.equal({ - eventTrigger: { - eventType: 'google.storage.object.metadataUpdate', - resource: 'projects/_/buckets/bucky', - service: 'storage.googleapis.com', - }, - }); + + expect(result.__trigger).to.deep.equal( + expectedTrigger('bucky', 'metadataUpdate') + ); + + expect(result.__endpoint).to.deep.equal( + expectedEndpoint('bucky', 'metadataUpdate') + ); }); it('should throw with improperly formatted buckets', () => { - expect( - () => - storage - .bucket('bad/bucket/format') - .object() - .onMetadataUpdate(() => null).__trigger - ).to.throw(Error); + const fn = storage + .bucket('bad/bucket/format') + .object() + .onMetadataUpdate(() => null); + + expect(() => fn.__trigger).to.throw(Error); + expect(() => fn.__endpoint).to.throw(Error); }); it('should not mess with media links using non-literal slashes', () => { @@ -389,7 +442,9 @@ describe('Storage Functions', () => { const cloudFunction = functions.handler.storage.bucket.onArchive( () => null ); + expect(cloudFunction.__trigger).to.deep.equal({}); + expect(cloudFunction.__endpoint).to.be.undefined; }); it('should not mess with media links using non-literal slashes', () => { @@ -428,7 +483,9 @@ describe('Storage Functions', () => { const cloudFunction = functions.handler.storage.bucket.onDelete( () => null ); + expect(cloudFunction.__trigger).to.deep.equal({}); + expect(cloudFunction.__endpoint).to.be.undefined; }); it('should not mess with media links using non-literal slashes', () => { @@ -467,7 +524,9 @@ describe('Storage Functions', () => { const cloudFunction = functions.handler.storage.bucket.onFinalize( () => null ); + expect(cloudFunction.__trigger).to.deep.equal({}); + expect(cloudFunction.__endpoint).to.be.undefined; }); it('should not mess with media links using non-literal slashes', () => { @@ -506,7 +565,9 @@ describe('Storage Functions', () => { const cloudFunction = functions.handler.storage.bucket.onMetadataUpdate( () => null ); + expect(cloudFunction.__trigger).to.deep.equal({}); + expect(cloudFunction.__endpoint).to.be.undefined; }); it('should not mess with media links using non-literal slashes', () => { @@ -542,6 +603,11 @@ describe('Storage Functions', () => { }); describe('process.env.FIREBASE_CONFIG not set', () => { + beforeEach(() => { + (config as any).firebaseConfigCache = null; + delete process.env.FIREBASE_CONFIG; + }); + it('should not throw if __trigger is not accessed', () => { expect(() => storage.object().onArchive(() => null)).to.not.throw(Error); }); @@ -552,6 +618,12 @@ describe('Storage Functions', () => { ); }); + it('should throw when endpoint is accessed', () => { + expect(() => storage.object().onArchive(() => null).__endpoint).to.throw( + Error + ); + }); + it('should not throw when #run is called', () => { const cf = storage.object().onArchive(() => null); expect(cf.run).to.not.throw(Error); diff --git a/spec/v1/providers/tasks.spec.ts b/spec/v1/providers/tasks.spec.ts new file mode 100644 index 000000000..20f8c8e00 --- /dev/null +++ b/spec/v1/providers/tasks.spec.ts @@ -0,0 +1,166 @@ +// 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 functions from '../../../src'; +import { taskQueue } from '../../../src/providers/tasks'; +import { MockRequest } from '../../fixtures/mockrequest'; +import { runHandler } from '../../helper'; + +describe('#onDispatch', () => { + it('should return a trigger/endpoint with appropriate values', () => { + const result = taskQueue({ + rateLimits: { + maxConcurrentDispatches: 30, + maxDispatchesPerSecond: 40, + }, + retryConfig: { + maxAttempts: 5, + maxRetrySeconds: 10, + maxBackoffSeconds: 20, + maxDoublings: 3, + minBackoffSeconds: 5, + }, + invoker: 'private', + }).onDispatch(() => {}); + + expect(result.__trigger).to.deep.equal({ + taskQueueTrigger: { + rateLimits: { + maxConcurrentDispatches: 30, + maxDispatchesPerSecond: 40, + }, + retryConfig: { + maxAttempts: 5, + maxRetrySeconds: 10, + maxBackoffSeconds: 20, + maxDoublings: 3, + minBackoffSeconds: 5, + }, + invoker: ['private'], + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv1', + taskQueueTrigger: { + rateLimits: { + maxConcurrentDispatches: 30, + maxDispatchesPerSecond: 40, + }, + retryConfig: { + maxAttempts: 5, + maxRetrySeconds: 10, + maxBackoffSeconds: 20, + maxDoublings: 3, + minBackoffSeconds: 5, + }, + invoker: ['private'], + }, + }); + }); + + it('should allow both region and runtime options to be set', () => { + const fn = functions + .region('us-east1') + .runWith({ + timeoutSeconds: 90, + memory: '256MB', + }) + .tasks.taskQueue({ retryConfig: { maxAttempts: 5 } }) + .onDispatch(() => null); + + expect(fn.__trigger).to.deep.equal({ + regions: ['us-east1'], + availableMemoryMb: 256, + timeout: '90s', + taskQueueTrigger: { + retryConfig: { + maxAttempts: 5, + }, + }, + }); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv1', + region: ['us-east1'], + availableMemoryMb: 256, + timeoutSeconds: 90, + taskQueueTrigger: { + retryConfig: { + maxAttempts: 5, + }, + }, + }); + }); + + it('has a .run method', async () => { + const data = 'data'; + const context = { + auth: { + uid: 'abc', + token: 'token' as any, + }, + }; + let done = false; + const cf = taskQueue().onDispatch((d, c) => { + expect(d).to.equal(data); + expect(c).to.deep.equal(context); + done = true; + }); + + await cf.run(data, context); + expect(done).to.be.true; + }); + + // Regression test for firebase-functions#947 + it('should lock to the v1 API even with function.length == 1', async () => { + let gotData: Record; + const func = taskQueue().onDispatch((data) => { + gotData = data; + }); + + const req = new MockRequest( + { + data: { foo: 'bar' }, + }, + { + 'content-type': 'application/json', + authorization: 'Bearer abc', + } + ); + req.method = 'POST'; + + const response = await runHandler(func, req as any); + expect(response.status).to.equal(204); + expect(gotData).to.deep.equal({ foo: 'bar' }); + }); +}); + +describe('handler namespace', () => { + it('should return an empty trigger', () => { + const result = functions.handler.tasks.taskQueue.onDispatch(() => null); + expect(result.__trigger).to.deep.equal({}); + expect(result.__endpoint).to.be.undefined; + }); +}); diff --git a/spec/providers/testLab.spec.ts b/spec/v1/providers/testLab.spec.ts similarity index 85% rename from spec/providers/testLab.spec.ts rename to spec/v1/providers/testLab.spec.ts index bf74a6fd1..b3ba22d7f 100644 --- a/spec/providers/testLab.spec.ts +++ b/spec/v1/providers/testLab.spec.ts @@ -22,7 +22,7 @@ import { expect } from 'chai'; -import * as testLab from '../../src/providers/testLab'; +import * as testLab from '../../../src/providers/testLab'; describe('Test Lab Functions', () => { describe('#onComplete', () => { @@ -35,8 +35,9 @@ describe('Test Lab Functions', () => { delete process.env.GCLOUD_PROJECT; }); - it('should return a TriggerDefinition with appropriate values', () => { + it('should return a trigger/endpoint with appropriate values', () => { const func = testLab.testMatrix().onComplete(() => null); + expect(func.__trigger).to.deep.equal({ eventTrigger: { service: 'testing.googleapis.com', @@ -44,6 +45,18 @@ describe('Test Lab Functions', () => { resource: 'projects/project1/testMatrices/{matrix}', }, }); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv1', + eventTrigger: { + eventType: 'google.testing.testMatrix.complete', + eventFilters: { + resource: 'projects/project1/testMatrices/{matrix}', + }, + retry: false, + }, + labels: {}, + }); }); it('should parse TestMatrix in "INVALID" state', () => { @@ -66,23 +79,23 @@ describe('Test Lab Functions', () => { resource: {}, }, }; - const expected = { + const expected = { testMatrixId: 'matrix-375mfeu9mnw8t', state: 'INVALID', createTime: '2019-04-15T17:43:32.538Z', outcomeSummary: undefined, invalidMatrixDetails: 'INVALID_INPUT_APK', - resultStorage: { + resultStorage: { gcsPath: 'gs://test.appspot.com', resultsUrl: undefined, toolResultsHistoryId: undefined, toolResultsExecutionId: undefined, - }, - clientInfo: { + } as testLab.ResultStorage, + clientInfo: { name: 'test', details: {}, - }, - }; + } as testLab.ClientInfo, + } as testLab.TestMatrix; const func = testLab.testMatrix().onComplete((matrix) => matrix); return expect(func(event.data, event.context)).to.eventually.deep.equal( expected @@ -119,23 +132,23 @@ describe('Test Lab Functions', () => { resource: {}, }, }; - const expected = { + const expected = { testMatrixId: 'matrix-tsgjk8pnvxhya', state: 'FINISHED', createTime: '2019-04-15T18:03:11.115Z', outcomeSummary: 'FAILURE', invalidMatrixDetails: undefined, - resultStorage: { + resultStorage: { gcsPath: 'gs://test.appspot.com', toolResultsHistoryId: 'bh.9b6f4dac24d3049', toolResultsExecutionId: '6352915701487950333', resultsUrl: 'https://path/to/results', - }, - clientInfo: { + } as testLab.ResultStorage, + clientInfo: { name: 'test', details: {}, - }, - }; + } as testLab.ClientInfo, + } as testLab.TestMatrix; const func = testLab.testMatrix().onComplete((matrix) => matrix); return expect(func(event.data, event.context)).to.eventually.deep.equal( expected @@ -155,13 +168,19 @@ describe('Test Lab Functions', () => { () => testLab.testMatrix().onComplete(() => null).__trigger ).to.throw(Error); }); + + it('should throw when endpoint is accessed', () => { + expect( + () => testLab.testMatrix().onComplete(() => null).__endpoint + ).to.throw(Error); + }); }); }); describe('TestMatrix', () => { describe('constructor', () => { it('should populate basic fields', () => { - const expected = { + const expected = { testMatrixId: 'id1', createTime: '2019-02-08T18:50:32.178Z', state: 'FINISHED', @@ -169,7 +188,7 @@ describe('Test Lab Functions', () => { invalidMatrixDetails: 'DETAILS_UNAVAILABLE', resultStorage: new testLab.ResultStorage(), clientInfo: new testLab.ClientInfo(), - }; + } as testLab.TestMatrix; const actual = new testLab.TestMatrix({ testMatrixId: 'id1', timestamp: '2019-02-08T18:50:32.178Z', @@ -185,10 +204,10 @@ describe('Test Lab Functions', () => { describe('ClientInfo', () => { describe('constructor', () => { it('should populate basic fields', () => { - const expected = { + const expected = { name: 'client', details: {}, - }; + } as testLab.ClientInfo; const actual = new testLab.ClientInfo({ name: 'client', }); @@ -196,13 +215,13 @@ describe('Test Lab Functions', () => { }); it('should populate key/value details', () => { - const expected = { + const expected = { name: 'client', details: { k0: 'v0', k1: '', }, - }; + } as testLab.ClientInfo; const actual = new testLab.ClientInfo({ name: 'client', clientInfoDetails: [ @@ -223,12 +242,12 @@ describe('Test Lab Functions', () => { describe('ResultStorage', () => { describe('constructor', () => { it('should populate basic fields', () => { - const expected = { + const expected = { gcsPath: 'path', toolResultsHistoryId: 'h1', toolResultsExecutionId: 'e2', resultsUrl: 'http://example.com/', - }; + } as testLab.ResultStorage; const actual = new testLab.ResultStorage({ googleCloudStorage: { gcsPath: 'path', diff --git a/spec/setup.spec.ts b/spec/v1/setup.spec.ts similarity index 97% rename from spec/setup.spec.ts rename to spec/v1/setup.spec.ts index 289b90fc1..25a6fbe0c 100644 --- a/spec/setup.spec.ts +++ b/spec/v1/setup.spec.ts @@ -21,7 +21,7 @@ // SOFTWARE. import { expect } from 'chai'; -import { setup } from '../src/setup'; +import { setup } from '../../src/setup'; describe('setup()', () => { afterEach(() => { diff --git a/spec/utils.spec.ts b/spec/v1/utils.spec.ts similarity index 97% rename from spec/utils.spec.ts rename to spec/v1/utils.spec.ts index 51a8478fa..db749ca5d 100644 --- a/spec/utils.spec.ts +++ b/spec/v1/utils.spec.ts @@ -21,7 +21,7 @@ // SOFTWARE. import { expect } from 'chai'; -import { applyChange } from '../src/utils'; +import { applyChange } from '../../src/utils'; describe('utils', () => { describe('.applyChange(from: any, to: any): any', () => { diff --git a/spec/v2/providers/alerts/alerts.spec.ts b/spec/v2/providers/alerts/alerts.spec.ts new file mode 100644 index 000000000..3decbd111 --- /dev/null +++ b/spec/v2/providers/alerts/alerts.spec.ts @@ -0,0 +1,215 @@ +import { expect } from 'chai'; +import { CloudEvent } from '../../../../src/v2'; +import * as options from '../../../../src/v2/options'; +import * as alerts from '../../../../src/v2/providers/alerts'; +import { FULL_ENDPOINT, FULL_OPTIONS } from '../fixtures'; + +const ALERT_TYPE = 'new-alert-type'; +const APPID = '123456789'; + +const ALERT_EVENT_FILTER = { + alerttype: ALERT_TYPE, +}; + +const ALERT_APP_EVENT_FILTER = { + alerttype: ALERT_TYPE, + appid: APPID, +}; + +describe('alerts', () => { + describe('onAlertPublished', () => { + it('should create the function without opts', () => { + const result = alerts.onAlertPublished(ALERT_TYPE, () => 42); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create the function with opts', () => { + const result = alerts.onAlertPublished( + { + ...FULL_OPTIONS, + alertType: ALERT_TYPE, + appId: APPID, + }, + () => 42 + ); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should have a .run method', () => { + const func = alerts.onAlertPublished(ALERT_TYPE, (event) => event); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + }); + + describe('getEndpointAnnotation', () => { + beforeEach(() => { + process.env.GCLOUD_PROJECT = 'aProject'; + }); + + afterEach(() => { + options.setGlobalOptions({}); + delete process.env.GCLOUD_PROJECT; + }); + + it('should define the endpoint without appId and opts', () => { + expect(alerts.getEndpointAnnotation({}, ALERT_TYPE)).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should define a complex endpoint without appId', () => { + expect( + alerts.getEndpointAnnotation({ ...FULL_OPTIONS }, ALERT_TYPE) + ).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should define a complex endpoint', () => { + expect( + alerts.getEndpointAnnotation({ ...FULL_OPTIONS }, ALERT_TYPE, APPID) + ).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should merge global & specific opts', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + }); + const specificOpts = { + region: 'us-west1', + minInstances: 3, + }; + + expect( + alerts.getEndpointAnnotation(specificOpts, ALERT_TYPE, APPID) + ).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + concurrency: 20, + region: ['us-west1'], + minInstances: 3, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + }); + + describe('getOptsAndAlertTypeAndApp', () => { + it('should parse a string', () => { + const [opts, alertType, appId] = alerts.getOptsAndAlertTypeAndApp( + ALERT_TYPE + ); + + expect(opts).to.deep.equal({}); + expect(alertType).to.equal(ALERT_TYPE); + expect(appId).to.be.undefined; + }); + + it('should parse an options object without appId', () => { + const myOpts: alerts.FirebaseAlertOptions = { + alertType: ALERT_TYPE, + region: 'us-west1', + }; + + const [opts, alertType, appId] = alerts.getOptsAndAlertTypeAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(alertType).to.equal(myOpts.alertType); + expect(appId).to.be.undefined; + }); + + it('should parse an options object with appId', () => { + const myOpts: alerts.FirebaseAlertOptions = { + alertType: ALERT_TYPE, + appId: APPID, + region: 'us-west1', + }; + + const [opts, alertType, appId] = alerts.getOptsAndAlertTypeAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(alertType).to.equal(myOpts.alertType); + expect(appId).to.be.equal(myOpts.appId); + }); + }); + + describe('convertAlertAndApp', () => { + const event: CloudEvent = { + specversion: '1.0', + id: 'id', + source: 'source', + type: 'type', + time: 'now', + data: 'data', + }; + + it('should leave event unchanged if alerttype & appid are missing', () => { + const raw = { ...event }; + + const converted = alerts.convertAlertAndApp(raw); + + expect(raw).to.deep.eq(converted); + }); + + it('should convert alerttype & appid when present', () => { + const raw = { + ...event, + alerttype: 'my-alert', + appid: 'my-app', + }; + + const converted = alerts.convertAlertAndApp(raw); + + expect(converted).to.deep.eq({ + ...event, + alerttype: 'my-alert', + appid: 'my-app', + alertType: 'my-alert', + appId: 'my-app', + }); + }); + }); +}); diff --git a/spec/v2/providers/alerts/appDistribution.spec.ts b/spec/v2/providers/alerts/appDistribution.spec.ts new file mode 100644 index 000000000..9b699bc62 --- /dev/null +++ b/spec/v2/providers/alerts/appDistribution.spec.ts @@ -0,0 +1,214 @@ +import { expect } from 'chai'; +import * as alerts from '../../../../src/v2/providers/alerts'; +import * as appDistribution from '../../../../src/v2/providers/alerts/appDistribution'; +import { FULL_ENDPOINT, FULL_OPTIONS } from '../fixtures'; + +const APPID = '123456789'; +const myHandler = () => 42; + +const APP_EVENT_FILTER = { + appid: APPID, +}; + +describe('appDistribution', () => { + describe('onNewTesterIosDevicePublished', () => { + it('should create a function with alertType & appId', () => { + const func = appDistribution.onNewTesterIosDevicePublished( + APPID, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + ...APP_EVENT_FILTER, + alerttype: appDistribution.newTesterIosDeviceAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = appDistribution.onNewTesterIosDevicePublished( + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: appDistribution.newTesterIosDeviceAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with appid in opts', () => { + const func = appDistribution.onNewTesterIosDevicePublished( + { ...FULL_OPTIONS, appId: APPID }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + ...APP_EVENT_FILTER, + alerttype: appDistribution.newTesterIosDeviceAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function without opts or appId', () => { + const func = appDistribution.onNewTesterIosDevicePublished(myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: appDistribution.newTesterIosDeviceAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with a run method', () => { + const func = appDistribution.onNewTesterIosDevicePublished( + APPID, + (event) => event + ); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + }); + + describe('onInAppfeedbackPublished', () => { + it('should create a function with alertType & appId', () => { + const func = appDistribution.onInAppFeedbackPublished(APPID, myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + ...APP_EVENT_FILTER, + alerttype: appDistribution.inAppFeedbackAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = appDistribution.onInAppFeedbackPublished( + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: appDistribution.inAppFeedbackAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with appid in opts', () => { + const func = appDistribution.onInAppFeedbackPublished( + { ...FULL_OPTIONS, appId: APPID }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + ...APP_EVENT_FILTER, + alerttype: appDistribution.inAppFeedbackAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function without opts or appId', () => { + const func = appDistribution.onInAppFeedbackPublished(myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: appDistribution.inAppFeedbackAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with a run method', () => { + const func = appDistribution.onInAppFeedbackPublished( + APPID, + (event) => event + ); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + }); + + describe('getOptsAndApp', () => { + it('should parse a string', () => { + const [opts, appId] = appDistribution.getOptsAndApp(APPID); + + expect(opts).to.deep.equal({}); + expect(appId).to.equal(APPID); + }); + + it('should parse an options object without appId', () => { + const myOpts: appDistribution.AppDistributionOptions = { + region: 'us-west1', + }; + + const [opts, appId] = appDistribution.getOptsAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(appId).to.be.undefined; + }); + + it('should parse an options object with appId', () => { + const myOpts: appDistribution.AppDistributionOptions = { + appId: APPID, + region: 'us-west1', + }; + + const [opts, appId] = appDistribution.getOptsAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(appId).to.equal(APPID); + }); + }); +}); diff --git a/spec/v2/providers/alerts/billing.spec.ts b/spec/v2/providers/alerts/billing.spec.ts new file mode 100644 index 000000000..4bf5f3080 --- /dev/null +++ b/spec/v2/providers/alerts/billing.spec.ts @@ -0,0 +1,126 @@ +import { expect } from 'chai'; +import * as alerts from '../../../../src/v2/providers/alerts'; +import * as billing from '../../../../src/v2/providers/alerts/billing'; +import { FULL_ENDPOINT, FULL_OPTIONS } from '../fixtures'; + +const ALERT_TYPE = 'new-alert-type'; +const myHandler = () => 42; + +describe('billing', () => { + describe('onPlanUpdatePublished', () => { + it('should create a function with only handler', () => { + const func = billing.onPlanUpdatePublished(myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: billing.planUpdateAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with opts & handler', () => { + const func = billing.onPlanUpdatePublished( + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: billing.planUpdateAlert, + }, + retry: false, + }, + }); + }); + }); + + describe('onPlanAutomatedUpdatePublished', () => { + it('should create a function with only handler', () => { + const func = billing.onPlanAutomatedUpdatePublished(myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: billing.planAutomatedUpdateAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with opts & handler', () => { + const func = billing.onPlanAutomatedUpdatePublished( + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: billing.planAutomatedUpdateAlert, + }, + retry: false, + }, + }); + }); + }); + + describe('onOperation', () => { + it('should create a function with alertType only', () => { + const func = billing.onOperation(ALERT_TYPE, myHandler, undefined); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: ALERT_TYPE, + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = billing.onOperation( + ALERT_TYPE, + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: ALERT_TYPE, + }, + retry: false, + }, + }); + }); + + it('should create a function with a run method', () => { + const func = billing.onOperation(ALERT_TYPE, (event) => event, undefined); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + }); +}); diff --git a/spec/v2/providers/alerts/crashlytics.spec.ts b/spec/v2/providers/alerts/crashlytics.spec.ts new file mode 100644 index 000000000..08956d8c7 --- /dev/null +++ b/spec/v2/providers/alerts/crashlytics.spec.ts @@ -0,0 +1,226 @@ +import { expect } from 'chai'; +import * as alerts from '../../../../src/v2/providers/alerts'; +import * as crashlytics from '../../../../src/v2/providers/alerts/crashlytics'; +import { FULL_ENDPOINT, FULL_OPTIONS } from '../fixtures'; + +const ALERT_TYPE = 'new-alert-type'; +const APPID = '123456789'; +const myHandler = () => 42; + +describe('crashlytics', () => { + const testcases = [ + { + method: 'onNewFatalIssuePublished', + event: crashlytics.newFatalIssueAlert, + }, + { + method: 'onNewNonfatalIssuePublished', + event: crashlytics.newNonfatalIssueAlert, + }, + { + method: 'onRegressionAlertPublished', + event: crashlytics.regressionAlert, + }, + { + method: 'onStabilityDigestPublished', + event: crashlytics.stabilityDigestAlert, + }, + { + method: 'onVelocityAlertPublished', + event: crashlytics.velocityAlert, + }, + { + method: 'onNewAnrIssuePublished', + event: crashlytics.newAnrIssueAlert, + }, + ]; + + for (const { method, event } of testcases) { + const ALERT_EVENT_FILTER = { + alerttype: event, + }; + + const ALERT_APP_EVENT_FILTER = { + ...ALERT_EVENT_FILTER, + appid: APPID, + }; + + describe(method, () => { + it('should create a function only handler', () => { + const func = crashlytics[method](myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with appId', () => { + const func = crashlytics[method](APPID, myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with base opts', () => { + const func = crashlytics[method]({ ...FULL_OPTIONS }, myHandler); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = crashlytics[method]( + { ...FULL_OPTIONS, appId: APPID }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + }); + } + + const ALERT_EVENT_FILTER = { + alerttype: ALERT_TYPE, + }; + + const ALERT_APP_EVENT_FILTER = { + ...ALERT_EVENT_FILTER, + appid: APPID, + }; + + describe('onOperation', () => { + it('should create a function with alertType only', () => { + const func = crashlytics.onOperation(ALERT_TYPE, myHandler, undefined); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with alertType & appId', () => { + const func = crashlytics.onOperation(ALERT_TYPE, APPID, myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with base opts', () => { + const func = crashlytics.onOperation( + ALERT_TYPE, + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with appid in opts', () => { + const func = crashlytics.onOperation( + ALERT_TYPE, + { ...FULL_OPTIONS, appId: APPID }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: ALERT_APP_EVENT_FILTER, + retry: false, + }, + }); + }); + + it('should create a function with a run method', () => { + const func = crashlytics.onOperation( + ALERT_TYPE, + (event) => event, + undefined + ); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + }); + + describe('getOptsAndApp', () => { + it('should parse a string', () => { + const APPID = '123456789'; + + const [opts, appId] = crashlytics.getOptsAndApp(APPID); + + expect(opts).to.deep.equal({}); + expect(appId).to.equal(APPID); + }); + + it('should parse an options object without appId', () => { + const myOpts: crashlytics.CrashlyticsOptions = { + region: 'us-west1', + }; + + const [opts, appId] = crashlytics.getOptsAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(appId).to.be.undefined; + }); + + it('should parse an options object with appId', () => { + const myOpts: crashlytics.CrashlyticsOptions = { + appId: '123456789', + region: 'us-west1', + }; + + const [opts, appId] = crashlytics.getOptsAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(appId).to.equal(myOpts.appId); + }); + }); +}); diff --git a/spec/v2/providers/alerts/performance.spec.ts b/spec/v2/providers/alerts/performance.spec.ts new file mode 100644 index 000000000..99f99ddc7 --- /dev/null +++ b/spec/v2/providers/alerts/performance.spec.ts @@ -0,0 +1,168 @@ +import { expect } from 'chai'; +import * as alerts from '../../../../src/v2/providers/alerts'; +import * as performance from '../../../../src/v2/providers/alerts/performance'; +import { FULL_ENDPOINT, FULL_OPTIONS } from '../fixtures'; + +const APPID = '123456789'; +const myHandler = () => 42; + +const APP_EVENT_FILTER = { + appid: APPID, +}; + +describe('performance', () => { + describe('onThresholdAlertPublished', () => { + it('should create a function with alertType & appId', () => { + const func = performance.onThresholdAlertPublished(APPID, myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + ...APP_EVENT_FILTER, + alerttype: performance.thresholdAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = performance.onThresholdAlertPublished( + { ...FULL_OPTIONS }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: performance.thresholdAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with appid in opts', () => { + const func = performance.onThresholdAlertPublished( + { ...FULL_OPTIONS, appId: APPID }, + myHandler + ); + + expect(func.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + ...APP_EVENT_FILTER, + alerttype: performance.thresholdAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function without opts or appId', () => { + const func = performance.onThresholdAlertPublished(myHandler); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: alerts.eventType, + eventFilters: { + alerttype: performance.thresholdAlert, + }, + retry: false, + }, + }); + }); + + it('should create a function with a run method', () => { + const func = performance.onThresholdAlertPublished( + APPID, + (event) => event + ); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + }); + + describe('getOptsAndApp', () => { + it('should parse a string', () => { + const [opts, appId] = performance.getOptsAndApp(APPID); + + expect(opts).to.deep.equal({}); + expect(appId).to.equal(APPID); + }); + + it('should parse an options object without appId', () => { + const myOpts: performance.PerformanceOptions = { + region: 'us-west1', + }; + + const [opts, appId] = performance.getOptsAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(appId).to.be.undefined; + }); + + it('should parse an options object with appId', () => { + const myOpts: performance.PerformanceOptions = { + appId: APPID, + region: 'us-west1', + }; + + const [opts, appId] = performance.getOptsAndApp(myOpts); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(appId).to.equal(APPID); + }); + }); + + describe('convertPayload', () => { + it('should return the same payload', () => { + const payload = { + a: 'b', + conditionPercentile: 23, + appVersion: '3', + }; + + const convertedPayload = performance.convertPayload(payload as any); + + expect(convertedPayload).to.deep.eq(payload); + }); + + it('should return the same payload if the fields are undefined', () => { + const payload = { + a: 'b', + }; + + const convertedPayload = performance.convertPayload(payload as any); + + expect(convertedPayload).to.deep.eq({ + a: 'b', + }); + }); + + it('should remove fields', () => { + const payload = { + a: 'b', + conditionPercentile: 0, + appVersion: '', + }; + + const convertedPayload = performance.convertPayload(payload as any); + + expect(convertedPayload).to.deep.eq({ + a: 'b', + }); + }); + }); +}); diff --git a/spec/v2/providers/database.spec.ts b/spec/v2/providers/database.spec.ts new file mode 100644 index 000000000..f700c58d3 --- /dev/null +++ b/spec/v2/providers/database.spec.ts @@ -0,0 +1,569 @@ +// 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 { PathPattern } from '../../../src/utilities/path-pattern'; +import * as database from '../../../src/v2/providers/database'; + +const RAW_RTDB_EVENT: database.RawRTDBCloudEvent = { + data: { + ['@type']: + 'type.googleapis.com/google.events.firebase.database.v1.ReferenceEventData', + data: {}, + delta: {}, + }, + firebasedatabasehost: 'firebaseio.com', + instance: 'my-instance', + ref: 'foo/bar', + location: 'us-central1', + id: 'id', + source: 'source', + specversion: '1.0', + time: 'time', + type: 'type', +}; + +describe('database', () => { + describe('makeParams', () => { + it('should make params with basic path', () => { + const event: database.RawRTDBCloudEvent = { + ...RAW_RTDB_EVENT, + ref: 'match_a/something/else/nothing/end/match_b', + }; + + expect( + database.makeParams( + event, + new PathPattern('{a}/something/else/*/end/{b}'), + new PathPattern('*') + ) + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + }); + }); + + it('should make params with multi segment path', () => { + const event: database.RawRTDBCloudEvent = { + ...RAW_RTDB_EVENT, + ref: 'something/is/a/thing/else/match_a/hello/match_b/world', + }; + + expect( + database.makeParams( + event, + new PathPattern('something/**/else/{a}/hello/{b}/world'), + new PathPattern('*') + ) + ).to.deep.equal({ + a: 'match_a', + b: 'match_b', + }); + }); + + it('should make params with multi segment path capture', () => { + const event: database.RawRTDBCloudEvent = { + ...RAW_RTDB_EVENT, + ref: 'something/is/a/thing/else/match_a/hello/match_b/world', + }; + + expect( + database.makeParams( + event, + new PathPattern('something/{path=**}/else/{a}/hello/{b}/world'), + new PathPattern('*') + ) + ).to.deep.equal({ + path: 'is/a/thing', + a: 'match_a', + b: 'match_b', + }); + }); + + it('should make params for a full path and instance', () => { + const event: database.RawRTDBCloudEvent = { + ...RAW_RTDB_EVENT, + ref: 'something/is/a/thing/else/match_a/hello/match_b/world', + }; + + expect( + database.makeParams( + event, + new PathPattern('something/{path=**}/else/{a}/hello/{b}/world'), + new PathPattern('{inst}') + ) + ).to.deep.equal({ + path: 'is/a/thing', + a: 'match_a', + b: 'match_b', + inst: 'my-instance', + }); + }); + }); + + describe('getOpts', () => { + it('should return opts when passed in a path', () => { + expect(database.getOpts('/foo/{bar}/')).to.deep.equal({ + path: 'foo/{bar}', + instance: '*', + opts: {}, + }); + }); + + it('should return opts when passed in an options object', () => { + expect( + database.getOpts({ + ref: '/foo/{bar}/', + instance: '{inst}', + region: 'us-central1', + }) + ).to.deep.equal({ + path: 'foo/{bar}', + instance: '{inst}', + opts: { + region: 'us-central1', + }, + }); + }); + }); + + describe('makeEndpoint', () => { + it('should create an endpoint with an instance wildcard', () => { + const ep = database.makeEndpoint( + database.writtenEventType, + { + region: 'us-central1', + labels: { 1: '2' }, + }, + new PathPattern('foo/bar'), + new PathPattern('{inst}') + ); + + expect(ep).to.deep.equal({ + platform: 'gcfv2', + labels: { + 1: '2', + }, + region: ['us-central1'], + eventTrigger: { + eventType: database.writtenEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/bar', + instance: '{inst}', + }, + retry: false, + }, + }); + }); + + it('should create an endpoint without an instance wildcard', () => { + const ep = database.makeEndpoint( + database.writtenEventType, + { + region: 'us-central1', + labels: { 1: '2' }, + }, + new PathPattern('foo/bar'), + new PathPattern('my-instance') + ); + + expect(ep).to.deep.equal({ + platform: 'gcfv2', + labels: { + 1: '2', + }, + region: ['us-central1'], + eventTrigger: { + eventType: database.writtenEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/bar', + }, + retry: false, + }, + }); + }); + }); + + describe('onChangedOperation', () => { + it('should create a function for a written event', () => { + const func = database.onChangedOperation( + database.writtenEventType, + '/foo/{bar}/', + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.writtenEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a function for a updated event', () => { + const func = database.onChangedOperation( + database.updatedEventType, + '/foo/{bar}/', + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.updatedEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a complex function', () => { + const func = database.onChangedOperation( + database.writtenEventType, + { + ref: '/foo/{path=**}/{bar}/', + instance: 'my-instance', + region: 'us-central1', + cpu: 'gcf_gen1', + minInstances: 2, + }, + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + cpu: 'gcf_gen1', + minInstances: 2, + region: ['us-central1'], + labels: {}, + eventTrigger: { + eventType: database.writtenEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/{path=**}/{bar}', + }, + retry: false, + }, + }); + }); + }); + + describe('onOperation', () => { + it('should create a function for a created event', () => { + const func = database.onOperation( + database.createdEventType, + '/foo/{bar}/', + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.createdEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a function for a deleted event', () => { + const func = database.onOperation( + database.deletedEventType, + '/foo/{bar}/', + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.deletedEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a complex function', () => { + const func = database.onOperation( + database.createdEventType, + { + ref: '/foo/{path=**}/{bar}/', + instance: 'my-instance', + region: 'us-central1', + cpu: 'gcf_gen1', + minInstances: 2, + }, + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + cpu: 'gcf_gen1', + minInstances: 2, + region: ['us-central1'], + labels: {}, + eventTrigger: { + eventType: database.createdEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/{path=**}/{bar}', + }, + retry: false, + }, + }); + }); + }); + + describe('onValueWritten', () => { + it('should create a function with a reference', () => { + const func = database.onValueWritten('/foo/{bar}/', (event) => 2); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.writtenEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = database.onValueWritten( + { + ref: '/foo/{path=**}/{bar}/', + instance: 'my-instance', + region: 'us-central1', + cpu: 'gcf_gen1', + minInstances: 2, + }, + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + cpu: 'gcf_gen1', + minInstances: 2, + region: ['us-central1'], + labels: {}, + eventTrigger: { + eventType: database.writtenEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/{path=**}/{bar}', + }, + retry: false, + }, + }); + }); + }); + + describe('onValueCreated', () => { + it('should create a function with a reference', () => { + const func = database.onValueCreated('/foo/{bar}/', (event) => 2); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.createdEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = database.onValueCreated( + { + ref: '/foo/{path=**}/{bar}/', + instance: 'my-instance', + region: 'us-central1', + cpu: 'gcf_gen1', + minInstances: 2, + }, + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + cpu: 'gcf_gen1', + minInstances: 2, + region: ['us-central1'], + labels: {}, + eventTrigger: { + eventType: database.createdEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/{path=**}/{bar}', + }, + retry: false, + }, + }); + }); + }); + + describe('onValueUpdated', () => { + it('should create a function with a reference', () => { + const func = database.onValueUpdated('/foo/{bar}/', (event) => 2); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.updatedEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = database.onValueUpdated( + { + ref: '/foo/{path=**}/{bar}/', + instance: 'my-instance', + region: 'us-central1', + cpu: 'gcf_gen1', + minInstances: 2, + }, + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + cpu: 'gcf_gen1', + minInstances: 2, + region: ['us-central1'], + labels: {}, + eventTrigger: { + eventType: database.updatedEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/{path=**}/{bar}', + }, + retry: false, + }, + }); + }); + }); + + describe('onValueDeleted', () => { + it('should create a function with a reference', () => { + const func = database.onValueDeleted('/foo/{bar}/', (event) => 2); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + eventType: database.deletedEventType, + eventFilters: {}, + eventFilterPathPatterns: { + ref: 'foo/{bar}', + instance: '*', + }, + retry: false, + }, + }); + }); + + it('should create a function with opts', () => { + const func = database.onValueDeleted( + { + ref: '/foo/{path=**}/{bar}/', + instance: 'my-instance', + region: 'us-central1', + cpu: 'gcf_gen1', + minInstances: 2, + }, + (event) => 2 + ); + + expect(func.__endpoint).to.deep.equal({ + platform: 'gcfv2', + cpu: 'gcf_gen1', + minInstances: 2, + region: ['us-central1'], + labels: {}, + eventTrigger: { + eventType: database.deletedEventType, + eventFilters: { + instance: 'my-instance', + }, + eventFilterPathPatterns: { + ref: 'foo/{path=**}/{bar}', + }, + retry: false, + }, + }); + }); + }); +}); diff --git a/spec/v2/providers/eventarc.spec.ts b/spec/v2/providers/eventarc.spec.ts new file mode 100644 index 000000000..96bd48940 --- /dev/null +++ b/spec/v2/providers/eventarc.spec.ts @@ -0,0 +1,147 @@ +// 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 options from '../../../src/v2/options'; +import * as eventarc from '../../../src/v2/providers/eventarc'; +import { FULL_ENDPOINT, FULL_OPTIONS } from './fixtures'; + +const ENDPOINT_EVENT_TRIGGER = { + eventType: 'event-type', + retry: false, + eventFilters: {}, +}; + +describe('v2/eventarc', () => { + describe('onCustomEventPublished', () => { + beforeEach(() => { + process.env.GCLOUD_PROJECT = 'aProject'; + }); + + afterEach(() => { + options.setGlobalOptions({}); + delete process.env.GCLOUD_PROJECT; + }); + + it('should create a minimal trigger/endpoint with default channel', () => { + const result = eventarc.onCustomEventPublished('event-type', () => 42); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_EVENT_TRIGGER, + channel: 'locations/us-central1/channels/firebase', + }, + }); + }); + + it('should create a minimal trigger/endpoint with opts', () => { + const result = eventarc.onCustomEventPublished( + { eventType: 'event-type', region: 'us-west1' }, + () => 42 + ); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_EVENT_TRIGGER, + channel: 'locations/us-central1/channels/firebase', + }, + region: ['us-west1'], + }); + }); + + it('should create a minimal trigger with channel with opts', () => { + const result = eventarc.onCustomEventPublished( + { + eventType: 'event-type', + channel: 'locations/us-west1/channels/my-channel', + filters: { foo: 'bar' }, + }, + () => 42 + ); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_EVENT_TRIGGER, + channel: 'locations/us-west1/channels/my-channel', + eventFilters: { + foo: 'bar', + }, + }, + }); + }); + + it('should create a complex trigger/endpoint with appropriate values', () => { + const result = eventarc.onCustomEventPublished( + { + ...FULL_OPTIONS, + eventType: 'event-type', + channel: 'locations/us-west1/channels/my-channel', + }, + () => 42 + ); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: { + ...ENDPOINT_EVENT_TRIGGER, + channel: 'locations/us-west1/channels/my-channel', + }, + }); + }); + + it('should merge options and globalOptions', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + }); + + const result = eventarc.onCustomEventPublished( + { + eventType: 'event-type', + channel: 'locations/us-west1/channels/my-channel', + region: 'us-west1', + minInstances: 3, + }, + () => 42 + ); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + concurrency: 20, + minInstances: 3, + region: ['us-west1'], + labels: {}, + eventTrigger: { + ...ENDPOINT_EVENT_TRIGGER, + channel: 'locations/us-west1/channels/my-channel', + }, + }); + }); + }); +}); diff --git a/spec/v2/providers/fixtures.ts b/spec/v2/providers/fixtures.ts new file mode 100644 index 000000000..f330efed1 --- /dev/null +++ b/spec/v2/providers/fixtures.ts @@ -0,0 +1,60 @@ +import { ManifestEndpoint } from '../../../src/runtime/manifest'; +import { TriggerAnnotation } from '../../../src/v2/core'; +import * as options from '../../../src/v2/options'; + +export const FULL_OPTIONS: options.GlobalOptions = { + region: 'us-west1', + memory: '512MiB', + timeoutSeconds: 60, + minInstances: 1, + maxInstances: 3, + concurrency: 20, + vpcConnector: 'aConnector', + vpcConnectorEgressSettings: 'ALL_TRAFFIC', + serviceAccount: 'root@', + ingressSettings: 'ALLOW_ALL', + cpu: 'gcf_gen1', + labels: { + hello: 'world', + }, + secrets: ['MY_SECRET'], +}; + +export const FULL_TRIGGER: TriggerAnnotation = { + platform: 'gcfv2', + regions: ['us-west1'], + availableMemoryMb: 512, + timeout: '60s', + minInstances: 1, + maxInstances: 3, + concurrency: 20, + vpcConnector: 'aConnector', + vpcConnectorEgressSettings: 'ALL_TRAFFIC', + serviceAccountEmail: 'root@aProject.iam.gserviceaccount.com', + ingressSettings: 'ALLOW_ALL', + labels: { + hello: 'world', + }, + secrets: ['MY_SECRET'], +}; + +export const FULL_ENDPOINT: ManifestEndpoint = { + platform: 'gcfv2', + region: ['us-west1'], + availableMemoryMb: 512, + timeoutSeconds: 60, + minInstances: 1, + maxInstances: 3, + concurrency: 20, + vpc: { + connector: 'aConnector', + egressSettings: 'ALL_TRAFFIC', + }, + serviceAccountEmail: 'root@', + ingressSettings: 'ALLOW_ALL', + cpu: 'gcf_gen1', + labels: { + hello: 'world', + }, + secretEnvironmentVariables: [{ key: 'MY_SECRET' }], +}; diff --git a/spec/v2/providers/https.spec.ts b/spec/v2/providers/https.spec.ts new file mode 100644 index 000000000..65e573849 --- /dev/null +++ b/spec/v2/providers/https.spec.ts @@ -0,0 +1,444 @@ +// 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 sinon from 'sinon'; + +import * as debug from '../../../src/common/debug'; +import * as options from '../../../src/v2/options'; +import * as https from '../../../src/v2/providers/https'; +import { + expectedResponseHeaders, + MockRequest, +} from '../../fixtures/mockrequest'; +import { runHandler } from '../../helper'; +import { FULL_ENDPOINT, FULL_OPTIONS, FULL_TRIGGER } from './fixtures'; + +describe('onRequest', () => { + beforeEach(() => { + options.setGlobalOptions({}); + process.env.GCLOUD_PROJECT = 'aProject'; + }); + + afterEach(() => { + delete process.env.GCLOUD_PROJECT; + }); + + it('should return a minimal trigger/endpoint with appropriate values', () => { + const result = https.onRequest((req, res) => { + res.send(200); + }); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + httpsTrigger: { + allowInsecure: false, + }, + labels: {}, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + httpsTrigger: {}, + labels: {}, + }); + }); + + it('should create a complex trigger/endpoint with appropriate values', () => { + const result = https.onRequest( + { + ...FULL_OPTIONS, + region: ['us-west1', 'us-central1'], + invoker: ['service-account1@', 'service-account2@'], + }, + (req, res) => { + res.send(200); + } + ); + + expect(result.__trigger).to.deep.equal({ + ...FULL_TRIGGER, + httpsTrigger: { + allowInsecure: false, + invoker: ['service-account1@', 'service-account2@'], + }, + regions: ['us-west1', 'us-central1'], + }); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + httpsTrigger: { + invoker: ['service-account1@', 'service-account2@'], + }, + region: ['us-west1', 'us-central1'], + }); + }); + + it('should merge options and globalOptions', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + invoker: 'public', + }); + + const result = https.onRequest( + { + region: ['us-west1', 'us-central1'], + minInstances: 3, + invoker: 'private', + }, + (req, res) => { + res.send(200); + } + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + httpsTrigger: { + allowInsecure: false, + invoker: ['private'], + }, + concurrency: 20, + minInstances: 3, + regions: ['us-west1', 'us-central1'], + labels: {}, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + httpsTrigger: { + invoker: ['private'], + }, + concurrency: 20, + minInstances: 3, + region: ['us-west1', 'us-central1'], + labels: {}, + }); + }); + + it('should be an express handler', async () => { + const func = https.onRequest((req, res) => { + res.send('Works'); + }); + + const req = new MockRequest( + { + data: {}, + }, + { + 'content-type': 'application/json', + origin: 'example.com', + } + ); + req.method = 'POST'; + + const resp = await runHandler(func, req as any); + expect(resp.body).to.equal('Works'); + }); + + it('should enforce CORS options', async () => { + const func = https.onRequest({ cors: 'example.com' }, (req, res) => { + throw new Error('Should not reach here for OPTIONS preflight'); + }); + + const req = new MockRequest( + { + data: {}, + }, + { + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'origin', + origin: 'example.com', + } + ); + req.method = 'OPTIONS'; + + const resp = await runHandler(func, req as any); + expect(resp.status).to.equal(204); + expect(resp.body).to.be.undefined; + expect(resp.headers).to.deep.equal({ + 'Access-Control-Allow-Methods': 'GET,HEAD,PUT,PATCH,POST,DELETE', + 'Access-Control-Allow-Origin': 'example.com', + 'Content-Length': '0', + Vary: 'Origin, Access-Control-Request-Headers', + }); + }); + + it('should add CORS headers if debug feature is enabled', async () => { + sinon + .stub(debug, 'isDebugFeatureEnabled') + .withArgs('enableCors') + .returns(true); + + const func = https.onRequest((req, res) => { + throw new Error('Should not reach here for OPTIONS preflight'); + }); + + const req = new MockRequest( + { + data: {}, + }, + { + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'origin', + origin: 'localhost', + } + ); + req.method = 'OPTIONS'; + + const resp = await runHandler(func, req as any); + expect(resp.status).to.equal(204); + expect(resp.body).to.be.undefined; + expect(resp.headers).to.deep.equal({ + 'Access-Control-Allow-Methods': 'GET,HEAD,PUT,PATCH,POST,DELETE', + 'Access-Control-Allow-Origin': 'localhost', + 'Content-Length': '0', + Vary: 'Origin, Access-Control-Request-Headers', + }); + + sinon.restore(); + }); +}); + +describe('onCall', () => { + beforeEach(() => { + options.setGlobalOptions({}); + process.env.GCLOUD_PROJECT = 'aProject'; + }); + + afterEach(() => { + delete process.env.GCLOUD_PROJECT; + }); + + it('should return a minimal trigger/endpoint with appropriate values', () => { + const result = https.onCall((request) => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + httpsTrigger: { + allowInsecure: false, + }, + labels: { + 'deployment-callable': 'true', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + callableTrigger: {}, + labels: {}, + }); + }); + + it('should create a complex trigger/endpoint with appropriate values', () => { + const result = https.onCall(FULL_OPTIONS, (request) => 42); + + expect(result.__trigger).to.deep.equal({ + ...FULL_TRIGGER, + httpsTrigger: { + allowInsecure: false, + }, + labels: { + ...FULL_TRIGGER.labels, + 'deployment-callable': 'true', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + callableTrigger: {}, + }); + }); + + it('should merge options and globalOptions', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + }); + + const result = https.onCall( + { + region: ['us-west1', 'us-central1'], + minInstances: 3, + }, + (request) => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + httpsTrigger: { + allowInsecure: false, + }, + concurrency: 20, + minInstances: 3, + regions: ['us-west1', 'us-central1'], + labels: { + 'deployment-callable': 'true', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + callableTrigger: {}, + concurrency: 20, + minInstances: 3, + region: ['us-west1', 'us-central1'], + labels: {}, + }); + }); + + it('has a .run method', () => { + const cf = https.onCall((request) => { + return request; + }); + + const request: any = { + data: 'data', + instanceIdToken: 'token', + auth: { + uid: 'abc', + token: 'token', + }, + }; + expect(cf.run(request)).to.deep.equal(request); + }); + + it('should be an express handler', async () => { + const func = https.onCall((request) => 42); + + const req = new MockRequest( + { + data: {}, + }, + { + 'content-type': 'application/json', + origin: 'example.com', + } + ); + req.method = 'POST'; + + const resp = await runHandler(func, req as any); + expect(resp.body).to.deep.equal({ result: 42 }); + }); + + it('should enforce CORS options', async () => { + const func = https.onCall({ cors: 'example.com' }, (request) => { + throw new Error('Should not reach here for OPTIONS preflight'); + }); + + const req = new MockRequest( + { + data: {}, + }, + { + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'origin', + origin: 'example.com', + } + ); + req.method = 'OPTIONS'; + + const resp = await runHandler(func, req as any); + expect(resp.status).to.equal(204); + expect(resp.body).to.be.undefined; + expect(resp.headers).to.deep.equal({ + 'Access-Control-Allow-Methods': 'POST', + 'Access-Control-Allow-Origin': 'example.com', + 'Content-Length': '0', + Vary: 'Origin, Access-Control-Request-Headers', + }); + }); + + it('overrides CORS headers if debug feature is enabled', async () => { + sinon + .stub(debug, 'isDebugFeatureEnabled') + .withArgs('enableCors') + .returns(true); + + const func = https.onCall({ cors: 'example.com' }, (request) => { + throw new Error('Should not reach here for OPTIONS preflight'); + }); + const req = new MockRequest( + { + data: {}, + }, + { + 'Access-Control-Request-Method': 'POST', + 'Access-Control-Request-Headers': 'origin', + origin: 'localhost', + } + ); + req.method = 'OPTIONS'; + + const response = await runHandler(func, req as any); + + expect(response.status).to.equal(204); + expect(response.body).to.be.undefined; + expect(response.headers).to.deep.equal({ + 'Access-Control-Allow-Methods': 'POST', + 'Access-Control-Allow-Origin': 'localhost', + 'Content-Length': '0', + Vary: 'Origin, Access-Control-Request-Headers', + }); + + sinon.restore(); + }); + + it('adds CORS headers', async () => { + const func = https.onCall((request) => 42); + const req = new MockRequest( + { + data: {}, + }, + { + 'content-type': 'application/json', + origin: 'example.com', + } + ); + req.method = 'POST'; + + const response = await runHandler(func, req as any); + + expect(response.status).to.equal(200); + expect(response.body).to.be.deep.equal({ result: 42 }); + expect(response.headers).to.deep.equal(expectedResponseHeaders); + }); + + // These tests pass if the code transpiles + it('allows desirable syntax', () => { + https.onCall( + (request: https.CallableRequest) => `hello, ${request.data}!` + ); + https.onCall( + (request: https.CallableRequest) => `hello, ${request.data}!` + ); + https.onCall( + (request: https.CallableRequest) => `hello, ${request.data}!` + ); + https.onCall( + (request: https.CallableRequest) => `Hello, ${request.data}` + ); + https.onCall((request: https.CallableRequest) => `Hello, ${request.data}`); + }); +}); diff --git a/spec/v2/providers/identity.spec.ts b/spec/v2/providers/identity.spec.ts new file mode 100644 index 000000000..4c8b19d3d --- /dev/null +++ b/spec/v2/providers/identity.spec.ts @@ -0,0 +1,277 @@ +// 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 identity from '../../../src/v2/providers/identity'; + +const BEFORE_CREATE_TRIGGER = { + eventType: 'providers/cloud.auth/eventTypes/user.beforeCreate', + options: { + accessToken: false, + idToken: false, + refreshToken: false, + }, +}; + +const BEFORE_SIGN_IN_TRIGGER = { + eventType: 'providers/cloud.auth/eventTypes/user.beforeSignIn', + options: { + accessToken: false, + idToken: false, + refreshToken: false, + }, +}; + +const opts: identity.BlockingOptions = { + accessToken: true, + refreshToken: false, + minInstances: 1, + region: 'us-west1', +}; + +describe('identity', () => { + describe('beforeUserCreated', () => { + it('should accept a handler', () => { + const fn = identity.beforeUserCreated((event) => Promise.resolve()); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + blockingTrigger: BEFORE_CREATE_TRIGGER, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should accept options and a handler', () => { + const fn = identity.beforeUserCreated(opts, (event) => Promise.resolve()); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + minInstances: 1, + region: ['us-west1'], + blockingTrigger: { + ...BEFORE_CREATE_TRIGGER, + options: { + ...BEFORE_CREATE_TRIGGER.options, + accessToken: true, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + }); + + describe('beforeUserSignedIn', () => { + it('should accept a handler', () => { + const fn = identity.beforeUserSignedIn((event) => Promise.resolve()); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + blockingTrigger: BEFORE_SIGN_IN_TRIGGER, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should accept options and a handler', () => { + const fn = identity.beforeUserSignedIn(opts, (event) => + Promise.resolve() + ); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + minInstances: 1, + region: ['us-west1'], + blockingTrigger: { + ...BEFORE_SIGN_IN_TRIGGER, + options: { + ...BEFORE_SIGN_IN_TRIGGER.options, + accessToken: true, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + }); + + describe('beforeOperation', () => { + it('should handle eventType and handler for before create events', () => { + const fn = identity.beforeOperation( + 'beforeCreate', + (event) => Promise.resolve(), + undefined + ); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + blockingTrigger: BEFORE_CREATE_TRIGGER, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should handle eventType and handler for before sign in events', () => { + const fn = identity.beforeOperation( + 'beforeSignIn', + (event) => Promise.resolve(), + undefined + ); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + blockingTrigger: BEFORE_SIGN_IN_TRIGGER, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should handle eventType, options, and handler for before create events', () => { + const fn = identity.beforeOperation('beforeCreate', opts, (event) => + Promise.resolve() + ); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + minInstances: 1, + region: ['us-west1'], + blockingTrigger: { + ...BEFORE_CREATE_TRIGGER, + options: { + ...BEFORE_CREATE_TRIGGER.options, + accessToken: true, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + + it('should handle eventType, options, and handler for before sign in events', () => { + const fn = identity.beforeOperation('beforeSignIn', opts, (event) => + Promise.resolve() + ); + + expect(fn.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + minInstances: 1, + region: ['us-west1'], + blockingTrigger: { + ...BEFORE_SIGN_IN_TRIGGER, + options: { + ...BEFORE_SIGN_IN_TRIGGER.options, + accessToken: true, + }, + }, + }); + expect(fn.__requiredAPIs).to.deep.equal([ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]); + }); + }); + + describe('getOpts', () => { + it('should parse an empty object', () => { + const internalOpts = identity.getOpts({}); + + expect(internalOpts).to.deep.equal({ + opts: {}, + accessToken: false, + idToken: false, + refreshToken: false, + }); + }); + + it('should parse global options', () => { + const internalOpts = identity.getOpts({ region: 'us-central1', cpu: 2 }); + + expect(internalOpts).to.deep.equal({ + opts: { + region: 'us-central1', + cpu: 2, + }, + accessToken: false, + idToken: false, + refreshToken: false, + }); + }); + + it('should a full options', () => { + const internalOpts = identity.getOpts({ + region: 'us-central1', + cpu: 2, + accessToken: true, + idToken: false, + refreshToken: true, + }); + + expect(internalOpts).to.deep.equal({ + opts: { + region: 'us-central1', + cpu: 2, + }, + accessToken: true, + idToken: false, + refreshToken: true, + }); + }); + }); +}); diff --git a/spec/v2/providers/pubsub.spec.ts b/spec/v2/providers/pubsub.spec.ts new file mode 100644 index 000000000..395dadace --- /dev/null +++ b/spec/v2/providers/pubsub.spec.ts @@ -0,0 +1,191 @@ +import { expect } from 'chai'; + +import { CloudEvent } from '../../../src/v2/core'; +import * as options from '../../../src/v2/options'; +import * as pubsub from '../../../src/v2/providers/pubsub'; +import { FULL_ENDPOINT, FULL_OPTIONS, FULL_TRIGGER } from './fixtures'; + +const EVENT_TRIGGER = { + eventType: 'google.cloud.pubsub.topic.v1.messagePublished', + resource: 'projects/aProject/topics/topic', +}; + +const ENDPOINT_EVENT_TRIGGER = { + eventType: 'google.cloud.pubsub.topic.v1.messagePublished', + eventFilters: { + topic: 'topic', + }, + retry: false, +}; + +describe('onMessagePublished', () => { + beforeEach(() => { + options.setGlobalOptions({}); + process.env.GCLOUD_PROJECT = 'aProject'; + }); + + afterEach(() => { + delete process.env.GCLOUD_PROJECT; + }); + + it('should return a minimal trigger/endpoint with appropriate values', () => { + const result = pubsub.onMessagePublished('topic', () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + eventTrigger: EVENT_TRIGGER, + labels: {}, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + eventTrigger: ENDPOINT_EVENT_TRIGGER, + labels: {}, + }); + }); + + it('should create a complex trigger/endpoint with appropriate values', () => { + const result = pubsub.onMessagePublished( + { ...FULL_OPTIONS, topic: 'topic' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + ...FULL_TRIGGER, + eventTrigger: EVENT_TRIGGER, + }); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: ENDPOINT_EVENT_TRIGGER, + }); + }); + + it('should merge options and globalOptions', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + }); + + const result = pubsub.onMessagePublished( + { + topic: 'topic', + region: 'us-west1', + minInstances: 3, + }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + concurrency: 20, + minInstances: 3, + regions: ['us-west1'], + labels: {}, + eventTrigger: EVENT_TRIGGER, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + concurrency: 20, + minInstances: 3, + region: ['us-west1'], + labels: {}, + eventTrigger: ENDPOINT_EVENT_TRIGGER, + }); + }); + + it('should convert retry option if appropriate', () => { + const result = pubsub.onMessagePublished( + { + topic: 'topic', + region: 'us-west1', + minInstances: 3, + retry: true, + }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + minInstances: 3, + regions: ['us-west1'], + labels: {}, + eventTrigger: EVENT_TRIGGER, + failurePolicy: { retry: true }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + minInstances: 3, + region: ['us-west1'], + labels: {}, + eventTrigger: { ...ENDPOINT_EVENT_TRIGGER, retry: true }, + }); + }); + + it('should have a .run method', () => { + const func = pubsub.onMessagePublished('topic', (event) => event); + + const res = func.run('input' as any); + + expect(res).to.equal('input'); + }); + + it('should parse pubsub messages', () => { + let json: unknown; + const messageJSON = { + messageId: 'uuid', + data: Buffer.from(JSON.stringify({ hello: 'world' })).toString('base64'), + attributes: { key: 'value' }, + orderingKey: 'orderingKey', + publishTime: new Date(Date.now()).toISOString(), + }; + const publishData: pubsub.MessagePublishedData = { + message: messageJSON as any, + subscription: 'projects/aProject/subscriptions/aSubscription', + }; + const event: CloudEvent> = { + specversion: '1.0', + source: '//pubsub.googleapis.com/projects/aProject/topics/topic', + id: 'uuid', + type: EVENT_TRIGGER.eventType, + time: messageJSON.publishTime, + data: publishData, + }; + + const func = pubsub.onMessagePublished('topic', (event) => { + json = event.data.message.json; + return event; + }); + + const eventAgain = func(event); + + // Deep equal uses JSON equality, so we'll still match even though + // Message is a class and we passed an interface. + expect(eventAgain).to.deep.equal(event); + + expect(json).to.deep.equal({ hello: 'world' }); + }); + + // These tests pass if the transpiler works + it('allows desirable syntax', () => { + pubsub.onMessagePublished( + 'topic', + (event: CloudEvent>) => {} + ); + pubsub.onMessagePublished( + 'topic', + (event: CloudEvent) => {} + ); + pubsub.onMessagePublished( + 'topic', + (event: CloudEvent>) => {} + ); + pubsub.onMessagePublished( + 'topic', + (event: CloudEvent) => {} + ); + }); +}); diff --git a/spec/v2/providers/scheduler.spec.ts b/spec/v2/providers/scheduler.spec.ts new file mode 100644 index 000000000..7d690cbe5 --- /dev/null +++ b/spec/v2/providers/scheduler.spec.ts @@ -0,0 +1,140 @@ +// 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 schedule from '../../../src/v2/providers/scheduler'; + +describe('schedule', () => { + describe('getOpts', () => { + it('should handle a schedule', () => { + expect(schedule.getOpts('* * * * *')).to.deep.eq({ + schedule: '* * * * *', + opts: {}, + }); + }); + + it('should handle full options', () => { + const options: schedule.ScheduleOptions = { + schedule: '* * * * *', + timeZone: 'utc', + retryCount: 3, + maxRetrySeconds: 1, + minBackoffSeconds: 2, + maxBackoffSeconds: 3, + maxDoublings: 4, + memory: '128MiB', + region: 'us-central1', + }; + + expect(schedule.getOpts(options)).to.deep.eq({ + schedule: '* * * * *', + timeZone: 'utc', + retryCount: 3, + maxRetrySeconds: 1, + minBackoffSeconds: 2, + maxBackoffSeconds: 3, + maxDoublings: 4, + opts: { + ...options, + memory: '128MiB', + region: 'us-central1', + }, + }); + }); + }); + + describe('onSchedule', () => { + it('should create a schedule function given a schedule', () => { + const schfn = schedule.onSchedule('* * * * *', (event) => console.log(1)); + + expect(schfn.__endpoint).to.deep.eq({ + platform: 'gcfv2', + labels: {}, + scheduleTrigger: { + schedule: '* * * * *', + retryConfig: {}, + }, + }); + expect(schfn.__requiredAPIs).to.deep.eq([ + { + api: 'cloudscheduler.googleapis.com', + reason: 'Needed for scheduled functions.', + }, + ]); + }); + + it('should create a schedule function given options', () => { + const schfn = schedule.onSchedule( + { + schedule: '* * * * *', + timeZone: 'utc', + retryCount: 3, + maxRetrySeconds: 10, + minBackoffSeconds: 11, + maxBackoffSeconds: 12, + maxDoublings: 2, + region: 'us-central1', + labels: { key: 'val' }, + }, + (event) => {} + ); + + expect(schfn.__endpoint).to.deep.eq({ + platform: 'gcfv2', + labels: { key: 'val' }, + region: ['us-central1'], + scheduleTrigger: { + schedule: '* * * * *', + timeZone: 'utc', + retryConfig: { + retryCount: 3, + maxRetrySeconds: 10, + minBackoffSeconds: 11, + maxBackoffSeconds: 12, + maxDoublings: 2, + }, + }, + }); + expect(schfn.__requiredAPIs).to.deep.eq([ + { + api: 'cloudscheduler.googleapis.com', + reason: 'Needed for scheduled functions.', + }, + ]); + }); + + it('should have a .run method', () => { + const testObj = { + foo: 'bar', + }; + const schfn = schedule.onSchedule('* * * * *', (event) => { + testObj.foo = 'newBar'; + }); + + schfn.run('input' as any); + + expect(testObj).to.deep.eq({ + foo: 'newBar', + }); + }); + }); +}); diff --git a/spec/v2/providers/storage.spec.ts b/spec/v2/providers/storage.spec.ts new file mode 100644 index 000000000..4f5221b6a --- /dev/null +++ b/spec/v2/providers/storage.spec.ts @@ -0,0 +1,696 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as config from '../../../src/config'; +import * as options from '../../../src/v2/options'; +import * as storage from '../../../src/v2/providers/storage'; +import { FULL_ENDPOINT, FULL_OPTIONS, FULL_TRIGGER } from './fixtures'; + +const EVENT_TRIGGER = { + eventType: 'event-type', + resource: 'some-bucket', +}; + +const ENDPOINT_EVENT_TRIGGER = { + eventType: 'event-type', + eventFilters: { + bucket: 'some-bucket', + }, + retry: false, +}; + +const DEFAULT_BUCKET_EVENT_FILTER = { + bucket: 'default-bucket', +}; + +const SPECIFIC_BUCKET_EVENT_FILTER = { + bucket: 'my-bucket', +}; + +describe('v2/storage', () => { + describe('getOptsAndBucket', () => { + it('should return the default bucket with empty opts', () => { + const configStub = sinon + .stub(config, 'firebaseConfig') + .returns({ storageBucket: 'default-bucket' }); + + const [opts, bucket] = storage.getOptsAndBucket({}); + + configStub.restore(); + expect(opts).to.deep.equal({}); + expect(bucket).to.eq('default-bucket'); + }); + + it('should return the default bucket with opts param', () => { + const configStub = sinon + .stub(config, 'firebaseConfig') + .returns({ storageBucket: 'default-bucket' }); + + const [opts, bucket] = storage.getOptsAndBucket({ region: 'us-west1' }); + + configStub.restore(); + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(bucket).to.eq('default-bucket'); + }); + + it('should return the given bucket', () => { + const [opts, bucket] = storage.getOptsAndBucket('my-bucket'); + + expect(opts).to.deep.equal({}); + expect(bucket).to.eq('my-bucket'); + }); + + it('should return the given bucket and opts', () => { + const [opts, bucket] = storage.getOptsAndBucket({ + bucket: 'my-bucket', + region: 'us-west1', + }); + + expect(opts).to.deep.equal({ region: 'us-west1' }); + expect(bucket).to.eq('my-bucket'); + }); + }); + + describe('onOperation', () => { + let configStub: sinon.SinonStub; + + beforeEach(() => { + process.env.GCLOUD_PROJECT = 'aProject'; + configStub = sinon.stub(config, 'firebaseConfig'); + }); + + afterEach(() => { + options.setGlobalOptions({}); + delete process.env.GCLOUD_PROJECT; + configStub.restore(); + }); + + it('should create a minimal trigger/endpoint with bucket', () => { + const result = storage.onOperation('event-type', 'some-bucket', () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: EVENT_TRIGGER, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: ENDPOINT_EVENT_TRIGGER, + }); + }); + + it('should create a minimal trigger/endpoint with opts', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onOperation( + 'event-type', + { region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...EVENT_TRIGGER, + resource: 'default-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_EVENT_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + + it('should create a minimal trigger with bucket with opts and bucket', () => { + const result = storage.onOperation( + 'event-type', + { bucket: 'some-bucket' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: EVENT_TRIGGER, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: ENDPOINT_EVENT_TRIGGER, + }); + }); + + it('should create a complex trigger/endpoint with appropriate values', () => { + const result = storage.onOperation( + 'event-type', + { + ...FULL_OPTIONS, + bucket: 'some-bucket', + }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + ...FULL_TRIGGER, + eventTrigger: EVENT_TRIGGER, + }); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + eventTrigger: ENDPOINT_EVENT_TRIGGER, + }); + }); + + it('should merge options and globalOptions', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + }); + + const result = storage.onOperation( + 'event-type', + { + bucket: 'some-bucket', + region: 'us-west1', + minInstances: 3, + }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + concurrency: 20, + minInstances: 3, + regions: ['us-west1'], + labels: {}, + eventTrigger: EVENT_TRIGGER, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + concurrency: 20, + minInstances: 3, + region: ['us-west1'], + labels: {}, + eventTrigger: ENDPOINT_EVENT_TRIGGER, + }); + }); + }); + + describe('onObjectArchived', () => { + const ARCHIVED_TRIGGER = { + ...EVENT_TRIGGER, + eventType: storage.archivedEvent, + }; + const ENDPOINT_ARCHIVED_TRIGGER = { + ...ENDPOINT_EVENT_TRIGGER, + eventType: storage.archivedEvent, + }; + let configStub: sinon.SinonStub; + + beforeEach(() => { + configStub = sinon.stub(config, 'firebaseConfig'); + }); + + afterEach(() => { + configStub.restore(); + }); + + it('should accept only handler', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectArchived(() => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ARCHIVED_TRIGGER, + resource: 'default-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_ARCHIVED_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + }); + }); + + it('should accept bucket and handler', () => { + const result = storage.onObjectArchived('my-bucket', () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ARCHIVED_TRIGGER, + resource: 'my-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_ARCHIVED_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + }); + }); + + it('should accept opts and handler', () => { + const result = storage.onObjectArchived( + { bucket: 'my-bucket', region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ARCHIVED_TRIGGER, + resource: 'my-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_ARCHIVED_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + + it('should accept opts and handler, default bucket', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectArchived({ region: 'us-west1' }, () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ARCHIVED_TRIGGER, + resource: 'default-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_ARCHIVED_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + }); + + describe('onObjectFinalized', () => { + const FINALIZED_TRIGGER = { + ...EVENT_TRIGGER, + eventType: storage.finalizedEvent, + }; + const ENDPOINT_FINALIZED_TRIGGER = { + ...ENDPOINT_EVENT_TRIGGER, + eventType: storage.finalizedEvent, + }; + let configStub: sinon.SinonStub; + + beforeEach(() => { + configStub = sinon.stub(config, 'firebaseConfig'); + }); + + afterEach(() => { + configStub.restore(); + }); + + it('should accept only handler', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectFinalized(() => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...FINALIZED_TRIGGER, + resource: 'default-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_FINALIZED_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + }); + }); + + it('should accept bucket and handler', () => { + const result = storage.onObjectFinalized('my-bucket', () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...FINALIZED_TRIGGER, + resource: 'my-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_FINALIZED_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + }); + }); + + it('should accept opts and handler', () => { + const result = storage.onObjectFinalized( + { bucket: 'my-bucket', region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...FINALIZED_TRIGGER, + resource: 'my-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_FINALIZED_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + + it('should accept opts and handler, default bucket', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectFinalized( + { region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...FINALIZED_TRIGGER, + resource: 'default-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_FINALIZED_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + }); + + describe('onObjectDeleted', () => { + const DELETED_TRIGGER = { + ...EVENT_TRIGGER, + eventType: storage.deletedEvent, + }; + const ENDPOINT_DELETED_TRIGGER = { + ...ENDPOINT_EVENT_TRIGGER, + eventType: storage.deletedEvent, + }; + let configStub: sinon.SinonStub; + + beforeEach(() => { + configStub = sinon.stub(config, 'firebaseConfig'); + }); + + afterEach(() => { + configStub.restore(); + }); + + it('should accept only handler', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectDeleted(() => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...DELETED_TRIGGER, + resource: 'default-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_DELETED_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + }); + + configStub.restore(); + }); + + it('should accept bucket and handler', () => { + const result = storage.onObjectDeleted('my-bucket', () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...DELETED_TRIGGER, + resource: 'my-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_DELETED_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + }); + }); + + it('should accept opts and handler', () => { + const result = storage.onObjectDeleted( + { bucket: 'my-bucket', region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...DELETED_TRIGGER, + resource: 'my-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_DELETED_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + + it('should accept opts and handler, default bucket', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectDeleted({ region: 'us-west1' }, () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...DELETED_TRIGGER, + resource: 'default-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_DELETED_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + }); + + describe('onObjectMetadataUpdated', () => { + const METADATA_TRIGGER = { + ...EVENT_TRIGGER, + eventType: storage.metadataUpdatedEvent, + }; + const ENDPOINT_METADATA_TRIGGER = { + ...ENDPOINT_EVENT_TRIGGER, + eventType: storage.metadataUpdatedEvent, + }; + let configStub: sinon.SinonStub; + + beforeEach(() => { + configStub = sinon.stub(config, 'firebaseConfig'); + }); + + afterEach(() => { + configStub.restore(); + }); + + it('should accept only handler', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectMetadataUpdated(() => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...METADATA_TRIGGER, + resource: 'default-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_METADATA_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + }); + + configStub.restore(); + }); + + it('should accept bucket and handler', () => { + const result = storage.onObjectMetadataUpdated('my-bucket', () => 42); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...METADATA_TRIGGER, + resource: 'my-bucket', + }, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_METADATA_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + }); + }); + + it('should accept opts and handler', () => { + const result = storage.onObjectMetadataUpdated( + { bucket: 'my-bucket', region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...METADATA_TRIGGER, + resource: 'my-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_METADATA_TRIGGER, + eventFilters: SPECIFIC_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + + it('should accept opts and handler, default bucket', () => { + configStub.returns({ storageBucket: 'default-bucket' }); + + const result = storage.onObjectMetadataUpdated( + { region: 'us-west1' }, + () => 42 + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...METADATA_TRIGGER, + resource: 'default-bucket', + }, + regions: ['us-west1'], + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + labels: {}, + eventTrigger: { + ...ENDPOINT_METADATA_TRIGGER, + eventFilters: DEFAULT_BUCKET_EVENT_FILTER, + }, + region: ['us-west1'], + }); + }); + }); +}); diff --git a/spec/v2/providers/tasks.spec.ts b/spec/v2/providers/tasks.spec.ts new file mode 100644 index 000000000..f0f8c9cc5 --- /dev/null +++ b/spec/v2/providers/tasks.spec.ts @@ -0,0 +1,193 @@ +// 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 options from '../../../src/v2/options'; +import { onTaskDispatched, Request } from '../../../src/v2/providers/tasks'; +import { MockRequest } from '../../fixtures/mockrequest'; +import { runHandler } from '../../helper'; +import { FULL_ENDPOINT, FULL_OPTIONS, FULL_TRIGGER } from './fixtures'; + +describe('onTaskDispatched', () => { + beforeEach(() => { + options.setGlobalOptions({}); + process.env.GCLOUD_PROJECT = 'aProject'; + }); + + afterEach(() => { + delete process.env.GCLOUD_PROJECT; + }); + + it('should return a minimal trigger/endpoint with appropriate values', () => { + const result = onTaskDispatched(() => {}); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + taskQueueTrigger: {}, + labels: {}, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + taskQueueTrigger: {}, + labels: {}, + }); + }); + + it('should create a complex trigger/endpoint with appropriate values', () => { + const result = onTaskDispatched( + { + ...FULL_OPTIONS, + retryConfig: { + maxAttempts: 4, + maxRetrySeconds: 10, + maxDoublings: 3, + minBackoffSeconds: 1, + maxBackoffSeconds: 2, + }, + rateLimits: { + maxConcurrentDispatches: 5, + maxDispatchesPerSecond: 10, + }, + invoker: 'private', + }, + () => {} + ); + + expect(result.__trigger).to.deep.equal({ + ...FULL_TRIGGER, + taskQueueTrigger: { + retryConfig: { + maxAttempts: 4, + maxRetrySeconds: 10, + maxDoublings: 3, + minBackoffSeconds: 1, + maxBackoffSeconds: 2, + }, + rateLimits: { + maxConcurrentDispatches: 5, + maxDispatchesPerSecond: 10, + }, + invoker: ['private'], + }, + }); + + expect(result.__endpoint).to.deep.equal({ + ...FULL_ENDPOINT, + platform: 'gcfv2', + taskQueueTrigger: { + retryConfig: { + maxAttempts: 4, + maxRetrySeconds: 10, + maxDoublings: 3, + minBackoffSeconds: 1, + maxBackoffSeconds: 2, + }, + rateLimits: { + maxConcurrentDispatches: 5, + maxDispatchesPerSecond: 10, + }, + invoker: ['private'], + }, + }); + }); + + it('should merge options and globalOptions', () => { + options.setGlobalOptions({ + concurrency: 20, + region: 'europe-west1', + minInstances: 1, + }); + + const result = onTaskDispatched( + { + region: 'us-west1', + minInstances: 3, + }, + (request) => {} + ); + + expect(result.__trigger).to.deep.equal({ + platform: 'gcfv2', + taskQueueTrigger: {}, + concurrency: 20, + minInstances: 3, + regions: ['us-west1'], + labels: {}, + }); + + expect(result.__endpoint).to.deep.equal({ + platform: 'gcfv2', + taskQueueTrigger: {}, + concurrency: 20, + minInstances: 3, + region: ['us-west1'], + labels: {}, + }); + }); + + it('has a .run method', async () => { + const request: any = { data: 'data' }; + const cf = onTaskDispatched((r) => { + expect(r.data).to.deep.equal(request.data); + }); + + await cf.run(request); + }); + + it('should be an express handler', async () => { + const func = onTaskDispatched((request) => {}); + + const req = new MockRequest( + { + data: {}, + }, + { + 'content-type': 'application/json', + authorization: 'Bearer abc', + origin: 'example.com', + } + ); + req.method = 'POST'; + + const resp = await runHandler(func, req as any); + expect(resp.status).to.equal(204); + }); + + // These tests pass if the code transpiles + it('allows desirable syntax', () => { + onTaskDispatched((request: Request) => { + // There should be no lint warnings that data is not a string. + console.log(`hello, ${request.data}`); + }); + onTaskDispatched((request: Request) => { + console.log(`hello, ${request.data}`); + }); + onTaskDispatched((request: Request) => { + console.log(`hello, ${request.data}`); + }); + onTaskDispatched((request: Request) => { + console.log(`Hello, ${request.data}`); + }); + }); +}); diff --git a/src/bin/firebase-functions.ts b/src/bin/firebase-functions.ts new file mode 100644 index 000000000..1be486b8c --- /dev/null +++ b/src/bin/firebase-functions.ts @@ -0,0 +1,82 @@ +#!/usr/bin/env node + +// 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 * as express from 'express'; +import { loadStack } from '../runtime/loader'; +import { stackToWire } from '../runtime/manifest'; + +function printUsageAndExit() { + console.error( + ` +Usage: firebase-functions [functionsDir] + +Arguments: + - functionsDir: Directory containing source code for Firebase Functions. +` + ); + process.exit(1); +} + +let functionsDir = '.'; + +const args = process.argv.slice(2); +if (args.length > 1) { + if (args[0] === '-h' || args[0] === '--help') { + printUsageAndExit(); + } + functionsDir = args[0]; +} + +let server; +const app = express(); + +async function handleQuitquitquit(req: express.Request, res: express.Response) { + res.send('ok'); + server.close(() => console.log('shutdown requested via /__/quitquitquit')); +} + +app.get('/__/quitquitquit', handleQuitquitquit); +app.post('/__/quitquitquit', handleQuitquitquit); + +if (process.env.FUNCTIONS_CONTROL_API === 'true') { + app.get('/__/functions.yaml', async (req, res) => { + try { + const stack = await loadStack(functionsDir); + res.setHeader('content-type', 'text/yaml'); + res.send(JSON.stringify(stackToWire(stack))); + } catch (e) { + res + .status(400) + .send(`Failed to generate manifest from function source: ${e}`); + } + }); +} + +let port = 8080; +if (process.env.PORT) { + port = Number.parseInt(process.env.PORT); +} + +console.log('Serving at port', port); +server = app.listen(port); diff --git a/src/cloud-functions.ts b/src/cloud-functions.ts index e8d099dca..c90bdaea4 100644 --- a/src/cloud-functions.ts +++ b/src/cloud-functions.ts @@ -22,8 +22,24 @@ import { Request, Response } from 'express'; import * as _ from 'lodash'; -import { DeploymentOptions, Schedule } from './function-configuration'; +import { + DEFAULT_FAILURE_POLICY, + DeploymentOptions, + FailurePolicy, + Schedule, +} from './function-configuration'; +import { warn } from './logger'; export { Request, Response }; +import { + convertIfPresent, + copyIfPresent, + Duration, + durationFromSeconds, + serviceAccountFromShorthand, +} from './common/encoding'; +import { ManifestEndpoint, ManifestRequiredAPI } from './runtime/manifest'; + +export { Change } from './common/change'; /** @hidden */ const WILDCARD_REGEX = new RegExp('{[^/{}]*}', 'g'); @@ -39,6 +55,7 @@ export interface Event { timestamp: string; eventType: string; resource: Resource; + domain?: string; }; data: any; } @@ -87,34 +104,32 @@ export interface EventContext { eventId: string; /** - * Type of event. Valid values are: + * Type of event. Possible values are: * - * * `providers/google.firebase.analytics/eventTypes/event.log` - * * `providers/firebase.auth/eventTypes/user.create` - * * `providers/firebase.auth/eventTypes/user.delete` - * * `providers/firebase.crashlytics/eventTypes/issue.new` - * * `providers/firebase.crashlytics/eventTypes/issue.regressed` - * * `providers/firebase.crashlytics/eventTypes/issue.velocityAlert` - * * `providers/google.firebase.database/eventTypes/ref.write` - * * `providers/google.firebase.database/eventTypes/ref.create` - * * `providers/google.firebase.database/eventTypes/ref.update` - * * `providers/google.firebase.database/eventTypes/ref.delete` - * * `providers/cloud.firestore/eventTypes/document.write` - * * `providers/cloud.firestore/eventTypes/document.create` - * * `providers/cloud.firestore/eventTypes/document.update` - * * `providers/cloud.firestore/eventTypes/document.delete` + * * `google.analytics.event.log` + * * `google.firebase.auth.user.create` + * * `google.firebase.auth.user.delete` + * * `google.firebase.database.ref.write` + * * `google.firebase.database.ref.create` + * * `google.firebase.database.ref.update` + * * `google.firebase.database.ref.delete` + * * `google.firestore.document.write` + * * `google.firestore.document.create` + * * `google.firestore.document.update` + * * `google.firestore.document.delete` * * `google.pubsub.topic.publish` + * * `google.firebase.remoteconfig.update` * * `google.storage.object.finalize` * * `google.storage.object.archive` * * `google.storage.object.delete` * * `google.storage.object.metadataUpdate` - * * `google.firebase.remoteconfig.update` + * * `google.testing.testMatrix.complete` */ eventType: string; /** * An object containing the values of the wildcards in the `path` parameter - * provided to the [`ref()`](functions.database#.ref) method for a Realtime + * provided to the [`ref()`](providers_database_.html#ref) method for a Realtime * Database trigger. Cannot be accessed while inside the handler namespace. */ params: { [option: string]: any }; @@ -142,92 +157,6 @@ export interface EventContext { timestamp: string; } -/** - * The Functions interface for events that change state, such as - * Realtime Database or Cloud Firestore `onWrite` and `onUpdate`. - * - * For more information about the format used to construct `Change` objects, see - * [`cloud-functions.ChangeJson`](/docs/reference/functions/cloud_functions_.changejson). - * - */ -export class Change { - constructor(public before: T, public after: T) {} -} - -/** - * `ChangeJson` is the JSON format used to construct a Change object. - */ -export interface ChangeJson { - /** - * Key-value pairs representing state of data after the change. - */ - after?: any; - /** - * Key-value pairs representing state of data before the change. If - * `fieldMask` is set, then only fields that changed are present in `before`. - */ - before?: any; - /** - * @hidden - * Comma-separated string that represents names of fields that changed. - */ - fieldMask?: string; -} - -export namespace Change { - /** @hidden */ - function reinterpretCast(x: any) { - return x as T; - } - - /** - * @hidden - * Factory method for creating a Change from a `before` object and an `after` - * object. - */ - export function fromObjects(before: T, after: T) { - return new Change(before, after); - } - - /** - * @hidden - * Factory method for creating a Change from a JSON and an optional customizer - * function to be applied to both the `before` and the `after` fields. - */ - export function fromJSON( - json: ChangeJson, - customizer: (x: any) => T = reinterpretCast - ): Change { - let before = _.assign({}, json.before); - if (json.fieldMask) { - before = applyFieldMask(before, json.after, json.fieldMask); - } - return Change.fromObjects( - customizer(before || {}), - customizer(json.after || {}) - ); - } - - /** @hidden */ - export function applyFieldMask( - sparseBefore: any, - after: any, - fieldMask: string - ) { - const before = _.assign({}, after); - const masks = fieldMask.split(','); - _.forEach(masks, (mask) => { - const val = _.get(sparseBefore, mask); - if (typeof val === 'undefined') { - _.unset(before, mask); - } else { - _.set(before, mask, val); - } - }); - return before; - } -} - /** * Resource is a standard format for defining a resource * (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the @@ -241,24 +170,33 @@ export interface Resource { } /** - * @hidden - * TriggerAnnotated is used internally by the firebase CLI to understand what + * TriggerAnnotion is used internally by the firebase CLI to understand what * type of Cloud Function to deploy. */ -export interface TriggerAnnotated { - __trigger: { - availableMemoryMb?: number; - eventTrigger?: { - eventType: string; - resource: string; - service: string; - }; - httpsTrigger?: {}; - labels?: { [key: string]: string }; - regions?: string[]; - schedule?: Schedule; - timeout?: string; +interface TriggerAnnotation { + availableMemoryMb?: number; + blockingTrigger?: { + eventType: string; + options?: Record; + }; + eventTrigger?: { + eventType: string; + resource: string; + service: string; + }; + failurePolicy?: FailurePolicy; + httpsTrigger?: { + invoker?: string[]; }; + labels?: { [key: string]: string }; + regions?: string[]; + schedule?: Schedule; + timeout?: Duration; + vpcConnector?: string; + vpcConnectorEgressSettings?: string; + serviceAccountEmail?: string; + ingressSettings?: string; + secrets?: string[]; } /** @@ -278,8 +216,34 @@ export interface Runnable { * [`Response`](https://expressjs.com/en/api.html#res) objects as its only * arguments. */ -export type HttpsFunction = TriggerAnnotated & - ((req: Request, resp: Response) => void); +export interface HttpsFunction { + (req: Request, resp: Response): void | Promise; + + /** @alpha */ + __trigger: TriggerAnnotation; + + /** @alpha */ + __endpoint: ManifestEndpoint; + + /** @alpha */ + __requiredAPIs?: ManifestRequiredAPI[]; +} + +/** + * The Cloud Function type for Blocking triggers. + */ +export interface BlockingFunction { + (req: Request, resp: Response): void | Promise; + + /** @alpha */ + __trigger: TriggerAnnotation; + + /** @alpha */ + __endpoint: ManifestEndpoint; + + /** @alpha */ + __requiredAPIs?: ManifestRequiredAPI[]; +} /** * The Cloud Function type for all non-HTTPS triggers. This should be exported @@ -288,9 +252,18 @@ export type HttpsFunction = TriggerAnnotated & * This type is a special JavaScript function which takes a templated * `Event` object as its only argument. */ -export type CloudFunction = Runnable & - TriggerAnnotated & - ((input: any, context?: any) => PromiseLike | any); +export interface CloudFunction extends Runnable { + (input: any, context?: any): PromiseLike | any; + + /** @alpha */ + __trigger: TriggerAnnotation; + + /** @alpha */ + __endpoint: ManifestEndpoint; + + /** @alpha */ + __requiredAPIs?: ManifestRequiredAPI[]; +} /** @hidden */ export interface MakeCloudFunctionArgs { @@ -300,9 +273,9 @@ export interface MakeCloudFunctionArgs { dataConstructor?: (raw: Event) => EventData; eventType: string; handler?: (data: EventData, context: EventContext) => PromiseLike | any; - labels?: { [key: string]: any }; + labels?: Record; legacyEventType?: string; - options?: { [key: string]: any }; + options?: DeploymentOptions; /* * TODO: should remove `provider` and require a fully qualified `eventType` * once all providers have migrated to new format. @@ -377,7 +350,7 @@ export function makeCloudFunction({ promise = handler(dataOrChange, context); } if (typeof promise === 'undefined') { - console.warn('Function returned undefined, expected Promise or value'); + warn('Function returned undefined, expected Promise or value'); } return Promise.resolve(promise) .then((result) => { @@ -404,12 +377,53 @@ export function makeCloudFunction({ }, }); if (!_.isEmpty(labels)) { - trigger.labels = labels; + trigger.labels = { ...trigger.labels, ...labels }; } return trigger; }, }); + Object.defineProperty(cloudFunction, '__endpoint', { + get: () => { + if (triggerResource() == null) { + return undefined; + } + + const endpoint: ManifestEndpoint = { + platform: 'gcfv1', + ...optionsToEndpoint(options), + }; + + if (options.schedule) { + endpoint.scheduleTrigger = options.schedule; + } else { + endpoint.eventTrigger = { + eventType: legacyEventType || provider + '.' + eventType, + eventFilters: { + resource: triggerResource(), + }, + retry: !!options.failurePolicy, + }; + } + + // Note: We intentionally don't make use of labels args here. + // labels is used to pass SDK-defined labels to the trigger, which isn't + // something we will do in the container contract world. + endpoint.labels = { ...endpoint.labels }; + + return endpoint; + }, + }); + + if (options.schedule) { + cloudFunction.__requiredAPIs = [ + { + api: 'cloudscheduler.googleapis.com', + reason: 'Needed for scheduled functions.', + }, + ]; + } + cloudFunction.run = handler || contextOnlyHandler; return cloudFunction; } @@ -467,24 +481,112 @@ function _detectAuthType(event: Event) { /** @hidden */ export function optionsToTrigger(options: DeploymentOptions) { const trigger: any = {}; - if (options.regions) { - trigger.regions = options.regions; - } - if (options.timeoutSeconds) { - trigger.timeout = options.timeoutSeconds.toString() + 's'; - } - if (options.memory) { + copyIfPresent( + trigger, + options, + 'regions', + 'schedule', + 'minInstances', + 'maxInstances', + 'ingressSettings', + 'vpcConnectorEgressSettings', + 'vpcConnector', + 'labels', + 'secrets' + ); + convertIfPresent( + trigger, + options, + 'failurePolicy', + 'failurePolicy', + (policy) => { + if (policy === false) { + return undefined; + } else if (policy === true) { + return DEFAULT_FAILURE_POLICY; + } else { + return policy; + } + } + ); + convertIfPresent( + trigger, + options, + 'timeout', + 'timeoutSeconds', + durationFromSeconds + ); + convertIfPresent(trigger, options, 'availableMemoryMb', 'memory', (mem) => { const memoryLookup = { '128MB': 128, '256MB': 256, '512MB': 512, '1GB': 1024, '2GB': 2048, + '4GB': 4096, + '8GB': 8192, }; - trigger.availableMemoryMb = _.get(memoryLookup, options.memory); - } - if (options.schedule) { - trigger.schedule = options.schedule; - } + return memoryLookup[mem]; + }); + convertIfPresent( + trigger, + options, + 'serviceAccountEmail', + 'serviceAccount', + serviceAccountFromShorthand + ); + return trigger; } + +export function optionsToEndpoint( + options: DeploymentOptions +): ManifestEndpoint { + const endpoint: ManifestEndpoint = {}; + copyIfPresent( + endpoint, + options, + 'minInstances', + 'maxInstances', + 'ingressSettings', + 'labels', + 'timeoutSeconds' + ); + convertIfPresent(endpoint, options, 'region', 'regions'); + convertIfPresent( + endpoint, + options, + 'serviceAccountEmail', + 'serviceAccount', + (sa) => sa + ); + convertIfPresent( + endpoint, + options, + 'secretEnvironmentVariables', + 'secrets', + (secrets) => secrets.map((secret) => ({ key: secret })) + ); + if (options?.vpcConnector) { + endpoint.vpc = { connector: options.vpcConnector }; + convertIfPresent( + endpoint.vpc, + options, + 'egressSettings', + 'vpcConnectorEgressSettings' + ); + } + convertIfPresent(endpoint, options, 'availableMemoryMb', 'memory', (mem) => { + const memoryLookup = { + '128MB': 128, + '256MB': 256, + '512MB': 512, + '1GB': 1024, + '2GB': 2048, + '4GB': 4096, + '8GB': 8192, + }; + return memoryLookup[mem]; + }); + return endpoint; +} diff --git a/src/common/change.ts b/src/common/change.ts new file mode 100644 index 000000000..c0180e0a0 --- /dev/null +++ b/src/common/change.ts @@ -0,0 +1,109 @@ +// 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. + +/** + * `ChangeJson` is the JSON format used to construct a Change object. + */ +export interface ChangeJson { + /** + * Key-value pairs representing state of data after the change. + */ + after?: any; + /** + * Key-value pairs representing state of data before the change. If + * `fieldMask` is set, then only fields that changed are present in `before`. + */ + before?: any; + /** + * @hidden + * Comma-separated string that represents names of fields that changed. + */ + fieldMask?: string; +} + +/** @hidden */ +export function applyFieldMask( + sparseBefore: any, + after: any, + fieldMask: string +) { + const before = { ...after }; + const masks = fieldMask.split(','); + + for (const mask of masks) { + const parts = mask.split('.'); + const head = parts[0]; + const tail = parts.slice(1).join('.'); + if (parts.length > 1) { + before[head] = applyFieldMask(sparseBefore?.[head], after[head], tail); + continue; + } + const val = sparseBefore?.[head]; + if (typeof val === 'undefined') { + delete before[mask]; + } else { + before[mask] = val; + } + } + + return before; +} + +/** + * The Functions interface for events that change state, such as + * Realtime Database or Cloud Firestore `onWrite` and `onUpdate`. + * + * For more information about the format used to construct `Change` objects, see + * {@link ChangeJson} below. + * + */ +export class Change { + /** + * @hidden + * Factory method for creating a Change from a `before` object and an `after` + * object. + */ + static fromObjects(before: T, after: T) { + return new Change(before, after); + } + + /** + * @hidden + * Factory method for creating a Change from a JSON and an optional customizer + * function to be applied to both the `before` and the `after` fields. + */ + static fromJSON( + json: ChangeJson, + customizer: (x: any) => T = (x) => x as T + ): Change { + let before = { ...json.before }; + if (json.fieldMask) { + before = applyFieldMask(before, json.after, json.fieldMask); + } + + return Change.fromObjects( + customizer(before || {}), + customizer(json.after || {}) + ); + } + constructor(public before: T, public after: T) {} +} diff --git a/src/common/debug.ts b/src/common/debug.ts new file mode 100644 index 000000000..55221c9e8 --- /dev/null +++ b/src/common/debug.ts @@ -0,0 +1,57 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// Do NOT turn on a debug feature in production. +const debugMode = process.env.FIREBASE_DEBUG_MODE === 'true'; + +interface DebugFeatures { + skipTokenVerification?: boolean; + enableCors?: boolean; +} + +function loadDebugFeatures(): DebugFeatures { + if (!debugMode) { + return {}; + } + try { + const obj = JSON.parse(process.env.FIREBASE_DEBUG_FEATURES); + if (typeof obj !== 'object') { + return {}; + } + return obj as DebugFeatures; + } catch (e) { + return {}; + } +} + +/* @internal */ +export function debugFeatureValue(feat: keyof DebugFeatures): unknown { + if (!debugMode) { + return; + } + return loadDebugFeatures()[feat]; +} + +/* @internal */ +export function isDebugFeatureEnabled(feat: keyof DebugFeatures): boolean { + return debugMode && !!debugFeatureValue(feat); +} diff --git a/src/common/encoding.ts b/src/common/encoding.ts new file mode 100644 index 000000000..554c5fcb1 --- /dev/null +++ b/src/common/encoding.ts @@ -0,0 +1,119 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// Copied from firebase-tools/src/gcp/proto + +/** + * A type alias used to annotate interfaces as using a google.protobuf.Duration. + * This type is parsed/encoded as a string of seconds + the "s" prefix. + */ +export type Duration = string; + +/** Get a google.protobuf.Duration for a number of seconds. */ +export function durationFromSeconds(s: number): Duration { + return `${s}s`; +} + +/** + * Utility function to help copy fields from type A to B. + * As a safety net, catches typos or fields that aren't named the same + * in A and B, but cannot verify that both Src and Dest have the same type for the same field. + */ +export function copyIfPresent( + dest: Dest, + src: Src, + ...fields: Array +) { + if (!src) { + return; + } + for (const field of fields) { + if (!Object.prototype.hasOwnProperty.call(src, field)) { + continue; + } + dest[field] = src[field] as any; + } +} + +export function convertIfPresent( + dest: Dest, + src: Src, + destField: keyof Dest, + srcField: keyof Src, + converter: (from: any) => any = (from: any) => { + return from; + } +) { + if (!src) { + return; + } + if (!Object.prototype.hasOwnProperty.call(src, srcField)) { + return; + } + dest[destField] = converter(src[srcField]); +} + +export function serviceAccountFromShorthand( + serviceAccount: string +): string | null { + if (serviceAccount === 'default') { + return null; + } else if (serviceAccount.endsWith('@')) { + if (!process.env.GCLOUD_PROJECT) { + throw new Error( + `Unable to determine email for service account '${serviceAccount}' because process.env.GCLOUD_PROJECT is not set.` + ); + } + return `${serviceAccount}${process.env.GCLOUD_PROJECT}.iam.gserviceaccount.com`; + } else if (serviceAccount.includes('@')) { + return serviceAccount; + } else { + throw new Error( + `Invalid option for serviceAccount: '${serviceAccount}'. Valid options are 'default', a service account email, or '{serviceAccountName}@'` + ); + } +} + +export function convertInvoker(invoker: string | string[]): string[] { + if (typeof invoker === 'string') { + invoker = [invoker]; + } + + if (invoker.length === 0) { + throw new Error('Invalid option for invoker: Must be a non-empty array.'); + } + + if (invoker.find((inv) => inv.length === 0)) { + throw new Error('Invalid option for invoker: Must be a non-empty string.'); + } + + if ( + invoker.length > 1 && + invoker.find((inv) => inv === 'public' || inv === 'private') + ) { + throw new Error( + "Invalid option for invoker: Cannot have 'public' or 'private' in an array of service accounts." + ); + } + + return invoker; +} diff --git a/src/common/providers/database.ts b/src/common/providers/database.ts new file mode 100644 index 000000000..f1c41d617 --- /dev/null +++ b/src/common/providers/database.ts @@ -0,0 +1,314 @@ +// 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 * as firebase from 'firebase-admin'; +import * as _ from 'lodash'; +import { joinPath, pathParts } from '../../utilities/path'; + +/** + * Interface representing a Firebase Realtime Database data snapshot. + */ +export class DataSnapshot { + public instance: string; + + /** @hidden */ + private _ref: firebase.database.Reference; + + /** @hidden */ + private _path: string; + + /** @hidden */ + private _data: any; + + /** @hidden */ + private _childPath: string; + + constructor( + data: any, + path?: string, // path will be undefined for the database root + private app?: firebase.app.App, + instance?: string + ) { + if (app?.options?.databaseURL?.startsWith('http:')) { + // In this case we're dealing with an emulator + this.instance = app.options.databaseURL; + } else if (instance) { + // SDK always supplies instance, but user's unit tests may not + this.instance = instance; + } else if (app) { + this.instance = app.options.databaseURL; + } else if (process.env.GCLOUD_PROJECT) { + this.instance = + 'https://' + process.env.GCLOUD_PROJECT + '.firebaseio.com'; + } + + this._path = path; + this._data = data; + } + + /** + * Returns a [`Reference`](/docs/reference/admin/node/admin.database.Reference) + * to the Database location where the triggering write occurred. Has + * full read and write access. + */ + get ref(): firebase.database.Reference { + if (!this.app) { + // may be unpopulated in user's unit tests + throw new Error( + 'Please supply a Firebase app in the constructor for DataSnapshot' + + ' in order to use the .ref method.' + ); + } + if (!this._ref) { + this._ref = this.app.database(this.instance).ref(this._fullPath()); + } + return this._ref; + } + + /** + * The key (last part of the path) of the location of this `DataSnapshot`. + * + * The last token in a Database location is considered its key. For example, + * "ada" is the key for the `/users/ada/` node. Accessing the key on any + * `DataSnapshot` will return the key for the location that generated it. + * However, accessing the key on the root URL of a Database will return `null`. + */ + get key(): string { + const last = _.last(pathParts(this._fullPath())); + return !last || last === '' ? null : last; + } + + /** + * Extracts a JavaScript value from a `DataSnapshot`. + * + * Depending on the data in a `DataSnapshot`, the `val()` method may return a + * scalar type (string, number, or boolean), an array, or an object. It may also + * return `null`, indicating that the `DataSnapshot` is empty (contains no + * data). + * + * @return The DataSnapshot's contents as a JavaScript value (Object, + * Array, string, number, boolean, or `null`). + */ + val(): any { + const parts = pathParts(this._childPath); + const source = this._data; + const node = _.cloneDeep( + parts.length ? _.get(source, parts, null) : source + ); + return this._checkAndConvertToArray(node); + } + + /** + * Exports the entire contents of the `DataSnapshot` as a JavaScript object. + * + * The `exportVal()` method is similar to `val()`, except priority information + * is included (if available), making it suitable for backing up your data. + * + * @return The contents of the `DataSnapshot` as a JavaScript value + * (Object, Array, string, number, boolean, or `null`). + */ + exportVal(): any { + return this.val(); + } + + /** + * Gets the priority value of the data in this `DataSnapshot`. + * + * As an alternative to using priority, applications can order collections by + * ordinary properties. See [Sorting and filtering + * data](/docs/database/web/lists-of-data#sorting_and_filtering_data). + * + * @return The priority value of the data. + */ + getPriority(): string | number | null { + return 0; + } + + /** + * Returns `true` if this `DataSnapshot` contains any data. It is slightly more + * efficient than using `snapshot.val() !== null`. + * + * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`. + */ + exists(): boolean { + return !_.isNull(this.val()); + } + + /** + * Gets a `DataSnapshot` for the location at the specified relative path. + * + * The relative path can either be a simple child name (for example, "ada") or + * a deeper slash-separated path (for example, "ada/name/first"). + * + * @param path A relative path from this location to the desired child + * location. + * @return The specified child location. + */ + child(childPath: string): DataSnapshot { + if (!childPath) { + return this; + } + return this._dup(childPath); + } + + /** + * Enumerates the `DataSnapshot`s of the children items. + * + * Because of the way JavaScript objects work, the ordering of data in the + * JavaScript object returned by `val()` is not guaranteed to match the ordering + * on the server nor the ordering of `child_added` events. That is where + * `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` + * will be iterated in their query order. + * + * If no explicit `orderBy*()` method is used, results are returned + * ordered by key (unless priorities are used, in which case, results are + * returned by priority). + * + * @param action A function that will be called for each child `DataSnapshot`. + * The callback can return `true` to cancel further enumeration. + * + * @return `true` if enumeration was canceled due to your callback + * returning `true`. + */ + forEach(action: (a: DataSnapshot) => boolean | void): boolean { + const val = this.val(); + if (_.isPlainObject(val)) { + return _.some( + val, + (value, key: string) => action(this.child(key)) === true + ); + } + return false; + } + + /** + * Returns `true` if the specified child path has (non-`null`) data. + * + * @param path A relative path to the location of a potential child. + * @return `true` if data exists at the specified child path; otherwise, + * `false`. + */ + hasChild(childPath: string): boolean { + return this.child(childPath).exists(); + } + + /** + * Returns whether or not the `DataSnapshot` has any non-`null` child + * properties. + * + * You can use `hasChildren()` to determine if a `DataSnapshot` has any + * children. If it does, you can enumerate them using `forEach()`. If it + * doesn't, then either this snapshot contains a primitive value (which can be + * retrieved with `val()`) or it is empty (in which case, `val()` will return + * `null`). + * + * @return `true` if this snapshot has any children; else `false`. + */ + hasChildren(): boolean { + const val = this.val(); + return _.isPlainObject(val) && _.keys(val).length > 0; + } + + /** + * Returns the number of child properties of this `DataSnapshot`. + * + * @return Number of child properties of this `DataSnapshot`. + */ + numChildren(): number { + const val = this.val(); + return _.isPlainObject(val) ? Object.keys(val).length : 0; + } + + /** + * Returns a JSON-serializable representation of this object. + * + * @return A JSON-serializable representation of this object. + */ + toJSON(): Object { + return this.val(); + } + + /** Recursive function to check if keys are numeric & convert node object to array if they are + * + * @hidden + */ + private _checkAndConvertToArray(node: any): any { + if (node === null || typeof node === 'undefined') { + return null; + } + if (typeof node !== 'object') { + return node; + } + const obj: any = {}; + let numKeys = 0; + let maxKey = 0; + let allIntegerKeys = true; + for (const key in node) { + if (!node.hasOwnProperty(key)) { + continue; + } + const childNode = node[key]; + obj[key] = this._checkAndConvertToArray(childNode); + numKeys++; + const integerRegExp = /^(0|[1-9]\d*)$/; + if (allIntegerKeys && integerRegExp.test(key)) { + maxKey = Math.max(maxKey, Number(key)); + } else { + allIntegerKeys = false; + } + } + + if (allIntegerKeys && maxKey < 2 * numKeys) { + // convert to array. + const array: any = []; + _.forOwn(obj, (val, key) => { + array[key] = val; + }); + + return array; + } + return obj; + } + + /** @hidden */ + private _dup(childPath?: string): DataSnapshot { + const dup = new DataSnapshot( + this._data, + undefined, + this.app, + this.instance + ); + [dup._path, dup._childPath] = [this._path, this._childPath]; + + if (childPath) { + dup._childPath = joinPath(dup._childPath, childPath); + } + + return dup; + } + + /** @hidden */ + private _fullPath(): string { + const out = (this._path || '') + '/' + (this._childPath || ''); + return out; + } +} diff --git a/src/common/providers/https.ts b/src/common/providers/https.ts new file mode 100644 index 000000000..b3bed0e6d --- /dev/null +++ b/src/common/providers/https.ts @@ -0,0 +1,788 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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 * as cors from 'cors'; +import * as express from 'express'; +import * as firebase from 'firebase-admin'; + +import * as logger from '../../logger'; + +// TODO(inlined): Decide whether we want to un-version apps or whether we want a +// different strategy +import { apps } from '../../apps'; +import { isDebugFeatureEnabled } from '../debug'; +import { TaskContext } from './tasks'; + +const JWT_REGEX = /^[a-zA-Z0-9\-_=]+?\.[a-zA-Z0-9\-_=]+?\.([a-zA-Z0-9\-_=]+)?$/; + +/** @hidden */ +export interface Request extends express.Request { + /** The wire format representation of the request body. */ + rawBody: Buffer; +} + +// This is actually a firebase.appCheck.DecodedAppCheckToken, but +// that type may not be available in some supported SDK versions. +// Declare as an inline type, which DecodedAppCheckToken will be +// able to merge with. +// TODO: Replace with the real type once we bump the min-version of +// the admin SDK +interface DecodedAppCheckToken { + /** + * The issuer identifier for the issuer of the response. + * + * This value is a URL with the format + * `https://firebaseappcheck.googleapis.com/`, where `` is the + * same project number specified in the [`aud`](#aud) property. + */ + iss: string; + + /** + * The Firebase App ID corresponding to the app the token belonged to. + * + * As a convenience, this value is copied over to the [`app_id`](#app_id) property. + */ + sub: string; + + /** + * The audience for which this token is intended. + * + * This value is a JSON array of two strings, the first is the project number of your + * Firebase project, and the second is the project ID of the same project. + */ + aud: string[]; + + /** + * The App Check token's expiration time, in seconds since the Unix epoch. That is, the + * time at which this App Check token expires and should no longer be considered valid. + */ + exp: number; + + /** + * The App Check token's issued-at time, in seconds since the Unix epoch. That is, the + * time at which this App Check token was issued and should start to be considered + * valid.; + */ + iat: number; + + /** + * The App ID corresponding to the App the App Check token belonged to. + * + * This value is not actually one of the JWT token claims. It is added as a + * convenience, and is set as the value of the [`sub`](#sub) property. + */ + app_id: string; + [key: string]: any; +} + +/** + * The interface for AppCheck tokens verified in Callable functions + */ +export interface AppCheckData { + appId: string; + token: DecodedAppCheckToken; +} + +/** + * The interface for Auth tokens verified in Callable functions + */ +export interface AuthData { + uid: string; + token: firebase.auth.DecodedIdToken; +} + +// This type is the direct v1 callable interface and is also an interface +// that the v2 API can conform to. This allows us to pass the v2 CallableRequest +// directly to the same helper methods. +/** + * The interface for metadata for the API as passed to the handler. + */ +export interface CallableContext { + /** + * The result of decoding and verifying a Firebase AppCheck token. + */ + app?: AppCheckData; + + /** + * The result of decoding and verifying a Firebase Auth ID token. + */ + auth?: AuthData; + + /** + * An unverified token for a Firebase Instance ID. + */ + instanceIdToken?: string; + + /** + * The raw request handled by the callable. + */ + rawRequest: Request; +} + +// This could be a simple extension of CallableContext, but we're +// avoiding that to avoid muddying the docs and making a v2 type depend +// on a v1 type. +/** + * The request used to call a callable function. + */ +export interface CallableRequest { + /** + * The parameters used by a client when calling this function. + */ + data: T; + + /** + * The result of decoding and verifying a Firebase AppCheck token. + */ + app?: AppCheckData; + + /** + * The result of decoding and verifying a Firebase Auth ID token. + */ + auth?: AuthData; + + /** + * An unverified token for a Firebase Instance ID. + */ + instanceIdToken?: string; + + /** + * The raw request handled by the callable. + */ + rawRequest: Request; +} + +/** + * The set of Firebase Functions status codes. The codes are the same at the + * ones exposed by gRPC here: + * https://github.com/grpc/grpc/blob/master/doc/statuscodes.md + * + * Possible values: + * + * - `cancelled`: The operation was cancelled (typically by the caller). + * + * - `unknown`: Unknown error or an error from a different error domain. + * + * - `invalid-argument`: Client specified an invalid argument. Note that this + * differs from `failed-precondition`. `invalid-argument` indicates + * arguments that are problematic regardless of the state of the system + * (e.g. an invalid field name). + * + * - `deadline-exceeded`: Deadline expired before operation could complete. + * For operations that change the state of the system, this error may be + * returned even if the operation has completed successfully. For example, + * a successful response from a server could have been delayed long enough + * for the deadline to expire. + * + * - `not-found`: Some requested document was not found. + * + * - `already-exists`: Some document that we attempted to create already + * exists. + * + * - `permission-denied`: The caller does not have permission to execute the + * specified operation. + * + * - `resource-exhausted`: Some resource has been exhausted, perhaps a + * per-user quota, or perhaps the entire file system is out of space. + * + * - `failed-precondition`: Operation was rejected because the system is not + * in a state required for the operation's execution. + * + * - `aborted`: The operation was aborted, typically due to a concurrency + * issue like transaction aborts, etc. + * + * - `out-of-range`: Operation was attempted past the valid range. + * + * - `unimplemented`: Operation is not implemented or not supported/enabled. + * + * - `internal`: Internal errors. Means some invariants expected by + * underlying system has been broken. If you see one of these errors, + * something is very broken. + * + * - `unavailable`: The service is currently unavailable. This is most likely + * a transient condition and may be corrected by retrying with a backoff. + * + * - `data-loss`: Unrecoverable data loss or corruption. + * + * - `unauthenticated`: The request does not have valid authentication + * credentials for the operation. + */ +export type FunctionsErrorCode = + | 'ok' + | 'cancelled' + | 'unknown' + | 'invalid-argument' + | 'deadline-exceeded' + | 'not-found' + | 'already-exists' + | 'permission-denied' + | 'resource-exhausted' + | 'failed-precondition' + | 'aborted' + | 'out-of-range' + | 'unimplemented' + | 'internal' + | 'unavailable' + | 'data-loss' + | 'unauthenticated'; + +/** @hidden */ +export type CanonicalErrorCodeName = + | 'OK' + | 'CANCELLED' + | 'UNKNOWN' + | 'INVALID_ARGUMENT' + | 'DEADLINE_EXCEEDED' + | 'NOT_FOUND' + | 'ALREADY_EXISTS' + | 'PERMISSION_DENIED' + | 'UNAUTHENTICATED' + | 'RESOURCE_EXHAUSTED' + | 'FAILED_PRECONDITION' + | 'ABORTED' + | 'OUT_OF_RANGE' + | 'UNIMPLEMENTED' + | 'INTERNAL' + | 'UNAVAILABLE' + | 'DATA_LOSS'; + +/** @hidden */ +interface HttpErrorCode { + canonicalName: CanonicalErrorCodeName; + status: number; +} + +/** + * Standard error codes and HTTP statuses for different ways a request can fail, + * as defined by: + * https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto + * + * This map is used primarily to convert from a client error code string to + * to the HTTP format error code string and status, and make sure it's in the + * supported set. + */ +const errorCodeMap: { [name in FunctionsErrorCode]: HttpErrorCode } = { + ok: { canonicalName: 'OK', status: 200 }, + cancelled: { canonicalName: 'CANCELLED', status: 499 }, + unknown: { canonicalName: 'UNKNOWN', status: 500 }, + 'invalid-argument': { canonicalName: 'INVALID_ARGUMENT', status: 400 }, + 'deadline-exceeded': { canonicalName: 'DEADLINE_EXCEEDED', status: 504 }, + 'not-found': { canonicalName: 'NOT_FOUND', status: 404 }, + 'already-exists': { canonicalName: 'ALREADY_EXISTS', status: 409 }, + 'permission-denied': { canonicalName: 'PERMISSION_DENIED', status: 403 }, + unauthenticated: { canonicalName: 'UNAUTHENTICATED', status: 401 }, + 'resource-exhausted': { canonicalName: 'RESOURCE_EXHAUSTED', status: 429 }, + 'failed-precondition': { canonicalName: 'FAILED_PRECONDITION', status: 400 }, + aborted: { canonicalName: 'ABORTED', status: 409 }, + 'out-of-range': { canonicalName: 'OUT_OF_RANGE', status: 400 }, + unimplemented: { canonicalName: 'UNIMPLEMENTED', status: 501 }, + internal: { canonicalName: 'INTERNAL', status: 500 }, + unavailable: { canonicalName: 'UNAVAILABLE', status: 503 }, + 'data-loss': { canonicalName: 'DATA_LOSS', status: 500 }, +}; + +/** @hidden */ +interface HttpErrorWireFormat { + details?: unknown; + message: string; + status: CanonicalErrorCodeName; +} + +/** + * An explicit error that can be thrown from a handler to send an error to the + * client that called the function. + */ +export class HttpsError extends Error { + /** + * A standard error code that will be returned to the client. This also + * determines the HTTP status code of the response, as defined in code.proto. + */ + public readonly code: FunctionsErrorCode; + + /** + * Extra data to be converted to JSON and included in the error response. + */ + public readonly details: unknown; + + /** + * A wire format representation of a provided error code. + * + * @hidden + */ + public readonly httpErrorCode: HttpErrorCode; + + constructor(code: FunctionsErrorCode, message: string, details?: unknown) { + super(message); + + // A sanity check for non-TypeScript consumers. + if (code in errorCodeMap === false) { + throw new Error(`Unknown error code: ${code}.`); + } + + this.code = code; + this.details = details; + this.httpErrorCode = errorCodeMap[code]; + } + + /** + * Returns a JSON-serializable representation of this object. + */ + public toJSON(): HttpErrorWireFormat { + const { + details, + httpErrorCode: { canonicalName: status }, + message, + } = this; + + return { + ...(details === undefined ? {} : { details }), + message, + status, + }; + } +} + +/** @hidden */ +// The allowed interface for an HTTP request to a Callable function. +interface HttpRequest extends Request { + body: { + data: any; + }; +} + +/** @hidden */ +// The format for an HTTP body response from a Callable function. +interface HttpResponseBody { + result?: any; + error?: HttpsError; +} + +/** @hidden */ +// Returns true if req is a properly formatted callable request. +export function isValidRequest(req: Request): req is HttpRequest { + // The body must not be empty. + if (!req.body) { + logger.warn('Request is missing body.'); + return false; + } + + // Make sure it's a POST. + if (req.method !== 'POST') { + logger.warn('Request has invalid method.', req.method); + return false; + } + + // Check that the Content-Type is JSON. + let contentType = (req.header('Content-Type') || '').toLowerCase(); + // If it has a charset, just ignore it for now. + const semiColon = contentType.indexOf(';'); + if (semiColon >= 0) { + contentType = contentType.slice(0, semiColon).trim(); + } + if (contentType !== 'application/json') { + logger.warn('Request has incorrect Content-Type.', contentType); + return false; + } + + // The body must have data. + if (typeof req.body.data === 'undefined') { + logger.warn('Request body is missing data.', req.body); + return false; + } + + // TODO(klimt): Allow only specific http headers. + + // Verify that the body does not have any extra fields. + const extraKeys = Object.keys(req.body).filter((field) => field !== 'data'); + if (extraKeys.length !== 0) { + logger.warn('Request body has extra fields: ', extraKeys.join(', ')); + return false; + } + return true; +} + +/** @hidden */ +const LONG_TYPE = 'type.googleapis.com/google.protobuf.Int64Value'; +/** @hidden */ +const UNSIGNED_LONG_TYPE = 'type.googleapis.com/google.protobuf.UInt64Value'; + +/** + * Encodes arbitrary data in our special format for JSON. + * This is exposed only for testing. + */ +/** @hidden */ +export function encode(data: any): any { + if (data === null || typeof data === 'undefined') { + return null; + } + if (data instanceof Number) { + data = data.valueOf(); + } + if (Number.isFinite(data)) { + // Any number in JS is safe to put directly in JSON and parse as a double + // without any loss of precision. + return data; + } + if (typeof data === 'boolean') { + return data; + } + if (typeof data === 'string') { + return data; + } + if (Array.isArray(data)) { + return data.map(encode); + } + if (typeof data === 'object' || typeof data === 'function') { + // Sadly we don't have Object.fromEntries in Node 10, so we can't use a single + // list comprehension + const obj: Record = {}; + for (const [k, v] of Object.entries(data)) { + obj[k] = encode(v); + } + return obj; + } + // If we got this far, the data is not encodable. + logger.error('Data cannot be encoded in JSON.', data); + throw new Error('Data cannot be encoded in JSON: ' + data); +} + +/** + * Decodes our special format for JSON into native types. + * This is exposed only for testing. + */ +/** @hidden */ +export function decode(data: any): any { + if (data === null) { + return data; + } + if (data['@type']) { + switch (data['@type']) { + case LONG_TYPE: + // Fall through and handle this the same as unsigned. + case UNSIGNED_LONG_TYPE: { + // Technically, this could work return a valid number for malformed + // data if there was a number followed by garbage. But it's just not + // worth all the extra code to detect that case. + const value = parseFloat(data.value); + if (isNaN(value)) { + logger.error('Data cannot be decoded from JSON.', data); + throw new Error('Data cannot be decoded from JSON: ' + data); + } + return value; + } + default: { + logger.error('Data cannot be decoded from JSON.', data); + throw new Error('Data cannot be decoded from JSON: ' + data); + } + } + } + if (Array.isArray(data)) { + return data.map(decode); + } + if (typeof data === 'object') { + const obj: Record = {}; + for (const [k, v] of Object.entries(data)) { + obj[k] = decode(v); + } + return obj; + } + // Anything else is safe to return. + return data; +} + +/** + * Be careful when changing token status values. + * + * Users are encouraged to setup log-based metric based on these values, and + * changing their values may cause their metrics to break. + * + */ +/** @hidden */ +type TokenStatus = 'MISSING' | 'VALID' | 'INVALID'; + +/** @hidden */ +interface CallableTokenStatus { + app: TokenStatus; + auth: TokenStatus; +} + +/** @internal */ +export function unsafeDecodeToken(token: string): unknown { + if (!JWT_REGEX.test(token)) { + return {}; + } + const components = token + .split('.') + .map((s) => Buffer.from(s, 'base64').toString()); + let payload = components[1]; + if (typeof payload === 'string') { + try { + const obj = JSON.parse(payload); + if (typeof obj === 'object') { + payload = obj; + } + } catch (e) {} + } + return payload; +} + +/** + * Decode, but not verify, a Auth ID token. + * + * Do not use in production. Token should always be verified using the Admin SDK. + * + * This is exposed only for testing. + */ +/** @internal */ +export function unsafeDecodeIdToken( + token: string +): firebase.auth.DecodedIdToken { + const decoded = unsafeDecodeToken(token) as firebase.auth.DecodedIdToken; + decoded.uid = decoded.sub; + return decoded; +} + +/** + * Decode, but not verify, an App Check token. + * + * Do not use in production. Token should always be verified using the Admin SDK. + * + * This is exposed only for testing. + */ +/** @internal */ +export function unsafeDecodeAppCheckToken(token: string): DecodedAppCheckToken { + const decoded = unsafeDecodeToken(token) as DecodedAppCheckToken; + decoded.app_id = decoded.sub; + return decoded; +} + +/** + * Check and verify tokens included in the requests. Once verified, tokens + * are injected into the callable context. + * + * @param {Request} req - Request sent to the Callable function. + * @param {CallableContext} ctx - Context to be sent to callable function handler. + * @return {CallableTokenStatus} Status of the token verifications. + */ +/** @internal */ +async function checkTokens( + req: Request, + ctx: CallableContext +): Promise { + const verifications: CallableTokenStatus = { + app: 'INVALID', + auth: 'INVALID', + }; + + await Promise.all([ + Promise.resolve().then(async () => { + verifications.auth = await checkAuthToken(req, ctx); + }), + Promise.resolve().then(async () => { + verifications.app = await checkAppCheckToken(req, ctx); + }), + ]); + + const logPayload = { + verifications, + 'logging.googleapis.com/labels': { + 'firebase-log-type': 'callable-request-verification', + }, + }; + + const errs = []; + if (verifications.app === 'INVALID') { + errs.push('AppCheck token was rejected.'); + } + if (verifications.auth === 'INVALID') { + errs.push('Auth token was rejected.'); + } + + if (errs.length == 0) { + logger.info('Callable request verification passed', logPayload); + } else { + logger.warn( + `Callable request verification failed: ${errs.join(' ')}`, + logPayload + ); + } + + return verifications; +} + +/** @interanl */ +export async function checkAuthToken( + req: Request, + ctx: CallableContext | TaskContext +): Promise { + const authorization = req.header('Authorization'); + if (!authorization) { + return 'MISSING'; + } + const match = authorization.match(/^Bearer (.*)$/); + if (match) { + const idToken = match[1]; + try { + let authToken: firebase.auth.DecodedIdToken; + if (isDebugFeatureEnabled('skipTokenVerification')) { + authToken = unsafeDecodeIdToken(idToken); + } else { + authToken = await apps() + .admin.auth() + .verifyIdToken(idToken); + } + ctx.auth = { + uid: authToken.uid, + token: authToken, + }; + return 'VALID'; + } catch (err) { + logger.warn('Failed to validate auth token.', err); + return 'INVALID'; + } + } +} + +/** @internal */ +async function checkAppCheckToken( + req: Request, + ctx: CallableContext +): Promise { + const appCheck = req.header('X-Firebase-AppCheck'); + if (!appCheck) { + return 'MISSING'; + } + try { + if (!apps().admin.appCheck) { + throw new Error( + 'Cannot validate AppCheck token. Please update Firebase Admin SDK to >= v9.8.0' + ); + } + let appCheckData; + if (isDebugFeatureEnabled('skipTokenVerification')) { + const decodedToken = unsafeDecodeAppCheckToken(appCheck); + appCheckData = { appId: decodedToken.app_id, token: decodedToken }; + } else { + appCheckData = await apps() + .admin.appCheck() + .verifyToken(appCheck); + } + ctx.app = appCheckData; + return 'VALID'; + } catch (err) { + logger.warn('Failed to validate AppCheck token.', err); + return 'INVALID'; + } +} + +type v1CallableHandler = ( + data: any, + context: CallableContext +) => any | Promise; +type v2CallableHandler = (request: CallableRequest) => Res; + +/** @internal **/ +export interface CallableOptions { + cors: cors.CorsOptions; + allowInvalidAppCheckToken?: boolean; +} + +/** @internal */ +export function onCallHandler( + options: CallableOptions, + handler: v1CallableHandler | v2CallableHandler +): (req: Request, res: express.Response) => Promise { + const wrapped = wrapOnCallHandler(options, handler); + return (req: Request, res: express.Response) => { + return new Promise((resolve) => { + res.on('finish', resolve); + cors(options.cors)(req, res, () => { + resolve(wrapped(req, res)); + }); + }); + }; +} + +/** @internal */ +function wrapOnCallHandler( + options: CallableOptions, + handler: v1CallableHandler | v2CallableHandler +): (req: Request, res: express.Response) => Promise { + return async (req: Request, res: express.Response): Promise => { + try { + if (!isValidRequest(req)) { + logger.error('Invalid request, unable to process.'); + throw new HttpsError('invalid-argument', 'Bad Request'); + } + + const context: CallableContext = { rawRequest: req }; + const tokenStatus = await checkTokens(req, context); + if (tokenStatus.auth === 'INVALID') { + throw new HttpsError('unauthenticated', 'Unauthenticated'); + } + if (tokenStatus.app === 'INVALID' && !options.allowInvalidAppCheckToken) { + throw new HttpsError('unauthenticated', 'Unauthenticated'); + } + + const instanceId = req.header('Firebase-Instance-ID-Token'); + if (instanceId) { + // Validating the token requires an http request, so we don't do it. + // If the user wants to use it for something, it will be validated then. + // Currently, the only real use case for this token is for sending + // pushes with FCM. In that case, the FCM APIs will validate the token. + context.instanceIdToken = req.header('Firebase-Instance-ID-Token'); + } + + const data: Req = decode(req.body.data); + let result: Res; + if (handler.length === 2) { + result = await handler(data, context); + } else { + const arg: CallableRequest = { + ...context, + data, + }; + // For some reason the type system isn't picking up that the handler + // is a one argument function. + result = await (handler as any)(arg); + } + + // Encode the result as JSON to preserve types like Dates. + result = encode(result); + + // If there was some result, encode it in the body. + const responseBody: HttpResponseBody = { result }; + res.status(200).send(responseBody); + } catch (err) { + if (!(err instanceof HttpsError)) { + // This doesn't count as an 'explicit' error. + logger.error('Unhandled error', err); + err = new HttpsError('internal', 'INTERNAL'); + } + + const { status } = err.httpErrorCode; + const body = { error: err.toJSON() }; + + res.status(status).send(body); + } + }; +} diff --git a/src/common/providers/identity.ts b/src/common/providers/identity.ts new file mode 100644 index 000000000..0a376be9e --- /dev/null +++ b/src/common/providers/identity.ts @@ -0,0 +1,887 @@ +// 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 * as express from 'express'; +import * as firebase from 'firebase-admin'; +import { logger } from '../..'; +import { apps } from '../../apps'; +import { EventContext } from '../../cloud-functions'; +import { isDebugFeatureEnabled } from '../debug'; +import { HttpsError, unsafeDecodeToken } from './https'; + +export { HttpsError }; + +const DISALLOWED_CUSTOM_CLAIMS = [ + 'acr', + 'amr', + 'at_hash', + 'aud', + 'auth_time', + 'azp', + 'cnf', + 'c_hash', + 'exp', + 'iat', + 'iss', + 'jti', + 'nbf', + 'nonce', + 'firebase', +]; + +const CLAIMS_MAX_PAYLOAD_SIZE = 1000; + +/** + * Shorthand auth blocking events from GCIP. + * @hidden + * @alpha + */ +export type AuthBlockingEventType = 'beforeCreate' | 'beforeSignIn'; + +const EVENT_MAPPING: Record = { + beforeCreate: 'providers/cloud.auth/eventTypes/user.beforeCreate', + beforeSignIn: 'providers/cloud.auth/eventTypes/user.beforeSignIn', +}; + +/** + * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin + * SDK. + */ +export type UserRecord = firebase.auth.UserRecord; + +/** + * UserInfo that is part of the UserRecord + */ +export type UserInfo = firebase.auth.UserInfo; + +/** + * Helper class to create the user metadata in a UserRecord object + */ +export class UserRecordMetadata implements firebase.auth.UserMetadata { + constructor(public creationTime: string, public lastSignInTime: string) {} + + /** Returns a plain JavaScript object with the properties of UserRecordMetadata. */ + toJSON(): AuthUserMetadata { + return { + creationTime: this.creationTime, + lastSignInTime: this.lastSignInTime, + }; + } +} + +/** + * Helper function that creates a UserRecord Class from data sent over the wire. + * @param wireData data sent over the wire + * @returns an instance of UserRecord with correct toJSON functions + */ +export function userRecordConstructor(wireData: Object): UserRecord { + // Falsey values from the wire format proto get lost when converted to JSON, this adds them back. + const falseyValues: any = { + email: null, + emailVerified: false, + displayName: null, + photoURL: null, + phoneNumber: null, + disabled: false, + providerData: [], + customClaims: {}, + passwordSalt: null, + passwordHash: null, + tokensValidAfterTime: null, + }; + const record = { ...falseyValues, ...wireData }; + + const meta = record.metadata; + if (meta) { + record.metadata = new UserRecordMetadata( + meta.createdAt || meta.creationTime, + meta.lastSignedInAt || meta.lastSignInTime + ); + } else { + record.metadata = new UserRecordMetadata(null, null); + } + record.toJSON = () => { + const { + uid, + email, + emailVerified, + displayName, + photoURL, + phoneNumber, + disabled, + passwordHash, + passwordSalt, + tokensValidAfterTime, + } = record; + const json: Record = { + uid, + email, + emailVerified, + displayName, + photoURL, + phoneNumber, + disabled, + passwordHash, + passwordSalt, + tokensValidAfterTime, + }; + json.metadata = record.metadata.toJSON(); + json.customClaims = JSON.parse(JSON.stringify(record.customClaims)); + json.providerData = record.providerData.map((entry) => { + const newEntry = { ...entry }; + newEntry.toJSON = () => entry; + return newEntry; + }); + return json; + }; + return record as UserRecord; +} + +/** + * User info that is part of the AuthUserRecord + */ +export interface AuthUserInfo { + /** + * The user identifier for the linked provider. + */ + uid: string; + /** + * The display name for the linked provider. + */ + displayName: string; + /** + * The email for the linked provider. + */ + email: string; + /** + * The photo URL for the linked provider. + */ + photoURL: string; + /** + * The linked provider ID (for example, "google.com" for the Google provider). + */ + providerId: string; + /** + * The phone number for the linked provider. + */ + phoneNumber: string; +} + +/** + * Additional metadata about the user. + */ +export interface AuthUserMetadata { + /** + * The date the user was created, formatted as a UTC string. + */ + creationTime: string; + /** + * The date the user last signed in, formatted as a UTC string. + */ + lastSignInTime: string; +} + +/** + * Interface representing the common properties of a user-enrolled second factor. + */ +export interface AuthMultiFactorInfo { + /** + * The ID of the enrolled second factor. This ID is unique to the user. + */ + uid: string; + /** + * The optional display name of the enrolled second factor. + */ + displayName?: string; + /** + * The type identifier of the second factor. For SMS second factors, this is `phone`. + */ + factorId: string; + /** + * The optional date the second factor was enrolled, formatted as a UTC string. + */ + enrollmentTime?: string; + /** + * The phone number associated with a phone second factor. + */ + phoneNumber?: string; +} + +/** + * The multi-factor related properties for the current user, if available. + */ +export interface AuthMultiFactorSettings { + /** + * List of second factors enrolled with the current user. + */ + enrolledFactors: AuthMultiFactorInfo[]; +} + +/** + * The UserRecord passed to auth blocking Cloud Functions from the identity platform. + */ +export interface AuthUserRecord { + /** + * The user's `uid`. + */ + uid: string; + /** + * The user's primary email, if set. + */ + email?: string; + /** + * Whether or not the user's primary email is verified. + */ + emailVerified: boolean; + /** + * The user's display name. + */ + displayName?: string; + /** + * The user's photo URL. + */ + photoURL?: string; + /** + * The user's primary phone number, if set. + */ + phoneNumber?: string; + /** + * Whether or not the user is disabled: `true` for disabled; `false` for + * enabled. + */ + disabled: boolean; + /** + * Additional metadata about the user. + */ + metadata: AuthUserMetadata; + /** + * An array of providers (for example, Google, Facebook) linked to the user. + */ + providerData: AuthUserInfo[]; + /** + * The user's hashed password (base64-encoded). + */ + passwordHash?: string; + /** + * The user's password salt (base64-encoded). + */ + passwordSalt?: string; + /** + * The user's custom claims object if available, typically used to define + * user roles and propagated to an authenticated user's ID token. + */ + customClaims?: Record; + /** + * The ID of the tenant the user belongs to, if available. + */ + tenantId?: string | null; + /** + * The date the user's tokens are valid after, formatted as a UTC string. + */ + tokensValidAfterTime?: string; + /** + * The multi-factor related properties for the current user, if available. + */ + multiFactor?: AuthMultiFactorSettings; +} + +/** The additional user info component of the auth event context */ +export interface AdditionalUserInfo { + providerId: string; + profile?: any; + username?: string; + isNewUser: boolean; +} + +/** The credential component of the auth event context */ +export interface Credential { + claims?: { [key: string]: any }; + idToken?: string; + accessToken?: string; + refreshToken?: string; + expirationTime?: string; + secret?: string; + providerId: string; + signInMethod: string; +} + +/** Defines the auth event context for blocking events */ +export interface AuthEventContext extends EventContext { + locale?: string; + ipAddress: string; + userAgent: string; + additionalUserInfo?: AdditionalUserInfo; + credential?: Credential; +} + +/** Defines the auth event for v2 blocking events */ +export interface AuthBlockingEvent extends AuthEventContext { + data: AuthUserRecord; +} + +/** The handler response type for beforeCreate blocking events */ +export interface BeforeCreateResponse { + displayName?: string; + disabled?: boolean; + emailVerified?: boolean; + photoURL?: string; + customClaims?: object; +} + +/** The handler response type for beforeSignIn blocking events */ +export interface BeforeSignInResponse extends BeforeCreateResponse { + sessionClaims?: object; +} + +interface DecodedPayloadUserRecordMetadata { + creation_time?: number; + last_sign_in_time?: number; +} + +interface DecodedPayloadUserRecordUserInfo { + uid: string; + display_name?: string; + email?: string; + photo_url?: string; + phone_number?: string; + provider_id: string; +} + +/** @internal */ +export interface DecodedPayloadMfaInfo { + uid: string; + display_name?: string; + phone_number?: string; + enrollment_time?: string; + factor_id?: string; +} + +interface DecodedPayloadUserRecordEnrolledFactors { + enrolled_factors?: DecodedPayloadMfaInfo[]; +} + +/** @internal */ +export interface DecodedPayloadUserRecord { + uid: string; + email?: string; + email_verified?: boolean; + phone_number?: string; + display_name?: string; + photo_url?: string; + disabled?: boolean; + metadata?: DecodedPayloadUserRecordMetadata; + password_hash?: string; + password_salt?: string; + provider_data?: DecodedPayloadUserRecordUserInfo[]; + multi_factor?: DecodedPayloadUserRecordEnrolledFactors; + custom_claims?: any; + tokens_valid_after_time?: number; + tenant_id?: string; + [key: string]: any; +} + +/** @internal */ +export interface DecodedPayload { + aud: string; + exp: number; + iat: number; + iss: string; + sub: string; + event_id: string; + event_type: string; + ip_address: string; + user_agent?: string; + locale?: string; + sign_in_method?: string; + user_record?: DecodedPayloadUserRecord; + tenant_id?: string; + raw_user_info?: string; + sign_in_attributes?: { + [key: string]: any; + }; + oauth_id_token?: string; + oauth_access_token?: string; + oauth_refresh_token?: string; + oauth_token_secret?: string; + oauth_expires_in?: number; + [key: string]: any; +} + +type HandlerV1 = ( + user: AuthUserRecord, + context: AuthEventContext +) => + | BeforeCreateResponse + | BeforeSignInResponse + | void + | Promise + | Promise + | Promise; + +type HandlerV2 = ( + event: AuthBlockingEvent +) => + | BeforeCreateResponse + | BeforeSignInResponse + | void + | Promise + | Promise + | Promise; + +/** + * Checks for a valid identity platform web request, otherwise throws an HttpsError + * @internal + */ +export function isValidRequest(req: express.Request): boolean { + if (req.method !== 'POST') { + logger.warn(`Request has invalid method "${req.method}".`); + return false; + } + + const contentType: string = (req.header('Content-Type') || '').toLowerCase(); + if (!contentType.includes('application/json')) { + logger.warn('Request has invalid header Content-Type.'); + return false; + } + + if (!req.body?.data?.jwt) { + logger.warn('Request has an invalid body.'); + return false; + } + return true; +} + +/** + * Decode, but not verify, an Auth Blocking token. + * + * Do not use in production. Token should always be verified using the Admin SDK. + * + * This is exposed only for testing. + */ +function unsafeDecodeAuthBlockingToken(token: string): DecodedPayload { + const decoded = unsafeDecodeToken(token) as DecodedPayload; + decoded.uid = decoded.sub; + return decoded; +} + +/** + * Helper function to parse the decoded metadata object into a UserMetaData object + * @internal + */ +export function parseMetadata( + metadata: DecodedPayloadUserRecordMetadata +): AuthUserMetadata { + const creationTime = metadata?.creation_time + ? new Date((metadata.creation_time as number) * 1000).toUTCString() + : null; + const lastSignInTime = metadata?.last_sign_in_time + ? new Date((metadata.last_sign_in_time as number) * 1000).toUTCString() + : null; + return { + creationTime, + lastSignInTime, + }; +} + +/** + * Helper function to parse the decoded user info array into an AuthUserInfo array + * @internal + */ +export function parseProviderData( + providerData: DecodedPayloadUserRecordUserInfo[] +): AuthUserInfo[] { + const providers: AuthUserInfo[] = []; + for (const provider of providerData) { + providers.push({ + uid: provider.uid, + displayName: provider.display_name, + email: provider.email, + photoURL: provider.photo_url, + providerId: provider.provider_id, + phoneNumber: provider.phone_number, + }); + } + return providers; +} + +/** + * Helper function to parse the date into a UTC string + * @internal + */ +export function parseDate(tokensValidAfterTime?: number): string | null { + if (!tokensValidAfterTime) { + return null; + } + tokensValidAfterTime = tokensValidAfterTime * 1000; + try { + const date = new Date(tokensValidAfterTime); + if (!isNaN(date.getTime())) { + return date.toUTCString(); + } + } catch {} + return null; +} + +/** + * Helper function to parse the decoded enrolled factors into a valid MultiFactorSettings + * @internal + */ +export function parseMultiFactor( + multiFactor?: DecodedPayloadUserRecordEnrolledFactors +): AuthMultiFactorSettings { + if (!multiFactor) { + return null; + } + const parsedEnrolledFactors: AuthMultiFactorInfo[] = []; + for (const factor of multiFactor.enrolled_factors || []) { + if (!factor.uid) { + throw new HttpsError( + 'internal', + 'INTERNAL ASSERT FAILED: Invalid multi-factor info response' + ); + } + const enrollmentTime = factor.enrollment_time + ? new Date(factor.enrollment_time).toUTCString() + : null; + parsedEnrolledFactors.push({ + uid: factor.uid, + factorId: factor.phone_number + ? factor.factor_id || 'phone' + : factor.factor_id, + displayName: factor.display_name, + enrollmentTime, + phoneNumber: factor.phone_number, + }); + } + + if (parsedEnrolledFactors.length > 0) { + return { + enrolledFactors: parsedEnrolledFactors, + }; + } + return null; +} + +/** + * Parses the decoded user record into a valid UserRecord for use in the handler + * @internal + */ +export function parseAuthUserRecord( + decodedJWTUserRecord: DecodedPayloadUserRecord +): AuthUserRecord { + if (!decodedJWTUserRecord.uid) { + throw new HttpsError( + 'internal', + 'INTERNAL ASSERT FAILED: Invalid user response' + ); + } + + const disabled = decodedJWTUserRecord.disabled || false; + const metadata = parseMetadata(decodedJWTUserRecord.metadata); + const providerData = parseProviderData(decodedJWTUserRecord.provider_data); + const tokensValidAfterTime = parseDate( + decodedJWTUserRecord.tokens_valid_after_time + ); + const multiFactor = parseMultiFactor(decodedJWTUserRecord.multi_factor); + + return { + uid: decodedJWTUserRecord.uid, + email: decodedJWTUserRecord.email, + emailVerified: decodedJWTUserRecord.email_verified, + displayName: decodedJWTUserRecord.display_name, + photoURL: decodedJWTUserRecord.photo_url, + phoneNumber: decodedJWTUserRecord.phone_number, + disabled, + metadata, + providerData, + passwordHash: decodedJWTUserRecord.password_hash, + passwordSalt: decodedJWTUserRecord.password_salt, + customClaims: decodedJWTUserRecord.custom_claims, + tenantId: decodedJWTUserRecord.tenant_id, + tokensValidAfterTime, + multiFactor, + }; +} + +/** Helper to get the AdditionalUserInfo from the decoded jwt */ +function parseAdditionalUserInfo( + decodedJWT: DecodedPayload +): AdditionalUserInfo { + let profile, username; + if (decodedJWT.raw_user_info) { + try { + profile = JSON.parse(decodedJWT.raw_user_info); + } catch (err) { + logger.debug(`Parse Error: ${err.message}`); + } + } + if (profile) { + if (decodedJWT.sign_in_method === 'github.com') { + username = profile.login; + } + if (decodedJWT.sign_in_method === 'twitter.com') { + username = profile.screen_name; + } + } + + return { + providerId: + decodedJWT.sign_in_method === 'emailLink' + ? 'password' + : decodedJWT.sign_in_method, + profile, + username, + isNewUser: decodedJWT.event_type === 'beforeCreate' ? true : false, + }; +} + +/** Helper to get the Credential from the decoded jwt */ +function parseAuthCredential( + decodedJWT: DecodedPayload, + time: number +): Credential { + if ( + !decodedJWT.sign_in_attributes && + !decodedJWT.oauth_id_token && + !decodedJWT.oauth_access_token && + !decodedJWT.oauth_refresh_token + ) { + return null; + } + return { + claims: decodedJWT.sign_in_attributes, + idToken: decodedJWT.oauth_id_token, + accessToken: decodedJWT.oauth_access_token, + refreshToken: decodedJWT.oauth_refresh_token, + expirationTime: decodedJWT.oauth_expires_in + ? new Date(time + decodedJWT.oauth_expires_in * 1000).toUTCString() + : undefined, + secret: decodedJWT.oauth_token_secret, + providerId: + decodedJWT.sign_in_method === 'emailLink' + ? 'password' + : decodedJWT.sign_in_method, + signInMethod: decodedJWT.sign_in_method, + }; +} + +/** + * Parses the decoded jwt into a valid AuthEventContext for use in the handler + * @internal + */ +export function parseAuthEventContext( + decodedJWT: DecodedPayload, + projectId: string, + time: number = new Date().getTime() +): AuthEventContext { + const eventType = + (EVENT_MAPPING[decodedJWT.event_type] || decodedJWT.event_type) + + (decodedJWT.sign_in_method ? `:${decodedJWT.sign_in_method}` : ''); + + return { + locale: decodedJWT.locale, + ipAddress: decodedJWT.ip_address, + userAgent: decodedJWT.user_agent, + eventId: decodedJWT.event_id, + eventType, + authType: !!decodedJWT.user_record ? 'USER' : 'UNAUTHENTICATED', + resource: { + // TODO(colerogers): figure out the correct service + service: 'identitytoolkit.googleapis.com', + name: !!decodedJWT.tenant_id + ? `projects/${projectId}/tenants/${decodedJWT.tenant_id}` + : `projects/${projectId}`, + }, + timestamp: new Date(decodedJWT.iat * 1000).toUTCString(), + additionalUserInfo: parseAdditionalUserInfo(decodedJWT), + credential: parseAuthCredential(decodedJWT, time), + params: {}, + }; +} + +/** + * Checks the handler response for invalid customClaims & sessionClaims objects + * @internal + */ +export function validateAuthResponse( + eventType: string, + authRequest?: BeforeCreateResponse | BeforeSignInResponse +) { + if (!authRequest) { + authRequest = {}; + } + if (authRequest.customClaims) { + const invalidClaims = DISALLOWED_CUSTOM_CLAIMS.filter((claim) => + authRequest.customClaims.hasOwnProperty(claim) + ); + if (invalidClaims.length > 0) { + throw new HttpsError( + 'invalid-argument', + `The customClaims claims "${invalidClaims.join( + ',' + )}" are reserved and cannot be specified.` + ); + } + if ( + JSON.stringify(authRequest.customClaims).length > CLAIMS_MAX_PAYLOAD_SIZE + ) { + throw new HttpsError( + 'invalid-argument', + `The customClaims payload should not exceed ${CLAIMS_MAX_PAYLOAD_SIZE} characters.` + ); + } + } + if ( + eventType === 'beforeSignIn' && + (authRequest as BeforeSignInResponse).sessionClaims + ) { + const invalidClaims = DISALLOWED_CUSTOM_CLAIMS.filter((claim) => + (authRequest as BeforeSignInResponse).sessionClaims.hasOwnProperty(claim) + ); + if (invalidClaims.length > 0) { + throw new HttpsError( + 'invalid-argument', + `The sessionClaims claims "${invalidClaims.join( + ',' + )}" are reserved and cannot be specified.` + ); + } + if ( + JSON.stringify((authRequest as BeforeSignInResponse).sessionClaims) + .length > CLAIMS_MAX_PAYLOAD_SIZE + ) { + throw new HttpsError( + 'invalid-argument', + `The sessionClaims payload should not exceed ${CLAIMS_MAX_PAYLOAD_SIZE} characters.` + ); + } + const combinedClaims = { + ...authRequest.customClaims, + ...(authRequest as BeforeSignInResponse).sessionClaims, + }; + if (JSON.stringify(combinedClaims).length > CLAIMS_MAX_PAYLOAD_SIZE) { + throw new HttpsError( + 'invalid-argument', + `The customClaims and sessionClaims payloads should not exceed ${CLAIMS_MAX_PAYLOAD_SIZE} characters combined.` + ); + } + } +} + +/** + * Helper function to generate the update mask for the identity platform changed values + * @internal + */ +export function getUpdateMask( + authResponse?: BeforeCreateResponse | BeforeSignInResponse +): string { + if (!authResponse) { + return ''; + } + const updateMask: string[] = []; + for (const key in authResponse) { + if ( + authResponse.hasOwnProperty(key) && + typeof authResponse[key] !== 'undefined' + ) { + updateMask.push(key); + } + } + return updateMask.join(','); +} + +/** @internal */ +export function wrapHandler( + eventType: AuthBlockingEventType, + handler: HandlerV1 | HandlerV2 +) { + return async (req: express.Request, res: express.Response): Promise => { + try { + const projectId = process.env.GCLOUD_PROJECT; + if (!isValidRequest(req)) { + logger.error('Invalid request, unable to process'); + throw new HttpsError('invalid-argument', 'Bad Request'); + } + + if (!apps().admin.auth()._verifyAuthBlockingToken) { + throw new Error( + 'Cannot validate Auth Blocking token. Please update Firebase Admin SDK to >= v10.1.0' + ); + } + + const decodedPayload: DecodedPayload = isDebugFeatureEnabled( + 'skipTokenVerification' + ) + ? unsafeDecodeAuthBlockingToken(req.body.data.jwt) + : handler.length === 2 + ? await apps() + .admin.auth() + ._verifyAuthBlockingToken(req.body.data.jwt) + : await apps() + .admin.auth() + ._verifyAuthBlockingToken(req.body.data.jwt, 'run.app'); + + const authUserRecord = parseAuthUserRecord(decodedPayload.user_record); + const authEventContext = parseAuthEventContext(decodedPayload, projectId); + + let authResponse; + if (handler.length === 2) { + authResponse = + (await (handler as HandlerV1)(authUserRecord, authEventContext)) || + undefined; + } else { + authResponse = + (await (handler as HandlerV2)({ + ...authEventContext, + data: authUserRecord, + } as AuthBlockingEvent)) || undefined; + } + + validateAuthResponse(eventType, authResponse); + const updateMask = getUpdateMask(authResponse); + const result = + updateMask.length === 0 + ? {} + : { + userRecord: { + ...authResponse, + updateMask, + }, + }; + + res.status(200); + res.setHeader('Content-Type', 'application/json'); + res.send(JSON.stringify(result)); + } catch (err) { + if (!(err instanceof HttpsError)) { + // This doesn't count as an 'explicit' error. + logger.error('Unhandled error', err); + err = new HttpsError('internal', 'An unexpected error occurred.'); + } + + const { status } = err.httpErrorCode; + const body = { error: err.toJSON() }; + res.setHeader('Content-Type', 'application/json'); + res.status(status).send(body); + } + }; +} diff --git a/src/common/providers/tasks.ts b/src/common/providers/tasks.ts new file mode 100644 index 000000000..814087f01 --- /dev/null +++ b/src/common/providers/tasks.ts @@ -0,0 +1,164 @@ +// 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 * as express from 'express'; +import * as firebase from 'firebase-admin'; + +import * as logger from '../../logger'; +import { Expression } from '../../v2/params'; +import * as https from './https'; + +/** How a task should be retried in the event of a non-2xx return. */ +export interface RetryConfig { + /** + * Maximum number of times a request should be attempted. + * If left unspecified, will default to 3. + */ + maxAttempts?: number | Expression | null; + + /** + * Maximum amount of time for retrying failed task. + * If left unspecified will retry indefinitely. + */ + maxRetrySeconds?: number | Expression | null; + + /** + * The maximum amount of time to wait between attempts. + * If left unspecified will default to 1hr. + */ + maxBackoffSeconds?: number | Expression | null; + + /** + * The maximum number of times to double the backoff between + * retries. If left unspecified will default to 16. + */ + maxDoublings?: number | Expression | null; + + /** + * The minimum time to wait between attempts. If left unspecified + * will default to 100ms. + */ + minBackoffSeconds?: number | Expression | null; +} + +/** How congestion control should be applied to the function. */ +export interface RateLimits { + /** + * The maximum number of requests that can be outstanding at a time. + * If left unspecified, will default to 1000. + */ + maxConcurrentDispatches?: number | Expression | null; + + /** + * The maximum number of requests that can be invoked per second. + * If left unspecified, will default to 500. + */ + maxDispatchesPerSecond?: number | Expression | null; +} + +/** Metadata about the authorization used to invoke a function. */ +export interface AuthData { + uid: string; + token: firebase.auth.DecodedIdToken; +} + +/** Metadata about a call to a Task Queue function. */ +export interface TaskContext { + /** + * The result of decoding and verifying an ODIC token. + */ + auth?: AuthData; +} + +/** + * The request used to call a Task Queue function. + */ +export interface Request { + /** + * The parameters used by a client when calling this function. + */ + data: T; + + /** + * The result of decoding and verifying an ODIC token. + */ + auth?: AuthData; +} + +type v1TaskHandler = (data: any, context: TaskContext) => void | Promise; +type v2TaskHandler = (request: Request) => void | Promise; + +/** @internal */ +export function onDispatchHandler( + handler: v1TaskHandler | v2TaskHandler +): (req: https.Request, res: express.Response) => Promise { + return async (req: https.Request, res: express.Response): Promise => { + try { + if (!https.isValidRequest(req)) { + logger.error('Invalid request, unable to process.'); + throw new https.HttpsError('invalid-argument', 'Bad Request'); + } + + const context: TaskContext = {}; + if (!process.env.FUNCTIONS_EMULATOR) { + const authHeader = req.header('Authorization') || ''; + const token = authHeader.match(/^Bearer (.*)$/)?.[1]; + // Note: this should never happen since task queue functions are guarded by IAM. + if (!token) { + throw new https.HttpsError('unauthenticated', 'Unauthenticated'); + } + // We skip authenticating the token since tq functions are guarded by IAM. + const authToken = await https.unsafeDecodeIdToken(token); + context.auth = { + uid: authToken.uid, + token: authToken, + }; + } + + const data: Req = https.decode(req.body.data); + if (handler.length === 2) { + await handler(data, context); + } else { + const arg: Request = { + ...context, + data, + }; + // For some reason the type system isn't picking up that the handler + // is a one argument function. + await (handler as any)(arg); + } + + res.status(204).end(); + } catch (err) { + if (!(err instanceof https.HttpsError)) { + // This doesn't count as an 'explicit' error. + logger.error('Unhandled error', err); + err = new https.HttpsError('internal', 'INTERNAL'); + } + + const { status } = err.httpErrorCode; + const body = { error: err.toJSON() }; + + res.status(status).send(body); + } + }; +} diff --git a/src/common/timezone.ts b/src/common/timezone.ts new file mode 100644 index 000000000..5af4980fc --- /dev/null +++ b/src/common/timezone.ts @@ -0,0 +1,542 @@ +export const tzDatabase: Record = { + 'Africa/Abidjan': '+00:00', + 'Africa/Accra': '+00:00', + 'Africa/Addis_Ababa': '+03:00', + 'Africa/Algiers': '+01:00', + 'Africa/Asmara': '+03:00', + 'Africa/Asmera': '+03:00', + 'Africa/Bamako': '+00:00', + 'Africa/Bangui': '+01:00', + 'Africa/Banjul': '+00:00', + 'Africa/Blantyre': '+02:00', + 'Africa/Brazzaville': '+01:00', + 'Africa/Bujumbura': '+02:00', + 'Africa/Cairo': '+02:00', + 'Africa/Casablanca': '+00:00', + 'Africa/Ceuta': '+01:00', + 'Africa/Conakry': '+00:00', + 'Africa/Dakar': '+00:00', + 'Africa/Dar_es_Salaam': '+03:00', + 'Africa/Djibouti': '+03:00', + 'Africa/Douala': '+01:00', + 'Africa/El_Aaiun': '+00:00', + 'Africa/Freetown': '+00:00', + 'Africa/Gaborone': '+02:00', + 'Africa/Harare': '+02:00', + 'Africa/Johannesburg': '+02:00', + 'Africa/Juba': '+03:00', + 'Africa/Kampala': '+03:00', + 'Africa/Khartoum': '+03:00', + 'Africa/Kigali': '+02:00', + 'Africa/Kinshasa': '+01:00', + 'Africa/Lagos': '+01:00', + 'Africa/Libreville': '+01:00', + 'Africa/Lome': '+00:00', + 'Africa/Luanda': '+01:00', + 'Africa/Lubumbashi': '+02:00', + 'Africa/Lusaka': '+02:00', + 'Africa/Malabo': '+01:00', + 'Africa/Maputo': '+02:00', + 'Africa/Maseru': '+02:00', + 'Africa/Mbabane': '+02:00', + 'Africa/Mogadishu': '+03:00', + 'Africa/Monrovia': '+00:00', + 'Africa/Nairobi': '+03:00', + 'Africa/Ndjamena': '+01:00', + 'Africa/Niamey': '+01:00', + 'Africa/Nouakchott': '+00:00', + 'Africa/Ouagadougou': '+00:00', + 'Africa/Porto-Novo': '+01:00', + 'Africa/Sao_Tome': '+00:00', + 'Africa/Timbuktu': '+00:00', + 'Africa/Tripoli': '+02:00', + 'Africa/Tunis': '+01:00', + 'Africa/Windhoek': '+01:00', + 'America/Adak': '-10:00', + 'America/Anchorage': '-09:00', + 'America/Anguilla': '-04:00', + 'America/Antigua': '-04:00', + 'America/Araguaina': '-03:00', + 'America/Argentina/Buenos_Aires': '-03:00', + 'America/Argentina/Catamarca': '-03:00', + 'America/Argentina/ComodRivadavia': '-03:00', + 'America/Argentina/Cordoba': '-03:00', + 'America/Argentina/Jujuy': '-03:00', + 'America/Argentina/La_Rioja': '-03:00', + 'America/Argentina/Mendoza': '-03:00', + 'America/Argentina/Rio_Gallegos': '-03:00', + 'America/Argentina/Salta': '-03:00', + 'America/Argentina/San_Juan': '-03:00', + 'America/Argentina/San_Luis': '-03:00', + 'America/Argentina/Tucuman': '-03:00', + 'America/Argentina/Ushuaia': '-03:00', + 'America/Aruba': '-04:00', + 'America/Asuncion': '-04:00', + 'America/Atikokan': '-05:00', + 'America/Atka': '-10:00', + 'America/Bahia': '-03:00', + 'America/Bahia_Banderas': '-06:00', + 'America/Barbados': '-04:00', + 'America/Belem': '-03:00', + 'America/Belize': '-06:00', + 'America/Blanc-Sablon': '-04:00', + 'America/Boa_Vista': '-04:00', + 'America/Bogota': '-05:00', + 'America/Boise': '-07:00', + 'America/Buenos_Aires': '-03:00', + 'America/Cambridge_Bay': '-07:00', + 'America/Campo_Grande': '-04:00', + 'America/Cancun': '-06:00', + 'America/Caracas': '-04:30', + 'America/Catamarca': '-03:00', + 'America/Cayenne': '-03:00', + 'America/Cayman': '-05:00', + 'America/Chicago': '-06:00', + 'America/Chihuahua': '-07:00', + 'America/Coral_Harbour': '-05:00', + 'America/Cordoba': '-03:00', + 'America/Costa_Rica': '-06:00', + 'America/Creston': '-07:00', + 'America/Cuiaba': '-04:00', + 'America/Curacao': '-04:00', + 'America/Danmarkshavn': '+00:00', + 'America/Dawson': '-08:00', + 'America/Dawson_Creek': '-07:00', + 'America/Denver': '-07:00', + 'America/Detroit': '-05:00', + 'America/Dominica': '-04:00', + 'America/Edmonton': '-07:00', + 'America/Eirunepe': '-05:00', + 'America/El_Salvador': '-06:00', + 'America/Ensenada': '-08:00', + 'America/Fort_Wayne': '-05:00', + 'America/Fortaleza': '-03:00', + 'America/Glace_Bay': '-04:00', + 'America/Godthab': '-03:00', + 'America/Goose_Bay': '-04:00', + 'America/Grand_Turk': '-05:00', + 'America/Grenada': '-04:00', + 'America/Guadeloupe': '-04:00', + 'America/Guatemala': '-06:00', + 'America/Guayaquil': '-05:00', + 'America/Guyana': '-04:00', + 'America/Halifax': '-04:00', + 'America/Havana': '-05:00', + 'America/Hermosillo': '-07:00', + 'America/Indiana/Indianapolis': '-05:00', + 'America/Indiana/Knox': '-06:00', + 'America/Indiana/Marengo': '-05:00', + 'America/Indiana/Petersburg': '-05:00', + 'America/Indiana/Tell_City': '-06:00', + 'America/Indiana/Valparaiso': '-06:00', + 'America/Indiana/Vevay': '-05:00', + 'America/Indiana/Vincennes': '-05:00', + 'America/Indiana/Winamac': '-05:00', + 'America/Indianapolis': '-05:00', + 'America/Inuvik': '-07:00', + 'America/Iqaluit': '-05:00', + 'America/Jamaica': '-05:00', + 'America/Jujuy': '-03:00', + 'America/Juneau': '-09:00', + 'America/Kentucky/Louisville': '-05:00', + 'America/Kentucky/Monticello': '-05:00', + 'America/Knox_IN': '-06:00', + 'America/Kralendijk': '-04:00', + 'America/La_Paz': '-04:00', + 'America/Lima': '-05:00', + 'America/Los_Angeles': '-08:00', + 'America/Louisville': '-05:00', + 'America/Lower_Princes': '-04:00', + 'America/Maceio': '-03:00', + 'America/Managua': '-06:00', + 'America/Manaus': '-04:00', + 'America/Marigot': '-04:00', + 'America/Martinique': '-04:00', + 'America/Matamoros': '-06:00', + 'America/Mazatlan': '-07:00', + 'America/Mendoza': '-03:00', + 'America/Menominee': '-06:00', + 'America/Merida': '-06:00', + 'America/Metlakatla': '-08:00', + 'America/Mexico_City': '-06:00', + 'America/Miquelon': '-03:00', + 'America/Moncton': '-04:00', + 'America/Monterrey': '-06:00', + 'America/Montevideo': '-03:00', + 'America/Montreal': '-05:00', + 'America/Montserrat': '-04:00', + 'America/Nassau': '-05:00', + 'America/New_York': '-05:00', + 'America/Nipigon': '-05:00', + 'America/Nome': '-09:00', + 'America/Noronha': '-02:00', + 'America/North_Dakota/Beulah': '-06:00', + 'America/North_Dakota/Center': '-06:00', + 'America/North_Dakota/New_Salem': '-06:00', + 'America/Ojinaga': '-07:00', + 'America/Panama': '-05:00', + 'America/Pangnirtung': '-05:00', + 'America/Paramaribo': '-03:00', + 'America/Phoenix': '-07:00', + 'America/Port_of_Spain': '-04:00', + 'America/Port-au-Prince': '-05:00', + 'America/Porto_Acre': '-05:00', + 'America/Porto_Velho': '-04:00', + 'America/Puerto_Rico': '-04:00', + 'America/Rainy_River': '-06:00', + 'America/Rankin_Inlet': '-06:00', + 'America/Recife': '-03:00', + 'America/Regina': '-06:00', + 'America/Resolute': '-06:00', + 'America/Rio_Branco': '-05:00', + 'America/Rosario': '-03:00', + 'America/Santa_Isabel': '-08:00', + 'America/Santarem': '-03:00', + 'America/Santiago': '-03:00', + 'America/Santo_Domingo': '-04:00', + 'America/Sao_Paulo': '-03:00', + 'America/Scoresbysund': '-01:00', + 'America/Shiprock': '-07:00', + 'America/Sitka': '-09:00', + 'America/St_Barthelemy': '-04:00', + 'America/St_Johns': '-03:30', + 'America/St_Kitts': '-04:00', + 'America/St_Lucia': '-04:00', + 'America/St_Thomas': '-04:00', + 'America/St_Vincent': '-04:00', + 'America/Swift_Current': '-06:00', + 'America/Tegucigalpa': '-06:00', + 'America/Thule': '-04:00', + 'America/Thunder_Bay': '-05:00', + 'America/Tijuana': '-08:00', + 'America/Toronto': '-05:00', + 'America/Tortola': '-04:00', + 'America/Vancouver': '-08:00', + 'America/Virgin': '-04:00', + 'America/Whitehorse': '-08:00', + 'America/Winnipeg': '-06:00', + 'America/Yakutat': '-09:00', + 'America/Yellowknife': '-07:00', + 'Antarctica/Casey': '+11:00', + 'Antarctica/Davis': '+05:00', + 'Antarctica/DumontDUrville': '+10:00', + 'Antarctica/Macquarie': '+11:00', + 'Antarctica/Mawson': '+05:00', + 'Antarctica/McMurdo': '+12:00', + 'Antarctica/Palmer': '-04:00', + 'Antarctica/Rothera': '-03:00', + 'Antarctica/South_Pole': '+12:00', + 'Antarctica/Syowa': '+03:00', + 'Antarctica/Troll': '+00:00', + 'Antarctica/Vostok': '+06:00', + 'Arctic/Longyearbyen': '+01:00', + 'Asia/Aden': '+03:00', + 'Asia/Almaty': '+06:00', + 'Asia/Amman': '+02:00', + 'Asia/Anadyr': '+12:00', + 'Asia/Aqtau': '+05:00', + 'Asia/Aqtobe': '+05:00', + 'Asia/Ashgabat': '+05:00', + 'Asia/Ashkhabad': '+05:00', + 'Asia/Baghdad': '+03:00', + 'Asia/Bahrain': '+03:00', + 'Asia/Baku': '+04:00', + 'Asia/Bangkok': '+07:00', + 'Asia/Beirut': '+02:00', + 'Asia/Bishkek': '+06:00', + 'Asia/Brunei': '+08:00', + 'Asia/Calcutta': '+05:30', + 'Asia/Choibalsan': '+08:00', + 'Asia/Chongqing': '+08:00', + 'Asia/Chungking': '+08:00', + 'Asia/Colombo': '+05:30', + 'Asia/Dacca': '+06:00', + 'Asia/Damascus': '+02:00', + 'Asia/Dhaka': '+06:00', + 'Asia/Dili': '+09:00', + 'Asia/Dubai': '+04:00', + 'Asia/Dushanbe': '+05:00', + 'Asia/Gaza': '+02:00', + 'Asia/Harbin': '+08:00', + 'Asia/Hebron': '+02:00', + 'Asia/Ho_Chi_Minh': '+07:00', + 'Asia/Hong_Kong': '+08:00', + 'Asia/Hovd': '+07:00', + 'Asia/Irkutsk': '+08:00', + 'Asia/Istanbul': '+02:00', + 'Asia/Jakarta': '+07:00', + 'Asia/Jayapura': '+09:00', + 'Asia/Jerusalem': '+02:00', + 'Asia/Kabul': '+04:30', + 'Asia/Kamchatka': '+12:00', + 'Asia/Karachi': '+05:00', + 'Asia/Kashgar': '+08:00', + 'Asia/Kathmandu': '+05:45', + 'Asia/Katmandu': '+05:45', + 'Asia/Khandyga': '+09:00', + 'Asia/Kolkata': '+05:30', + 'Asia/Krasnoyarsk': '+07:00', + 'Asia/Kuala_Lumpur': '+08:00', + 'Asia/Kuching': '+08:00', + 'Asia/Kuwait': '+03:00', + 'Asia/Macao': '+08:00', + 'Asia/Macau': '+08:00', + 'Asia/Magadan': '+10:00', + 'Asia/Makassar': '+08:00', + 'Asia/Manila': '+08:00', + 'Asia/Muscat': '+04:00', + 'Asia/Nicosia': '+02:00', + 'Asia/Novokuznetsk': '+07:00', + 'Asia/Novosibirsk': '+06:00', + 'Asia/Omsk': '+06:00', + 'Asia/Oral': '+05:00', + 'Asia/Phnom_Penh': '+07:00', + 'Asia/Pontianak': '+07:00', + 'Asia/Pyongyang': '+09:00', + 'Asia/Qatar': '+03:00', + 'Asia/Qyzylorda': '+06:00', + 'Asia/Rangoon': '+06:30', + 'Asia/Riyadh': '+03:00', + 'Asia/Saigon': '+07:00', + 'Asia/Sakhalin': '+11:00', + 'Asia/Samarkand': '+05:00', + 'Asia/Seoul': '+09:00', + 'Asia/Shanghai': '+08:00', + 'Asia/Singapore': '+08:00', + 'Asia/Taipei': '+08:00', + 'Asia/Tashkent': '+05:00', + 'Asia/Tbilisi': '+04:00', + 'Asia/Tehran': '+03:30', + 'Asia/Tel_Aviv': '+02:00', + 'Asia/Thimbu': '+06:00', + 'Asia/Thimphu': '+06:00', + 'Asia/Tokyo': '+09:00', + 'Asia/Ujung_Pandang': '+08:00', + 'Asia/Ulaanbaatar': '+08:00', + 'Asia/Ulan_Bator': '+08:00', + 'Asia/Urumqi': '+08:00', + 'Asia/Ust-Nera': '+10:00', + 'Asia/Vientiane': '+07:00', + 'Asia/Vladivostok': '+10:00', + 'Asia/Yakutsk': '+09:00', + 'Asia/Yekaterinburg': '+05:00', + 'Asia/Yerevan': '+04:00', + 'Atlantic/Azores': '-01:00', + 'Atlantic/Bermuda': '-04:00', + 'Atlantic/Canary': '+00:00', + 'Atlantic/Cape_Verde': '-01:00', + 'Atlantic/Faeroe': '+00:00', + 'Atlantic/Faroe': '+00:00', + 'Atlantic/Jan_Mayen': '+01:00', + 'Atlantic/Madeira': '+00:00', + 'Atlantic/Reykjavik': '+00:00', + 'Atlantic/South_Georgia': '-02:00', + 'Atlantic/St_Helena': '+00:00', + 'Atlantic/Stanley': '-03:00', + 'Australia/ACT': '+10:00', + 'Australia/Adelaide': '+09:30', + 'Australia/Brisbane': '+10:00', + 'Australia/Broken_Hill': '+09:30', + 'Australia/Canberra': '+10:00', + 'Australia/Currie': '+10:00', + 'Australia/Darwin': '+09:30', + 'Australia/Eucla': '+08:45', + 'Australia/Hobart': '+10:00', + 'Australia/LHI': '+10:30', + 'Australia/Lindeman': '+10:00', + 'Australia/Lord_Howe': '+10:30', + 'Australia/Melbourne': '+10:00', + 'Australia/North': '+09:30', + 'Australia/NSW': '+10:00', + 'Australia/Perth': '+08:00', + 'Australia/Queensland': '+10:00', + 'Australia/South': '+09:30', + 'Australia/Sydney': '+10:00', + 'Australia/Tasmania': '+10:00', + 'Australia/Victoria': '+10:00', + 'Australia/West': '+08:00', + 'Australia/Yancowinna': '+09:30', + 'Brazil/Acre': '-05:00', + 'Brazil/DeNoronha': '-02:00', + 'Brazil/East': '-03:00', + 'Brazil/West': '-04:00', + 'Canada/Atlantic': '-04:00', + 'Canada/Central': '-06:00', + 'Canada/Eastern': '-05:00', + 'Canada/East-Saskatchewan': '-06:00', + 'Canada/Mountain': '-07:00', + 'Canada/Newfoundland': '-03:30', + 'Canada/Pacific': '-08:00', + 'Canada/Saskatchewan': '-06:00', + 'Canada/Yukon': '-08:00', + 'Chile/Continental': '-03:00', + 'Chile/EasterIsland': '-05:00', + Cuba: '-05:00', + Egypt: '+02:00', + Eire: '+00:00', + 'Etc/GMT': '+00:00', + 'Etc/GMT+0': '+00:00', + 'Etc/UCT': '+00:00', + 'Etc/Universal': '+00:00', + 'Etc/UTC': '+00:00', + 'Etc/Zulu': '+00:00', + 'Europe/Amsterdam': '+01:00', + 'Europe/Andorra': '+01:00', + 'Europe/Athens': '+02:00', + 'Europe/Belfast': '+00:00', + 'Europe/Belgrade': '+01:00', + 'Europe/Berlin': '+01:00', + 'Europe/Bratislava': '+01:00', + 'Europe/Brussels': '+01:00', + 'Europe/Bucharest': '+02:00', + 'Europe/Budapest': '+01:00', + 'Europe/Busingen': '+01:00', + 'Europe/Chisinau': '+02:00', + 'Europe/Copenhagen': '+01:00', + 'Europe/Dublin': '+00:00', + 'Europe/Gibraltar': '+01:00', + 'Europe/Guernsey': '+00:00', + 'Europe/Helsinki': '+02:00', + 'Europe/Isle_of_Man': '+00:00', + 'Europe/Istanbul': '+02:00', + 'Europe/Jersey': '+00:00', + 'Europe/Kaliningrad': '+02:00', + 'Europe/Kiev': '+02:00', + 'Europe/Lisbon': '+00:00', + 'Europe/Ljubljana': '+01:00', + 'Europe/London': '+00:00', + 'Europe/Luxembourg': '+01:00', + 'Europe/Madrid': '+01:00', + 'Europe/Malta': '+01:00', + 'Europe/Mariehamn': '+02:00', + 'Europe/Minsk': '+03:00', + 'Europe/Monaco': '+01:00', + 'Europe/Moscow': '+03:00', + 'Europe/Nicosia': '+02:00', + 'Europe/Oslo': '+01:00', + 'Europe/Paris': '+01:00', + 'Europe/Podgorica': '+01:00', + 'Europe/Prague': '+01:00', + 'Europe/Riga': '+02:00', + 'Europe/Rome': '+01:00', + 'Europe/Samara': '+04:00', + 'Europe/San_Marino': '+01:00', + 'Europe/Sarajevo': '+01:00', + 'Europe/Simferopol': '+03:00', + 'Europe/Skopje': '+01:00', + 'Europe/Sofia': '+02:00', + 'Europe/Stockholm': '+01:00', + 'Europe/Tallinn': '+02:00', + 'Europe/Tirane': '+01:00', + 'Europe/Tiraspol': '+02:00', + 'Europe/Uzhgorod': '+02:00', + 'Europe/Vaduz': '+01:00', + 'Europe/Vatican': '+01:00', + 'Europe/Vienna': '+01:00', + 'Europe/Vilnius': '+02:00', + 'Europe/Volgograd': '+03:00', + 'Europe/Warsaw': '+01:00', + 'Europe/Zagreb': '+01:00', + 'Europe/Zaporozhye': '+02:00', + 'Europe/Zurich': '+01:00', + GB: '+00:00', + 'GB-Eire': '+00:00', + GMT: '+00:00', + 'GMT+0': '+00:00', + GMT0: '+00:00', + 'GMT-0': '+00:00', + Greenwich: '+00:00', + Hongkong: '+08:00', + Iceland: '+00:00', + 'Indian/Antananarivo': '+03:00', + 'Indian/Chagos': '+06:00', + 'Indian/Christmas': '+07:00', + 'Indian/Cocos': '+06:30', + 'Indian/Comoro': '+03:00', + 'Indian/Kerguelen': '+05:00', + 'Indian/Mahe': '+04:00', + 'Indian/Maldives': '+05:00', + 'Indian/Mauritius': '+04:00', + 'Indian/Mayotte': '+03:00', + 'Indian/Reunion': '+04:00', + Iran: '+03:30', + Israel: '+02:00', + Jamaica: '-05:00', + Japan: '+09:00', + Kwajalein: '+12:00', + Libya: '+02:00', + 'Mexico/BajaNorte': '-08:00', + 'Mexico/BajaSur': '-07:00', + 'Mexico/General': '-06:00', + Navajo: '-07:00', + NZ: '+12:00', + 'NZ-CHAT': '+12:45', + 'Pacific/Apia': '+13:00', + 'Pacific/Auckland': '+12:00', + 'Pacific/Chatham': '+12:45', + 'Pacific/Chuuk': '+10:00', + 'Pacific/Easter': '-06:00', + 'Pacific/Efate': '+11:00', + 'Pacific/Enderbury': '+13:00', + 'Pacific/Fakaofo': '+13:00', + 'Pacific/Fiji': '+12:00', + 'Pacific/Funafuti': '+12:00', + 'Pacific/Galapagos': '-06:00', + 'Pacific/Gambier': '-09:00', + 'Pacific/Guadalcanal': '+11:00', + 'Pacific/Guam': '+10:00', + 'Pacific/Honolulu': '-10:00', + 'Pacific/Johnston': '-10:00', + 'Pacific/Kiritimati': '+14:00', + 'Pacific/Kosrae': '+11:00', + 'Pacific/Kwajalein': '+12:00', + 'Pacific/Majuro': '+12:00', + 'Pacific/Marquesas': '-09:30', + 'Pacific/Midway': '-11:00', + 'Pacific/Nauru': '+12:00', + 'Pacific/Niue': '-11:00', + 'Pacific/Norfolk': '+11:30', + 'Pacific/Noumea': '+11:00', + 'Pacific/Pago_Pago': '-11:00', + 'Pacific/Palau': '+09:00', + 'Pacific/Pitcairn': '-08:00', + 'Pacific/Pohnpei': '+11:00', + 'Pacific/Ponape': '+11:00', + 'Pacific/Port_Moresby': '+10:00', + 'Pacific/Rarotonga': '-10:00', + 'Pacific/Saipan': '+10:00', + 'Pacific/Samoa': '-11:00', + 'Pacific/Tahiti': '-10:00', + 'Pacific/Tarawa': '+12:00', + 'Pacific/Tongatapu': '+13:00', + 'Pacific/Truk': '+10:00', + 'Pacific/Wake': '+12:00', + 'Pacific/Wallis': '+12:00', + 'Pacific/Yap': '+10:00', + Poland: '+01:00', + Portugal: '+00:00', + PRC: '+08:00', + ROC: '+08:00', + ROK: '+09:00', + Singapore: '+08:00', + Turkey: '+02:00', + UCT: '+00:00', + Universal: '+00:00', + 'US/Alaska': '-09:00', + 'US/Aleutian': '-10:00', + 'US/Arizona': '-07:00', + 'US/Central': '-06:00', + 'US/Eastern': '-05:00', + 'US/East-Indiana': '-05:00', + 'US/Hawaii': '-10:00', + 'US/Indiana-Starke': '-06:00', + 'US/Michigan': '-05:00', + 'US/Mountain': '-07:00', + 'US/Pacific': '-08:00', + 'US/Samoa': '-11:00', + UTC: '+00:00', + 'W-SU': '+03:00', + Zulu: '+00:00', +}; + +export type timezone = keyof typeof tzDatabase; diff --git a/src/config.ts b/src/config.ts index 9823b3746..01ca3a4cc 100644 --- a/src/config.ts +++ b/src/config.ts @@ -20,18 +20,38 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. +import * as fs from 'fs'; +import * as path from 'path'; + import * as firebase from 'firebase-admin'; export function config(): config.Config { + // K_CONFIGURATION is only set in GCFv2 + if (process.env.K_CONFIGURATION) { + throw new Error( + 'functions.config() is no longer available in Cloud Functions for ' + + 'Firebase v2. Please see the latest documentation for information ' + + 'on how to transition to using environment variables' + ); + } if (typeof config.singleton === 'undefined') { init(); } return config.singleton; } +/** + * Store and retrieve project configuration data such as third-party API + * keys or other settings. You can set configuration values using the + * Firebase CLI as described in + * [Environment Configuration](/docs/functions/config-env). + */ export namespace config { - // Config type is usable as a object (dot notation allowed), and firebase - // property will also code complete. + /** + * The Functions configuration interface. + * + * Access via `functions.config()`. + */ export interface Config { [key: string]: any; } @@ -40,18 +60,34 @@ export namespace config { export let singleton: config.Config; } +/** @hidden */ +export let firebaseConfigCache: firebase.AppOptions | null = null; + /** @hidden */ export function firebaseConfig(): firebase.AppOptions | null { - const env = process.env.FIREBASE_CONFIG; + if (firebaseConfigCache) { + return firebaseConfigCache; + } + + let env = process.env.FIREBASE_CONFIG; if (env) { - return JSON.parse(env); + // Firebase Tools will always use a JSON blob in prod, but docs + // explicitly state that the user can set the env to a file: + // https://firebase.google.com/docs/admin/setup#initialize-without-parameters + if (!env.startsWith('{')) { + env = fs.readFileSync(path.join(process.env.PWD, env)).toString('utf8'); + } + + firebaseConfigCache = JSON.parse(env); + return firebaseConfigCache; } // Could have Runtime Config with Firebase in it as an ENV value. try { const config = JSON.parse(process.env.CLOUD_RUNTIME_CONFIG); if (config.firebase) { - return config.firebase; + firebaseConfigCache = config.firebase; + return firebaseConfigCache; } } catch (e) { // Do nothing @@ -59,11 +95,14 @@ export function firebaseConfig(): firebase.AppOptions | null { // Could have Runtime Config with Firebase in it as an ENV location or default. try { - const path = - process.env.CLOUD_RUNTIME_CONFIG || '../../../.runtimeconfig.json'; - const config = require(path); + const configPath = + process.env.CLOUD_RUNTIME_CONFIG || + path.join(process.cwd(), '.runtimeconfig.json'); + const contents = fs.readFileSync(configPath); + const config = JSON.parse(contents.toString('utf8')); if (config.firebase) { - return config.firebase; + firebaseConfigCache = config.firebase; + return firebaseConfigCache; } } catch (e) { // Do nothing @@ -83,9 +122,11 @@ function init() { } try { - const path = - process.env.CLOUD_RUNTIME_CONFIG || '../../../.runtimeconfig.json'; - const parsed = require(path); + const configPath = + process.env.CLOUD_RUNTIME_CONFIG || + path.join(process.cwd(), '.runtimeconfig.json'); + const contents = fs.readFileSync(configPath); + const parsed = JSON.parse(contents.toString('utf8')); delete parsed.firebase; config.singleton = parsed; return; diff --git a/src/function-builder.ts b/src/function-builder.ts index 580e0498b..1fd4efb05 100644 --- a/src/function-builder.ts +++ b/src/function-builder.ts @@ -26,20 +26,23 @@ import * as _ from 'lodash'; import { CloudFunction, EventContext } from './cloud-functions'; import { DeploymentOptions, + INGRESS_SETTINGS_OPTIONS, + MAX_NUMBER_USER_LABELS, MAX_TIMEOUT_SECONDS, RuntimeOptions, SUPPORTED_REGIONS, VALID_MEMORY_OPTIONS, + VPC_EGRESS_SETTINGS_OPTIONS, } from './function-configuration'; import * as analytics from './providers/analytics'; import * as auth from './providers/auth'; -import * as crashlytics from './providers/crashlytics'; import * as database from './providers/database'; import * as firestore from './providers/firestore'; import * as https from './providers/https'; import * as pubsub from './providers/pubsub'; import * as remoteConfig from './providers/remoteConfig'; import * as storage from './providers/storage'; +import * as tasks from './providers/tasks'; import * as testLab from './providers/testLab'; /** @@ -66,6 +69,179 @@ function assertRuntimeOptionsValid(runtimeOptions: RuntimeOptions): boolean { `TimeoutSeconds must be between 0 and ${MAX_TIMEOUT_SECONDS}` ); } + + if ( + runtimeOptions.ingressSettings && + !_.includes(INGRESS_SETTINGS_OPTIONS, runtimeOptions.ingressSettings) + ) { + throw new Error( + `The only valid ingressSettings values are: ${INGRESS_SETTINGS_OPTIONS.join( + ',' + )}` + ); + } + + if ( + runtimeOptions.vpcConnectorEgressSettings && + !_.includes( + VPC_EGRESS_SETTINGS_OPTIONS, + runtimeOptions.vpcConnectorEgressSettings + ) + ) { + throw new Error( + `The only valid vpcConnectorEgressSettings values are: ${VPC_EGRESS_SETTINGS_OPTIONS.join( + ',' + )}` + ); + } + + if (runtimeOptions.failurePolicy !== undefined) { + if ( + _.isBoolean(runtimeOptions.failurePolicy) === false && + _.isObjectLike(runtimeOptions.failurePolicy) === false + ) { + throw new Error(`failurePolicy must be a boolean or an object.`); + } + + if (typeof runtimeOptions.failurePolicy === 'object') { + if ( + _.isObjectLike(runtimeOptions.failurePolicy.retry) === false || + _.isEmpty(runtimeOptions.failurePolicy.retry) === false + ) { + throw new Error('failurePolicy.retry must be an empty object.'); + } + } + } + + if ( + runtimeOptions.serviceAccount && + runtimeOptions.serviceAccount !== 'default' && + !_.includes(runtimeOptions.serviceAccount, '@') + ) { + throw new Error( + `serviceAccount must be set to 'default', a service account email, or '{serviceAccountName}@'` + ); + } + + if (runtimeOptions.labels) { + // Labels must follow the rules listed in + // https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements + + if (Object.keys(runtimeOptions.labels).length > MAX_NUMBER_USER_LABELS) { + throw new Error( + `A function must not have more than ${MAX_NUMBER_USER_LABELS} user-defined labels.` + ); + } + + // We reserve the 'deployment' and 'firebase' namespaces for future feature development. + const reservedKeys = Object.keys(runtimeOptions.labels).filter( + (key) => key.startsWith('deployment') || key.startsWith('firebase') + ); + if (reservedKeys.length) { + throw new Error( + `Invalid labels: ${reservedKeys.join( + ', ' + )}. Labels may not start with reserved names 'deployment' or 'firebase'` + ); + } + + const invalidLengthKeys = Object.keys(runtimeOptions.labels).filter( + (key) => key.length < 1 || key.length > 63 + ); + if (invalidLengthKeys.length > 0) { + throw new Error( + `Invalid labels: ${invalidLengthKeys.join( + ', ' + )}. Label keys must be between 1 and 63 characters in length.` + ); + } + + const invalidLengthValues = Object.values(runtimeOptions.labels).filter( + (value) => value.length > 63 + ); + if (invalidLengthValues.length > 0) { + throw new Error( + `Invalid labels: ${invalidLengthValues.join( + ', ' + )}. Label values must be less than 64 charcters.` + ); + } + + // Keys can contain lowercase letters, foreign characters, numbers, _ or -. They must start with a letter. + const validKeyPattern = /^[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}$/u; + const invalidKeys = Object.keys(runtimeOptions.labels).filter( + (key) => !validKeyPattern.test(key) + ); + if (invalidKeys.length > 0) { + throw new Error( + `Invalid labels: ${invalidKeys.join( + ', ' + )}. Label keys can only contain lowercase letters, international characters, numbers, _ or -, and must start with a letter.` + ); + } + + // Values can contain lowercase letters, foreign characters, numbers, _ or -. + const validValuePattern = /^[\p{Ll}\p{Lo}\p{N}_-]{0,63}$/u; + const invalidValues = Object.values(runtimeOptions.labels).filter( + (value) => !validValuePattern.test(value) + ); + if (invalidValues.length > 0) { + throw new Error( + `Invalid labels: ${invalidValues.join( + ', ' + )}. Label values can only contain lowercase letters, international characters, numbers, _ or -.` + ); + } + } + + if ( + typeof runtimeOptions.invoker === 'string' && + runtimeOptions.invoker.length === 0 + ) { + throw new Error( + 'Invalid service account for function invoker, must be a non-empty string' + ); + } + if ( + runtimeOptions.invoker !== undefined && + Array.isArray(runtimeOptions.invoker) + ) { + if (runtimeOptions.invoker.length === 0) { + throw new Error( + 'Invalid invoker array, must contain at least 1 service account entry' + ); + } + for (const serviceAccount of runtimeOptions.invoker) { + if (serviceAccount.length === 0) { + throw new Error( + 'Invalid invoker array, a service account must be a non-empty string' + ); + } + if (serviceAccount === 'public') { + throw new Error( + "Invalid invoker array, a service account cannot be set to the 'public' identifier" + ); + } + if (serviceAccount === 'private') { + throw new Error( + "Invalid invoker array, a service account cannot be set to the 'private' identifier" + ); + } + } + } + + if (runtimeOptions.secrets !== undefined) { + const invalidSecrets = runtimeOptions.secrets.filter( + (s) => !/^[A-Za-z\d\-_]+$/.test(s) + ); + if (invalidSecrets.length > 0) { + throw new Error( + `Invalid secrets: ${invalidSecrets.join(',')}. ` + + 'Secret must be configured using the resource id (e.g. API_KEY)' + ); + } + } + return true; } @@ -78,11 +254,6 @@ function assertRegionsAreValid(regions: string[]): boolean { if (!regions.length) { throw new Error('You must specify at least one region'); } - if (_.difference(regions, SUPPORTED_REGIONS).length) { - throw new Error( - `The only valid regions are: ${SUPPORTED_REGIONS.join(', ')}` - ); - } return true; } @@ -95,7 +266,7 @@ function assertRegionsAreValid(regions: string[]): boolean { * functions.region('us-east1', 'us-central1') */ export function region( - ...regions: Array + ...regions: Array ): FunctionBuilder { if (assertRegionsAreValid(regions)) { return new FunctionBuilder({ regions }); @@ -104,11 +275,21 @@ export function region( /** * Configure runtime options for the function. - * @param runtimeOptions Object with three optional fields: - * 1. memory: amount of memory to allocate to the function, possible values - * are: '128MB', '256MB', '512MB', '1GB', and '2GB'. - * 2. timeoutSeconds: timeout for the function in seconds, possible values are + * @param runtimeOptions Object with optional fields: + * 1. `memory`: amount of memory to allocate to the function, possible values + * are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'. + * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are * 0 to 540. + * 3. `failurePolicy`: failure policy of the function, with boolean `true` being + * equivalent to providing an empty retry object. + * 4. `vpcConnector`: id of a VPC connector in same project and region. + * 5. `vpcConnectorEgressSettings`: when a vpcConnector is set, control which + * egress traffic is sent through the vpcConnector. + * 6. `serviceAccount`: Specific service account for the function. + * 7. `ingressSettings`: ingress settings for the function, which control where a HTTPS + * function can be called from. + * + * Value must not be null. */ export function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder { if (assertRuntimeOptionsValid(runtimeOptions)) { @@ -127,7 +308,9 @@ export class FunctionBuilder { * @example * functions.region('us-east1', 'us-central1') */ - region(...regions: Array): FunctionBuilder { + region( + ...regions: Array + ): FunctionBuilder { if (assertRegionsAreValid(regions)) { this.options.regions = regions; return this; @@ -136,11 +319,18 @@ export class FunctionBuilder { /** * Configure runtime options for the function. - * @param runtimeOptions Object with three optional fields: - * 1. memory: amount of memory to allocate to the function, possible values - * are: '128MB', '256MB', '512MB', '1GB', and '2GB'. - * 2. timeoutSeconds: timeout for the function in seconds, possible values are + * @param runtimeOptions Object with optional fields: + * 1. `memory`: amount of memory to allocate to the function, possible values + * are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'. + * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are * 0 to 540. + * 3. `failurePolicy`: failure policy of the function, with boolean `true` being + * equivalent to providing an empty retry object. + * 4. `vpcConnector`: id of a VPC connector in the same project and region + * 5. `vpcConnectorEgressSettings`: when a `vpcConnector` is set, control which + * egress traffic is sent through the `vpcConnector`. + * + * Value must not be null. */ runWith(runtimeOptions: RuntimeOptions): FunctionBuilder { if (assertRuntimeOptionsValid(runtimeOptions)) { @@ -150,6 +340,12 @@ export class FunctionBuilder { } get https() { + if (this.options.failurePolicy !== undefined) { + console.warn( + 'RuntimeOptions.failurePolicy is not supported in https functions.' + ); + } + return { /** * Handle HTTP requests. @@ -157,7 +353,10 @@ export class FunctionBuilder { * same signature as an Express app. */ onRequest: ( - handler: (req: https.Request, resp: express.Response) => void + handler: ( + req: https.Request, + resp: express.Response + ) => void | Promise ) => https._onRequestWithOptions(handler, this.options), /** * Declares a callable method for clients to call using a Firebase SDK. @@ -172,6 +371,19 @@ export class FunctionBuilder { }; } + get tasks() { + return { + /** + * Declares a task queue function for clients to call using a Firebase Admin SDK. + * @param options Configurations for the task queue function. + */ + /** @hidden */ + taskQueue: (options?: tasks.TaskQueueOptions) => { + return new tasks.TaskQueueBuilder(options, this.options); + }, + }; + } + get database() { return { /** @@ -233,16 +445,6 @@ export class FunctionBuilder { }; } - get crashlytics() { - return { - /** - * Handle events related to Crashlytics issues. An issue in Crashlytics is - * an aggregation of crashes which have a shared root cause. - */ - issue: () => crashlytics._issueWithOptions(this.options), - }; - } - get analytics() { return { /** @@ -311,7 +513,8 @@ export class FunctionBuilder { /** * Handle events related to Firebase authentication users. */ - user: () => auth._userWithOptions(this.options), + user: (userOptions?: auth.UserOptions) => + auth._userWithOptions(this.options, userOptions), }; } diff --git a/src/function-configuration.ts b/src/function-configuration.ts index ec1695ccd..6a352e880 100644 --- a/src/function-configuration.ts +++ b/src/function-configuration.ts @@ -1,3 +1,5 @@ +import { Expression } from './v2/params'; + /** * List of all regions supported by Cloud Functions. */ @@ -5,10 +7,25 @@ export const SUPPORTED_REGIONS = [ 'us-central1', 'us-east1', 'us-east4', + 'us-west2', + 'us-west3', + 'us-west4', + 'europe-central2', 'europe-west1', 'europe-west2', + 'europe-west3', + 'europe-west6', + 'asia-east1', 'asia-east2', 'asia-northeast1', + 'asia-northeast2', + 'asia-northeast3', + 'asia-south1', + 'asia-southeast1', + 'asia-southeast2', + 'northamerica-northeast1', + 'southamerica-east1', + 'australia-southeast1', ] as const; /** @@ -30,17 +47,38 @@ export const VALID_MEMORY_OPTIONS = [ '512MB', '1GB', '2GB', + '4GB', + '8GB', +] as const; + +/** + * List of available options for VpcConnectorEgressSettings. + */ +export const VPC_EGRESS_SETTINGS_OPTIONS = [ + 'VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED', + 'PRIVATE_RANGES_ONLY', + 'ALL_TRAFFIC', +] as const; + +/** + * List of available options for IngressSettings. + */ +export const INGRESS_SETTINGS_OPTIONS = [ + 'INGRESS_SETTINGS_UNSPECIFIED', + 'ALLOW_ALL', + 'ALLOW_INTERNAL_ONLY', + 'ALLOW_INTERNAL_AND_GCLB', ] as const; /** * Scheduler retry options. Applies only to scheduled functions. */ export interface ScheduleRetryConfig { - retryCount?: number; - maxRetryDuration?: string; - minBackoffDuration?: string; - maxBackoffDuration?: string; - maxDoublings?: number; + retryCount?: number | Expression | null; + maxRetryDuration?: string | Expression | null; + minBackoffDuration?: string | Expression | null; + maxBackoffDuration?: string | Expression | null; + maxDoublings?: number | Expression | null; } /** @@ -52,7 +90,28 @@ export interface Schedule { retryConfig?: ScheduleRetryConfig; } +export interface FailurePolicy { + retry: {}; +} + +export const DEFAULT_FAILURE_POLICY: FailurePolicy = { + retry: {}, +}; + +export const MAX_NUMBER_USER_LABELS = 58; + export interface RuntimeOptions { + /** + * Which platform should host the backend. Valid options are "gcfv1" + * @hidden + */ + platform?: 'gcfv1'; + + /** + * Failure policy of the function, with boolean `true` being equivalent to + * providing an empty retry object. + */ + failurePolicy?: FailurePolicy | boolean; /** * Amount of memory to allocate to the function. */ @@ -61,9 +120,61 @@ export interface RuntimeOptions { * Timeout for the function in seconds, possible values are 0 to 540. */ timeoutSeconds?: number; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + */ + minInstances?: number; + + /** + * Max number of actual instances allowed to be running in parallel. + */ + maxInstances?: number; + + /** + * Connect cloud function to specified VPC connector. + */ + vpcConnector?: string; + + /** + * Egress settings for VPC connector. + */ + vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number]; + + /** + * Specific service account for the function to run as. + */ + serviceAccount?: 'default' | string; + + /** + * Ingress settings which control where this function can be called from. + */ + ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number]; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /** + * Invoker to set access control on https functions. + */ + invoker?: 'public' | 'private' | string | string[]; + + /* + * Allow requests with invalid App Check tokens on callable functions. + */ + allowInvalidAppCheckToken?: boolean; + + /* + * Secrets to bind to a function instance. + */ + secrets?: string[]; } export interface DeploymentOptions extends RuntimeOptions { - regions?: Array; + regions?: Array; schedule?: Schedule; } diff --git a/src/handler-builder.ts b/src/handler-builder.ts index 22b2268aa..c976bf8e6 100644 --- a/src/handler-builder.ts +++ b/src/handler-builder.ts @@ -26,36 +26,55 @@ import { apps } from './apps'; import { CloudFunction, EventContext, HttpsFunction } from './cloud-functions'; import * as analytics from './providers/analytics'; import * as auth from './providers/auth'; -import * as crashlytics from './providers/crashlytics'; import * as database from './providers/database'; import * as firestore from './providers/firestore'; import * as https from './providers/https'; import * as pubsub from './providers/pubsub'; import * as remoteConfig from './providers/remoteConfig'; import * as storage from './providers/storage'; +import * as tasks from './providers/tasks'; import * as testLab from './providers/testLab'; +/** + * The `HandlerBuilder` class facilitates the writing of functions by developers + * building Firebase Extensions as well as developers who want to use the gcloud CLI or + * Google Cloud Console to deploy their functions. + * + * **Do not use `HandlerBuilder` when writing normal functions for deployment via + * the Firebase CLI.** For normal purposes, use + * [`FunctionBuilder`](/docs/reference/functions/function_builder_.functionbuilder). + */ export class HandlerBuilder { constructor() {} + /** + * Create a handler for HTTPS events. + + * `onRequest` handles an HTTPS request and has the same signature as an Express app. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.https.onRequest((req, res) => { ... }) + * ``` + * + * `onCall` declares a callable function for clients to call using a Firebase SDK. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.https.onCall((data, context) => { ... }) + * ``` + */ get https() { return { - /** - * Handle HTTP requests. - * @param handler A function that takes a request and response object, - * same signature as an Express app. - */ onRequest: ( handler: (req: express.Request, resp: express.Response) => void ): HttpsFunction => { const func = https._onRequestWithOptions(handler, {}); func.__trigger = {}; + func.__endpoint = undefined; + func.__requiredAPIs = undefined; return func; }, - /** - * Declares a callable method for clients to call using a Firebase SDK. - * @param handler A method that takes a data and context and returns a value. - */ onCall: ( handler: ( data: any, @@ -64,17 +83,78 @@ export class HandlerBuilder { ): HttpsFunction => { const func = https._onCallWithOptions(handler, {}); func.__trigger = {}; + func.__endpoint = undefined; + func.__requiredAPIs = undefined; return func; }, }; } + /** + * Create a handler for tasks functions. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.tasks.onDispatch((data, context) => { ... }) + * ``` + */ + /** @hidden */ + get tasks() { + return { + get taskQueue() { + return { + onDispatch: ( + handler: ( + data: any, + context: tasks.TaskContext + ) => void | Promise + ): HttpsFunction => { + const builder = new tasks.TaskQueueBuilder(); + const func = builder.onDispatch(handler); + func.__trigger = {}; + func.__endpoint = undefined; + func.__requiredAPIs = undefined; + return func; + }, + }; + }, + }; + } + + /** + * Create a handler for Firebase Realtime Database events. + * + * `ref.onCreate` handles the creation of new data. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.database.ref.onCreate((snap, context) => { ... }) + * ``` + * + * `ref.onUpdate` handles updates to existing data. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.database.ref.onUpdate((change, context) => { ... }) + * ``` + + * `ref.onDelete` handles the deletion of existing data. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.database.ref.onDelete((snap, context) => { ... }) + * ``` + + * `ref.onWrite` handles the creation, update, or deletion of data. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.database.ref.onWrite((change, context) => { ... }) + * ``` + */ get database() { return { - /** - * Selects a database instance that will trigger the function. - * If omitted, will pick the default database for your project. - */ + /** @hidden */ get instance() { return { get ref() { @@ -82,41 +162,47 @@ export class HandlerBuilder { }, }; }, - - /** - * Select Firebase Realtime Database Reference to listen to. - * - * This method behaves very similarly to the method of the same name in the - * client and Admin Firebase SDKs. Any change to the Database that affects the - * data at or below the provided `path` will fire an event in Cloud Functions. - * - * There are three important differences between listening to a Realtime - * Database event in Cloud Functions and using the Realtime Database in the - * client and Admin SDKs: - * 1. Cloud Functions allows wildcards in the `path` name. Any `path` component - * in curly brackets (`{}`) is a wildcard that matches all strings. The value - * that matched a certain invocation of a Cloud Function is returned as part - * of the `context.params` object. For example, `ref("messages/{messageId}")` - * matches changes at `/messages/message1` or `/messages/message2`, resulting - * in `context.params.messageId` being set to `"message1"` or `"message2"`, - * respectively. - * 2. Cloud Functions do not fire an event for data that already existed before - * the Cloud Function was deployed. - * 3. Cloud Function events have access to more information, including information - * about the user who triggered the Cloud Function. - */ get ref() { return new database.RefBuilder(apps(), () => null, {}); }, }; } + /** + * Create a handler for Cloud Firestore events. + * + * `document.onCreate` handles the creation of new documents. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.firestore.document.onCreate((snap, context) => { ... }) + * ``` + + * `document.onUpdate` handles updates to existing documents. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.firestore.document.onUpdate((change, context) => { ... }) + * ``` + + * `document.onDelete` handles the deletion of existing documents. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.firestore.document.onDelete((snap, context) => + * { ... }) + * ``` + + * `document.onWrite` handles the creation, update, or deletion of documents. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.firestore.document.onWrite((change, context) => + * { ... }) + * ``` + */ get firestore() { return { - /** - * Listen for events on a Firestore document. A Firestore document contains a set of - * key-value pairs and may contain subcollections and nested objects. - */ get document() { return new firestore.DocumentBuilder(() => null, {}); }, @@ -131,26 +217,18 @@ export class HandlerBuilder { }; } - get crashlytics() { - return { - /** - * Handle events related to Crashlytics issues. An issue in Crashlytics is an - * aggregation of crashes which have a shared root cause. - */ - get issue() { - return new crashlytics.IssueBuilder(() => null, {}); - }, - }; - } + /** + * Create a handler for Firebase Remote Config events. + * `remoteConfig.onUpdate` handles events that update a Remote Config template. + + * @example + * ```javascript + * exports.myFunction = functions.handler.remoteConfig.onUpdate() => { ... }) + * ``` + */ get remoteConfig() { return { - /** - * Handle all updates (including rollbacks) that affect a Remote Config - * project. - * @param handler A function that takes the updated Remote Config template - * version metadata as an argument. - */ onUpdate: ( handler: ( version: remoteConfig.TemplateVersion, @@ -162,61 +240,134 @@ export class HandlerBuilder { }; } + /** + * Create a handler for Google Analytics events. + + * `event.onLog` handles the logging of Analytics conversion events. + + * @example + * ```javascript + * exports.myFunction = functions.handler.analytics.event.onLog((event) => { ... }) + * ``` + */ get analytics() { return { - /** - * Select analytics events to listen to for events. - */ get event() { return new analytics.AnalyticsEventBuilder(() => null, {}); }, }; } + /** + * Create a handler for Cloud Storage for Firebase events. + * + * `object.onArchive` handles the archiving of Storage objects. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.storage.object.onArchive((object) => { ... }) + * ``` + + * `object.onDelete` handles the deletion of Storage objects. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.storage.object.onDelete((object) => { ... }) + * ``` + + * `object.onFinalize` handles the creation of Storage objects. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.storage.object.onFinalize((object) => + * { ... }) + * ``` + + * `object.onMetadataUpdate` handles changes to the metadata of existing Storage objects. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.storage.object.onMetadataUpdate((object) => + * { ... }) + * ``` + */ get storage() { return { - /** - * The optional bucket function allows you to choose which buckets' events to handle. - * This step can be bypassed by calling object() directly, which will use the default - * Cloud Storage for Firebase bucket. - */ get bucket() { return new storage.BucketBuilder(() => null, {}).object(); }, - /** - * Handle events related to Cloud Storage objects. - */ get object() { return new storage.ObjectBuilder(() => null, {}); }, }; } + /** + * Create a handler for Cloud Pub/Sub events. + * + * `topic.onPublish` handles messages published to a Pub/Sub topic from SDKs, Cloud Console, or gcloud CLI. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.pubsub.topic.onPublish((message) => { ... }) + * ``` + + * `schedule.onPublish` handles messages published to a Pub/Sub topic on a schedule. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.pubsub.schedule.onPublish((message) => { ... }) + * ``` + */ get pubsub() { return { - /** - * Select Cloud Pub/Sub topic to listen to. - */ get topic() { return new pubsub.TopicBuilder(() => null, {}); }, + get schedule() { + return new pubsub.ScheduleBuilder(() => null, {}); + }, }; } + /** + * Create a handler for Firebase Authentication events. + * + * `user.onCreate` handles the creation of users. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.auth.user.onCreate((user) => { ... }) + * ``` + + * `user.onDelete` handles the deletion of users. + * + * @example + * ```javascript + * exports.myFunction = functions.handler.auth.user.onDelete((user => { ... }) + * ``` + + */ get auth() { return { - /** - * Handle events related to Firebase authentication users. - */ get user() { - return new auth.UserBuilder(() => null, {}); + return new auth.UserBuilder(() => null, {}, {}); }, }; } + /** + * Create a handler for Firebase Test Lab events. + + * `testMatrix.onComplete` handles the completion of a test matrix. + + * @example + * ```javascript + * exports.myFunction = functions.handler.testLab.testMatrix.onComplete((testMatrix) => { ... }) + * ``` + */ get testLab() { - /** Handle events related to Test Lab test matrices. */ return { get testMatrix() { return new testLab.TestMatrixBuilder(() => null, {}); diff --git a/src/index.ts b/src/index.ts index d4951c512..a77ba3ff9 100644 --- a/src/index.ts +++ b/src/index.ts @@ -23,17 +23,18 @@ // Providers: import * as analytics from './providers/analytics'; import * as auth from './providers/auth'; -import * as crashlytics from './providers/crashlytics'; import * as database from './providers/database'; import * as firestore from './providers/firestore'; import * as https from './providers/https'; import * as pubsub from './providers/pubsub'; import * as remoteConfig from './providers/remoteConfig'; import * as storage from './providers/storage'; +import * as tasks from './providers/tasks'; import * as testLab from './providers/testLab'; import * as apps from './apps'; import { handler } from './handler-builder'; +import * as logger from './logger'; import { setup } from './setup'; const app = apps.apps(); @@ -42,7 +43,6 @@ export { analytics, app, auth, - crashlytics, database, firestore, handler, @@ -50,7 +50,9 @@ export { pubsub, remoteConfig, storage, + tasks, testLab, + logger, }; // Exported root types: diff --git a/src/logger/common.ts b/src/logger/common.ts new file mode 100644 index 000000000..020883bbb --- /dev/null +++ b/src/logger/common.ts @@ -0,0 +1,52 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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. + +// Determine if structured logs are supported (node >= 10). If something goes wrong, +// assume no since unstructured is safer. +/** @hidden */ +export const SUPPORTS_STRUCTURED_LOGS = + parseInt(process.versions?.node?.split('.')?.[0] || '8', 10) >= 10; + +// Map LogSeverity types to their equivalent `console.*` method. +/** @hidden */ +export const CONSOLE_SEVERITY: { + [severity: string]: 'debug' | 'info' | 'warn' | 'error'; +} = { + DEBUG: 'debug', + INFO: 'info', + NOTICE: 'info', + WARNING: 'warn', + ERROR: 'error', + CRITICAL: 'error', + ALERT: 'error', + EMERGENCY: 'error', +}; + +// safely preserve unpatched console.* methods in case of compat require +/** @hidden */ +export const UNPATCHED_CONSOLE = { + debug: console.debug, + info: console.info, + log: console.log, + warn: console.warn, + error: console.error, +}; diff --git a/src/logger/compat.ts b/src/logger/compat.ts new file mode 100644 index 000000000..7300a197b --- /dev/null +++ b/src/logger/compat.ts @@ -0,0 +1,49 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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 { format } from 'util'; +import { + CONSOLE_SEVERITY, + SUPPORTS_STRUCTURED_LOGS, + UNPATCHED_CONSOLE, +} from './common'; + +/** @hidden */ +function patchedConsole(severity: string): (data: any, ...args: any[]) => void { + return function(data: any, ...args: any[]): void { + if (SUPPORTS_STRUCTURED_LOGS) { + UNPATCHED_CONSOLE[CONSOLE_SEVERITY[severity]]( + JSON.stringify({ severity, message: format(data, ...args) }) + ); + return; + } + + UNPATCHED_CONSOLE[CONSOLE_SEVERITY[severity]](data, ...args); + }; +} + +// IMPORTANT -- "../logger" must be imported before monkeypatching! +console.debug = patchedConsole('DEBUG'); +console.info = patchedConsole('INFO'); +console.log = patchedConsole('INFO'); +console.warn = patchedConsole('WARNING'); +console.error = patchedConsole('ERROR'); diff --git a/src/logger/index.ts b/src/logger/index.ts new file mode 100644 index 000000000..02750f845 --- /dev/null +++ b/src/logger/index.ts @@ -0,0 +1,181 @@ +// The MIT License (MIT) +// +// Copyright (c) 2017 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 { format } from 'util'; + +import { + CONSOLE_SEVERITY, + SUPPORTS_STRUCTURED_LOGS, + UNPATCHED_CONSOLE, +} from './common'; + +/** + * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity). + * @public + */ +export type LogSeverity = + | 'DEBUG' + | 'INFO' + | 'NOTICE' + | 'WARNING' + | 'ERROR' + | 'CRITICAL' + | 'ALERT' + | 'EMERGENCY'; + +/** + * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging) + * entry. All keys aside from `severity` and `message` are + * included in the `jsonPayload` of the logged entry. + * @public + */ +export interface LogEntry { + severity: LogSeverity; + message?: string; + [key: string]: any; +} + +/** @internal */ +function removeCircular(obj: any, refs: any[] = []): any { + if (typeof obj !== 'object' || !obj) { + return obj; + } + // If the object defines its own toJSON, prefer that. + if (obj.toJSON) { + return obj.toJSON(); + } + if (refs.includes(obj)) { + return '[Circular]'; + } else { + refs.push(obj); + } + let returnObj: any; + if (Array.isArray(obj)) { + returnObj = new Array(obj.length); + } else { + returnObj = {}; + } + for (const k in obj) { + if (refs.includes(obj[k])) { + returnObj[k] = '[Circular]'; + } else { + returnObj[k] = removeCircular(obj[k], refs); + } + } + return returnObj; +} + +/** + * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity). + * @param entry - The `LogEntry` including severity, message, and any additional structured metadata. + * @public + */ +export function write(entry: LogEntry) { + if (SUPPORTS_STRUCTURED_LOGS) { + UNPATCHED_CONSOLE[CONSOLE_SEVERITY[entry.severity]]( + JSON.stringify(removeCircular(entry)) + ); + return; + } + + let message = entry.message || ''; + const jsonPayload: { [key: string]: any } = {}; + let jsonKeyCount = 0; + for (const k in entry) { + if (!['severity', 'message'].includes(k)) { + jsonKeyCount++; + jsonPayload[k] = entry[k]; + } + } + if (jsonKeyCount > 0) { + message = `${message} ${JSON.stringify( + removeCircular(jsonPayload), + null, + 2 + )}`; + } + UNPATCHED_CONSOLE[CONSOLE_SEVERITY[entry.severity]](message); +} + +/** + * Writes a `DEBUG` severity log. If the last argument provided is a plain object, + * it is added to the `jsonPayload` in the Cloud Logging entry. + * @param args - Arguments, concatenated into the log message with space separators. + * @public + */ +export function debug(...args: any[]) { + write(entryFromArgs('DEBUG', args)); +} + +/** + * Writes an `INFO` severity log. If the last argument provided is a plain object, + * it is added to the `jsonPayload` in the Cloud Logging entry. + * @param args - Arguments, concatenated into the log message with space separators. + * @public + */ +export function log(...args: any[]) { + write(entryFromArgs('INFO', args)); +} + +/** + * Writes an `INFO` severity log. If the last argument provided is a plain object, + * it is added to the `jsonPayload` in the Cloud Logging entry. + * @param args - Arguments, concatenated into the log message with space separators. + * @public + */ +export function info(...args: any[]) { + write(entryFromArgs('INFO', args)); +} + +/** + * Writes a `WARNING` severity log. If the last argument provided is a plain object, + * it is added to the `jsonPayload` in the Cloud Logging entry. + * @param args - Arguments, concatenated into the log message with space separators. + * @public + */ +export function warn(...args: any[]) { + write(entryFromArgs('WARNING', args)); +} + +/** + * Writes an `ERROR` severity log. If the last argument provided is a plain object, + * it is added to the `jsonPayload` in the Cloud Logging entry. + * @param args - Arguments, concatenated into the log message with space separators. + * @public + */ +export function error(...args: any[]) { + write(entryFromArgs('ERROR', args)); +} + +/** @hidden */ +function entryFromArgs(severity: LogSeverity, args: any[]): LogEntry { + let entry = {}; + const lastArg = args[args.length - 1]; + if (lastArg && typeof lastArg == 'object' && lastArg.constructor == Object) { + entry = args.pop(); + } + return Object.assign({}, entry, { + severity, + // mimic `console.*` behavior, see https://nodejs.org/api/console.html#console_console_log_data_args + message: format.apply(null, args), + }); +} diff --git a/src/providers/analytics.ts b/src/providers/analytics.ts index 43578f8b6..2d57d6f5e 100644 --- a/src/providers/analytics.ts +++ b/src/providers/analytics.ts @@ -184,7 +184,7 @@ export class UserDimensions { * A map of user properties set with the * [`setUserProperty`](https://firebase.google.com/docs/analytics/android/properties) API. * - * All values are [`UserPropertyValue`](functions.analytics.UserPropertyValue) objects. + * All values are [`UserPropertyValue`](providers_analytics_.userpropertyvalue) objects. */ userProperties: { [key: string]: UserPropertyValue }; @@ -319,7 +319,8 @@ export interface DeviceInfo { /** * The time zone of the device when data was uploaded, as seconds skew from UTC. - * Use this to calculate the device's local time for [`event.timestamp`](functions.Event#timestamp). + * Use this to calculate the device's local time for + * [`EventContext.timestamp`](cloud_functions_eventcontext.html#timestamp). */ deviceTimeZoneOffsetSeconds: number; diff --git a/src/providers/auth.ts b/src/providers/auth.ts index 7274399b2..f845424ea 100644 --- a/src/providers/auth.ts +++ b/src/providers/auth.ts @@ -20,76 +20,148 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. -import * as firebase from 'firebase-admin'; -import * as _ from 'lodash'; import { + BlockingFunction, CloudFunction, Event, EventContext, makeCloudFunction, + optionsToEndpoint, + optionsToTrigger, } from '../cloud-functions'; +import { + AuthBlockingEventType, + AuthEventContext, + AuthUserRecord, + BeforeCreateResponse, + BeforeSignInResponse, + HttpsError, + UserInfo, + UserRecord, + userRecordConstructor, + UserRecordMetadata, + wrapHandler, +} from '../common/providers/identity'; import { DeploymentOptions } from '../function-configuration'; +// TODO: yank in next breaking change release +export { UserRecord, UserInfo, UserRecordMetadata, userRecordConstructor }; + +export { HttpsError }; + /** @hidden */ export const provider = 'google.firebase.auth'; /** @hidden */ export const service = 'firebaseauth.googleapis.com'; /** - * Handle events related to Firebase authentication users. + * Resource level options + * @public */ -export function user() { - return _userWithOptions({}); -} +export interface UserOptions { + /** Options to set configuration at the resource level for blocking functions. */ + blockingOptions?: { + /** Pass the ID Token credential to the function. */ + idToken?: boolean; -/** @hidden */ -export function _userWithOptions(options: DeploymentOptions) { - return new UserBuilder(() => { - if (!process.env.GCLOUD_PROJECT) { - throw new Error('process.env.GCLOUD_PROJECT is not set.'); - } - return 'projects/' + process.env.GCLOUD_PROJECT; - }, options); + /** Pass the Access Token credential to the function. */ + accessToken?: boolean; + + /** Pass the Refresh Token credential to the function. */ + refreshToken?: boolean; + }; } -export class UserRecordMetadata implements firebase.auth.UserMetadata { - constructor(public creationTime: string, public lastSignInTime: string) {} +/** + * Handles events related to Firebase authentication users. + * @param userOptions - Resource level options + * @returns UserBuilder - Builder used to create Cloud Functions for Firebase Auth user lifecycle events + * @public + */ +export function user(userOptions?: UserOptions): UserBuilder { + return _userWithOptions({}, userOptions || {}); +} - /** Returns a plain JavaScript object with the properties of UserRecordMetadata. */ - toJSON() { - return { - creationTime: this.creationTime, - lastSignInTime: this.lastSignInTime, - }; - } +/** @hidden */ +export function _userWithOptions( + options: DeploymentOptions, + userOptions: UserOptions +) { + return new UserBuilder( + () => { + if (!process.env.GCLOUD_PROJECT) { + throw new Error('process.env.GCLOUD_PROJECT is not set.'); + } + return 'projects/' + process.env.GCLOUD_PROJECT; + }, + options, + userOptions + ); } -/** Builder used to create Cloud Functions for Firebase Auth user lifecycle events. */ +/** + * Builder used to create Cloud Functions for Firebase Auth user lifecycle events. + * @public + */ export class UserBuilder { - private static dataConstructor(raw: Event): firebase.auth.UserRecord { + private static dataConstructor(raw: Event): UserRecord { return userRecordConstructor(raw.data); } /** @hidden */ constructor( private triggerResource: () => string, - private options?: DeploymentOptions + private options: DeploymentOptions, + private userOptions?: UserOptions ) {} - /** Respond to the creation of a Firebase Auth user. */ + /** + * Responds to the creation of a Firebase Auth user. + * @public + */ onCreate( handler: (user: UserRecord, context: EventContext) => PromiseLike | any ): CloudFunction { return this.onOperation(handler, 'user.create'); } - /** Respond to the deletion of a Firebase Auth user. */ + /** + * Responds to the deletion of a Firebase Auth user. + * @public + */ onDelete( handler: (user: UserRecord, context: EventContext) => PromiseLike | any ): CloudFunction { return this.onOperation(handler, 'user.delete'); } + beforeCreate( + handler: ( + user: AuthUserRecord, + context: AuthEventContext + ) => + | BeforeCreateResponse + | void + | Promise + | Promise + ): BlockingFunction { + return this.beforeOperation(handler, 'beforeCreate'); + } + + beforeSignIn( + handler: ( + user: AuthUserRecord, + context: AuthEventContext + ) => + | BeforeSignInResponse + | void + | Promise + | Promise + ): BlockingFunction { + return this.beforeOperation(handler, 'beforeSignIn'); + } + + /** @hidden */ private onOperation( handler: ( user: UserRecord, @@ -108,73 +180,70 @@ export class UserBuilder { options: this.options, }); } -} -/** - * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin - * SDK. - */ -export type UserRecord = firebase.auth.UserRecord; + /** @hidden */ + private beforeOperation( + handler: ( + user: AuthUserRecord, + context: AuthEventContext + ) => + | BeforeCreateResponse + | BeforeSignInResponse + | void + | Promise + | Promise + | Promise, + eventType: AuthBlockingEventType + ): BlockingFunction { + const accessToken = this.userOptions?.blockingOptions?.accessToken || false; + const idToken = this.userOptions?.blockingOptions?.idToken || false; + const refreshToken = + this.userOptions?.blockingOptions?.refreshToken || false; -/** - * UserInfo that is part of the UserRecord - */ -export type UserInfo = firebase.auth.UserInfo; - -export function userRecordConstructor( - wireData: Object -): firebase.auth.UserRecord { - // Falsey values from the wire format proto get lost when converted to JSON, this adds them back. - const falseyValues: any = { - email: null, - emailVerified: false, - displayName: null, - photoURL: null, - phoneNumber: null, - disabled: false, - providerData: [], - customClaims: {}, - passwordSalt: null, - passwordHash: null, - tokensValidAfterTime: null, - }; - const record = _.assign({}, falseyValues, wireData); - - const meta = _.get(record, 'metadata'); - if (meta) { - _.set( - record, - 'metadata', - new UserRecordMetadata( - meta.createdAt || meta.creationTime, - meta.lastSignedInAt || meta.lastSignInTime - ) - ); - } else { - _.set(record, 'metadata', new UserRecordMetadata(null, null)); + // Create our own function that just calls the provided function so we know for sure that + // handler takes two arguments. This is something common/providers/identity depends on. + const wrappedHandler = (user: AuthUserRecord, context: AuthEventContext) => + handler(user, context); + const func: any = wrapHandler(eventType, wrappedHandler); + + const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`; + + func.__trigger = { + labels: {}, + ...optionsToTrigger(this.options), + blockingTrigger: { + eventType: legacyEventType, + options: { + accessToken, + idToken, + refreshToken, + }, + }, + }; + + func.__endpoint = { + platform: 'gcfv1', + labels: {}, + ...optionsToEndpoint(this.options), + blockingTrigger: { + eventType: legacyEventType, + options: { + accessToken, + idToken, + refreshToken, + }, + }, + }; + + func.__requiredAPIs = [ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]; + + func.run = handler; + + return func; } - _.forEach(record.providerData, (entry) => { - _.set(entry, 'toJSON', () => { - return entry; - }); - }); - _.set(record, 'toJSON', () => { - const json: any = _.pick(record, [ - 'uid', - 'email', - 'emailVerified', - 'displayName', - 'photoURL', - 'phoneNumber', - 'disabled', - 'passwordHash', - 'passwordSalt', - 'tokensValidAfterTime', - ]); - json.metadata = _.get(record, 'metadata').toJSON(); - json.customClaims = _.cloneDeep(record.customClaims); - json.providerData = _.map(record.providerData, (entry) => entry.toJSON()); - return json; - }); - return record as firebase.auth.UserRecord; } diff --git a/src/providers/crashlytics.ts b/src/providers/crashlytics.ts deleted file mode 100644 index e7a6fe882..000000000 --- a/src/providers/crashlytics.ts +++ /dev/null @@ -1,197 +0,0 @@ -// The MIT License (MIT) -// -// Copyright (c) 2017 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 { - CloudFunction, - EventContext, - makeCloudFunction, -} from '../cloud-functions'; -import { DeploymentOptions } from '../function-configuration'; - -/** @hidden */ -export const provider = 'google.firebase.crashlytics'; -/** @hidden */ -export const service = 'fabric.io'; - -/** - * Registers a Cloud Function to handle Crashlytics issue events. - * - * @returns Crashlytics issue event builder interface. - */ -export function issue() { - return _issueWithOptions({}); -} - -/** @hidden */ -export function _issueWithOptions(options: DeploymentOptions) { - return new IssueBuilder(() => { - if (!process.env.GCLOUD_PROJECT) { - throw new Error('process.env.GCLOUD_PROJECT is not set.'); - } - return 'projects/' + process.env.GCLOUD_PROJECT; - }, options); -} - -/** The Firebase Crashlytics issue builder interface. */ -export class IssueBuilder { - /** @hidden */ - constructor( - private triggerResource: () => string, - private options: DeploymentOptions - ) {} - - /** @hidden */ - onNewDetected(handler: any): Error { - throw new Error('"onNewDetected" is now deprecated, please use "onNew"'); - } - - /** - * Event handler that fires every time a new issue occurs in a project. - * - * @param handler Event handler that fires every time a new issue event occurs. - * @example - * ```javascript - * exports.postOnNewIssue = functions.crashlytics.issue().onNew(event => { - * const { data } = event; - * issueId = data.issueId; - * issueTitle = data.issueTitle; - * const slackMessage = ` There's a new issue (${issueId}) ` + - * `in your app - ${issueTitle}`; - * return notifySlack(slackMessage).then(() => { - * console.log(`Posted new issue ${issueId} successfully to Slack`); - * }); - * }); - * ``` - */ - onNew( - handler: (issue: Issue, context: EventContext) => PromiseLike | any - ): CloudFunction { - return this.onEvent(handler, 'issue.new'); - } - - /** - * Event handler that fires every time a regressed issue reoccurs in a project. - * - * @param handler Event handler that fires every time a regressed issue event occurs. - */ - onRegressed( - handler: (issue: Issue, context: EventContext) => PromiseLike | any - ): CloudFunction { - return this.onEvent(handler, 'issue.regressed'); - } - - /** - * Event handler that fires every time a velocity alert occurs in a project. - * - * @param handler handler that fires every time a velocity alert issue event occurs. - */ - onVelocityAlert( - handler: (issue: Issue, context: EventContext) => PromiseLike | any - ): CloudFunction { - return this.onEvent(handler, 'issue.velocityAlert'); - } - - private onEvent( - handler: (issue: Issue, context: EventContext) => PromiseLike | any, - eventType: string - ): CloudFunction { - return makeCloudFunction({ - handler, - provider, - eventType, - service, - legacyEventType: `providers/firebase.crashlytics/eventTypes/${eventType}`, - triggerResource: this.triggerResource, - options: this.options, - }); - } -} - -/** - * Interface representing a Firebase Crashlytics event that was logged for a specific issue. - */ -export interface Issue { - /** Crashlytics-provided issue ID. */ - issueId: string; - - /** Crashlytics-provided issue title. */ - issueTitle: string; - - /** AppInfo interface describing the App. */ - appInfo: AppInfo; - - /** - * UTC when the issue occurred in ISO8601 standard representation. - * - * Example: 1970-01-17T10:52:15.661-08:00 - */ - createTime: string; - - /** - * UTC When the issue was closed in ISO8601 standard representation. - * - * Example: 1970-01-17T10:52:15.661-08:00 - */ - resolvedTime?: string; - - /** Information about the velocity alert, like number of crashes and percentage of users affected by the issue. */ - velocityAlert?: VelocityAlert; -} - -/** Interface representing Firebase Crashlytics VelocityAlert data. */ -export interface VelocityAlert { - /** - * The percentage of sessions which have been impacted by this issue. - * - * Example: .04 - */ - crashPercentage: number; - - /** The number of crashes that this issue has caused. */ - crashes: number; -} - -/** Interface representing Firebase Crashlytics AppInfo data. */ -export interface AppInfo { - /** - * The app's name. - * - * Example: "My Awesome App". - */ - appName: string; - - /** The app's platform. - * - * Examples: "android", "ios". - */ - appPlatform: string; - - /** Unique application identifier within an app store, either the Android package name or the iOS bundle id. */ - appId: string; - - /** - * The app's version name. - * - * Examples: "1.0", "4.3.1.1.213361", "2.3 (1824253)", "v1.8b22p6". - */ - latestAppVersion: string; -} diff --git a/src/providers/database.ts b/src/providers/database.ts index 8a2f9453a..39feaf0e8 100644 --- a/src/providers/database.ts +++ b/src/providers/database.ts @@ -20,28 +20,29 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. -import * as firebase from 'firebase-admin'; -import * as _ from 'lodash'; import { apps } from '../apps'; import { - Change, CloudFunction, Event, EventContext, makeCloudFunction, } from '../cloud-functions'; +import { Change } from '../common/change'; +import { DataSnapshot } from '../common/providers/database'; import { firebaseConfig } from '../config'; import { DeploymentOptions } from '../function-configuration'; -import { joinPath, normalizePath, pathParts } from '../utilities/path'; +import { normalizePath } from '../utilities/path'; import { applyChange } from '../utils'; +export { DataSnapshot }; + /** @hidden */ export const provider = 'google.firebase.database'; /** @hidden */ export const service = 'firebaseio.com'; -// NOTE(inlined): Should we relax this a bit to allow staging or alternate implementations of our API? -const databaseURLRegex = new RegExp('https://([^.]+).firebaseio.com'); +const databaseURLRegex = new RegExp('^https://([^.]+).'); +const emulatorDatabaseURLRegex = new RegExp('^http://.*ns=([^&]+)'); /** * Registers a function that triggers on events from a specific @@ -75,7 +76,7 @@ export function instance(instance: string) { * 1. Cloud Functions allows wildcards in the `path` name. Any `path` component * in curly brackets (`{}`) is a wildcard that matches all strings. The value * that matched a certain invocation of a Cloud Function is returned as part - * of the [`event.params`](functions.EventContext#params) object. For + * of the [`EventContext.params`](cloud_functions_eventcontext.html#params object. For * example, `ref("messages/{messageId}")` matches changes at * `/messages/message1` or `/messages/message2`, resulting in * `event.params.messageId` being set to `"message1"` or `"message2"`, @@ -104,7 +105,7 @@ export function _instanceWithOptions( /** * The Firebase Realtime Database instance builder interface. * - * Access via [`functions.database.instance()`](functions.database#.instance). + * Access via [`database.instance()`](providers_database_.html#instance). */ export class InstanceBuilder { /** @hidden */ @@ -139,14 +140,25 @@ export function _refWithOptions( '\n If you are unit testing, please set process.env.FIREBASE_CONFIG' ); } - const match = databaseURL.match(databaseURLRegex); - if (!match) { + + let instance; + const prodMatch = databaseURL.match(databaseURLRegex); + if (prodMatch) { + instance = prodMatch[1]; + } else { + const emulatorMatch = databaseURL.match(emulatorDatabaseURLRegex); + if (emulatorMatch) { + instance = emulatorMatch[1]; + } + } + + if (!instance) { throw new Error( 'Invalid value for config firebase.databaseURL: ' + databaseURL ); } - const subdomain = match[1]; - return `projects/_/instances/${subdomain}/refs/${normalized}`; + + return `projects/_/instances/${instance}/refs/${normalized}`; }; return new RefBuilder(apps(), resourceGetter, options); @@ -215,8 +227,9 @@ export class RefBuilder { ) => PromiseLike | any ): CloudFunction { const dataConstructor = (raw: Event) => { - const [dbInstance, path] = resourceToInstanceAndPath( - raw.context.resource.name + const [dbInstance, path] = extractInstanceAndPath( + raw.context.resource.name, + raw.context.domain ); return new DataSnapshot( raw.data.delta, @@ -243,8 +256,9 @@ export class RefBuilder { ) => PromiseLike | any ): CloudFunction { const dataConstructor = (raw: Event) => { - const [dbInstance, path] = resourceToInstanceAndPath( - raw.context.resource.name + const [dbInstance, path] = extractInstanceAndPath( + raw.context.resource.name, + raw.context.domain ); return new DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance); }; @@ -271,8 +285,9 @@ export class RefBuilder { } private changeConstructor = (raw: Event): Change => { - const [dbInstance, path] = resourceToInstanceAndPath( - raw.context.resource.name + const [dbInstance, path] = extractInstanceAndPath( + raw.context.resource.name, + raw.context.domain ); const before = new DataSnapshot( raw.data.data, @@ -293,10 +308,21 @@ export class RefBuilder { }; } -/* Utility function to extract database reference from resource string */ +const resourceRegex = /^projects\/([^/]+)\/instances\/([a-zA-Z0-9-]+)\/refs(\/.+)?/; + +/** + * Utility function to extract database reference from resource string + * + * @param optional database domain override for the original of the source database. + * It defaults to `firebaseio.com`. + * Multi-region RTDB will be served from different domains. + * Since region is not part of the resource name, it is provided through context. + */ /** @hidden */ -export function resourceToInstanceAndPath(resource: string) { - const resourceRegex = `projects/([^/]+)/instances/([a-zA-Z0-9\-^/]+)/refs(/.+)?`; +export function extractInstanceAndPath( + resource: string, + domain = 'firebaseio.com' +) { const match = resource.match(new RegExp(resourceRegex)); if (!match) { throw new Error( @@ -310,292 +336,13 @@ export function resourceToInstanceAndPath(resource: string) { `Expect project to be '_' in a Firebase Realtime Database event` ); } - const dbInstance = 'https://' + dbInstanceName + '.firebaseio.com'; - return [dbInstance, path]; -} - -/** - * Interface representing a Firebase Realtime Database data snapshot. - */ -export class DataSnapshot { - public instance: string; - - /** @hidden */ - private _ref: firebase.database.Reference; - - /** @hidden */ - private _path: string; - - /** @hidden */ - private _data: any; - - /** @hidden */ - private _childPath: string; - - constructor( - data: any, - path?: string, // path will be undefined for the database root - private app?: firebase.app.App, - instance?: string - ) { - if (instance) { - // SDK always supplies instance, but user's unit tests may not - this.instance = instance; - } else if (app) { - this.instance = app.options.databaseURL; - } else if (process.env.GCLOUD_PROJECT) { - this.instance = - 'https://' + process.env.GCLOUD_PROJECT + '.firebaseio.com'; - } - - this._path = path; - this._data = data; - } - - /** - * Returns a [`Reference`](/docs/reference/admin/node/admin.database.Reference) - * to the Database location where the triggering write occurred. Has - * full read and write access. - */ - get ref(): firebase.database.Reference { - if (!this.app) { - // may be unpopulated in user's unit tests - throw new Error( - 'Please supply a Firebase app in the constructor for DataSnapshot' + - ' in order to use the .ref method.' - ); - } - if (!this._ref) { - this._ref = this.app.database(this.instance).ref(this._fullPath()); - } - return this._ref; - } - - /** - * The key (last part of the path) of the location of this `DataSnapshot`. - * - * The last token in a Database location is considered its key. For example, - * "ada" is the key for the `/users/ada/` node. Accessing the key on any - * `DataSnapshot` will return the key for the location that generated it. - * However, accessing the key on the root URL of a Database will return `null`. - */ - get key(): string { - const last = _.last(pathParts(this._fullPath())); - return !last || last === '' ? null : last; - } - - /** - * Extracts a JavaScript value from a `DataSnapshot`. - * - * Depending on the data in a `DataSnapshot`, the `val()` method may return a - * scalar type (string, number, or boolean), an array, or an object. It may also - * return `null`, indicating that the `DataSnapshot` is empty (contains no - * data). - * - * @return The DataSnapshot's contents as a JavaScript value (Object, - * Array, string, number, boolean, or `null`). - */ - val(): any { - const parts = pathParts(this._childPath); - const source = this._data; - const node = _.cloneDeep( - parts.length ? _.get(source, parts, null) : source - ); - return this._checkAndConvertToArray(node); - } - - /** - * Exports the entire contents of the `DataSnapshot` as a JavaScript object. - * - * The `exportVal()` method is similar to `val()`, except priority information - * is included (if available), making it suitable for backing up your data. - * - * @return The contents of the `DataSnapshot` as a JavaScript value - * (Object, Array, string, number, boolean, or `null`). - */ - exportVal(): any { - return this.val(); - } - - /** - * Gets the priority value of the data in this `DataSnapshot`. - * - * As an alternative to using priority, applications can order collections by - * ordinary properties. See [Sorting and filtering - * data](/docs/database/web/lists-of-data#sorting_and_filtering_data). - * - * @return The priority value of the data. - */ - getPriority(): string | number | null { - return 0; - } - - /** - * Returns `true` if this `DataSnapshot` contains any data. It is slightly more - * efficient than using `snapshot.val() !== null`. - * - * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`. - */ - exists(): boolean { - return !_.isNull(this.val()); - } - - /** - * Gets a `DataSnapshot` for the location at the specified relative path. - * - * The relative path can either be a simple child name (for example, "ada") or - * a deeper slash-separated path (for example, "ada/name/first"). - * - * @param path A relative path from this location to the desired child - * location. - * @return The specified child location. - */ - child(childPath: string): DataSnapshot { - if (!childPath) { - return this; - } - return this._dup(childPath); - } - - /** - * Enumerates the `DataSnapshot`s of the children items. - * - * Because of the way JavaScript objects work, the ordering of data in the - * JavaScript object returned by `val()` is not guaranteed to match the ordering - * on the server nor the ordering of `child_added` events. That is where - * `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` - * will be iterated in their query order. - * - * If no explicit `orderBy*()` method is used, results are returned - * ordered by key (unless priorities are used, in which case, results are - * returned by priority). - * - * @param action A function that will be called for each child `DataSnapshot`. - * The callback can return `true` to cancel further enumeration. - * - * @return `true` if enumeration was canceled due to your callback - * returning `true`. - */ - forEach(action: (a: DataSnapshot) => boolean): boolean { - const val = this.val(); - if (_.isPlainObject(val)) { - return _.some( - val, - (value, key: string) => action(this.child(key)) === true - ); - } - return false; - } - - /** - * Returns `true` if the specified child path has (non-`null`) data. - * - * @param path A relative path to the location of a potential child. - * @return `true` if data exists at the specified child path; otherwise, - * `false`. - */ - hasChild(childPath: string): boolean { - return this.child(childPath).exists(); - } - - /** - * Returns whether or not the `DataSnapshot` has any non-`null` child - * properties. - * - * You can use `hasChildren()` to determine if a `DataSnapshot` has any - * children. If it does, you can enumerate them using `forEach()`. If it - * doesn't, then either this snapshot contains a primitive value (which can be - * retrieved with `val()`) or it is empty (in which case, `val()` will return - * `null`). - * - * @return `true` if this snapshot has any children; else `false`. - */ - hasChildren(): boolean { - const val = this.val(); - return _.isPlainObject(val) && _.keys(val).length > 0; - } - - /** - * Returns the number of child properties of this `DataSnapshot`. - * - * @return Number of child properties of this `DataSnapshot`. - */ - numChildren(): number { - const val = this.val(); - return _.isPlainObject(val) ? Object.keys(val).length : 0; - } - - /** - * Returns a JSON-serializable representation of this object. - * - * @return A JSON-serializable representation of this object. - */ - toJSON(): Object { - return this.val(); - } - - /** Recursive function to check if keys are numeric & convert node object to array if they are - * - * @hidden - */ - private _checkAndConvertToArray(node: any): any { - if (node === null || typeof node === 'undefined') { - return null; - } - if (typeof node !== 'object') { - return node; - } - const obj: any = {}; - let numKeys = 0; - let maxKey = 0; - let allIntegerKeys = true; - for (const key in node) { - if (!node.hasOwnProperty(key)) { - continue; - } - const childNode = node[key]; - obj[key] = this._checkAndConvertToArray(childNode); - numKeys++; - const integerRegExp = /^(0|[1-9]\d*)$/; - if (allIntegerKeys && integerRegExp.test(key)) { - maxKey = Math.max(maxKey, Number(key)); - } else { - allIntegerKeys = false; - } - } - - if (allIntegerKeys && maxKey < 2 * numKeys) { - // convert to array. - const array: any = []; - _.forOwn(obj, (val, key) => { - array[key] = val; - }); - - return array; - } - return obj; - } - - /** @hidden */ - private _dup(childPath?: string): DataSnapshot { - const dup = new DataSnapshot( - this._data, - undefined, - this.app, - this.instance - ); - [dup._path, dup._childPath] = [this._path, this._childPath]; - - if (childPath) { - dup._childPath = joinPath(dup._childPath, childPath); - } - - return dup; - } - /** @hidden */ - private _fullPath(): string { - const out = (this._path || '') + '/' + (this._childPath || ''); - return out; + const emuHost = process.env.FIREBASE_DATABASE_EMULATOR_HOST; + if (emuHost) { + const dbInstance = `http://${emuHost}/?ns=${dbInstanceName}`; + return [dbInstance, path]; + } else { + const dbInstance = 'https://' + dbInstanceName + '.' + domain; + return [dbInstance, path]; } } diff --git a/src/providers/firestore.ts b/src/providers/firestore.ts index 291d7d7f9..73d8eed13 100644 --- a/src/providers/firestore.ts +++ b/src/providers/firestore.ts @@ -22,17 +22,19 @@ import * as firebase from 'firebase-admin'; import * as _ from 'lodash'; + import { posix } from 'path'; import { apps } from '../apps'; import { - Change, CloudFunction, Event, EventContext, makeCloudFunction, } from '../cloud-functions'; +import { Change } from '../common/change'; import { dateToTimestampProto } from '../encoder'; import { DeploymentOptions } from '../function-configuration'; +import * as logger from '../logger'; /** @hidden */ export const provider = 'google.firestore'; @@ -42,6 +44,7 @@ export const service = 'firestore.googleapis.com'; export const defaultDatabase = '(default)'; let firestoreInstance: any; export type DocumentSnapshot = firebase.firestore.DocumentSnapshot; +export type QueryDocumentSnapshot = firebase.firestore.QueryDocumentSnapshot; /** * Select the Firestore document to listen to for events. @@ -154,7 +157,16 @@ export function snapshotConstructor(event: Event): DocumentSnapshot { event.context.resource.name, 'value' ); - const readTime = dateToTimestampProto(_.get(event, 'data.value.readTime')); + let timeString = + _.get(event, 'data.value.readTime') ?? + _.get(event, 'data.value.updateTime'); + + if (!timeString) { + logger.warn('Snapshot has no readTime. Using now()'); + timeString = new Date().toISOString(); + } + + const readTime = dateToTimestampProto(timeString); return firestoreInstance.snapshot_(valueProto, readTime, 'json'); } @@ -204,30 +216,30 @@ export class DocumentBuilder { /** Respond only to document updates. */ onUpdate( handler: ( - change: Change, + change: Change, context: EventContext ) => PromiseLike | any - ): CloudFunction> { + ): CloudFunction> { return this.onOperation(handler, 'document.update', changeConstructor); } /** Respond only to document creations. */ onCreate( handler: ( - snapshot: DocumentSnapshot, + snapshot: QueryDocumentSnapshot, context: EventContext ) => PromiseLike | any - ): CloudFunction { + ): CloudFunction { return this.onOperation(handler, 'document.create', snapshotConstructor); } /** Respond only to document deletions. */ onDelete( handler: ( - snapshot: DocumentSnapshot, + snapshot: QueryDocumentSnapshot, context: EventContext ) => PromiseLike | any - ): CloudFunction { + ): CloudFunction { return this.onOperation( handler, 'document.delete', diff --git a/src/providers/https.ts b/src/providers/https.ts index d941f67c8..842ebd84c 100644 --- a/src/providers/https.ts +++ b/src/providers/https.ts @@ -20,17 +20,25 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. -import * as cors from 'cors'; import * as express from 'express'; -import * as firebase from 'firebase-admin'; -import * as _ from 'lodash'; -import { apps } from '../apps'; -import { HttpsFunction, optionsToTrigger, Runnable } from '../cloud-functions'; + +import { + HttpsFunction, + optionsToEndpoint, + optionsToTrigger, + Runnable, +} from '../cloud-functions'; +import { convertIfPresent, convertInvoker } from '../common/encoding'; +import { + CallableContext, + FunctionsErrorCode, + HttpsError, + onCallHandler, + Request, +} from '../common/providers/https'; import { DeploymentOptions } from '../function-configuration'; -export interface Request extends express.Request { - rawBody: Buffer; -} +export { Request, CallableContext, FunctionsErrorCode, HttpsError }; /** * Handle HTTP requests. @@ -38,7 +46,7 @@ export interface Request extends express.Request { * same signature as an Express app. */ export function onRequest( - handler: (req: Request, resp: express.Response) => void + handler: (req: Request, resp: express.Response) => void | Promise ): HttpsFunction { return _onRequestWithOptions(handler, {}); } @@ -55,430 +63,74 @@ export function onCall( /** @hidden */ export function _onRequestWithOptions( - handler: (req: Request, resp: express.Response) => void, + handler: (req: Request, resp: express.Response) => void | Promise, options: DeploymentOptions ): HttpsFunction { // lets us add __trigger without altering handler: const cloudFunction: any = (req: Request, res: express.Response) => { - handler(req, res); + return handler(req, res); }; - cloudFunction.__trigger = _.assign(optionsToTrigger(options), { + cloudFunction.__trigger = { + ...optionsToTrigger(options), httpsTrigger: {}, - }); - // TODO parse the options - return cloudFunction; -} - -/** - * The set of Firebase Functions status codes. The codes are the same at the - * ones exposed by gRPC here: - * https://github.com/grpc/grpc/blob/master/doc/statuscodes.md - * - * Possible values: - * - 'cancelled': The operation was cancelled (typically by the caller). - * - 'unknown': Unknown error or an error from a different error domain. - * - 'invalid-argument': Client specified an invalid argument. Note that this - * differs from 'failed-precondition'. 'invalid-argument' indicates - * arguments that are problematic regardless of the state of the system - * (e.g. an invalid field name). - * - 'deadline-exceeded': Deadline expired before operation could complete. - * For operations that change the state of the system, this error may be - * returned even if the operation has completed successfully. For example, - * a successful response from a server could have been delayed long enough - * for the deadline to expire. - * - 'not-found': Some requested document was not found. - * - 'already-exists': Some document that we attempted to create already - * exists. - * - 'permission-denied': The caller does not have permission to execute the - * specified operation. - * - 'resource-exhausted': Some resource has been exhausted, perhaps a - * per-user quota, or perhaps the entire file system is out of space. - * - 'failed-precondition': Operation was rejected because the system is not - * in a state required for the operation's execution. - * - 'aborted': The operation was aborted, typically due to a concurrency - * issue like transaction aborts, etc. - * - 'out-of-range': Operation was attempted past the valid range. - * - 'unimplemented': Operation is not implemented or not supported/enabled. - * - 'internal': Internal errors. Means some invariants expected by - * underlying system has been broken. If you see one of these errors, - * something is very broken. - * - 'unavailable': The service is currently unavailable. This is most likely - * a transient condition and may be corrected by retrying with a backoff. - * - 'data-loss': Unrecoverable data loss or corruption. - * - 'unauthenticated': The request does not have valid authentication - * credentials for the operation. - */ -export type FunctionsErrorCode = - | 'ok' - | 'cancelled' - | 'unknown' - | 'invalid-argument' - | 'deadline-exceeded' - | 'not-found' - | 'already-exists' - | 'permission-denied' - | 'resource-exhausted' - | 'failed-precondition' - | 'aborted' - | 'out-of-range' - | 'unimplemented' - | 'internal' - | 'unavailable' - | 'data-loss' - | 'unauthenticated'; - -export type CanonicalErrorCodeName = - | 'OK' - | 'CANCELLED' - | 'UNKNOWN' - | 'INVALID_ARGUMENT' - | 'DEADLINE_EXCEEDED' - | 'NOT_FOUND' - | 'ALREADY_EXISTS' - | 'PERMISSION_DENIED' - | 'UNAUTHENTICATED' - | 'RESOURCE_EXHAUSTED' - | 'FAILED_PRECONDITION' - | 'ABORTED' - | 'OUT_OF_RANGE' - | 'UNIMPLEMENTED' - | 'INTERNAL' - | 'UNAVAILABLE' - | 'DATA_LOSS'; - -interface HttpErrorCode { - canonicalName: CanonicalErrorCodeName; - status: number; -} - -/** - * Standard error codes and HTTP statuses for different ways a request can fail, - * as defined by: - * https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - * - * This map is used primarily to convert from a client error code string to - * to the HTTP format error code string and status, and make sure it's in the - * supported set. - */ -const errorCodeMap: { [name in FunctionsErrorCode]: HttpErrorCode } = { - ok: { canonicalName: 'OK', status: 200 }, - cancelled: { canonicalName: 'CANCELLED', status: 499 }, - unknown: { canonicalName: 'UNKNOWN', status: 500 }, - 'invalid-argument': { canonicalName: 'INVALID_ARGUMENT', status: 400 }, - 'deadline-exceeded': { canonicalName: 'DEADLINE_EXCEEDED', status: 504 }, - 'not-found': { canonicalName: 'NOT_FOUND', status: 404 }, - 'already-exists': { canonicalName: 'ALREADY_EXISTS', status: 409 }, - 'permission-denied': { canonicalName: 'PERMISSION_DENIED', status: 403 }, - unauthenticated: { canonicalName: 'UNAUTHENTICATED', status: 401 }, - 'resource-exhausted': { canonicalName: 'RESOURCE_EXHAUSTED', status: 429 }, - 'failed-precondition': { canonicalName: 'FAILED_PRECONDITION', status: 400 }, - aborted: { canonicalName: 'ABORTED', status: 409 }, - 'out-of-range': { canonicalName: 'OUT_OF_RANGE', status: 400 }, - unimplemented: { canonicalName: 'UNIMPLEMENTED', status: 501 }, - internal: { canonicalName: 'INTERNAL', status: 500 }, - unavailable: { canonicalName: 'UNAVAILABLE', status: 503 }, - 'data-loss': { canonicalName: 'DATA_LOSS', status: 500 }, -}; - -interface HttpErrorWireFormat { - details?: unknown; - message: string; - status: CanonicalErrorCodeName; -} - -/** - * An explicit error that can be thrown from a handler to send an error to the - * client that called the function. - */ -export class HttpsError extends Error { - /** - * A standard error code that will be returned to the client. This also - * determines the HTTP status code of the response, as defined in code.proto. - */ - public readonly code: FunctionsErrorCode; - - /** - * Extra data to be converted to JSON and included in the error response. - */ - public readonly details: unknown; - - /** - * A wire format representation of a provided error code. - * - * @hidden - */ - public readonly httpErrorCode: HttpErrorCode; - - constructor(code: FunctionsErrorCode, message: string, details?: unknown) { - super(message); - - // A sanity check for non-TypeScript consumers. - if (code in errorCodeMap === false) { - throw new Error(`Unknown error code: ${code}.`); - } - - this.code = code; - this.details = details; - this.httpErrorCode = errorCodeMap[code]; - } - - /** @hidden */ - public toJSON(): HttpErrorWireFormat { - const { - details, - httpErrorCode: { canonicalName: status }, - message, - } = this; - - return { - ...(details === undefined ? {} : { details }), - message, - status, - }; - } -} - -/** - * The interface for metadata for the API as passed to the handler. - */ -export interface CallableContext { - /** - * The result of decoding and verifying a Firebase Auth ID token. - */ - auth?: { - uid: string; - token: firebase.auth.DecodedIdToken; }; + convertIfPresent( + cloudFunction.__trigger.httpsTrigger, + options, + 'invoker', + 'invoker', + convertInvoker + ); + // TODO parse the options - /** - * An unverified token for a Firebase Instance ID. - */ - instanceIdToken?: string; - - /** - * The raw request handled by the callable. - */ - rawRequest: Request; -} - -// The allowed interface for an http request for a callable function. -interface HttpRequest extends Request { - body: { - data: any; + cloudFunction.__endpoint = { + platform: 'gcfv1', + ...optionsToEndpoint(options), + httpsTrigger: {}, }; + convertIfPresent( + cloudFunction.__endpoint.httpsTrigger, + options, + 'invoker', + 'invoker', + convertInvoker + ); + return cloudFunction; } -// The format for the http body response to a callable function. -interface HttpResponseBody { - result?: any; - error?: HttpsError; -} - -// Returns true if req is a properly formatted callable request. -function isValidRequest(req: Request): req is HttpRequest { - // The body must not be empty. - if (!req.body) { - console.warn('Request is missing body.'); - return false; - } - - // Make sure it's a POST. - if (req.method !== 'POST') { - console.warn('Request has invalid method.', req.method); - return false; - } - - // Check that the Content-Type is JSON. - let contentType = (req.header('Content-Type') || '').toLowerCase(); - // If it has a charset, just ignore it for now. - const semiColon = contentType.indexOf(';'); - if (semiColon >= 0) { - contentType = contentType.substr(0, semiColon).trim(); - } - if (contentType !== 'application/json') { - console.warn('Request has incorrect Content-Type.', contentType); - return false; - } - - // The body must have data. - if (_.isUndefined(req.body.data)) { - console.warn('Request body is missing data.', req.body); - return false; - } - - // TODO(klimt): Allow only whitelisted http headers. - - // Verify that the body does not have any extra fields. - const extras = _.omit(req.body, 'data'); - if (!_.isEmpty(extras)) { - console.warn('Request body has extra fields.', extras); - return false; - } - return true; -} - -const LONG_TYPE = 'type.googleapis.com/google.protobuf.Int64Value'; -const UNSIGNED_LONG_TYPE = 'type.googleapis.com/google.protobuf.UInt64Value'; - -/** - * Encodes arbitrary data in our special format for JSON. - * This is exposed only for testing. - */ -/** @hidden */ -export function encode(data: any): any { - if (_.isNull(data) || _.isUndefined(data)) { - return null; - } - // Oddly, _.isFinite(new Number(x)) always returns false, so unwrap Numbers. - if (data instanceof Number) { - data = data.valueOf(); - } - if (_.isFinite(data)) { - // Any number in JS is safe to put directly in JSON and parse as a double - // without any loss of precision. - return data; - } - if (_.isBoolean(data)) { - return data; - } - if (_.isString(data)) { - return data; - } - if (_.isArray(data)) { - return _.map(data, encode); - } - if (_.isObject(data)) { - // It's not safe to use _.forEach, because the object might be 'array-like' - // if it has a key called 'length'. Note that this intentionally overrides - // any toJSON method that an object may have. - return _.mapValues(data, encode); - } - // If we got this far, the data is not encodable. - console.error('Data cannot be encoded in JSON.', data); - throw new Error('Data cannot be encoded in JSON: ' + data); -} - -/** - * Decodes our special format for JSON into native types. - * This is exposed only for testing. - */ -/** @hidden */ -export function decode(data: any): any { - if (data === null) { - return data; - } - if (data['@type']) { - switch (data['@type']) { - case LONG_TYPE: - // Fall through and handle this the same as unsigned. - case UNSIGNED_LONG_TYPE: { - // Technically, this could work return a valid number for malformed - // data if there was a number followed by garbage. But it's just not - // worth all the extra code to detect that case. - const value = parseFloat(data.value); - if (_.isNaN(value)) { - console.error('Data cannot be decoded from JSON.', data); - throw new Error('Data cannot be decoded from JSON: ' + data); - } - return value; - } - default: { - console.error('Data cannot be decoded from JSON.', data); - throw new Error('Data cannot be decoded from JSON: ' + data); - } - } - } - if (_.isArray(data)) { - return _.map(data, decode); - } - if (_.isObject(data)) { - // It's not safe to use _.forEach, because the object might be 'array-like' - // if it has a key called 'length'. - return _.mapValues(data, decode); - } - // Anything else is safe to return. - return data; -} - -const corsHandler = cors({ origin: true, methods: 'POST' }); - /** @hidden */ export function _onCallWithOptions( handler: (data: any, context: CallableContext) => any | Promise, options: DeploymentOptions ): HttpsFunction & Runnable { - const func = async (req: Request, res: express.Response) => { - try { - if (!isValidRequest(req)) { - console.error('Invalid request', req); - throw new HttpsError('invalid-argument', 'Bad Request'); - } - - const context: CallableContext = { rawRequest: req }; - - const authorization = req.header('Authorization'); - if (authorization) { - const match = authorization.match(/^Bearer (.*)$/); - if (!match) { - throw new HttpsError('unauthenticated', 'Unauthenticated'); - } - const idToken = match[1]; - try { - const authToken = await apps() - .admin.auth() - .verifyIdToken(idToken); - context.auth = { - uid: authToken.uid, - token: authToken, - }; - } catch (e) { - throw new HttpsError('unauthenticated', 'Unauthenticated'); - } - } - - const instanceId = req.header('Firebase-Instance-ID-Token'); - if (instanceId) { - // Validating the token requires an http request, so we don't do it. - // If the user wants to use it for something, it will be validated then. - // Currently, the only real use case for this token is for sending - // pushes with FCM. In that case, the FCM APIs will validate the token. - context.instanceIdToken = req.header('Firebase-Instance-ID-Token'); - } - - const data = decode(req.body.data); - let result: any = await handler(data, context); - - // Encode the result as JSON to preserve types like Dates. - result = encode(result); - - // If there was some result, encode it in the body. - const responseBody: HttpResponseBody = { result }; - res.status(200).send(responseBody); - } catch (error) { - if (!(error instanceof HttpsError)) { - // This doesn't count as an 'explicit' error. - console.error('Unhandled error', error); - error = new HttpsError('internal', 'INTERNAL'); - } - - const { status } = error.httpErrorCode; - const body = { error: error.toJSON() }; - - res.status(status).send(body); - } + // onCallHandler sniffs the function length of the passed-in callback + // and the user could have only tried to listen to data. Wrap their handler + // in another handler to avoid accidentally triggering the v2 API + const fixedLen = (data: any, context: CallableContext) => + handler(data, context); + const func: any = onCallHandler( + { + allowInvalidAppCheckToken: options.allowInvalidAppCheckToken, + cors: { origin: true, methods: 'POST' }, + }, + fixedLen + ); + + func.__trigger = { + labels: {}, + ...optionsToTrigger(options), + httpsTrigger: {}, }; + func.__trigger.labels['deployment-callable'] = 'true'; - // Wrap the function with a cors handler. - const corsFunc: any = (req: Request, res: express.Response) => { - return corsHandler(req, res, () => func(req, res)); + func.__endpoint = { + platform: 'gcfv1', + labels: {}, + ...optionsToEndpoint(options), + callableTrigger: {}, }; - corsFunc.__trigger = _.assign(optionsToTrigger(options), { - httpsTrigger: {}, - labels: { 'deployment-callable': 'true' }, - }); - - corsFunc.run = handler; + func.run = handler; - return corsFunc; + return func; } diff --git a/src/providers/pubsub.ts b/src/providers/pubsub.ts index d1a687819..18517bee0 100644 --- a/src/providers/pubsub.ts +++ b/src/providers/pubsub.ts @@ -39,8 +39,8 @@ export const service = 'pubsub.googleapis.com'; * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message * is sent to a specified topic. * - * @param topic The Pub/Sub topic to watch for message events. - * @return Pub/Sub topic builder interface. + * @param topic - The Pub/Sub topic to watch for message events. + * @returns Pub/Sub topic builder interface. */ export function topic(topic: string) { return _topicWithOptions(topic, {}); @@ -63,91 +63,121 @@ export function _topicWithOptions( }, options); } -export function schedule(schedule: string): ScheduleBuilder { - return _scheduleWithOptions(schedule, {}); -} - -export class ScheduleBuilder { +/** + * The Google Cloud Pub/Sub topic builder. + * + * Access via [`functions.pubsub.topic()`](providers_pubsub_.html#topic). + */ +export class TopicBuilder { /** @hidden */ - constructor(private options: DeploymentOptions) {} - - retryConfig(config: ScheduleRetryConfig): ScheduleBuilder { - this.options.schedule.retryConfig = config; - return this; - } - - timeZone(timeZone: string): ScheduleBuilder { - this.options.schedule.timeZone = timeZone; - return this; - } + constructor( + private triggerResource: () => string, + private options: DeploymentOptions + ) {} - onRun(handler: (context: EventContext) => PromiseLike | any) { - const triggerResource = () => { - if (!process.env.GCLOUD_PROJECT) { - throw new Error('process.env.GCLOUD_PROJECT is not set.'); - } - return `projects/${process.env.GCLOUD_PROJECT}/topics`; // The CLI will append the correct topic name based on region and function name - }; - const cloudFunction = makeCloudFunction({ - contextOnlyHandler: handler, + /** + * Event handler that fires every time a Cloud Pub/Sub message is + * published. + * + * @param handler - Event handler that runs every time a Cloud Pub/Sub message + * is published. + * @return A Cloud Function that you can export and deploy. + */ + onPublish( + handler: (message: Message, context: EventContext) => PromiseLike | any + ): CloudFunction { + return makeCloudFunction({ + handler, provider, service, - triggerResource, + triggerResource: this.triggerResource, eventType: 'topic.publish', + dataConstructor: (raw) => new Message(raw.data), options: this.options, - labels: { 'deployment-scheduled': 'true' }, }); - return cloudFunction; } } +/** + * Registers a Cloud Function to run at specified times. + * + * @param schedule - The schedule, in Unix Crontab or AppEngine syntax. + * @return ScheduleBuilder interface. + */ +export function schedule(schedule: string): ScheduleBuilder { + return _scheduleWithOptions(schedule, {}); +} + /** @hidden */ export function _scheduleWithOptions( schedule: string, options: DeploymentOptions ): ScheduleBuilder { - return new ScheduleBuilder({ ...options, schedule: { schedule } }); + const triggerResource = () => { + if (!process.env.GCLOUD_PROJECT) { + throw new Error('process.env.GCLOUD_PROJECT is not set.'); + } + // The CLI will append the correct topic name based on region and function name + return `projects/${process.env.GCLOUD_PROJECT}/topics`; + }; + return new ScheduleBuilder(triggerResource, { + ...options, + schedule: { schedule }, + }); } /** - * The Google Cloud Pub/Sub topic builder. + * The builder for scheduled functions, which are powered by + * Google Pub/Sub and Cloud Scheduler. Describes the Cloud Scheduler + * job that is deployed to trigger a scheduled function at the provided + * frequency. For more information, see + * [Schedule functions](/docs/functions/schedule-functions). * - * Access via [`functions.pubsub.topic()`](functions.pubsub#.topic). + * Access via [`functions.pubsub.schedule()`](providers_pubsub_.html#schedule). */ -export class TopicBuilder { +export class ScheduleBuilder { /** @hidden */ constructor( private triggerResource: () => string, private options: DeploymentOptions ) {} + retryConfig(config: ScheduleRetryConfig): ScheduleBuilder { + this.options.schedule.retryConfig = config; + return this; + } + + timeZone(timeZone: string): ScheduleBuilder { + this.options.schedule.timeZone = timeZone; + return this; + } + /** - * Event handler that fires every time a Cloud Pub/Sub message is - * published. + * Event handler for scheduled functions. Triggered whenever the associated + * scheduler job sends a Pub/Sub message. * - * @param handler Event handler that runs every time a Cloud Pub/Sub message - * is published. + * @param handler - Handler that fires whenever the associated + * scheduler job sends a Pub/Sub message. * @return A Cloud Function that you can export and deploy. */ - onPublish( - handler: (message: Message, context: EventContext) => PromiseLike | any - ): CloudFunction { - return makeCloudFunction({ - handler, + onRun(handler: (context: EventContext) => PromiseLike | any) { + const cloudFunction = makeCloudFunction({ + contextOnlyHandler: handler, provider, service, triggerResource: this.triggerResource, eventType: 'topic.publish', - dataConstructor: (raw) => new Message(raw.data), options: this.options, + labels: { 'deployment-scheduled': 'true' }, }); + return cloudFunction; } } /** * Interface representing a Google Cloud Pub/Sub message. * - * @param data Payload of a Pub/Sub message. + * @param data - Payload of a Pub/Sub message. */ export class Message { /** @@ -176,7 +206,9 @@ export class Message { */ get json(): any { if (typeof this._json === 'undefined') { - this._json = JSON.parse(new Buffer(this.data, 'base64').toString('utf8')); + this._json = JSON.parse( + Buffer.from(this.data, 'base64').toString('utf8') + ); } return this._json; diff --git a/src/providers/storage.ts b/src/providers/storage.ts index 3ba98ea72..33b2a64eb 100644 --- a/src/providers/storage.ts +++ b/src/providers/storage.ts @@ -84,7 +84,7 @@ export function _objectWithOptions(options: DeploymentOptions): ObjectBuilder { /** * The Google Cloud Storage bucket builder interface. * - * Access via [`functions.storage.bucket()`](functions.storage#.bucket). + * Access via [`functions.storage.bucket()`](providers_storage_.html#bucket). */ export class BucketBuilder { /** @hidden */ @@ -107,7 +107,7 @@ export class BucketBuilder { /** * The Google Cloud Storage object builder interface. * - * Access via [`functions.storage.object()`](functions.storage#.object). + * Access via [`functions.storage.object()`](providers_storage_.html#object). */ export class ObjectBuilder { /** @hidden */ diff --git a/src/providers/tasks.ts b/src/providers/tasks.ts new file mode 100644 index 000000000..f06e7b92e --- /dev/null +++ b/src/providers/tasks.ts @@ -0,0 +1,161 @@ +// 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 * as express from 'express'; + +import { optionsToEndpoint, optionsToTrigger } from '../cloud-functions'; +import { + convertIfPresent, + convertInvoker, + copyIfPresent, +} from '../common/encoding'; +import { Request } from '../common/providers/https'; +import { + onDispatchHandler, + RateLimits, + RetryConfig, + TaskContext, +} from '../common/providers/tasks'; +import { DeploymentOptions } from '../function-configuration'; +import { ManifestEndpoint, ManifestRequiredAPI } from '../runtime/manifest'; + +export { RetryConfig, RateLimits, TaskContext }; + +/** + * Options for configuring the task queue to listen to. + */ +export interface TaskQueueOptions { + /** How a task should be retried in the event of a non-2xx return. */ + retryConfig?: RetryConfig; + /** How congestion control should be applied to the function. */ + rateLimits?: RateLimits; + + /** + * Who can enqueue tasks for this function. + * If left unspecified, only service accounts which have + * `roles/cloudtasks.enqueuer` and `roles/cloudfunctions.invoker` + * will have permissions. + */ + invoker?: 'private' | string | string[]; +} + +/** + * A handler for tasks. + */ +export interface TaskQueueFunction { + (req: Request, res: express.Response): Promise; + + /** @alpha */ + __trigger: unknown; + + /** @alpha */ + __endpoint: ManifestEndpoint; + + /** @alpha */ + __requiredAPIs?: ManifestRequiredAPI[]; + + /** + * The callback passed to the `TaskQueueFunction` constructor. + * @param data - The body enqueued into a task queue. + * @param context - The request context of the enqueued task + * @returns Any return value. Google Cloud Functions will await any promise + * before shutting down your function. Resolved return values + * are only used for unit testing purposes. + */ + run(data: any, context: TaskContext): void | Promise; +} + +/** + * Builder for creating a `TaskQueueFunction`. + */ +export class TaskQueueBuilder { + /** @internal */ + constructor( + private readonly tqOpts?: TaskQueueOptions, + private readonly depOpts?: DeploymentOptions + ) {} + + /** + * Creates a handler for tasks sent to a Google Cloud Tasks queue. + * @param handler - A callback to handle task requests. + * @returns A Cloud Function you can export and deploy. + */ + onDispatch( + handler: (data: any, context: TaskContext) => void | Promise + ): TaskQueueFunction { + // onEnqueueHandler sniffs the function length of the passed-in callback + // and the user could have only tried to listen to data. Wrap their handler + // in another handler to avoid accidentally triggering the v2 API + const fixedLen = (data: any, context: TaskContext) => + handler(data, context); + const func: any = onDispatchHandler(fixedLen); + + func.__trigger = { + ...optionsToTrigger(this.depOpts || {}), + taskQueueTrigger: {}, + }; + copyIfPresent(func.__trigger.taskQueueTrigger, this.tqOpts, 'retryConfig'); + copyIfPresent(func.__trigger.taskQueueTrigger, this.tqOpts, 'rateLimits'); + convertIfPresent( + func.__trigger.taskQueueTrigger, + this.tqOpts, + 'invoker', + 'invoker', + convertInvoker + ); + + func.__endpoint = { + platform: 'gcfv1', + ...optionsToEndpoint(this.depOpts), + taskQueueTrigger: {}, + }; + copyIfPresent(func.__endpoint.taskQueueTrigger, this.tqOpts, 'retryConfig'); + copyIfPresent(func.__endpoint.taskQueueTrigger, this.tqOpts, 'rateLimits'); + convertIfPresent( + func.__endpoint.taskQueueTrigger, + this.tqOpts, + 'invoker', + 'invoker', + convertInvoker + ); + + func.__requiredAPIs = [ + { + api: 'cloudtasks.googleapis.com', + reason: 'Needed for task queue functions', + }, + ]; + + func.run = handler; + + return func; + } +} + +/** + * Declares a function that can handle tasks enqueued using the Firebase Admin SDK. + * @param options - Configuration for the Task Queue that feeds into this function. + * Omitting options will configure a Task Queue with default settings. + */ +export function taskQueue(options?: TaskQueueOptions): TaskQueueBuilder { + return new TaskQueueBuilder(options); +} diff --git a/src/runtime/loader.ts b/src/runtime/loader.ts new file mode 100644 index 000000000..4dd4b41d2 --- /dev/null +++ b/src/runtime/loader.ts @@ -0,0 +1,126 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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 * as path from 'path'; +import * as url from 'url'; + +import { + ManifestEndpoint, + ManifestRequiredAPI, + ManifestStack, +} from './manifest'; + +import * as params from '../v2/params'; + +/** + * Dynamically load import function to prevent TypeScript from + * transpiling into a require. + * + * See https://github.com/microsoft/TypeScript/issues/43329. + */ +const dynamicImport = new Function( + 'modulePath', + 'return import(modulePath)' +) as (modulePath: string) => Promise; + +async function loadModule(functionsDir: string) { + const absolutePath = path.resolve(functionsDir); + try { + return require(path.resolve(absolutePath)); + } catch (e) { + if (e.code === 'ERR_REQUIRE_ESM') { + // This is an ESM package! + const modulePath = require.resolve(absolutePath); + // Resolve module path to file:// URL. Required for windows support. + // @ts-ignore pathToFileURL exists for Node.js v10 and up. Since ESM support exists for Node.js v13 and up, we + // can be sure that this function exists here. + const moduleURL = url.pathToFileURL(modulePath).href; + return await dynamicImport(moduleURL); + } + throw e; + } +} + +/* @internal */ +export function extractStack( + module, + endpoints: Record, + requiredAPIs: ManifestRequiredAPI[], + prefix = '' +) { + for (const [name, valAsUnknown] of Object.entries(module)) { + // We're introspecting untrusted code here. Any is appropraite + const val: any = valAsUnknown; + if ( + typeof val === 'function' && + val.__endpoint && + typeof val.__endpoint === 'object' + ) { + const funcName = prefix + name; + endpoints[funcName] = { + ...val.__endpoint, + entryPoint: funcName.replace(/-/g, '.'), + }; + if (val.__requiredAPIs && Array.isArray(val.__requiredAPIs)) { + requiredAPIs.push(...val.__requiredAPIs); + } + } else if (typeof val === 'object' && val !== null) { + extractStack(val, endpoints, requiredAPIs, prefix + name + '-'); + } + } +} + +/* @internal */ +export function mergeRequiredAPIs( + requiredAPIs: ManifestRequiredAPI[] +): ManifestRequiredAPI[] { + const apiToReasons: Record> = {}; + for (const { api, reason } of requiredAPIs) { + const reasons = apiToReasons[api] || new Set(); + reasons.add(reason); + apiToReasons[api] = reasons; + } + + const merged: ManifestRequiredAPI[] = []; + for (const [api, reasons] of Object.entries(apiToReasons)) { + merged.push({ api, reason: Array.from(reasons).join(' ') }); + } + return merged; +} + +/* @internal */ +export async function loadStack(functionsDir: string): Promise { + const endpoints: Record = {}; + const requiredAPIs: ManifestRequiredAPI[] = []; + const mod = await loadModule(functionsDir); + + extractStack(mod, endpoints, requiredAPIs); + + const stack: ManifestStack = { + endpoints, + specVersion: 'v1alpha1', + requiredAPIs: mergeRequiredAPIs(requiredAPIs), + }; + if (params.declaredParams.length > 0) { + stack.params = params.declaredParams.map((p) => p.toSpec()); + } + return stack; +} diff --git a/src/runtime/manifest.ts b/src/runtime/manifest.ts new file mode 100644 index 000000000..553854ae0 --- /dev/null +++ b/src/runtime/manifest.ts @@ -0,0 +1,117 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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 { Expression } from '../v2/params'; +import { ParamSpec } from '../v2/params/types'; + +/** + * An definition of a function as appears in the Manifest. + */ +export interface ManifestEndpoint { + entryPoint?: string; + region?: string[]; + platform?: string; + availableMemoryMb?: number | Expression; + maxInstances?: number | Expression; + minInstances?: number | Expression; + concurrency?: number | Expression; + serviceAccountEmail?: string; + timeoutSeconds?: number | Expression; + cpu?: number | 'gcf_gen1'; + vpc?: { + connector: string | Expression; + egressSettings?: string; + }; + labels?: Record; + ingressSettings?: string; + environmentVariables?: Record; + secretEnvironmentVariables?: Array<{ key: string; secret?: string }>; + + httpsTrigger?: { + invoker?: string[]; + }; + + callableTrigger?: {}; + + eventTrigger?: { + eventFilters: Record>; + eventFilterPathPatterns?: Record>; + channel?: string; + eventType: string; + retry: boolean | Expression; + region?: string; + serviceAccountEmail?: string; + }; + + scheduleTrigger?: { + schedule?: string | Expression; + timeZone?: string | Expression; + retryConfig?: { + retryCount?: number | Expression; + maxRetrySeconds?: string | Expression; + minBackoffSeconds?: string | Expression; + maxBackoffSeconds?: string | Expression; + maxDoublings?: number | Expression; + }; + }; + + blockingTrigger?: { + eventType: string; + options?: Record; + }; +} + +export interface ManifestRequiredAPI { + api: string; + reason: string; +} + +/** + * An definition of a function deployment as appears in the Manifest. + */ +export interface ManifestStack { + specVersion: 'v1alpha1'; + params?: ParamSpec[]; + requiredAPIs: ManifestRequiredAPI[]; + endpoints: Record; +} + +/** + * Returns the JSON representation of a ManifestStack, which has CEL + * expressions in its options as object types, with its expressions + * transformed into the actual CEL strings. + * @internal + */ +export function stackToWire(stack: ManifestStack): Object { + const wireStack = stack as any; + const traverse = function traverse(obj: Object) { + for (const [key, val] of Object.entries(obj)) { + if (val instanceof Expression) { + obj[key] = val.toCEL(); + } else if (typeof val === 'object' && val !== null) { + traverse(val); + } + } + }; + traverse(wireStack.endpoints); + return wireStack; +} diff --git a/src/setup.ts b/src/setup.ts index 6a0796348..6a9db702d 100644 --- a/src/setup.ts +++ b/src/setup.ts @@ -20,7 +20,9 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. +/** @hidden */ import { firebaseConfig } from './config'; +import { warn } from './logger'; // Set up for config and vars export function setup() { @@ -44,20 +46,20 @@ export function setup() { // If FIREBASE_CONFIG is still not found, try using GCLOUD_PROJECT to estimate if (!process.env.FIREBASE_CONFIG) { if (process.env.GCLOUD_PROJECT) { - console.warn( + warn( 'Warning, estimating Firebase Config based on GCLOUD_PROJECT. Initializing firebase-admin may fail' ); process.env.FIREBASE_CONFIG = JSON.stringify({ databaseURL: - `${process.env.DATABASE_URL}` || + process.env.DATABASE_URL || `https://${process.env.GCLOUD_PROJECT}.firebaseio.com`, storageBucket: - `${process.env.STORAGE_BUCKET_URL}` || + process.env.STORAGE_BUCKET_URL || `${process.env.GCLOUD_PROJECT}.appspot.com`, projectId: process.env.GCLOUD_PROJECT, }); } else { - console.warn( + warn( 'Warning, FIREBASE_CONFIG and GCLOUD_PROJECT environment variables are missing. Initializing firebase-admin will fail' ); } diff --git a/src/types/global.d.ts b/src/types/global.d.ts new file mode 100644 index 000000000..164cd4d74 --- /dev/null +++ b/src/types/global.d.ts @@ -0,0 +1,6 @@ +export {}; + +declare global { + interface AbortSignal {} + interface AbortController {} +} diff --git a/src/utilities/assertions.ts b/src/utilities/assertions.ts index 49ff5e36d..982ca304d 100644 --- a/src/utilities/assertions.ts +++ b/src/utilities/assertions.ts @@ -1,4 +1,4 @@ -/** +/** @hidden * @file Provides common assertion helpers which can be used to improve * strictness of both type checking and runtime. */ diff --git a/src/utilities/path-pattern.ts b/src/utilities/path-pattern.ts new file mode 100644 index 000000000..dadc96bb1 --- /dev/null +++ b/src/utilities/path-pattern.ts @@ -0,0 +1,173 @@ +// 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 { pathParts } from './path'; + +/** https://cloud.google.com/eventarc/docs/path-patterns */ + +/** @hidden */ +const WILDCARD_CAPTURE_REGEX = new RegExp('{[^/{}]+}', 'g'); + +/** @internal */ +export function trimParam(param: string) { + const paramNoBraces = param.slice(1, -1); + if (paramNoBraces.includes('=')) { + return paramNoBraces.slice(0, paramNoBraces.indexOf('=')); + } + return paramNoBraces; +} + +/** @hidden */ +type SegmentName = 'segment' | 'single-capture' | 'multi-capture'; + +/** @hidden */ +interface PathSegment { + readonly name: SegmentName; + readonly value: string; + readonly trimmed: string; + isSingleSegmentWildcard(): boolean; + isMultiSegmentWildcard(): boolean; +} + +/** @hidden */ +class Segment implements PathSegment { + readonly name = 'segment'; + readonly trimmed: string; + constructor(readonly value: string) { + this.trimmed = value; + } + isSingleSegmentWildcard(): boolean { + return this.value.includes('*') && !this.isMultiSegmentWildcard(); + } + isMultiSegmentWildcard(): boolean { + return this.value.includes('**'); + } +} + +/** @hidden */ +class SingleCaptureSegment implements PathSegment { + readonly name = 'single-capture'; + readonly trimmed: string; + constructor(readonly value: string) { + this.trimmed = trimParam(value); + } + isSingleSegmentWildcard(): boolean { + return true; + } + isMultiSegmentWildcard(): boolean { + return false; + } +} + +/** @hidden */ +class MultiCaptureSegment implements PathSegment { + readonly name = 'multi-capture'; + readonly trimmed: string; + constructor(readonly value: string) { + this.trimmed = trimParam(value); + } + isSingleSegmentWildcard(): boolean { + return false; + } + isMultiSegmentWildcard(): boolean { + return true; + } +} + +/** + * Implements Eventarc's path pattern from the spec https://cloud.google.com/eventarc/docs/path-patterns + * @internal + */ +export class PathPattern { + /** @throws on validation error */ + static compile(rawPath: string) {} + private segments: PathSegment[]; + + constructor(private raw: string) { + this.segments = []; + this.initPathSegments(raw); + } + + getValue(): string { + return this.raw; + } + + // If false, we don't need to use pathPattern as our eventarc match type. + hasWildcards(): boolean { + return this.segments.some( + (segment) => + segment.isSingleSegmentWildcard() || segment.isMultiSegmentWildcard() + ); + } + + hasCaptures(): boolean { + return this.segments.some( + (segment) => + segment.name == 'single-capture' || segment.name === 'multi-capture' + ); + } + + extractMatches(path: string): Record { + const matches: Record = {}; + if (!this.hasCaptures()) { + return matches; + } + const pathSegments = pathParts(path); + let pathNdx = 0; + + for ( + let segmentNdx = 0; + segmentNdx < this.segments.length && pathNdx < pathSegments.length; + segmentNdx++ + ) { + const segment = this.segments[segmentNdx]; + const remainingSegments = this.segments.length - 1 - segmentNdx; + const nextPathNdx = pathSegments.length - remainingSegments; + if (segment.name === 'single-capture') { + matches[segment.trimmed] = pathSegments[pathNdx]; + } else if (segment.name === 'multi-capture') { + matches[segment.trimmed] = pathSegments + .slice(pathNdx, nextPathNdx) + .join('/'); + } + pathNdx = segment.isMultiSegmentWildcard() ? nextPathNdx : pathNdx + 1; + } + + return matches; + } + + private initPathSegments(raw: string) { + const parts = pathParts(raw); + for (const part of parts) { + let segment: PathSegment; + const capture = part.match(WILDCARD_CAPTURE_REGEX); + if (capture && capture.length === 1) { + segment = part.includes('**') + ? new MultiCaptureSegment(part) + : new SingleCaptureSegment(part); + } else { + segment = new Segment(part); + } + this.segments.push(segment); + } + } +} diff --git a/src/utilities/path.ts b/src/utilities/path.ts index 40ab8f047..33e187f9e 100644 --- a/src/utilities/path.ts +++ b/src/utilities/path.ts @@ -1,4 +1,4 @@ -/** +/** @hidden * Removes leading and trailing slashes from a path. * * @param path A path to normalize, in POSIX format. diff --git a/src/utils.ts b/src/utils.ts index b52c1e54f..e41b1e1fb 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -20,6 +20,7 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. +/** @hidden */ import * as _ from 'lodash'; export function applyChange(src: any, dest: any) { diff --git a/src/v2/core.ts b/src/v2/core.ts new file mode 100644 index 000000000..7bd88fc8d --- /dev/null +++ b/src/v2/core.ts @@ -0,0 +1,117 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +/** + * Core functionality of the Firebase Functions v2 SDK. + * @packageDocumentation + */ + +import { Change } from '../common/change'; +import { ManifestEndpoint } from '../runtime/manifest'; + +export { Change }; + +/** @internal */ +export interface TriggerAnnotation { + platform?: string; + concurrency?: number; + minInstances?: number; + maxInstances?: number; + availableMemoryMb?: number; + eventTrigger?: { + eventType: string; + resource: string; + service: string; + }; + failurePolicy?: { retry: boolean }; + httpsTrigger?: { + invoker?: string[]; + }; + labels?: { [key: string]: string }; + regions?: string[]; + timeout?: string; + vpcConnector?: string; + vpcConnectorEgressSettings?: string; + serviceAccountEmail?: string; + ingressSettings?: string; + secrets?: string[]; + blockingTrigger?: { + eventType: string; + options?: Record; + }; + // TODO: schedule +} + +/** + * A CloudEventBase is the base of a cross-platform format for encoding a serverless event. + * More information can be found in https://github.com/cloudevents/spec + * @typeParam T - The type of the event data. + * @beta + */ +export interface CloudEvent { + /** Version of the CloudEvents spec for this event. */ + readonly specversion: '1.0'; + + /** A globally unique ID for this event. */ + id: string; + + /** The resource which published this event. */ + source: string; + + /** The resource, provided by source, that this event relates to */ + subject?: string; + + /** The type of event that this represents. */ + type: string; + + /** When this event occurred. */ + time: string; + + /** Information about this specific event. */ + data: T; +} + +/** + * A handler for CloudEvents. + * @typeParam EventType - The kind of event this function handles. + * Always a subclass of CloudEvent<> + * @beta + */ +export interface CloudFunction> { + (raw: CloudEvent): any | Promise; + + /** @alpha */ + __trigger?: unknown; + /** @alpha */ + __endpoint: ManifestEndpoint; + + /** + * The callback passed to the CloudFunction constructor. + * Use run to test a CloudFunction + * @param event - The parsed event to handle. + * @returns Any return value. Google Cloud Functions awaits any promise + * before shutting down your function. Resolved return values + * are only used for unit testing purposes. + * @beta + */ + run(event: EventType): any | Promise; +} diff --git a/src/v2/index.ts b/src/v2/index.ts new file mode 100644 index 000000000..d1054504a --- /dev/null +++ b/src/v2/index.ts @@ -0,0 +1,67 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +/** + * The V2 API for Cloud Functions for Firebase. + * This SDK also supports deep imports. For example, the namespace + * 'pubsub' is available at 'firebase-functions/v2' or is directly importable + * from 'firebase-functions/v2/pubsub'. + * @packageDocumentation + */ + +import * as logger from '../logger'; +import * as alerts from './providers/alerts'; +import * as database from './providers/database'; +import * as eventarc from './providers/eventarc'; +import * as https from './providers/https'; +import * as identity from './providers/identity'; +import * as pubsub from './providers/pubsub'; +import * as scheduler from './providers/scheduler'; +import * as storage from './providers/storage'; +import * as tasks from './providers/tasks'; + +export { + alerts, + database, + storage, + https, + identity, + pubsub, + logger, + tasks, + eventarc, + scheduler, +}; + +export { + setGlobalOptions, + GlobalOptions, + SupportedRegion, + MemoryOption, + VpcEgressSetting, + IngressSetting, + EventHandlerOptions, +} from './options'; + +export { Change } from '../common/change'; + +export { CloudFunction, CloudEvent } from './core'; diff --git a/src/v2/options.ts b/src/v2/options.ts new file mode 100644 index 000000000..b8a5a5dcd --- /dev/null +++ b/src/v2/options.ts @@ -0,0 +1,364 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +/** + * Options to configure cloud functions. + * @packageDocumentation + */ + +import { + convertIfPresent, + copyIfPresent, + durationFromSeconds, + serviceAccountFromShorthand, +} from '../common/encoding'; +import * as logger from '../logger'; +import { ManifestEndpoint } from '../runtime/manifest'; +import { TriggerAnnotation } from './core'; +import { declaredParams, Expression } from './params'; +import { ParamSpec } from './params/types'; +import { HttpsOptions } from './providers/https'; + +/** + * List of all regions supported by Cloud Functions v2 + */ +export type SupportedRegion = + | 'asia-northeast1' + | 'europe-north1' + | 'europe-west1' + | 'europe-west4' + | 'us-central1' + | 'us-east1' + | 'us-west1'; + +/** + * List of available memory options supported by Cloud Functions. + */ +export type MemoryOption = + | '128MiB' + | '256MiB' + | '512MiB' + | '1GiB' + | '2GiB' + | '4GiB' + | '8GiB' + | '16GiB' + | '32GiB'; + +const MemoryOptionToMB: Record = { + '128MiB': 128, + '256MiB': 256, + '512MiB': 512, + '1GiB': 1024, + '2GiB': 2048, + '4GiB': 4096, + '8GiB': 8192, + '16GiB': 16384, + '32GiB': 32768, +}; + +/** + * List of available options for VpcConnectorEgressSettings. + */ +export type VpcEgressSetting = 'PRIVATE_RANGES_ONLY' | 'ALL_TRAFFIC'; + +/** + * List of available options for IngressSettings. + */ +export type IngressSetting = + | 'ALLOW_ALL' + | 'ALLOW_INTERNAL_ONLY' + | 'ALLOW_INTERNAL_AND_GCLB'; + +/** + * GlobalOptions are options that can be set across an entire project. + * These options are common to HTTPS and Event handling functions. + */ +export interface GlobalOptions { + /** + * Region where functions should be deployed. + * HTTP functions can override and specify more than one region. + */ + region?: SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /** + * Invoker to set access control on https functions. + */ + invoker?: 'public' | 'private' | string | string[]; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; +} + +let globalOptions: GlobalOptions | undefined; + +/** + * Sets default options for all functions written using the v2 SDK. + * @param options Options to set as default + */ +export function setGlobalOptions(options: GlobalOptions) { + if (globalOptions) { + logger.warn('Calling setGlobalOptions twice leads to undefined behavior'); + } + globalOptions = options; +} + +/** + * Get the currently set default options. + * Used only for trigger generation. + * @internal + */ +export function getGlobalOptions(): GlobalOptions { + return globalOptions || {}; +} + +/** + * Additional fields that can be set on any event-handling Cloud Function. + */ +export interface EventHandlerOptions extends GlobalOptions { + eventType?: string; + + eventFilters?: Record>; + eventFilterPathPatterns?: Record>; + + /** Whether failed executions should be delivered again. */ + retry?: boolean | Expression | null; + + /** Region of the EventArc trigger. */ + //region?: string | Expression | null; + region?: string; + + /** The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account. */ + serviceAccount?: string | null; + + /** The name of the channel where the function receives events. */ + channel?: string; +} + +/** + * Apply GlobalOptions to trigger definitions. + * @internal + */ +export function optionsToTriggerAnnotations( + opts: GlobalOptions | EventHandlerOptions | HttpsOptions +): TriggerAnnotation { + const annotation: TriggerAnnotation = {}; + copyIfPresent( + annotation, + opts, + 'concurrency', + 'minInstances', + 'maxInstances', + 'ingressSettings', + 'labels', + 'vpcConnector', + 'vpcConnectorEgressSettings', + 'secrets' + ); + convertIfPresent( + annotation, + opts, + 'availableMemoryMb', + 'memory', + (mem: MemoryOption | Expression): number | Expression => { + return typeof mem === 'object' ? mem : MemoryOptionToMB[mem]; + } + ); + convertIfPresent(annotation, opts, 'regions', 'region', (region) => { + if (typeof region === 'string') { + return [region]; + } + return region; + }); + convertIfPresent( + annotation, + opts, + 'serviceAccountEmail', + 'serviceAccount', + serviceAccountFromShorthand + ); + convertIfPresent( + annotation, + opts, + 'timeout', + 'timeoutSeconds', + durationFromSeconds + ); + convertIfPresent( + annotation, + (opts as any) as EventHandlerOptions, + 'failurePolicy', + 'retry', + (retry: boolean) => { + return retry ? { retry: true } : null; + } + ); + + return annotation; +} + +/** + * Apply GlobalOptions to endpoint manifest. + * @internal + */ +export function optionsToEndpoint( + opts: GlobalOptions | EventHandlerOptions | HttpsOptions +): ManifestEndpoint { + const endpoint: ManifestEndpoint = {}; + copyIfPresent( + endpoint, + opts, + 'concurrency', + 'minInstances', + 'maxInstances', + 'ingressSettings', + 'labels', + 'timeoutSeconds', + 'cpu' + ); + convertIfPresent(endpoint, opts, 'serviceAccountEmail', 'serviceAccount'); + if (opts.vpcConnector) { + const vpc: ManifestEndpoint['vpc'] = { connector: opts.vpcConnector }; + convertIfPresent(vpc, opts, 'egressSettings', 'vpcConnectorEgressSettings'); + endpoint.vpc = vpc; + } + convertIfPresent( + endpoint, + opts, + 'availableMemoryMb', + 'memory', + (mem: MemoryOption | Expression): number | Expression => { + return typeof mem === 'object' ? mem : MemoryOptionToMB[mem]; + } + ); + convertIfPresent(endpoint, opts, 'region', 'region', (region) => { + if (typeof region === 'string') { + return [region]; + } + return region; + }); + convertIfPresent( + endpoint, + opts, + 'secretEnvironmentVariables', + 'secrets', + (secrets) => secrets.map((secret) => ({ key: secret })) + ); + + return endpoint; +} + +/** + * @hidden + * @alpha + */ +export function __getSpec(): { + globalOptions: GlobalOptions; + params: ParamSpec[]; +} { + return { + globalOptions: getGlobalOptions(), + params: declaredParams.map((p) => p.toSpec()), + }; +} diff --git a/src/v2/params/index.ts b/src/v2/params/index.ts new file mode 100644 index 000000000..b638d68a5 --- /dev/null +++ b/src/v2/params/index.ts @@ -0,0 +1,160 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +/** + * @hidden + * @alpha + */ + +import { + BooleanParam, + Expression, + FloatParam, + IntParam, + ListParam, + Param, + ParamOptions, + SecretParam, + StringParam, +} from './types'; + +export { ParamOptions, Expression }; + +type SecretOrExpr = Param | SecretParam; +export const declaredParams: SecretOrExpr[] = []; + +/** + * Use a helper to manage the list such that params are uniquely + * registered once only but order is preserved. + * @internal + */ +function registerParam(param: SecretOrExpr) { + for (let i = 0; i < declaredParams.length; i++) { + if (declaredParams[i].name === param.name) { + declaredParams.splice(i, 1); + } + } + declaredParams.push(param); +} + +/** + * For testing. + * @internal + */ +export function clearParams() { + declaredParams.splice(0, declaredParams.length); +} + +/** + * Declares a secret param, that will persist values only in Cloud Secret Manager. + * Secrets are stored interally as bytestrings. Use ParamOptions.`as` to provide type + * hinting during parameter resolution. + * + * @param name The name of the environment variable to use to load the param. + * @param options Configuration options for the param. + * @returns A Param with a `string` return type for `.value`. + */ +export function defineSecret(name: string): SecretParam { + const param = new SecretParam(name); + registerParam(param); + return param; +} + +/** + * Declare a string param. + * + * @param name The name of the environment variable to use to load the param. + * @param options Configuration options for the param. + * @returns A Param with a `string` return type for `.value`. + */ +export function defineString( + name: string, + options: ParamOptions = {} +): StringParam { + const param = new StringParam(name, options); + registerParam(param); + return param; +} + +/** + * Declare a boolean param. + * + * @param name The name of the environment variable to use to load the param. + * @param options Configuration options for the param. + * @returns A Param with a `boolean` return type for `.value`. + */ +export function defineBoolean( + name: string, + options: ParamOptions = {} +): BooleanParam { + const param = new BooleanParam(name, options); + registerParam(param); + return param; +} + +/** + * Declare an integer param. + * + * @param name The name of the environment variable to use to load the param. + * @param options Configuration options for the param. + * @returns A Param with a `number` return type for `.value`. + */ +export function defineInt( + name: string, + options: ParamOptions = {} +): IntParam { + const param = new IntParam(name, options); + registerParam(param); + return param; +} + +/** + * Declare a float param. + * + * @param name The name of the environment variable to use to load the param. + * @param options Configuration options for the param. + * @returns A Param with a `number` return type for `.value`. + */ +export function defineFloat( + name: string, + options: ParamOptions = {} +): FloatParam { + const param = new FloatParam(name, options); + registerParam(param); + return param; +} + +/** + * Declare a list param (array of strings). + * + * @param name The name of the environment variable to use to load the param. + * @param options Configuration options for the param. + * @returns A Param with a `string[]` return type for `.value`. + */ +export function defineList( + name: string, + options: ParamOptions = {} +): ListParam { + const param = new ListParam(name, options); + registerParam(param); + return param; +} diff --git a/src/v2/params/types.ts b/src/v2/params/types.ts new file mode 100644 index 000000000..b138150db --- /dev/null +++ b/src/v2/params/types.ts @@ -0,0 +1,294 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +/* + * A CEL expression which can be evaluated during function deployment, and + * resolved to a value of the generic type parameter: i.e, you can pass + * an Expression as the value of an option that normally accepts numbers. + */ +export abstract class Expression< + T extends string | number | boolean | string[] +> { + // Returns the Expression's runtime value, based on the CLI's resolution of params. + value(): T { + throw new Error('Not implemented'); + } + + // Returns the Expression's representation as a braced CEL expression. + toCEL(): string { + return `{{ ${this.toString()} }}`; + } + + toJSON(): string { + return this.toString(); + } +} + +function quoteIfString( + literal: T +): T { + // TODO(vsfan@): CEL's string escape semantics are slightly different than Javascript's, what do we do here? + return typeof literal === 'string' ? (`"${literal}"` as T) : literal; +} + +/** + * A CEL expression corresponding to a ternary operator, e.g {{ cond ? ifTrue : ifFalse }} + */ +export class TernaryExpression< + T extends string | number | boolean | string[] +> extends Expression { + constructor( + private readonly test: Expression, + private readonly ifTrue: T, + private readonly ifFalse: T + ) { + super(); + this.ifTrue = ifTrue; + this.ifFalse = ifFalse; + } + + value(): T { + return !!this.test.value ? this.ifTrue : this.ifFalse; + } + + toString() { + return `${this.test} ? ${quoteIfString(this.ifTrue)} : ${quoteIfString( + this.ifFalse + )}`; + } +} + +/** + * A CEL expression that evaluates to boolean true or false based on a comparison + * between the value of another expression and a literal of that same type. + */ +export class CompareExpression< + T extends string | number | boolean | string[] +> extends Expression { + cmp: '==' | '>' | '>=' | '<' | '<='; + lhs: Expression; + rhs: T; + + constructor(cmp: '==' | '>' | '>=' | '<' | '<=', lhs: Expression, rhs: T) { + super(); + this.cmp = cmp; + this.lhs = lhs; + this.rhs = rhs; + } + + value(): boolean { + const left = this.lhs.value(); + switch (this.cmp) { + case '==': + return left === this.rhs; + case '>': + return left > this.rhs; + case '>=': + return left >= this.rhs; + case '<': + return left < this.rhs; + case '<=': + return left <= this.rhs; + default: + throw new Error('Unknown comparator ' + this.cmp); + } + } + + toString() { + return `${this.lhs} ${this.cmp} ${quoteIfString(this.rhs)}`; + } + + then(ifTrue: T, ifFalse: T) { + return new TernaryExpression(this, ifTrue, ifFalse); + } +} + +/** @hidden */ +type ParamValueType = + | 'string' + | 'list' + | 'boolean' + | 'int' + | 'float' + | 'secret'; + +type ParamInput = + | { text: TextInput } + | { select: SelectInput } + | { resource: ResourceInput }; + +/** + * Specifies that a Param's value should be determined by prompting the user + * to type it in interactively at deploy-time. Input that does not match the + * provided validationRegex, if present, will be retried. + */ +export interface TextInput { + example?: string; + validationRegex?: string; + validationErrorMessage?: string; +} + +/** + * Specifies that a Param's value should be determined by having the user + * select from a list containing all the project's resources of a certain + * type. Currently, only type:"storage.googleapis.com/Bucket" is supported. + */ +export interface ResourceInput { + resource: { + type: string; + }; +} + +/** + * Specifies that a Param's value should be determined by having the user select + * from a list of pre-canned options interactively at deploy-time. + */ +export interface SelectInput { + options: Array>; +} + +export interface SelectOptions { + label?: string; + value: T; +} + +export interface ParamSpec { + name: string; + default?: T; + label?: string; + description?: string; + type: ParamValueType; + input?: ParamInput; +} + +export type ParamOptions = Omit, 'name' | 'type'>; + +export abstract class Param< + T extends string | number | boolean | string[] +> extends Expression { + static type: ParamValueType = 'string'; + + constructor(readonly name: string, readonly options: ParamOptions = {}) { + super(); + } + + value(): T { + throw new Error('Not implemented'); + } + + cmp(cmp: '==' | '>' | '>=' | '<' | '<=', rhs: T) { + return new CompareExpression(cmp, this, rhs); + } + + equals(rhs: T) { + return this.cmp('==', rhs); + } + + toString(): string { + return `params.${this.name}`; + } + + toSpec(): ParamSpec { + const out: ParamSpec = { + name: this.name, + ...this.options, + type: (this.constructor as typeof Param).type, + }; + + return out as ParamSpec; + } +} + +export class SecretParam { + static type: ParamValueType = 'secret'; + name: string; + + constructor(name: string) { + this.name = name; + } + + value(): string { + return process.env[this.name] || ''; + } + + toSpec(): ParamSpec { + return { + type: 'secret', + name: this.name, + }; + } +} + +export class StringParam extends Param { + value(): string { + return process.env[this.name] || ''; + } +} + +export class IntParam extends Param { + static type: ParamValueType = 'int'; + + value(): number { + return parseInt(process.env[this.name] || '0', 10) || 0; + } +} + +export class FloatParam extends Param { + static type: ParamValueType = 'float'; + + value(): number { + return parseFloat(process.env[this.name] || '0') || 0; + } +} + +export class BooleanParam extends Param { + static type: ParamValueType = 'boolean'; + + value(): boolean { + return !!process.env[this.name]; + } + + then(ifTrue: T, ifFalse: T) { + return new TernaryExpression(this, ifTrue, ifFalse); + } +} + +export class ListParam extends Param { + static type: ParamValueType = 'list'; + + value(): string[] { + throw new Error('Not implemented'); + } + + toSpec(): ParamSpec { + const out: ParamSpec = { + name: this.name, + type: 'list', + ...this.options, + }; + if (this.options.default && this.options.default.length > 0) { + out.default = this.options.default.join(','); + } + + return out as ParamSpec; + } +} diff --git a/src/v2/providers/alerts/alerts.ts b/src/v2/providers/alerts/alerts.ts new file mode 100644 index 000000000..b36fb0c55 --- /dev/null +++ b/src/v2/providers/alerts/alerts.ts @@ -0,0 +1,292 @@ +// 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 { ManifestEndpoint } from '../../../runtime/manifest'; +import { CloudEvent, CloudFunction } from '../../core'; +import * as options from '../../options'; +import { Expression } from '../../params'; + +/** + * The CloudEvent data emitted by Firebase Alerts. + * @typeParam T - the payload type that is expected for this alert. + */ +export interface FirebaseAlertData { + /** Time that the event has created. */ + createTime: string; + /** Time that the event has ended. Optional, only present for ongoing alerts. */ + endTime: string; + /** Payload of the event, which includes the details of the specific alert. */ + payload: T; +} + +/** + * A custom CloudEvent for Firebase Alerts (with custom extension attributes). + * @typeParam T - the data type for this alert that is wrapped in a `FirebaseAlertData` object. + */ +export interface AlertEvent extends CloudEvent> { + /** The type of the alerts that got triggered. */ + alertType: string; + /** + * The Firebase App ID that’s associated with the alert. This is optional, + * and only present when the alert is targeting at a specific Firebase App. + */ + appId?: string; + + /** Data for an `AlertEvent` is a `FirebaseAlertData` object with a given payload. */ + data: FirebaseAlertData; +} + +/** @internal */ +export const eventType = 'google.firebase.firebasealerts.alerts.v1.published'; + +/** The underlying alert type of the Firebase Alerts provider. */ +export type AlertType = + | 'crashlytics.newFatalIssue' + | 'crashlytics.newNonfatalIssue' + | 'crashlytics.regression' + | 'crashlytics.stabilityDigest' + | 'crashlytics.velocity' + | 'crashlytics.newAnrIssue' + | 'billing.planUpdate' + | 'billing.automatedPlanUpdate' + | 'appDistribution.newTesterIosDevice' + | 'appDistribution.inAppFeedback' + | 'performance.threshold' + | string; + +/** + * Configuration for Firebase Alert functions. + */ +export interface FirebaseAlertOptions extends options.EventHandlerOptions { + /** Scope the handler to trigger on an alert type. */ + alertType: AlertType; + + /** Scope the function to trigger on a specific application. */ + appId?: string; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * Declares a function that can handle Firebase Alerts from CloudEvents. + * @typeParam T - the type of event.data.payload. + * @param alertType - the alert type or Firebase Alert function configuration. + * @param handler a function that can handle the Firebase Alert inside a CloudEvent. + * @returns A function that you can export and deploy. + */ +export function onAlertPublished( + alertType: AlertType, + handler: (event: AlertEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle Firebase Alerts from CloudEvents. + * @typeParam T - the type of event.data.payload. + * @param options - the alert type and other options for this cloud function. + * @param handler a function that can handle the Firebase Alert inside a CloudEvent. + */ +export function onAlertPublished( + options: FirebaseAlertOptions, + handler: (event: AlertEvent) => any | Promise +): CloudFunction>; + +export function onAlertPublished( + alertTypeOrOpts: AlertType | FirebaseAlertOptions, + handler: (event: AlertEvent) => any | Promise +): CloudFunction> { + const [opts, alertType, appId] = getOptsAndAlertTypeAndApp(alertTypeOrOpts); + + const func = (raw: CloudEvent) => { + return handler(convertAlertAndApp(raw) as AlertEvent); + }; + + func.run = handler; + func.__endpoint = getEndpointAnnotation(opts, alertType, appId); + + return func; +} + +/** + * Helper function for getting the endpoint annotation used in alert handling functions. + * @internal + */ +export function getEndpointAnnotation( + opts: options.EventHandlerOptions, + alertType: string, + appId?: string +): ManifestEndpoint { + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + const specificOpts = options.optionsToEndpoint(opts); + const endpoint: ManifestEndpoint = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType, + eventFilters: { + alerttype: alertType, + }, + retry: !!opts.retry, + }, + }; + if (appId) { + endpoint.eventTrigger.eventFilters.appid = appId; + } + return endpoint; +} + +/** + * Helper function to parse the function opts, alert type, and appId. + * @internal + */ +export function getOptsAndAlertTypeAndApp( + alertTypeOrOpts: AlertType | FirebaseAlertOptions +): [options.EventHandlerOptions, string, string | undefined] { + let opts: options.EventHandlerOptions; + let alertType: AlertType; + let appId: string | undefined; + if (typeof alertTypeOrOpts === 'string') { + alertType = alertTypeOrOpts; + opts = {}; + } else { + alertType = alertTypeOrOpts.alertType; + appId = alertTypeOrOpts.appId; + opts = { ...alertTypeOrOpts }; + delete (opts as any).alertType; + delete (opts as any).appId; + } + return [opts, alertType, appId]; +} + +/** + * Helper function to covert alert type & app id in the CloudEvent to camel case. + * @internal + */ +export function convertAlertAndApp( + raw: CloudEvent +): CloudEvent { + const event = { ...raw }; + + if ('alerttype' in event) { + (event as any).alertType = (event as any).alerttype; + } + if ('appid' in event) { + (event as any).appId = (event as any).appid; + } + + return event; +} diff --git a/src/v2/providers/alerts/appDistribution.ts b/src/v2/providers/alerts/appDistribution.ts new file mode 100644 index 000000000..3446379e4 --- /dev/null +++ b/src/v2/providers/alerts/appDistribution.ts @@ -0,0 +1,374 @@ +// 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. + +/** + * Cloud functions to handle Firebase App Distribution events from Firebase Alerts. + * @packageDocumentation + */ + +import { CloudEvent, CloudFunction } from '../../core'; +import * as options from '../../options'; +import { Expression } from '../../params'; +import { + convertAlertAndApp, + FirebaseAlertData, + getEndpointAnnotation, +} from './alerts'; + +/** + * The internal payload object for adding a new tester device to app distribution. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface NewTesterDevicePayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.AppDistroNewTesterIosDevicePayload'; + /** Name of the tester */ + testerName: string; + /** Email of the tester */ + testerEmail: string; + /** The device model name */ + testerDeviceModelName: string; + /** The device ID */ + testerDeviceIdentifier: string; +} + +/** + * The internal payload object for receiving in-app feedback from a tester. + * Payload is wrapped inside a `FirebaseAlertData` object. + * + * @alpha + */ +export interface InAppFeedbackPayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.AppDistroInAppFeedbackPayload'; + /** Resource name. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/feedbackReports/{feedback_id}` */ + feedbackReport: string; + /** Deep link back to the Firebase console. */ + feedbackConsoleUri: string; + /** Name of the tester */ + testerName?: string; + /** Email of the tester */ + testerEmail: string; + /** + * Version consisting of `versionName` and `versionCode` for Android and + * `CFBundleShortVersionString` and `CFBundleVersion` for iOS. + */ + appVersion: string; + /** Text entered by the tester */ + text: string; + /** URI to download screenshot. This URI is fast expiring. */ + screenshotUri?: string; +} + +/** + * A custom CloudEvent for Firebase Alerts (with custom extension attributes). + * @typeParam T - the data type for app distribution alerts that is wrapped in a `FirebaseAlertData` object. + */ +export interface AppDistributionEvent + extends CloudEvent> { + /** The type of the alerts that got triggered. */ + alertType: string; + /** The Firebase App ID that’s associated with the alert. */ + appId: string; +} + +/** @internal */ +export const newTesterIosDeviceAlert = 'appDistribution.newTesterIosDevice'; +/** @internal */ +export const inAppFeedbackAlert = 'appDistribution.inAppFeedback'; + +/** + * Configuration for app distribution functions. + */ +export interface AppDistributionOptions extends options.EventHandlerOptions { + /** Scope the function to trigger on a specific application. */ + appId?: string; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * Declares a function that can handle adding a new tester iOS device. + * @param handler - Event handler which is run every time a new tester iOS device is added. + * @returns A function that you can export and deploy. + */ +export function onNewTesterIosDevicePublished( + handler: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle adding a new tester iOS device. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler which is run every time a new tester iOS device is added. + * @returns A function that you can export and deploy. + */ +export function onNewTesterIosDevicePublished( + appId: string, + handler: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle adding a new tester iOS device. + * @param opts - Options that can be set on the function. + * @param handler - Event handler which is run every time a new tester iOS device is added. + * @returns A function that you can export and deploy. + */ +export function onNewTesterIosDevicePublished( + opts: AppDistributionOptions, + handler: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle adding a new tester iOS device. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler which is run every time a new tester iOS device is added. + * @returns A function that you can export and deploy. + */ +export function onNewTesterIosDevicePublished( + appIdOrOptsOrHandler: + | string + | AppDistributionOptions + | (( + event: AppDistributionEvent + ) => any | Promise), + handler?: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction> { + if (typeof appIdOrOptsOrHandler === 'function') { + handler = appIdOrOptsOrHandler as ( + event: AppDistributionEvent + ) => any | Promise; + appIdOrOptsOrHandler = {}; + } + + const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler); + + const func = (raw: CloudEvent) => { + return handler( + convertAlertAndApp(raw) as AppDistributionEvent + ); + }; + + func.run = handler; + func.__endpoint = getEndpointAnnotation(opts, newTesterIosDeviceAlert, appId); + + return func; +} + +/** + * Declares a function that can handle receiving new in-app feedback from a tester. + * @param handler - Event handler which is run every time new feedback is received. + * @returns A function that you can export and deploy. + * + * @alpha + */ +export function onInAppFeedbackPublished( + handler: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle receiving new in-app feedback from a tester. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler which is run every time new feedback is received. + * @returns A function that you can export and deploy. + * + * @alpha + */ +export function onInAppFeedbackPublished( + appId: string, + handler: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle receiving new in-app feedback from a tester. + * @param opts - Options that can be set on the function. + * @param handler - Event handler which is run every time new feedback is received. + * @returns A function that you can export and deploy. + * + * @alpha + */ +export function onInAppFeedbackPublished( + opts: AppDistributionOptions, + handler: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle receiving new in-app feedback from a tester. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler which is run every time new feedback is received. + * @returns A function that you can export and deploy. + * + * @alpha + */ +export function onInAppFeedbackPublished( + appIdOrOptsOrHandler: + | string + | AppDistributionOptions + | (( + event: AppDistributionEvent + ) => any | Promise), + handler?: ( + event: AppDistributionEvent + ) => any | Promise +): CloudFunction> { + if (typeof appIdOrOptsOrHandler === 'function') { + handler = appIdOrOptsOrHandler as ( + event: AppDistributionEvent + ) => any | Promise; + appIdOrOptsOrHandler = {}; + } + + const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler); + + const func = (raw: CloudEvent) => { + return handler( + convertAlertAndApp(raw) as AppDistributionEvent + ); + }; + + func.run = handler; + func.__endpoint = getEndpointAnnotation(opts, inAppFeedbackAlert, appId); + + return func; +} + +/** + * Helper function to parse the function opts and appId. + * @internal + */ +export function getOptsAndApp( + appIdOrOpts: string | AppDistributionOptions +): [options.EventHandlerOptions, string | undefined] { + let opts: options.EventHandlerOptions; + let appId: string | undefined; + if (typeof appIdOrOpts === 'string') { + opts = {}; + appId = appIdOrOpts; + } else { + appId = appIdOrOpts.appId; + opts = { ...appIdOrOpts }; + delete (opts as any).appId; + } + return [opts, appId]; +} diff --git a/src/v2/providers/alerts/billing.ts b/src/v2/providers/alerts/billing.ts new file mode 100644 index 000000000..955fd8791 --- /dev/null +++ b/src/v2/providers/alerts/billing.ts @@ -0,0 +1,181 @@ +// 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. + +/** + * Cloud functions to handle billing events from Firebase Alerts. + * @packageDocumentation + */ + +import { CloudEvent, CloudFunction } from '../../core'; +import * as options from '../../options'; +import { + convertAlertAndApp, + FirebaseAlertData, + getEndpointAnnotation, +} from './alerts'; + +/** + * The internal payload object for billing plan updates. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface PlanUpdatePayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.BillingPlanUpdatePayload'; + /** A Firebase billing plan. */ + billingPlan: string; + /** The email address of the person that triggered billing plan change */ + principalEmail: string; + /** The type of the notification, e.g. upgrade, downgrade */ + notificationType: string; +} + +/** + * The internal payload object for billing plan automated updates. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface PlanAutomatedUpdatePayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.BillingPlanAutomatedUpdatePayload'; + /** A Firebase billing plan. */ + billingPlan: string; + /** The type of the notification, e.g. upgrade, downgrade */ + notificationType: string; +} + +/** + * A custom CloudEvent for billing Firebase Alerts (with custom extension attributes). + * @typeParam T - the data type for billing alerts that is wrapped in a `FirebaseAlertData` object. + */ +export interface BillingEvent extends CloudEvent> { + /** The type of the alerts that got triggered. */ + alertType: string; +} + +/** @internal */ +export const planUpdateAlert = 'billing.planUpdate'; +/** @internal */ +export const planAutomatedUpdateAlert = 'billing.planAutomatedUpdate'; + +/** + * Declares a function that can handle a billing plan update event. + * @param handler - Event handler which is run every time a billing plan is updated. + * @returns A function that you can export and deploy. + */ +export function onPlanUpdatePublished( + handler: (event: BillingEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a billing plan update event. + * @param opts - Options that can be set on the function. + * @param handler - Event handler which is run every time a billing plan is updated. + * @returns A function that you can export and deploy. + */ +export function onPlanUpdatePublished( + opts: options.EventHandlerOptions, + handler: (event: BillingEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a billing plan update event. + * @param optsOrHandler - Options or an event-handling function. + * @param handler - Event handler which is run every time a billing plan is updated. + * @returns A function that you can export and deploy. + */ +export function onPlanUpdatePublished( + optsOrHandler: + | options.EventHandlerOptions + | ((event: BillingEvent) => any | Promise), + handler?: (event: BillingEvent) => any | Promise +): CloudFunction> { + return onOperation( + planUpdateAlert, + optsOrHandler, + handler + ); +} + +/** + * Declares a function that can handle an automated billing plan update event. + * @param handler - Event handler which is run every time an automated billing plan update occurs. + * @returns A function that you can export and deploy. + */ +export function onPlanAutomatedUpdatePublished( + handler: ( + event: BillingEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle an automated billing plan update event. + * @param opts - Options that can be set on the function. + * @param handler - Event handler which is run every time an automated billing plan update occurs. + * @returns A function that you can export and deploy. + */ +export function onPlanAutomatedUpdatePublished( + opts: options.EventHandlerOptions, + handler: ( + event: BillingEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle an automated billing plan update event. + * @param optsOrHandler - Options or an event-handling function. + * @param handler - Event handler which is run every time an automated billing plan update occurs. + * @returns A function that you can export and deploy. + */ +export function onPlanAutomatedUpdatePublished( + optsOrHandler: + | options.EventHandlerOptions + | ((event: BillingEvent) => any | Promise), + handler?: ( + event: BillingEvent + ) => any | Promise +): CloudFunction> { + return onOperation( + planAutomatedUpdateAlert, + optsOrHandler, + handler + ); +} + +/** @internal */ +export function onOperation( + alertType: string, + optsOrHandler: + | options.EventHandlerOptions + | ((event: BillingEvent) => any | Promise), + handler: (event: BillingEvent) => any | Promise +): CloudFunction> { + if (typeof optsOrHandler === 'function') { + handler = optsOrHandler as (event: BillingEvent) => any | Promise; + optsOrHandler = {}; + } + + const func = (raw: CloudEvent) => { + return handler(convertAlertAndApp(raw) as BillingEvent); + }; + + func.run = handler; + func.__endpoint = getEndpointAnnotation(optsOrHandler, alertType); + + return func; +} diff --git a/src/v2/providers/alerts/crashlytics.ts b/src/v2/providers/alerts/crashlytics.ts new file mode 100644 index 000000000..1e6345b41 --- /dev/null +++ b/src/v2/providers/alerts/crashlytics.ts @@ -0,0 +1,665 @@ +// 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. + +/** + * Cloud functions to handle Crashlytics events from Firebase Alerts. + * @packageDocumentation + */ + +import { CloudEvent, CloudFunction } from '../../core'; +import * as options from '../../options'; +import { Expression } from '../../params'; +import { + convertAlertAndApp, + FirebaseAlertData, + getEndpointAnnotation, +} from './alerts'; + +/** Generic Crashlytics issue interface */ +export interface Issue { + /** The ID of the Crashlytics issue */ + id: string; + /** The title of the Crashlytics issue */ + title: string; + /** The subtitle of the Crashlytics issue */ + subtitle: string; + /** The application version of the Crashlytics issue */ + appVersion: string; +} + +/** + * The internal payload object for a new fatal issue. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface NewFatalIssuePayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewFatalIssuePayload'; + /** Basic information of the Crashlytics issue */ + issue: Issue; +} + +/** + * The internal payload object for a new non-fatal issue. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface NewNonfatalIssuePayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewNonfatalIssuePayload'; + /** Basic information of the Crashlytics issue */ + issue: Issue; +} + +/** + * The internal payload object for a regression alert. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface RegressionAlertPayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsRegressionAlertPayload'; + /** The type of the Crashlytics issue, e.g. new fatal, new nonfatal, ANR */ + type: string; + /** Basic information of the Crashlytics issue */ + issue: Issue; + /** + * The time that the Crashlytics issues was most recently resolved before it + * began to reoccur. + */ + resolveTime: string; +} + +/** Generic Crashlytics trending issue interface */ +export interface TrendingIssueDetails { + /** The type of the Crashlytics issue, e.g. new fatal, new nonfatal, ANR */ + type: string; + /** Basic information of the Crashlytics issue */ + issue: Issue; + /** The number of crashes that occurred with the issue */ + eventCount: number; + /** The number of distinct users that were affected by the issue */ + userCount: number; +} + +/** + * The internal payload object for a stability digest. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface StabilityDigestPayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsStabilityDigestPayload'; + /** + * The date that the digest gets created. Issues in the digest should have the + * same date as the digest date + */ + digestDate: string; + /** A stability digest containing several trending Crashlytics issues */ + trendingIssues: TrendingIssueDetails[]; +} + +/** + * The internal payload object for a velocity alert. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface VelocityAlertPayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsVelocityAlertPayload'; + /** Basic information of the Crashlytics issue */ + issue: Issue; + /** The time that the Crashlytics issue gets created */ + createTime: string; + /** + * The number of user sessions for the given app version that had this + * specific crash issue in the time period used to trigger the velocity alert. + */ + crashCount: number; + /** + * The percentage of user sessions for the given app version that had this + * specific crash issue in the time period used to trigger the velocity alert. + */ + crashPercentage: number; + /** + * The first app version where this issue was seen, and not necessarily the + * version that has triggered the alert. + */ + firstVersion: string; +} + +/** + * The internal payload object for a new Application Not Responding issue. + * Payload is wrapped inside a `FirebaseAlertData` object. + */ +export interface NewAnrIssuePayload { + ['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.CrashlyticsNewAnrIssuePayload'; + /** Basic information of the Crashlytics issue */ + issue: Issue; +} + +/** + * A custom CloudEvent for Firebase Alerts (with custom extension attributes). + * @typeParam T - the data type for Crashlytics alerts that is wrapped in a `FirebaseAlertData` object. + */ +export interface CrashlyticsEvent extends CloudEvent> { + /** The type of the alerts that got triggered. */ + alertType: string; + /** The Firebase App ID that’s associated with the alert. */ + appId: string; +} + +/** @internal */ +export const newFatalIssueAlert = 'crashlytics.newFatalIssue'; +/** @internal */ +export const newNonfatalIssueAlert = 'crashlytics.newNonfatalIssue'; +/** @internal */ +export const regressionAlert = 'crashlytics.regression'; +/** @internal */ +export const stabilityDigestAlert = 'crashlytics.stabilityDigest'; +/** @internal */ +export const velocityAlert = 'crashlytics.velocity'; +/** @internal */ +export const newAnrIssueAlert = 'crashlytics.newAnrIssue'; + +/** + * Configuration for Crashlytics functions. + */ +export interface CrashlyticsOptions extends options.EventHandlerOptions { + /** Scope the function to trigger on a specific application. */ + appId?: string; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * Declares a function that can handle a new fatal issue published to Crashlytics. + * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewFatalIssuePublished( + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new fatal issue published to Crashlytics. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewFatalIssuePublished( + appId: string, + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new fatal issue published to Crashlytics. + * @param opts - Options that can be set on the function. + * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewFatalIssuePublished( + opts: CrashlyticsOptions, + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new fatal issue published to Crashlytics. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewFatalIssuePublished( + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | ((event: CrashlyticsEvent) => any | Promise), + handler?: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction> { + return onOperation( + newFatalIssueAlert, + appIdOrOptsOrHandler, + handler + ); +} + +/** + * Declares a function that can handle a new non-fatal issue published to Crashlytics. + * @param handler - Event handler that is triggered when a new fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewNonfatalIssuePublished( + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new non-fatal issue published to Crashlytics. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler that is triggered when a new non-fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewNonfatalIssuePublished( + appId: string, + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new non-fatal issue published to Crashlytics. + * @param opts - Options that can be set on the function. + * @param handler - Event handler that is triggered when a new non-fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewNonfatalIssuePublished( + opts: CrashlyticsOptions, + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new non-fatal issue published to Crashlytics. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler that is triggered when a new non-fatal issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewNonfatalIssuePublished( + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | (( + event: CrashlyticsEvent + ) => any | Promise), + handler?: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction> { + return onOperation( + newNonfatalIssueAlert, + appIdOrOptsOrHandler, + handler + ); +} + +/** + * Declares a function that can handle a regression alert published to Crashlytics. + * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onRegressionAlertPublished( + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a regression alert published to Crashlytics. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics. + * @returns A function that you can export and deploy. + + */ +export function onRegressionAlertPublished( + appId: string, + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a regression alert published to Crashlytics. + * @param opts - Options that can be set on the function. + * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics. + * @returns A function that you can export and deploy. + + */ +export function onRegressionAlertPublished( + opts: CrashlyticsOptions, + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a regression alert published to Crashlytics. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler that is triggered when a regression alert is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onRegressionAlertPublished( + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | ((event: CrashlyticsEvent) => any | Promise), + handler?: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction> { + return onOperation( + regressionAlert, + appIdOrOptsOrHandler, + handler + ); +} + +/** + * Declares a function that can handle a stability digest published to Crashlytics. + * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onStabilityDigestPublished( + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a stability digest published to Crashlytics. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics. + * @returns A function that you can export and deploy. + + */ +export function onStabilityDigestPublished( + appId: string, + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a stability digest published to Crashlytics. + * @param opts - Options that can be set on the function. + * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics. + * @returns A function that you can export and deploy. + + */ +export function onStabilityDigestPublished( + opts: CrashlyticsOptions, + handler: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a stability digest published to Crashlytics. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler that is triggered when a stability digest is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onStabilityDigestPublished( + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | ((event: CrashlyticsEvent) => any | Promise), + handler?: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction> { + return onOperation( + stabilityDigestAlert, + appIdOrOptsOrHandler, + handler + ); +} + +/** + * Declares a function that can handle a velocity alert published to Crashlytics. + * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onVelocityAlertPublished( + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a velocity alert published to Crashlytics. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onVelocityAlertPublished( + appId: string, + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a velocity alert published to Crashlytics. + * @param opts - Options that can be set on the function. + * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onVelocityAlertPublished( + opts: CrashlyticsOptions, + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a velocity alert published to Crashlytics. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler that is triggered when a velocity alert is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onVelocityAlertPublished( + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | ((event: CrashlyticsEvent) => any | Promise), + handler?: ( + event: CrashlyticsEvent + ) => any | Promise +): CloudFunction> { + return onOperation( + velocityAlert, + appIdOrOptsOrHandler, + handler + ); +} + +/** + * Declares a function that can handle a new Application Not Responding issue published to Crashlytics. + * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewAnrIssuePublished( + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new Application Not Responding issue published to Crashlytics. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics. + * @returns A function that you can export and deploy. + + */ +export function onNewAnrIssuePublished( + appId: string, + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new Application Not Responding issue published to Crashlytics. + * @param opts - Options that can be set on the function. + * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics. + * @returns A function that you can export and deploy. + + */ +export function onNewAnrIssuePublished( + opts: CrashlyticsOptions, + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle a new Application Not Responding issue published to Crashlytics. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics. + * @returns A function that you can export and deploy. + */ +export function onNewAnrIssuePublished( + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | ((event: CrashlyticsEvent) => any | Promise), + handler?: (event: CrashlyticsEvent) => any | Promise +): CloudFunction> { + return onOperation( + newAnrIssueAlert, + appIdOrOptsOrHandler, + handler + ); +} + +/** @internal */ +export function onOperation( + alertType: string, + appIdOrOptsOrHandler: + | string + | CrashlyticsOptions + | ((event: CrashlyticsEvent) => any | Promise), + handler: (event: CrashlyticsEvent) => any | Promise +): CloudFunction> { + if (typeof appIdOrOptsOrHandler === 'function') { + handler = appIdOrOptsOrHandler as ( + event: CrashlyticsEvent + ) => any | Promise; + appIdOrOptsOrHandler = {}; + } + + const [opts, appId] = getOptsAndApp( + appIdOrOptsOrHandler as string | CrashlyticsOptions + ); + + const func = (raw: CloudEvent) => { + return handler(convertAlertAndApp(raw) as CrashlyticsEvent); + }; + + func.run = handler; + func.__endpoint = getEndpointAnnotation(opts, alertType, appId); + + return func; +} + +/** + * Helper function to parse the function opts and appId. + * @internal + */ +export function getOptsAndApp( + appIdOrOpts: string | CrashlyticsOptions +): [options.EventHandlerOptions, string | undefined] { + let opts: options.EventHandlerOptions; + let appId: string | undefined; + if (typeof appIdOrOpts === 'string') { + opts = {}; + appId = appIdOrOpts; + } else { + appId = appIdOrOpts.appId; + opts = { ...appIdOrOpts }; + delete (opts as any).appId; + } + return [opts, appId]; +} diff --git a/src/v2/providers/alerts/index.ts b/src/v2/providers/alerts/index.ts new file mode 100644 index 000000000..e0988f5b8 --- /dev/null +++ b/src/v2/providers/alerts/index.ts @@ -0,0 +1,36 @@ +// 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. + +/** + * Cloud functions to handle events from Firebase Alerts. + * Subpackages give stronger typing to specific services which + * notify users via Firebase Alerts. + * @packageDocumentation + */ + +import * as appDistribution from './appDistribution'; +import * as billing from './billing'; +import * as crashlytics from './crashlytics'; +import * as performance from './performance'; + +export { appDistribution, billing, crashlytics, performance }; +export * from './alerts'; diff --git a/src/v2/providers/alerts/performance.ts b/src/v2/providers/alerts/performance.ts new file mode 100644 index 000000000..ef0a5f5e0 --- /dev/null +++ b/src/v2/providers/alerts/performance.ts @@ -0,0 +1,203 @@ +// 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. + +/** + * Cloud functions to handle Firebase Performance Monitoring events from Firebase Alerts. + * @packageDocumentation + */ + +import { CloudEvent, CloudFunction } from '../../core'; +import { EventHandlerOptions } from '../../options'; +import { + convertAlertAndApp, + FirebaseAlertData, + getEndpointAnnotation, +} from './alerts'; + +/** + * The internal payload object for a performance threshold alert. + * Payload is wrapped inside a {@link FirebaseAlertData} object. + */ +export interface ThresholdAlertPayload { + /** Name of the trace or network request this alert is for (e.g. my_custom_trace, firebase.com/api/123) */ + eventName: string; + /** The resource type this alert is for (i.e. trace, network request, screen rendering, etc.) */ + eventType: string; + /** The metric type this alert is for (i.e. success rate, response time, duration, etc.) */ + metricType: string; + /** The number of events checked for this alert condition */ + numSamples: number; + /** The threshold value of the alert condition without units (e.g. "75", "2.1") */ + thresholdValue: number; + /** The unit for the alert threshold (e.g. "percent", "seconds") */ + thresholdUnit: string; + /** The percentile of the alert condition, can be 0 if percentile is not applicable to the alert condition and omitted; range: [1, 100] */ + conditionPercentile?: number; + /** The app version this alert was triggered for, can be omitted if the alert is for a network request (because the alert was checked against data from all versions of app) or a web app (where the app is versionless) */ + appVersion?: string; + /** The value that violated the alert condition (e.g. "76.5", "3") */ + violationValue: number; + /** The unit for the violation value (e.g. "percent", "seconds") */ + violationUnit: string; + /** The link to Fireconsole to investigate more into this alert */ + investigateUri: string; +} + +/** + * A custom CloudEvent for Firebase Alerts (with custom extension attributes). + * @typeParam T - the data type for performance alerts that is wrapped in a `FirebaseAlertData` object. + */ +export interface PerformanceEvent extends CloudEvent> { + /** The type of the alerts that got triggered. */ + alertType: string; + /** The Firebase App ID that’s associated with the alert. */ + appId: string; +} + +/** @internal */ +export const thresholdAlert = 'performance.threshold'; + +/** + * Configuration for app distribution functions. + */ +export interface PerformanceOptions extends EventHandlerOptions { + /** Scope the function to trigger on a specific application. */ + appId?: string; +} + +/** + * Declares a function that can handle receiving performance threshold alerts. + * @param handler - Event handler which is run every time a threshold alert is received. + * @returns A function that you can export and deploy. + */ +export function onThresholdAlertPublished( + handler: ( + event: PerformanceEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle receiving performance threshold alerts. + * @param appId - A specific application the handler will trigger on. + * @param handler - Event handler which is run every time a threshold alert is received. + * @returns A function that you can export and deploy. + */ +export function onThresholdAlertPublished( + appId: string, + handler: ( + event: PerformanceEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle receiving performance threshold alerts. + * @param opts - Options that can be set on the function. + * @param handler - Event handler which is run every time a threshold alert is received. + * @returns A function that you can export and deploy. + */ +export function onThresholdAlertPublished( + opts: PerformanceOptions, + handler: ( + event: PerformanceEvent + ) => any | Promise +): CloudFunction>; + +/** + * Declares a function that can handle receiving performance threshold alerts. + * @param appIdOrOptsOrHandler - A specific application, options, or an event-handling function. + * @param handler - Event handler which is run every time a threshold alert is received. + * @returns A function that you can export and deploy. + */ +export function onThresholdAlertPublished( + appIdOrOptsOrHandler: + | string + | PerformanceOptions + | ((event: PerformanceEvent) => any | Promise), + handler?: ( + event: PerformanceEvent + ) => any | Promise +): CloudFunction> { + if (typeof appIdOrOptsOrHandler === 'function') { + handler = appIdOrOptsOrHandler as ( + event: PerformanceEvent + ) => any | Promise; + appIdOrOptsOrHandler = {}; + } + + const [opts, appId] = getOptsAndApp(appIdOrOptsOrHandler); + + const func = (raw: CloudEvent) => { + const event = convertAlertAndApp(raw) as PerformanceEvent< + ThresholdAlertPayload + >; + const convertedPayload = convertPayload(event.data.payload); + event.data.payload = convertedPayload; + return handler(event); + }; + + func.run = handler; + func.__endpoint = getEndpointAnnotation(opts, thresholdAlert, appId); + + return func; +} + +/** + * Helper function to parse the function opts and appId. + * @internal + */ +export function getOptsAndApp( + appIdOrOpts: string | PerformanceOptions +): [EventHandlerOptions, string | undefined] { + if (typeof appIdOrOpts === 'string') { + return [{}, appIdOrOpts]; + } + + const opts: EventHandlerOptions = { ...appIdOrOpts }; + const appId: string | undefined = appIdOrOpts.appId; + delete (opts as any).appId; + + return [opts, appId]; +} + +/** + * Helper function to convert the raw payload of a {@link PerformanceEvent} to a {@link ThresholdAlertPayload} + * @internal + */ +export function convertPayload( + raw: ThresholdAlertPayload +): ThresholdAlertPayload { + const payload: ThresholdAlertPayload = { ...raw }; + if ( + typeof payload.conditionPercentile !== 'undefined' && + payload.conditionPercentile === 0 + ) { + delete (payload as any).conditionPercentile; + } + if ( + typeof payload.appVersion !== 'undefined' && + payload.appVersion.length === 0 + ) { + delete (payload as any).appVersion; + } + + return payload; +} diff --git a/src/v2/providers/database.ts b/src/v2/providers/database.ts new file mode 100644 index 000000000..2f3127dff --- /dev/null +++ b/src/v2/providers/database.ts @@ -0,0 +1,505 @@ +// 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 { apps } from '../../apps'; +import { Change } from '../../common/change'; +import { DataSnapshot } from '../../common/providers/database'; +import { ManifestEndpoint } from '../../runtime/manifest'; +import { normalizePath } from '../../utilities/path'; +import { PathPattern } from '../../utilities/path-pattern'; +import { applyChange } from '../../utils'; +import { CloudEvent, CloudFunction } from '../core'; +import * as options from '../options'; +import { Expression } from '../params'; + +export { DataSnapshot }; + +/** @internal */ +export const writtenEventType = 'google.firebase.database.ref.v1.written'; + +/** @internal */ +export const createdEventType = 'google.firebase.database.ref.v1.created'; + +/** @internal */ +export const updatedEventType = 'google.firebase.database.ref.v1.updated'; + +/** @internal */ +export const deletedEventType = 'google.firebase.database.ref.v1.deleted'; + +/** @hidden */ +export interface RawRTDBCloudEventData { + ['@type']: 'type.googleapis.com/google.events.firebase.database.v1.ReferenceEventData'; + data: any; + delta: any; +} + +/** @hidden */ +export interface RawRTDBCloudEvent extends CloudEvent { + firebasedatabasehost: string; + instance: string; + ref: string; + location: string; +} + +/** A CloudEvent that contains a DataSnapshot or a Change */ +export interface DatabaseEvent extends CloudEvent { + /** The domain of the database instance */ + firebaseDatabaseHost: string; + /** The instance ID portion of the fully qualified resource name */ + instance: string; + /** The database reference path */ + ref: string; + /** The location of the database */ + location: string; + /** + * An object containing the values of the path patterns. + * Only named capture groups will be populated - {key}, {key=*}, {key=**} + */ + params: Record; +} + +/** ReferenceOptions extend EventHandlerOptions with provided ref and optional instance */ +export interface ReferenceOptions extends options.EventHandlerOptions { + /** + * Specify the handler to trigger on a database reference(s). + * This value can either be a single reference or a pattern. + * Examples: '/foo/bar', '/foo/{bar}' + */ + ref: string; + + /** + * Specify the handler to trigger on a database instance(s). + * If present, this value can either be a single instance or a pattern. + * Examples: 'my-instance-1', 'my-instance-*' + * Note: The capture syntax cannot be used for 'instance'. + */ + instance?: string; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean | Expression | null; +} + +/** + * Event handler which triggers when data is created, updated, or deleted in Realtime Database. + * + * @param reference - The database reference path to trigger on. + * @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs. + */ +export function onValueWritten( + reference: string, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>>; + +/** + * Event handler which triggers when data is created, updated, or deleted in Realtime Database. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs. + */ +export function onValueWritten( + opts: ReferenceOptions, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>>; + +/** + * Event handler which triggers when data is created, updated, or deleted in Realtime Database. + * + * @param referenceOrOpts - Options or a string reference. + * @param handler - Event handler which is run every time a Realtime Database create, update, or delete occurs. + */ +export function onValueWritten( + referenceOrOpts: string | ReferenceOptions, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>> { + return onChangedOperation(writtenEventType, referenceOrOpts, handler); +} + +/** + * Event handler which triggers when data is created in Realtime Database. + * + * @param reference - The database reference path to trigger on. + * @param handler - Event handler which is run every time a Realtime Database create occurs. + */ +export function onValueCreated( + reference: string, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction>; + +/** + * Event handler which triggers when data is created in Realtime Database. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Realtime Database create occurs. + */ +export function onValueCreated( + opts: ReferenceOptions, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction>; + +/** + * Event handler which triggers when data is created in Realtime Database. + * + * @param referenceOrOpts - Options or a string reference. + * @param handler - Event handler which is run every time a Realtime Database create occurs. + */ +export function onValueCreated( + referenceOrOpts: string | ReferenceOptions, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction> { + return onOperation(createdEventType, referenceOrOpts, handler); +} + +/** + * Event handler which triggers when data is updated in Realtime Database. + * + * @param reference - The database reference path to trigger on. + * @param handler - Event handler which is run every time a Realtime Database update occurs. + */ +export function onValueUpdated( + reference: string, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>>; + +/** + * Event handler which triggers when data is updated in Realtime Database. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Realtime Database update occurs. + */ +export function onValueUpdated( + opts: ReferenceOptions, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>>; + +/** + * Event handler which triggers when data is updated in Realtime Database. + * + * @param referenceOrOpts - Options or a string reference. + * @param handler - Event handler which is run every time a Realtime Database update occurs. + */ +export function onValueUpdated( + referenceOrOpts: string | ReferenceOptions, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>> { + return onChangedOperation(updatedEventType, referenceOrOpts, handler); +} + +/** + * Event handler which triggers when data is deleted in Realtime Database. + * + * @param reference - The database reference path to trigger on. + * @param handler - Event handler which is run every time a Realtime Database deletion occurs. + */ +export function onValueDeleted( + reference: string, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction>; + +/** + * Event handler which triggers when data is deleted in Realtime Database. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Realtime Database deletion occurs. + */ +export function onValueDeleted( + opts: ReferenceOptions, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction>; + +/** + * Event handler which triggers when data is deleted in Realtime Database. + * + * @param referenceOrOpts - Options or a string reference. + * @param handler - Event handler which is run every time a Realtime Database deletion occurs. + */ +export function onValueDeleted( + referenceOrOpts: string | ReferenceOptions, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction> { + // TODO - need to use event.data.delta + return onOperation(deletedEventType, referenceOrOpts, handler); +} + +/** @internal */ +export function getOpts(referenceOrOpts: string | ReferenceOptions) { + let path: string, instance: string, opts: options.EventHandlerOptions; + if (typeof referenceOrOpts === 'string') { + path = normalizePath(referenceOrOpts); + instance = '*'; + opts = {}; + } else { + path = normalizePath(referenceOrOpts.ref); + instance = referenceOrOpts.instance || '*'; + opts = { ...referenceOrOpts }; + delete (opts as any).ref; + delete (opts as any).instance; + } + + return { + path, + instance, + opts, + }; +} + +/** @internal */ +export function makeParams( + event: RawRTDBCloudEvent, + path: PathPattern, + instance: PathPattern +) { + return { + ...path.extractMatches(event.ref), + ...instance.extractMatches(event.instance), + }; +} + +/** @hidden */ +function makeDatabaseEvent( + event: RawRTDBCloudEvent, + data: any, + instance: string, + params: Record +): DatabaseEvent { + const snapshot = new DataSnapshot(data, event.ref, apps().admin, instance); + const databaseEvent: DatabaseEvent = { + ...event, + firebaseDatabaseHost: event.firebasedatabasehost, + data: snapshot, + params, + }; + delete (databaseEvent as any).firebasedatabasehost; + return databaseEvent; +} + +/** @hidden */ +function makeChangedDatabaseEvent( + event: RawRTDBCloudEvent, + instance: string, + params: Record +): DatabaseEvent> { + const before = new DataSnapshot( + event.data.data, + event.ref, + apps().admin, + instance + ); + const after = new DataSnapshot( + applyChange(event.data.data, event.data.delta), + event.ref, + apps().admin, + instance + ); + const databaseEvent: DatabaseEvent> = { + ...event, + firebaseDatabaseHost: event.firebasedatabasehost, + data: { + before, + after, + }, + params, + }; + delete (databaseEvent as any).firebasedatabasehost; + return databaseEvent; +} + +/** @internal */ +export function makeEndpoint( + eventType: string, + opts: options.EventHandlerOptions, + path: PathPattern, + instance: PathPattern +): ManifestEndpoint { + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + const specificOpts = options.optionsToEndpoint(opts); + + const eventFilters: Record = {}; + const eventFilterPathPatterns: Record = { + // Note: Eventarc always treats ref as a path pattern + ref: path.getValue(), + }; + instance.hasWildcards() + ? (eventFilterPathPatterns.instance = instance.getValue()) + : (eventFilters.instance = instance.getValue()); + + return { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType, + eventFilters, + eventFilterPathPatterns, + retry: false, + }, + }; +} + +/** @internal */ +export function onChangedOperation( + eventType: string, + referenceOrOpts: string | ReferenceOptions, + handler: (event: DatabaseEvent>) => any | Promise +): CloudFunction>> { + const { path, instance, opts } = getOpts(referenceOrOpts); + + const pathPattern = new PathPattern(path); + const instancePattern = new PathPattern(instance); + + // wrap the handler + const func = (raw: CloudEvent) => { + const event = raw as RawRTDBCloudEvent; + const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`; + const params = makeParams(event, pathPattern, instancePattern); + const databaseEvent = makeChangedDatabaseEvent(event, instanceUrl, params); + return handler(databaseEvent); + }; + + func.run = handler; + + func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern); + + return func; +} + +/** @internal */ +export function onOperation( + eventType: string, + referenceOrOpts: string | ReferenceOptions, + handler: (event: DatabaseEvent) => any | Promise +): CloudFunction> { + const { path, instance, opts } = getOpts(referenceOrOpts); + + const pathPattern = new PathPattern(path); + const instancePattern = new PathPattern(instance); + + // wrap the handler + const func = (raw: CloudEvent) => { + const event = raw as RawRTDBCloudEvent; + const instanceUrl = `https://${event.instance}.${event.firebasedatabasehost}`; + const params = makeParams(event, pathPattern, instancePattern); + const data = + eventType === deletedEventType ? event.data.data : event.data.delta; + const databaseEvent = makeDatabaseEvent(event, data, instanceUrl, params); + return handler(databaseEvent); + }; + + func.run = handler; + + func.__endpoint = makeEndpoint(eventType, opts, pathPattern, instancePattern); + + return func; +} diff --git a/src/v2/providers/eventarc.ts b/src/v2/providers/eventarc.ts new file mode 100644 index 000000000..71e4b0174 --- /dev/null +++ b/src/v2/providers/eventarc.ts @@ -0,0 +1,220 @@ +// 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. + +/** + * Cloud functions to integrate directly with Eventarc. + * @packageDocumentation + */ + +import { convertIfPresent, copyIfPresent } from '../../common/encoding'; +import { ManifestEndpoint } from '../../runtime/manifest'; +import { CloudEvent, CloudFunction } from '../core'; +import * as options from '../options'; +import { Expression } from '../params'; + +/** Options that can be set on an Eventarc trigger. */ +export interface EventarcTriggerOptions extends options.EventHandlerOptions { + /** + * Type of the event to trigger on. + */ + eventType: string; + + /** + * ID of the channel. Can be either: + * * fully qualified channel resource name: + * `projects/{project}/locations/{location}/channels/{channel-id}` + * * partial resource name with location and channel ID, in which case + * the runtime project ID of the function will be used: + * `locations/{location}/channels/{channel-id}` + * * partial channel ID, in which case the runtime project ID of the + * function and `us-central1` as location will be used: + * `{channel-id}` + * + * If not specified, the default Firebase channel will be used: + * `projects/{project}/locations/us-central1/channels/firebase` + */ + channel?: string; + + /** + * Eventarc event exact match filter. + */ + filters?: Record; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** Handles an Eventarc event published on the default channel. + * @param eventType - Type of the event to trigger on. + * @param handler - A function to execute when triggered. + * @returns A function that you can export and deploy. + */ +export function onCustomEventPublished( + eventType: string, + handler: (event: CloudEvent) => any | Promise +): CloudFunction>; + +/** Handles an Eventarc event. + * @param opts - Options to set on this function + * @param handler - A function to execute when triggered. + * @returns A function that you can export and deploy. + */ +export function onCustomEventPublished( + opts: EventarcTriggerOptions, + handler: (event: CloudEvent) => any | Promise +): CloudFunction>; + +export function onCustomEventPublished( + eventTypeOrOpts: string | EventarcTriggerOptions, + handler: (event: CloudEvent) => any | Promise +): CloudFunction> { + let opts: EventarcTriggerOptions; + if (typeof eventTypeOrOpts === 'string') { + opts = { + eventType: eventTypeOrOpts as string, + }; + } else if (typeof eventTypeOrOpts === 'object') { + opts = eventTypeOrOpts as EventarcTriggerOptions; + } + const func = (raw: CloudEvent) => { + return handler(raw as CloudEvent); + }; + + func.run = handler; + + const channel = opts.channel ?? 'locations/us-central1/channels/firebase'; + + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + const specificOpts = options.optionsToEndpoint(opts); + + const endpoint: ManifestEndpoint = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType: opts.eventType, + eventFilters: {}, + retry: false, + channel, + }, + }; + convertIfPresent(endpoint.eventTrigger, opts, 'eventFilters', 'filters'); + copyIfPresent(endpoint.eventTrigger, opts, 'retry'); + + func.__endpoint = endpoint; + + return func; +} diff --git a/src/v2/providers/https.ts b/src/v2/providers/https.ts new file mode 100644 index 000000000..0ab9c531c --- /dev/null +++ b/src/v2/providers/https.ts @@ -0,0 +1,380 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +/** + * Cloud functions to handle HTTPS request or callable RPCs. + * @packageDocumentation + */ + +import * as cors from 'cors'; +import * as express from 'express'; +import { convertIfPresent, convertInvoker } from '../../common/encoding'; + +import { isDebugFeatureEnabled } from '../../common/debug'; +import { + CallableRequest, + FunctionsErrorCode, + HttpsError, + onCallHandler, + Request, +} from '../../common/providers/https'; +import { ManifestEndpoint } from '../../runtime/manifest'; +import * as options from '../options'; +import { GlobalOptions, SupportedRegion } from '../options'; +import { Expression } from '../params'; + +export { Request, CallableRequest, FunctionsErrorCode, HttpsError }; + +/** + * Options that can be set on an individual HTTPS function. + */ +export interface HttpsOptions extends Omit { + /** HTTP functions can override global options and can specify multiple regions to deploy to. */ + region?: SupportedRegion | string | Array; + /** If true, allows CORS on requests to this function. + * If this is a `string` or `RegExp`, allows requests from domains that match the provided value. + * If this is an `Array`, allows requests from domains matching at least one entry of the array. + * Defaults to true for {@link https.CallableFunction} and false otherwise. + */ + cors?: string | boolean | RegExp | Array; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /** + * Invoker to set access control on https functions. + */ + invoker?: 'public' | 'private' | string | string[]; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * Handles HTTPS requests. + */ +export type HttpsFunction = (( + /** An Express request object representing the HTTPS call to the function. */ + req: Request, + /** An Express response object, for this function to respond to callers. */ + res: express.Response +) => void | Promise) & { + /** @alpha */ + __trigger?: unknown; + /** @alpha */ + __endpoint: ManifestEndpoint; +}; + +/** + * Creates a callable method for clients to call using a Firebase SDK. + */ +export interface CallableFunction extends HttpsFunction { + /** Executes the handler function with the provided data as input. Used for unit testing. + * @param data - An input for the handler function. + * @returns The output of the handler function. + */ + run(data: CallableRequest): Return; +} +/** + * Handles HTTPS requests. + * @param opts - Options to set on this function + * @param handler - A function that takes a {@link https.Request} and response object, same signature as an Express app. + * @returns A function that you can export and deploy. + */ +export function onRequest( + opts: HttpsOptions, + handler: ( + request: Request, + response: express.Response + ) => void | Promise +): HttpsFunction; +/** + * Handles HTTPS requests. + * @param handler - A function that takes a {@link https.Request} and response object, same signature as an Express app. + * @returns A function that you can export and deploy. + */ +export function onRequest( + handler: ( + request: Request, + response: express.Response + ) => void | Promise +): HttpsFunction; +export function onRequest( + optsOrHandler: + | HttpsOptions + | ((request: Request, response: express.Response) => void | Promise), + handler?: ( + request: Request, + response: express.Response + ) => void | Promise +): HttpsFunction { + let opts: HttpsOptions; + if (arguments.length === 1) { + opts = {}; + handler = optsOrHandler as ( + request: Request, + response: express.Response + ) => void | Promise; + } else { + opts = optsOrHandler as HttpsOptions; + } + + if (isDebugFeatureEnabled('enableCors') || 'cors' in opts) { + const origin = isDebugFeatureEnabled('enableCors') ? true : opts.cors; + const userProvidedHandler = handler; + handler = (req: Request, res: express.Response): void | Promise => { + return new Promise((resolve) => { + res.on('finish', resolve); + cors({ origin })(req, res, () => { + resolve(userProvidedHandler(req, res)); + }); + }); + }; + } + + Object.defineProperty(handler, '__trigger', { + get: () => { + const baseOpts = options.optionsToTriggerAnnotations( + options.getGlobalOptions() + ); + // global options calls region a scalar and https allows it to be an array, + // but optionsToTriggerAnnotations handles both cases. + const specificOpts = options.optionsToTriggerAnnotations( + opts as options.GlobalOptions + ); + const trigger: any = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + httpsTrigger: { + allowInsecure: false, + }, + }; + convertIfPresent( + trigger.httpsTrigger, + opts, + 'invoker', + 'invoker', + convertInvoker + ); + return trigger; + }, + }); + + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + // global options calls region a scalar and https allows it to be an array, + // but optionsToTriggerAnnotations handles both cases. + const specificOpts = options.optionsToEndpoint(opts as options.GlobalOptions); + const endpoint: Partial = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + httpsTrigger: {}, + }; + convertIfPresent( + endpoint.httpsTrigger, + opts, + 'invoker', + 'invoker', + convertInvoker + ); + (handler as HttpsFunction).__endpoint = endpoint; + + return handler as HttpsFunction; +} + +/** + * Declares a callable method for clients to call using a Firebase SDK. + * @param opts - Options to set on this function. + * @param handler - A function that takes a {@link https.CallableRequest}. + * @returns A function that you can export and deploy. + */ +export function onCall>( + opts: HttpsOptions, + handler: (request: CallableRequest) => Return +): CallableFunction; +/** + * Declares a callable method for clients to call using a Firebase SDK. + * @param handler - A function that takes a {@link https.CallableRequest}. + * @returns A function that you can export and deploy. + */ +export function onCall>( + handler: (request: CallableRequest) => Return +): CallableFunction; +export function onCall>( + optsOrHandler: HttpsOptions | ((request: CallableRequest) => Return), + handler?: (request: CallableRequest) => Return +): CallableFunction { + let opts: HttpsOptions; + if (arguments.length == 1) { + opts = {}; + handler = optsOrHandler as (request: CallableRequest) => Return; + } else { + opts = optsOrHandler as HttpsOptions; + } + + const origin = isDebugFeatureEnabled('enableCors') + ? true + : 'cors' in opts + ? opts.cors + : true; + + // onCallHandler sniffs the function length to determine which API to present. + // fix the length to prevent api versions from being mismatched. + const fixedLen = (req: CallableRequest) => handler(req); + const func: any = onCallHandler( + { cors: { origin, methods: 'POST' } }, + fixedLen + ); + + Object.defineProperty(func, '__trigger', { + get: () => { + const baseOpts = options.optionsToTriggerAnnotations( + options.getGlobalOptions() + ); + // global options calls region a scalar and https allows it to be an array, + // but optionsToTriggerAnnotations handles both cases. + const specificOpts = options.optionsToTriggerAnnotations(opts); + return { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + 'deployment-callable': 'true', + }, + httpsTrigger: { + allowInsecure: false, + }, + }; + }, + }); + + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + // global options calls region a scalar and https allows it to be an array, + // but optionsToEndpoint handles both cases. + const specificOpts = options.optionsToEndpoint(opts); + func.__endpoint = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + callableTrigger: {}, + }; + + func.run = handler; + return func; +} diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts new file mode 100644 index 000000000..ed823dd0f --- /dev/null +++ b/src/v2/providers/identity.ts @@ -0,0 +1,365 @@ +// 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. + +/** + * Cloud functions to handle events from Google Cloud Identity Platform. + * @packageDocumentation + */ + +import { BlockingFunction } from '../../cloud-functions'; +import { + AuthBlockingEvent, + AuthBlockingEventType, + AuthUserRecord, + BeforeCreateResponse, + BeforeSignInResponse, + HttpsError, + wrapHandler, +} from '../../common/providers/identity'; +import * as options from '../options'; +import { Expression } from '../params'; + +export { AuthUserRecord, AuthBlockingEvent, HttpsError }; + +/** @hidden Internally used when parsing the options. */ +interface InternalOptions { + opts: options.GlobalOptions; + idToken: boolean; + accessToken: boolean; + refreshToken: boolean; +} + +/** + * All function options plus idToken, accessToken, and refreshToken. + */ +export interface BlockingOptions { + /** Pass the ID Token credential to the function. */ + idToken?: boolean; + + /** Pass the Access Token credential to the function. */ + accessToken?: boolean; + + /** Pass the Refresh Token credential to the function. */ + refreshToken?: boolean; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; +} + +/** + * Handles an event that is triggered before a user is created. + * @param handler - Event handler which is run every time before a user is created + */ +export function beforeUserCreated( + handler: ( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | Promise + | void + | Promise +): BlockingFunction; + +/** + * Handles an event that is triggered before a user is created. + * @param opts - Object containing function options + * @param handler - Event handler which is run every time before a user is created + */ +export function beforeUserCreated( + opts: BlockingOptions, + handler: ( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | Promise + | void + | Promise +): BlockingFunction; + +/** + * Handles an event that is triggered before a user is created + * @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation) + * @param handler? - If defined, an event handler which is run every time before a user is created + */ +export function beforeUserCreated( + optsOrHandler: + | BlockingOptions + | (( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | Promise + | void + | Promise), + handler?: ( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | Promise + | void + | Promise +): BlockingFunction { + return beforeOperation('beforeCreate', optsOrHandler, handler); +} + +/** + * Handles an event that is triggered before a user is signed in. + * @param handler - Event handler which is run every time before a user is signed in + */ +export function beforeUserSignedIn( + handler: ( + event: AuthBlockingEvent + ) => + | BeforeSignInResponse + | Promise + | void + | Promise +): BlockingFunction; + +/** + * Handles an event that is triggered before a user is signed in. + * @param opts - Object containing function options + * @param handler - Event handler which is run every time before a user is signed in + */ +export function beforeUserSignedIn( + opts: BlockingOptions, + handler: ( + event: AuthBlockingEvent + ) => + | BeforeSignInResponse + | Promise + | void + | Promise +): BlockingFunction; + +/** + * Handles an event that is triggered before a user is signed in. + * @param optsOrHandler - Either an object containing function options, or an event handler (run before user signin) + * @param handler - Event handler which is run every time before a user is signed in + */ +export function beforeUserSignedIn( + optsOrHandler: + | BlockingOptions + | (( + event: AuthBlockingEvent + ) => + | BeforeSignInResponse + | Promise + | void + | Promise), + handler?: ( + event: AuthBlockingEvent + ) => + | BeforeSignInResponse + | Promise + | void + | Promise +): BlockingFunction { + return beforeOperation('beforeSignIn', optsOrHandler, handler); +} + +/** @hidden */ +export function beforeOperation( + eventType: AuthBlockingEventType, + optsOrHandler: + | BlockingOptions + | (( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | BeforeSignInResponse + | void + | Promise + | Promise + | Promise), + handler: ( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | BeforeSignInResponse + | void + | Promise + | Promise + | Promise +): BlockingFunction { + if (!handler || typeof optsOrHandler === 'function') { + handler = optsOrHandler as ( + event: AuthBlockingEvent + ) => + | BeforeCreateResponse + | BeforeSignInResponse + | void + | Promise + | Promise + | Promise; + optsOrHandler = {}; + } + + const { opts, accessToken, idToken, refreshToken } = getOpts( + optsOrHandler as BlockingOptions + ); + + // Create our own function that just calls the provided function so we know for sure that + // handler takes one argument. This is something common/providers/identity depends on. + const wrappedHandler = (event: AuthBlockingEvent) => handler(event); + const func: any = wrapHandler(eventType, wrappedHandler); + + const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`; + + /** Endpoint */ + const baseOptsEndpoint = options.optionsToEndpoint( + options.getGlobalOptions() + ); + const specificOptsEndpoint = options.optionsToEndpoint(opts); + func.__endpoint = { + platform: 'gcfv2', + ...baseOptsEndpoint, + ...specificOptsEndpoint, + labels: { + ...baseOptsEndpoint?.labels, + ...specificOptsEndpoint?.labels, + }, + blockingTrigger: { + eventType: legacyEventType, + options: { + accessToken, + idToken, + refreshToken, + }, + }, + }; + + func.__requiredAPIs = [ + { + api: 'identitytoolkit.googleapis.com', + reason: 'Needed for auth blocking functions', + }, + ]; + + func.run = handler; + + return func; +} + +/** @hidden */ +export function getOpts(blockingOptions: BlockingOptions): InternalOptions { + const accessToken = blockingOptions.accessToken || false; + const idToken = blockingOptions.idToken || false; + const refreshToken = blockingOptions.refreshToken || false; + const opts = { ...blockingOptions }; + delete (opts as any).accessToken; + delete (opts as any).idToken; + delete (opts as any).refreshToken; + return { + opts, + accessToken, + idToken, + refreshToken, + }; +} diff --git a/src/v2/providers/pubsub.ts b/src/v2/providers/pubsub.ts new file mode 100644 index 000000000..6f04f5cec --- /dev/null +++ b/src/v2/providers/pubsub.ts @@ -0,0 +1,351 @@ +// 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. + +/** + * Cloud functions to handle events from Google Cloud Pub/Sub. + * @packageDocumentation + */ + +import { copyIfPresent } from '../../common/encoding'; +import { ManifestEndpoint } from '../../runtime/manifest'; +import { CloudEvent, CloudFunction } from '../core'; +import * as options from '../options'; +import { Expression } from '../params'; + +/** + * Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it. + * You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub. + * + * This function triggers whenever a new pub/sub message is sent to a specific topic. + * You must specify the Pub/Sub topic name that you want to trigger your function, and set the event within the + * onPublish() event handler. + * + * PubSub Topic: + *
        + *
      • A resource that you can publish messages to and then consume those messages via subscriptions. + *
      • An isolated data stream for pub/sub messages. + *
      • Messages are published to a topic. + *
      • Messages are listened to via a subscription. + *
      • Each subscription listens to the messages published to exactly one topic. + * + * Subscriptions - Resource that listens to the messages published by exactly one topic. + * + * [More info here](https://firebase.google.com/docs/functions/pubsub-events) + */ + +/** + * Interface representing a Google Cloud Pub/Sub message. + * + * @param data - Payload of a Pub/Sub message. + * @typeParam T - Type representing `Message.data`'s JSON format + */ +export class Message { + /** + * Autogenerated ID that uniquely identifies this message. + */ + readonly messageId: string; + + /** + * Time the message was published + */ + readonly publishTime: string; + + /** + * The data payload of this message object as a base64-encoded string. + */ + readonly data: string; + + /** + * User-defined attributes published with the message, if any. + */ + readonly attributes: { [key: string]: string }; + + /** + * User-defined key used to ensure ordering amongst messages with the same key. + */ + readonly orderingKey: string; + + /** @hidden */ + private _json: T; + + /** + * @hidden + * @alpha + */ + constructor(data: any) { + this.messageId = data.messageId; + this.data = data.data; + this.attributes = data.attributes || {}; + this.orderingKey = data.orderingKey || ''; + this.publishTime = data.publishTime || new Date().toISOString(); + this._json = data.json; + } + + /** + * The JSON data payload of this message object, if any. + */ + get json(): T { + if (typeof this._json === 'undefined') { + try { + this._json = JSON.parse( + Buffer.from(this.data, 'base64').toString('utf8') + ); + } catch (err) { + throw new Error( + `Unable to parse Pub/Sub message data as JSON: ${err.message}` + ); + } + } + + return this._json; + } + + /** + * Returns a JSON-serializable representation of this object. + * + * @returns A JSON-serializable representation of this object. + */ + toJSON(): any { + const json: Record = { + messageId: this.messageId, + data: this.data, + publishTime: this.publishTime, + }; + if (Object.keys(this.attributes).length) { + json.attributes = this.attributes; + } + if (this.orderingKey) { + json.orderingKey = this.orderingKey; + } + return json; + } +} + +/** + * The interface published in a Pub/Sub publish subscription. + * @typeParam T - Type representing `Message.data`'s JSON format + */ +export interface MessagePublishedData { + /** Google Cloud Pub/Sub message. */ + readonly message: Message; + /** A subscription resource. */ + readonly subscription: string; +} + +/** PubSubOptions extend EventHandlerOptions but must include a topic. */ +export interface PubSubOptions extends options.EventHandlerOptions { + /** The Pub/Sub topic to watch for message events */ + topic: string; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * Handle a message being published to a Pub/Sub topic. + * @param topic - The Pub/Sub topic to watch for message events. + * @param handler - runs every time a Cloud Pub/Sub message is published + * @typeParam T - Type representing `Message.data`'s JSON format + */ +export function onMessagePublished( + topic: string, + handler: (event: CloudEvent>) => any | Promise +): CloudFunction>>; + +/** + * Handle a message being published to a Pub/Sub topic. + * @param options - Option containing information (topic) for event + * @param handler - runs every time a Cloud Pub/Sub message is published + * @typeParam T - Type representing `Message.data`'s JSON format + */ +export function onMessagePublished( + options: PubSubOptions, + handler: (event: CloudEvent>) => any | Promise +): CloudFunction>>; + +/** + * Handle a message being published to a Pub/Sub topic. + * @param topicOrOptions - A string representing the PubSub topic or an option (which contains the topic) + * @param handler - runs every time a Cloud Pub/Sub message is published + * @typeParam T - Type representing `Message.data`'s JSON format + */ +export function onMessagePublished( + topicOrOptions: string | PubSubOptions, + handler: (event: CloudEvent>) => any | Promise +): CloudFunction>> { + let topic: string; + let opts: options.EventHandlerOptions; + if (typeof topicOrOptions === 'string') { + topic = topicOrOptions; + opts = {}; + } else { + topic = topicOrOptions.topic; + opts = { ...topicOrOptions }; + delete (opts as any).topic; + } + + const func = (raw: CloudEvent) => { + const messagePublishedData = raw.data as { + message: unknown; + subscription: string; + }; + messagePublishedData.message = new Message(messagePublishedData.message); + return handler(raw as CloudEvent>); + }; + + func.run = handler; + + Object.defineProperty(func, '__trigger', { + get: () => { + const baseOpts = options.optionsToTriggerAnnotations( + options.getGlobalOptions() + ); + const specificOpts = options.optionsToTriggerAnnotations(opts); + + return { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType: 'google.cloud.pubsub.topic.v1.messagePublished', + resource: `projects/${process.env.GCLOUD_PROJECT}/topics/${topic}`, + }, + }; + }, + }); + + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + const specificOpts = options.optionsToEndpoint(opts); + + const endpoint: ManifestEndpoint = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType: 'google.cloud.pubsub.topic.v1.messagePublished', + eventFilters: { topic }, + retry: false, + }, + }; + copyIfPresent(endpoint.eventTrigger, opts, 'retry', 'retry'); + func.__endpoint = endpoint; + + return func; +} diff --git a/src/v2/providers/scheduler.ts b/src/v2/providers/scheduler.ts new file mode 100644 index 000000000..4c181ed11 --- /dev/null +++ b/src/v2/providers/scheduler.ts @@ -0,0 +1,210 @@ +// 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 * as express from 'express'; +import { copyIfPresent } from '../../common/encoding'; +import { timezone } from '../../common/timezone'; +import * as logger from '../../logger'; +import { ManifestEndpoint, ManifestRequiredAPI } from '../../runtime/manifest'; +import * as options from '../options'; +import { HttpsFunction } from './https'; + +/** @hidden */ +interface ScheduleArgs { + schedule: string; + timeZone?: timezone; + retryCount?: number; + maxRetrySeconds?: number; + minBackoffSeconds?: number; + maxBackoffSeconds?: number; + maxDoublings?: number; + opts: options.GlobalOptions; +} + +/** @internal */ +export function getOpts(args: string | ScheduleOptions): ScheduleArgs { + if (typeof args === 'string') { + return { + schedule: args, + opts: {} as options.GlobalOptions, + }; + } + return { + schedule: args.schedule, + timeZone: args.timeZone, + retryCount: args.retryCount, + maxRetrySeconds: args.maxRetrySeconds, + minBackoffSeconds: args.minBackoffSeconds, + maxBackoffSeconds: args.maxBackoffSeconds, + maxDoublings: args.maxDoublings, + opts: args as options.GlobalOptions, + }; +} + +/** + * Interface representing a ScheduleEvent that is passed to the function handler. + */ +export interface ScheduledEvent { + /** + * The Cloud Scheduler job name. + * Populated via the X-CloudScheduler-JobName header. + * + * If invoked manually, this field is undefined. + */ + jobName?: string; + + /** + * For Cloud Scheduler jobs specified in the unix-cron format, + * this is the job schedule time in RFC3339 UTC "Zulu" format. + * Populated via the X-CloudScheduler-ScheduleTime header. + * + * If the schedule is manually triggered, this field will be + * the function execution time. + */ + scheduleTime: string; +} + +/** The Cloud Function type for Schedule triggers. */ +export interface ScheduleFunction extends HttpsFunction { + __requiredAPIs?: ManifestRequiredAPI[]; + run(data: ScheduledEvent): void | Promise; +} + +/** Options that can be set on a Schedule trigger. */ +export interface ScheduleOptions extends options.GlobalOptions { + /** The schedule, in Unix Crontab or AppEngine syntax. */ + schedule: string; + + /** The timezone that the schedule executes in. */ + timeZone?: timezone; + + /** The number of retry attempts for a failed run. */ + retryCount?: number; + + /** The time limit for retrying. */ + maxRetrySeconds?: number; + + /** The minimum time to wait before retying. */ + minBackoffSeconds?: number; + + /** The maximum time to wait before retrying. */ + maxBackoffSeconds?: number; + + /** The time between will double max doublings times. */ + maxDoublings?: number; +} + +/** + * Handler for scheduled functions. Triggered whenever the associated + * scheduler job sends a http request. + * @param schedule - The schedule, in Unix Crontab or AppEngine syntax. + * @param handler - A function to execute when triggered. + * @returns A function that you can export and deploy. + */ +export function onSchedule( + schedule: string, + handler: (req: ScheduledEvent) => void | Promise +): ScheduleFunction; + +/** + * Handler for scheduled functions. Triggered whenever the associated + * scheduler job sends a http request. + * @param options - Options to set on scheduled functions. + * @param handler - A function to execute when triggered. + * @returns A function that you can export and deploy. + */ +export function onSchedule( + options: ScheduleOptions, + handler: (req: ScheduledEvent) => void | Promise +): ScheduleFunction; + +/** + * Handler for scheduled functions. Triggered whenever the associated + * scheduler job sends a http request. + * @param args - Either a schedule or an object containing function options. + * @param handler - A function to execute when triggered. + * @returns A function that you can export and deploy. + */ +export function onSchedule( + args: string | ScheduleOptions, + handler: (req: ScheduledEvent) => void | Promise +): ScheduleFunction { + const separatedOpts = getOpts(args); + + const func: any = async ( + req: express.Request, + res: express.Response + ): Promise => { + const event: ScheduledEvent = { + jobName: req.header('X-CloudScheduler-JobName') || undefined, + scheduleTime: + req.header('X-CloudScheduler-ScheduleTime') || new Date().toISOString(), + }; + try { + await handler(event); + res.status(200).send(); + } catch (err) { + logger.error((err as Error).message); + res.status(500).send(); + } + }; + func.run = handler; + + const baseOptsEndpoint = options.optionsToEndpoint( + options.getGlobalOptions() + ); + const specificOptsEndpoint = options.optionsToEndpoint(separatedOpts.opts); + + const ep: ManifestEndpoint = { + platform: 'gcfv2', + ...baseOptsEndpoint, + ...specificOptsEndpoint, + labels: { + ...baseOptsEndpoint?.labels, + ...specificOptsEndpoint?.labels, + }, + scheduleTrigger: { + schedule: separatedOpts.schedule, + retryConfig: {}, + }, + }; + copyIfPresent(ep.scheduleTrigger, separatedOpts, 'timeZone'); + copyIfPresent( + ep.scheduleTrigger.retryConfig, + separatedOpts, + 'retryCount', + 'maxRetrySeconds', + 'minBackoffSeconds', + 'maxBackoffSeconds', + 'maxDoublings' + ); + func.__endpoint = ep; + + func.__requiredAPIs = [ + { + api: 'cloudscheduler.googleapis.com', + reason: 'Needed for scheduled functions.', + }, + ]; + + return func; +} diff --git a/src/v2/providers/storage.ts b/src/v2/providers/storage.ts new file mode 100644 index 000000000..fd8a2131e --- /dev/null +++ b/src/v2/providers/storage.ts @@ -0,0 +1,656 @@ +// 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. + +/** + * Cloud functions to handle events from Google Cloud Storage. + * @packageDocumentation + */ + +import { copyIfPresent } from '../../common/encoding'; +import { firebaseConfig } from '../../config'; +import { ManifestEndpoint } from '../../runtime/manifest'; +import { CloudEvent, CloudFunction } from '../core'; +import * as options from '../options'; +import { Expression } from '../params'; + +/** + * An object within Google Cloud Storage. + * Ref: https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts + */ +export interface StorageObjectData { + /** + * The name of the bucket containing this object. + */ + bucket?: string; + /** + * Cache-Control directive for the object data, matching + * [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2]. + */ + cacheControl?: string; + /** + * Number of underlying components that make up this object. Components are + * accumulated by compose operations. + * Attempting to set this field will result in an error. + */ + componentCount?: number; + /** + * Content-Disposition of the object data, matching + * [https://tools.ietf.org/html/rfc6266][RFC 6266]. + */ + contentDisposition?: string; + /** + * Content-Encoding of the object data, matching + * [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2] + */ + contentEncoding?: string; + /** + * Content-Language of the object data, matching + * [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2]. + */ + contentLanguage?: string; + /** + * Content-Type of the object data, matching + * [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5]. + * If an object is stored without a Content-Type, it is served as + * `application/octet-stream`. + */ + contentType?: string; + /** + * CRC32c checksum. For more information about using the CRC32c + * checksum, see + * [https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI][Hashes and + * ETags: Best Practices]. + */ + crc32c?: string; + /** + * Metadata of customer-supplied encryption key, if the object is encrypted by + * such a key. + */ + customerEncryption?: CustomerEncryption; + /** + * HTTP 1.1 Entity tag for the object. See + * [https://tools.ietf.org/html/rfc7232#section-2.3][RFC 7232 §2.3]. + */ + etag?: string; + /** + * The content generation of this object. Used for object versioning. + * Attempting to set this field will result in an error. + */ + generation?: number; + /** + * The ID of the object, including the bucket name, object name, and + * generation number. + */ + id?: string; + /** + * The kind of item this is. For objects, this is always "storage#object". + */ + kind?: string; + /** + * MD5 hash of the data; encoded using base64 as per + * [https://tools.ietf.org/html/rfc4648#section-4][RFC 4648 §4]. For more + * information about using the MD5 hash, see + * [https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI][Hashes and + * ETags: Best Practices]. + */ + md5Hash?: string; + /** + * Media download link. + */ + mediaLink?: string; + /** + * User-provided metadata, in key/value pairs. + */ + metadata?: { [key: string]: string }; + /** + * The version of the metadata for this object at this generation. Used for + * preconditions and for detecting changes in metadata. A metageneration + * number is only meaningful in the context of a particular generation of a + * particular object. + */ + metageneration?: number; + /** + * The name of the object. + */ + name?: string; + /** + * The link to this object. + */ + selfLink?: string; + /** + * Content-Length of the object data in bytes, matching + * [https://tools.ietf.org/html/rfc7230#section-3.3.2][RFC 7230 §3.3.2]. + */ + size?: number; + /** + * Storage class of the object. + */ + storageClass?: string; + /** + * The creation time of the object. + * Attempting to set this field will result in an error. + */ + timeCreated?: Date | string; + /** + * The deletion time of the object. Will be returned if and only if this + * version of the object has been deleted. + */ + timeDeleted?: Date | string; + /** + * The time at which the object's storage class was last changed. + */ + timeStorageClassUpdated?: Date | string; + /** + * The modification time of the object metadata. + */ + updated?: Date | string; +} + +/** + * Metadata of customer-supplied encryption key, if the object is encrypted by + * such a key. + */ +export interface CustomerEncryption { + /** + * The encryption algorithm. + */ + encryptionAlgorithm?: string; + /** + * SHA256 hash value of the encryption key. + */ + keySha256?: string; +} + +/** A CloudEvent that contains StorageObjectData */ +export interface StorageEvent extends CloudEvent { + /** The name of the bucket containing this object. */ + bucket: string; +} + +/** @internal */ +export const archivedEvent = 'google.cloud.storage.object.v1.archived'; +/** @internal */ +export const finalizedEvent = 'google.cloud.storage.object.v1.finalized'; +/** @internal */ +export const deletedEvent = 'google.cloud.storage.object.v1.deleted'; +/** @internal */ +export const metadataUpdatedEvent = + 'google.cloud.storage.object.v1.metadataUpdated'; + +/** StorageOptions extend EventHandlerOptions with a bucket name */ +export interface StorageOptions extends options.EventHandlerOptions { + /** The name of the bucket containing this object. */ + bucket?: string; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * Event handler sent only when a bucket has enabled object versioning. + * This event indicates that the live version of an object has become an + * archived version, either because it was archived or because it was + * overwritten by the upload of an object of the same name. + * + * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs. + */ +export function onObjectArchived( + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler sent only when a bucket has enabled object versioning. + * This event indicates that the live version of an object has become an + * archived version, either because it was archived or because it was + * overwritten by the upload of an object of the same name. + * + * @param bucket - The name of the bucket containing this object. + * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs. + */ +export function onObjectArchived( + bucket: string, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler sent only when a bucket has enabled object versioning. + * This event indicates that the live version of an object has become an + * archived version, either because it was archived or because it was + * overwritten by the upload of an object of the same name. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs. + */ +export function onObjectArchived( + opts: StorageOptions, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler sent only when a bucket has enabled object versioning. + * This event indicates that the live version of an object has become an + * archived version, either because it was archived or because it was + * overwritten by the upload of an object of the same name. + * + * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used. + * @param handler - Event handler which is run every time a Google Cloud Storage archival occurs. + */ +export function onObjectArchived( + bucketOrOptsOrHandler: + | string + | StorageOptions + | ((event: StorageEvent) => any | Promise), + handler?: (event: StorageEvent) => any | Promise +): CloudFunction { + return onOperation(archivedEvent, bucketOrOptsOrHandler, handler); +} + +/** + * Event handler which fires every time a Google Cloud Storage object + * creation occurs. + * + * Sent when a new object (or a new generation of an existing object) + * is successfully created in the bucket. This includes copying or rewriting + * an existing object. A failed upload does not trigger this event. + * + * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs. + */ +export function onObjectFinalized( + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time a Google Cloud Storage object + * creation occurs. + * + * Sent when a new object (or a new generation of an existing object) + * is successfully created in the bucket. This includes copying or rewriting + * an existing object. A failed upload does not trigger this event. + * + * @param bucket - The name of the bucket containing this object. + * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs. + */ +export function onObjectFinalized( + bucket: string, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time a Google Cloud Storage object + * creation occurs. + * + * Sent when a new object (or a new generation of an existing object) + * is successfully created in the bucket. This includes copying or rewriting + * an existing object. A failed upload does not trigger this event. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs. + */ +export function onObjectFinalized( + opts: StorageOptions, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time a Google Cloud Storage object + * creation occurs. + * + * Sent when a new object (or a new generation of an existing object) + * is successfully created in the bucket. This includes copying or rewriting + * an existing object. A failed upload does not trigger this event. + * + * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used. + * @param handler - Event handler which is run every time a Google Cloud Storage object creation occurs. + */ +export function onObjectFinalized( + bucketOrOptsOrHandler: + | string + | StorageOptions + | ((event: StorageEvent) => any | Promise), + handler?: (event: StorageEvent) => any | Promise +): CloudFunction { + return onOperation(finalizedEvent, bucketOrOptsOrHandler, handler); +} + +/** + * Event handler which fires every time a Google Cloud Storage deletion occurs. + * + * Sent when an object has been permanently deleted. This includes objects + * that are overwritten or are deleted as part of the bucket's lifecycle + * configuration. For buckets with object versioning enabled, this is not + * sent when an object is archived, even if archival occurs + * via the `storage.objects.delete` method. + * + * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs. + */ +export function onObjectDeleted( + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time a Google Cloud Storage deletion occurs. + * + * Sent when an object has been permanently deleted. This includes objects + * that are overwritten or are deleted as part of the bucket's lifecycle + * configuration. For buckets with object versioning enabled, this is not + * sent when an object is archived, even if archival occurs + * via the `storage.objects.delete` method. + * + * @param bucket - The name of the bucket containing this object. + * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs. + */ +export function onObjectDeleted( + bucket: string, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time a Google Cloud Storage deletion occurs. + * + * Sent when an object has been permanently deleted. This includes objects + * that are overwritten or are deleted as part of the bucket's lifecycle + * configuration. For buckets with object versioning enabled, this is not + * sent when an object is archived, even if archival occurs + * via the `storage.objects.delete` method. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs. + */ +export function onObjectDeleted( + opts: StorageOptions, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time a Google Cloud Storage deletion occurs. + * + * Sent when an object has been permanently deleted. This includes objects + * that are overwritten or are deleted as part of the bucket's lifecycle + * configuration. For buckets with object versioning enabled, this is not + * sent when an object is archived, even if archival occurs + * via the `storage.objects.delete` method. + * + * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used. + * @param handler - Event handler which is run every time a Google Cloud Storage object deletion occurs. + */ +export function onObjectDeleted( + bucketOrOptsOrHandler: + | string + | StorageOptions + | ((event: StorageEvent) => any | Promise), + handler?: (event: StorageEvent) => any | Promise +): CloudFunction { + return onOperation(deletedEvent, bucketOrOptsOrHandler, handler); +} + +/** + * Event handler which fires every time the metadata of an existing object + * changes. + * + * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used. + * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs. + */ +export function onObjectMetadataUpdated( + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time the metadata of an existing object + * changes. + * + * @param bucket - The name of the bucket containing this object. + * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs. + */ +export function onObjectMetadataUpdated( + bucket: string, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time the metadata of an existing object + * changes. + * + * @param opts - Options that can be set on an individual event-handling function. + * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs. + */ +export function onObjectMetadataUpdated( + opts: StorageOptions, + handler: (event: StorageEvent) => any | Promise +): CloudFunction; + +/** + * Event handler which fires every time the metadata of an existing object + * changes. + * + * @param bucketOrOptsOrHandler - Options or string that may (or may not) define the bucket to be used. + * @param handler - Event handler which is run every time a Google Cloud Storage object metadata update occurs. + */ +export function onObjectMetadataUpdated( + bucketOrOptsOrHandler: + | string + | StorageOptions + | ((event: StorageEvent) => any | Promise), + handler?: (event: StorageEvent) => any | Promise +): CloudFunction { + return onOperation(metadataUpdatedEvent, bucketOrOptsOrHandler, handler); +} + +/** @internal */ +export function onOperation( + eventType: string, + bucketOrOptsOrHandler: + | string + | StorageOptions + | ((event: StorageEvent) => any | Promise), + handler: (event: StorageEvent) => any | Promise +): CloudFunction { + if (typeof bucketOrOptsOrHandler === 'function') { + handler = bucketOrOptsOrHandler as ( + event: StorageEvent + ) => any | Promise; + bucketOrOptsOrHandler = {}; + } + + const [opts, bucket] = getOptsAndBucket( + bucketOrOptsOrHandler as string | StorageOptions + ); + + const func = (raw: CloudEvent) => { + return handler(raw as StorageEvent); + }; + + func.run = handler; + + Object.defineProperty(func, '__trigger', { + get: () => { + const baseOpts = options.optionsToTriggerAnnotations( + options.getGlobalOptions() + ); + const specificOpts = options.optionsToTriggerAnnotations(opts); + + return { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType, + resource: bucket, // TODO(colerogers): replace with 'bucket,' eventually + }, + }; + }, + }); + + // TypeScript doesn't recognize defineProperty as adding a property and complains + // that __endpoint doesn't exist. We can either cast to any and lose all type safety + // or we can just assign a meaningless value before calling defineProperty. + func.__endpoint = {} as ManifestEndpoint; + + // SDK may attempt to read FIREBASE_CONFIG env var to fetch the default bucket name. + // To prevent runtime errors when FIREBASE_CONFIG env var is missing, we use getters. + Object.defineProperty(func, '__endpoint', { + get: () => { + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + const specificOpts = options.optionsToEndpoint(opts); + + const endpoint: ManifestEndpoint = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + eventTrigger: { + eventType, + eventFilters: { bucket }, + retry: false, + }, + }; + copyIfPresent(endpoint.eventTrigger, opts, 'retry', 'retry'); + return endpoint; + }, + }); + + return func; +} + +/** @internal */ +export function getOptsAndBucket( + bucketOrOpts: string | StorageOptions +): [options.EventHandlerOptions, string] { + let bucket: string; + let opts: options.EventHandlerOptions; + if (typeof bucketOrOpts === 'string') { + bucket = bucketOrOpts; + opts = {}; + } else { + bucket = bucketOrOpts.bucket || firebaseConfig()?.storageBucket; + opts = { ...bucketOrOpts }; + delete (opts as any).bucket; + } + + if (!bucket) { + throw new Error( + 'Missing bucket name. If you are unit testing, please provide a bucket name' + + ' by providing bucket name directly in the event handler or by setting process.env.FIREBASE_CONFIG.' + ); + } + if (!/^[a-z\d][a-z\d\\._-]{1,230}[a-z\d]$/.test(bucket)) { + throw new Error(`Invalid bucket name ${bucket}`); + } + + return [opts, bucket]; +} diff --git a/src/v2/providers/tasks.ts b/src/v2/providers/tasks.ts new file mode 100644 index 000000000..efc99e273 --- /dev/null +++ b/src/v2/providers/tasks.ts @@ -0,0 +1,275 @@ +// 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. + +/** + * Cloud functions to handle Tasks enqueued with Google Cloud Tasks. + * @packageDocumentation + */ + +import { + convertIfPresent, + convertInvoker, + copyIfPresent, +} from '../../common/encoding'; +import { + AuthData, + onDispatchHandler, + RateLimits, + Request, + RetryConfig, +} from '../../common/providers/tasks'; +import * as options from '../options'; +import { Expression } from '../params'; +import { HttpsFunction } from './https'; + +export { AuthData, Request }; + +export interface TaskQueueOptions extends options.EventHandlerOptions { + /** How a task should be retried in the event of a non-2xx return. */ + retryConfig?: RetryConfig; + + /** How congestion control should be applied to the function. */ + rateLimits?: RateLimits; + + /** + * Who can enqueue tasks for this function. + * If left unspecified, only service accounts which have + * `roles/cloudtasks.enqueuer` and `roles/cloudfunctions.invoker` + * will have permissions. + */ + invoker?: 'private' | string | string[]; + + /** + * Region where functions should be deployed. + */ + region?: options.SupportedRegion | string; + + /** + * Amount of memory to allocate to a function. + * A value of null restores the defaults of 256MB. + */ + memory?: options.MemoryOption | Expression | null; + + /** + * Timeout for the function in sections, possible values are 0 to 540. + * HTTPS functions can specify a higher timeout. + * A value of null restores the default of 60s + * The minimum timeout for a gen 2 function is 1s. The maximum timeout for a + * function depends on the type of function: Event handling functions have a + * maximum timeout of 540s (9 minutes). HTTPS and callable functions have a + * maximum timeout of 36,00s (1 hour). Task queue functions have a maximum + * timeout of 1,800s (30 minutes) + */ + timeoutSeconds?: number | Expression | null; + + /** + * Min number of actual instances to be running at a given time. + * Instances will be billed for memory allocation and 10% of CPU allocation + * while idle. + * A value of null restores the default min instances. + */ + minInstances?: number | Expression | null; + + /** + * Max number of instances to be running in parallel. + * A value of null restores the default max instances. + */ + maxInstances?: number | Expression | null; + + /** + * Number of requests a function can serve at once. + * Can only be applied to functions running on Cloud Functions v2. + * A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). + * Concurrency cannot be set to any value other than 1 if `cpu` is less than 1. + * The maximum value for concurrency is 1,000. + */ + concurrency?: number | Expression | null; + + /** + * Fractional number of CPUs to allocate to a function. + * Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. + * This is different from the defaults when using the gcloud utility and is different from + * the fixed amount assigned in Google Cloud Functions generation 1. + * To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this + * to the value "gcf_gen1" + */ + cpu?: number | 'gcf_gen1'; + + /** + * Connect cloud function to specified VPC connector. + * A value of null removes the VPC connector + */ + vpcConnector?: string | null; + + /** + * Egress settings for VPC connector. + * A value of null turns off VPC connector egress settings + */ + vpcConnectorEgressSettings?: options.VpcEgressSetting | null; + + /** + * Specific service account for the function to run as. + * A value of null restores the default service account. + */ + serviceAccount?: string | null; + + /** + * Ingress settings which control where this function can be called from. + * A value of null turns off ingress settings. + */ + ingressSettings?: options.IngressSetting | null; + + /** + * User labels to set on the function. + */ + labels?: Record; + + /* + * Secrets to bind to a function. + */ + secrets?: string[]; + + /** Whether failed executions should be delivered again. */ + retry?: boolean; +} + +/** + * A handler for tasks. + * @typeParam T - The task data interface. Task data is unmarshaled from JSON. + */ +export interface TaskQueueFunction extends HttpsFunction { + /** + * The callback passed to the `TaskQueueFunction` constructor. + * @param request - A TaskRequest containing data and auth information. + * @returns Any return value. Google Cloud Functions will await any promise + * before shutting down your function. Resolved return values + * are only used for unit testing purposes. + */ + run(request: Request): void | Promise; +} + +/** + * Creates a handler for tasks sent to a Google Cloud Tasks queue. + * @param handler - A callback to handle task requests. + * @typeParam Args - The interface for the request's `data` field. + * @returns A Cloud Function you can export and deploy. + */ +export function onTaskDispatched( + handler: (request: Request) => void | Promise +): TaskQueueFunction; + +/** + * Creates a handler for tasks sent to a Google Cloud Tasks queue. + * @param options - Configuration for the task queue or Cloud Function. + * @param handler - A callback to handle task requests. + * @typeParam Args - The interface for the request's `data` field. + * @returns A Cloud Function you can export and deploy. + */ +export function onTaskDispatched( + options: TaskQueueOptions, + handler: (request: Request) => void | Promise +): TaskQueueFunction; +export function onTaskDispatched( + optsOrHandler: + | TaskQueueOptions + | ((request: Request) => void | Promise), + handler?: (request: Request) => void | Promise +): TaskQueueFunction { + let opts: TaskQueueOptions; + if (arguments.length == 1) { + opts = {}; + handler = optsOrHandler as (request: Request) => void | Promise; + } else { + opts = optsOrHandler as TaskQueueOptions; + } + + // onDispatchHandler sniffs the function length to determine which API to present. + // fix the length to prevent api versions from being mismatched. + const fixedLen = (req: Request) => handler(req); + const func: any = onDispatchHandler(fixedLen); + + Object.defineProperty(func, '__trigger', { + get: () => { + const baseOpts = options.optionsToTriggerAnnotations( + options.getGlobalOptions() + ); + // global options calls region a scalar and https allows it to be an array, + // but optionsToTriggerAnnotations handles both cases. + const specificOpts = options.optionsToTriggerAnnotations( + opts as options.GlobalOptions + ); + const taskQueueTrigger: Record = {}; + copyIfPresent(taskQueueTrigger, opts, 'retryConfig', 'rateLimits'); + convertIfPresent( + taskQueueTrigger, + opts, + 'invoker', + 'invoker', + convertInvoker + ); + return { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + taskQueueTrigger, + }; + }, + }); + + const baseOpts = options.optionsToEndpoint(options.getGlobalOptions()); + // global options calls region a scalar and https allows it to be an array, + // but optionsToManifestEndpoint handles both cases. + const specificOpts = options.optionsToEndpoint(opts as options.GlobalOptions); + func.__endpoint = { + platform: 'gcfv2', + ...baseOpts, + ...specificOpts, + labels: { + ...baseOpts?.labels, + ...specificOpts?.labels, + }, + taskQueueTrigger: {}, + }; + copyIfPresent(func.__endpoint.taskQueueTrigger, opts, 'retryConfig'); + copyIfPresent(func.__endpoint.taskQueueTrigger, opts, 'rateLimits'); + convertIfPresent( + func.__endpoint.taskQueueTrigger, + opts, + 'invoker', + 'invoker', + convertInvoker + ); + + func.__requiredAPIs = [ + { + api: 'cloudtasks.googleapis.com', + reason: 'Needed for task queue functions', + }, + ]; + + func.run = handler; + return func; +} diff --git a/tsconfig.release.json b/tsconfig.release.json index e93d5d4b6..b98955ee5 100644 --- a/tsconfig.release.json +++ b/tsconfig.release.json @@ -1,14 +1,21 @@ { "compilerOptions": { "declaration": true, - "lib": ["es2017"], + "lib": ["es2018"], "module": "commonjs", "noImplicitAny": false, "noUnusedLocals": true, "outDir": "lib", "stripInternal": true, - "target": "es2017", + "target": "es2018", "typeRoots": ["./node_modules/@types"] }, - "files": ["./src/index.ts"] + "files": [ + "./src/types/global.d.ts", + "./src/index.ts", + "./src/logger/index.ts", + "./src/logger/compat.ts", + "./src/v2/index.ts", + "./src/bin/firebase-functions.ts" + ] } diff --git a/v1/analytics.js b/v1/analytics.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/analytics.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/auth.js b/v1/auth.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/auth.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/database.js b/v1/database.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/database.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/firestore.js b/v1/firestore.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/firestore.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/index.js b/v1/index.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/index.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/pubsub.js b/v1/pubsub.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/pubsub.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/remoteConfig.js b/v1/remoteConfig.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/remoteConfig.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/storage.js b/v1/storage.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/storage.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/tasks.js b/v1/tasks.js new file mode 100644 index 000000000..ae33ba821 --- /dev/null +++ b/v1/tasks.js @@ -0,0 +1,26 @@ +// 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v1/testLab.js b/v1/testLab.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v1/testLab.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/alerts/appDistribution.js b/v2/alerts/appDistribution.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/alerts/appDistribution.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/alerts/billing.js b/v2/alerts/billing.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/alerts/billing.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/alerts/crashlytics.js b/v2/alerts/crashlytics.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/alerts/crashlytics.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/alerts/index.js b/v2/alerts/index.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/alerts/index.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/alerts/performance.js b/v2/alerts/performance.js new file mode 100644 index 000000000..ae33ba821 --- /dev/null +++ b/v2/alerts/performance.js @@ -0,0 +1,26 @@ +// 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/core.js b/v2/core.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/core.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/database.js b/v2/database.js new file mode 100644 index 000000000..c822b56f1 --- /dev/null +++ b/v2/database.js @@ -0,0 +1,26 @@ +// 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 \ No newline at end of file diff --git a/v2/eventarc.js b/v2/eventarc.js new file mode 100644 index 000000000..ae33ba821 --- /dev/null +++ b/v2/eventarc.js @@ -0,0 +1,26 @@ +// 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/https.js b/v2/https.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/https.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/identity.js b/v2/identity.js new file mode 100644 index 000000000..ac9a09d74 --- /dev/null +++ b/v2/identity.js @@ -0,0 +1,21 @@ +// 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. diff --git a/v2/index.js b/v2/index.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/index.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/options.js b/v2/options.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/options.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/params.js b/v2/params.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/params.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/pubsub.js b/v2/pubsub.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/pubsub.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/scheduler.js b/v2/scheduler.js new file mode 100644 index 000000000..ae33ba821 --- /dev/null +++ b/v2/scheduler.js @@ -0,0 +1,26 @@ +// 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/storage.js b/v2/storage.js new file mode 100644 index 000000000..7d725acc3 --- /dev/null +++ b/v2/storage.js @@ -0,0 +1,26 @@ +// The MIT License (MIT) +// +// Copyright (c) 2021 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810 diff --git a/v2/tasks.js b/v2/tasks.js new file mode 100644 index 000000000..ae33ba821 --- /dev/null +++ b/v2/tasks.js @@ -0,0 +1,26 @@ +// 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. + +// This file is not part of the firebase-functions SDK. It is used to silence the +// imports eslint plugin until it can understand import paths defined by node +// package exports. +// For more information, see github.com/import-js/eslint-plugin-import/issues/1810