[feat] Add true-end plugin

.github/CODEOWNERS

@@ -29,3 +29,6 @@ packages/plugins/analytics                                            @yoannmoin
 
 # Custom Hooks
 packages/plugins/custom-hooks                                         @yoannmoinet
+
+# True End
+packages/plugins/true-end                                            @yoannmoinet

packages/core/src/types.ts

@@ -179,11 +179,13 @@ export type FactoryMeta = {
 export type HookFn<T extends Array<any>> = (...args: T) => void;
 export type AsyncHookFn<T extends Array<any>> = (...args: T) => Promise<void> | void;
 export type CustomHooks = {
+    asyncTrueEnd?: () => Promise<void> | void;
     cwd?: HookFn<[string]>;
     init?: HookFn<[GlobalContext]>;
     buildReport?: HookFn<[BuildReport]>;
     bundlerReport?: HookFn<[BundlerReport]>;
     git?: AsyncHookFn<[RepositoryData]>;
+    syncTrueEnd?: () => void;
 };
 
 export type PluginOptions = Assign<

packages/factory/README.md

@@ -15,6 +15,7 @@ This is used to aggregate all the plugins and expose them to the bundler.
     -   [Custom Hooks](#custom-hooks)
     -   [Git](#git)
     -   [Injection](#injection)
+    -   [True End](#true-end)
 -   [Logger](#logger)
 -   [Time Logger](#time-logger)
     -   [Options](#options)
@@ -82,6 +83,13 @@ Most of the time they will interact via the global context.
 
 #### [📝 Full documentation ➡️](/packages/plugins/injection#readme)
 
+
+### True End
+
+> A custom hook for the true end of a build, cross bundlers.
+
+#### [📝 Full documentation ➡️](/packages/plugins/true-end#readme)
+
 <!-- #internal-plugins-list -->
 
 ## Logger

packages/factory/package.json

@@ -27,6 +27,7 @@
         "@dd/internal-custom-hooks-plugin": "workspace:*",
         "@dd/internal-git-plugin": "workspace:*",
         "@dd/internal-injection-plugin": "workspace:*",
+        "@dd/internal-true-end-plugin": "workspace:*",
         "@dd/rum-plugin": "workspace:*",
         "@dd/telemetry-plugin": "workspace:*",
         "chalk": "2.3.1",

packages/factory/src/index.ts

@@ -40,6 +40,7 @@ import { getBundlerReportPlugins } from '@dd/internal-bundler-report-plugin';
 import { getCustomHooksPlugins } from '@dd/internal-custom-hooks-plugin';
 import { getGitPlugins } from '@dd/internal-git-plugin';
 import { getInjectionPlugins } from '@dd/internal-injection-plugin';
+import { getTrueEndPlugins } from '@dd/internal-true-end-plugin';
 // #imports-injection-marker
 // #types-export-injection-marker
 export type { types as ErrorTrackingTypes } from '@dd/error-tracking-plugin';
@@ -94,6 +95,7 @@ export const buildPluginFactory = ({
             ['custom-hooks', getCustomHooksPlugins],
             ['git', getGitPlugins],
             ['injection', getInjectionPlugins],
+            ['true-end', getTrueEndPlugins],
             // #internal-plugins-injection-marker
         );
 

packages/plugins/custom-hooks/README.md

@@ -12,6 +12,7 @@ you should create a custom hook to let other plugins use it as soon as it is ava
     -   [Build Report](#build-report)
     -   [Bundler Report](#bundler-report)
     -   [Git](#git)
+    -   [True End](#true-end)
 <!-- #toc -->
 
 ## Create a custom hook
@@ -148,4 +149,42 @@ This hook is called when the git repository data is computed.
 }
 ```
 
+### True End
+
+> [📝 Full documentation ➡️](/packages/plugins/true-end#hooks)
+
+#### `asyncTrueEnd`
+
+This hook is called at the very end of the build asynchronously.
+
+It may execute sooner than `syncTrueEnd` in some contexts:
+
+- `esbuild` will call `asyncTrueEnd` before `syncTrueEnd`.
+    - We use `build.onDispose`, for the latest hook possible in the build. The issue is, it's synchronous only. So we have to use `build.onEnd` for the asynchronous `asyncTrueEnd`, but it's called well before `build.onDispose`.
+- `webpack 4` will only call `syncTrueEnd` if the build has an error. All good otherwise.
+
+```typescript
+{
+    name: 'my-plugin',
+    async asyncTrueEnd() {
+        // Do something asynchronous on closure
+        await someAsyncOperation();
+    }
+}
+```
+
+#### `syncTrueEnd`
+
+This hook is called at the very end of the build synchronously.
+
+```typescript
+{
+    name: 'my-plugin',
+    syncTrueEnd() {
+        // Do something synchronous on closure
+        someSyncOperation();
+    }
+}
+```
+
 <!-- #list-of-hooks -->

packages/plugins/true-end/README.md

@@ -0,0 +1,39 @@
+# True End Plugin <!-- #omit in toc -->
+
+A custom hook for the true end of a build, cross bundlers.
+
+## Hooks
+
+### `asyncTrueEnd`
+
+This hook is called at the very end of the build asynchronously.
+
+It may execute sooner than `syncTrueEnd` in some contexts:
+
+- `esbuild` will call `asyncTrueEnd` before `syncTrueEnd`.
+    - We use `build.onDispose`, for the latest hook possible in the build. The issue is, it's synchronous only. So we have to use `build.onEnd` for the asynchronous `asyncTrueEnd`, but it's called well before `build.onDispose`.
+- `webpack 4` will only call `syncTrueEnd` if the build has an error. All good otherwise.
+
+```typescript
+{
+    name: 'my-plugin',
+    async asyncTrueEnd() {
+        // Do something asynchronous on closure
+        await someAsyncOperation();
+    }
+}
+```
+
+### `syncTrueEnd`
+
+This hook is called at the very end of the build synchronously.
+
+```typescript
+{
+    name: 'my-plugin',
+    syncTrueEnd() {
+        // Do something synchronous on closure
+        someSyncOperation();
+    }
+}
+```

packages/plugins/true-end/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "@dd/internal-true-end-plugin",
+    "packageManager": "yarn@4.0.2",
+    "license": "MIT",
+    "private": true,
+    "author": "Datadog",
+    "description": "A custom hook for the true end of a build, cross bundlers.",
+    "homepage": "https://github.com/DataDog/build-plugins/tree/main/packages/plugins/true-end#readme",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/DataDog/build-plugins",
+        "directory": "packages/plugins/true-end"
+    },
+    "exports": {
+        ".": "./src/index.ts",
+        "./*": "./src/*.ts"
+    },
+    "scripts": {
+        "typecheck": "tsc --noEmit"
+    },
+    "dependencies": {
+        "@dd/core": "workspace:*"
+    },
+    "devDependencies": {
+        "typescript": "5.4.3"
+    }
+}

packages/plugins/true-end/src/index.test.ts

@@ -0,0 +1,45 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import { BUNDLERS, runBundlers } from '@dd/tests/_jest/helpers/runBundlers';
+
+describe('True End', () => {
+    // TODO test for multi outputs, failing builds, async hook in esbuild.
+    test('Should call true end hook.', async () => {
+        const asyncBundlers: string[] = [];
+        const syncBundlers: string[] = [];
+
+        const asyncTrueEndHookFn = jest.fn(async (bundler: string) => {
+            asyncBundlers.push(bundler);
+        });
+        const syncTrueEndHookFn = jest.fn((bundler: string) => {
+            syncBundlers.push(bundler);
+        });
+
+        await runBundlers({
+            logLevel: 'none',
+            customPlugins: ({ context }) => {
+                return [
+                    {
+                        name: 'true-end-plugin',
+                        async asyncTrueEnd() {
+                            await asyncTrueEndHookFn(context.bundler.fullName);
+                        },
+                        syncTrueEnd() {
+                            syncTrueEndHookFn(context.bundler.fullName);
+                        },
+                    },
+                ];
+            },
+        });
+
+        const bundlerNames = BUNDLERS.map((b) => b.name);
+
+        expect(asyncBundlers).toEqual(bundlerNames);
+        expect(syncBundlers).toEqual(bundlerNames);
+
+        expect(asyncTrueEndHookFn).toHaveBeenCalledTimes(BUNDLERS.length);
+        expect(syncTrueEndHookFn).toHaveBeenCalledTimes(BUNDLERS.length);
+    });
+});

packages/plugins/true-end/src/index.ts

@@ -0,0 +1,64 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import type { GetInternalPlugins, GetPluginsArg, PluginOptions, PluginName } from '@dd/core/types';
+
+export const PLUGIN_NAME: PluginName = 'datadog-true-end-plugin' as const;
+
+export const getTrueEndPlugins: GetInternalPlugins = (arg: GetPluginsArg) => {
+    const { context } = arg;
+    const asyncHookFn = async () => {
+        await context.asyncHook('asyncTrueEnd');
+    };
+    const syncHookFn = () => {
+        context.hook('syncTrueEnd');
+    };
+    const bothHookFns = async () => {
+        syncHookFn();
+        await asyncHookFn();
+    };
+
+    const xpackPlugin: PluginOptions['rspack'] & PluginOptions['webpack'] = (compiler) => {
+        if (compiler.hooks.shutdown) {
+            // NOTE: rspack prior to 1.2.* will randomly crash on shutdown.tapPromise.
+            compiler.hooks.shutdown.tapPromise(PLUGIN_NAME, bothHookFns);
+        } else {
+            // Webpack 4 only.
+            compiler.hooks.done.tapPromise(PLUGIN_NAME, bothHookFns);
+            compiler.hooks.failed.tap(PLUGIN_NAME, syncHookFn);
+        }
+    };
+
+    const rollupPlugin: PluginOptions['rollup'] & PluginOptions['vite'] = {
+        async writeBundle() {
+            // TODO: Need to fallback here in case the closeBundle isn't called.
+        },
+        async closeBundle() {
+            await bothHookFns();
+        },
+    };
+
+    return [
+        {
+            name: PLUGIN_NAME,
+            enforce: 'post',
+            webpack: xpackPlugin,
+            esbuild: {
+                setup(build) {
+                    // NOTE: "onEnd" is the best we can do for esbuild, but it's very far from being the "true end" of the build.
+                    build.onEnd(async () => {
+                        await asyncHookFn();
+                    });
+                    // NOTE: "onDispose" is strictly synchronous.
+                    build.onDispose(() => {
+                        syncHookFn();
+                    });
+                },
+            },
+            vite: rollupPlugin,
+            rollup: rollupPlugin,
+            rspack: xpackPlugin,
+        },
+    ];
+};

packages/plugins/true-end/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "extends": "../../../tsconfig.json",
+    "compilerOptions": {
+        "baseUrl": "./",
+        "rootDir": "./",
+        "outDir": "./dist"
+    },
+    "include": ["**/*"],
+    "exclude": ["dist", "node_modules"]
+}

packages/tools/src/bundlers.ts

@@ -141,6 +141,9 @@ export const buildWithEsbuild: BundlerRunFn = async (bundlerConfigs: BuildOption
         errors.push(`[ESBUILD] : ${e.message}`);
     }
 
+    // There's a slight delay to fully exit esbuild and trigger the onDispose hook.
+    await new Promise<void>((resolve) => setTimeout(resolve, 1));
+
     return { errors, result };
 };
 
@@ -168,12 +171,18 @@ export const buildWithRollup: BundlerRunFn = async (bundlerConfig: RollupOptions
 
         // Write out the results.
         if (bundlerConfig.output) {
-            const outputProms = [];
+            const outputProms: Promise<RollupOutput>[] = [];
             const outputOptions = Array.isArray(bundlerConfig.output)
                 ? bundlerConfig.output
                 : [bundlerConfig.output];
             for (const outputOption of outputOptions) {
-                outputProms.push(result.write(outputOption));
+                outputProms.push(
+                    (async () => {
+                        const bundleResult = await result.write(outputOption);
+                        await result.close();
+                        return bundleResult;
+                    })(),
+                );
             }
 
             results = await Promise.all(outputProms);

yarn.lock

@@ -1690,6 +1690,7 @@ __metadata:
     "@dd/internal-custom-hooks-plugin": "workspace:*"
     "@dd/internal-git-plugin": "workspace:*"
     "@dd/internal-injection-plugin": "workspace:*"
+    "@dd/internal-true-end-plugin": "workspace:*"
     "@dd/rum-plugin": "workspace:*"
     "@dd/telemetry-plugin": "workspace:*"
     chalk: "npm:2.3.1"
@@ -1754,6 +1755,15 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@dd/internal-true-end-plugin@workspace:*, @dd/internal-true-end-plugin@workspace:packages/plugins/true-end":
+  version: 0.0.0-use.local
+  resolution: "@dd/internal-true-end-plugin@workspace:packages/plugins/true-end"
+  dependencies:
+    "@dd/core": "workspace:*"
+    typescript: "npm:5.4.3"
+  languageName: unknown
+  linkType: soft
+
 "@dd/rum-plugin@workspace:*, @dd/rum-plugin@workspace:packages/plugins/rum":
   version: 0.0.0-use.local
   resolution: "@dd/rum-plugin@workspace:packages/plugins/rum"