feat(core): add OSS onboarding survey reporting (#8666)

Author: darcyYe

Dockerfile

@@ -1,5 +1,7 @@
+# syntax=docker/dockerfile:1.7
+
 ###### [STAGE] Build ######
-FROM node:22-alpine as builder
+FROM node:22-alpine AS builder
 WORKDIR /etc/logto
 ENV CI=true
 
@@ -14,7 +16,8 @@ RUN apk add --no-cache python3 make g++ rsync
 COPY . .
 
 ### Install dependencies and build ###
-RUN pnpm i
+# Reuse the pnpm store between BuildKit runs to reduce duplicate downloads/writes.
+RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store pnpm i
 
 ### Set if dev features enabled ###
 ARG dev_features_enabled
@@ -23,6 +26,9 @@ ENV DEV_FEATURES_ENABLED=${dev_features_enabled}
 ARG applicationinsights_connection_string
 ENV APPLICATIONINSIGHTS_CONNECTION_STRING=${applicationinsights_connection_string}
 
+ARG logto_oss_survey_endpoint=
+ENV LOGTO_OSS_SURVEY_ENDPOINT=${logto_oss_survey_endpoint}
+
 RUN pnpm -r build
 
 ### Add official connectors ###
@@ -31,15 +37,19 @@ ENV ADDITIONAL_CONNECTOR_ARGS=${additional_connector_args}
 RUN pnpm cli connector link $ADDITIONAL_CONNECTOR_ARGS -p .
 
 ### Prune dependencies for production ###
-RUN rm -rf node_modules packages/**/node_modules
-RUN NODE_ENV=production pnpm i
+# Keep prune + production install in one layer to avoid extra transient disk usage.
+RUN --mount=type=cache,id=pnpm-store,target=/root/.local/share/pnpm/store \
+  rm -rf node_modules packages/**/node_modules && NODE_ENV=production pnpm i
 
 ### Clean up ###
 RUN rm -rf .scripts pnpm-*.yaml packages/cloud
 
 ###### [STAGE] Seal ######
-FROM node:22-alpine as app
+FROM node:22-alpine AS app
 WORKDIR /etc/logto
+ARG logto_oss_survey_endpoint=
+# Default to empty so external survey relaying stays opt-in for controlled builds/environments.
+ENV LOGTO_OSS_SURVEY_ENDPOINT=${logto_oss_survey_endpoint}
 COPY --from=builder /etc/logto .
 RUN mkdir -p /etc/logto/packages/cli/alteration-scripts && chmod g+w /etc/logto/packages/cli/alteration-scripts
 EXPOSE 3001

packages/console/src/consts/env.ts

@@ -33,3 +33,4 @@ export const postHogHost = normalizeEnv(import.meta.env.POSTHOG_PUBLIC_HOST);
  * @see https://posthog.com/docs/libraries/js/config for more details.
  */
 export const postHogUiHost = normalizeEnv(import.meta.env.POSTHOG_PUBLIC_UI_HOST);
+export const ossSurveyEndpoint = normalizeEnv(import.meta.env.LOGTO_OSS_SURVEY_ENDPOINT);

packages/console/src/hooks/use-oss-onboarding-data.ts

@@ -30,8 +30,6 @@ const useOssOnboardingData = (): {
 
   const update = useCallback(
     async (data: Partial<OssUserOnboardingData>) => {
-      // TODO: sync OSS onboarding submissions to a dedicated server-side endpoint for
-      // analysis and future marketing email outreach instead of relying only on user custom data.
       await updateCustomData({
         [ossUserOnboardingDataKey]: {
           ...ossOnboardingData,

packages/console/src/pages/OssOnboarding/index.tsx

@@ -23,9 +23,9 @@ import useTenantPathname from '@/hooks/use-tenant-pathname';
 import { trySubmitSafe } from '@/utils/form';
 
 import styles from './index.module.scss';
+import { submitOssOnboarding } from './submit-oss-onboarding';
 import {
   getOssOnboardingDefaultValues,
-  getOssOnboardingSubmitPayload,
   shouldRequireCompanyFields,
   type OssOnboardingFormData,
 } from './utils';
@@ -67,13 +67,13 @@ function OssOnboarding() {
   }, [data.questionnaire, isLoading, reset]);
 
   const onSubmit = handleSubmit(
-    trySubmitSafe(async (formData) => {
-      await update({
-        questionnaire: getOssOnboardingSubmitPayload(formData),
-        isOnboardingDone: true,
-      });
-      navigate('/get-started', { replace: true });
-    })
+    trySubmitSafe(async (formData) =>
+      submitOssOnboarding({
+        formData,
+        navigate,
+        update,
+      })
+    )
   );
 
   if (isLoading) {

packages/console/src/pages/OssOnboarding/submit-oss-onboarding.test.ts

@@ -0,0 +1,287 @@
+import { CompanySize, Project, type OssUserOnboardingData } from '@logto/schemas';
+import type { Options } from 'ky';
+
+import type { OssOnboardingFormData } from './utils';
+
+// Module-level mocks for env constants. Must be declared before importing the module under test.
+// eslint-disable-next-line @silverhand/fp/no-let
+let mockIsDevFeaturesEnabled = true;
+// eslint-disable-next-line @silverhand/fp/no-let
+let mockOssSurveyEndpoint: string | undefined = 'https://survey.example.com';
+
+const mockKyPost = jest.fn<Promise<{ ok: boolean }>, [URL, Options?]>();
+const mockKyOptions: { current?: Options } = {};
+const mockKyCreate = jest.fn((options?: Options) => {
+  // eslint-disable-next-line @silverhand/fp/no-mutation
+  mockKyOptions.current = options;
+
+  return {
+    post: async (...args: [URL, Options?]) => {
+      const retryLimit =
+        options?.retry && typeof options.retry !== 'number' ? (options.retry.limit ?? 0) : 0;
+      const retryDelay =
+        options?.retry && typeof options.retry !== 'number' ? (options.retry.delay?.(1) ?? 0) : 0;
+
+      try {
+        const response = await mockKyPost(...args);
+        return response;
+      } catch (error) {
+        if (retryLimit < 1 || retryDelay === 0) {
+          throw error;
+        }
+
+        const response = await mockKyPost(...args);
+        return response;
+      }
+    },
+  };
+});
+
+jest.mock('ky', () => ({
+  __esModule: true,
+  default: {
+    create: (...args: [Options?]) => mockKyCreate(...args),
+  },
+}));
+
+jest.mock('@/consts/env', () => ({
+  get isDevFeaturesEnabled() {
+    return mockIsDevFeaturesEnabled;
+  },
+  get ossSurveyEndpoint() {
+    return mockOssSurveyEndpoint;
+  },
+}));
+
+const mockFormData: OssOnboardingFormData = {
+  emailAddress: 'Dev@Example.COM',
+  newsletter: true,
+  project: Project.Company,
+  companyName: 'Acme',
+  companySize: CompanySize.Scale3,
+};
+
+const getSubmitOssOnboarding = async () => {
+  const module = await import('./submit-oss-onboarding');
+  return module.submitOssOnboarding;
+};
+
+describe('submitOssOnboarding', () => {
+  beforeAll(async () => {
+    await import('./submit-oss-onboarding');
+  });
+
+  afterEach(() => {
+    mockKyPost.mockReset();
+    mockKyPost.mockResolvedValue({ ok: true });
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockKyOptions.current = undefined;
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockIsDevFeaturesEnabled = true;
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockOssSurveyEndpoint = 'https://survey.example.com';
+  });
+
+  beforeEach(() => {
+    mockKyPost.mockResolvedValue({ ok: true });
+  });
+
+  it('configures the OSS survey client with ky retry options', () => {
+    expect(mockKyCreate).toHaveBeenCalledTimes(1);
+    expect(mockKyOptions.current?.throwHttpErrors).toBe(false);
+
+    const retry = mockKyOptions.current?.retry;
+
+    expect(retry && typeof retry !== 'number' ? retry.limit : undefined).toBe(1);
+    expect(retry && typeof retry !== 'number' ? retry.methods : undefined).toEqual(['post']);
+    expect(retry && typeof retry !== 'number' ? retry.statusCodes : undefined).toEqual([]);
+    expect(retry && typeof retry !== 'number' ? retry.afterStatusCodes : undefined).toEqual([]);
+    expect(retry && typeof retry !== 'number' ? retry.delay?.(1) : undefined).toBe(1);
+  });
+
+  it('updates, reports and navigates when onboarding is submitted', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    update.mockResolvedValue();
+
+    await submitOssOnboarding({
+      formData: mockFormData,
+      navigate,
+      update,
+    });
+
+    expect(update).toHaveBeenCalledWith({
+      questionnaire: {
+        emailAddress: 'dev@example.com',
+        newsletter: true,
+        project: Project.Company,
+        companyName: 'Acme',
+        companySize: CompanySize.Scale3,
+      },
+      isOnboardingDone: true,
+    });
+    expect(mockKyPost).toHaveBeenCalledWith(
+      new URL('https://survey.example.com/api/surveys'),
+      expect.objectContaining({
+        json: {
+          emailAddress: 'dev@example.com',
+          newsletter: true,
+          project: Project.Company,
+          companyName: 'Acme',
+          companySize: CompanySize.Scale3,
+        },
+        keepalive: true,
+      })
+    );
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+
+  it('constructs the reporting URL when endpoint has trailing slash', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockOssSurveyEndpoint = 'https://survey.example.com/';
+    update.mockResolvedValue();
+
+    await submitOssOnboarding({
+      formData: mockFormData,
+      navigate,
+      update,
+    });
+
+    expect(mockKyPost).toHaveBeenCalledWith(
+      new URL('https://survey.example.com/api/surveys'),
+      expect.anything()
+    );
+  });
+
+  it('still reports and navigates when onboarding data persistence fails', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    update.mockRejectedValue(new Error('save failed'));
+
+    await expect(
+      submitOssOnboarding({
+        formData: mockFormData,
+        navigate,
+        update,
+      })
+    ).resolves.toBeUndefined();
+
+    expect(mockKyPost).toHaveBeenCalled();
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+
+  it('retries report once after a network failure', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    mockKyPost.mockRejectedValueOnce(new TypeError('network error')).mockResolvedValueOnce({
+      ok: true,
+    });
+    update.mockResolvedValue();
+
+    await expect(
+      submitOssOnboarding({
+        formData: mockFormData,
+        navigate,
+        update,
+      })
+    ).resolves.toBeUndefined();
+
+    await new Promise<void>((resolve) => {
+      setTimeout(resolve, 0);
+    });
+
+    expect(mockKyPost).toHaveBeenCalledTimes(2);
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+
+  it('swallows report fetch failures after retry to keep submit flow unchanged', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    mockKyPost.mockRejectedValue(new TypeError('network error'));
+    update.mockResolvedValue();
+
+    await expect(
+      submitOssOnboarding({
+        formData: mockFormData,
+        navigate,
+        update,
+      })
+    ).resolves.toBeUndefined();
+
+    await new Promise<void>((resolve) => {
+      setTimeout(resolve, 0);
+    });
+
+    expect(mockKyPost).toHaveBeenCalledTimes(2);
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+
+  it('does not report when isDevFeaturesEnabled is false', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockIsDevFeaturesEnabled = false;
+    update.mockResolvedValue();
+
+    await submitOssOnboarding({
+      formData: mockFormData,
+      navigate,
+      update,
+    });
+
+    expect(mockKyPost).not.toHaveBeenCalled();
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+
+  it('does not report when ossSurveyEndpoint is undefined', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockOssSurveyEndpoint = undefined;
+    update.mockResolvedValue();
+
+    await submitOssOnboarding({
+      formData: mockFormData,
+      navigate,
+      update,
+    });
+
+    expect(mockKyPost).not.toHaveBeenCalled();
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+
+  it('does not report when ossSurveyEndpoint is invalid', async () => {
+    const submitOssOnboarding = await getSubmitOssOnboarding();
+    const update = jest.fn<Promise<void>, [Partial<OssUserOnboardingData>]>();
+    const navigate = jest.fn<void, [string, { replace: boolean }]>();
+
+    // eslint-disable-next-line @silverhand/fp/no-mutation
+    mockOssSurveyEndpoint = 'not a valid URL';
+    update.mockResolvedValue();
+
+    await submitOssOnboarding({
+      formData: mockFormData,
+      navigate,
+      update,
+    });
+
+    expect(mockKyPost).not.toHaveBeenCalled();
+    expect(navigate).toHaveBeenCalledWith('/get-started', { replace: true });
+  });
+});