create-bubbles 0.1.26 → 0.1.27

package/template-vp-monorepo-react-nestjs/apps/web/test/router/config.ts

@@ -0,0 +1,140 @@
+import { vi } from 'vite-plus/test'
+import type { AccessContext, AccessScope, WorkspaceEntry, WorkspacesResult } from 'shared/types'
+import { accessScopeKey } from 'shared/utils'
+
+const api = vi.hoisted(() => ({
+  getAccessContext:
+    vi.fn<
+      (
+        scope: AccessScope,
+        options: { workspaceKey: string; signal?: AbortSignal },
+      ) => Promise<AccessContext>
+    >(),
+  getWorkspaces:
+    vi.fn<(options: { workspaceKey: string; signal?: AbortSignal }) => Promise<WorkspacesResult>>(),
+}))
+const session = vi.hoisted(() => ({ token: 'session' as string | null }))
+export { api, session }
+vi.mock('@/pages/workspaces/api', () => api)
+vi.mock('@/utils/request/workspace', () => ({ enterWorkspace: vi.fn() }))
+vi.mock('@/utils/storage/cookie', () => ({ cookie: { get: () => session.token } }))
+
+import { authMiddleware } from '../../src/router/middleware/auth'
+import { accessMiddleware } from '../../src/router/middleware/workspace/access'
+import { scopeMiddleware, workspacesMiddleware } from '../../src/router/middleware/workspace/data'
+import { entryMiddleware } from '../../src/router/middleware/workspace/entry'
+import { getWorkspaceState } from '../../src/pages/workspaces/state'
+import type { RegisteredPage } from '../../src/router/page-registry'
+
+export const companyScope = { type: 'company', companyId: 'company-a' } as const
+export const projectScope = {
+  type: 'project',
+  companyId: 'company-a',
+  projectId: 'project-a',
+} as const
+export const projectPath = '/companies/company-a/projects/project-a'
+const user = { id: 'user', name: '测试成员', account: 'member' }
+
+/** 构造完整权限响应，允许各策略用例只覆盖相关业务字段。 */
+export function access(scope: AccessScope, overrides: Partial<AccessContext> = {}): AccessContext {
+  return {
+    user,
+    scope,
+    administrator: null,
+    permissionKeys: [`${scope.type}.home.read`],
+    menus: [],
+    menuVersion: 1,
+    catalogVersion: 'v1',
+    ...overrides,
+  }
+}
+
+/** 构造列表入口，管理员字段与权限响应可分别模拟。 */
+export function workspace(
+  scope: AccessScope,
+  administrator: WorkspaceEntry['administrator'] = null,
+): WorkspaceEntry {
+  return { scope, name: `${scope.type} 工作空间`, administrator }
+}
+
+/** 重置会话及接口，默认允许所有测试作用域的首页。 */
+export function resetPolicyData() {
+  vi.clearAllMocks()
+  session.token = 'session'
+  const state = getWorkspaceState()
+  state.workspaces = undefined
+  state.accessByScope.clear()
+  api.getAccessContext.mockReset().mockImplementation(async (scope) => access(scope))
+  setWorkspaces([])
+}
+
+/** 为后续列表请求提供可明确控制的空间集合。 */
+export function setWorkspaces(workspaces: WorkspaceEntry[]) {
+  api.getWorkspaces.mockReset().mockResolvedValue({ user, workspaces })
+}
+
+/** 按作用域返回指定权限，未指定的作用域仍有默认首页权限。 */
+export function setAccess(contexts: AccessContext[]) {
+  const byScope = new Map(contexts.map((context) => [accessScopeKey(context.scope), context]))
+  api.getAccessContext.mockImplementation(
+    async (scope) => byScope.get(accessScopeKey(scope)) ?? access(scope),
+  )
+}
+
+/** 用真实 middleware 构建最小页面树，保留生产路由的父子错误边界。 */
+function scopeRoute(type: AccessScope['type'], path: string): RouteObject {
+  const pages = type === 'platform' ? ['home', 'accounts', 'menus'] : ['home', 'members', 'roles']
+  return {
+    id: type,
+    path,
+    middleware: [authMiddleware, scopeMiddleware(type)],
+    errorElement: '作用域不可用',
+    children: pages.map((name): RouteObject => ({
+      id: `${type}.${name}`,
+      ...(name === 'home' ? { index: true as const } : { path: name }),
+      middleware: [accessMiddleware(`${type}.${name}` as RegisteredPage)],
+      element: null,
+      errorElement: '页面不可用',
+    })),
+  }
+}
+
+/** 建立内存路由并提供业务数据读取入口，测试结束必须调用 dispose。 */
+export async function makeRouter() {
+  const router = createMemoryRouter(
+    [
+      {
+        id: 'root',
+        errorElement: '路由不可用',
+        children: [
+          { path: '/placeholder', element: null },
+          { path: '/login', element: null },
+          ...['/', '/home'].map((path) => ({
+            path,
+            middleware: [authMiddleware, workspacesMiddleware, entryMiddleware],
+          })),
+          {
+            path: '/workspaces',
+            middleware: [authMiddleware, workspacesMiddleware],
+            element: null,
+          },
+          scopeRoute('platform', '/platform'),
+          scopeRoute('company', '/companies/:companyId'),
+          scopeRoute('project', '/companies/:companyId/projects/:projectId'),
+        ],
+      },
+    ],
+    { initialEntries: ['/placeholder'] },
+  )
+  await vi.waitFor(() => {
+    if (!router.state.initialized) throw new Error('等待初始导航完成')
+  })
+  return {
+    router,
+    access: (scope: AccessScope) => getWorkspaceState().accessByScope.get(accessScopeKey(scope)),
+    workspaces: () => getWorkspaceState().workspaces,
+    dispose() {
+      router.dispose()
+    },
+  }
+}

package/template-vp-monorepo-react-nestjs/apps/web/test/router/entry.spec.ts

@@ -0,0 +1,179 @@
+import { beforeEach, describe, expect, it } from 'vite-plus/test'
+import { getBuiltinPermissionKeys } from 'shared/utils'
+import {
+  access,
+  api,
+  companyScope,
+  makeRouter,
+  projectPath,
+  projectScope,
+  resetPolicyData,
+  session,
+  setAccess,
+  setWorkspaces,
+  workspace,
+} from './config'
+
+beforeEach(resetPolicyData)
+
+describe('默认入口 middleware 分流', () => {
+  it.each(['/', '/home'])('只有一个项目时从 %s 直接进入项目', async (entry) => {
+    setWorkspaces([workspace(projectScope)])
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate(entry)
+      expect(fixture.router.state.location.pathname).toBe(projectPath)
+      expect(fixture.router.state.errors).toBeNull()
+      expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it('普通企业成员的默认权限不会阻止唯一项目直达', async () => {
+    setWorkspaces([workspace(companyScope), workspace(projectScope)])
+    setAccess([
+      access(companyScope, {
+        permissionKeys: getBuiltinPermissionKeys({ scopeType: 'company', builtin: 'member' }),
+      }),
+    ])
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate('/')
+      expect(fixture.router.state.location.pathname).toBe(projectPath)
+      expect(api.getAccessContext).toHaveBeenNthCalledWith(1, companyScope, {
+        workspaceKey: 'workspaces',
+        signal: expect.any(AbortSignal),
+      })
+      expect(api.getAccessContext).toHaveBeenNthCalledWith(2, projectScope, {
+        workspaceKey: 'workspaces',
+        signal: expect.any(AbortSignal),
+      })
+      expect(api.getAccessContext).toHaveBeenNthCalledWith(3, projectScope, {
+        workspaceKey: 'project:company-a:project-a',
+        signal: expect.any(AbortSignal),
+      })
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it.each([
+    {
+      name: '平台身份',
+      entries: [workspace({ type: 'platform' }, 'platform'), workspace(projectScope)],
+    },
+    { name: '企业管理员', entries: [workspace(companyScope, 'company'), workspace(projectScope)] },
+    {
+      name: '多个项目',
+      entries: [workspace(projectScope), workspace({ ...projectScope, projectId: 'project-b' })],
+    },
+    { name: '没有项目', entries: [workspace(companyScope)] },
+    { name: '没有空间', entries: [] },
+  ])('$name 进入工作空间选择', async ({ entries }) => {
+    setWorkspaces(entries)
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate('/')
+      expect(fixture.router.state.location.pathname).toBe('/workspaces')
+      expect(fixture.workspaces()?.workspaces).toEqual(entries)
+      expect(api.getAccessContext).not.toHaveBeenCalled()
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it.each([
+    {
+      name: '自定义企业管理权限',
+      context: access(companyScope, {
+        permissionKeys: ['company.home.read', 'company.members.read'],
+      }),
+    },
+    { name: '权限响应标记企业管理员', context: access(companyScope, { administrator: 'company' }) },
+  ])('$name 保留工作空间选择', async ({ context }) => {
+    setWorkspaces([workspace(companyScope), workspace(projectScope)])
+    setAccess([context])
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate('/')
+      expect(fixture.router.state.location.pathname).toBe('/workspaces')
+      expect(api.getAccessContext).toHaveBeenCalledTimes(1)
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it('唯一项目首页不可见时直接进入另一个已授权页面', async () => {
+    setWorkspaces([workspace(projectScope)])
+    setAccess([access(projectScope, { permissionKeys: ['project.members.read'] })])
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate('/')
+      expect(fixture.router.state.location.pathname).toBe(`${projectPath}/members`)
+      expect(fixture.router.state.errors).toBeNull()
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it('唯一项目无任何可访问页面时回到选择页', async () => {
+    setWorkspaces([workspace(projectScope)])
+    setAccess([access(projectScope, { permissionKeys: [] })])
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate('/')
+      expect(fixture.router.state.location.pathname).toBe('/workspaces')
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it.each([403, 404])('自动选择期间身份失效 %s 时重新获取选择页列表', async (status) => {
+    setWorkspaces([workspace(projectScope)])
+    api.getAccessContext.mockRejectedValue(Object.assign(new Error('项目身份失效'), { status }))
+    const fixture = await makeRouter()
+    try {
+      await fixture.router.navigate('/')
+      expect(fixture.router.state.location.pathname).toBe('/workspaces')
+      expect(fixture.router.state.errors).toBeNull()
+      expect(api.getWorkspaces).toHaveBeenCalledTimes(2)
+    } finally {
+      fixture.dispose()
+    }
+  })
+
+  it.each(['/workspaces', '/companies/company-a', `${projectPath}/members`])(
+    '显式进入 %s 不触发默认分流',
+    async (destination) => {
+      setWorkspaces([workspace(companyScope), workspace(projectScope)])
+      setAccess([access(projectScope, { permissionKeys: ['project.members.read'] })])
+      const fixture = await makeRouter()
+      try {
+        await fixture.router.navigate(destination)
+        expect(fixture.router.state.location.pathname).toBe(destination)
+        expect(fixture.router.state.errors).toBeNull()
+        expect(api.getWorkspaces).toHaveBeenCalledTimes(1)
+        expect(api.getAccessContext).toHaveBeenCalledTimes(destination === '/workspaces' ? 0 : 1)
+      } finally {
+        fixture.dispose()
+      }
+    },
+  )
+
+  it.each(['/', '/home', '/workspaces', projectPath])(
+    '未登录访问 %s 时不请求工作空间数据',
+    async (destination) => {
+      session.token = null
+      const fixture = await makeRouter()
+      try {
+        await fixture.router.navigate(destination)
+        expect(fixture.router.state.location.pathname).toBe('/login')
+        expect(api.getWorkspaces).not.toHaveBeenCalled()
+        expect(api.getAccessContext).not.toHaveBeenCalled()
+      } finally {
+        fixture.dispose()
+      }
+    },
+  )
+})

package/template-vp-monorepo-react-nestjs/apps/web/test/router/workspace-data.spec.ts

@@ -0,0 +1,112 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vite-plus/test'
+import type { AccessContext } from 'shared/types'
+import {
+  access,
+  api,
+  makeRouter,
+  projectPath,
+  projectScope,
+  resetPolicyData,
+  session,
+  setWorkspaces,
+  workspace,
+} from './config'
+
+let fixture: Awaited<ReturnType<typeof makeRouter>>
+beforeEach(async () => {
+  resetPolicyData()
+  setWorkspaces([workspace(projectScope)])
+  fixture = await makeRouter()
+})
+afterEach(() => fixture?.dispose())
+
+describe('工作空间数据交接', () => {
+  it('切换项目等待期间保留原项目权限，完成后按新项目读取且无需 loader', async () => {
+    await fixture.router.navigate(projectPath)
+    api.getAccessContext.mockClear()
+    api.getWorkspaces.mockClear()
+    const nextScope = { ...projectScope, projectId: 'project-b' }
+    const nextWorkspaceKey = 'project:company-a:project-b'
+    let resolve!: (value: AccessContext) => void
+    api.getAccessContext.mockImplementationOnce(
+      () =>
+        new Promise<AccessContext>((done) => {
+          resolve = done
+        }),
+    )
+    const navigation = fixture.router.navigate('/companies/company-a/projects/project-b')
+    await vi.waitFor(() => expect(resolve).toBeDefined())
+    expect(api.getAccessContext).toHaveBeenCalledWith(nextScope, {
+      workspaceKey: nextWorkspaceKey,
+      signal: expect.any(AbortSignal),
+    })
+    expect(api.getWorkspaces).toHaveBeenCalledWith({
+      workspaceKey: nextWorkspaceKey,
+      signal: expect.any(AbortSignal),
+    })
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+    expect(fixture.access(nextScope)).toBeUndefined()
+    resolve(access(nextScope))
+    await navigation
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+    expect(fixture.access(nextScope)?.scope).toEqual(nextScope)
+    expect(fixture.router.state.errors).toBeNull()
+    expect(fixture.router.state.loaderData).toEqual({})
+  })
+
+  it('同位置撤销空间身份后清除权限，重新校验成功可以恢复', async () => {
+    await fixture.router.navigate(projectPath)
+    const key = fixture.router.state.location.key
+    api.getAccessContext.mockRejectedValueOnce(
+      Object.assign(new Error('身份已撤销'), { status: 403 }),
+    )
+    await fixture.router.revalidate()
+    expect(fixture.access(projectScope)).toBeUndefined()
+    expect(Object.values(fixture.router.state.errors ?? {})).toEqual([
+      expect.objectContaining({ status: 403 }),
+    ])
+    await fixture.router.revalidate()
+    expect(fixture.router.state.location.key).toBe(key)
+    expect(fixture.router.state.errors).toBeNull()
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+  })
+
+  it('取消刷新不会清掉已经验证的空间权限', async () => {
+    await fixture.router.navigate(projectPath)
+    api.getAccessContext.mockRejectedValueOnce(new DOMException('请求已取消', 'AbortError'))
+    await fixture.router.revalidate()
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+  })
+
+  it('更换账号后不再读取原账号的列表与空间权限', async () => {
+    await fixture.router.navigate('/workspaces')
+    await fixture.router.navigate(projectPath)
+    session.token = 'another-account'
+    expect(fixture.workspaces()).toBeUndefined()
+    expect(fixture.access(projectScope)).toBeUndefined()
+    await fixture.router.revalidate()
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+  })
+
+  it('Hash 导航仍可读取当前空间，查询参数变化重新取权限', async () => {
+    await fixture.router.navigate(projectPath)
+    await fixture.router.navigate(`${projectPath}#section`)
+    expect(api.getAccessContext).toHaveBeenCalledTimes(1)
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+    await fixture.router.navigate(`${projectPath}?view=details#section`)
+    expect(api.getAccessContext).toHaveBeenCalledTimes(2)
+    expect(fixture.access(projectScope)?.scope).toEqual(projectScope)
+  })
+
+  it('列表刷新失败不保留旧列表，重试后可显示最新空列表', async () => {
+    await fixture.router.navigate('/workspaces')
+    expect(fixture.workspaces()?.workspaces).toHaveLength(1)
+    api.getWorkspaces.mockRejectedValueOnce(new Error('列表获取失败'))
+    await fixture.router.revalidate()
+    expect(fixture.workspaces()).toBeUndefined()
+    setWorkspaces([])
+    await fixture.router.revalidate()
+    expect(fixture.router.state.errors).toBeNull()
+    expect(fixture.workspaces()?.workspaces).toEqual([])
+  })
+})