mirror of
https://gitee.com/nocobase/nocobase.git
synced 2025-07-01 18:52:20 +08:00
feat(server): add lock manager to server (for testing on dev) (#5144)
* feat: pub/sub manager * fix: test case * fix: test error * fix: test error * feat: skip self * feat: debounce * feat: improve code * fix: test error * feat: test cases * feat: test cases * fix: improve code * fix: improve code * feat: improve code * fix: improve code * fix: test case * fix: typo * fix: createPubSubManager * fix: delete messageHandlers * fix: test case * feat: improve code * fix: test error * fix: test error * refactor(server): adapt to new api and fix test * fix(plugin-data-source-main): fix changed api * fix: test error * fix: remove sync-manager test case * chore(server): remove legacy code * fix(plugin-workflow): fix send sync message with transaction * chore(server): remove legacy code * chore(server): remove legacy code * fix(plugin-workflow): fix test case * fix(plugin-workflow): fix test case * test(server): test skip-install parameter in cluster * test(server): avoid multiple installation in cluster * test(server): installation in cluster * feat: sync collection using sync manager (#4920) * chore: sync collection message * chore: sync acl * fix: typo * chore: sync data source * chore: remove collection * fix: typo * fix: test * chore: sync sub app event * chore: sync collection test * chore: collection test * chore: test * chore: data source sync message * chore: sync multi app * chore: test * chore: test * chore: test * chore: test * chore: test * chore: error message * fix(server): add type and remove log * fix(server): not to publish when adpater is not connected * refactor(server): refine types * chore: timeout * fix(server): fix pubSubManager options * test(ci): test ci checkout * feat(server): add lock manager to server * feat: update ci * feat: pub/sub manager (#4933) * feat: pub/sub manager * fix: test case * fix: test error * fix: test error * feat: skip self * feat: debounce * feat: improve code * fix: test error * feat: test cases * feat: test cases * fix: improve code * fix: improve code * feat: improve code * fix: improve code * fix: test case * fix: typo * fix: createPubSubManager * fix: delete messageHandlers * fix: test case * feat: improve code * fix: test error * fix: test error * refactor(server): adapt to new api and fix test * fix(plugin-data-source-main): fix changed api * fix: test error * fix: remove sync-manager test case * chore(server): remove legacy code * fix(plugin-workflow): fix send sync message with transaction * chore(server): remove legacy code * chore(server): remove legacy code * fix(plugin-workflow): fix test case * fix(plugin-workflow): fix test case * test(server): test skip-install parameter in cluster * test(server): avoid multiple installation in cluster * test(server): installation in cluster * feat: sync collection using sync manager (#4920) * chore: sync collection message * chore: sync acl * fix: typo * chore: sync data source * chore: remove collection * fix: typo * fix: test * chore: sync sub app event * chore: sync collection test * chore: collection test * chore: test * chore: data source sync message * chore: sync multi app * chore: test * chore: test * chore: test * chore: test * chore: test * chore: error message * fix(server): add type and remove log * fix(server): not to publish when adpater is not connected * refactor(server): refine types * chore: timeout * fix(server): fix pubSubManager options * test(ci): test ci checkout --------- Co-authored-by: mytharcher <mytharcher@gmail.com> Co-authored-by: ChengLei Shao <chareice@live.com> * refactor(server): refactor api and local lock * refactor(server): change variable names and use singleton for local lock * fix: lockManager.close * refactor(server): adjust types * feat(server): add api * refactor(core): move lock-manager to independent package to be used in db * refactor(plugins): change to new lock manager to use locks * fix(auth): fix test case * chore: ttl of sort field lock * fix: ttl * fix(plugins): revert lock usage back for some plugins * refactor(plugin-field-sort): move sort field to plugin * chore: update build ci * fix(server): fix build errors * fix(plugin-field-sort): fix test case * fix(plugin-field-sort): fix register move action * fix(plugin-field-sort): fix load logic * fix(plugin-data-source-main): fix lock usage * chore(plugin-data-source-main): remove unused import * fix(server): fix import crypto in pub sub manager (#5111) * fix(plugin-field-sort): fix build and test cases * fix(plugin-user-data-sync): fix test with sort field * fix(plugin-users): fix test with sort field --------- Co-authored-by: chenos <chenlinxh@gmail.com> Co-authored-by: ChengLei Shao <chareice@live.com>
This commit is contained in:
Junyi
GitHub
parent
5338a0f5a4
commit
02c3a2be25
@ -16,6 +16,5 @@ export * from './add';
|
|||||||
export * from './set';
|
export * from './set';
|
||||||
export * from './remove';
|
export * from './remove';
|
||||||
export * from './toggle';
|
export * from './toggle';
|
||||||
export * from './move';
|
|
||||||
export * from './first-or-create';
|
export * from './first-or-create';
|
||||||
export * from './update-or-create';
|
export * from './update-or-create';
|
||||||
|
|||||||
@ -8,7 +8,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import { Database } from '@nocobase/database';
|
import { Database } from '@nocobase/database';
|
||||||
import { MockServer, mockServer } from '@nocobase/test';
|
import { MockServer, createMockServer } from '@nocobase/test';
|
||||||
import { vi } from 'vitest';
|
import { vi } from 'vitest';
|
||||||
|
|
||||||
describe('middleware', () => {
|
describe('middleware', () => {
|
||||||
@ -17,14 +17,13 @@ describe('middleware', () => {
|
|||||||
let agent;
|
let agent;
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = mockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
acl: true,
|
acl: true,
|
||||||
plugins: ['users', 'auth', 'acl', 'data-source-manager'],
|
plugins: ['users', 'auth', 'acl', 'field-sort', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
|
|
||||||
// app.plugin(ApiKeysPlugin);
|
// app.plugin(ApiKeysPlugin);
|
||||||
await app.loadAndInstall({ clean: true });
|
|
||||||
db = app.db;
|
db = app.db;
|
||||||
agent = app.agent();
|
agent = app.agent();
|
||||||
});
|
});
|
||||||
|
|||||||
@ -48,7 +48,6 @@ import {
|
|||||||
UpdatedAtFieldInterface,
|
UpdatedAtFieldInterface,
|
||||||
UpdatedByFieldInterface,
|
UpdatedByFieldInterface,
|
||||||
UrlFieldInterface,
|
UrlFieldInterface,
|
||||||
SortFieldInterface,
|
|
||||||
UUIDFieldInterface,
|
UUIDFieldInterface,
|
||||||
NanoidFieldInterface,
|
NanoidFieldInterface,
|
||||||
UnixTimestampFieldInterface,
|
UnixTimestampFieldInterface,
|
||||||
@ -169,7 +168,6 @@ export class CollectionPlugin extends Plugin {
|
|||||||
UpdatedAtFieldInterface,
|
UpdatedAtFieldInterface,
|
||||||
UpdatedByFieldInterface,
|
UpdatedByFieldInterface,
|
||||||
UrlFieldInterface,
|
UrlFieldInterface,
|
||||||
SortFieldInterface,
|
|
||||||
UUIDFieldInterface,
|
UUIDFieldInterface,
|
||||||
NanoidFieldInterface,
|
NanoidFieldInterface,
|
||||||
UnixTimestampFieldInterface,
|
UnixTimestampFieldInterface,
|
||||||
|
|||||||
@ -42,7 +42,6 @@ export * from './time';
|
|||||||
export * from './updatedAt';
|
export * from './updatedAt';
|
||||||
export * from './updatedBy';
|
export * from './updatedBy';
|
||||||
export * from './url';
|
export * from './url';
|
||||||
export * from './sort';
|
|
||||||
export * from './uuid';
|
export * from './uuid';
|
||||||
export * from './nanoid';
|
export * from './nanoid';
|
||||||
export * from './unixTimestamp';
|
export * from './unixTimestamp';
|
||||||
|
|||||||
@ -9,7 +9,6 @@
|
|||||||
|
|
||||||
import { list } from '../default-actions/list';
|
import { list } from '../default-actions/list';
|
||||||
import { vi } from 'vitest';
|
import { vi } from 'vitest';
|
||||||
import { createMoveAction } from '../default-actions/move';
|
|
||||||
|
|
||||||
describe('action test', () => {
|
describe('action test', () => {
|
||||||
describe('list action', async () => {
|
describe('list action', async () => {
|
||||||
@ -100,59 +99,4 @@ describe('action test', () => {
|
|||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('move action', async () => {
|
|
||||||
it('should call database move action', async () => {
|
|
||||||
const dbMove = vi.fn();
|
|
||||||
const moveAction = createMoveAction(dbMove);
|
|
||||||
|
|
||||||
const ctx: any = {
|
|
||||||
getCurrentRepository() {
|
|
||||||
return {
|
|
||||||
database: {},
|
|
||||||
};
|
|
||||||
},
|
|
||||||
action: {
|
|
||||||
params: {
|
|
||||||
filterByTk: 1,
|
|
||||||
targetCollection: 'test',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
await moveAction(ctx, () => {});
|
|
||||||
|
|
||||||
expect(dbMove).toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should move when repository can move', async () => {
|
|
||||||
const moveAction = createMoveAction(() => {});
|
|
||||||
|
|
||||||
const ctx: any = {
|
|
||||||
getCurrentRepository() {
|
|
||||||
return {};
|
|
||||||
},
|
|
||||||
action: {
|
|
||||||
params: {
|
|
||||||
filterByTk: 1,
|
|
||||||
targetCollection: 'test',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
const moveFn = vi.fn();
|
|
||||||
|
|
||||||
vi.spyOn(ctx, 'getCurrentRepository').mockImplementation(() => {
|
|
||||||
return {
|
|
||||||
move: async () => {
|
|
||||||
moveFn();
|
|
||||||
},
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
await moveAction(ctx, () => {});
|
|
||||||
|
|
||||||
expect(moveFn).toHaveBeenCalled();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@ -1,29 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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 { Context } from '@nocobase/actions';
|
|
||||||
|
|
||||||
export function createMoveAction(databaseMoveAction) {
|
|
||||||
return async function move(ctx: Context, next) {
|
|
||||||
const repository = ctx.getCurrentRepository();
|
|
||||||
|
|
||||||
if (repository.move) {
|
|
||||||
ctx.body = await repository.move(ctx.action.params);
|
|
||||||
await next();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (repository.database) {
|
|
||||||
ctx.databaseRepository = repository;
|
|
||||||
return databaseMoveAction(ctx, next);
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error(`Repository can not handle action move for ${ctx.action.resourceName}`);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@ -8,9 +8,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import { list } from './default-actions/list';
|
import { list } from './default-actions/list';
|
||||||
import { createMoveAction } from './default-actions/move';
|
|
||||||
import { proxyToRepository } from './default-actions/proxy-to-repository';
|
import { proxyToRepository } from './default-actions/proxy-to-repository';
|
||||||
import globalActions from '@nocobase/actions';
|
|
||||||
|
|
||||||
type Actions = { [key: string]: { params: Array<string> | ((ctx: any) => Array<string>); method: string } };
|
type Actions = { [key: string]: { params: Array<string> | ((ctx: any) => Array<string>); method: string } };
|
||||||
|
|
||||||
@ -81,6 +79,5 @@ export function loadDefaultActions() {
|
|||||||
return carry;
|
return carry;
|
||||||
}, {}),
|
}, {}),
|
||||||
list,
|
list,
|
||||||
move: createMoveAction(globalActions.move),
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@ -8,7 +8,6 @@
|
|||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@nocobase/logger": "1.4.0-alpha",
|
"@nocobase/logger": "1.4.0-alpha",
|
||||||
"@nocobase/utils": "1.4.0-alpha",
|
"@nocobase/utils": "1.4.0-alpha",
|
||||||
"async-mutex": "^0.3.2",
|
|
||||||
"chalk": "^4.1.1",
|
"chalk": "^4.1.1",
|
||||||
"cron-parser": "4.4.0",
|
"cron-parser": "4.4.0",
|
||||||
"dayjs": "^1.11.8",
|
"dayjs": "^1.11.8",
|
||||||
|
|||||||
@ -1,75 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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 { mockDatabase } from './index';
|
|
||||||
import { Database } from '../database';
|
|
||||||
|
|
||||||
describe('collection sortable options', () => {
|
|
||||||
let db: Database;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
db = mockDatabase();
|
|
||||||
await db.clean({ drop: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
afterEach(async () => {
|
|
||||||
await db.close();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('sortable=true', async () => {
|
|
||||||
const Test = db.collection({
|
|
||||||
name: 'test',
|
|
||||||
sortable: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
const model = Test.model;
|
|
||||||
|
|
||||||
await db.sync();
|
|
||||||
const instance = await model.create();
|
|
||||||
expect(model.rawAttributes['sort']).toBeDefined();
|
|
||||||
expect(instance.get('sort')).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('sortable=string', async () => {
|
|
||||||
const Test = db.collection({
|
|
||||||
name: 'test',
|
|
||||||
sortable: 'order',
|
|
||||||
});
|
|
||||||
|
|
||||||
const model = Test.model;
|
|
||||||
|
|
||||||
await db.sync();
|
|
||||||
const instance = await model.create();
|
|
||||||
expect(model.rawAttributes['order']).toBeDefined();
|
|
||||||
expect(instance.get('order')).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('sortable=object', async () => {
|
|
||||||
const Test = db.collection({
|
|
||||||
name: 'test',
|
|
||||||
sortable: {
|
|
||||||
name: 'sort',
|
|
||||||
scopeKey: 'status',
|
|
||||||
},
|
|
||||||
fields: [{ type: 'string', name: 'status' }],
|
|
||||||
});
|
|
||||||
|
|
||||||
await db.sync();
|
|
||||||
|
|
||||||
const t1 = await Test.model.create({ status: 'publish' });
|
|
||||||
const t2 = await Test.model.create({ status: 'publish' });
|
|
||||||
const t3 = await Test.model.create({ status: 'draft' });
|
|
||||||
const t4 = await Test.model.create({ status: 'draft' });
|
|
||||||
|
|
||||||
expect(t1.get('sort')).toBe(1);
|
|
||||||
expect(t2.get('sort')).toBe(2);
|
|
||||||
expect(t3.get('sort')).toBe(1);
|
|
||||||
expect(t4.get('sort')).toBe(2);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@ -27,7 +27,6 @@ import {
|
|||||||
import { PasswordFieldOptions } from './password-field';
|
import { PasswordFieldOptions } from './password-field';
|
||||||
import { RadioFieldOptions } from './radio-field';
|
import { RadioFieldOptions } from './radio-field';
|
||||||
import { SetFieldOptions } from './set-field';
|
import { SetFieldOptions } from './set-field';
|
||||||
import { SortFieldOptions } from './sort-field';
|
|
||||||
import { StringFieldOptions } from './string-field';
|
import { StringFieldOptions } from './string-field';
|
||||||
import { TextFieldOptions } from './text-field';
|
import { TextFieldOptions } from './text-field';
|
||||||
import { TimeFieldOptions } from './time-field';
|
import { TimeFieldOptions } from './time-field';
|
||||||
@ -52,7 +51,6 @@ export * from './password-field';
|
|||||||
export * from './radio-field';
|
export * from './radio-field';
|
||||||
export * from './relation-field';
|
export * from './relation-field';
|
||||||
export * from './set-field';
|
export * from './set-field';
|
||||||
export * from './sort-field';
|
|
||||||
export * from './string-field';
|
export * from './string-field';
|
||||||
export * from './text-field';
|
export * from './text-field';
|
||||||
export * from './time-field';
|
export * from './time-field';
|
||||||
@ -74,7 +72,6 @@ export type FieldOptions =
|
|||||||
| JsonbFieldOptions
|
| JsonbFieldOptions
|
||||||
| BooleanFieldOptions
|
| BooleanFieldOptions
|
||||||
| RadioFieldOptions
|
| RadioFieldOptions
|
||||||
| SortFieldOptions
|
|
||||||
| TextFieldOptions
|
| TextFieldOptions
|
||||||
| VirtualFieldOptions
|
| VirtualFieldOptions
|
||||||
| ArrayFieldOptions
|
| ArrayFieldOptions
|
||||||
|
|||||||
661
packages/core/lock-manager/LICENSE
Normal file
661
packages/core/lock-manager/LICENSE
Normal file
@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published
|
||||||
|
by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
12
packages/core/lock-manager/package.json
Normal file
12
packages/core/lock-manager/package.json
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"name": "@nocobase/lock-manager",
|
||||||
|
"version": "1.4.0-alpha",
|
||||||
|
"main": "lib/index.js",
|
||||||
|
"license": "AGPL-3.0",
|
||||||
|
"dependencies": {
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@nocobase/utils": "1.4.0-alpha",
|
||||||
|
"async-mutex": "^0.5.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
169
packages/core/lock-manager/src/__tests__/lock-manager.test.ts
Normal file
169
packages/core/lock-manager/src/__tests__/lock-manager.test.ts
Normal file
@ -0,0 +1,169 @@
|
|||||||
|
/**
|
||||||
|
* 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 { Mutex, tryAcquire } from 'async-mutex';
|
||||||
|
|
||||||
|
import { LockManager, LockAcquireError } from '../lock-manager';
|
||||||
|
|
||||||
|
function sleep(ms = 1000) {
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
setTimeout(resolve, ms);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('lock manager', () => {
|
||||||
|
describe.skip('mutex example', () => {
|
||||||
|
it('acquire and release', async () => {
|
||||||
|
const order = [];
|
||||||
|
const lock = new Mutex();
|
||||||
|
const release1 = await lock.acquire();
|
||||||
|
order.push(1);
|
||||||
|
expect(release1).toBeDefined();
|
||||||
|
expect(lock.isLocked()).toBe(true);
|
||||||
|
setTimeout(async () => {
|
||||||
|
order.push(2);
|
||||||
|
await lock.release();
|
||||||
|
order.push(3);
|
||||||
|
expect(lock.isLocked()).toBe(true);
|
||||||
|
}, 200);
|
||||||
|
order.push(4);
|
||||||
|
const release2 = await lock.acquire();
|
||||||
|
order.push(5);
|
||||||
|
expect(lock.isLocked()).toBe(true);
|
||||||
|
await release2();
|
||||||
|
order.push(6);
|
||||||
|
expect(lock.isLocked()).toBe(false);
|
||||||
|
expect(order).toEqual([1, 4, 2, 3, 5, 6]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('tryAcquire', async () => {
|
||||||
|
const order = [];
|
||||||
|
const lock = new Mutex();
|
||||||
|
const l1 = tryAcquire(lock);
|
||||||
|
expect(l1.isLocked()).toBe(false);
|
||||||
|
const release1 = await lock.acquire();
|
||||||
|
expect(lock.isLocked()).toBe(true);
|
||||||
|
const l2 = tryAcquire(lock);
|
||||||
|
await expect(async () => {
|
||||||
|
const r2 = await l2.acquire();
|
||||||
|
}).rejects.toThrow();
|
||||||
|
await release1();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('local lock', () => {
|
||||||
|
const lockManager = new LockManager();
|
||||||
|
|
||||||
|
it('acquire and release', async () => {
|
||||||
|
const order = [];
|
||||||
|
const r1 = await lockManager.acquire('test');
|
||||||
|
order.push(1);
|
||||||
|
setTimeout(async () => {
|
||||||
|
order.push(2);
|
||||||
|
await r1();
|
||||||
|
order.push(3);
|
||||||
|
}, 200);
|
||||||
|
order.push(4);
|
||||||
|
const r2 = await lockManager.acquire('test');
|
||||||
|
order.push(5);
|
||||||
|
await r2();
|
||||||
|
order.push(6);
|
||||||
|
expect(order).toEqual([1, 4, 2, 3, 5, 6]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('acquire and release with timeout', async () => {
|
||||||
|
const order = [];
|
||||||
|
const r1 = await lockManager.acquire('test', 200);
|
||||||
|
order.push(1);
|
||||||
|
setTimeout(async () => {
|
||||||
|
order.push(2);
|
||||||
|
await r1();
|
||||||
|
order.push(3);
|
||||||
|
}, 400);
|
||||||
|
order.push(4);
|
||||||
|
const r2 = await lockManager.acquire('test', 200);
|
||||||
|
order.push(5);
|
||||||
|
await sleep(300);
|
||||||
|
await r2();
|
||||||
|
order.push(6);
|
||||||
|
expect(order).toEqual([1, 4, 5, 2, 3, 6]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('runExclusive', async () => {
|
||||||
|
const order = [];
|
||||||
|
setTimeout(async () => {
|
||||||
|
await lockManager.runExclusive('test', async () => {
|
||||||
|
order.push(1);
|
||||||
|
await sleep(100);
|
||||||
|
order.push(2);
|
||||||
|
});
|
||||||
|
}, 100);
|
||||||
|
order.push(3);
|
||||||
|
await lockManager.runExclusive('test', async () => {
|
||||||
|
order.push(4);
|
||||||
|
await sleep(400);
|
||||||
|
order.push(5);
|
||||||
|
});
|
||||||
|
order.push(6);
|
||||||
|
await sleep(200);
|
||||||
|
expect(order).toEqual([3, 4, 5, 1, 6, 2]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('runExclusive with timeout', async () => {
|
||||||
|
const order = [];
|
||||||
|
setTimeout(async () => {
|
||||||
|
await lockManager.runExclusive(
|
||||||
|
'test',
|
||||||
|
async () => {
|
||||||
|
order.push(1);
|
||||||
|
await sleep(200);
|
||||||
|
order.push(2);
|
||||||
|
},
|
||||||
|
200,
|
||||||
|
);
|
||||||
|
}, 100);
|
||||||
|
order.push(3);
|
||||||
|
await lockManager.runExclusive(
|
||||||
|
'test',
|
||||||
|
async () => {
|
||||||
|
order.push(4);
|
||||||
|
await sleep(400);
|
||||||
|
order.push(5);
|
||||||
|
},
|
||||||
|
200,
|
||||||
|
);
|
||||||
|
order.push(6);
|
||||||
|
await sleep(200);
|
||||||
|
expect(order).toEqual([3, 4, 5, 1, 6, 2]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('tryAcquire', async () => {
|
||||||
|
const release = await lockManager.acquire('test');
|
||||||
|
await expect(lockManager.tryAcquire('test')).rejects.toThrowError(LockAcquireError);
|
||||||
|
await release();
|
||||||
|
const lock = await lockManager.tryAcquire('test');
|
||||||
|
expect(lock.acquire).toBeTypeOf('function');
|
||||||
|
expect(lock.runExclusive).toBeTypeOf('function');
|
||||||
|
|
||||||
|
const order = [];
|
||||||
|
const r1 = await lock.acquire(200);
|
||||||
|
order.push(1);
|
||||||
|
setTimeout(async () => {
|
||||||
|
order.push(2);
|
||||||
|
await r1();
|
||||||
|
order.push(3);
|
||||||
|
}, 100);
|
||||||
|
const r2 = await lock.acquire(200);
|
||||||
|
order.push(4);
|
||||||
|
await sleep(300);
|
||||||
|
await r2();
|
||||||
|
expect(order).toEqual([1, 2, 3, 4]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
11
packages/core/lock-manager/src/index.ts
Normal file
11
packages/core/lock-manager/src/index.ts
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export * from './lock-manager';
|
||||||
|
export { default } from './lock-manager';
|
||||||
169
packages/core/lock-manager/src/lock-manager.ts
Normal file
169
packages/core/lock-manager/src/lock-manager.ts
Normal file
@ -0,0 +1,169 @@
|
|||||||
|
/**
|
||||||
|
* 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 { Registry } from '@nocobase/utils';
|
||||||
|
import { Mutex, MutexInterface, E_CANCELED } from 'async-mutex';
|
||||||
|
|
||||||
|
export type Releaser = () => void | Promise<void>;
|
||||||
|
|
||||||
|
export interface ILock {
|
||||||
|
acquire(ttl: number): Releaser | Promise<Releaser>;
|
||||||
|
runExclusive<T>(fn: () => Promise<T>, ttl: number): Promise<T>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ILockAdapter {
|
||||||
|
connect(): Promise<void>;
|
||||||
|
close(): Promise<void>;
|
||||||
|
acquire(key: string, ttl: number): Releaser | Promise<Releaser>;
|
||||||
|
runExclusive<T>(key: string, fn: () => Promise<T>, ttl: number): Promise<T>;
|
||||||
|
tryAcquire(key: string, timeout?: number): Promise<ILock>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class LockAbortError extends Error {
|
||||||
|
constructor(message, options) {
|
||||||
|
super(message, options);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class LockAcquireError extends Error {
|
||||||
|
constructor(message, options?) {
|
||||||
|
super(message, options);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class LocalLockAdapter implements ILockAdapter {
|
||||||
|
static locks = new Map<string, MutexInterface>();
|
||||||
|
|
||||||
|
async connect() {}
|
||||||
|
async close() {}
|
||||||
|
|
||||||
|
private getLock(key: string): MutexInterface {
|
||||||
|
let lock = (<typeof LocalLockAdapter>this.constructor).locks.get(key);
|
||||||
|
if (!lock) {
|
||||||
|
lock = new Mutex();
|
||||||
|
(<typeof LocalLockAdapter>this.constructor).locks.set(key, lock);
|
||||||
|
}
|
||||||
|
return lock;
|
||||||
|
}
|
||||||
|
|
||||||
|
async acquire(key: string, ttl: number) {
|
||||||
|
const lock = this.getLock(key);
|
||||||
|
const release = (await lock.acquire()) as Releaser;
|
||||||
|
const timer = setTimeout(() => {
|
||||||
|
if (lock.isLocked()) {
|
||||||
|
release();
|
||||||
|
}
|
||||||
|
}, ttl);
|
||||||
|
return () => {
|
||||||
|
release();
|
||||||
|
clearTimeout(timer);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async runExclusive<T>(key: string, fn: () => Promise<T>, ttl: number): Promise<T> {
|
||||||
|
const lock = this.getLock(key);
|
||||||
|
let timer;
|
||||||
|
try {
|
||||||
|
timer = setTimeout(() => {
|
||||||
|
if (lock.isLocked()) {
|
||||||
|
lock.release();
|
||||||
|
}
|
||||||
|
}, ttl);
|
||||||
|
return lock.runExclusive(fn);
|
||||||
|
} catch (e) {
|
||||||
|
if (e === E_CANCELED) {
|
||||||
|
throw new LockAbortError('Lock aborted', { cause: E_CANCELED });
|
||||||
|
} else {
|
||||||
|
throw e;
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
clearTimeout(timer);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async tryAcquire(key: string) {
|
||||||
|
const lock = this.getLock(key);
|
||||||
|
if (lock.isLocked()) {
|
||||||
|
throw new LockAcquireError('lock is locked');
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
acquire: async (ttl) => {
|
||||||
|
return this.acquire(key, ttl);
|
||||||
|
},
|
||||||
|
runExclusive: async (fn: () => Promise<any>, ttl) => {
|
||||||
|
return this.runExclusive(key, fn, ttl);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LockAdapterConfig<C extends ILockAdapter = ILockAdapter> {
|
||||||
|
Adapter: new (...args: any[]) => C;
|
||||||
|
options?: Record<string, any>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LockManagerOptions {
|
||||||
|
defaultAdapter?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class LockManager {
|
||||||
|
private registry = new Registry<LockAdapterConfig>();
|
||||||
|
private adapters = new Map<string, ILockAdapter>();
|
||||||
|
|
||||||
|
constructor(private options: LockManagerOptions = {}) {
|
||||||
|
this.registry.register('local', {
|
||||||
|
Adapter: LocalLockAdapter,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
registerAdapter(name: string, adapterConfig: LockAdapterConfig) {
|
||||||
|
this.registry.register(name, adapterConfig);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async getAdapter(): Promise<ILockAdapter> {
|
||||||
|
const type = this.options.defaultAdapter || 'local';
|
||||||
|
let client = this.adapters.get(type);
|
||||||
|
if (!client) {
|
||||||
|
const adapter = this.registry.get(type);
|
||||||
|
if (!adapter) {
|
||||||
|
throw new Error(`Lock adapter "${type}" not registered`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const { Adapter, options } = adapter;
|
||||||
|
client = new Adapter(options);
|
||||||
|
await client.connect();
|
||||||
|
this.adapters.set(type, client);
|
||||||
|
}
|
||||||
|
|
||||||
|
return client;
|
||||||
|
}
|
||||||
|
|
||||||
|
public async close() {
|
||||||
|
for (const client of this.adapters.values()) {
|
||||||
|
await client.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async acquire(key: string, ttl = 500): Promise<Releaser> {
|
||||||
|
const client = await this.getAdapter();
|
||||||
|
return client.acquire(key, ttl);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async runExclusive<T>(key: string, fn: () => Promise<T>, ttl = 500): Promise<T> {
|
||||||
|
const client = await this.getAdapter();
|
||||||
|
return client.runExclusive(key, fn, ttl);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async tryAcquire(key: string) {
|
||||||
|
const client = await this.getAdapter();
|
||||||
|
return client.tryAcquire(key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default LockManager;
|
||||||
@ -17,6 +17,7 @@
|
|||||||
"@nocobase/data-source-manager": "1.4.0-alpha",
|
"@nocobase/data-source-manager": "1.4.0-alpha",
|
||||||
"@nocobase/database": "1.4.0-alpha",
|
"@nocobase/database": "1.4.0-alpha",
|
||||||
"@nocobase/evaluators": "1.4.0-alpha",
|
"@nocobase/evaluators": "1.4.0-alpha",
|
||||||
|
"@nocobase/lock-manager": "1.4.0-alpha",
|
||||||
"@nocobase/logger": "1.4.0-alpha",
|
"@nocobase/logger": "1.4.0-alpha",
|
||||||
"@nocobase/resourcer": "1.4.0-alpha",
|
"@nocobase/resourcer": "1.4.0-alpha",
|
||||||
"@nocobase/sdk": "1.4.0-alpha",
|
"@nocobase/sdk": "1.4.0-alpha",
|
||||||
|
|||||||
@ -25,6 +25,7 @@ import {
|
|||||||
import { ResourceOptions, Resourcer } from '@nocobase/resourcer';
|
import { ResourceOptions, Resourcer } from '@nocobase/resourcer';
|
||||||
import { Telemetry, TelemetryOptions } from '@nocobase/telemetry';
|
import { Telemetry, TelemetryOptions } from '@nocobase/telemetry';
|
||||||
import { applyMixins, AsyncEmitter, importModule, Toposort, ToposortOptions } from '@nocobase/utils';
|
import { applyMixins, AsyncEmitter, importModule, Toposort, ToposortOptions } from '@nocobase/utils';
|
||||||
|
import { LockManager, LockManagerOptions } from '@nocobase/lock-manager';
|
||||||
import { Command, CommandOptions, ParseOptions } from 'commander';
|
import { Command, CommandOptions, ParseOptions } from 'commander';
|
||||||
import { randomUUID } from 'crypto';
|
import { randomUUID } from 'crypto';
|
||||||
import glob from 'glob';
|
import glob from 'glob';
|
||||||
@ -114,6 +115,7 @@ export interface ApplicationOptions {
|
|||||||
pmSock?: string;
|
pmSock?: string;
|
||||||
name?: string;
|
name?: string;
|
||||||
authManager?: AuthManagerOptions;
|
authManager?: AuthManagerOptions;
|
||||||
|
lockManager?: LockManagerOptions;
|
||||||
/**
|
/**
|
||||||
* @internal
|
* @internal
|
||||||
*/
|
*/
|
||||||
@ -231,6 +233,8 @@ export class Application<StateT = DefaultState, ContextT = DefaultContext> exten
|
|||||||
private _maintainingStatusBeforeCommand: MaintainingCommandStatus | null;
|
private _maintainingStatusBeforeCommand: MaintainingCommandStatus | null;
|
||||||
private _actionCommand: Command;
|
private _actionCommand: Command;
|
||||||
|
|
||||||
|
public lockManager: LockManager;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @internal
|
* @internal
|
||||||
*/
|
*/
|
||||||
@ -1133,6 +1137,10 @@ export class Application<StateT = DefaultState, ContextT = DefaultContext> exten
|
|||||||
this._i18n = createI18n(options);
|
this._i18n = createI18n(options);
|
||||||
this.pubSubManager = createPubSubManager(this, options.pubSubManager);
|
this.pubSubManager = createPubSubManager(this, options.pubSubManager);
|
||||||
this.syncMessageManager = new SyncMessageManager(this, options.syncMessageManager);
|
this.syncMessageManager = new SyncMessageManager(this, options.syncMessageManager);
|
||||||
|
this.lockManager = new LockManager({
|
||||||
|
defaultAdapter: process.env.LOCK_ADAPTER_DEFAULT,
|
||||||
|
...options.lockManager,
|
||||||
|
});
|
||||||
this.context.db = this.db;
|
this.context.db = this.db;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -16,4 +16,6 @@ export * from './migration';
|
|||||||
export * from './plugin';
|
export * from './plugin';
|
||||||
export * from './plugin-manager';
|
export * from './plugin-manager';
|
||||||
export * from './pub-sub-manager';
|
export * from './pub-sub-manager';
|
||||||
|
export * from './gateway';
|
||||||
|
export * from './app-supervisor';
|
||||||
export const OFFICIAL_PLUGIN_PREFIX = '@nocobase/plugin-';
|
export const OFFICIAL_PLUGIN_PREFIX = '@nocobase/plugin-';
|
||||||
|
|||||||
@ -325,7 +325,7 @@ export async function createMockCluster({
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function createMockServer(options: MockServerOptions = {}) {
|
export async function createMockServer(options: MockServerOptions = {}): Promise<MockServer> {
|
||||||
const { version, beforeInstall, skipInstall, skipStart, ...others } = options;
|
const { version, beforeInstall, skipInstall, skipStart, ...others } = options;
|
||||||
const app: MockServer = mockServer(others);
|
const app: MockServer = mockServer(others);
|
||||||
if (!skipInstall) {
|
if (!skipInstall) {
|
||||||
|
|||||||
@ -14,7 +14,6 @@
|
|||||||
],
|
],
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jsonwebtoken": "^8.5.8",
|
"@types/jsonwebtoken": "^8.5.8",
|
||||||
"async-mutex": "^0.3.2",
|
|
||||||
"jsonwebtoken": "^8.5.1",
|
"jsonwebtoken": "^8.5.1",
|
||||||
"react": "^18.2.0",
|
"react": "^18.2.0",
|
||||||
"react-dom": "^18.2.0"
|
"react-dom": "^18.2.0"
|
||||||
|
|||||||
@ -16,6 +16,7 @@ export async function prepareApp(): Promise<MockServer> {
|
|||||||
plugins: [
|
plugins: [
|
||||||
'acl',
|
'acl',
|
||||||
'error-handler',
|
'error-handler',
|
||||||
|
'field-sort',
|
||||||
'users',
|
'users',
|
||||||
'ui-schema-storage',
|
'ui-schema-storage',
|
||||||
'data-source-main',
|
'data-source-main',
|
||||||
|
|||||||
@ -20,7 +20,7 @@ describe('role', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
api = await createMockServer({
|
api = await createMockServer({
|
||||||
plugins: ['users', 'acl', 'auth', 'data-source-manager'],
|
plugins: ['field-sort', 'users', 'acl', 'auth', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
db = api.db;
|
db = api.db;
|
||||||
usersPlugin = api.getPlugin('users');
|
usersPlugin = api.getPlugin('users');
|
||||||
|
|||||||
@ -11,7 +11,6 @@ import { Context, utils as actionUtils } from '@nocobase/actions';
|
|||||||
import { Cache } from '@nocobase/cache';
|
import { Cache } from '@nocobase/cache';
|
||||||
import { Collection, RelationField, Transaction } from '@nocobase/database';
|
import { Collection, RelationField, Transaction } from '@nocobase/database';
|
||||||
import { Plugin } from '@nocobase/server';
|
import { Plugin } from '@nocobase/server';
|
||||||
import { Mutex } from 'async-mutex';
|
|
||||||
import lodash from 'lodash';
|
import lodash from 'lodash';
|
||||||
import { resolve } from 'path';
|
import { resolve } from 'path';
|
||||||
import { availableActionResource } from './actions/available-actions';
|
import { availableActionResource } from './actions/available-actions';
|
||||||
@ -275,10 +274,9 @@ export class PluginACLServer extends Plugin {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const mutex = new Mutex();
|
|
||||||
|
|
||||||
this.app.db.on('fields.afterDestroy', async (model, options) => {
|
this.app.db.on('fields.afterDestroy', async (model, options) => {
|
||||||
await mutex.runExclusive(async () => {
|
const lockKey = `${this.name}:fields.afterDestroy:${model.get('collectionName')}:${model.get('name')}`;
|
||||||
|
await this.app.lockManager.runExclusive(lockKey, async () => {
|
||||||
const collectionName = model.get('collectionName');
|
const collectionName = model.get('collectionName');
|
||||||
const fieldName = model.get('name');
|
const fieldName = model.get('name');
|
||||||
|
|
||||||
|
|||||||
@ -22,7 +22,7 @@ describe('actions', () => {
|
|||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
acl: true,
|
acl: true,
|
||||||
plugins: ['users', 'auth', 'acl', 'action-custom-request', 'data-source-manager'],
|
plugins: ['field-sort', 'users', 'auth', 'acl', 'action-custom-request', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
repo = db.getRepository('customRequests');
|
repo = db.getRepository('customRequests');
|
||||||
|
|||||||
@ -14,7 +14,7 @@
|
|||||||
"@formily/react": "2.x",
|
"@formily/react": "2.x",
|
||||||
"@formily/shared": "2.x",
|
"@formily/shared": "2.x",
|
||||||
"@types/node-xlsx": "^0.15.1",
|
"@types/node-xlsx": "^0.15.1",
|
||||||
"async-mutex": "^0.3.2",
|
"async-mutex": "^0.5.0",
|
||||||
"file-saver": "^2.0.5",
|
"file-saver": "^2.0.5",
|
||||||
"node-xlsx": "^0.16.1",
|
"node-xlsx": "^0.16.1",
|
||||||
"react": "^18.2.0",
|
"react": "^18.2.0",
|
||||||
|
|||||||
@ -18,6 +18,7 @@
|
|||||||
"@koa/multer": "^3.0.2",
|
"@koa/multer": "^3.0.2",
|
||||||
"@types/node-xlsx": "^0.15.1",
|
"@types/node-xlsx": "^0.15.1",
|
||||||
"antd": "5.x",
|
"antd": "5.x",
|
||||||
|
"async-mutex": "^0.5.0",
|
||||||
"file-saver": "^2.0.5",
|
"file-saver": "^2.0.5",
|
||||||
"mathjs": "^10.6.0",
|
"mathjs": "^10.6.0",
|
||||||
"node-xlsx": "^0.16.1",
|
"node-xlsx": "^0.16.1",
|
||||||
|
|||||||
@ -10,14 +10,14 @@
|
|||||||
import { Context, Next } from '@nocobase/actions';
|
import { Context, Next } from '@nocobase/actions';
|
||||||
import { Repository } from '@nocobase/database';
|
import { Repository } from '@nocobase/database';
|
||||||
import XLSX from 'xlsx';
|
import XLSX from 'xlsx';
|
||||||
import { XlsxImporter } from '../services/xlsx-importer';
|
|
||||||
import { Mutex } from 'async-mutex';
|
import { Mutex } from 'async-mutex';
|
||||||
|
import { XlsxImporter } from '../services/xlsx-importer';
|
||||||
import { DataSource } from '@nocobase/data-source-manager';
|
import { DataSource } from '@nocobase/data-source-manager';
|
||||||
|
|
||||||
const mutex = new Mutex();
|
|
||||||
|
|
||||||
const IMPORT_LIMIT_COUNT = 2000;
|
const IMPORT_LIMIT_COUNT = 2000;
|
||||||
|
|
||||||
|
const mutex = new Mutex();
|
||||||
|
|
||||||
async function importXlsxAction(ctx: Context, next: Next) {
|
async function importXlsxAction(ctx: Context, next: Next) {
|
||||||
let columns = (ctx.request.body as any).columns as any[];
|
let columns = (ctx.request.body as any).columns as any[];
|
||||||
if (typeof columns === 'string') {
|
if (typeof columns === 'string') {
|
||||||
|
|||||||
@ -32,7 +32,7 @@ describe('actions', () => {
|
|||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
acl: true,
|
acl: true,
|
||||||
plugins: ['users', 'auth', 'api-keys', 'acl', 'data-source-manager'],
|
plugins: ['field-sort', 'users', 'auth', 'api-keys', 'acl', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
|
|
||||||
db = app.db;
|
db = app.db;
|
||||||
|
|||||||
@ -30,7 +30,7 @@ describe('signin', () => {
|
|||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['users', 'auth', 'verification', 'acl', 'auth-sms', 'data-source-manager'],
|
plugins: ['field-sort', 'users', 'auth', 'verification', 'acl', 'auth-sms', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
agent = app.agent();
|
agent = app.agent();
|
||||||
|
|||||||
@ -19,7 +19,7 @@ describe('actions', () => {
|
|||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['auth'],
|
plugins: ['field-sort', 'auth'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
repo = db.getRepository('authenticators');
|
repo = db.getRepository('authenticators');
|
||||||
@ -95,7 +95,7 @@ describe('actions', () => {
|
|||||||
process.env.INIT_ROOT_PASSWORD = '123456';
|
process.env.INIT_ROOT_PASSWORD = '123456';
|
||||||
process.env.INIT_ROOT_NICKNAME = 'Test';
|
process.env.INIT_ROOT_NICKNAME = 'Test';
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['auth', 'users'],
|
plugins: ['field-sort', 'auth', 'users'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
agent = app.agent();
|
agent = app.agent();
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('AuthModel', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['auth', 'users'],
|
plugins: ['field-sort', 'auth', 'users'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
repo = db.getRepository('authenticators');
|
repo = db.getRepository('authenticators');
|
||||||
|
|||||||
@ -19,7 +19,7 @@ describe('auth', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['users', 'auth'],
|
plugins: ['field-sort', 'users', 'auth'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
|
|
||||||
|
|||||||
@ -19,7 +19,7 @@ describe('token-blacklist', () => {
|
|||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['auth'],
|
plugins: ['field-sort', 'auth'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
repo = db.getRepository('tokenBlacklist');
|
repo = db.getRepository('tokenBlacklist');
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('sql collection', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['data-source-main', 'error-handler', 'collection-sql'],
|
plugins: ['field-sort', 'data-source-main', 'error-handler', 'collection-sql'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
db.options.underscored = false;
|
db.options.underscored = false;
|
||||||
|
|||||||
@ -16,6 +16,7 @@ export async function prepareApp(): Promise<MockServer> {
|
|||||||
plugins: [
|
plugins: [
|
||||||
'acl',
|
'acl',
|
||||||
'error-handler',
|
'error-handler',
|
||||||
|
'field-sort',
|
||||||
'users',
|
'users',
|
||||||
'ui-schema-storage',
|
'ui-schema-storage',
|
||||||
'data-source-main',
|
'data-source-main',
|
||||||
@ -32,6 +33,7 @@ export async function createApp(options: any = {}) {
|
|||||||
acl: false,
|
acl: false,
|
||||||
...options,
|
...options,
|
||||||
plugins: [
|
plugins: [
|
||||||
|
'field-sort',
|
||||||
'data-source-main',
|
'data-source-main',
|
||||||
'users',
|
'users',
|
||||||
'collection-tree',
|
'collection-tree',
|
||||||
@ -47,7 +49,14 @@ export async function createAppWithNoUsersPlugin(options: any = {}) {
|
|||||||
const app = await createMockServer({
|
const app = await createMockServer({
|
||||||
acl: false,
|
acl: false,
|
||||||
...options,
|
...options,
|
||||||
plugins: ['data-source-main', 'collection-tree', 'error-handler', 'data-source-manager', 'ui-schema-storage'],
|
plugins: [
|
||||||
|
'field-sort',
|
||||||
|
'data-source-main',
|
||||||
|
'collection-tree',
|
||||||
|
'error-handler',
|
||||||
|
'data-source-manager',
|
||||||
|
'ui-schema-storage',
|
||||||
|
],
|
||||||
});
|
});
|
||||||
return app;
|
return app;
|
||||||
}
|
}
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('tree collection sync', async () => {
|
|||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
version: '1.3.0-alpha',
|
version: '1.3.0-alpha',
|
||||||
plugins: ['data-source-main', 'data-source-manager', 'error-handler', 'collection-tree'],
|
plugins: ['field-sort', 'data-source-main', 'data-source-manager', 'error-handler', 'collection-tree'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
});
|
});
|
||||||
@ -61,7 +61,7 @@ describe('collection tree migrate test', () => {
|
|||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
version: '1.3.0-alpha',
|
version: '1.3.0-alpha',
|
||||||
plugins: ['data-source-main', 'data-source-manager', 'error-handler', 'collection-tree'],
|
plugins: ['field-sort', 'data-source-main', 'data-source-manager', 'error-handler', 'collection-tree'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
repo = app.db.getRepository('applicationPlugins');
|
repo = app.db.getRepository('applicationPlugins');
|
||||||
|
|||||||
@ -42,7 +42,8 @@ describe('tree', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
const userPlugin = app.getPlugin('users');
|
const userPlugin = app.getPlugin('users');
|
||||||
const agent = app.agent().login(user).set('X-With-ACL-Meta', true);
|
const agent = app.agent().login(user);
|
||||||
|
agent.set('X-With-ACL-Meta', 'true');
|
||||||
app.acl.allow('table_a', ['*']);
|
app.acl.allow('table_a', ['*']);
|
||||||
app.acl.allow('collections', ['*']);
|
app.acl.allow('collections', ['*']);
|
||||||
|
|
||||||
|
|||||||
@ -11,13 +11,13 @@
|
|||||||
"license": "AGPL-3.0",
|
"license": "AGPL-3.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@hapi/topo": "^6.0.0",
|
"@hapi/topo": "^6.0.0",
|
||||||
"async-mutex": "^0.3.2",
|
|
||||||
"toposort": "^2.0.2"
|
"toposort": "^2.0.2"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@nocobase/client": "1.x",
|
"@nocobase/client": "1.x",
|
||||||
"@nocobase/database": "1.x",
|
"@nocobase/database": "1.x",
|
||||||
"@nocobase/plugin-error-handler": "1.x",
|
"@nocobase/plugin-error-handler": "1.x",
|
||||||
|
"@nocobase/plugin-field-sort": "1.x",
|
||||||
"@nocobase/server": "1.x",
|
"@nocobase/server": "1.x",
|
||||||
"@nocobase/test": "1.x",
|
"@nocobase/test": "1.x",
|
||||||
"@nocobase/utils": "1.x"
|
"@nocobase/utils": "1.x"
|
||||||
|
|||||||
@ -13,7 +13,7 @@ describe('cluster', () => {
|
|||||||
let cluster;
|
let cluster;
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
cluster = await createMockCluster({
|
cluster = await createMockCluster({
|
||||||
plugins: ['error-handler', 'data-source-main', 'ui-schema-storage'],
|
plugins: ['error-handler', 'field-sort', 'data-source-main', 'ui-schema-storage'],
|
||||||
acl: false,
|
acl: false,
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@ -13,7 +13,7 @@ export async function createApp(options: any = {}) {
|
|||||||
const app = await createMockServer({
|
const app = await createMockServer({
|
||||||
acl: false,
|
acl: false,
|
||||||
...options,
|
...options,
|
||||||
plugins: ['error-handler', 'data-source-main', 'ui-schema-storage'],
|
plugins: ['error-handler', 'field-sort', 'data-source-main', 'ui-schema-storage'],
|
||||||
});
|
});
|
||||||
return app;
|
return app;
|
||||||
}
|
}
|
||||||
|
|||||||
@ -16,7 +16,7 @@ describe('collections repository', () => {
|
|||||||
tablePrefix: 'through_',
|
tablePrefix: 'through_',
|
||||||
},
|
},
|
||||||
acl: false,
|
acl: false,
|
||||||
plugins: ['error-handler', 'data-source-main'],
|
plugins: ['error-handler', 'field-sort', 'data-source-main'],
|
||||||
});
|
});
|
||||||
|
|
||||||
await app1
|
await app1
|
||||||
@ -121,7 +121,7 @@ describe('collections repository', () => {
|
|||||||
await app1.destroy();
|
await app1.destroy();
|
||||||
|
|
||||||
const app2 = await startMockServer({
|
const app2 = await startMockServer({
|
||||||
plugins: ['error-handler', 'data-source-main'],
|
plugins: ['error-handler', 'field-sort', 'data-source-main'],
|
||||||
database: {
|
database: {
|
||||||
tablePrefix: 'through_',
|
tablePrefix: 'through_',
|
||||||
database: app1.db.options.database,
|
database: app1.db.options.database,
|
||||||
|
|||||||
@ -10,7 +10,6 @@
|
|||||||
import { Filter, InheritedCollection, UniqueConstraintError } from '@nocobase/database';
|
import { Filter, InheritedCollection, UniqueConstraintError } from '@nocobase/database';
|
||||||
import PluginErrorHandler from '@nocobase/plugin-error-handler';
|
import PluginErrorHandler from '@nocobase/plugin-error-handler';
|
||||||
import { Plugin } from '@nocobase/server';
|
import { Plugin } from '@nocobase/server';
|
||||||
import { Mutex } from 'async-mutex';
|
|
||||||
import lodash from 'lodash';
|
import lodash from 'lodash';
|
||||||
import path from 'path';
|
import path from 'path';
|
||||||
import * as process from 'process';
|
import * as process from 'process';
|
||||||
@ -315,9 +314,9 @@ export class PluginDataSourceMainServer extends Plugin {
|
|||||||
this.app.db.on('fields.beforeDestroy', beforeDestoryField(this.app.db));
|
this.app.db.on('fields.beforeDestroy', beforeDestoryField(this.app.db));
|
||||||
this.app.db.on('fields.beforeDestroy', beforeDestroyForeignKey(this.app.db));
|
this.app.db.on('fields.beforeDestroy', beforeDestroyForeignKey(this.app.db));
|
||||||
|
|
||||||
const mutex = new Mutex();
|
|
||||||
this.app.db.on('fields.beforeDestroy', async (model: FieldModel, options) => {
|
this.app.db.on('fields.beforeDestroy', async (model: FieldModel, options) => {
|
||||||
await mutex.runExclusive(async () => {
|
const lockKey = `${this.name}:fields.beforeDestroy:${model.get('collectionName')}`;
|
||||||
|
await this.app.lockManager.runExclusive(lockKey, async () => {
|
||||||
await model.remove(options);
|
await model.remove(options);
|
||||||
|
|
||||||
this.sendSyncMessage(
|
this.sendSyncMessage(
|
||||||
|
|||||||
@ -20,7 +20,7 @@ describe('api', () => {
|
|||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
acl: true,
|
acl: true,
|
||||||
plugins: ['users', 'auth', 'data-visualization'],
|
plugins: ['field-sort', 'users', 'auth', 'data-visualization'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
|
|
||||||
|
|||||||
@ -19,7 +19,7 @@ describe('external data source', () => {
|
|||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
process.env.INIT_ROOT_USERNAME = 'test';
|
process.env.INIT_ROOT_USERNAME = 'test';
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['data-source-manager', 'users', 'acl'],
|
plugins: ['field-sort', 'data-source-manager', 'users', 'acl'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
ctx = {
|
ctx = {
|
||||||
|
|||||||
@ -29,7 +29,7 @@ describe('query', () => {
|
|||||||
let db: Database;
|
let db: Database;
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['data-source-manager', 'users', 'acl'],
|
plugins: ['field-sort', 'data-source-manager', 'users', 'acl'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
db.options.underscored = true;
|
db.options.underscored = true;
|
||||||
|
|||||||
@ -17,7 +17,7 @@ describe('belongs to array field', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['field-m2m-array', 'data-source-manager', 'data-source-main', 'error-handler'],
|
plugins: ['field-m2m-array', 'data-source-manager', 'field-sort', 'data-source-main', 'error-handler'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
fieldRepo = db.getRepository('fields');
|
fieldRepo = db.getRepository('fields');
|
||||||
|
|||||||
@ -17,7 +17,7 @@ describe('m2m array api, bigInt targetKey', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['field-m2m-array', 'data-source-manager', 'data-source-main', 'error-handler'],
|
plugins: ['field-m2m-array', 'data-source-manager', 'field-sort', 'data-source-main', 'error-handler'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
await db.getRepository('collections').create({
|
await db.getRepository('collections').create({
|
||||||
|
|||||||
@ -17,7 +17,7 @@ describe('m2m array api, string targetKey', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['field-m2m-array', 'data-source-manager', 'data-source-main', 'error-handler'],
|
plugins: ['field-m2m-array', 'data-source-manager', 'field-sort', 'data-source-main', 'error-handler'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
await db.getRepository('collections').create({
|
await db.getRepository('collections').create({
|
||||||
|
|||||||
2
packages/plugins/@nocobase/plugin-field-sort/.npmignore
Normal file
2
packages/plugins/@nocobase/plugin-field-sort/.npmignore
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
/node_modules
|
||||||
|
/src
|
||||||
1
packages/plugins/@nocobase/plugin-field-sort/README.md
Normal file
1
packages/plugins/@nocobase/plugin-field-sort/README.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# @nocobase/plugin-field-sort
|
||||||
2
packages/plugins/@nocobase/plugin-field-sort/client.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-field-sort/client.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
export * from './dist/client';
|
||||||
|
export { default } from './dist/client';
|
||||||
1
packages/plugins/@nocobase/plugin-field-sort/client.js
Normal file
1
packages/plugins/@nocobase/plugin-field-sort/client.js
Normal file
@ -0,0 +1 @@
|
|||||||
|
module.exports = require('./dist/client/index.js');
|
||||||
16
packages/plugins/@nocobase/plugin-field-sort/package.json
Normal file
16
packages/plugins/@nocobase/plugin-field-sort/package.json
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"name": "@nocobase/plugin-field-sort",
|
||||||
|
"version": "1.4.0-alpha",
|
||||||
|
"main": "dist/server/index.js",
|
||||||
|
"dependencies": {},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@nocobase/actions": "1.x",
|
||||||
|
"@nocobase/client": "1.x",
|
||||||
|
"@nocobase/database": "1.x",
|
||||||
|
"@nocobase/lock-manager": "1.x",
|
||||||
|
"@nocobase/server": "1.x",
|
||||||
|
"@nocobase/test": "1.x",
|
||||||
|
"lodash": "4.17.21",
|
||||||
|
"sequelize": "^6.26.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
2
packages/plugins/@nocobase/plugin-field-sort/server.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-field-sort/server.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
export * from './dist/server';
|
||||||
|
export { default } from './dist/server';
|
||||||
1
packages/plugins/@nocobase/plugin-field-sort/server.js
Normal file
1
packages/plugins/@nocobase/plugin-field-sort/server.js
Normal file
@ -0,0 +1 @@
|
|||||||
|
module.exports = require('./dist/server/index.js');
|
||||||
249
packages/plugins/@nocobase/plugin-field-sort/src/client/client.d.ts
vendored
Normal file
249
packages/plugins/@nocobase/plugin-field-sort/src/client/client.d.ts
vendored
Normal file
@ -0,0 +1,249 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// CSS modules
|
||||||
|
type CSSModuleClasses = { readonly [key: string]: string };
|
||||||
|
|
||||||
|
declare module '*.module.css' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.scss' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.sass' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.less' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.styl' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.stylus' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.pcss' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
declare module '*.module.sss' {
|
||||||
|
const classes: CSSModuleClasses;
|
||||||
|
export default classes;
|
||||||
|
}
|
||||||
|
|
||||||
|
// CSS
|
||||||
|
declare module '*.css' { }
|
||||||
|
declare module '*.scss' { }
|
||||||
|
declare module '*.sass' { }
|
||||||
|
declare module '*.less' { }
|
||||||
|
declare module '*.styl' { }
|
||||||
|
declare module '*.stylus' { }
|
||||||
|
declare module '*.pcss' { }
|
||||||
|
declare module '*.sss' { }
|
||||||
|
|
||||||
|
// Built-in asset types
|
||||||
|
// see `src/node/constants.ts`
|
||||||
|
|
||||||
|
// images
|
||||||
|
declare module '*.apng' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.png' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.jpg' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.jpeg' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.jfif' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.pjpeg' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.pjp' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.gif' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.svg' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.ico' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.webp' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.avif' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
// media
|
||||||
|
declare module '*.mp4' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.webm' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.ogg' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.mp3' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.wav' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.flac' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.aac' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.opus' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.mov' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.m4a' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.vtt' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
// fonts
|
||||||
|
declare module '*.woff' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.woff2' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.eot' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.ttf' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.otf' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
// other
|
||||||
|
declare module '*.webmanifest' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.pdf' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
declare module '*.txt' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
// wasm?init
|
||||||
|
declare module '*.wasm?init' {
|
||||||
|
const initWasm: (options?: WebAssembly.Imports) => Promise<WebAssembly.Instance>;
|
||||||
|
export default initWasm;
|
||||||
|
}
|
||||||
|
|
||||||
|
// web worker
|
||||||
|
declare module '*?worker' {
|
||||||
|
const workerConstructor: {
|
||||||
|
new(options?: { name?: string }): Worker;
|
||||||
|
};
|
||||||
|
export default workerConstructor;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?worker&inline' {
|
||||||
|
const workerConstructor: {
|
||||||
|
new(options?: { name?: string }): Worker;
|
||||||
|
};
|
||||||
|
export default workerConstructor;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?worker&url' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?sharedworker' {
|
||||||
|
const sharedWorkerConstructor: {
|
||||||
|
new(options?: { name?: string }): SharedWorker;
|
||||||
|
};
|
||||||
|
export default sharedWorkerConstructor;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?sharedworker&inline' {
|
||||||
|
const sharedWorkerConstructor: {
|
||||||
|
new(options?: { name?: string }): SharedWorker;
|
||||||
|
};
|
||||||
|
export default sharedWorkerConstructor;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?sharedworker&url' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?raw' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?url' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module '*?inline' {
|
||||||
|
const src: string;
|
||||||
|
export default src;
|
||||||
|
}
|
||||||
@ -0,0 +1,31 @@
|
|||||||
|
/**
|
||||||
|
* 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 { Plugin } from '@nocobase/client';
|
||||||
|
import { SortFieldInterface } from './sort-interface';
|
||||||
|
|
||||||
|
export class PluginFieldSortClient extends Plugin {
|
||||||
|
async afterAdd() {
|
||||||
|
// await this.app.pm.add()
|
||||||
|
}
|
||||||
|
|
||||||
|
async beforeLoad() {}
|
||||||
|
|
||||||
|
// You can get and modify the app instance here
|
||||||
|
async load() {
|
||||||
|
this.app.addFieldInterfaces([SortFieldInterface]);
|
||||||
|
// this.app.addComponents({})
|
||||||
|
// this.app.addScopes({})
|
||||||
|
// this.app.addProvider()
|
||||||
|
// this.app.addProviders()
|
||||||
|
// this.app.router.add()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PluginFieldSortClient;
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// @ts-ignore
|
||||||
|
import pkg from './../../package.json';
|
||||||
|
import { useApp } from '@nocobase/client';
|
||||||
|
|
||||||
|
export function useT() {
|
||||||
|
const app = useApp();
|
||||||
|
return (str: string) => app.i18n.t(str, { ns: [pkg.name, 'client'] });
|
||||||
|
}
|
||||||
|
|
||||||
|
export function tStr(key: string) {
|
||||||
|
return `{{t(${JSON.stringify(key)}, { ns: ['${pkg.name}', 'client'], nsMode: 'fallback' })}}`;
|
||||||
|
}
|
||||||
@ -7,9 +7,7 @@
|
|||||||
* For more information, please refer to: https://www.nocobase.com/agreement.
|
* For more information, please refer to: https://www.nocobase.com/agreement.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { CollectionFieldInterface } from '../../data-source/collection-field-interface/CollectionFieldInterface';
|
import { CollectionFieldInterface, i18n, defaultProps, operators } from '@nocobase/client';
|
||||||
import { i18n } from '../../i18n';
|
|
||||||
import { defaultProps, operators } from './properties';
|
|
||||||
export class SortFieldInterface extends CollectionFieldInterface {
|
export class SortFieldInterface extends CollectionFieldInterface {
|
||||||
name = 'sort';
|
name = 'sort';
|
||||||
type = 'object';
|
type = 'object';
|
||||||
11
packages/plugins/@nocobase/plugin-field-sort/src/index.ts
Normal file
11
packages/plugins/@nocobase/plugin-field-sort/src/index.ts
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export * from './server';
|
||||||
|
export { default } from './server';
|
||||||
@ -0,0 +1 @@
|
|||||||
|
{}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
{}
|
||||||
@ -7,22 +7,30 @@
|
|||||||
* For more information, please refer to: https://www.nocobase.com/agreement.
|
* For more information, please refer to: https://www.nocobase.com/agreement.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { mockServer, MockServer } from './index';
|
import { createMockServer, MockServer } from '@nocobase/test';
|
||||||
import { registerActions } from '@nocobase/actions';
|
|
||||||
import { Collection, Database } from '@nocobase/database';
|
import { Collection, Database } from '@nocobase/database';
|
||||||
import { waitSecond } from '@nocobase/test';
|
import { waitSecond } from '@nocobase/test';
|
||||||
|
|
||||||
describe('sort action', () => {
|
import Plugin from '..';
|
||||||
describe('associations', () => {
|
|
||||||
let api: MockServer;
|
|
||||||
|
|
||||||
|
describe('sort action', () => {
|
||||||
|
let api: MockServer;
|
||||||
|
let db: Database;
|
||||||
|
|
||||||
|
beforeEach(async () => {
|
||||||
|
api = await createMockServer({
|
||||||
|
plugins: [Plugin, 'data-source-main', 'error-handler'],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(async () => {
|
||||||
|
return api.destroy();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('associations', () => {
|
||||||
let UserCollection: Collection;
|
let UserCollection: Collection;
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
api = mockServer();
|
|
||||||
|
|
||||||
registerActions(api);
|
|
||||||
|
|
||||||
UserCollection = api.db.collection({
|
UserCollection = api.db.collection({
|
||||||
name: 'users',
|
name: 'users',
|
||||||
fields: [
|
fields: [
|
||||||
@ -67,10 +75,6 @@ describe('sort action', () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
afterEach(async () => {
|
|
||||||
return api.destroy();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should not move association items when association not sortable', async () => {
|
it('should not move association items when association not sortable', async () => {
|
||||||
const u1 = await api.db.getRepository('users').findOne({
|
const u1 = await api.db.getRepository('users').findOne({
|
||||||
filter: {
|
filter: {
|
||||||
@ -143,7 +147,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(u1Posts.body).toMatchObject({
|
expect(u1Posts.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 'u1p2',
|
title: 'u1p2',
|
||||||
},
|
},
|
||||||
@ -162,12 +166,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe('same scope', () => {
|
describe('same scope', () => {
|
||||||
let api: MockServer;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
api = mockServer();
|
|
||||||
|
|
||||||
registerActions(api);
|
|
||||||
api.db.collection({
|
api.db.collection({
|
||||||
name: 'tests',
|
name: 'tests',
|
||||||
fields: [
|
fields: [
|
||||||
@ -202,7 +201,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't2',
|
title: 't2',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -237,7 +236,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't3',
|
title: 't3',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -272,7 +271,7 @@ describe('sort action', () => {
|
|||||||
sort: ['sort2'],
|
sort: ['sort2'],
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't2',
|
title: 't2',
|
||||||
sort2: 1,
|
sort2: 1,
|
||||||
@ -306,7 +305,7 @@ describe('sort action', () => {
|
|||||||
sort: ['sort'],
|
sort: ['sort'],
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't3',
|
title: 't3',
|
||||||
sort: 0,
|
sort: 0,
|
||||||
@ -329,14 +328,9 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe('different scope', () => {
|
describe('different scope', () => {
|
||||||
let api: MockServer;
|
|
||||||
let db: Database;
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
api = mockServer();
|
|
||||||
db = api.db;
|
db = api.db;
|
||||||
|
|
||||||
registerActions(api);
|
|
||||||
api.db.collection({
|
api.db.collection({
|
||||||
name: 'tests',
|
name: 'tests',
|
||||||
fields: [
|
fields: [
|
||||||
@ -495,7 +489,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't12',
|
title: 't12',
|
||||||
sort: 2,
|
sort: 2,
|
||||||
@ -520,7 +514,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't21',
|
title: 't21',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -561,7 +555,7 @@ describe('sort action', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't12',
|
title: 't12',
|
||||||
sort: 2,
|
sort: 2,
|
||||||
@ -584,7 +578,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 2 },
|
filter: { state: 2 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't21',
|
title: 't21',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -622,7 +616,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 1 },
|
filter: { state: 1 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't11',
|
title: 't11',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -653,7 +647,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 2 },
|
filter: { state: 2 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't21',
|
title: 't21',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -684,7 +678,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 1 },
|
filter: { state: 1 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't11',
|
title: 't11',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -715,7 +709,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 2 },
|
filter: { state: 2 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't21',
|
title: 't21',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -750,7 +744,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 1 },
|
filter: { state: 1 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't12',
|
title: 't12',
|
||||||
sort: 2,
|
sort: 2,
|
||||||
@ -773,7 +767,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 2 },
|
filter: { state: 2 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't21',
|
title: 't21',
|
||||||
sort: 1,
|
sort: 1,
|
||||||
@ -817,7 +811,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 1 },
|
filter: { state: 1 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't12',
|
title: 't12',
|
||||||
},
|
},
|
||||||
@ -837,7 +831,7 @@ describe('sort action', () => {
|
|||||||
filter: { state: 2 },
|
filter: { state: 2 },
|
||||||
});
|
});
|
||||||
expect(response.body).toMatchObject({
|
expect(response.body).toMatchObject({
|
||||||
rows: [
|
data: [
|
||||||
{
|
{
|
||||||
title: 't11',
|
title: 't11',
|
||||||
},
|
},
|
||||||
@ -7,16 +7,23 @@
|
|||||||
* For more information, please refer to: https://www.nocobase.com/agreement.
|
* For more information, please refer to: https://www.nocobase.com/agreement.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { mockServer } from './index';
|
|
||||||
import { SortAbleCollection } from '../actions';
|
|
||||||
import lodash from 'lodash';
|
import lodash from 'lodash';
|
||||||
|
import Database from '@nocobase/database';
|
||||||
|
import { createMockServer, MockServer } from '@nocobase/test';
|
||||||
|
import { SortableCollection } from '../action';
|
||||||
|
import Plugin from '..';
|
||||||
|
|
||||||
describe('sort collections', () => {
|
describe('sort collections', () => {
|
||||||
let app;
|
let app: MockServer;
|
||||||
|
let db: Database;
|
||||||
let Post;
|
let Post;
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = mockServer();
|
app = await createMockServer({
|
||||||
|
plugins: ['error-handler', Plugin, 'data-source-main'],
|
||||||
|
});
|
||||||
|
|
||||||
|
db = app.db;
|
||||||
});
|
});
|
||||||
|
|
||||||
afterEach(async () => {
|
afterEach(async () => {
|
||||||
@ -50,6 +57,57 @@ describe('sort collections', () => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('sortable=true', async () => {
|
||||||
|
const Test = db.collection({
|
||||||
|
name: 'test',
|
||||||
|
sortable: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
const model = Test.model;
|
||||||
|
|
||||||
|
await db.sync();
|
||||||
|
const instance = await model.create();
|
||||||
|
expect(model.rawAttributes['sort']).toBeDefined();
|
||||||
|
expect(instance.get('sort')).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('sortable=string', async () => {
|
||||||
|
const Test = db.collection({
|
||||||
|
name: 'test',
|
||||||
|
sortable: 'order',
|
||||||
|
});
|
||||||
|
|
||||||
|
const model = Test.model;
|
||||||
|
|
||||||
|
await db.sync();
|
||||||
|
const instance = await model.create();
|
||||||
|
expect(model.rawAttributes['order']).toBeDefined();
|
||||||
|
expect(instance.get('order')).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('sortable=object', async () => {
|
||||||
|
const Test = db.collection({
|
||||||
|
name: 'test',
|
||||||
|
sortable: {
|
||||||
|
name: 'sort',
|
||||||
|
scopeKey: 'status',
|
||||||
|
},
|
||||||
|
fields: [{ type: 'string', name: 'status' }],
|
||||||
|
});
|
||||||
|
|
||||||
|
await db.sync();
|
||||||
|
|
||||||
|
const t1 = await Test.model.create({ status: 'publish' });
|
||||||
|
const t2 = await Test.model.create({ status: 'publish' });
|
||||||
|
const t3 = await Test.model.create({ status: 'draft' });
|
||||||
|
const t4 = await Test.model.create({ status: 'draft' });
|
||||||
|
|
||||||
|
expect(t1.get('sort')).toBe(1);
|
||||||
|
expect(t2.get('sort')).toBe(2);
|
||||||
|
expect(t3.get('sort')).toBe(1);
|
||||||
|
expect(t4.get('sort')).toBe(2);
|
||||||
|
});
|
||||||
|
|
||||||
test('forward insert', async () => {
|
test('forward insert', async () => {
|
||||||
const t2 = await Post.repository.findOne({
|
const t2 = await Post.repository.findOne({
|
||||||
filter: {
|
filter: {
|
||||||
@ -62,7 +120,7 @@ describe('sort collections', () => {
|
|||||||
title: 't4',
|
title: 't4',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
const sortCollection = new SortAbleCollection(Post);
|
const sortCollection = new SortableCollection(Post);
|
||||||
|
|
||||||
await sortCollection.move(t2.get('id'), t4.get('id'));
|
await sortCollection.move(t2.get('id'), t4.get('id'));
|
||||||
|
|
||||||
@ -95,7 +153,7 @@ describe('sort collections', () => {
|
|||||||
title: 't4',
|
title: 't4',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
const sortCollection = new SortAbleCollection(Post);
|
const sortCollection = new SortableCollection(Post);
|
||||||
|
|
||||||
await sortCollection.move(t4.get('id'), t2.get('id'));
|
await sortCollection.move(t4.get('id'), t2.get('id'));
|
||||||
|
|
||||||
@ -173,7 +231,7 @@ describe('sort collections', () => {
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const sortCollection = new SortAbleCollection(Post);
|
const sortCollection = new SortableCollection(Post);
|
||||||
await sortCollection.move(s1t2.get('id'), s1t4.get('id'));
|
await sortCollection.move(s1t2.get('id'), s1t4.get('id'));
|
||||||
const results = (
|
const results = (
|
||||||
await Post.repository.find({
|
await Post.repository.find({
|
||||||
@ -245,7 +303,7 @@ describe('sort collections', () => {
|
|||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const sortCollection = new SortAbleCollection(Post);
|
const sortCollection = new SortableCollection(Post);
|
||||||
|
|
||||||
await sortCollection.move(s1t1.get('id'), s2t3.get('id'));
|
await sortCollection.move(s1t1.get('id'), s2t3.get('id'));
|
||||||
|
|
||||||
@ -7,24 +7,24 @@
|
|||||||
* For more information, please refer to: https://www.nocobase.com/agreement.
|
* For more information, please refer to: https://www.nocobase.com/agreement.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { Database } from '../../database';
|
import { Database } from '@nocobase/database';
|
||||||
import { mockDatabase } from '../';
|
import { createMockServer, MockServer } from '@nocobase/test';
|
||||||
import { SortField } from '../../fields';
|
|
||||||
|
import Plugin from '..';
|
||||||
|
|
||||||
describe('string field', () => {
|
describe('string field', () => {
|
||||||
|
let app: MockServer;
|
||||||
let db: Database;
|
let db: Database;
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
db = mockDatabase();
|
app = await createMockServer({
|
||||||
await db.clean({ drop: true });
|
plugins: [Plugin, 'data-source-main', 'error-handler'],
|
||||||
|
|
||||||
db.registerFieldTypes({
|
|
||||||
sort: SortField,
|
|
||||||
});
|
});
|
||||||
|
db = app.db;
|
||||||
});
|
});
|
||||||
|
|
||||||
afterEach(async () => {
|
afterEach(async () => {
|
||||||
await db.close();
|
await app.destroy();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should init with camelCase scope key', async () => {
|
it('should init with camelCase scope key', async () => {
|
||||||
@ -7,14 +7,23 @@
|
|||||||
* For more information, please refer to: https://www.nocobase.com/agreement.
|
* For more information, please refer to: https://www.nocobase.com/agreement.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { Model, Op } from 'sequelize';
|
import { BelongsToManyRepository, Collection, HasManyRepository, TargetKey, Model, Op } from '@nocobase/database';
|
||||||
|
import { Context } from '@nocobase/actions';
|
||||||
|
|
||||||
import { BelongsToManyRepository, Collection, HasManyRepository, SortField, TargetKey } from '@nocobase/database';
|
import { SortField } from './sort-field';
|
||||||
import { Context } from '..';
|
|
||||||
import { getRepositoryFromParams } from '../utils';
|
|
||||||
|
|
||||||
export async function move(ctx: Context, next) {
|
export async function move(ctx: Context, next) {
|
||||||
const repository = ctx.databaseRepository || getRepositoryFromParams(ctx);
|
const repository = ctx.getCurrentRepository();
|
||||||
|
|
||||||
|
if (repository.move) {
|
||||||
|
ctx.body = await repository.move(ctx.action.params);
|
||||||
|
return next();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!repository.database) {
|
||||||
|
return ctx.throw(new Error(`Repository can not handle action move for ${ctx.action.resourceName}`));
|
||||||
|
}
|
||||||
|
|
||||||
const { sourceId, targetId, targetScope, sticky, method } = ctx.action.params;
|
const { sourceId, targetId, targetScope, sticky, method } = ctx.action.params;
|
||||||
|
|
||||||
let sortField = ctx.action.params.sortField;
|
let sortField = ctx.action.params.sortField;
|
||||||
@ -27,21 +36,21 @@ export async function move(ctx: Context, next) {
|
|||||||
sortField = `${repository.association.foreignKey}Sort`;
|
sortField = `${repository.association.foreignKey}Sort`;
|
||||||
}
|
}
|
||||||
|
|
||||||
const sortAbleCollection = new SortAbleCollection(repository.collection, sortField);
|
const sortableCollection = new SortableCollection(repository.collection, sortField);
|
||||||
|
|
||||||
if (sourceId && targetId) {
|
if (sourceId && targetId) {
|
||||||
await sortAbleCollection.move(sourceId, targetId, {
|
await sortableCollection.move(sourceId, targetId, {
|
||||||
insertAfter: method === 'insertAfter',
|
insertAfter: method === 'insertAfter',
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// change scope
|
// change scope
|
||||||
if (sourceId && targetScope) {
|
if (sourceId && targetScope) {
|
||||||
await sortAbleCollection.changeScope(sourceId, targetScope, method);
|
await sortableCollection.changeScope(sourceId, targetScope, method);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (sourceId && sticky) {
|
if (sourceId && sticky) {
|
||||||
await sortAbleCollection.sticky(sourceId);
|
await sortableCollection.sticky(sourceId);
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx.body = 'ok';
|
ctx.body = 'ok';
|
||||||
@ -57,7 +66,7 @@ interface MoveOptions {
|
|||||||
insertAfter?: boolean;
|
insertAfter?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class SortAbleCollection {
|
export class SortableCollection {
|
||||||
collection: Collection;
|
collection: Collection;
|
||||||
field: SortField;
|
field: SortField;
|
||||||
scopeKey: string;
|
scopeKey: string;
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export { default } from './plugin';
|
||||||
|
export { move } from './action';
|
||||||
@ -0,0 +1,46 @@
|
|||||||
|
/**
|
||||||
|
* 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 { Plugin } from '@nocobase/server';
|
||||||
|
import { DataSource } from '@nocobase/data-source-manager';
|
||||||
|
|
||||||
|
import { SortField } from './sort-field';
|
||||||
|
import { move } from './action';
|
||||||
|
|
||||||
|
export class PluginFieldSortServer extends Plugin {
|
||||||
|
async afterAdd() {}
|
||||||
|
|
||||||
|
async beforeLoad() {
|
||||||
|
const { lockManager } = this.app;
|
||||||
|
class SortFieldClass extends SortField {}
|
||||||
|
SortFieldClass.lockManager = lockManager;
|
||||||
|
this.app.db.registerFieldTypes({
|
||||||
|
sort: SortFieldClass,
|
||||||
|
});
|
||||||
|
|
||||||
|
this.app.dataSourceManager.beforeAddDataSource((dataSource: DataSource) => {
|
||||||
|
// @ts-ignore
|
||||||
|
if (dataSource.collectionManager?.db) {
|
||||||
|
dataSource.resourceManager.registerActionHandlers({ move });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async load() {}
|
||||||
|
|
||||||
|
async install() {}
|
||||||
|
|
||||||
|
async afterEnable() {}
|
||||||
|
|
||||||
|
async afterDisable() {}
|
||||||
|
|
||||||
|
async remove() {}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PluginFieldSortServer;
|
||||||
@ -7,14 +7,14 @@
|
|||||||
* For more information, please refer to: https://www.nocobase.com/agreement.
|
* For more information, please refer to: https://www.nocobase.com/agreement.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { Mutex } from 'async-mutex';
|
|
||||||
import { isNumber } from 'lodash';
|
import { isNumber } from 'lodash';
|
||||||
import { DataTypes } from 'sequelize';
|
import { DataTypes } from 'sequelize';
|
||||||
import { BaseColumnFieldOptions, Field } from './field';
|
import { BaseColumnFieldOptions, Field } from '@nocobase/database';
|
||||||
|
import { LockManager } from '@nocobase/lock-manager';
|
||||||
const sortFieldMutex = new Mutex();
|
|
||||||
|
|
||||||
export class SortField extends Field {
|
export class SortField extends Field {
|
||||||
|
static lockManager: LockManager;
|
||||||
|
|
||||||
get dataType() {
|
get dataType() {
|
||||||
return DataTypes.BIGINT;
|
return DataTypes.BIGINT;
|
||||||
}
|
}
|
||||||
@ -36,11 +36,15 @@ export class SortField extends Field {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
await sortFieldMutex.runExclusive(async () => {
|
await (<typeof SortField>this.constructor).lockManager.runExclusive(
|
||||||
|
this.context.collection.name,
|
||||||
|
async () => {
|
||||||
const max = await model.max<number, any>(name, { ...options, where });
|
const max = await model.max<number, any>(name, { ...options, where });
|
||||||
const newValue = (max || 0) + 1;
|
const newValue = (max || 0) + 1;
|
||||||
instance.set(name, newValue);
|
instance.set(name, newValue);
|
||||||
});
|
},
|
||||||
|
2000,
|
||||||
|
);
|
||||||
};
|
};
|
||||||
|
|
||||||
onScopeChange = async (instance, options) => {
|
onScopeChange = async (instance, options) => {
|
||||||
@ -18,7 +18,7 @@ export async function getApp(options = {}): Promise<MockServer> {
|
|||||||
cors: {
|
cors: {
|
||||||
origin: '*',
|
origin: '*',
|
||||||
},
|
},
|
||||||
plugins: ['users', 'auth', 'file-manager'],
|
plugins: ['field-sort', 'users', 'auth', 'file-manager'],
|
||||||
});
|
});
|
||||||
|
|
||||||
app.use(async (ctx, next) => {
|
app.use(async (ctx, next) => {
|
||||||
|
|||||||
@ -22,6 +22,7 @@ describe('sync', () => {
|
|||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: [
|
plugins: [
|
||||||
// 'data-source-manager',
|
// 'data-source-manager',
|
||||||
|
'field-sort',
|
||||||
'data-source-main',
|
'data-source-main',
|
||||||
'localization',
|
'localization',
|
||||||
'ui-schema-storage',
|
'ui-schema-storage',
|
||||||
|
|||||||
@ -14,7 +14,7 @@
|
|||||||
"@formily/shared": "2.x",
|
"@formily/shared": "2.x",
|
||||||
"antd": "5.x",
|
"antd": "5.x",
|
||||||
"antd-style": "3.x",
|
"antd-style": "3.x",
|
||||||
"async-mutex": "^0.3.2",
|
"async-mutex": "^0.5.0",
|
||||||
"mysql2": "^3.11.0",
|
"mysql2": "^3.11.0",
|
||||||
"pg": "^8.7.3",
|
"pg": "^8.7.3",
|
||||||
"react": "18.x",
|
"react": "18.x",
|
||||||
|
|||||||
@ -44,7 +44,7 @@ describe('test with start', () => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const app = await createMockServer({
|
const app = await createMockServer({
|
||||||
plugins: ['multi-app-manager'],
|
plugins: ['field-sort', 'multi-app-manager'],
|
||||||
});
|
});
|
||||||
|
|
||||||
const db = app.db;
|
const db = app.db;
|
||||||
@ -74,7 +74,7 @@ describe('test with start', () => {
|
|||||||
|
|
||||||
it('should install into difference database', async () => {
|
it('should install into difference database', async () => {
|
||||||
const app = await createMockServer({
|
const app = await createMockServer({
|
||||||
plugins: ['multi-app-manager'],
|
plugins: ['field-sort', 'multi-app-manager'],
|
||||||
});
|
});
|
||||||
|
|
||||||
const db = app.db;
|
const db = app.db;
|
||||||
@ -85,7 +85,7 @@ describe('test with start', () => {
|
|||||||
values: {
|
values: {
|
||||||
name,
|
name,
|
||||||
options: {
|
options: {
|
||||||
plugins: ['ui-schema-storage'],
|
plugins: ['field-sort', 'ui-schema-storage'],
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
context: {
|
context: {
|
||||||
|
|||||||
@ -22,7 +22,7 @@ describe('multiple apps', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['nocobase', 'multi-app-manager'],
|
plugins: ['nocobase', 'field-sort', 'multi-app-manager'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
});
|
});
|
||||||
|
|||||||
@ -13,7 +13,14 @@ export async function createApp(options = {}) {
|
|||||||
const app = await createMockServer({
|
const app = await createMockServer({
|
||||||
acl: false,
|
acl: false,
|
||||||
...options,
|
...options,
|
||||||
plugins: ['users', 'error-handler', 'data-source-main', 'multi-app-manager', 'multi-app-share-collection'],
|
plugins: [
|
||||||
|
'field-sort',
|
||||||
|
'users',
|
||||||
|
'error-handler',
|
||||||
|
'data-source-main',
|
||||||
|
'multi-app-manager',
|
||||||
|
'multi-app-share-collection',
|
||||||
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
return app;
|
return app;
|
||||||
|
|||||||
@ -16,7 +16,7 @@ describe('actions', () => {
|
|||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
acl: false,
|
acl: false,
|
||||||
plugins: ['error-handler', 'users', 'ui-schema-storage', 'data-source-main', 'snapshot-field'],
|
plugins: ['error-handler', 'field-sort', 'users', 'ui-schema-storage', 'data-source-main', 'snapshot-field'],
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@ -27,7 +27,7 @@ describe('actions', () => {
|
|||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
acl: false,
|
acl: false,
|
||||||
plugins: ['error-handler', 'users', 'ui-schema-storage', 'data-source-main', 'snapshot-field'],
|
plugins: ['error-handler', 'field-sort', 'users', 'ui-schema-storage', 'data-source-main', 'snapshot-field'],
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@ -24,7 +24,16 @@ describe('server hooks', () => {
|
|||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
plugins: ['ui-schema-storage', 'data-source-main', 'error-handler', 'users', 'acl', 'data-source-manager'],
|
plugins: [
|
||||||
|
'ui-schema-storage',
|
||||||
|
'field-sort',
|
||||||
|
'data-source-main',
|
||||||
|
'field-sort',
|
||||||
|
'error-handler',
|
||||||
|
'users',
|
||||||
|
'acl',
|
||||||
|
'data-source-manager',
|
||||||
|
],
|
||||||
});
|
});
|
||||||
await app.runCommand('install', '-f');
|
await app.runCommand('install', '-f');
|
||||||
db = app.db;
|
db = app.db;
|
||||||
|
|||||||
@ -65,7 +65,7 @@ describe('server hooks', () => {
|
|||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
registerActions: true,
|
registerActions: true,
|
||||||
plugins: ['ui-schema-storage', 'data-source-main', 'error-handler'],
|
plugins: ['ui-schema-storage', 'field-sort', 'data-source-main', 'error-handler'],
|
||||||
});
|
});
|
||||||
|
|
||||||
db = app.db;
|
db = app.db;
|
||||||
|
|||||||
@ -19,7 +19,7 @@ describe('api', async () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['user-data-sync'],
|
plugins: ['field-sort', 'user-data-sync'],
|
||||||
});
|
});
|
||||||
agent = app.agent();
|
agent = app.agent();
|
||||||
const plugin = app.pm.get('user-data-sync') as PluginUserDataSyncServer;
|
const plugin = app.pm.get('user-data-sync') as PluginUserDataSyncServer;
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('user-data-resource-manager', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['user-data-sync'],
|
plugins: ['field-sort', 'user-data-sync'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
resourceManager = new UserDataResourceManager();
|
resourceManager = new UserDataResourceManager();
|
||||||
|
|||||||
@ -23,7 +23,7 @@ describe('actions', () => {
|
|||||||
process.env.INIT_ROOT_PASSWORD = '123456';
|
process.env.INIT_ROOT_PASSWORD = '123456';
|
||||||
process.env.INIT_ROOT_NICKNAME = 'Test';
|
process.env.INIT_ROOT_NICKNAME = 'Test';
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['auth', 'users', 'acl', 'data-source-manager'],
|
plugins: ['field-sort', 'auth', 'users', 'acl', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
|
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('user data sync', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['user-data-sync', 'users'],
|
plugins: ['field-sort', 'user-data-sync', 'users'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
const plugin = app.pm.get('user-data-sync') as PluginUserDataSyncServer;
|
const plugin = app.pm.get('user-data-sync') as PluginUserDataSyncServer;
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('createdBy/updatedBy', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
api = await createMockServer({
|
api = await createMockServer({
|
||||||
plugins: ['acl', 'users', 'data-source-main', 'error-handler', 'data-source-manager'],
|
plugins: ['acl', 'field-sort', 'users', 'data-source-main', 'error-handler', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
db = api.db;
|
db = api.db;
|
||||||
|
|
||||||
|
|||||||
@ -17,7 +17,7 @@ describe('models', () => {
|
|||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['auth', 'users'],
|
plugins: ['field-sort', 'auth', 'users'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
});
|
});
|
||||||
|
|||||||
@ -18,7 +18,7 @@ describe('actions', () => {
|
|||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
app = await createMockServer({
|
app = await createMockServer({
|
||||||
plugins: ['acl', 'users', 'data-source-manager'],
|
plugins: ['acl', 'field-sort', 'users', 'data-source-manager'],
|
||||||
});
|
});
|
||||||
db = app.db;
|
db = app.db;
|
||||||
repo = db.getRepository('users');
|
repo = db.getRepository('users');
|
||||||
|
|||||||
@ -43,6 +43,7 @@ export async function getApp({
|
|||||||
const app = await createMockServer({
|
const app = await createMockServer({
|
||||||
...options,
|
...options,
|
||||||
plugins: [
|
plugins: [
|
||||||
|
'field-sort',
|
||||||
[
|
[
|
||||||
'workflow',
|
'workflow',
|
||||||
{
|
{
|
||||||
|
|||||||
@ -35,6 +35,7 @@
|
|||||||
"@nocobase/plugin-field-m2m-array": "1.4.0-alpha",
|
"@nocobase/plugin-field-m2m-array": "1.4.0-alpha",
|
||||||
"@nocobase/plugin-field-markdown-vditor": "1.4.0-alpha",
|
"@nocobase/plugin-field-markdown-vditor": "1.4.0-alpha",
|
||||||
"@nocobase/plugin-field-sequence": "1.4.0-alpha",
|
"@nocobase/plugin-field-sequence": "1.4.0-alpha",
|
||||||
|
"@nocobase/plugin-field-sort": "1.4.0-alpha",
|
||||||
"@nocobase/plugin-file-manager": "1.4.0-alpha",
|
"@nocobase/plugin-file-manager": "1.4.0-alpha",
|
||||||
"@nocobase/plugin-gantt": "1.4.0-alpha",
|
"@nocobase/plugin-gantt": "1.4.0-alpha",
|
||||||
"@nocobase/plugin-graph-collection-manager": "1.4.0-alpha",
|
"@nocobase/plugin-graph-collection-manager": "1.4.0-alpha",
|
||||||
|
|||||||
@ -20,6 +20,7 @@ export class PresetNocoBase extends Plugin {
|
|||||||
'file-manager',
|
'file-manager',
|
||||||
'system-settings',
|
'system-settings',
|
||||||
'field-sequence',
|
'field-sequence',
|
||||||
|
'field-sort',
|
||||||
'verification',
|
'verification',
|
||||||
'users',
|
'users',
|
||||||
'user-data-sync',
|
'user-data-sync',
|
||||||
|
|||||||
@ -0,0 +1,35 @@
|
|||||||
|
/**
|
||||||
|
* 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 { Migration } from '@nocobase/server';
|
||||||
|
|
||||||
|
export default class extends Migration {
|
||||||
|
on = 'beforeLoad'; // 'beforeLoad' or 'afterLoad'
|
||||||
|
|
||||||
|
async up() {
|
||||||
|
const existed = await this.pm.repository.findOne({
|
||||||
|
filter: {
|
||||||
|
packageName: '@nocobase/plugin-field-sort',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!existed) {
|
||||||
|
await this.pm.repository.create({
|
||||||
|
values: {
|
||||||
|
name: 'field-sort',
|
||||||
|
packageName: '@nocobase/plugin-field-sort',
|
||||||
|
version: this.appVersion,
|
||||||
|
enabled: true,
|
||||||
|
installed: true,
|
||||||
|
builtIn: true,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user