Drop @datadog/apps-function-query, inject apps runtime via globalThis.DD_APPS_RUNTIME

Author: sdkennedy2

.yarn/cache/@datadog-apps-function-query-npm-0.0.1-8c329c6500-8b6eb4aadd.zip

@@ -116,7 +116,6 @@ Component,Origin,Licence,Copyright
 @babel/types,npm,MIT,The Babel Team (https://babel.dev/docs/en/next/babel-types)
 @bcoe/v8-coverage,npm,MIT,Charles Samborski (https://demurgos.github.io/v8-coverage)
 @cspotcode/source-map-support,npm,MIT,(https://www.npmjs.com/package/@cspotcode/source-map-support)
-@datadog/apps-function-query,npm,Apache-2.0,Datadog (https://datadoghq.com)
 @datadog/browser-core,npm,Apache-2.0,(https://www.npmjs.com/package/@datadog/browser-core)
 @datadog/browser-rum,virtual,Apache-2.0,(https://www.npmjs.com/package/@datadog/browser-rum)
 @datadog/browser-rum-core,npm,Apache-2.0,(https://www.npmjs.com/package/@datadog/browser-rum-core)

LICENSES-3rdparty.csv

@@ -14,6 +14,12 @@
     "buildPlugin": {
         "hideFromRootReadme": true
     },
+    "toBuild": {
+        "apps-runtime": {
+            "entry": "./src/built/apps-runtime.ts",
+            "format": ["esm"]
+        }
+    },
     "exports": {
         ".": "./src/index.ts",
         "./*": "./src/*.ts"

packages/plugins/apps/package.json

@@ -0,0 +1,14 @@
+// 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.
+
+/* eslint-env browser */
+/* global globalThis */
+import { executeBackendFunction } from '../vite/proxy-codegen/execute-backend-function';
+
+// Exposed on `globalThis.DD_APPS_RUNTIME` by the apps plugin injection so
+// generated proxy modules can call `executeBackendFunction` without importing
+// a runtime package. Internal API — consumers (generated .backend.ts proxy
+// modules) are produced by the apps plugin itself, not authored by users.
+const globalAny: any = globalThis;
+globalAny.DD_APPS_RUNTIME = { executeBackendFunction };

packages/plugins/apps/src/built/apps-runtime.ts

@@ -8,6 +8,7 @@ import * as identifier from '@dd/apps-plugin/identifier';
 import * as uploader from '@dd/apps-plugin/upload';
 import { getPlugins } from '@dd/apps-plugin';
 import * as fsHelpers from '@dd/core/helpers/fs';
+import { InjectPosition } from '@dd/core/types';
 import type { PluginOptions } from '@dd/core/types';
 import {
     getGetPluginsArg,
@@ -58,6 +59,29 @@ describe('Apps Plugin - getPlugins', () => {
         expect(getPlugins(getArgs())).toHaveLength(1);
     });
 
+    test('Should inject the apps runtime at the top of the user bundle when enabled', () => {
+        const injectMock = jest.fn();
+        getPlugins(
+            getGetPluginsArg(
+                { apps: {} },
+                { bundler: { ...getMockBundler({ name: 'vite' }), outDir }, inject: injectMock },
+            ),
+        );
+
+        expect(injectMock).toHaveBeenCalledWith({
+            type: 'file',
+            position: InjectPosition.MIDDLE,
+            value: expect.stringContaining('apps-runtime.mjs'),
+        });
+    });
+
+    test('Should not inject the runtime when disabled', () => {
+        const injectMock = jest.fn();
+        getPlugins(getGetPluginsArg({ apps: { enable: false } }, { inject: injectMock }));
+
+        expect(injectMock).not.toHaveBeenCalled();
+    });
+
     test('Should log an error when identifier cannot be resolved', async () => {
         const collectSpy = jest.spyOn(assets, 'collectAssets').mockResolvedValue([]);
         const uploadSpy = jest.spyOn(uploader, 'uploadArchive').mockResolvedValue({

packages/plugins/apps/src/index.test.ts

@@ -4,6 +4,7 @@
 
 import { rm } from '@dd/core/helpers/fs';
 import type { GetPlugins } from '@dd/core/types';
+import { InjectPosition } from '@dd/core/types';
 import chalk from 'chalk';
 import path from 'path';
 
@@ -83,6 +84,21 @@ export const getPlugins: GetPlugins = ({ options, context, bundler }) => {
         return [];
     }
 
+    // Inject the runtime that `globalThis.DD_APPS_RUNTIME.executeBackendFunction`
+    // is read from. The generated proxy modules (emitted by the transform hook
+    // below) reference that global. NOTE: This file is built alongside the
+    // bundler plugin via the `toBuild` entry in @dd/apps-plugin's package.json.
+    //
+    // Position MIDDLE is used instead of BEFORE so Vite's dev server injects
+    // the runtime as a <script type="module"> via `transformIndexHtml` — BEFORE
+    // is served via Rollup's `banner()` output hook which only fires at build
+    // time, leaving the runtime undefined during `vite` (dev).
+    context.inject({
+        type: 'file',
+        position: InjectPosition.MIDDLE,
+        value: path.join(__dirname, './apps-runtime.mjs'),
+    });
+
     const { setBackendFunctions, getBackendFunctions } = createBackendFunctionRegistry();
 
     const handleUpload = async (backendOutputs: Map<string, string>) => {

packages/plugins/apps/src/index.ts

@@ -5,14 +5,16 @@
 import { generateProxyModule } from '@dd/apps-plugin/vite/proxy-codegen';
 
 describe('Proxy Codegen - generateProxyModule', () => {
-    test('Should generate a proxy module with a pre-computed query name', () => {
+    test('Should generate a proxy module that reads executeBackendFunction off the runtime global', () => {
         const result = generateProxyModule([{ exportName: 'add', queryName: 'a1b2c3d4e5f6.add' }]);
 
+        expect(result).toContain('export async function add(...args)');
         expect(result).toContain(
-            "import { executeBackendFunction } from '@datadog/apps-function-query'",
+            'globalThis.DD_APPS_RUNTIME.executeBackendFunction("a1b2c3d4e5f6.add", args)',
         );
-        expect(result).toContain('export async function add(...args)');
-        expect(result).toContain('executeBackendFunction("a1b2c3d4e5f6.add", args)');
+        expect(result).not.toContain('@datadog/apps-function-query');
+        expect(result).not.toContain('virtual:dd-apps-runtime');
+        expect(result).not.toMatch(/^\s*import\s/m);
     });
 
     test('Should generate a proxy module for multiple exports', () => {
@@ -38,15 +40,4 @@ describe('Proxy Codegen - generateProxyModule', () => {
         expect(result).not.toContain('.backend');
         expect(result).toContain('"deadbeef1234.login"');
     });
-
-    test('Should import executeBackendFunction exactly once', () => {
-        const result = generateProxyModule([
-            { exportName: 'a', queryName: 'abc123.a' },
-            { exportName: 'b', queryName: 'abc123.b' },
-            { exportName: 'c', queryName: 'abc123.c' },
-        ]);
-
-        const importCount = (result.match(/import.*executeBackendFunction/g) || []).length;
-        expect(importCount).toBe(1);
-    });
 });

packages/plugins/apps/src/vite/proxy-codegen.test.ts

@@ -11,25 +11,25 @@ interface ProxyExport {
 
 /**
  * Generate a proxy module for a `.backend.ts` file. Each exported function
- * is replaced with a wrapper that calls `executeBackendFunction` with the
- * pre-computed query name string.
+ * is replaced with a wrapper that calls `executeBackendFunction` from the
+ * runtime exposed on `globalThis.DD_APPS_RUNTIME` by the apps plugin's
+ * injection (see packages/plugins/apps/src/built/apps-runtime.ts).
  *
- * The raw backend file path is never present in the generated
- * code — only the hashed query name appears, preventing backend file
- * structure from leaking into frontend bundles.
+ * The raw backend file path is never present in the generated code — only
+ * the hashed query name appears, preventing backend file structure from
+ * leaking into frontend bundles.
  *
  * @param exports - The export name + pre-computed query name for each export
  * @returns Generated proxy module source code
  */
 export function generateProxyModule(exports: ProxyExport[]): string {
     const lines: string[] = [];
 
-    lines.push("import { executeBackendFunction } from '@datadog/apps-function-query';");
-    lines.push('');
-
     for (const { exportName, queryName } of exports) {
         lines.push(`export async function ${exportName}(...args) {`);
-        lines.push(`    return executeBackendFunction(${JSON.stringify(queryName)}, args);`);
+        lines.push(
+            `    return globalThis.DD_APPS_RUNTIME.executeBackendFunction(${JSON.stringify(queryName)}, args);`,
+        );
         lines.push('}');
         lines.push('');
     }

packages/plugins/apps/src/vite/proxy-codegen.ts

@@ -50,7 +50,6 @@
         "watch": "yarn build --watch"
     },
     "dependencies": {
-        "@datadog/apps-function-query": "0.0.1",
         "@datadog/js-instrumentation-wasm": "1.0.8",
         "async-retry": "1.3.3",
         "chalk": "2.3.1",

packages/published/vite-plugin/package.json

@@ -34,15 +34,7 @@ const dependencyExceptions = [
 // Dependencies that are added directly to a published package and should not
 // be removed by the integrity check, even though they don't come from an
 // internal plugin's dependency tree.
-const publishedPackageExtraDependencies: Record<string, Record<string, string>> = {
-    // The apps plugin generates proxy modules that import executeBackendFunction
-    // at runtime in the user's frontend bundle. Only the vite-plugin supports
-    // .backend.ts files, so this dependency is scoped here rather than in the
-    // internal plugin (which would propagate it to all published packages).
-    '@datadog/vite-plugin': {
-        '@datadog/apps-function-query': '0.0.1',
-    },
-};
+const publishedPackageExtraDependencies: Record<string, Record<string, string>> = {};
 
 // Some filters.
 const allDependencies = (dependencyName: string) => !dependencyExceptions.includes(dependencyName);