fix: Update service polling (#31)

* fix: Update service polling

* lint

* debug

* Add timeout

* Add comments

* Throw error for ready timeouts

* update test and merge

* deep copy

* debug

* debug

* debug

* debug

* remove print

* Update unit test

Author: averikitsch

.github/workflows/deploy-cloudrun-credentials-it.yml

@@ -2,8 +2,9 @@ name: deploy-cloudrun Credentials Integration
 
 on:
   push:
-    branches-ignore: 
-    - 'example-*'
+    branches: 
+    - 'main'
+  pull_request:
 
 jobs:
   gcloud:

.github/workflows/deploy-cloudrun-it.yml

@@ -2,8 +2,9 @@ name: deploy-cloudrun Integration
 
 on:
   push:
-    branches-ignore: 
-    - 'example-*'
+    branches: 
+    - 'main'
+  pull_request:
 
 jobs:
   envvars:

.github/workflows/release-please.yml

@@ -1,8 +1,10 @@
+name: build and release-please
+
 on:
   push:
     branches:
       - main
-name: build and release-please
+      
 jobs:
   build:
     env:

src/cloudRun.ts

@@ -25,6 +25,7 @@ import {
 } from 'google-auth-library';
 import { Service } from './service';
 import { MethodOptions } from 'googleapis-common';
+import { get } from 'lodash';
 
 /**
  * Available options to create the client.
@@ -185,7 +186,7 @@ export class CloudRun {
    * @param service Service object.
    * @returns Service object.
    */
-  async deploy(service: Service): Promise<run_v1.Schema$Service> {
+  async deploy(service: Service): Promise<string> {
     const authClient = await this.getAuthClient();
     const serviceNames = await this.listServices();
     let serviceResponse: GaxiosResponse<run_v1.Schema$Service>;
@@ -218,8 +219,11 @@ export class CloudRun {
         this.methodOptions,
       );
     }
+
+    const url = await this.pollService(serviceResponse.data);
     core.info(`Service ${service.name} has been successfully deployed.`);
-    return serviceResponse.data;
+    // return serviceResponse.data;
+    return url;
   }
 
   /**
@@ -299,4 +303,74 @@ export class CloudRun {
       this.methodOptions,
     );
   }
+
+  /**
+   * Poll service revision until ready
+   * @param serviceResponse
+   * @returns service url or revision url
+   */
+  async pollService(serviceResponse: run_v1.Schema$Service): Promise<string> {
+    let url = getUrl(serviceResponse);
+    const maxAttempts = 60; // Timeout after 300 seconds
+    let attempt = 0;
+    // Revision is ready and url is found before timeout
+    while (!getReadyStatus(serviceResponse) && !url && attempt < maxAttempts) {
+      attempt += 1;
+      await sleep(5000);
+      serviceResponse = await this.getService(serviceResponse.metadata!.name!);
+      url = getUrl(serviceResponse);
+    }
+    if (!url) throw new Error('Timeout error: service revision is not ready.');
+    return url;
+  }
+}
+
+/** Retrieve status of new revision */
+function getReadyStatus(serviceResponse: run_v1.Schema$Service): boolean {
+  // Retrieve the revision name
+  const revisionName = get(serviceResponse, 'spec.template.metadata.name');
+  // Retrieve the revision statuses
+  const createdRevision = get(
+    serviceResponse,
+    'status.latestCreatedRevisionName',
+  );
+  const latestRevision = get(serviceResponse, 'status.latestReadyRevisionName');
+  // Latest created revision must equal latest ready revision
+  if (revisionName) {
+    // After first deployment, revision name is set
+    return (
+      revisionName &&
+      createdRevision &&
+      latestRevision &&
+      revisionName == createdRevision &&
+      revisionName == latestRevision
+    );
+  } else {
+    // First deployment will not have a revision name
+    return (
+      createdRevision && latestRevision && latestRevision == createdRevision
+    );
+  }
+}
+
+function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+/** Get service url or tagged revision url */
+function getUrl(serviceResponse: run_v1.Schema$Service): string {
+  const revisionName = get(serviceResponse, 'spec.template.metadata.name');
+  // Find revision url
+  const traffic: run_v1.Schema$TrafficTarget[] = get(
+    serviceResponse,
+    'status.traffic',
+  );
+  let revision;
+  if (traffic) {
+    revision = traffic.find((revision) => {
+      return revision.revisionName == revisionName && revision.url;
+    });
+  }
+  // Or return service url
+  return get(revision, 'url') || get(serviceResponse, 'status.url') || '';
 }

src/index.ts

@@ -17,11 +17,6 @@
 import * as core from '@actions/core';
 import { CloudRun } from './cloudRun';
 import { Service } from './service';
-import { get } from 'lodash';
-
-function sleep(ms: number): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
 
 /**
  * Executes the main action. It includes the main business logic and is the
@@ -45,13 +40,10 @@ async function run(): Promise<void> {
     const service = new Service({ image, name, envVars, yaml });
 
     // Deploy service
-    let serviceResponse = await client.deploy(service);
-    while (!get(serviceResponse, 'status.url')) {
-      serviceResponse = await client.getService(service.name);
-      await sleep(2000);
-    }
+    const url = await client.deploy(service);
+
     // Set URL as output
-    core.setOutput('url', get(serviceResponse, 'status.url'));
+    core.setOutput('url', url);
   } catch (error) {
     core.setFailed(error.message);
   }

src/service.ts

@@ -15,7 +15,7 @@
  */
 
 import { run_v1 } from 'googleapis';
-import { get, merge } from 'lodash';
+import { get, merge, cloneDeep } from 'lodash';
 import fs from 'fs';
 import YAML from 'yaml';
 
@@ -136,38 +136,49 @@ export class Service {
    * @param prevService the previous Cloud Run service revision
    */
   public merge(prevService: run_v1.Schema$Service): void {
+    const currentService = cloneDeep(this.request);
+
     // Get Revision names if set
-    const name = get(this.request, 'spec.template.metadata.name');
+    const name = get(currentService, 'spec.template.metadata.name');
     const previousName = get(prevService, 'spec.template.metadata.name');
-
-    // Deep Merge Service
-    const mergedServices = merge(prevService, this.request);
-
-    // Force update with Revision name change
-    mergedServices.spec!.template!.metadata!.name = this.generateRevisionName(
-      name,
-      previousName,
-    );
-
-    // Merge Container spec
-    const prevEnvVars = prevService.spec!.template!.spec!.containers![0].env;
-    const currentEnvVars = this.request.spec!.template!.spec!.containers![0]
-      .env;
+    const generatedName = this.generateRevisionName(name, previousName);
 
     // Merge Env vars
+    const prevEnvVars = get(prevService, 'spec.template.spec.containers')[0]
+      .env;
+    const currentEnvVars = get(
+      currentService,
+      'spec.template.spec.containers',
+    )[0].env;
     let env: run_v1.Schema$EnvVar[] = [];
     if (currentEnvVars) {
-      env = currentEnvVars.map((envVar) => envVar as run_v1.Schema$EnvVar);
+      env = currentEnvVars.map(
+        (envVar: run_v1.Schema$EnvVar) => envVar as run_v1.Schema$EnvVar,
+      );
     }
     const keys = env?.map((envVar) => envVar.name);
-    prevEnvVars?.forEach((envVar) => {
+    prevEnvVars?.forEach((envVar: run_v1.Schema$EnvVar) => {
       if (!keys.includes(envVar.name)) {
         // Add old env vars without duplicating
-        return env.push(envVar);
+        env.push(envVar);
       }
     });
-    // Set Env vars
-    mergedServices.spec!.template!.spec!.containers![0].env = env;
+    const newEnv = cloneDeep(env);
+
+    // Deep Merge Service
+    const mergedServices = merge(prevService, currentService);
+
+    // Force update with Revision name change
+    if (!get(mergedServices, 'spec.template.metadata')) {
+      mergedServices.spec!.template!.metadata = {
+        name: generatedName,
+      };
+    } else {
+      mergedServices.spec!.template!.metadata!.name = generatedName;
+    }
+
+    // Merge Container spec
+    mergedServices.spec!.template!.spec!.containers![0].env = newEnv;
     this.request = mergedServices;
   }
 

tests/unit/cloudRun.test.ts

@@ -28,10 +28,6 @@ const image = 'gcr.io/cloudrun/hello';
 const name = `test-${Math.round(Math.random() * 100000)}`; // Cloud Run currently has name length restrictions
 const service = new Service({ image, name });
 
-function sleep(ms: number): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
-
 describe('CloudRun', function() {
   it('initializes with JSON creds', function() {
     const client = new CloudRun(region, {
@@ -62,13 +58,13 @@ describe('CloudRun', function() {
       credentials: credentials,
       projectId: project,
     });
-    let result = await client.deploy(service);
-    while (!result.status!.url) {
-      result = await client.getService(name);
-      await sleep(2000);
+    try {
+      let result = await client.deploy(service);
+      expect(result).to.include('run.app');
+    } catch (err) {
+      let result = await client.getService(service.name);
+      expect(result).to.not.be.undefined;
     }
-    expect(result).to.not.eql(null);
-    expect(result.status!.url).to.include('run.app');
     await client.delete(service);
   });
 });

tests/unit/service.test.ts

@@ -62,6 +62,33 @@ describe('Service', function() {
     );
   });
 
+  it('retains env vars', function()  {
+    const envVars = 'KEY1=VALUE1';
+    const service = new Service({ image, name, envVars });
+    const containers = get(service, 'request.spec.template.spec.containers');
+    const actual = containers[0]?.env[0];
+    const expected: run_v1.Schema$EnvVar = {
+      name: 'KEY1',
+      value: 'VALUE1',
+    };
+    expect(actual.name).equal(expected.name);
+
+    const envVars2 = 'KEY2=VALUE2';
+    const service2 = new Service({ image, name, envVars: envVars2 });
+    service.merge(service2.request);
+    const containers2 = get(service2, 'request.spec.template.spec.containers');
+    const actual2 = containers2[0]?.env;
+    expect(actual2.length).equal(2);
+    const expected2: run_v1.Schema$EnvVar = {
+      name: 'KEY2',
+      value: 'VALUE2',
+    };
+    expect(actual2[1].name).equal(expected2.name);
+
+    const revisionName = get(service2, 'request.spec.template.metadata.name');
+    expect(revisionName).to.not.be.undefined;
+  });
+
   it('parses yaml', function() {
     const yaml = './tests/unit/service.basic.yaml';
     const service = new Service({ image, name, yaml });