fix(nx-heroku): wrap parameters with double quotes

Author: getlarge

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

@@ -8,9 +8,7 @@ export async function getAddons(
 ): Promise<{ addon_service: { name: string } }[]> {
   const { stdout, stderr } = await exec(
     `heroku addons --app ${appName} --json`,
-    {
-      encoding: 'utf-8',
-    }
+    { encoding: 'utf-8' }
   );
   if (!stderr) {
     return parseJsonString(stdout);
@@ -25,7 +23,7 @@ export async function addAddon(options: {
   addonName: string;
 }) {
   const { addonAlias, addonName, appName } = options;
-  const baseCommand = `heroku addons:create ${addonName} -a ${appName}`;
+  const baseCommand = `heroku addons:create ${addonName} --app ${appName}`;
   const command = addonAlias
     ? `${baseCommand} --as ${addonAlias}`
     : baseCommand;

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

@@ -58,7 +58,7 @@ export async function appExists(options: {
 }): Promise<boolean> {
   try {
     // check if appName exists, throws an error if it doesn't
-    const { stderr } = await exec(`heroku apps:info -a ${options.appName}`, {
+    const { stderr } = await exec(`heroku apps:info --app ${options.appName}`, {
       encoding: 'utf-8',
     });
     if (stderr) {

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

@@ -14,7 +14,7 @@ export async function getConfigVars(options: {
   appName: string;
 }): Promise<Record<string, string>> {
   const { appName } = options;
-  const { stdout: configVars } = await exec(`heroku config --app=${appName}`, {
+  const { stdout: configVars } = await exec(`heroku config --app ${appName}`, {
     encoding: 'utf-8',
   });
   const rawAppEnv = parseTable(configVars) || [];
@@ -80,7 +80,7 @@ export async function setConfigVars(options: {
     // outputs variables set to stdout  key1: value1 \n key2: value2
     // outputs success message to stderr  Setting <configVars keys comma separated> and restarting ${appName}...
     const { stdout = '' } = await exec(
-      `heroku config:set --app=${appName} ${configVars.join(' ')}`
+      `heroku config:set --app ${appName} ${configVars.join(' ')}`
     );
     const updatedConfigVarsMatrix = stdout
       .trim()

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

@@ -15,9 +15,12 @@ export async function getDrains(appName: string): Promise<
     url: string;
   }[]
 > {
-  const { stdout, stderr } = await exec(`heroku drains -a ${appName} --json`, {
-    encoding: 'utf-8',
-  });
+  const { stdout, stderr } = await exec(
+    `heroku drains --app ${appName} --json`,
+    {
+      encoding: 'utf-8',
+    }
+  );
   if (stderr) {
     logger.warn(HerokuError.cleanMessage(stderr));
     return [];
@@ -47,7 +50,7 @@ export async function addDrain(options: {
     return 'found';
   }
   // output success to stdout:  Successfully added drain ${drain.url}
-  const { stderr } = await exec(`heroku drains:add ${url} -a ${appName}`);
+  const { stderr } = await exec(`heroku drains:add ${url} --app ${appName}`);
   if (stderr) {
     throw new HerokuError(stderr);
   }

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

@@ -17,9 +17,10 @@ export async function getMembers(appName: string): Promise<
     privileges: { name: string; description: string }[];
   }[]
 > {
-  const { stdout, stderr } = await exec(`heroku access -a ${appName} --json`, {
-    encoding: 'utf-8',
-  });
+  const { stdout, stderr } = await exec(
+    `heroku access --app ${appName} --json`,
+    { encoding: 'utf-8' }
+  );
   if (stderr && !stdout) {
     throw new HerokuError(stderr);
   }
@@ -46,7 +47,7 @@ export async function addMember(options: {
   } else {
     // success message is sent to stderr : Adding ${serviceUser} access to the app ${appName}
     await exec(
-      `heroku access:add ${serviceUser} -a ${appName} -p ${permissions}`
+      `heroku access:add ${serviceUser} --app ${appName} --permissions "${permissions}"`
     );
     return 'created';
   }

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

@@ -7,7 +7,7 @@ import { HerokuError } from './error';
 export async function getWebhooks(
   appName: string
 ): Promise<{ id: string; url: string; include: string; level: string }[]> {
-  const { stdout, stderr } = await exec(`heroku webhooks -a ${appName}`, {
+  const { stdout, stderr } = await exec(`heroku webhooks --app ${appName}`, {
     encoding: 'utf-8',
   });
   if (stderr) {
@@ -47,11 +47,15 @@ export async function addWebhook(options: {
   const include = webhook.include.join(',');
   const webhooks = await getWebhooks(appName);
   const sameWebhookEndpoint = webhooks.find((hook) => hook.url === url);
+
+  const baseCommandParameters = `--app ${appName} --url ${url} --include "${include}" --level ${level}`;
+  const commandParameters = secret
+    ? `${baseCommandParameters} --secret "${secret}"`
+    : baseCommandParameters;
+
   if (!sameWebhookEndpoint) {
     // output success to stderr : Adding webhook to ${appName}... done
-    await exec(
-      `heroku webhooks:add -u ${url} -i ${include} -l ${level} -s ${secret} -a ${appName}`
-    );
+    await exec(`heroku webhooks:add ${commandParameters}`);
     return 'created';
   } else if (
     sameWebhookEndpoint.id &&
@@ -60,7 +64,7 @@ export async function addWebhook(options: {
   ) {
     // output success to stderr : Updating webhook ${sameWebhookEndpoint.id} for ${appName}... done
     await exec(
-      `heroku webhooks:update ${sameWebhookEndpoint.id} -u ${url} -i ${include} -l ${level} -s ${secret} -a ${appName}`
+      `heroku webhooks:update ${sameWebhookEndpoint.id} ${commandParameters}`
     );
     return 'updated';
   }

packages/nx-heroku/src/executors/deploy/schema.json

@@ -92,7 +92,7 @@
         },
         "include": {
           "type": "array",
-          "description": "The subscription scope",
+          "description": "The subscription entities, https://devcenter.heroku.com/articles/app-webhooks#subscribing-to-webhooks-via-the-heroku-cli",
           "items": {
             "type": "string",
             "enum": [
@@ -120,7 +120,7 @@
           "description": "Webhook secret to override the one autogenerated by Heroku during webhook registration"
         }
       },
-      "required": ["url", "include", "level", "secret"]
+      "required": ["url", "include", "level"]
     },
     "drain": {
       "description": "Log drain to register on Heroku, see https://devcenter.heroku.com/articles/log-drains",

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

@@ -112,16 +112,19 @@ class HerokuApp {
       context.nxJsonConfiguration?.workspaceLayout?.appsDir || 'apps';
   }
 
-  private async addAndCommit(
+  private async addAndCommitFile(
     projectName: string,
-    pattern: string
+    fileName: string
   ): Promise<void> {
     try {
-      //? allow custom commit message
+      //? allow custom commit message with format from 'util'
+      // const COMMIT_MESSAGE_TEMPLATE = '%s(%s): %s';
+      // format(COMMIT_MESSAGE_TEMPLATE, conf.type, conf.scope, conf.message);
+      const path = `${this.appsDir}/${projectName}/${fileName}`;
       await exec(
-        `git add ${pattern} && git commit -m "ci(${projectName}): add ${pattern}" -n --no-gpg-sign`
+        `git add ${path} && git commit -m "ci(${projectName}): add ${fileName}" -n --no-gpg-sign`
       );
-      this.logger.info(`Wrote ${pattern} with custom configuration.`);
+      this.logger.info(`Wrote ${path} with custom configuration.`);
     } catch (error) {
       const ex = error as ExecException;
       // there is (probably) nothing to commit
@@ -136,7 +139,7 @@ class HerokuApp {
     if (procfile) {
       const procfilePath = `${this.appsDir}/${projectName}/${PROCFILE}`;
       await writeFile(join(process.cwd(), procfilePath), procfile);
-      await this.addAndCommit(projectName, PROCFILE);
+      await this.addAndCommitFile(projectName, PROCFILE);
     }
   }
 
@@ -157,7 +160,7 @@ class HerokuApp {
       if (destBuildPackFile === srcBuildPackFile) return;
 
       await writeFile(destPath, srcBuildPackFile);
-      await this.addAndCommit(projectName, buildPackFile);
+      await this.addAndCommitFile(projectName, buildPackFile);
     }
   }
 
@@ -325,10 +328,14 @@ class HerokuApp {
       args.push('--force');
     }
 
-    const push = spawn('git', args, { signal });
-    //? if data contains `Everything up-to-date`, should we still restart the app
+    console.warn({
+      cwd: process.cwd(),
+      cwd2: this.context.cwd,
+    });
+    const push = spawn('git', args, { signal, cwd: this.context.cwd });
     push.stdout
       .setEncoding('utf-8')
+      //? if data contains `Everything up-to-date`, should we still restart the app ?
       .on('data', (data) => this.logger.info(data?.trim()));
 
     push.stderr