refactor: cleanup error handling

Author: JohannesHoppe

src/angular-cli-ghpages

@@ -6,8 +6,9 @@ var path = require('path'),
   pjson = require('./package.json'),
   commander = require('commander');
 
-// unfortunately defaults-file is ignored for --no-silent & --no-dotfiles
-// according to PR it should work (https://github.com/tj/commander.js/issues/928) but it's still completely foobar!?!
+// defaults-file was ignored for --no-silent & --no-dotfiles, so it is not used here
+// TODO: review https://github.com/tj/commander.js/issues/928 and check again if it now works
+// (this is not a big problem, because true is currently the desired value and this is also the value in the defaults file)
 commander
   .version(pjson.version)
   .description(pjson.description)
@@ -74,5 +75,7 @@ var consoleLogger = {
 var dir = path.join(process.cwd(), commander.dir);
 
 engine.run(dir, commander, consoleLogger).catch(function(error) {
+  consoleLogger.error('❌ An error occurred when trying to deploy:');
+  consoleLogger.error(error.message);
   process.exit(1);
 });

src/deploy/actions.ts

@@ -48,7 +48,7 @@ export default async function deploy(
     const buildResult = await build.result;
 
     if (!buildResult.success) {
-      throw new Error(buildResult.error);
+      throw new Error("Error while building the app.");
     }
   }
 

src/deploy/builder.ts

@@ -16,46 +16,47 @@ import { Schema } from './schema';
 // createJobHandler() but add typings specific to Architect Builders.
 export default createBuilder<any>(
   async (options: Schema, context: BuilderContext): Promise<BuilderOutput> => {
-    // The project root is added to a BuilderContext.
-    const root = normalize(context.workspaceRoot);
-    const workspace = new experimental.workspace.Workspace(
-      root,
-      new NodeJsSyncHost()
-    );
-    await workspace
-      .loadWorkspaceFromHost(normalize('angular.json'))
-      .toPromise();
+    try {
+      // The project root is added to a BuilderContext.
+      const root = normalize(context.workspaceRoot);
+      const workspace = new experimental.workspace.Workspace(
+        root,
+        new NodeJsSyncHost()
+      );
+      await workspace
+        .loadWorkspaceFromHost(normalize('angular.json'))
+        .toPromise();
 
-    if (!context.target) {
-      throw new Error('Cannot deploy the application without a target');
-    }
+      if (!context.target) {
+        throw new Error('Cannot deploy the application without a target');
+      }
 
-    const targets = workspace.getProjectTargets(context.target.project);
+      const targets = workspace.getProjectTargets(context.target.project);
 
-    if (
-      !targets ||
-      !targets.build ||
-      !targets.build.options ||
-      !targets.build.options.outputPath
-    ) {
-      throw new Error('Cannot find the project output directory');
-    }
+      if (
+        !targets ||
+        !targets.build ||
+        !targets.build.options ||
+        !targets.build.options.outputPath
+      ) {
+        throw new Error('Cannot find the project output directory');
+      }
 
-    const isWin = os.platform() === 'win32';
-    const workspaceRoot = !isWin
-      ? workspace.root
-      : asWindowsPath(workspace.root);
+      const isWin = os.platform() === 'win32';
+      const workspaceRoot = !isWin
+        ? workspace.root
+        : asWindowsPath(workspace.root);
 
-    try {
       await deploy(
         engine,
         context,
         path.join(workspaceRoot, targets.build.options.outputPath),
         options
       );
     } catch (e) {
-      context.logger.error('Error when trying to deploy:', e);
-      console.error(e);
+
+      context.logger.error('❌ An error occurred when trying to deploy:');
+      context.logger.error(e.message);
       return { success: false };
     }
 

src/engine/engine.ts

@@ -23,7 +23,6 @@ export async function run(
     ghpages.clean();
   }
 
-  try {
     await checkIfDistFolderExists(dir);
     await createNotFoundPage(dir, options, logger);
     await createCnameFile(dir, options, logger);
@@ -32,10 +31,6 @@ export async function run(
     logger.info(
       '🚀 Successfully published via angular-cli-ghpages! Have a nice day!'
     );
-  } catch (error) {
-    logger.error('❌ An error occurred!');
-    throw error;
-  }
 }
 
 export function prepareOptions(origOptions: Schema, logger: logging.LoggerApi) {
@@ -138,9 +133,6 @@ async function createNotFoundPage(
   const indexHtml = path.join(dir, 'index.html');
   const notFoundPage = path.join(dir, '404.html');
 
-  // console.log('***', indexHtml)
-  // console.log('***', notFoundPage)
-
   try {
     return await fse.copy(indexHtml, notFoundPage);
   } catch (err) {
@@ -150,7 +142,7 @@ async function createNotFoundPage(
     logger.info(
       '(Hint: are you sure that you have setup the directory correctly?)'
     );
-    logger.debug('Diagnostic info', err);
+    logger.debug('Diagnostic info: ' + err.message);
     return;
   }
 }
@@ -176,8 +168,7 @@ async function createCnameFile(
     await fse.writeFile(cnameFile, options.cname);
     logger.info('CNAME file created');
   } catch (err) {
-    logger.error('CNAME file could not be created. Stopping execution.');
-    throw err;
+    throw new Error('CNAME file could not be created. ' + err.message);
   }
 }
 

src/interfaces.ts

@@ -1,4 +1,4 @@
 export interface GHPages {
-  publish(dir: string, options: any): Promise<any>;
+  publish(dir: string, options: any, callback: (error: any) => void);
   clean?(): void;
 }