Merge pull request #12 from getlarge/fix-table-parsing-failure

fix: Heroku CLI table parsing failure

Author: getlarge

packages/nx-heroku/src/executors/common/heroku/config-vars.spec.ts

@@ -0,0 +1,28 @@
+import { parseConfigVarsTable } from './config-vars';
+
+const configVarsTable = [
+  'CLUSTER_ENABLED:            true',
+  'DISK_STORAGE_TRESHOLD:      161061273600',
+  'EVENT_LOOP_DELAY_THRESHOLD: 100',
+  'HOSTNAME:                   0.0.0.0',
+  'LOG_CONCURRENCY:            true',
+  'MAX_PAYLOAD_SIZE:           1',
+  'MEMORY_RSS_TRESHOLD:',
+];
+
+const configVars = {
+  CLUSTER_ENABLED: 'true',
+  DISK_STORAGE_TRESHOLD: '161061273600',
+  EVENT_LOOP_DELAY_THRESHOLD: '100',
+  HOSTNAME: '0.0.0.0',
+  LOG_CONCURRENCY: 'true',
+  MAX_PAYLOAD_SIZE: '1',
+  MEMORY_RSS_TRESHOLD: '',
+};
+
+describe('ConfigVars', () => {
+  it('parseConfigVarsTable - should return a valid Variables object from a table', () => {
+    const result = parseConfigVarsTable(configVarsTable);
+    expect(result).toEqual(configVars);
+  });
+});

packages/nx-heroku/src/executors/common/heroku/config-vars.ts

@@ -10,6 +10,16 @@ export type SerializedConfigVar =
 
 export type Variables = Record<string, string>;
 
+export function parseConfigVarsTable(table: string[]): Variables {
+  return table.reduce((acc, line) => {
+    const parts = line.split(':');
+    const key = parts.shift().trim();
+    const value = parts.map((el) => el.trim()).join(':');
+    key && (acc[key] = value);
+    return acc;
+  }, {});
+}
+
 export async function getConfigVars(options: {
   appName: string;
 }): Promise<Record<string, string>> {
@@ -18,16 +28,10 @@ export async function getConfigVars(options: {
     encoding: 'utf-8',
   });
   const rawAppEnv = parseTable(configVars) || [];
-  if (rawAppEnv.includes(`Invalid credentials provided`)) {
+  if (rawAppEnv[0]?.includes(`Invalid credentials provided`)) {
     throw new Error('Invalid credentials provided');
   }
-  return rawAppEnv.reduce((acc, line) => {
-    const parts = line.split(':');
-    const key = parts.shift().trim();
-    const value = parts.map((el) => el.trim()).join(':');
-    if (key && value) acc[key] = value;
-    return acc;
-  }, {});
+  return parseConfigVarsTable(rawAppEnv);
 }
 
 export function serializeConfigVar(
@@ -42,10 +46,9 @@ export function serializeConfigVars(
   variables: Variables,
   quote: ConfigVarQuote = `'`
 ): SerializedConfigVar[] {
-  return Object.entries(variables).reduce((acc, [key, value]) => {
-    acc.push(serializeConfigVar(key, value, quote));
-    return acc;
-  }, []);
+  return Object.entries(variables).map(([key, value]) =>
+    serializeConfigVar(key, value, quote)
+  );
 }
 
 export async function setConfigVars(options: {

packages/nx-heroku/src/executors/common/heroku/index.ts

@@ -2,7 +2,7 @@ import { exec } from '../utils';
 import { AppName } from './apps';
 
 export async function dynoCommand(options: {
-  command: 'kill' | 'restart' | 'stop';
+  command: 'kill' | 'restart' | 'stop' | 'scale';
   appName: AppName;
 }) {
   const { appName, command } = options;

packages/nx-heroku/src/executors/common/heroku/webhooks.spec.ts

@@ -0,0 +1,49 @@
+import { parseWebhooksTable, Webhook } from './webhooks';
+
+const webhooksTable = [
+  '1965e28c-b99f-4c14-a64c-582efc7667ae https://webhook-handler.io/receive api:build,dyno sync',
+  '682df0e5-67f8-4a3b-a71d-78451470b997 https://webhook-handler.io/receive api:build,api:release,dyno sync',
+  '5541c980-0835-4063-bc70-9a11d5b8a016 https://webhook-handler.io/receive api:build,api:release,dyno notify',
+  'bffc659a-d802-4761-86d5-7f343c135eca https://webhook-handler.io/receive api:addon sync',
+  '9caf5cfb-ceac-4512-b197-fab47b3629f2 https://webhook-handler.io/receive api:formation sync',
+];
+
+const webhooks: Webhook[] = [
+  {
+    id: '1965e28c-b99f-4c14-a64c-582efc7667ae',
+    url: 'https://webhook-handler.io/receive',
+    include: 'api:build,dyno',
+    level: 'sync',
+  },
+  {
+    id: '682df0e5-67f8-4a3b-a71d-78451470b997',
+    url: 'https://webhook-handler.io/receive',
+    include: 'api:build,api:release,dyno',
+    level: 'sync',
+  },
+  {
+    id: '5541c980-0835-4063-bc70-9a11d5b8a016',
+    url: 'https://webhook-handler.io/receive',
+    include: 'api:build,api:release,dyno',
+    level: 'notify',
+  },
+  {
+    id: 'bffc659a-d802-4761-86d5-7f343c135eca',
+    url: 'https://webhook-handler.io/receive',
+    include: 'api:addon',
+    level: 'sync',
+  },
+  {
+    id: '9caf5cfb-ceac-4512-b197-fab47b3629f2',
+    url: 'https://webhook-handler.io/receive',
+    include: 'api:formation',
+    level: 'sync',
+  },
+];
+
+describe('Webhooks', () => {
+  it('parseWebhooksTable - should return a valid Webhook objects array from a table', () => {
+    const result = parseWebhooksTable(webhooksTable);
+    expect(result).toEqual(webhooks);
+  });
+});

packages/nx-heroku/src/executors/common/heroku/webhooks.ts

@@ -1,24 +1,55 @@
 import { logger } from '@nrwl/devkit';
 import isURL from 'validator/lib/isURL';
+import isUUID from 'validator/lib/isUUID';
 
 import { exec, parseTable } from '../utils';
 import { HerokuError, shouldHandleHerokuError } from './error';
 
-export async function getWebhooks(
-  appName: string
-): Promise<{ id: string; url: string; include: string; level: string }[]> {
+export type Webhook = {
+  id: string;
+  url: string;
+  include: string;
+  level: string;
+};
+
+export function parseWebhooksTable(table: string[]): Webhook[] {
+  /** key order matters */
+  const validators = {
+    id: isUUID,
+    url: isURL,
+    include: () => true,
+    level: (x?: string) => !x || ['sync', 'notify'].includes(x),
+  };
+  return table
+    .map((webhook) => {
+      const parts = webhook.split(' ');
+      const webhookIsValid =
+        parts.length === 4 &&
+        Object.entries(validators).every(([key, validator], i) => {
+          if (validator(parts[i])) {
+            return true;
+          }
+          logger.warn(`Invalid ${key} (${parts[i]}) for webhook ${webhook}`);
+          return false;
+        });
+      if (!webhookIsValid) return null;
+      const [id, url, include, level] = parts;
+      return { id, url, include, level };
+    })
+    .filter(Boolean);
+}
+
+export async function getWebhooks(appName: string): Promise<Webhook[]> {
   const { stdout, stderr } = await exec(`heroku webhooks --app ${appName}`, {
     encoding: 'utf-8',
   });
   if (shouldHandleHerokuError(stderr, stdout)) {
     logger.warn(HerokuError.cleanMessage(stderr));
     return [];
   }
-  const res = parseTable(stdout);
-  return res.map((webhook) => {
-    const [id, url, include, level] = webhook.split(' ');
-    return { id, url, include, level };
-  });
+
+  const table = parseTable(stdout);
+  return parseWebhooksTable(table);
 }
 
 // eslint-disable-next-line max-lines-per-function

packages/nx-heroku/src/executors/common/utils.spec.ts

@@ -41,6 +41,15 @@ const configVarsRawOutput = `
 YARN2_SKIP_PRUNING:         true
 `;
 
+const webhooksRawOutput = `Webhook ID                           URL                                                                                       Include                    Level
+ ──────────────────────────────────── ───────────────────────────────────────────────────────────────────────────────────────── ────────────────────────── ─────
+ 1965e28c-b99f-4c14-a64c-582efc7667ae https://webhook-handler/receive api:build,dyno sync
+ 682df0e5-67f8-4a3b-a71d-78451470b997 https://webhook-handler/receive api:build,api:release,dyno sync
+ 5541c980-0835-4063-bc70-9a11d5b8a016 https://webhook-handler/receive api:build,api:release,dyno notify
+ bffc659a-d802-4761-86d5-7f343c135eca https://webhook-handler/receive api:addon sync
+ 9caf5cfb-ceac-4512-b197-fab47b3629f2 https://webhook-handler/receive api:formation sync
+`;
+
 const configVarsClean = `=== s1-auth-service-staging Config Vars
 CLUSTER_ENABLED:            true
 DISK_STORAGE_TRESHOLD:      161061273600
@@ -60,6 +69,7 @@ TAG:                        v1.9.4
 USE_YARN_CACHE:             undefined
 YARN2_SKIP_PRUNING:         true`;
 
+// eslint-disable-next-line max-lines-per-function
 describe('Utils', () => {
   it.todo('expandOptions - should expand options');
 
@@ -94,5 +104,23 @@ describe('Utils', () => {
     const result = parseTable(configVarsRawOutput);
     expect(result).toBeDefined();
     expect(result).toHaveLength(17);
+    expect(
+      result
+        .shift()
+        .split(':')
+        .map((el) => el.trim())
+    ).toEqual(['CLUSTER_ENABLED', 'true']);
+  });
+
+  it('parseTable - should parse raw webhooks string', () => {
+    const result = parseTable(webhooksRawOutput);
+    expect(result).toBeDefined();
+    expect(result).toHaveLength(5);
+    expect(result.shift().split(' ')).toEqual([
+      '1965e28c-b99f-4c14-a64c-582efc7667ae',
+      'https://webhook-handler/receive',
+      'api:build,dyno',
+      'sync',
+    ]);
   });
 });

packages/nx-heroku/src/executors/common/utils.ts

@@ -16,9 +16,18 @@ export function parseJsonString(stdout: string) {
 }
 
 export function parseTable(stdout: string) {
-  const lines = removeConsoleOutputColors(stdout)?.split('\n');
-  // remove header from response
+  const lines = removeConsoleOutputColors(stdout)
+    ?.split('\n')
+    ?.map((line) => line?.trim());
+  // remove header from response, column names
   lines.shift();
+  // remove separator
+  if (
+    lines[0]?.trim()?.length === 0 ||
+    lines[0]?.includes('──────────────────────────────')
+  ) {
+    lines.shift();
+  }
   return lines;
 }
 

packages/nx-heroku/src/executors/deploy/executor.spec.ts

@@ -131,6 +131,10 @@ describe('Deploy Executor', () => {
     expect(herokuDeployService.close).toBeCalled();
   });
 
+  // TODO: test
+  // validateOptions
+  // setEnvironmentVariables
+  // setupHeroku
   it('should instantiate the heroku app factory', async () => {
     options.config = ['development', 'production'];
     herokuDeployService['validateOptions'] = jest.fn();

packages/nx-heroku/src/executors/deploy/services/heroku-app.service.ts

@@ -344,7 +344,7 @@ class HerokuApp {
     const push = spawn('git', args, { signal });
     push.stdout
       .setEncoding('utf-8')
-      //? if data contains `Everything up-to-date`, should we still restart the app ?
+      //? stop watch when data matches ^Total\s+(\d+)\s+\(delta\s+(\d+)\),\s+reused\s+(\d+)\s+\(delta\s+(\d+)\),\s+pack-reused\s+(\d+)
       .on('data', (data) => this.logger.info(data?.trim()));
 
     push.stderr
@@ -375,6 +375,7 @@ class HerokuApp {
     // Wait for [watchDelay] seconds once the build started to ensure it works and kill child process
     // if watchDelay === 0, the process will not be aborted
     await new Promise<void>((resolve, reject) => {
+      // TODO: const signal =  AbortSignal.timeout(watchDelay);
       const controller = new AbortController();
       const { signal } = controller;
       const push = this.createDeployProcess(signal, useHttps);