Fix: handles exceptions when tracking events (fixes #14)

kontent-ai · Oct 16, 2024 · 28f3ea9 · 28f3ea9
1 parent 89a39c2
commit 28f3ea9
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 18 deletions.
diff --git a/lib/core/utils/global.utils.ts b/lib/core/utils/global.utils.ts
@@ -1,7 +1,10 @@
-import { format } from 'bytes';
 import { ITrackingEventData, getTrackingService } from '@kontent-ai-consulting/tools-analytics';
 import { isBrowser, isNode, isWebWorker } from 'browser-or-node';
+import { format } from 'bytes';
+import { getDefaultLogger } from '../logs/loggers.js';
 import { EnvContext } from '../models/core.models.js';
+import { Logger } from '../models/log.models.js';
+import { extractErrorData } from './error.utils.js';
 
 export type Writeable<T> = { -readonly [P in keyof T]: T[P] };
 
@@ -35,25 +38,58 @@ export const defaultZipFilename: string = 'data.zip';
 export async function executeWithTrackingAsync<TResult>(data: {
     func: () => Promise<TResult extends void ? void : Readonly<TResult>>;
     event: Readonly<ITrackingEventData>;
+    logger?: Logger;
 }): Promise<TResult extends void ? void : Readonly<TResult>> {
     const trackingService = getTrackingService();
-    const event = await trackingService.trackEventAsync(data.event);
+    const logger = data.logger ?? getDefaultLogger();
+
+    const event = await runTrackingFuncWithErrorHadlingAsync({
+        func: async () => {
+            return await trackingService.trackEventAsync(data.event);
+        },
+        logger: logger
+    });
 
     try {
         const result = await data.func();
 
-        await trackingService.setEventResultAsync({
-            eventId: event.eventId,
-            result: 'success'
-        });
+        if (event) {
+            await runTrackingFuncWithErrorHadlingAsync({
+                func: async () => {
+                    await trackingService.setEventResultAsync({
+                        eventId: event.eventId,
+                        result: 'success'
+                    });
+                },
+                logger: logger
+            });
+        }
 
         return result;
     } catch (error) {
-        await trackingService.setEventResultAsync({
-            eventId: event.eventId,
-            result: 'fail'
-        });
+        if (event) {
+            await runTrackingFuncWithErrorHadlingAsync({
+                func: async () => {
+                    await trackingService.setEventResultAsync({
+                        eventId: event.eventId,
+                        result: 'fail'
+                    });
+                },
+                logger: logger
+            });
+        }
 
         throw error;
     }
 }
+
+async function runTrackingFuncWithErrorHadlingAsync<T>(data: { func: () => Promise<T>; logger: Logger }): Promise<T | void> {
+    try {
+        return await data.func();
+    } catch (trackingError) {
+        data.logger.log({
+            message: `Failed to track event. ${extractErrorData(trackingError).message}`,
+            type: 'warning'
+        });
+    }
+}
diff --git a/lib/toolkit/export.ts b/lib/toolkit/export.ts
@@ -1,6 +1,6 @@
-import { libMetadata } from '../metadata.js';
 import { MigrationData, executeWithTrackingAsync } from '../core/index.js';
 import { ExportConfig, exportManager } from '../export/index.js';
+import { libMetadata } from '../metadata.js';
 
 export async function exportAsync(config: ExportConfig): Promise<MigrationData> {
     return await executeWithTrackingAsync({
@@ -16,6 +16,7 @@ export async function exportAsync(config: ExportConfig): Promise<MigrationData>
         },
         func: async () => {
             return await exportManager(config).exportAsync();
-        }
+        },
+        logger: config.logger
     });
 }
diff --git a/lib/toolkit/file.ts b/lib/toolkit/file.ts
@@ -38,7 +38,8 @@ export async function storeAsync(config: StoreConfig): Promise<void> {
             } else {
                 throw Error(`Cannot store '${filename}' on File system because the provided zip is not a Buffer`);
             }
-        }
+        },
+        logger: config.logger
     });
 }
 
@@ -60,6 +61,7 @@ export async function extractAsync(config: ExtractConfig): Promise<MigrationData
         func: async () => {
             const fileData = await fileManager(logger).loadFileAsync(filename);
             return await zipManager(logger).parseZipAsync(fileData);
-        }
+        },
+        logger: config.logger
     });
 }
diff --git a/lib/toolkit/import.ts b/lib/toolkit/import.ts
@@ -16,6 +16,7 @@ export async function importAsync(config: ImportConfig): Promise<ImportResult> {
         },
         func: async () => {
             return await importManager(config).importAsync();
-        }
+        },
+        logger: config.logger
     });
 }
diff --git a/lib/toolkit/migrate.ts b/lib/toolkit/migrate.ts
@@ -1,4 +1,3 @@
-import { libMetadata } from '../metadata.js';
 import { IRetryStrategyOptions } from '@kontent-ai/core-sdk';
 import {
     ExternalIdGenerator,
@@ -9,9 +8,10 @@ import {
     getDefaultLogger
 } from '../core/index.js';
 import { SourceExportItem } from '../export/index.js';
+import { ImportResult } from '../import/index.js';
+import { libMetadata } from '../metadata.js';
 import { exportAsync } from './export.js';
 import { importAsync } from './import.js';
-import { ImportResult } from '../import/index.js';
 
 export interface MigrationSource extends ManagementClientConfig {
     readonly items: readonly SourceExportItem[];
@@ -64,6 +64,7 @@ export async function migrateAsync(config: MigrationConfig): Promise<MigrationRe
                 importResult,
                 migrationData
             };
-        }
+        },
+        logger: config.logger
     });
 }