Merge pull request #232 from rubenaeg/v4/development

🥅 Improve error handling
jovotech · Aug 27, 2021 · 6c8fa4a · 6c8fa4a
2 parents c232c1b + 1ead6b5
commit 6c8fa4a
Show file tree

Hide file tree

Showing 10 changed files with 24,931 additions and 555 deletions.
diff --git a/commands/command-build/src/commands/build.ts b/commands/command-build/src/commands/build.ts
@@ -1,4 +1,4 @@
-import { DeployEvents } from '@jovotech/cli-command-deploy';
+import { DeployCodeEvents, DeployPlatformEvents } from '@jovotech/cli-command-deploy';
 import {
  checkForProjectDirectory,
  CliFlags,
@@ -32,7 +32,7 @@ export interface BuildContext extends PluginContext {
 
 export type BuildEvents = 'before.build' | 'build' | 'after.build' | 'reverse.build';
 
-export class Build extends PluginCommand<BuildEvents | DeployEvents> {
+export class Build extends PluginCommand<BuildEvents | DeployCodeEvents | DeployPlatformEvents> {
  static id = 'build';
  static description = 'Build platform-specific language models based on jovo models folder.';
  static examples: string[] = ['jovo build --platform alexaSkill', 'jovo build --target zip'];
@@ -160,9 +160,9 @@ export class Build extends PluginCommand<BuildEvents | DeployEvents> {
 
  if (flags.deploy) {
  Log.spacer();
- await this.$emitter.run('before.deploy');
- await this.$emitter.run('deploy');
- await this.$emitter.run('after.deploy');
+ await this.$emitter.run('before.deploy:platform');
+ await this.$emitter.run('deploy:platform');
+ await this.$emitter.run('after.deploy:platform');
  }
 
  Log.spacer();

diff --git a/commands/command-deploy/src/commands/deploy.ts b/commands/command-deploy/src/commands/deploy.ts
diff --git a/commands/command-deploy/src/index.ts b/commands/command-deploy/src/index.ts
@@ -1,9 +1,7 @@
 import { JovoCliPlugin, PluginCommand, PluginType } from '@jovotech/cli-core';
-import { Deploy } from './commands/deploy';
 import { DeployCode } from './commands/deploy.code';
 import { DeployPlatform } from './commands/deploy.platform';
 
-export * from './commands/deploy';
 export * from './commands/deploy.code';
 export * from './commands/deploy.platform';
 
@@ -12,7 +10,7 @@ export class DeployCommand extends JovoCliPlugin {
  $type: PluginType = 'command';
 
  getCommands(): typeof PluginCommand[] {
- return [Deploy, DeployCode, DeployPlatform];
+ return [DeployCode, DeployPlatform];
  }
 }
 

diff --git a/commands/command-get/src/commands/get.ts b/commands/command-get/src/commands/get.ts
@@ -30,7 +30,7 @@ export interface GetContext extends PluginContext {
 
 export class Get extends PluginCommand<BuildEvents | GetEvents> {
  static id = 'get';
- static description = 'Downloads an existing platform project into the platforms folder.';
+ static description = 'Downloads an existing platform project into the build folder.';
  static examples: string[] = [
  'jovo get alexaSkill --skill-id amzn1.ask.skill.xxxxxxxx',
  'jovo get googleAction --project-id testproject-xxxxxx',

diff --git a/core/src/Project.ts b/core/src/Project.ts
@@ -1,7 +1,7 @@
 import { join as joinPaths, sep as pathSeperator } from 'path';
 import { copyFileSync, existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'fs';
 import tv4 from 'tv4';
-import { JovoModelData, ModelValidationError } from '@jovotech/model';
+import { JovoModelData } from '@jovotech/model';
 
 import { JovoCliError } from './JovoCliError';
 import { Config } from './Config';
@@ -133,7 +133,11 @@ export class Project {
  const model: JovoModelData = this.getModel(locale);
 
  if (!tv4.validate(model, validator)) {
- throw new ModelValidationError(tv4.error.message, locale, tv4.error.dataPath);
+ throw new JovoCliError({
+ message: `Validation failed for locale "${locale}"`,
+ details: tv4.error.message,
+ learnMore: tv4.error.dataPath ? `Path: ${tv4.error.dataPath}` : '',
+ });
  }
  }
 

diff --git a/core/src/Task.ts b/core/src/Task.ts
@@ -102,7 +102,7 @@ export class Task {
  throw error;
  }
 
- throw new JovoCliError(error.message);
+ throw new JovoCliError({ message: error.message });
  }
  }
  }

diff --git a/core/src/prompts.ts b/core/src/prompts.ts
@@ -1,6 +1,6 @@
 import prompt from 'prompts';
 import { ANSWER_BACKUP, ANSWER_CANCEL, ANSWER_OVERWRITE } from './constants';
-import { printUserInput } from './prints';
+import { printHighlight, printUserInput } from './prints';
 
 /**
  * Prompt if existing model files should be overwritten.
@@ -69,9 +69,36 @@ export async function promptOverwrite(message: string): Promise<{ overwrite: str
  ],
  },
  {
- onCancel(prompt, answers) {
+ onCancel(_prompt, answers) {
  answers.overwrite = ANSWER_CANCEL;
  },
  },
  );
 }
+
+export async function promptSupportedLocales(
+ locale: string,
+ platform: string,
+ supportedLocales: string[],
+): Promise<{ locales: string[] }> {
+ return await prompt(
+ {
+ name: 'locales',
+ type: 'multiselect',
+ message: `Locale ${printHighlight(
+ locale,
+ )} is not supported by ${platform}.\nPlease provide an alternative locale (type to filter, select with space):`,
+ instructions: false,
+ min: 1,
+ choices: supportedLocales.map((locale) => ({
+ title: printUserInput(locale),
+ value: locale,
+ })),
+ },
+ {
+ onCancel() {
+ process.exit();
+ },
+ },
+ );
+}
diff --git a/core/test/Project.test.ts b/core/test/Project.test.ts
@@ -230,7 +230,9 @@ describe('validateModel()', () => {
  tv4.error = { message: 'Validation failed.' };
 
  const project: Project = new Project('');
- expect(project.validateModel.bind(project, 'en', {})).toThrow('Validation failed.');
+ expect(project.validateModel.bind(project, 'en', {})).toThrow(
+ 'Validation failed for locale "en"',
+ );
  });
 
  test('should do nothing if model is valid', () => {