@hubspot/cli 5.2.1-beta.3 → 5.2.1-beta.5

package/commands/feedback.js

@@ -1,7 +1,7 @@
 const open = require('open');
 
 const { i18n } = require('../lib/lang');
-const { FEEDBACK_OPTIONS, FEEDBACK_URLS } = require('../lib/constants');
+const { FEEDBACK_URLS } = require('../lib/constants');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 
 const {
@@ -22,10 +22,8 @@ exports.handler = async options => {
   const { shouldOpen } = await shouldOpenBrowserPrompt(type, usedTypeFlag);
 
   if (shouldOpen || usedTypeFlag) {
-    const url =
-      type === FEEDBACK_OPTIONS.BUG || bugFlag
-        ? FEEDBACK_URLS.BUG
-        : FEEDBACK_URLS.GENERAL;
+    // NOTE: for now, all feedback should go to the hubspot-cli repository
+    const url = FEEDBACK_URLS.BUG;
     open(url, { url: true });
     logger.success(i18n(`${i18nKey}.success`, { url }));
   }

package/commands/project/dev.js

@@ -79,8 +79,8 @@ exports.handler = async options => {
 
   const components = await findProjectComponents(projectDir);
   const componentTypes = getProjectComponentTypes(components);
-  const hasPrivateApps = componentTypes[COMPONENT_TYPES.privateApp];
-  const hasPublicApps = componentTypes[COMPONENT_TYPES.publicApp];
+  const hasPrivateApps = !!componentTypes[COMPONENT_TYPES.privateApp];
+  const hasPublicApps = !!componentTypes[COMPONENT_TYPES.publicApp];
 
   if (hasPrivateApps && hasPublicApps) {
     logger.error(i18n(`${i18nKey}.errors.invalidProjectComponents`));
@@ -178,7 +178,7 @@ exports.handler = async options => {
     targetProjectAccountId = accountId;
   }
 
-  const { projectExists, project } = await ensureProjectExists(
+  let { projectExists, project } = await ensureProjectExists(
     targetProjectAccountId,
     projectConfig.name,
     {
@@ -199,7 +199,7 @@ exports.handler = async options => {
       project.sourceIntegration &&
       project.sourceIntegration.source === 'GITHUB';
   } else {
-    await createNewProjectForLocalDev(
+    project = await createNewProjectForLocalDev(
       projectConfig,
       targetProjectAccountId,
       createNewSandbox,
@@ -221,7 +221,9 @@ exports.handler = async options => {
     parentAccountId: targetProjectAccountId,
     projectConfig,
     projectDir,
+    projectId: project.id,
     targetAccountId: targetTestingAccountId,
+    env,
   });
 
   await LocalDev.start();

package/commands/project/upload.js

@@ -93,7 +93,7 @@ exports.handler = async options => {
       uiLine();
       logFeedbackMessage(result.buildId);
 
-      displayWarnLogs(accountId, projectConfig.name, result.buildId);
+      await displayWarnLogs(accountId, projectConfig.name, result.buildId);
       process.exit(EXIT_CODES.SUCCESS);
     }
   } catch (e) {

package/lang/en.lyaml

@@ -648,7 +648,7 @@ en:
             bug:
               describe: "Open Github issues in your browser to report a bug."
             general:
-              describe: "Open the projects feedback form in your browser."
+              describe: "Open Github issues in your browser to give feedback."
     remove:
       describe: "Delete a file or folder from HubSpot."
       deleted: "Deleted \"{{ path }}\" from account {{ accountId }}"
@@ -917,7 +917,7 @@ en:
       noCompatibleComponents: "Skipping call to {{ serverKey }} because there are no compatible components in the project."
     LocalDevManager:
       failedToInitialize: "Missing required arguments to initialize Local Dev"
-      noDeployedBuild: "There is no deployed build for this project in {{ accountIdentifier }}. Run {{ uploadCommand }} to upload and deploy your project."
+      noDeployedBuild: "Your project {{#bold}}{{ projectName }}{{/bold}} exists in {{ accountIdentifier }}, but has no deployed build. Projects must be successfully deployed to be developed locally. Address any build and deploy errors your project may have, then run {{ uploadCommand }} to upload and deploy your project."
       noComponents: "There are no components in this project."
       noRunnableComponents: "No supported components were found under {{#bold}}{{ projectSourceDir }}{{/bold}}. Run {{ command }} to see a list of available components."
       betaMessage: "HubSpot projects local development"
@@ -927,16 +927,24 @@ en:
       exitingStart: "Stopping local dev server ..."
       exitingSucceed: "Successfully exited"
       exitingFail: "Failed to cleanup before exiting"
+      missingUid: "Could not find a uid for the selected app. Confirm that the app config file contains the uid field and re-run {{ devCommand }}."
       uploadWarning:
         appLabel: "[App]"
         uiExtensionLabel: "[UI Extension]"
         missingComponents: "Couldn't find the following components in the deployed build for this project: {{#bold}}'{{ missingComponents }}'{{/bold}}. This may cause issues in local development."
         defaultWarning: "Changing project configuration requires a new project build."
+        defaultPublicAppWarning: "Changing project configuration requires a new project build. This will affect existing users of your public app. If your app has users in production, we strongly recommend creating a copy of this app to test your changes before proceding."
         header: "{{ warning }} To reflect these changes and continue testing:"
         stopDev: "  * Stop {{ command }}"
         runUpload: "  * Run {{ command }}"
         restartDev: "  * Re-run {{ command }}"
         pushToGithub: "  * Commit and push your changes to GitHub"
+      activeInstallWarning:
+        installCount: "{{#bold}}The app {{ appName }} has {{ installCount }} production installs{{/bold}}"
+        genericHeader: "{{#bold}}Local development can affect existing installs of your public app.{{/bold}}"
+        genericExplanation: "Some changes made during local development may need to be synced to HubSpot, which will impact users with existing installs. You will always be asked to confirm these changes before uploading them. If your app has any production installs, we strongly recommend creating a copy of this app to develop on instead."
+        explanation: "Some changes made during local development may need to be synced to HubSpot, which will impact those existing installs. We strongly recommend creating a copy of this app to use instead."
+        confirmation: "You will always be asked to confirm any permanent changes to your app’s configuration before uploading them."
       devServer:
         cleanupError: "Failed to cleanup local dev server: {{ message }}"
         setupError: "Failed to setup local dev server: {{ message }}"
@@ -950,7 +958,7 @@ en:
       suggestRecommendedNestedAccount:
         nonSandboxWarning: "Testing in a sandbox is strongly recommended. To switch the target account, select an option below or run {{#bold}}`hs accounts use`{{/bold}} before running the command again."
         publicAppNonDeveloperTestAccountWarning: "Local development of public apps is only supported in {{#bold}}developer test accounts{{/bold}}."
-        privateAppNonDeveloperTestAccountWarning: "Local development of private apps is only supported in {{#bold}}developer test accounts{{/bold}}"
+        privateAppInAppDeveloperAccountError: "Local development of private apps is not supported in {{#bold}}app developer accounts{{/bold}}"
       createNewProjectForLocalDev:
         projectMustExistExplanation: "The project {{ projectName }} does not exist in the target account {{ accountIdentifier}}. This command requires the project to exist in the target account."
         publicAppProjectMustExistExplanation: "The project {{ projectName }} does not exist in {{ accountIdentifier}}, the app developer account associated with your target account. This command requires the project to exist in this app developer account."
@@ -1216,7 +1224,7 @@ en:
           bug: "[--bug] Report a bug"
           general: "[--general] Tell us about your experience with HubSpot's developer tools"
         bugPrompt: "Create an issue on Github in your browser?"
-        generalPrompt: "Open the projects feedback form in your browser?"
+        generalPrompt: "Create an issue on Github in your browser?"
       buildIdPrompt:
         enterBuildId: "[--build] Deploy which build?"
         errors:
@@ -1231,6 +1239,10 @@ en:
           destRequired: "You must specify a destination directory."
       cleanUploadPrompt:
         message: "You are about to remove any remote files in \"{{ filePath }}\" on HubSpot account {{ accountId }} that don't exist locally. Are you sure you want to do this?"
+      installPublicAppPrompt:
+        explanation: "Local development requires this app to be installed in the target test account"
+        prompt: "Open hubspot.com to install this app?"
+        decline: "To continue local development of this app, install it in your target test account and re-run {{#bold}}`hs project dev`{{/bold}}"
     convertFields:
       positionals:
         src:

package/lib/LocalDevManager.js

@@ -4,6 +4,12 @@ const chalk = require('chalk');
 const { i18n } = require('./lang');
 const { handleKeypress } = require('./process');
 const { logger } = require('@hubspot/local-dev-lib/logger');
+const {
+  fetchAppInstallationData,
+} = require('@hubspot/local-dev-lib/api/localDevAuth');
+const {
+  fetchPublicAppsForPortal,
+} = require('@hubspot/local-dev-lib/api/appsDev');
 const {
   getAccountId,
   getConfigDefaultAccount,
@@ -26,6 +32,8 @@ const {
   uiLink,
   uiLine,
 } = require('./ui');
+const { logErrorInstance } = require('./errorHandlers/standardErrors');
+const { installPublicAppPrompt } = require('./prompts/installPublicAppPrompt');
 
 const WATCH_EVENTS = {
   add: 'add',
@@ -44,6 +52,7 @@ class LocalDevManager {
 
     this.projectConfig = options.projectConfig;
     this.projectDir = options.projectDir;
+    this.projectId = options.projectId;
     this.debug = options.debug || false;
     this.deployedBuild = options.deployedBuild;
     this.isGithubLinked = options.isGithubLinked;
@@ -51,6 +60,8 @@ class LocalDevManager {
     this.uploadWarnings = {};
     this.runnableComponents = this.getRunnableComponents(options.components);
     this.activeApp = null;
+    this.activePublicAppData = null;
+    this.env = options.env;
 
     this.projectSourceDir = path.join(
       this.projectDir,
@@ -84,10 +95,57 @@ class LocalDevManager {
     return components.filter(component => component.runnable);
   }
 
-  async setActiveApp(app) {
-    this.activeApp = app;
+  async setActiveApp(appUid) {
+    if (!appUid) {
+      logger.error(
+        i18n(`${i18nKey}.missingUid`, {
+          devCommand: uiCommandReference('hs project dev'),
+        })
+      );
+      process.exit(EXIT_CODES.ERROR);
+    }
+    this.activeApp = this.runnableComponents.find(component => {
+      return component.config.uid === appUid;
+    });
 
-    // TODO: Show the install warnings the first time this gets set
+    if (this.activeApp.type === COMPONENT_TYPES.publicApp) {
+      try {
+        await this.setActivePublicAppData();
+        await this.checkActivePublicAppInstalls();
+        await this.checkPublicAppInstallation();
+      } catch (e) {
+        logErrorInstance(e);
+      }
+    }
+  }
+
+  async setActivePublicAppData() {
+    if (!this.activeApp) {
+      return;
+    }
+
+    const portalPublicApps = await fetchPublicAppsForPortal(
+      this.targetProjectAccountId
+    );
+
+    const activePublicAppData = portalPublicApps.find(
+      ({ sourceId }) => sourceId === this.activeApp.config.uid
+    );
+
+    this.activePublicAppData = activePublicAppData;
+  }
+
+  async checkActivePublicAppInstalls() {
+    // TODO: Add check for installs once we have that info
+    if (!this.activePublicAppData) {
+      return;
+    }
+    uiLine();
+    // TODO: Replace with final copy
+
+    logger.warn(i18n(`${i18nKey}.activeInstallWarning.genericHeader`));
+    logger.log(i18n(`${i18nKey}.activeInstallWarning.genericExplanation`));
+    uiLine();
   }
 
   async start() {
@@ -98,6 +156,7 @@ class LocalDevManager {
     if (!this.deployedBuild) {
       logger.error(
         i18n(`${i18nKey}.noDeployedBuild`, {
+          projectName: this.projectConfig.name,
           accountIdentifier: uiAccountDescription(this.targetProjectAccountId),
           uploadCommand: this.getUploadCommand(),
         })
@@ -179,6 +238,32 @@ class LocalDevManager {
     process.exit(EXIT_CODES.SUCCESS);
   }
 
+  getActiveAppInstallationData() {
+    return fetchAppInstallationData(
+      this.targetAccountId,
+      this.projectId,
+      this.activeApp.config.uid,
+      this.activeApp.config.auth.requiredScopes,
+      this.activeApp.config.auth.optionalScopes
+    );
+  }
+
+  async checkPublicAppInstallation() {
+    const {
+      isInstalledWithScopeGroups: isInstalled,
+    } = await this.getActiveAppInstallationData();
+
+    if (!isInstalled) {
+      await installPublicAppPrompt(
+        this.env,
+        this.targetAccountId,
+        this.activePublicAppData.clientId,
+        this.activeApp.config.auth.requiredScopes,
+        this.activeApp.config.auth.redirectUrls
+      );
+    }
+  }
+
   updateKeypressListeners() {
     handleKeypress(async key => {
       if ((key.ctrl && key.name === 'c') || key.name === 'q') {
@@ -198,7 +283,13 @@ class LocalDevManager {
   }
 
   logUploadWarning(reason) {
-    const warning = reason || i18n(`${i18nKey}.uploadWarning.defaultWarning`);
+    let warning = reason;
+    if (!reason) {
+      warning =
+        this.activeApp.type === COMPONENT_TYPES.publicApp
+          ? i18n(`${i18nKey}.uploadWarning.defaultPublicAppWarning`)
+          : i18n(`${i18nKey}.uploadWarning.defaultWarning`);
+    }
 
     // Avoid logging the warning to the console if it is currently the most
     // recently logged warning. We do not want to spam the console with the same message.

package/lib/localDev.js

@@ -114,19 +114,20 @@ const suggestRecommendedNestedAccount = async (
   logger.log();
   uiLine();
   if (hasPublicApps) {
-    logger.warn(
+    logger.log(
       i18n(
         `${i18nKey}.suggestRecommendedNestedAccount.publicAppNonDeveloperTestAccountWarning`
       )
     );
   } else if (isAppDeveloperAccount(accountConfig)) {
-    logger.warn(
+    logger.error(
       i18n(
-        `${i18nKey}.suggestRecommendedNestedAccount.publicAppNonDeveloperTestAccountWarning`
+        `${i18nKey}.suggestRecommendedNestedAccount.privateAppInAppDeveloperAccountError`
       )
     );
+    process.exit(EXIT_CODES.ERROR);
   } else {
-    logger.warn(
+    logger.log(
       i18n(`${i18nKey}.suggestRecommendedNestedAccount.nonSandboxWarning`)
     );
   }
@@ -290,7 +291,7 @@ const useExistingDevTestAccount = async (env, account) => {
   }
   const devTestAcctConfigName = await saveDevTestAccountToConfig(env, account);
   logger.success(
-    i18n(`cli.lib.developerTestAccount.create.success.configFileUpdated`, {
+    i18n(`lib.developerTestAccount.create.success.configFileUpdated`, {
       accountName: devTestAcctConfigName,
       authType: PERSONAL_ACCESS_KEY_AUTH_METHOD.name,
     })
@@ -319,7 +320,7 @@ const createNewProjectForLocalDev = async (
     );
     logger.log();
     uiLine();
-    logger.warn(explanationString);
+    logger.log(explanationString);
     uiLine();
 
     shouldCreateProject = await confirmPrompt(
@@ -339,7 +340,7 @@ const createNewProjectForLocalDev = async (
     });
 
     try {
-      await createProject(targetAccountId, projectConfig.name);
+      const project = await createProject(targetAccountId, projectConfig.name);
       SpinniesManager.succeed('createProject', {
         text: i18n(`${i18nKey}.createNewProjectForLocalDev.createdProject`, {
           accountIdentifier: uiAccountDescription(targetAccountId),
@@ -347,6 +348,7 @@ const createNewProjectForLocalDev = async (
         }),
         succeedColor: 'white',
       });
+      return project;
     } catch (err) {
       SpinniesManager.fail('createProject');
       logger.log(
@@ -417,7 +419,7 @@ const createInitialBuildForNewProject = async (
 
     logger.log();
     failedSubTasks.forEach(failedSubTask => {
-      console.error(failedSubTask.errorMessage);
+      logger.error(failedSubTask.errorMessage);
     });
     logger.log();
 

package/lib/projects.js

@@ -893,9 +893,17 @@ const displayWarnLogs = async (
   let result;
 
   if (isDeploy) {
-    result = await fetchDeployWarnLogs(accountId, projectName, taskId);
+    try {
+      result = await fetchDeployWarnLogs(accountId, projectName, taskId);
+    } catch (e) {
+      logApiErrorInstance(e);
+    }
   } else {
-    result = await fetchBuildWarnLogs(accountId, projectName, taskId);
+    try {
+      result = await fetchBuildWarnLogs(accountId, projectName, taskId);
+    } catch (e) {
+      logApiErrorInstance(e);
+    }
   }
 
   if (result && result.logs.length) {

package/lib/prompts/installPublicAppPrompt.js

@@ -0,0 +1,42 @@
+const open = require('open');
+const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('../lang');
+const { EXIT_CODES } = require('../enums/exitCodes');
+
+const i18nKey = 'lib.prompts.installPublicAppPrompt';
+
+const installPublicAppPrompt = async (
+  env,
+  targetAccountId,
+  clientId,
+  scopes,
+  redirectUrls
+) => {
+  logger.log('');
+  logger.log(i18n(`${i18nKey}.explanation`));
+
+  const { shouldOpenBrowser } = await promptUser({
+    name: 'shouldOpenBrowser',
+    type: 'confirm',
+    message: i18n(`${i18nKey}.prompt`),
+  });
+
+  if (!shouldOpenBrowser) {
+    logger.log(i18n(`${i18nKey}.decline`));
+    process.exit(EXIT_CODES.SUCCESS);
+  }
+
+  const websiteOrigin = getHubSpotWebsiteOrigin(env);
+
+  const url =
+    `${websiteOrigin}/oauth/${targetAccountId}/authorize` +
+    `?client_id=${encodeURIComponent(clientId)}` +
+    `&scope=${encodeURIComponent(scopes)}` +
+    `&redirect_uri=${encodeURIComponent(redirectUrls)}`;
+
+  open(url);
+};
+
+module.exports = { installPublicAppPrompt };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "5.2.1-beta.3",
+  "version": "5.2.1-beta.5",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,10 +8,10 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/local-dev-lib": "1.0.1",
-    "@hubspot/serverless-dev-runtime": "5.2.1-beta.2",
-    "@hubspot/theme-preview-dev-server": "0.0.5",
-    "@hubspot/ui-extensions-dev-server": "0.8.15",
+    "@hubspot/local-dev-lib": "1.1.0",
+    "@hubspot/serverless-dev-runtime": "5.2.1-beta.4",
+    "@hubspot/theme-preview-dev-server": "0.0.6",
+    "@hubspot/ui-extensions-dev-server": "0.8.17",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "chokidar": "^3.0.1",
@@ -45,5 +45,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "70d81f550d7916e8eb80ec22ce41ac51265c9a36"
+  "gitHead": "21195f0f24e2e148f37c0320f0b31c2ebad817ff"
 }