feat: add support for event_trigger_retry (#216)

Author: sethvargo

.github/workflows/integration.yml

@@ -219,6 +219,7 @@ jobs:
         source_dir: './tests/test-node-func/'
         event_trigger_type: 'providers/cloud.pubsub/eventTypes/topic.publish'
         event_trigger_resource: '${{ secrets.DEPLOY_CF_EVENT_PUBSUB_TOPIC }}'
+        event_trigger_retry: true
         env_vars_file: './tests/env-var-files/test.good.yaml'
         build_environment_variables: 'FOO=bar, ZIP=zap'
         build_environment_variables_file: './tests/env-var-files/test.good.yaml'

README.md

@@ -95,6 +95,10 @@ steps:
 
 - `event_trigger_service`: (Optional) The hostname of the service that should be observed.
 
+- `event_trigger_retry`: (Optional) If true, the event will be retried if the
+  function returns a failure. The default value is false. Note this applies to
+  function invocation from events, not the deployment itself.
+
 - `deploy_timeout`: (Optional) The function deployment timeout in seconds. Defaults to 300.
 
 - `build_worker_pool`: (Optional) Name of the Cloud Build Custom Worker Pool

action.yaml

@@ -134,6 +134,12 @@ inputs:
       The hostname of the service that should be observed.
     required: false
 
+  event_trigger_retry:
+    description: |-
+      If true, the event will be retried if the function returns a failure.
+    default: false
+    required: false
+
   deploy_timeout:
     description: |-
       The function deployment timeout in seconds.

src/client.ts

@@ -125,6 +125,11 @@ export type EventTrigger = {
   eventType: string;
   resource: string;
   service?: string;
+  failurePolicy?: FailurePolicy;
+};
+
+export type FailurePolicy = {
+  retry: Record<string, string>;
 };
 
 export type CreateOptions = {

src/main.ts

@@ -15,6 +15,7 @@
  */
 
 import {
+  getBooleanInput,
   getInput,
   info as logInfo,
   setFailed,
@@ -61,6 +62,7 @@ async function run(): Promise<void> {
     const eventTriggerType = presence(getInput('event_trigger_type'));
     const eventTriggerResource = presence(getInput('event_trigger_resource'));
     const eventTriggerService = presence(getInput('event_trigger_service'));
+    const eventTriggerRetry = getBooleanInput('event_trigger_retry');
     const deployTimeout = presence(getInput('deploy_timeout'));
     const labels = parseKVString(getInput('labels'));
 
@@ -154,9 +156,7 @@ async function run(): Promise<void> {
       labels: labels,
       maxInstances: maxInstances ? +maxInstances : undefined,
       minInstances: minInstances ? +minInstances : undefined,
-      // network: network, // TODO: add support
       serviceAccountEmail: serviceAccountEmail,
-      // sourceToken: sourceToken, // TODO: add support
       timeout: `${timeout}s`,
       vpcConnector: vpcConnector,
       vpcConnectorEgressSettings: vpcConnectorEgressSettings,
@@ -168,6 +168,14 @@ async function run(): Promise<void> {
         resource: eventTriggerResource,
         service: eventTriggerService,
       };
+
+      if (eventTriggerRetry) {
+        cf.eventTrigger.failurePolicy = {
+          // No, there's no value here. Retry is a oneof, and this is the
+          // translation to javascript.
+          retry: {},
+        };
+      }
     } else if (
       eventTriggerType ||
       eventTriggerResource ||

tests/client.test.ts

@@ -6,10 +6,6 @@ import { expect } from 'chai';
 import os from 'os';
 import path from 'path';
 import crypto from 'crypto';
-import {
-  CredentialBody,
-  ExternalAccountClientOptions,
-} from 'google-auth-library';
 
 import { CloudFunctionsClient, CloudFunction } from '../src/client';
 import { parseServiceAccountKeyJSON, zipDir } from '../src/util';