fix(cli): ensure fatal errors set process exit code to 1

packages/cli/src/cli/base.cli.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { Env, LogConfig } from '@basemaps/shared';
+import { Env, LogConfig, LoggerFatalError } from '@basemaps/shared';
 import { GitTag } from '@basemaps/shared/build/cli/git.tag';
 import { CommandLineParser } from '@rushstack/ts-command-line';
 import { PrettyTransform } from 'pretty-json-log';
@@ -57,7 +57,11 @@ export abstract class BaseCommandLine extends CommandLineParser {
 
     public run(): void {
         this.executeWithoutErrorHandling().catch((err) => {
-            LogConfig.get().fatal({ err }, 'Failed to run command');
+            if (err instanceof LoggerFatalError) {
+                LogConfig.get().fatal(err.obj, err.message);
+            } else {
+                LogConfig.get().fatal({ err }, 'Failed to run command');
+            }
             process.exit(1);
         });
     }

packages/cli/src/cli/cogify/action.cog.ts

@@ -1,4 +1,4 @@
-import { Env, FileOperator, LogConfig, LogType, ProjectionTileMatrixSet } from '@basemaps/shared';
+import { Env, FileOperator, LogConfig, LoggerFatalError, ProjectionTileMatrixSet } from '@basemaps/shared';
 import {
     CommandLineAction,
     CommandLineFlagParameter,
@@ -8,8 +8,8 @@ import {
 import { createReadStream, promises as fs } from 'fs';
 import { FeatureCollection } from 'geojson';
 import { buildCogForName } from '../../cog/cog';
-import { Cutline } from '../../cog/cutline';
 import { CogVrt } from '../../cog/cog.vrt';
+import { Cutline } from '../../cog/cutline';
 import { CogJob } from '../../cog/types';
 import { GdalCogBuilder } from '../../gdal/gdal';
 import { CliId, CliInfo } from '../base.cli';
@@ -30,16 +30,15 @@ export class ActionCogCreate extends CommandLineAction {
         });
     }
 
-    getName(job: CogJob, logger: LogType): string | null {
+    getName(job: CogJob): string | null {
         const batchIndex = Env.getNumber(Env.BatchIndex, -1);
         if (batchIndex > -1) {
             const { name } = job.files[batchIndex];
             if (name == null) {
-                logger.fatal(
+                throw new LoggerFatalError(
                     { cogIndex: batchIndex, tileMax: job.files.length - 1 },
                     'Failed to find cog name from batch index',
                 );
-                return null;
             }
             return name;
         }
@@ -48,15 +47,19 @@ export class ActionCogCreate extends CommandLineAction {
         if (cogIndex != null) {
             const { name } = job.files[cogIndex];
             if (name == null) {
-                logger.fatal({ cogIndex, tileMax: job.files.length - 1 }, 'Failed to find cog name from index');
-                return null;
+                throw new LoggerFatalError(
+                    { cogIndex, tileMax: job.files.length - 1 },
+                    'Failed to find cog name from index',
+                );
             }
             return name;
         }
         const name = this.name?.value;
         if (name == null || !job.files.find((r) => r.name === name)) {
-            logger.fatal({ name, names: job.files.map((r) => r.name).join(', ') }, 'Name does not exist inside job');
-            return null;
+            throw new LoggerFatalError(
+                { name, names: job.files.map((r) => r.name).join(', ') },
+                'Name does not exist inside job',
+            );
         }
         return name;
     }
@@ -69,8 +72,7 @@ export class ActionCogCreate extends CommandLineAction {
 
         const jobVersion = SemVer.compare(job.generated?.version ?? '', CliInfo.version);
         if (jobVersion !== 0) {
-            LogConfig.get().fatal({ jobInfo: job.generated, cli: CliInfo }, 'Version mismatch');
-            return;
+            throw new LoggerFatalError({ jobInfo: job.generated, cli: CliInfo }, 'Version mismatch');
         }
 
         const isCommit = this.commit?.value ?? false;
@@ -81,7 +83,7 @@ export class ActionCogCreate extends CommandLineAction {
         const gdalVersion = await GdalCogBuilder.getVersion(logger);
         logger.info({ version: gdalVersion }, 'GdalVersion');
 
-        const name = this.getName(job, logger);
+        const name = this.getName(job);
         if (name == null) {
             return;
         }

packages/cli/src/cog/builder.ts

@@ -1,5 +1,11 @@
 import { Epsg, GeoJson, Bounds } from '@basemaps/geo';
-import { CompositeError, FileOperatorSimple, LogType, ProjectionTileMatrixSet } from '@basemaps/shared';
+import {
+    CompositeError,
+    FileOperatorSimple,
+    LogType,
+    ProjectionTileMatrixSet,
+    LoggerFatalError,
+} from '@basemaps/shared';
 import { CogSource, CogTiff, TiffTag, TiffTagGeo } from '@cogeotiff/core';
 import { CogSourceFile } from '@cogeotiff/source-file';
 import { createHash } from 'crypto';
@@ -170,8 +176,10 @@ export class CogBuilder {
         const noDataNum = parseInt(noData);
 
         if (isNaN(noDataNum) || noDataNum < 0 || noDataNum > 256) {
-            this.logger.fatal({ tiff: tiff.source.name, noData }, 'Failed converting GDAL_NODATA, defaulting to 255');
-            throw new Error(`Invalid GDAL_NODATA: ${noData}`);
+            throw new LoggerFatalError(
+                { tiff: tiff.source.name, noData },
+                'Failed converting GDAL_NODATA, defaulting to 255',
+            );
         }
 
         return noDataNum;

packages/shared/src/index.ts

@@ -8,6 +8,7 @@ export { tileFromPath, TileType, TileData, TileDataWmts, TileDataXyz } from './a
 export { V, VNode, VNodeElement, VNodeText } from './vdom';
 export { VNodeParser } from './vdom.parse';
 export { CompositeError } from './composite.error';
+export { LoggerFatalError } from './logger.fatal.error';
 export * from './tms/projection.tile.matrix.set';
 
 export * from './aws/tile.metadata.base';

packages/shared/src/logger.fatal.error.ts

@@ -0,0 +1,10 @@
+/**
+ * Utility error to throw expecting that Logger will fatal log its contents
+ */
+export class LoggerFatalError extends Error {
+    obj: Record<string, unknown>;
+    constructor(obj: Record<string, unknown>, msg: string) {
+        super(msg);
+        this.obj = obj;
+    }
+}