fix(nx-heroku): handle update of config vars during merge

Author: getlarge

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

@@ -48,28 +48,6 @@ export function serializeConfigVars(
   }, []);
 }
 
-export function addConfigVars(
-  variables: Variables,
-  source: Variables,
-  excludeKeys: string[] = [],
-  prefix?: string
-): SerializedConfigVar[] {
-  const configVars: SerializedConfigVar[] = [];
-  for (const key in variables) {
-    if (excludeKeys.includes(key)) continue;
-    const newValue = variables[key];
-    if (prefix && key.startsWith(prefix)) {
-      const newKey = key.substring(prefix.length);
-      if (!(newKey in source) || source[newKey] !== newValue) {
-        configVars.push(serializeConfigVar(newKey, newValue));
-      }
-    } else if (!prefix && !(key in source)) {
-      configVars.push(serializeConfigVar(key, newValue));
-    }
-  }
-  return configVars;
-}
-
 export async function setConfigVars(options: {
   appName: string;
   configVars: SerializedConfigVar[];
@@ -95,29 +73,59 @@ export async function setConfigVars(options: {
   return undefined;
 }
 
+function addConfigVars(
+  variables: Variables,
+  source: Variables,
+  options: {
+    excludeKeys?: string[];
+    prefix?: string;
+    update?: boolean;
+  }
+): SerializedConfigVar[] {
+  const { excludeKeys = [], update, prefix } = options;
+  const configVars: SerializedConfigVar[] = [];
+
+  function shouldInsert(key: string): boolean {
+    return !(key in source) || (source[key] !== variables[key] && update);
+  }
+
+  for (let key in variables) {
+    if (excludeKeys.includes(key)) continue;
+    if (prefix && !key.startsWith(prefix)) continue;
+    const newValue = variables[key];
+    key = prefix ? key.substring(prefix.length) : key;
+    if (shouldInsert(key)) {
+      configVars.push(serializeConfigVar(key, newValue));
+    }
+  }
+  return configVars;
+}
+
 /*
  * check existing config variables to only push changed or new variables
  */
 export async function mergeConfigVars(options: {
   appName: string;
   variables?: Variables;
   excludeKeys?: string[];
+  update?: boolean;
 }): Promise<Variables> {
-  const { appName, variables = {}, excludeKeys = [] } = options;
+  const { appName, variables = {}, excludeKeys = [], update } = options;
   const currentConfigVars = await getConfigVars(options);
   let configVars: SerializedConfigVar[] = [];
   configVars = [
-    ...configVars,
-    ...addConfigVars(
-      process.env,
-      currentConfigVars,
+    ...addConfigVars(process.env, currentConfigVars, {
       excludeKeys,
-      HEROKU_ENV_VARIABLES_PREFIX
-    ),
+      prefix: HEROKU_ENV_VARIABLES_PREFIX,
+      update,
+    }),
   ];
   configVars = [
     ...configVars,
-    ...addConfigVars(variables, currentConfigVars, excludeKeys),
+    ...addConfigVars(variables, currentConfigVars, {
+      excludeKeys,
+      update,
+    }),
   ];
   return setConfigVars({ appName, configVars });
 }

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

@@ -206,7 +206,12 @@ class HerokuApp {
   }
 
   private async mergeConfigVars(): Promise<void> {
-    const updatedConfigVars = await mergeConfigVars(this.options);
+    const { appName, variables } = this.options;
+    const updatedConfigVars = await mergeConfigVars({
+      appName,
+      variables,
+      update: true,
+    });
     if (updatedConfigVars) {
       this.logger.info(
         `Merged config vars : ${serializeConfigVars(updatedConfigVars)}.`

packages/nx-heroku/src/executors/promote/services/heroku-promote.service.ts

@@ -78,6 +78,7 @@ export class HerokuPromoteService extends HerokuBaseService<PromoteExecutorSchem
     await mergeConfigVars({
       appName,
       variables,
+      update: true,
     });
 
     this.logger.log(`Promoting app ${appName}...`);