Insert Expression and Field types into GlobalOptions and inheriting types (#1171)

This will plumb Param definitions and Expression types in Options to the CLI.

Author: Berlioz

package-lock.json

@@ -1,8 +1,16 @@
 const functions = require("../../../../src/index");
 const functionsv2 = require("../../../../src/v2/index");
-const { defineString } = require("../../../../src/v2/params");
+const params = require("../../../../src/v2/params");
 
-defineString("FOO");
+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");

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

@@ -8,6 +8,7 @@ import {
  ManifestRequiredAPI,
  ManifestStack,
 } from '../../src/runtime/manifest';
+import { clearParams } from '../../src/v2/params';
 
 describe('extractStack', () => {
  const httpFn = functions.https.onRequest(() => {});
@@ -104,6 +105,7 @@ describe('extractStack', () => {
 
  afterEach(() => {
  process.env.GCLOUD_PROJECT = prev;
+ clearParams();
  });
 
  it('extracts stack from a simple module', () => {
@@ -313,7 +315,44 @@ describe('loadStack', () => {
  {
  name: 'has params',
  modulePath: './spec/fixtures/sources/commonjs-params',
- expected: { ...expected, params: [{ name: 'FOO', type: 'string' }] },
+ 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' },
+ ],
+ },
  },
  ];
 

spec/runtime/loader.spec.ts

@@ -0,0 +1,67 @@
+import { stackToWire, ManifestStack } from '../../src/runtime/manifest';
+import { expect } from 'chai';
+import * as params from '../../src/v2/params';
+
+describe('stackToWire', () => {
+ afterEach(() => {
+ params.clearParams();
+ });
+
+ 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);
+ });
+});