tachybase_todo/packages/presets/nocobase/src/server/index.ts
ChengLei Shao fa97d0a642
feat: application backup and restore (#3268)
* fix: perform load action on boot main app

* feat: add dataType option in collection duplicator

* chore: reset optional dumpable config

* chore: dump command

* chore: dump & restore command

* chore: delay restore

* fix: dump test

* chore: restore command

* chore: dump command action

* chore: dumpable collection api

* chore: client collection option

* feat: backup& restore client

* chore: content disposition header in dump response

* chore: download backup field

* feat: collection origin option

* fix: test

* chore: collection manager collection origin

* chore: upload  backup field

* chore: upload restore file

* chore: upload restore file

* fix: test

* chore: backup and restore support learn more

* refactor: upload restore file

* refactor: upload restore file

* fix: test

* fix: test

* chore: dumpable collection with title

* chore: pg only test

* chore: test

* fix: test

* chore: test sleep

* style: locale improve

* refactor: download backup file

* refactor: start restore

* fix: restore key name

* refactor: start restore

* refactor: start restore

* refactor: start restore

* refactor: start restore

* refactor: start restore

* refactor: start restore

* chore: unify duplicator option

* fix: dump empty collection

* chore: test

* chore: test

* style: style improve

* refactor: locale improve

* chore: dumpalbe collection orders

* style: style improve

* style: style improve

* style: icon adjust

* chore: nginx body size

* chore: get file status

* feat: run dump task

* feat: download api

* chore: backup files resourcer

* feat: restore destroy api

* chore: backup files resoucer

* feat: list backup files action

* chore: get collection meta from dumped file

* fix: dump file name

* fix: test

* chore: backup and restore ui

* chore: swagger api for backup & restore

* chore: api doc

* chore: api doc

* chore: api doc

* chore: backup and restore ui

* chore: backup and restore ui

* chore: backup and restore ui

* chore: backup and restore ui

* chore: backup and restore ui

* fix: restore values

* style: style improve

* fix: download field respontype

* fix: restore form local file

* refactor: local improve

* refactor: delete backup file

* fix: in progress status

* refactor: locale improve

* refactor: locale improve

* refactor: style improve

* refactor: style improve

* refactor: style improve

* test: dump collection table attribute

* chore: dump collection with table attributes

* chore: test

* chore: create new table in restore

* fix: import error

* chore: restore table from backup file

* chore: sync collection after restore collections

* fix: restore json data

* style: style improve

* chore: restore with fields

* chore: test

* fix: test

* fix: test with underscored

* style: style improve

* fix: lock file state

* chore: add test file

* refactor: backup & restore plugin

* fix: mysql test

* chore: skip import view collection

* chore: restore collection with inherits topo order

* fix: import

* style: style improve

* fix: restore sequence fields

* fix: themeConfig collection duplicator option

* fix: restore with dialectOnly meta

* fix: throw error

* fix: restore

* fix: import backup file created in postgres into mysql

* fix: repeated items in inherits

* chore: upgrade after restore

* feat: check database env before restore

* feat: handle autoincr val in postgres

* chore: sqlite & mysql queryInterface

* chore: test

* fix: test

* chore: test

* fix: build

* fix: pg test

* fix: restore with date field

* chore: theme-config collection

* chore: chage import collections method to support collection origin

* chore: fallback get autoincr value in mysql

* fix: dataType normalize

* chore: delay restore

* chore: test

* fix: build

* feat: collectin onDump

* feat: collection onDump interface

* chore: dump with view collection

* chore: sync in restore

* refactor: locale improve

* refactor: code improve

* fix: test

* fix: data sync

* chore: rename backup & restore plugin

* chore: skip test

* style: style improve

* style: style improve

* style: style improve

* style: style improve

* chore: import version check

* chore: backup file dir

* chore: build

* fix: bugs

* fix: error

* fix: pageSize

* fix: import origin

* fix: improve code

* fix: remove namespace

* chore: dump rules config

* fix: dump custom collection

* chore: version

* fix: test

* fix: test

* fix: test

* fix: test

* chore: test

* fix: load custom collection

* fix: client

* fix: translation

* chore: code

* fix: bug

* fix:  support shared option

* fix: roles collection dumpRules

* chore: test

* fix: define collections

* chore: collection group

* fix: translation

* fix: translation

* fix: restore options

* chore: restore command

* chore: dump error

* fix: too many open files

---------

Co-authored-by: katherinehhh <katherine_15995@163.com>
Co-authored-by: chenos <chenlinxh@gmail.com>
2024-01-08 18:59:56 +08:00

181 lines
5.4 KiB
TypeScript

import { Repository } from '@nocobase/database';
import { Plugin, PluginManager } from '@nocobase/server';
import _ from 'lodash';
import path from 'path';
export class PresetNocoBase extends Plugin {
builtInPlugins = [
'error-handler',
'collection-manager',
'ui-schema-storage',
// 'ui-routes-storage',
'file-manager',
'system-settings',
'sequence-field',
'verification',
'users',
'acl',
'china-region',
'workflow',
'workflow-aggregate',
'workflow-delay',
'workflow-dynamic-calculation',
'workflow-form-trigger',
'workflow-loop',
'workflow-manual',
'workflow-parallel',
'workflow-request',
'workflow-sql',
'client',
'export',
'import',
'backup-restore',
'iframe-block',
'formula-field',
'data-visualization',
'auth',
'sms-auth',
'logger',
'custom-request',
'calendar',
'action-bulk-update',
'action-bulk-edit',
'gantt',
'kanban',
'action-duplicate',
'action-print',
];
localPlugins = [
'audit-logs@0.7.1-alpha.4',
'sample-hello@0.8.0-alpha.4',
'multi-app-manager@0.7.0-alpha.1',
'multi-app-share-collection@0.9.2-alpha.1',
'oidc@0.9.2-alpha.1',
'saml@0.8.1-alpha.3',
'cas@0.13.0-alpha.5',
'map@0.8.1-alpha.3',
'snapshot-field@0.8.1-alpha.3',
'graph-collection-manager@0.9.0-alpha.1',
'mobile-client@0.10.0-alpha.2',
'api-keys@0.10.1-alpha.1',
'localization-management@0.11.1-alpha.1',
'theme-editor@0.11.1-alpha.1',
'api-doc@0.13.0-alpha.1',
];
splitNames(name: string) {
return (name || '').split(',').filter(Boolean);
}
getBuiltInPlugins() {
const { PRESET_NOCOBASE_PLUGINS, APPEND_PRESET_BUILT_IN_PLUGINS } = process.env;
return _.uniq(
this.splitNames(APPEND_PRESET_BUILT_IN_PLUGINS || PRESET_NOCOBASE_PLUGINS).concat(this.builtInPlugins),
);
}
getLocalPlugins() {
const { APPEND_PRESET_LOCAL_PLUGINS } = process.env;
const plugins = this.splitNames(APPEND_PRESET_LOCAL_PLUGINS)
.concat(this.localPlugins)
.map((name) => name.split('@'));
return plugins;
}
beforeLoad() {
this.db.addMigrations({
namespace: this.getName(),
directory: path.resolve(__dirname, './migrations'),
context: {
plugin: this,
},
});
this.app.on('beforeUpgrade', async () => {
await this.updateOrCreatePlugins();
});
}
async allPlugins() {
return (
await Promise.all(
this.getBuiltInPlugins().map(async (name) => {
const packageName = await PluginManager.getPackageName(name);
const packageJson = await PluginManager.getPackageJson(packageName);
return { name, packageName, enabled: true, builtIn: true, version: packageJson.version } as any;
}),
)
).concat(
await Promise.all(
this.getLocalPlugins().map(async (plugin) => {
const name = plugin[0];
const packageName = await PluginManager.getPackageName(name);
const packageJson = await PluginManager.getPackageJson(packageName);
return { name, packageName, version: packageJson.version };
}),
),
);
}
async getPluginToBeUpgraded() {
const repository = this.app.db.getRepository<any>('applicationPlugins');
const items = (await repository.find()).map((item) => item.name);
const plugins = await Promise.all(
this.getBuiltInPlugins().map(async (name) => {
const packageName = await PluginManager.getPackageName(name);
const packageJson = await PluginManager.getPackageJson(packageName);
return { name, packageName, enabled: true, builtIn: true, version: packageJson.version } as any;
}),
);
for (const plugin of this.getLocalPlugins()) {
if (plugin[1]) {
// 不在插件列表,并且插件最低版本小于当前应用版本,跳过不处理
if (!items.includes(plugin[0]) && (await this.app.version.satisfies(`>${plugin[1]}`))) {
continue;
}
}
const name = plugin[0];
const packageName = await PluginManager.getPackageName(name);
const packageJson = await PluginManager.getPackageJson(packageName);
plugins.push({ name, packageName, version: packageJson.version });
}
return plugins;
}
async updateOrCreatePlugins() {
const repository = this.app.db.getRepository<any>('applicationPlugins');
const plugins = await this.getPluginToBeUpgraded();
await this.db.sequelize.transaction((transaction) => {
return Promise.all(
plugins.map((values) =>
repository.updateOrCreate({
transaction,
values,
filterKeys: ['name'],
}),
),
);
});
await this.app.reload();
}
async createIfNotExists() {
const repository = this.app.db.getRepository<Repository>('applicationPlugins');
const existPlugins = await repository.find();
const existPluginNames = existPlugins.map((item) => item.name);
const plugins = (await this.allPlugins()).filter((item) => !existPluginNames.includes(item.name));
await repository.create({ values: plugins });
}
async install() {
const repository = this.db.getRepository<any>('applicationPlugins');
await this.createIfNotExists();
this.log.debug('install preset plugins');
await repository.init();
await this.app.pm.load();
await this.app.pm.install();
}
}
export default PresetNocoBase;