@nocobase/test 0.21.0-alpha.1 → 0.21.0-alpha.10

package/es/client/index.d.ts

@@ -1,7 +1,19 @@
-/// <reference types="react" />
+import React, { FC } from 'react';
+import { GetAppComponentOptions, GetAppOptions } from '../web';
 export { renderHook } from '@testing-library/react-hooks';
 declare function customRender(ui: React.ReactElement, options?: {}): import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
 export * from '@testing-library/react';
 export { default as userEvent } from '@testing-library/user-event';
 export { customRender as render };
 export declare const sleep: (timeout?: number) => Promise<unknown>;
+export declare const WaitApp: () => Promise<void>;
+interface RenderHookOptions extends Omit<GetAppOptions, 'value' | 'onChange'> {
+    hook: () => any;
+    props?: any;
+    Wrapper?: FC<{
+        children: React.ReactNode;
+    }>;
+}
+export declare const renderHookWithApp: (options: RenderHookOptions) => Promise<import("@testing-library/react-hooks").RenderHookResult<any, any, import("@testing-library/react-hooks").Renderer<any>>>;
+export declare const renderApp: (options: GetAppComponentOptions) => Promise<import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>>;
+export declare const renderReadPrettyApp: (options: GetAppComponentOptions) => Promise<import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>>;

package/es/client/index.mjs

@@ -1,7 +1,504 @@
-import { render } from "@testing-library/react";
+import { expect } from "vitest";
+import React, { Fragment } from "react";
+import { render, waitFor, screen } from "@testing-library/react";
 export * from "@testing-library/react";
 import { renderHook } from "@testing-library/react-hooks";
+import { renderHook as renderHook2 } from "@testing-library/react-hooks";
+import MockAdapter from "axios-mock-adapter";
+import { Application, LocalDataSource, SchemaComponent, DataBlockProvider } from "@nocobase/client";
 import { default as default2 } from "@testing-library/user-event";
+const dataSourceMainCollections = [
+  {
+    key: "h7b9i8khc3q",
+    name: "users",
+    inherit: false,
+    hidden: false,
+    description: null,
+    category: [],
+    namespace: "users.users",
+    duplicator: {
+      dumpable: "optional",
+      "with": "rolesUsers"
+    },
+    sortable: "sort",
+    model: "UserModel",
+    createdBy: true,
+    updatedBy: true,
+    logging: true,
+    from: "db2cm",
+    title: '{{t("Users")}}',
+    rawTitle: '{{t("Users")}}',
+    fields: [
+      {
+        uiSchema: {
+          type: "number",
+          title: '{{t("ID")}}',
+          "x-component": "InputNumber",
+          "x-read-pretty": true,
+          rawTitle: '{{t("ID")}}'
+        },
+        key: "ffp1f2sula0",
+        name: "id",
+        type: "bigInt",
+        "interface": "id",
+        description: null,
+        collectionName: "users",
+        parentKey: null,
+        reverseKey: null,
+        autoIncrement: true,
+        primaryKey: true,
+        allowNull: false
+      },
+      {
+        uiSchema: {
+          type: "string",
+          title: '{{t("Nickname")}}',
+          "x-component": "Input",
+          rawTitle: '{{t("Nickname")}}'
+        },
+        key: "vrv7yjue90g",
+        name: "nickname",
+        type: "string",
+        "interface": "input",
+        description: null,
+        collectionName: "users",
+        parentKey: null,
+        reverseKey: null
+      },
+      {
+        uiSchema: {
+          type: "string",
+          title: '{{t("Username")}}',
+          "x-component": "Input",
+          "x-validator": {
+            username: true
+          },
+          required: true,
+          rawTitle: '{{t("Username")}}'
+        },
+        key: "2ccs6evyrub",
+        name: "username",
+        type: "string",
+        "interface": "input",
+        description: null,
+        collectionName: "users",
+        parentKey: null,
+        reverseKey: null,
+        unique: true
+      },
+      {
+        uiSchema: {
+          type: "string",
+          title: '{{t("Email")}}',
+          "x-component": "Input",
+          "x-validator": "email",
+          required: true,
+          rawTitle: '{{t("Email")}}'
+        },
+        key: "rrskwjl5wt1",
+        name: "email",
+        type: "string",
+        "interface": "email",
+        description: null,
+        collectionName: "users",
+        parentKey: null,
+        reverseKey: null,
+        unique: true
+      },
+      {
+        key: "t09bauwm0wb",
+        name: "roles",
+        type: "belongsToMany",
+        "interface": "m2m",
+        description: null,
+        collectionName: "users",
+        parentKey: null,
+        reverseKey: null,
+        target: "roles",
+        foreignKey: "userId",
+        otherKey: "roleName",
+        onDelete: "CASCADE",
+        sourceKey: "id",
+        targetKey: "name",
+        through: "rolesUsers",
+        uiSchema: {
+          type: "array",
+          title: '{{t("Roles")}}',
+          "x-component": "AssociationField",
+          "x-component-props": {
+            multiple: true,
+            fieldNames: {
+              label: "title",
+              value: "name"
+            }
+          }
+        }
+      },
+      {
+        key: "1pz0art9mt7",
+        name: "f_n2fu6hvprct",
+        type: "string",
+        "interface": "select",
+        description: null,
+        collectionName: "t_vwpds9fs4xs",
+        parentKey: null,
+        reverseKey: null,
+        uiSchema: {
+          "enum": [
+            {
+              value: "test1",
+              label: "test1"
+            },
+            {
+              value: "test2",
+              label: "test2"
+            }
+          ],
+          type: "string",
+          "x-component": "Select",
+          title: "test"
+        }
+      }
+    ]
+  },
+  {
+    key: "pqnenvqrzxr",
+    name: "roles",
+    inherit: false,
+    hidden: false,
+    description: null,
+    category: [],
+    namespace: "acl.acl",
+    duplicator: {
+      dumpable: "required",
+      "with": "uiSchemas"
+    },
+    autoGenId: false,
+    model: "RoleModel",
+    filterTargetKey: "name",
+    sortable: true,
+    from: "db2cm",
+    title: '{{t("Roles")}}',
+    rawTitle: '{{t("Roles")}}',
+    fields: [
+      {
+        uiSchema: {
+          type: "string",
+          title: '{{t("Role UID")}}',
+          "x-component": "Input",
+          rawTitle: '{{t("Role UID")}}'
+        },
+        key: "jbz9m80bxmp",
+        name: "name",
+        type: "uid",
+        "interface": "input",
+        description: null,
+        collectionName: "roles",
+        parentKey: null,
+        reverseKey: null,
+        prefix: "r_",
+        primaryKey: true
+      },
+      {
+        uiSchema: {
+          type: "string",
+          title: '{{t("Role name")}}',
+          "x-component": "Input",
+          rawTitle: '{{t("Role name")}}'
+        },
+        key: "faywtz4sf3u",
+        name: "title",
+        type: "string",
+        "interface": "input",
+        description: null,
+        collectionName: "roles",
+        parentKey: null,
+        reverseKey: null,
+        unique: true,
+        translation: true
+      },
+      {
+        key: "1enkovm9sye",
+        name: "description",
+        type: "string",
+        "interface": null,
+        description: null,
+        collectionName: "roles",
+        parentKey: null,
+        reverseKey: null
+      }
+    ]
+  }
+];
+const key = "data-source2";
+const displayName = "Data Source 2";
+const status = "loaded";
+const type = "postgres";
+const isDBInstance = true;
+const collections = [
+  {
+    name: "test",
+    title: "test",
+    tableName: "test",
+    timestamps: false,
+    autoGenId: false,
+    filterTargetKey: "id",
+    fields: [
+      {
+        name: "id",
+        type: "integer",
+        allowNull: false,
+        primaryKey: false,
+        unique: false,
+        autoIncrement: true,
+        possibleTypes: [
+          "integer",
+          "sort"
+        ],
+        rawType: "INTEGER",
+        "interface": "integer",
+        uiSchema: {
+          type: "number",
+          "x-component": "InputNumber",
+          "x-component-props": {
+            stringMode: true,
+            step: "1"
+          },
+          "x-validator": "integer",
+          title: "id"
+        }
+      },
+      {
+        name: "title",
+        type: "string",
+        allowNull: false,
+        primaryKey: false,
+        unique: false,
+        possibleTypes: [
+          "string",
+          "uuid",
+          "nanoid"
+        ],
+        rawType: "CHARACTER VARYING(255)",
+        "interface": "input",
+        uiSchema: {
+          "x-component": "Input",
+          "x-component-props": {
+            style: {
+              width: "100%"
+            }
+          },
+          title: "title"
+        }
+      },
+      {
+        name: "content",
+        type: "text",
+        allowNull: true,
+        primaryKey: false,
+        unique: false,
+        rawType: "TEXT",
+        "interface": "textarea",
+        uiSchema: {
+          type: "string",
+          "x-component": "Input.TextArea",
+          title: "content"
+        }
+      }
+    ],
+    introspected: true
+  },
+  {
+    name: "test2",
+    title: "test2",
+    tableName: "test2",
+    timestamps: false,
+    autoGenId: false,
+    filterTargetKey: "id",
+    fields: [
+      {
+        name: "id",
+        type: "integer",
+        allowNull: false,
+        primaryKey: true,
+        unique: false,
+        autoIncrement: true,
+        possibleTypes: [
+          "integer",
+          "sort"
+        ],
+        rawType: "INTEGER",
+        "interface": "integer",
+        uiSchema: {
+          type: "number",
+          "x-component": "InputNumber",
+          "x-component-props": {
+            stringMode: true,
+            step: "1"
+          },
+          "x-validator": "integer",
+          title: "id"
+        }
+      },
+      {
+        name: "title",
+        type: "string",
+        allowNull: true,
+        primaryKey: false,
+        unique: false,
+        possibleTypes: [
+          "string",
+          "uuid",
+          "nanoid"
+        ],
+        rawType: "CHARACTER VARYING(255)",
+        "interface": "input",
+        uiSchema: {
+          "x-component": "Input",
+          "x-component-props": {
+            style: {
+              width: "100%"
+            }
+          },
+          title: "title"
+        }
+      },
+      {
+        name: "content",
+        type: "text",
+        allowNull: true,
+        primaryKey: false,
+        unique: false,
+        rawType: "TEXT",
+        "interface": "textarea",
+        uiSchema: {
+          type: "string",
+          "x-component": "Input.TextArea",
+          title: "content"
+        }
+      }
+    ],
+    introspected: true
+  }
+];
+const dataSource2 = {
+  key,
+  displayName,
+  status,
+  type,
+  isDBInstance,
+  collections
+};
+const data = [
+  {
+    f_o3y6p9gf1gx: null,
+    createdAt: "2023-03-30T07:53:10.941Z",
+    updatedAt: "2024-04-12T03:27:45.748Z",
+    appLang: "zh-CN",
+    createdById: null,
+    email: "admin@nocobase.com",
+    f_2ytvt3phlp2: null,
+    f_3jl554hv7lt: null,
+    f_51qityssoq1: null,
+    f_dybwctlb233: null,
+    f_hbegrnglpv2: null,
+    f_ndkyrfvh9il: null,
+    f_o33xmbd62fj: null,
+    f_t52vqdtfv4h: null,
+    f_vak0o8efq4v: [],
+    id: 1,
+    nickname: "Super Admin",
+    phone: null,
+    systemSettings: {
+      theme: "compact",
+      themeId: 1
+    },
+    updatedById: 1,
+    username: "nocobase"
+  }
+];
+const usersListData = {
+  data
+};
+const mockApi = (axiosInstance, apis = {}) => {
+  const mock = new MockAdapter(axiosInstance);
+  Object.keys(apis).forEach((key2) => {
+    mock.onAny(key2).reply(200, apis[key2]);
+  });
+  return (apis2 = {}) => {
+    Object.keys(apis2).forEach((key2) => {
+      mock.onAny(key2).reply(200, apis2[key2]);
+    });
+  };
+};
+const mockAppApi = (app, apis = {}) => {
+  const mock = mockApi(app.apiClient.axios, apis);
+  return mock;
+};
+const getApp = (options) => {
+  const { appOptions, enableUserListDataBlock, providers, apis, enableMultipleDataSource } = options;
+  const app = appOptions instanceof Application ? appOptions : new Application(appOptions);
+  if (providers) {
+    app.addProviders(providers);
+  }
+  app.getCollectionManager().addCollections(dataSourceMainCollections);
+  if (enableUserListDataBlock && !apis["users:list"]) {
+    apis["users:list"] = usersListData;
+  }
+  if (enableMultipleDataSource) {
+    app.dataSourceManager.addDataSource(LocalDataSource, dataSource2);
+  }
+  mockAppApi(app, apis);
+  const App = app.getRootComponent();
+  return {
+    App,
+    app
+  };
+};
+const getAppComponent = (options) => {
+  const {
+    Component,
+    enableUserListDataBlock,
+    enableMultipleDataSource,
+    value,
+    props,
+    appOptions,
+    apis,
+    onChange,
+    schema: optionsSchema = {}
+  } = options;
+  const schema = {
+    type: "object",
+    name: "test",
+    default: value,
+    "x-component": Component,
+    "x-component-props": {
+      onChange,
+      ...props
+    },
+    ...optionsSchema
+  };
+  if (!schema.name) {
+    schema.name = "test";
+  }
+  if (!schema.type) {
+    schema.type = "void";
+  }
+  const TestDemo = () => {
+    if (!enableUserListDataBlock) {
+      return /* @__PURE__ */ React.createElement(SchemaComponent, { schema });
+    }
+    return /* @__PURE__ */ React.createElement(DataBlockProvider, { collection: "users", action: "list" }, /* @__PURE__ */ React.createElement(SchemaComponent, { schema }));
+  };
+  const { App } = getApp({
+    appOptions,
+    apis,
+    providers: [TestDemo],
+    enableMultipleDataSource,
+    enableUserListDataBlock
+  });
+  return App;
+};
 function customRender(ui, options = {}) {
   return render(ui, {
     // wrap provider(s) here if needed
@@ -14,9 +511,35 @@ const sleep = async (timeout = 0) => {
     setTimeout(resolve, timeout);
   });
 };
+const WaitApp = async () => {
+  await waitFor(() => {
+    expect(screen.queryByText("Loading...")).not.toBeInTheDocument();
+  });
+};
+const renderHookWithApp = async (options) => {
+  const { hook: useHook, props, Wrapper = Fragment, ...otherOptions } = options;
+  const { App } = getApp(otherOptions);
+  const WrapperValue = ({ children }) => /* @__PURE__ */ React.createElement(App, null, /* @__PURE__ */ React.createElement(Wrapper, null, children));
+  const res = renderHook(() => useHook(), { wrapper: WrapperValue, initialProps: props });
+  await WaitApp();
+  return res;
+};
+const renderApp = async (options) => {
+  const App = getAppComponent(options);
+  const res = render(/* @__PURE__ */ React.createElement(App, null));
+  await WaitApp();
+  return res;
+};
+const renderReadPrettyApp = (options) => {
+  return renderApp({ ...options, schema: { ...options.schema || {}, "x-read-pretty": true } });
+};
 export {
+  WaitApp,
   customRender as render,
-  renderHook,
+  renderApp,
+  renderHook2 as renderHook,
+  renderHookWithApp,
+  renderReadPrettyApp,
   sleep,
   default2 as userEvent
 };

package/es/e2e/e2eUtils.d.ts

@@ -5,6 +5,7 @@ export { defineConfig };
 export interface CollectionSetting {
     name: string;
     title?: string;
+    titleField?: string;
     /**
      * @default 'general'
      */
@@ -47,6 +48,7 @@ export interface CollectionSetting {
      * @default false
      */
     inherit?: boolean;
+    inherits?: string[];
     category?: any[];
     hidden?: boolean;
     description?: string;
@@ -183,11 +185,21 @@ interface ExtendUtils {
     mockCollection: (collectionSetting: CollectionSetting) => Promise<any>;
     /**
      * 自动生成一条对应 collection 的数据
-     * @param collectionName 数据表名称
-     * @param data 自定义的数据，缺失时会生成随机数据
      * @returns 返回一条生成的数据
      */
-    mockRecord: <T = any>(collectionName: string, data?: any) => Promise<T>;
+    mockRecord: {
+        /**
+         * @param collectionName 数据表名称
+         * @param data 自定义的数据，缺失时会生成随机数据
+         * @param maxDepth - 生成的数据的最大深度，默认为 4，当不想生成太多数据时可以设置一个较低的值
+         */
+        <T = any>(collectionName: string, data?: any, maxDepth?: number): Promise<T>;
+        /**
+         * @param collectionName 数据表名称
+         * @param maxDepth - 生成的数据的最大深度，默认为 4，当不想生成太多数据时可以设置一个较低的值
+         */
+        <T = any>(collectionName: string, maxDepth?: number): Promise<T>;
+    };
     /**
      * 自动生成多条对应 collection 的数据
      */
@@ -195,13 +207,15 @@ interface ExtendUtils {
         /**
          * @param collectionName - 数据表名称
          * @param count - 生成的数据条数
+         * @param maxDepth - 生成的数据的最大深度，默认为 4，当不想生成太多数据时可以设置一个较低的值
          */
-        <T = any>(collectionName: string, count?: number): Promise<T[]>;
+        <T = any>(collectionName: string, count?: number, maxDepth?: number): Promise<T[]>;
         /**
          * @param collectionName - 数据表名称
          * @param data - 指定生成的数据
+         * @param maxDepth - 生成的数据的最大深度，默认为 4，当不想生成太多数据时可以设置一个较低的值
          */
-        <T = any>(collectionName: string, data?: any[]): Promise<T[]>;
+        <T = any>(collectionName: string, data?: any[], maxDepth?: number): Promise<T[]>;
     };
     /**
      * 该方法已弃用，请使用 mockCollections
@@ -233,6 +247,10 @@ interface ExtendUtils {
      * @param key 外部数据源key
      */
     destoryExternalDataSource: <T = any>(key: string) => Promise<T>;
+    /**
+     * 清空区块模板
+     */
+    clearBlockTemplates: () => Promise<void>;
 }
 export declare class NocoPage {
     private options?;
@@ -259,6 +277,12 @@ export declare const test: import("@playwright/test").TestType<import("@playwrig
         (callback: (args: import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & ExtendUtils & import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions) => boolean, description?: string): void;
     };
 };
+/**
+ * 将数据表中 mock 出来的 records 删除掉
+ * @param collectionName
+ * @param records
+ */
+export declare const deleteRecords: (collectionName: string, filter: any) => Promise<void>;
 /**
  * 删除一些不需要的字段，如 key
  * @param collectionSettings
@@ -280,10 +304,11 @@ export declare function expectSettingsMenu({ showMenu, supportedOptions, page, u
  * 辅助断言 Initializer 的菜单项是否存在
  * @param param0
  */
-export declare function expectInitializerMenu({ showMenu, supportedOptions, page }: {
-    showMenu: any;
-    supportedOptions: any;
-    page: any;
+export declare function expectInitializerMenu({ showMenu, supportedOptions, page, expectValue, }: {
+    showMenu: () => Promise<void>;
+    supportedOptions: string[];
+    page: Page;
+    expectValue?: () => Promise<void>;
 }): Promise<void>;
 /**
  * 用于辅助在 page 中创建区块
@@ -291,3 +316,4 @@ export declare function expectInitializerMenu({ showMenu, supportedOptions, page
  * @param name
  */
 export declare const createBlockInPage: (page: Page, name: string) => Promise<void>;
+export declare const mockUserRecordsWithoutDepartments: (mockRecords: ExtendUtils['mockRecords'], count: number) => Promise<any[]>;