plugin-data-source-mssql 2.0.11 → 2.0.12

package/dist/tedious/node_modules/wsl-utils/readme.md

@@ -0,0 +1,50 @@
+# wsl-utils
+
+> Utilities for working with [Windows Subsystem for Linux (WSL)](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux)
+
+## Install
+
+```sh
+npm install wsl-utils
+```
+
+## Usage
+
+```js
+import {isWsl, powerShellPathFromWsl} from 'wsl-utils';
+
+// Check if running in WSL
+console.log('Is WSL:', isWsl);
+
+// Get PowerShell path from WSL
+console.log('PowerShell path:', await powerShellPathFromWsl());
+//=> '/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe'
+```
+
+## API
+
+### isWsl
+
+Type: `boolean`
+
+Check if the current environment is Windows Subsystem for Linux (WSL).
+
+### powerShellPathFromWsl()
+
+Returns: `Promise<string>`
+
+Get the PowerShell executable path in WSL environment.
+
+### powerShellPath()
+
+Returns: `Promise<string>`
+
+Get the PowerShell executable path for the current environment.
+
+Returns WSL path if in WSL, otherwise returns Windows path.
+
+### wslDrivesMountPoint()
+
+Returns: `Promise<string>`
+
+Get the mount point for fixed drives in WSL.

package/package.json

@@ -3,9 +3,9 @@
   "displayName": "Data source: MSSQL",
   "displayName.ru-RU": "Источник данных: MSSQL",
   "displayName.zh-CN": "数据源：MSSQL",
-  "version": "2.0.11",
+  "version": "2.0.12",
   "description": "External MSSQL data source support for NocoBase.",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "main": "dist/server/index.js",
   "scripts": {
     "postbuild": "node ./scripts/copy-tedious.js",
@@ -42,5 +42,15 @@
     "@nocobase/test": "2.x",
     "@nocobase/client-v2": "2.x",
     "@nocobase/flow-engine": "2.x"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OrgGem/nocobase-beta.git",
+    "directory": "packages/plugins/plugin-data-source-mssql"
+  },
+  "gitHead": "4750faf567bd9dd662a55d30fb2a0f2b6aa39d6f",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   }
 }

package/server.d.ts

@@ -1 +1 @@
-export * from './dist/server';
+export * from './dist/server';

package/src/client/components/MssqlConfigForm.tsx

@@ -1,92 +1,92 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-import React, { useCallback, useState } from 'react';
-import { Checkbox, Form, Input, InputNumber, Select } from 'antd';
-import { useTranslation } from 'react-i18next';
-
-interface MssqlConfigFormProps {
-  mode: 'create' | 'edit';
-  type: Record<string, any>;
-  initialValues?: Record<string, any>;
-  loadCollections: (key: string) => Promise<any>;
-}
-
-function toCollectionOptions(result: any): { label: string; value: string }[] {
-  const list = result?.data?.data ?? result?.data ?? result ?? [];
-  if (!Array.isArray(list)) return [];
-  return list.map((item: any) => {
-    const name = typeof item === 'string' ? item : item?.name;
-    return { label: name, value: name };
-  });
-}
-
-export const MssqlConfigForm: React.FC<MssqlConfigFormProps> = ({ initialValues, loadCollections }) => {
-  const { t } = useTranslation();
-  const form = Form.useFormInstance();
-  const addAllCollections = Form.useWatch('addAllCollections', form);
-  const [collectionOptions, setCollectionOptions] = useState<{ label: string; value: string }[]>([]);
-  const [loading, setLoading] = useState(false);
-
-  const handleLoadCollections = useCallback(async () => {
-    setLoading(true);
-    try {
-      const result = await loadCollections(initialValues?.key);
-      setCollectionOptions(toCollectionOptions(result));
-    } finally {
-      setLoading(false);
-    }
-  }, [loadCollections, initialValues?.key]);
-
-  return (
-    <>
-      <Form.Item name={['options', 'host']} label={t('Host')} rules={[{ required: true }]}>
-        <Input placeholder="localhost" />
-      </Form.Item>
-      <Form.Item name={['options', 'port']} label={t('Port')} rules={[{ required: true }]} initialValue={1433}>
-        <InputNumber min={1} max={65535} style={{ width: '100%' }} />
-      </Form.Item>
-      <Form.Item name={['options', 'database']} label={t('Database')} rules={[{ required: true }]}>
-        <Input />
-      </Form.Item>
-      <Form.Item name={['options', 'schema']} label={t('Schema')}>
-        <Input />
-      </Form.Item>
-      <Form.Item name={['options', 'username']} label={t('Username')} rules={[{ required: true }]}>
-        <Input />
-      </Form.Item>
-      <Form.Item name={['options', 'password']} label={t('Password')}>
-        <Input.Password />
-      </Form.Item>
-      <Form.Item name={['options', 'encrypt']} label={t('Encrypt')} valuePropName="checked">
-        <Checkbox />
-      </Form.Item>
-      <Form.Item name={['options', 'tablePrefix']} label={t('Table prefix')}>
-        <Input />
-      </Form.Item>
-      <Form.Item name="addAllCollections" label={t('Load all collections')} valuePropName="checked" initialValue={true}>
-        <Checkbox />
-      </Form.Item>
-      {!addAllCollections ? (
-        <Form.Item name="collections" label={t('Collections')}>
-          <Select
-            mode="multiple"
-            allowClear
-            loading={loading}
-            options={collectionOptions}
-            onFocus={handleLoadCollections}
-            optionFilterProp="label"
-          />
-        </Form.Item>
-      ) : null}
-    </>
-  );
-};
-
-export default MssqlConfigForm;
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import React, { useCallback, useState } from 'react';
+import { Checkbox, Form, Input, InputNumber, Select } from 'antd';
+import { useTranslation } from 'react-i18next';
+
+interface MssqlConfigFormProps {
+  mode: 'create' | 'edit';
+  type: Record<string, any>;
+  initialValues?: Record<string, any>;
+  loadCollections: (key: string) => Promise<any>;
+}
+
+function toCollectionOptions(result: any): { label: string; value: string }[] {
+  const list = result?.data?.data ?? result?.data ?? result ?? [];
+  if (!Array.isArray(list)) return [];
+  return list.map((item: any) => {
+    const name = typeof item === 'string' ? item : item?.name;
+    return { label: name, value: name };
+  });
+}
+
+export const MssqlConfigForm: React.FC<MssqlConfigFormProps> = ({ initialValues, loadCollections }) => {
+  const { t } = useTranslation();
+  const form = Form.useFormInstance();
+  const addAllCollections = Form.useWatch('addAllCollections', form);
+  const [collectionOptions, setCollectionOptions] = useState<{ label: string; value: string }[]>([]);
+  const [loading, setLoading] = useState(false);
+
+  const handleLoadCollections = useCallback(async () => {
+    setLoading(true);
+    try {
+      const result = await loadCollections(initialValues?.key);
+      setCollectionOptions(toCollectionOptions(result));
+    } finally {
+      setLoading(false);
+    }
+  }, [loadCollections, initialValues?.key]);
+
+  return (
+    <>
+      <Form.Item name={['options', 'host']} label={t('Host')} rules={[{ required: true }]}>
+        <Input placeholder="localhost" />
+      </Form.Item>
+      <Form.Item name={['options', 'port']} label={t('Port')} rules={[{ required: true }]} initialValue={1433}>
+        <InputNumber min={1} max={65535} style={{ width: '100%' }} />
+      </Form.Item>
+      <Form.Item name={['options', 'database']} label={t('Database')} rules={[{ required: true }]}>
+        <Input />
+      </Form.Item>
+      <Form.Item name={['options', 'schema']} label={t('Schema')}>
+        <Input />
+      </Form.Item>
+      <Form.Item name={['options', 'username']} label={t('Username')} rules={[{ required: true }]}>
+        <Input />
+      </Form.Item>
+      <Form.Item name={['options', 'password']} label={t('Password')}>
+        <Input.Password />
+      </Form.Item>
+      <Form.Item name={['options', 'encrypt']} label={t('Encrypt')} valuePropName="checked">
+        <Checkbox />
+      </Form.Item>
+      <Form.Item name={['options', 'tablePrefix']} label={t('Table prefix')}>
+        <Input />
+      </Form.Item>
+      <Form.Item name="addAllCollections" label={t('Load all collections')} valuePropName="checked" initialValue={true}>
+        <Checkbox />
+      </Form.Item>
+      {!addAllCollections ? (
+        <Form.Item name="collections" label={t('Collections')}>
+          <Select
+            mode="multiple"
+            allowClear
+            loading={loading}
+            options={collectionOptions}
+            onFocus={handleLoadCollections}
+            optionFilterProp="label"
+          />
+        </Form.Item>
+      ) : null}
+    </>
+  );
+};
+
+export default MssqlConfigForm;

package/src/client/index.tsx

@@ -8,13 +8,12 @@
  */
 
 import { Plugin } from '@nocobase/client';
-import PluginDataSourceManagerClient from '@nocobase/plugin-data-source-manager/client';
+import PluginDataSourceManagerClient from '@nocobase/plugin-data-source-manager';
 import { MssqlConfigForm } from './components/MssqlConfigForm';
 import { MssqlDeleteCollection } from './components/MssqlDeleteCollection';
 
 export class PluginDataSourceMssqlClient extends Plugin {
   async load() {
-    console.log('[MSSQL Plugin] Client loading...');
     const manager = this.app.pm.get(PluginDataSourceManagerClient);
 
     manager.registerType('mssql', {

package/src/client-v2/MssqlDeleteCollection.tsx

@@ -0,0 +1,78 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import React, { useState } from 'react';
+import { Button, Checkbox, Modal } from 'antd';
+import { useFlowContext } from '@nocobase/flow-engine';
+import type { DataSourceCollectionActionProps } from '@nocobase/plugin-data-source-manager/client-v2';
+import { useTranslation } from 'react-i18next';
+
+export function MssqlDeleteCollection({
+  dataSourceKey,
+  record,
+  selectedRowKeys,
+  onSubmitted,
+  children,
+  isBulk,
+}: DataSourceCollectionActionProps) {
+  const ctx = useFlowContext();
+  const { t } = useTranslation('plugin-data-source-mssql');
+  const [open, setOpen] = useState(false);
+  const [pending, setPending] = useState(false);
+  const [cascade, setCascade] = useState(false);
+  const keys = isBulk ? selectedRowKeys || [] : record?.name ? [record.name] : [];
+  async function submit() {
+    if (!keys.length) return;
+    setPending(true);
+    try {
+      await ctx.api.request({
+        url: `dataSources/${encodeURIComponent(dataSourceKey)}/collections:destroy`,
+        method: 'post',
+        params: { filterByTk: keys, cascade: cascade },
+      });
+      setOpen(false);
+      ctx.dataSourceManager.getDataSource(dataSourceKey)?.reload();
+      onSubmitted?.();
+    } catch {
+      ctx.message.error(t('Failed to delete collection'));
+    } finally {
+      setPending(false);
+    }
+  }
+  return (
+    <>
+      <Button
+        type={isBulk ? 'default' : 'link'}
+        danger
+        disabled={!keys.length}
+        onClick={() => {
+          setCascade(false);
+          setOpen(true);
+        }}
+      >
+        {children || t('Delete')}
+      </Button>
+      <Modal
+        open={open}
+        title={t('Delete collection')}
+        confirmLoading={pending}
+        okButtonProps={{ danger: true }}
+        onOk={submit}
+        onCancel={() => setOpen(false)}
+      >
+        <p>{t('Are you sure you want to delete it?')}</p>
+        <Checkbox checked={cascade} onChange={(event) => setCascade(event.target.checked)}>
+          {t(
+            'Automatically drop objects that depend on the collection (such as views), and in turn all objects that depend on those objects',
+          )}
+        </Checkbox>
+      </Modal>
+    </>
+  );
+}

package/src/client-v2/__tests__/collection-picker-cache.test.tsx

@@ -0,0 +1,148 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import { createMockClient } from '@nocobase/client-v2';
+import { FlowEngineProvider } from '@nocobase/flow-engine';
+import { act, cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
+import React from 'react';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+
+vi.mock('antd', async (importOriginal) => {
+  const antd = await importOriginal<typeof import('antd')>();
+  const ReactModule = await import('react');
+  return {
+    ...antd,
+    Select: ({ onFocus, onBlur }: { onFocus?: () => void; onBlur?: () => void }) =>
+      ReactModule.createElement('button', { type: 'button', role: 'combobox', onFocus, onBlur }),
+  };
+});
+
+import { Form } from 'antd';
+import { MssqlConfigForm } from '../components/MssqlConfigForm';
+
+afterEach(cleanup);
+
+async function blurPicker() {
+  fireEvent.blur(screen.getByRole('combobox'));
+  await act(async () => Promise.resolve());
+}
+
+describe('MSSQL V2 collection picker request cache', () => {
+  it('deduplicates while loading and reloads when connection values change', async () => {
+    const app = createMockClient();
+    app.flowEngine.context.defineProperty('message', { value: { error: vi.fn() } });
+    let resolveCollections: ((value: { data: Array<{ name: string }> }) => void) | undefined;
+    const loadCollections = vi.fn(
+      () =>
+        new Promise<{ data: Array<{ name: string }> }>((resolve) => {
+          resolveCollections = resolve;
+        }),
+    );
+    app.apiMock.onPost('dataSources:readTables').reply(200, { data: [{ name: 'orders-v2' }] });
+    let form!: ReturnType<typeof Form.useForm>[0];
+    function FormHarness() {
+      const [formInstance] = Form.useForm();
+      form = formInstance;
+      return (
+        <Form
+          form={formInstance}
+          initialValues={{
+            key: 'external',
+            options: { host: 'db.test', port: 1433, database: 'sales', addAllCollections: false },
+          }}
+        >
+          <MssqlConfigForm
+            mode="edit"
+            type={{ label: 'MSSQL' }}
+            initialValues={{
+              key: 'external',
+              options: { host: 'db.test', port: 1433, database: 'sales', addAllCollections: false },
+            }}
+            loadCollections={loadCollections}
+          />
+        </Form>
+      );
+    }
+
+    render(
+      <FlowEngineProvider engine={app.flowEngine}>
+        <FormHarness />
+      </FlowEngineProvider>,
+    );
+
+    fireEvent.focus(await screen.findByRole('combobox'));
+    await waitFor(() => expect(loadCollections).toHaveBeenCalledOnce());
+    await blurPicker();
+    fireEvent.focus(screen.getByRole('combobox'));
+    expect(loadCollections).toHaveBeenCalledOnce();
+
+    resolveCollections?.({ data: [{ name: 'orders' }] });
+    await act(async () => loadCollections.mock.results[0].value);
+    await blurPicker();
+    act(() => form.setFieldValue(['options', 'host'], 'db-v2.test'));
+    expect(form.getFieldValue(['options', 'host'])).toBe('db-v2.test');
+    fireEvent.focus(screen.getByRole('combobox'));
+
+    await waitFor(() => expect(app.apiMock.history.post).toHaveLength(1));
+    expect(JSON.parse(app.apiMock.history.post[0].data)).toMatchObject({
+      dataSourceKey: 'external',
+      dbOptions: { type: 'mssql', host: 'db-v2.test', database: 'sales' },
+    });
+  });
+
+  it('restores saved selections and retries a failed table-list request', async () => {
+    const app = createMockClient();
+    const messageError = vi.fn();
+    app.flowEngine.context.defineProperty('message', { value: { error: messageError } });
+    app.apiMock.onPost('dataSources:readTables').replyOnce(500, { errors: [{ message: 'unavailable' }] });
+    app.apiMock.onPost('dataSources:readTables').reply(200, { data: [{ name: 'orders' }] });
+    let form!: ReturnType<typeof Form.useForm>[0];
+    function FormHarness() {
+      const [formInstance] = Form.useForm();
+      form = formInstance;
+      return (
+        <Form
+          form={formInstance}
+          initialValues={{
+            key: 'external',
+            options: {
+              host: 'db-v2.test',
+              port: 1433,
+              database: 'sales',
+              addAllCollections: false,
+              selectedCollections: ['orders'],
+            },
+          }}
+        >
+          <MssqlConfigForm
+            mode="edit"
+            type={{ label: 'MSSQL' }}
+            initialValues={{
+              key: 'external',
+              options: {
+                host: 'db.test',
+                port: 1433,
+                database: 'sales',
+                addAllCollections: false,
+                selectedCollections: ['orders'],
+              },
+            }}
+            loadCollections={vi.fn()}
+          />
+        </Form>
+      );
+    }
+
+    render(
+      <FlowEngineProvider engine={app.flowEngine}>
+        <FormHarness />
+      </FlowEngineProvider>,
+    );
+
+    await waitFor(() => expect(form.getFieldValue('collections')).toEqual(['orders']));
+    fireEvent.focus(await screen.findByRole('combobox'));
+    await waitFor(() => expect(messageError).toHaveBeenCalledOnce());
+    await blurPicker();
+    fireEvent.focus(screen.getByRole('combobox'));
+    await waitFor(() => expect(app.apiMock.history.post).toHaveLength(2));
+  });
+});

package/src/client-v2/__tests__/delete.test.tsx

@@ -0,0 +1,71 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import React from 'react';
+import { createMockClient } from '@nocobase/client-v2';
+import { FlowEngineProvider } from '@nocobase/flow-engine';
+import NativeManager from '@nocobase/plugin-data-source-manager/client-v2';
+import { cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
+import { afterEach, expect, it, vi } from 'vitest';
+import Plugin from '../plugin';
+import { MssqlDeleteCollection } from '../MssqlDeleteCollection';
+
+afterEach(() => {
+  cleanup();
+  vi.restoreAllMocks();
+});
+
+it('registers deletion and confirms a scoped request before refreshing collections', async () => {
+  const app = createMockClient();
+  const message = { error: vi.fn() };
+  app.flowEngine.context.defineProperty('message', { value: message });
+  const manager = new NativeManager({}, app);
+  vi.spyOn(app.pm, 'get').mockReturnValue(manager);
+  await new Plugin({}, app).load();
+  expect(manager.getType('mssql').allowCollectionDeletion).toBe(true);
+  expect(manager.getType('mssql').DeleteCollection).toBe(MssqlDeleteCollection);
+  app.apiMock.onPost('dataSources/external/collections:destroy').reply(200, { data: {} });
+  const submitted = vi.fn();
+  render(
+    <FlowEngineProvider engine={app.flowEngine}>
+      <MssqlDeleteCollection dataSourceKey="external" record={{ name: 'orders' }} onSubmitted={submitted} />
+    </FlowEngineProvider>,
+  );
+  fireEvent.click(screen.getByRole('button', { name: 'Delete' }));
+  expect(app.apiMock.history.post).toHaveLength(0);
+  fireEvent.click(screen.getByRole('checkbox'));
+  fireEvent.click(screen.getByRole('button', { name: /OK/i }));
+  await waitFor(() => expect(submitted).toHaveBeenCalledOnce());
+  expect(app.apiMock.history.post[0].params).toEqual({ filterByTk: ['orders'], cascade: true });
+  expect(message.error).not.toHaveBeenCalled();
+});
+
+it('supports selected collections and retains the dialog on a failed delete', async () => {
+  const app = createMockClient();
+  const message = { error: vi.fn() };
+  app.flowEngine.context.defineProperty('message', { value: message });
+  app.apiMock.onPost('dataSources/external/collections:destroy').reply(403, {});
+  const submitted = vi.fn();
+  render(
+    <FlowEngineProvider engine={app.flowEngine}>
+      <MssqlDeleteCollection
+        dataSourceKey="external"
+        selectedRowKeys={['orders', 'items']}
+        isBulk
+        onSubmitted={submitted}
+      />
+    </FlowEngineProvider>,
+  );
+  fireEvent.click(screen.getByRole('button', { name: 'Delete' }));
+  fireEvent.click(screen.getByRole('button', { name: /OK/i }));
+  await waitFor(() => expect(message.error).toHaveBeenCalled());
+  expect(app.apiMock.history.post[0].params.filterByTk).toEqual(['orders', 'items']);
+  expect(submitted).not.toHaveBeenCalled();
+  expect(screen.getByRole('dialog')).toBeTruthy();
+});

package/src/client-v2/__tests__/form.test.tsx

@@ -0,0 +1,47 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { createMockClient } from '@nocobase/client-v2';
+import { FlowEngineProvider } from '@nocobase/flow-engine';
+import { cleanup, fireEvent, render, screen, waitFor } from '@testing-library/react';
+import { Form } from 'antd';
+import React from 'react';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { MssqlConfigForm } from '../components/MssqlConfigForm';
+
+afterEach(cleanup);
+describe('MSSQL V2 native datasource settings', () => {
+  it('discovers tables before creation through the core dbOptions contract and stores load-all under options', async () => {
+    const app = createMockClient();
+    app.flowEngine.context.defineProperty('message', { value: { error: vi.fn() } });
+    app.apiMock.onPost('dataSources:readTables').reply(200, { data: [{ name: 'orders' }] });
+    let values: Record<string, unknown>;
+    function Fields() {
+      const form = Form.useFormInstance();
+      values = form.getFieldsValue(true);
+      return <MssqlConfigForm mode="create" type={{ label: 'MSSQL' }} loadCollections={vi.fn()} />;
+    }
+    render(
+      <FlowEngineProvider engine={app.flowEngine}>
+        <Form
+          initialValues={{ key: 'external', options: { host: 'db.test', database: 'sales', addAllCollections: false } }}
+        >
+          <Fields />
+        </Form>
+      </FlowEngineProvider>,
+    );
+    fireEvent.focus(await screen.findByRole('combobox'));
+    await waitFor(() => expect(app.apiMock.history.post).toHaveLength(1));
+    expect(JSON.parse(app.apiMock.history.post[0].data)).toMatchObject({
+      dataSourceKey: 'external',
+      dbOptions: { type: 'mssql', host: 'db.test', database: 'sales', addAllCollections: false },
+    });
+    expect(values).toMatchObject({ options: { addAllCollections: false } });
+  });
+});