@nocobase/app-template-default 0.0.0-stage → 1.0.0-beta.57

package/tests/logic/user-menu-sign-out.test.tsx

@@ -0,0 +1,98 @@
+import {
+  act,
+  fireEvent,
+  render,
+  screen,
+  waitFor,
+} from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import {
+  TestI18nProvider,
+  createTestI18nRuntime,
+} from '@nocobase/i18n/testing';
+import type { ReactNode } from 'react';
+import { UserMenu } from '../../client/layouts/components/user-menu.tsx';
+import enUS from '../../client/locales/en-US.js';
+
+const runtime = await createTestI18nRuntime({
+  application: { namespace: '@nocobase/app-template-default', resources: enUS },
+});
+
+function I18n({ children }: { readonly children: ReactNode }) {
+  return <TestI18nProvider runtime={runtime}>{children}</TestI18nProvider>;
+}
+
+const { signOut, refresh, showToast } = vi.hoisted(() => ({
+  signOut: vi.fn(),
+  refresh: vi.fn(),
+  showToast: vi.fn(),
+}));
+vi.mock('@nocobase/app-client', () => {
+  const toaster = { show: showToast, close: vi.fn() };
+  return { useToaster: () => toaster };
+});
+vi.mock('@nocobase/app-plugin-authentication/client', () => ({
+  useAuthentication: () => ({
+    client: { signOut },
+    session: {
+      user: { id: 'operator', name: 'Operator', email: 'operator@example.com' },
+    },
+    isPending: false,
+    refresh,
+  }),
+}));
+vi.mock('../../client/layouts/components/language-switcher.js', () => ({
+  LanguageSwitcher: () => null,
+}));
+
+/**
+ * Opens the account menu from the keyboard. A pointer opens it on hover and again on the press, one frame later, which
+ * can reopen the menu after a test has already chosen an item and closed it.
+ */
+async function openAccountMenu(): Promise<void> {
+  act(() => screen.getByRole('button', { name: 'Open account menu' }).focus());
+  await userEvent.keyboard('{Enter}');
+}
+
+describe('account menu sign out', () => {
+  beforeEach(() => {
+    vi.resetAllMocks();
+    refresh.mockResolvedValue(undefined);
+  });
+  async function signOutFromMenu() {
+    render(<UserMenu />, { wrapper: I18n });
+    await openAccountMenu();
+    fireEvent.click(await screen.findByRole('menuitem', { name: 'Sign out' }));
+  }
+  it('refreshes the server session after successful sign-out', async () => {
+    signOut.mockResolvedValue({ data: { success: true }, error: null });
+    await signOutFromMenu();
+    await waitFor(() => expect(refresh).toHaveBeenCalledTimes(1));
+    expect(showToast).not.toHaveBeenCalled();
+  });
+  it('reports a rejected origin without pretending the session ended', async () => {
+    signOut.mockResolvedValue({
+      data: null,
+      error: { status: 403, code: 'INVALID_ORIGIN' },
+    });
+    await signOutFromMenu();
+    await waitFor(() =>
+      expect(showToast).toHaveBeenCalledWith({
+        type: 'error',
+        title: 'Unable to sign out. Please try again.',
+      }),
+    );
+    expect(refresh).not.toHaveBeenCalled();
+    await openAccountMenu();
+    expect(
+      await screen.findByRole('menuitem', { name: 'Sign out' }),
+    ).not.toHaveAttribute('aria-disabled', 'true');
+  });
+  it('reports network failures and allows retry', async () => {
+    signOut.mockRejectedValue(new Error('Network unavailable'));
+    await signOutFromMenu();
+    await waitFor(() => expect(showToast).toHaveBeenCalledTimes(1));
+    expect(refresh).not.toHaveBeenCalled();
+  });
+});

package/tests/setup/client-config.ts

@@ -0,0 +1,27 @@
+import { beforeEach } from 'vitest';
+
+const RUNTIME_CONFIG_ELEMENT_ID = 'nocobase-runtime-config';
+
+/**
+ * The application server renders the client configuration into every page, and the client reads its mount path and
+ * API URL from nowhere else. A test page has no server in front of it, so this puts the same block in place, mounted
+ * at `/main`. A test that needs other values removes it and renders its own.
+ */
+function renderClientConfig(): void {
+  // Server-side tests run under `@vitest-environment node`, where there is no page to render into.
+  if (typeof document === 'undefined') return;
+  if (document.getElementById(RUNTIME_CONFIG_ELEMENT_ID)) return;
+  const element = document.createElement('script');
+  element.id = RUNTIME_CONFIG_ELEMENT_ID;
+  element.type = 'application/json';
+  element.textContent = JSON.stringify({
+    version: 1,
+    config: { app: { basePath: '/main' }, api: { baseURL: '/main/api' } },
+  });
+  document.head.append(element);
+}
+
+// Before the test file is imported, as the server renders it before the entry module runs: some modules resolve
+// URLs at the top level.
+renderClientConfig();
+beforeEach(renderClientConfig);

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@nocobase/dev-config/tsconfig/client.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo"
+  },
+  // A workflow package's client form is browser code that the application's
+  // Vite build resolves through the workflow plugin's virtual module, so it is
+  // typechecked here rather than by the server build.
+  "include": ["client", "workflows/*/client"],
+  "exclude": ["registry"]
+}

package/tsconfig.node.json

@@ -0,0 +1,12 @@
+{
+  "extends": "@nocobase/dev-config/tsconfig/node-tooling.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo"
+  },
+  "include": [
+    "vite.config.ts",
+    "cli/**/*.ts",
+    "playwright.config.ts",
+    "tests/playwright/**/*.ts"
+  ]
+}

package/tsconfig.server.json

@@ -0,0 +1,19 @@
+{
+  "extends": "@nocobase/dev-config/tsconfig/server-library.json",
+  "compilerOptions": {
+    // Application configuration factories infer exports during the full TypeScript build.
+    "isolatedDeclarations": false,
+    // tsc-alias completes relative ESM paths after compilation.
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "tsc-alias": { "resolveFullPaths": true },
+  "include": [
+    "server/**/*.ts",
+    "database/**/*.ts",
+    "cli/**/*.ts",
+    "workflows/**/*.ts"
+  ]
+}

package/vite.config.ts

@@ -0,0 +1,92 @@
+import { createAppViteConfig } from '@nocobase/dev-config/vite/app';
+import { loadAppVitePlugins } from '@nocobase/dev-config/vite/plugins';
+import agentAnnotations from '@gchust/agent-annotations/vite';
+import path from 'path';
+import {
+  createDevClientConfigPlugin,
+  createDevProxy,
+} from '@nocobase/app-cli/dev/proxy';
+
+const AGENT_ANNOTATIONS_DISABLED_VALUES = new Set(['false', '0', 'no', 'off']);
+
+function isAgentAnnotationsEnabled(value: string | undefined): boolean {
+  const normalized = value?.trim().toLowerCase();
+  return !normalized || !AGENT_ANNOTATIONS_DISABLED_VALUES.has(normalized);
+}
+
+const numberFromEnv = (value: string | undefined): number | undefined => {
+  const parsed = Number(value);
+  return Number.isFinite(parsed) && parsed > 0 ? parsed : undefined;
+};
+
+// https://vite.dev/config/
+export default createAppViteConfig(async (environment) => {
+  const command = environment.command;
+  // Configuration is loaded by the application runtime. Vite should only
+  // consume the environment explicitly supplied by the invoking process;
+  // reading .env here would make the client and server use different paths.
+  const env = process.env;
+  // `pnpm dev` passes the mount path it resolved; the preset serves from it, and a build does not depend on one.
+  const appBase = env.APP_BASE_PATH ?? '';
+  const devClientConfig =
+    command === 'serve'
+      ? createDevClientConfigPlugin(appBase, env.PROXY_TARGET_URL)
+      : undefined;
+  const annotationsEnabled = isAgentAnnotationsEnabled(
+    env.AGENT_ANNOTATIONS_ENABLED,
+  );
+  const viteHmrHost = env.APP_VITE_HMR_HOST;
+  const viteDevPort = numberFromEnv(env.APP_VITE_DEV_PORT) ?? 5173;
+
+  return {
+    root: __dirname,
+    ...(command === 'build' ? { base: env.CDN_BASE_URL?.trim() || './' } : {}),
+    plugins: [
+      ...(await loadAppVitePlugins({ appRoot: __dirname, environment })),
+      ...(devClientConfig ? [devClientConfig] : []),
+      ...(annotationsEnabled
+        ? [
+            agentAnnotations({
+              root: __dirname,
+              clientExtensions: [
+                path.resolve(__dirname, 'client/agent-annotations-host.ts'),
+              ],
+            }),
+          ]
+        : []),
+    ],
+    server: {
+      proxy:
+        command === 'serve'
+          ? createDevProxy(appBase, env.PROXY_TARGET_URL)
+          : undefined,
+      watch: {
+        ignored: [
+          '**/.agent-annotations/**',
+          '**/storage/**',
+          // Vite only excludes dist/client automatically. The server build and
+          // vendored packages also live in dist and can exhaust file watchers.
+          // Scope this to the app so linked dependencies still receive HMR.
+          (filePath: string) => {
+            const relativePath = path.relative(__dirname, filePath);
+            return (
+              relativePath === 'dist' ||
+              relativePath.startsWith(`dist${path.sep}`)
+            );
+          },
+        ],
+      },
+      ...(command === 'serve'
+        ? {
+            hmr: {
+              ...(viteHmrHost ? { host: viteHmrHost } : {}),
+              clientPort: viteDevPort,
+            },
+          }
+        : {}),
+    },
+    resolve: {
+      dedupe: ['react', 'react-dom', 'react-router'],
+    },
+  };
+});

package/vitest.config.ts

@@ -0,0 +1,37 @@
+import { fileURLToPath } from 'node:url';
+
+import { createReactVitestConfig } from '@nocobase/dev-config/vitest/react';
+
+const root = fileURLToPath(new URL('.', import.meta.url));
+
+export default createReactVitestConfig({
+  test: {
+    root,
+    server: {
+      deps: {
+        // Transform the public Client surfaces so vi.mock applies, without duplicating the Server packages' identity tokens.
+        inline: [
+          // The authentication guards read the location, so they share the test's react-router rather than Node's copy,
+          // together with every client that resolves the authentication tokens and provider.
+          /@nocobase\/app-plugin-(?:authentication|api-keys|users)\/(?:dist\/)?client\//u,
+          /@nocobase\/app-plugin-authorization\/(?:dist\/)?client\//u,
+          /@nocobase\/app-plugin-notification-in-app\/(?:dist\/)?client\//u,
+        ],
+      },
+    },
+    // A glob rather than a list of filenames. The list had to be edited by hand for every test added or removed and
+    // silently drifted: it named a file that no longer existed while several real test files were absent from it, so
+    // those tests were never run at all.
+    include: ['tests/**/*.test.{ts,tsx}'],
+    // Playwright runs tests/playwright/ against a built application; its files are named *.test.ts too.
+    exclude: ['tests/playwright/**'],
+    setupFiles: ['./tests/setup/client-config.ts'],
+    // Keep the command usable if an application intentionally removes all scaffold tests before adding its own.
+    passWithNoTests: true,
+    coverage: {
+      provider: 'v8',
+      reportsDirectory: './coverage',
+      reporter: ['text', 'html'],
+    },
+  },
+});

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.