@gooddata/create-pluggable-module 11.43.0-alpha.3 → 11.43.0-alpha.5

package/dist/templates/harness/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gdc-app-template-name-harness",
-    "version": "11.43.0-alpha.3",
+    "version": "11.43.0-alpha.5",
     "private": true,
     "description": "Standalone harness for gdc-app-template-name module",
     "license": "UNLICENSED",

package/dist/templates/module/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gdc-app-template-name-module",
-    "version": "11.43.0-alpha.3",
+    "version": "11.43.0-alpha.5",
     "private": true,
     "description": "{applicationTemplateTitle} pluggable application module",
     "license": "UNLICENSED",

package/dist/templates/module/src/App.test.tsx

@@ -1,13 +1,20 @@
 // (C) 2026 GoodData Corporation
 
+import { version as reactVersion } from "react";
+
 import { render, screen } from "@testing-library/react";
 import { IntlProvider } from "react-intl";
-import { describe, expect, it } from "vitest";
+import { describe, expect, it, vi } from "vitest";
 
+import {
+    type IPluggableAppTelemetryCallbacks,
+    LIB_VERSION as sdkVersion,
+} from "@gooddata/sdk-pluggable-application-model";
 import { BackendProvider } from "@gooddata/sdk-ui";
 import { type IClientPlatformContext, PlatformContextProvider } from "@gooddata/sdk-ui-pluggable-application";
 
 import { App } from "./App.js";
+import { reportPageView } from "./pluggableApp.js";
 
 function createMockCtx(): IClientPlatformContext {
     return {
@@ -50,4 +57,43 @@ describe("App", () => {
         renderWithProviders(<App />);
         expect(screen.getByText(/test@example.com/)).toBeTruthy();
     });
+
+    it("reports one page view carrying the module React / SDK versions and the workspace id", () => {
+        const trackPageView = vi.fn();
+        const onTelemetryEvent: IPluggableAppTelemetryCallbacks = {
+            trackEvent: vi.fn(),
+            trackPageView,
+            trackTiming: vi.fn(),
+        };
+
+        reportPageView(onTelemetryEvent, "ws-1");
+
+        expect(trackPageView).toHaveBeenCalledTimes(1);
+        expect(trackPageView).toHaveBeenCalledWith("gdc-app-template-name", {
+            moduleReactVersion: reactVersion,
+            moduleSdkVersion: sdkVersion,
+            identifiers: { workspaceId: "ws-1" },
+        });
+    });
+
+    it("reports a page view without identifiers for an organization-scoped app", () => {
+        const trackPageView = vi.fn();
+        const onTelemetryEvent: IPluggableAppTelemetryCallbacks = {
+            trackEvent: vi.fn(),
+            trackPageView,
+            trackTiming: vi.fn(),
+        };
+
+        reportPageView(onTelemetryEvent, undefined);
+
+        expect(trackPageView).toHaveBeenCalledTimes(1);
+        expect(trackPageView).toHaveBeenCalledWith("gdc-app-template-name", {
+            moduleReactVersion: reactVersion,
+            moduleSdkVersion: sdkVersion,
+        });
+    });
+
+    it("no-ops when the host supplies no telemetry callbacks (standalone run)", () => {
+        expect(() => reportPageView(undefined, "ws-1")).not.toThrow();
+    });
 });

package/dist/templates/module/src/App.tsx

@@ -4,7 +4,7 @@ import { FormattedMessage } from "react-intl";
 
 import { type IPluggableAppEvent } from "@gooddata/sdk-pluggable-application-model";
 import { useWorkspace } from "@gooddata/sdk-ui";
-import { usePlatformContextStrict, usePluggableAppTelemetry } from "@gooddata/sdk-ui-pluggable-application";
+import { usePlatformContextStrict } from "@gooddata/sdk-ui-pluggable-application";
 
 interface IAppProps {
     onEvent?: (e: IPluggableAppEvent) => void;
@@ -13,7 +13,10 @@ interface IAppProps {
 export function App({ onEvent: _onEvent }: IAppProps) {
     const ctx = usePlatformContextStrict();
     const workspaceId = useWorkspace();
-    const { trackEvent: _trackEvent } = usePluggableAppTelemetry();
+
+    // The mount page view that reports this module's React / SDK versions is fired once per lifecycle
+    // in pluggableApp.tsx. To send telemetry from inside the app (e.g. on a user action), pull the
+    // host callbacks with `usePluggableAppTelemetry()` and call `trackEvent` / `trackTiming`.
 
     return (
         <div style={{ display: "flex", flexDirection: "column", padding: "4rem" }}>

package/dist/templates/module/src/pluggableApp.tsx

@@ -13,11 +13,37 @@ import {
     type IPluggableApplicationMountOptions,
     LIB_VERSION as moduleSdkVersion,
 } from "@gooddata/sdk-pluggable-application-model";
-import { PluggableAppTelemetryProvider } from "@gooddata/sdk-ui-pluggable-application";
+import {
+    PluggableAppTelemetryProvider,
+    enrichTelemetryCallbacks,
+} from "@gooddata/sdk-ui-pluggable-application";
 
 import { App } from "./App.js";
 import { AppProviders } from "./AppProviders.js";
 
+// Page id reported on mount. The scaffolder rewrites the `gdc-app-template-name` token to your
+// module's id when generating the project, so this becomes your app's name automatically — rename
+// it if you want a different page id.
+const TELEMETRY_PAGE = "gdc-app-template-name";
+
+/**
+ * Report one page view stamped with this module's React / SDK versions — the page-scoped custom
+ * variables the host records as `moduleReactVersion` / `moduleSdkVersion`, so a single page view per
+ * lifecycle is enough to attribute the module's runtime.
+ *
+ * Fired here from the mount lifecycle rather than from a React effect inside `<App/>`: AppProviders
+ * briefly unmounts its children while an async locale bundle loads, so an effect-based page view
+ * would re-fire on that remount. The workspace id (when this app is workspace-scoped) rides along as
+ * a neutral `identifiers` entry so the host keeps the page view's workspace attribution.
+ */
+export function reportPageView(
+    onTelemetryEvent: IPluggableAppTelemetryCallbacks | undefined,
+    workspaceId: string | undefined,
+) {
+    const telemetry = enrichTelemetryCallbacks(onTelemetryEvent, { moduleReactVersion, moduleSdkVersion });
+    telemetry?.trackPageView(TELEMETRY_PAGE, workspaceId ? { identifiers: { workspaceId } } : undefined);
+}
+
 function renderApp(
     root: Root,
     ctx: IPlatformContext,
@@ -53,6 +79,9 @@ export const pluggableApp: IPluggableApp = {
         const root = createRoot(container);
 
         renderApp(root, ctx, basePath, onEvent, onTelemetryEvent);
+        reportPageView(onTelemetryEvent, ctx.currentWorkspaceId);
+
+        let previousWorkspaceId = ctx.currentWorkspaceId;
 
         return {
             unmount() {
@@ -60,6 +89,12 @@ export const pluggableApp: IPluggableApp = {
             },
             updateContext(nextCtx: IPlatformContext) {
                 renderApp(root, nextCtx, basePath, onEvent, onTelemetryEvent);
+                // Re-report only on a genuine workspace switch — not on every context update (theme,
+                // auth, locale, …) — so each workspace visit is counted exactly once.
+                if (nextCtx.currentWorkspaceId !== previousWorkspaceId) {
+                    reportPageView(onTelemetryEvent, nextCtx.currentWorkspaceId);
+                    previousWorkspaceId = nextCtx.currentWorkspaceId;
+                }
             },
         };
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/create-pluggable-module",
-  "version": "11.43.0-alpha.3",
+  "version": "11.43.0-alpha.5",
   "description": "Scaffolder for GoodData pluggable applications. Invoked via `npm init @gooddata/pluggable-module`.",
   "license": "MIT",
   "author": "GoodData Corporation",
@@ -50,10 +50,10 @@
     "typescript": "5.9.3",
     "vite": "8.0.16",
     "vitest": "4.1.8",
-    "@gooddata/eslint-config": "11.43.0-alpha.3",
-    "gdc-app-template-name-harness": "11.43.0-alpha.3",
-    "@gooddata/oxlint-config": "11.43.0-alpha.3",
-    "gdc-app-template-name-module": "11.43.0-alpha.3"
+    "@gooddata/eslint-config": "11.43.0-alpha.5",
+    "gdc-app-template-name-harness": "11.43.0-alpha.5",
+    "@gooddata/oxlint-config": "11.43.0-alpha.5",
+    "gdc-app-template-name-module": "11.43.0-alpha.5"
   },
   "engines": {
     "node": ">=24.12.0"