firebase-functions 3.17.2 → 3.19.0

package/lib/bin/firebase-functions.js

@@ -28,21 +28,23 @@ async function handleQuitquitquit(req, res) {
 }
 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}`);
-    }
-});
+if (process.env.FUNCTIONS_CONTROL_API === 'true') {
+    app.get('/__/functions.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);
+if (process.env.PORT) {
+    port = Number.parseInt(process.env.PORT);
 }
 console.log('Serving at port', port);
 server = app.listen(port);

package/lib/cloud-functions.d.ts

@@ -199,6 +199,7 @@ export interface TriggerAnnotated {
         vpcConnectorEgressSettings?: string;
         serviceAccountEmail?: string;
         ingressSettings?: string;
+        secrets?: string[];
     };
 }
 /**

package/lib/cloud-functions.js

@@ -180,9 +180,12 @@ function makeCloudFunction({ after = () => { }, before = () => { }, contextOnlyH
             else {
                 endpoint.eventTrigger = {
                     eventType: legacyEventType || provider + '.' + eventType,
-                    eventFilters: {
-                        resource: triggerResource(),
-                    },
+                    eventFilters: [
+                        {
+                            attribute: 'resource',
+                            value: triggerResource(),
+                        },
+                    ],
                     retry: !!options.failurePolicy,
                 };
             }
@@ -252,7 +255,7 @@ function _detectAuthType(event) {
 /** @hidden */
 function optionsToTrigger(options) {
     const trigger = {};
-    (0, encoding_1.copyIfPresent)(trigger, options, 'regions', 'schedule', 'minInstances', 'maxInstances', 'ingressSettings', 'vpcConnectorEgressSettings', 'vpcConnector', 'labels');
+    (0, encoding_1.copyIfPresent)(trigger, options, 'regions', 'schedule', 'minInstances', 'maxInstances', 'ingressSettings', 'vpcConnectorEgressSettings', 'vpcConnector', 'labels', 'secrets');
     (0, encoding_1.convertIfPresent)(trigger, options, 'failurePolicy', 'failurePolicy', (policy) => {
         if (policy === false) {
             return undefined;
@@ -286,6 +289,7 @@ function optionsToEndpoint(options) {
     (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);
+    (0, encoding_1.convertIfPresent)(endpoint, options, 'secretEnvironmentVariables', 'secrets', (secrets) => secrets.map((secret) => ({ secret, key: secret })));
     if (options === null || options === void 0 ? void 0 : options.vpcConnector) {
         endpoint.vpc = { connector: options.vpcConnector };
         (0, encoding_1.convertIfPresent)(endpoint.vpc, options, 'egressSettings', 'vpcConnectorEgressSettings');

package/lib/function-builder.js

@@ -125,6 +125,13 @@ function assertRuntimeOptionsValid(runtimeOptions) {
             }
         }
     }
+    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;
 }
 /**

package/lib/function-configuration.d.ts

@@ -99,6 +99,7 @@ export interface RuntimeOptions {
      */
     invoker?: 'public' | 'private' | string | string[];
     allowInvalidAppCheckToken?: boolean;
+    secrets?: string[];
 }
 export interface DeploymentOptions extends RuntimeOptions {
     regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;

package/lib/index.js

@@ -22,7 +22,11 @@
 // SOFTWARE.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/providers/database.js

@@ -229,6 +229,7 @@ class RefBuilder {
     }
 }
 exports.RefBuilder = RefBuilder;
+const resourceRegex = /^projects\/([^/]+)\/instances\/([a-zA-Z0-9-]+)\/refs(\/.+)?/;
 /**
  * Utility function to extract database reference from resource string
  *
@@ -239,7 +240,6 @@ exports.RefBuilder = RefBuilder;
  */
 /** @hidden */
 function extractInstanceAndPath(resource, domain = 'firebaseio.com') {
-    const resourceRegex = `projects/([^/]+)/instances/([a-zA-Z0-9\-^/]+)/refs(/.+)?`;
     const match = resource.match(new RegExp(resourceRegex));
     if (!match) {
         throw new Error(`Unexpected resource string for Firebase Realtime Database event: ${resource}. ` +

package/lib/runtime/loader.js

@@ -91,11 +91,10 @@ async function loadStack(functionsDir) {
     const requiredAPIs = [];
     const mod = await loadModule(functionsDir);
     extractStack(mod, endpoints, requiredAPIs);
-    const stack = {
+    return {
         endpoints,
         specVersion: 'v1alpha1',
         requiredAPIs: mergeRequiredAPIs(requiredAPIs),
     };
-    return stack;
 }
 exports.loadStack = loadStack;

package/lib/runtime/manifest.d.ts

@@ -1,3 +1,11 @@
+/**
+ * One or more event filters restrict the set of events delivered to an EventTrigger.
+ */
+interface EventFilter {
+    attribute: string;
+    value: string;
+    operator?: string;
+}
 /**
  * An definition of a function as appears in the Manifest.
  */
@@ -18,12 +26,16 @@ export interface ManifestEndpoint {
     labels?: Record<string, string>;
     ingressSettings?: string;
     environmentVariables?: Record<string, string>;
+    secretEnvironmentVariables?: Array<{
+        key: string;
+        secret?: string;
+    }>;
     httpsTrigger?: {
         invoker?: string[];
     };
     callableTrigger?: {};
     eventTrigger?: {
-        eventFilters: Record<string, string>;
+        eventFilters: EventFilter[];
         eventType: string;
         retry: boolean;
         region?: string;
@@ -47,9 +59,10 @@ export interface ManifestRequiredAPI {
 }
 /**
  * An definition of a function deployment as appears in the Manifest.
- **/
+ */
 export interface ManifestStack {
     specVersion: 'v1alpha1';
     requiredAPIs: ManifestRequiredAPI[];
     endpoints: Record<string, ManifestEndpoint>;
 }
+export {};

package/lib/v2/options.d.ts

@@ -2,7 +2,7 @@ import { ParamSpec } from './params/types';
 /**
  * List of all regions supported by Cloud Functions v2
  */
-export declare const SUPPORTED_REGIONS: readonly ["us-west1", "us-central1", "europe-west4", "asia-northeast1"];
+export declare const SUPPORTED_REGIONS: readonly ["asia-northeast1", "europe-north1", "europe-west1", "europe-west4", "us-central1", "us-east1", "us-west1"];
 /**
  * A region known to be supported by CloudFunctions v2
  */
@@ -26,7 +26,7 @@ export declare const MAX_CONCURRENCY = 1000;
 /**
  * List of available memory options supported by Cloud Functions.
  */
-export declare const SUPPORTED_MEMORY_OPTIONS: readonly ["256MB", "512MB", "1GB", "2GB", "4GB", "8GB"];
+export declare const SUPPORTED_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB", "16GB", "32GB"];
 /**
  * A supported memory option.
  */

package/lib/v2/options.js

@@ -29,10 +29,13 @@ const params_1 = require("./params");
  * List of all regions supported by Cloud Functions v2
  */
 exports.SUPPORTED_REGIONS = [
-    'us-west1',
-    'us-central1',
-    'europe-west4',
     'asia-northeast1',
+    'europe-north1',
+    'europe-west1',
+    'europe-west4',
+    'us-central1',
+    'us-east1',
+    'us-west1',
 ];
 /**
  * Cloud Functions v2 min timeout value.
@@ -54,20 +57,26 @@ exports.MAX_CONCURRENCY = 1000;
  * List of available memory options supported by Cloud Functions.
  */
 exports.SUPPORTED_MEMORY_OPTIONS = [
+    '128MB',
     '256MB',
     '512MB',
     '1GB',
     '2GB',
     '4GB',
     '8GB',
+    '16GB',
+    '32GB',
 ];
 const MemoryOptionToMB = {
+    '128MB': 128,
     '256MB': 256,
     '512MB': 512,
     '1GB': 1024,
     '2GB': 2048,
     '4GB': 4096,
     '8GB': 8192,
+    '16GB': 16384,
+    '32GB': 32768,
 };
 /**
  * List of available options for VpcConnectorEgressSettings.

package/lib/v2/providers/alerts/alerts.js

@@ -36,14 +36,20 @@ function getEndpointAnnotation(opts, alertType, appId) {
         },
         eventTrigger: {
             eventType: exports.eventType,
-            eventFilters: {
-                alertType,
-            },
+            eventFilters: [
+                {
+                    attribute: 'alerttype',
+                    value: alertType,
+                },
+            ],
             retry: !!opts.retry,
         },
     };
     if (appId) {
-        endpoint.eventTrigger.eventFilters.appId = appId;
+        endpoint.eventTrigger.eventFilters.push({
+            attribute: 'appid',
+            value: appId,
+        });
     }
     return endpoint;
 }

package/lib/v2/providers/alerts/billing.d.ts

@@ -33,6 +33,6 @@ export declare function onPlanUpdatePublished(opts: options.EventHandlerOptions,
 /**
  * Declares a function that can handle an automated billing plan update event.
  */
-export declare function onAutomatedPlanUpdatePublished(handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanAutomatedUpdatePayload>>;
-export declare function onAutomatedPlanUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanAutomatedUpdatePayload>>;
+export declare function onPlanAutomatedUpdatePublished(handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanAutomatedUpdatePayload>>;
+export declare function onPlanAutomatedUpdatePublished(opts: options.EventHandlerOptions, handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any | Promise<any>): CloudFunction<FirebaseAlertData<PlanAutomatedUpdatePayload>>;
 export {};

package/lib/v2/providers/alerts/billing.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onOperation = exports.onAutomatedPlanUpdatePublished = exports.onPlanUpdatePublished = exports.automatedPlanUpdateAlert = exports.planUpdateAlert = void 0;
+exports.onOperation = exports.onPlanAutomatedUpdatePublished = exports.onPlanUpdatePublished = exports.planAutomatedUpdateAlert = exports.planUpdateAlert = void 0;
 const _1 = require(".");
 /** @internal */
 exports.planUpdateAlert = 'billing.planUpdate';
 /** @internal */
-exports.automatedPlanUpdateAlert = 'billing.automatedPlanUpdate';
+exports.planAutomatedUpdateAlert = 'billing.planAutomatedUpdate';
 function onPlanUpdatePublished(optsOrHandler, handler) {
     return onOperation(exports.planUpdateAlert, optsOrHandler, handler);
 }
 exports.onPlanUpdatePublished = onPlanUpdatePublished;
-function onAutomatedPlanUpdatePublished(optsOrHandler, handler) {
-    return onOperation(exports.automatedPlanUpdateAlert, optsOrHandler, handler);
+function onPlanAutomatedUpdatePublished(optsOrHandler, handler) {
+    return onOperation(exports.planAutomatedUpdateAlert, optsOrHandler, handler);
 }
-exports.onAutomatedPlanUpdatePublished = onAutomatedPlanUpdatePublished;
+exports.onPlanAutomatedUpdatePublished = onPlanAutomatedUpdatePublished;
 /** @internal */
 function onOperation(alertType, optsOrHandler, handler) {
     if (typeof optsOrHandler === 'function') {

package/lib/v2/providers/alerts/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/v2/providers/pubsub.js

@@ -104,7 +104,7 @@ function onMessagePublished(topicOrOptions, handler) {
         },
         eventTrigger: {
             eventType: 'google.cloud.pubsub.topic.v1.messagePublished',
-            eventFilters: { topic },
+            eventFilters: [{ attribute: 'topic', value: topic }],
             retry: false,
         },
     };

package/lib/v2/providers/storage.js

@@ -99,9 +99,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
                 },
                 eventTrigger: {
                     eventType,
-                    eventFilters: {
-                        bucket,
-                    },
+                    eventFilters: [{ attribute: 'bucket', value: bucket }],
                     retry: false,
                 },
             };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.17.2",
+  "version": "3.19.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -149,7 +149,7 @@
     "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 --file ./mocha/setup.ts spec/**/*.spec.ts ",
+    "test": "mocha --file ./mocha/setup.ts \"spec/**/*.spec.ts\"",
     "test:bin": "./scripts/bin-test/run.sh"
   },
   "dependencies": {