Merge pull request #19 from DouglasNeuroInformatics/dev

chore: add onComplete callback to options

Author: joshunrau

src/meta/__tests__/build.test.ts

@@ -15,16 +15,16 @@ const { loadUserConfig, parseEntryFromFunction } = vi.hoisted(() => ({
   parseEntryFromFunction: vi.fn()
 }));
 
+const esbuildMock = {
+  build: vi.fn()
+};
+
 vi.mock('../load.js', () => ({ loadUserConfig }));
 vi.mock('../parse.js', () => ({ parseEntryFromFunction }));
 
 describe('bundle', () => {
-  const esbuild = {
-    build: vi.fn()
-  };
-
   beforeAll(() => {
-    vi.doMock('esbuild', () => esbuild);
+    vi.doMock('esbuild', () => esbuildMock);
   });
 
   afterAll(() => {
@@ -33,7 +33,7 @@ describe('bundle', () => {
 
   it('should return an error if esbuild throws', async () => {
     const cause = new Error('Something went wrong');
-    esbuild.build.mockImplementationOnce(() => {
+    esbuildMock.build.mockImplementationOnce(() => {
       throw cause;
     });
     await expect(
@@ -47,7 +47,7 @@ describe('bundle', () => {
   });
 
   it('should an ok result on success', async () => {
-    esbuild.build.mockResolvedValueOnce({});
+    esbuildMock.build.mockResolvedValueOnce({});
     const result = await bundle({
       config: { build: { outfile: 'out.js' } },
       entrySpecifier: './app.ts',
@@ -98,10 +98,12 @@ describe('buildProd', () => {
 
   it('should correctly bundle the example application as a module', { timeout: 10000 }, async () => {
     const outfile = path.join(outdir, 'module.js');
+    const onComplete = vi.fn();
     loadUserConfig.mockReturnValue(
       okAsync({
         build: {
           mode: 'module',
+          onComplete,
           outfile
         },
         entry: vi.fn(),
@@ -118,5 +120,35 @@ describe('buildProd', () => {
     const appContainer = await import(outfile).then((module) => module.default as AppContainer);
     const app = appContainer.getApplicationInstance();
     expect(app).toBeDefined();
+    expect(onComplete).toHaveBeenCalledOnce();
+  });
+
+  it('should handle errors in the onComplete callback', async () => {
+    vi.doMock('esbuild', () => esbuildMock);
+    const callbackError = new Error('Something went wrong');
+    const onComplete = vi.fn().mockImplementation(() => {
+      throw callbackError;
+    });
+    loadUserConfig.mockReturnValue(
+      okAsync({
+        build: {
+          mode: 'module',
+          onComplete,
+          outfile: '/dev/null'
+        },
+        entry: vi.fn()
+      } satisfies UserConfigOptions)
+    );
+    parseEntryFromFunction.mockReturnValueOnce(ok('./example/app.js'));
+    const result = await buildProd({ configFile });
+    expect(result.isErr()).toBe(true);
+    expect(result).toMatchObject({
+      error: {
+        cause: callbackError,
+        message: 'An error occurred in the user-specified `onComplete` callback'
+      }
+    });
+    expect(onComplete).toHaveBeenCalledOnce();
+    vi.doUnmock('esbuild');
   });
 });

src/meta/build.ts

@@ -65,11 +65,26 @@ export const bundle = fromAsyncThrowable(
 export function buildProd({ configFile }: { configFile: string }): ResultAsync<void, typeof RuntimeException.Instance> {
   return loadUserConfig(configFile).andThen((config) => {
     return parseEntryFromFunction(config.entry).asyncAndThen((entrySpecifier) => {
-      return bundle({
+      const result = bundle({
         config,
         entrySpecifier,
         resolveDir: path.dirname(configFile)
       });
+      const { onComplete } = config.build;
+      if (onComplete) {
+        const callback = fromAsyncThrowable(
+          async () => {
+            await onComplete();
+          },
+          (err) => {
+            return new RuntimeException('An error occurred in the user-specified `onComplete` callback', {
+              cause: err
+            });
+          }
+        );
+        return result.andThen(callback);
+      }
+      return result;
     });
   });
 }

src/meta/load.ts

@@ -18,6 +18,7 @@ const $UserConfigOptions: z.ZodType<UserConfigOptions> = z.object({
   build: z.object({
     esbuildOptions: z.record(z.any()).optional(),
     mode: z.enum(['module', 'server']).optional(),
+    onComplete: z.function().returns(z.any()).optional(),
     outfile: z.string().min(1)
   }),
   entry: $EntryFunction,

src/user-config.ts

@@ -19,6 +19,8 @@ export type UserConfigOptions = {
      * @default 'server'
      */
     mode?: 'module' | 'server';
+    /** A callback function to invoke when the build is complete */
+    onComplete?: () => Promisable<void>;
     /** The path where the bundle should be written */
     outfile: string;
   };