firebase-functions 3.15.5 → 3.17.0

package/lib/bin/firebase-functions.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/bin/firebase-functions.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const express = require("express");
+const loader_1 = require("../runtime/loader");
+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, res) {
+    res.send('ok');
+    server.close(() => console.log('shutdown requested via /__/quitquitquit'));
+}
+app.get('/__/quitquitquit', handleQuitquitquit);
+app.post('/__/quitquitquit', handleQuitquitquit);
+app.get('/__/stack.yaml', async (req, res) => {
+    try {
+        const stack = await (0, loader_1.loadStack)(functionsDir);
+        res.setHeader('content-type', 'text/yaml');
+        res.send(JSON.stringify(stack));
+    }
+    catch (e) {
+        res
+            .status(400)
+            .send(`Failed to generate manifest from function source: ${e}`);
+    }
+});
+let port = 8080;
+if (process.env.STACK_CONTROL_API_PORT) {
+    port = Number.parseInt(process.env.STACK_CONTROL_API_PORT);
+}
+console.log('Serving at port', port);
+server = app.listen(port);

package/lib/cloud-functions.d.ts

@@ -2,6 +2,7 @@ import { Request, Response } from 'express';
 import { DeploymentOptions, FailurePolicy, Schedule } from './function-configuration';
 export { Request, Response };
 import { Duration } from './common/encoding';
+import { ManifestEndpoint, ManifestRequiredAPI } from './common/manifest';
 /**
  * @hidden
  *
@@ -200,6 +201,14 @@ export interface TriggerAnnotated {
         ingressSettings?: string;
     };
 }
+/**
+ * @hidden
+ * EndpointAnnotated is used to generate the manifest that conforms to the container contract.
+ */
+export interface EndpointAnnotated {
+    __endpoint: ManifestEndpoint;
+    __requiredAPIs?: ManifestRequiredAPI[];
+}
 /**
  * A Runnable has a `run` method which directly invokes the user-defined
  * function - useful for unit testing.
@@ -216,7 +225,7 @@ export interface Runnable<T> {
  * [`Response`](https://expressjs.com/en/api.html#res) objects as its only
  * arguments.
  */
-export declare type HttpsFunction = TriggerAnnotated & ((req: Request, resp: Response) => void | Promise<void>);
+export declare type HttpsFunction = TriggerAnnotated & EndpointAnnotated & ((req: Request, resp: Response) => void | Promise<void>);
 /**
  * The Cloud Function type for all non-HTTPS triggers. This should be exported
  * from your JavaScript file to define a Cloud Function.
@@ -224,7 +233,7 @@ export declare type HttpsFunction = TriggerAnnotated & ((req: Request, resp: Res
  * This type is a special JavaScript function which takes a templated
  * `Event` object as its only argument.
  */
-export declare type CloudFunction<T> = Runnable<T> & TriggerAnnotated & ((input: any, context?: any) => PromiseLike<any> | any);
+export declare type CloudFunction<T> = Runnable<T> & TriggerAnnotated & EndpointAnnotated & ((input: any, context?: any) => PromiseLike<any> | any);
 /** @hidden */
 export interface MakeCloudFunctionArgs<EventData> {
     after?: (raw: Event) => void;
@@ -233,13 +242,9 @@ export interface MakeCloudFunctionArgs<EventData> {
     dataConstructor?: (raw: Event) => EventData;
     eventType: string;
     handler?: (data: EventData, context: EventContext) => PromiseLike<any> | any;
-    labels?: {
-        [key: string]: any;
-    };
+    labels?: Record<string, string>;
     legacyEventType?: string;
-    options?: {
-        [key: string]: any;
-    };
+    options?: DeploymentOptions;
     provider: string;
     service: string;
     triggerResource: () => string;
@@ -248,3 +253,4 @@ export interface MakeCloudFunctionArgs<EventData> {
 export declare function makeCloudFunction<EventData>({ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }: MakeCloudFunctionArgs<EventData>): CloudFunction<EventData>;
 /** @hidden */
 export declare function optionsToTrigger(options: DeploymentOptions): any;
+export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

package/lib/cloud-functions.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionsToTrigger = exports.makeCloudFunction = exports.Change = void 0;
+exports.optionsToEndpoint = exports.optionsToTrigger = exports.makeCloudFunction = exports.Change = void 0;
 const _ = require("lodash");
 const function_configuration_1 = require("./function-configuration");
 const logger_1 = require("./logger");
@@ -165,6 +165,42 @@ function makeCloudFunction({ after = () => { }, before = () => { }, contextOnlyH
             return trigger;
         },
     });
+    Object.defineProperty(cloudFunction, '__endpoint', {
+        get: () => {
+            if (triggerResource() == null) {
+                return undefined;
+            }
+            const endpoint = {
+                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;
 }
@@ -245,3 +281,27 @@ function optionsToTrigger(options) {
     return trigger;
 }
 exports.optionsToTrigger = optionsToTrigger;
+function optionsToEndpoint(options) {
+    const endpoint = {};
+    (0, encoding_1.copyIfPresent)(endpoint, options, 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'timeoutSeconds');
+    (0, encoding_1.convertIfPresent)(endpoint, options, 'region', 'regions');
+    (0, encoding_1.convertIfPresent)(endpoint, options, 'serviceAccountEmail', 'serviceAccount', (sa) => sa);
+    if (options === null || options === void 0 ? void 0 : options.vpcConnector) {
+        endpoint.vpc = { connector: options.vpcConnector };
+        (0, encoding_1.convertIfPresent)(endpoint.vpc, options, 'egressSettings', 'vpcConnectorEgressSettings');
+    }
+    (0, encoding_1.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;
+}
+exports.optionsToEndpoint = optionsToEndpoint;

package/lib/common/debug.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/common/debug.js

@@ -0,0 +1,54 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDebugFeatureEnabled = exports.debugFeatureValue = void 0;
+// Do NOT turn on a debug feature in production.
+const debugMode = process.env.FIREBASE_DEBUG_MODE === 'true';
+function loadDebugFeatures() {
+    if (!debugMode) {
+        return {};
+    }
+    try {
+        const obj = JSON.parse(process.env.FIREBASE_DEBUG_FEATURES);
+        if (typeof obj !== 'object') {
+            return {};
+        }
+        return obj;
+    }
+    catch (e) {
+        return {};
+    }
+}
+/* @internal */
+function debugFeatureValue(feat) {
+    if (!debugMode) {
+        return;
+    }
+    return loadDebugFeatures()[feat];
+}
+exports.debugFeatureValue = debugFeatureValue;
+/* @internal */
+function isDebugFeatureEnabled(feat) {
+    return debugMode && !!debugFeatureValue(feat);
+}
+exports.isDebugFeatureEnabled = isDebugFeatureEnabled;

package/lib/common/encoding.js

@@ -13,6 +13,9 @@ exports.durationFromSeconds = durationFromSeconds;
  * in A and B, but cannot verify that both Src and Dest have the same type for the same field.
  */
 function copyIfPresent(dest, src, ...fields) {
+    if (!src) {
+        return;
+    }
     for (const field of fields) {
         if (!Object.prototype.hasOwnProperty.call(src, field)) {
             continue;
@@ -24,6 +27,9 @@ exports.copyIfPresent = copyIfPresent;
 function convertIfPresent(dest, src, destField, srcField, converter = (from) => {
     return from;
 }) {
+    if (!src) {
+        return;
+    }
     if (!Object.prototype.hasOwnProperty.call(src, srcField)) {
         return;
     }

package/lib/common/manifest.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/common/manifest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/common/providers/https.d.ts

@@ -1,58 +1,58 @@
 /// <reference types="node" />
-import * as cors from 'cors';
 import * as express from 'express';
 import * as firebase from 'firebase-admin';
 /** @hidden */
 export interface Request extends express.Request {
     rawBody: Buffer;
 }
+interface DecodedAppCheckToken {
+    /**
+     * The issuer identifier for the issuer of the response.
+     *
+     * This value is a URL with the format
+     * `https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>`, where `<PROJECT_NUMBER>` 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: {
-        /**
-         * The issuer identifier for the issuer of the response.
-         *
-         * This value is a URL with the format
-         * `https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>`, where `<PROJECT_NUMBER>` 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;
-    };
+    token: DecodedAppCheckToken;
 }
 /**
  * The interface for Auth tokens verified in Callable functions
@@ -107,6 +107,55 @@ export interface CallableRequest<T = any> {
      */
     rawRequest: Request;
 }
+/** How a task should be retried in the event of a non-2xx return. */
+export interface TaskRetryConfig {
+    /**
+     * Maximum number of times a request should be attempted.
+     * If left unspecified, will default to 3.
+     */
+    maxAttempts?: number;
+    /**
+     * The maximum amount of time to wait between attempts.
+     * If left unspecified will default to 1hr.
+     */
+    maxBackoffSeconds?: number;
+    /**
+     * The maximum number of times to double the backoff between
+     * retries. If left unspecified will default to 16.
+     */
+    maxDoublings?: number;
+    /**
+     * The minimum time to wait between attempts. If left unspecified
+     * will default to 100ms.
+     */
+    minBackoffSeconds?: number;
+}
+/** How congestion control should be applied to the function. */
+export interface TaskRateLimits {
+    maxBurstSize?: number;
+    maxConcurrentDispatches?: number;
+    maxDispatchesPerSecond?: number;
+}
+/** 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 TaskRequest<T = any> {
+    /**
+     * The parameters used by a client when calling this function.
+     */
+    data: T;
+    /**
+     * The result of decoding and verifying an ODIC token.
+     */
+    auth?: AuthData;
+}
 /**
  * The set of Firebase Functions status codes. The codes are the same at the
  * ones exposed by gRPC here:
@@ -195,8 +244,4 @@ export declare function encode(data: any): any;
  */
 /** @hidden */
 export declare function decode(data: any): any;
-declare type v1Handler = (data: any, context: CallableContext) => any | Promise<any>;
-declare type v2Handler<Req, Res> = (request: CallableRequest<Req>) => Res;
-/** @hidden */
-export declare function onCallHandler<Req = any, Res = any>(options: cors.CorsOptions, handler: v1Handler | v2Handler<Req, Res>): (req: Request, res: express.Response) => Promise<void>;
 export {};