678b6cef21
* feat: update docs * fix: improve code
428 lines
10 KiB
TypeScript
428 lines
10 KiB
TypeScript
import { ACL } from '@nocobase/acl';
|
|
import { registerActions } from '@nocobase/actions';
|
|
import Database, { Collection, CollectionOptions, IDatabaseOptions } from '@nocobase/database';
|
|
import Resourcer, { ResourceOptions } from '@nocobase/resourcer';
|
|
import { applyMixins, AsyncEmitter } from '@nocobase/utils';
|
|
import { Command, CommandOptions, ParseOptions } from 'commander';
|
|
import { Server } from 'http';
|
|
import { i18n, InitOptions } from 'i18next';
|
|
import Koa, { DefaultContext as KoaDefaultContext, DefaultState as KoaDefaultState } from 'koa';
|
|
import { isBoolean } from 'lodash';
|
|
import semver from 'semver';
|
|
import { createACL } from './acl';
|
|
import { AppManager } from './app-manager';
|
|
import { registerCli } from './commands';
|
|
import { createI18n, createResourcer, registerMiddlewares } from './helper';
|
|
import { Plugin } from './plugin';
|
|
import { InstallOptions, PluginManager } from './plugin-manager';
|
|
|
|
const packageJson = require('../package.json');
|
|
|
|
export type PluginConfiguration = string | [string, any];
|
|
|
|
export interface ResourcerOptions {
|
|
prefix?: string;
|
|
}
|
|
|
|
export interface ApplicationOptions {
|
|
database?: IDatabaseOptions | Database;
|
|
resourcer?: ResourcerOptions;
|
|
bodyParser?: any;
|
|
cors?: any;
|
|
dataWrapping?: boolean;
|
|
registerActions?: boolean;
|
|
i18n?: i18n | InitOptions;
|
|
plugins?: PluginConfiguration[];
|
|
}
|
|
|
|
export interface DefaultState extends KoaDefaultState {
|
|
currentUser?: any;
|
|
[key: string]: any;
|
|
}
|
|
|
|
export interface DefaultContext extends KoaDefaultContext {
|
|
db: Database;
|
|
resourcer: Resourcer;
|
|
i18n: any;
|
|
[key: string]: any;
|
|
}
|
|
|
|
interface MiddlewareOptions {
|
|
name?: string;
|
|
resourceName?: string;
|
|
resourceNames?: string[];
|
|
insertBefore?: string;
|
|
insertAfter?: string;
|
|
}
|
|
|
|
interface ActionsOptions {
|
|
resourceName?: string;
|
|
resourceNames?: string[];
|
|
}
|
|
|
|
interface ListenOptions {
|
|
port?: number | undefined;
|
|
host?: string | undefined;
|
|
backlog?: number | undefined;
|
|
path?: string | undefined;
|
|
exclusive?: boolean | undefined;
|
|
readableAll?: boolean | undefined;
|
|
writableAll?: boolean | undefined;
|
|
/**
|
|
* @default false
|
|
*/
|
|
ipv6Only?: boolean | undefined;
|
|
signal?: AbortSignal | undefined;
|
|
}
|
|
|
|
interface StartOptions {
|
|
cliArgs?: any[];
|
|
listen?: ListenOptions;
|
|
}
|
|
|
|
export class ApplicationVersion {
|
|
protected app: Application;
|
|
protected collection: Collection;
|
|
|
|
constructor(app: Application) {
|
|
this.app = app;
|
|
if (!app.db.hasCollection('applicationVersion')) {
|
|
app.db.collection({
|
|
name: 'applicationVersion',
|
|
timestamps: false,
|
|
fields: [{ name: 'value', type: 'string' }],
|
|
});
|
|
}
|
|
this.collection = this.app.db.getCollection('applicationVersion');
|
|
}
|
|
|
|
async get() {
|
|
if (await this.app.db.collectionExistsInDb('applicationVersion')) {
|
|
const model = await this.collection.model.findOne();
|
|
return model.get('value') as any;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
async update() {
|
|
await this.collection.sync();
|
|
await this.collection.model.destroy({
|
|
truncate: true,
|
|
});
|
|
await this.collection.model.create({
|
|
value: this.app.getVersion(),
|
|
});
|
|
}
|
|
|
|
async satisfies(range: string) {
|
|
if (await this.app.db.collectionExistsInDb('applicationVersion')) {
|
|
const model: any = await this.collection.model.findOne();
|
|
const version = model?.value as any;
|
|
if (!version) {
|
|
return true;
|
|
}
|
|
return semver.satisfies(version, range, { includePrerelease: true });
|
|
}
|
|
return true;
|
|
}
|
|
}
|
|
|
|
export class Application<StateT = DefaultState, ContextT = DefaultContext> extends Koa implements AsyncEmitter {
|
|
protected _db: Database;
|
|
|
|
protected _resourcer: Resourcer;
|
|
|
|
protected _cli: Command;
|
|
|
|
protected _i18n: i18n;
|
|
|
|
protected _pm: PluginManager;
|
|
|
|
protected _acl: ACL;
|
|
|
|
protected _appManager: AppManager;
|
|
|
|
protected _version: ApplicationVersion;
|
|
|
|
protected plugins = new Map<string, Plugin>();
|
|
|
|
public listenServer: Server;
|
|
|
|
constructor(public options: ApplicationOptions) {
|
|
super();
|
|
this.init();
|
|
}
|
|
|
|
get db() {
|
|
return this._db;
|
|
}
|
|
|
|
get resourcer() {
|
|
return this._resourcer;
|
|
}
|
|
|
|
get cli() {
|
|
return this._cli;
|
|
}
|
|
|
|
get acl() {
|
|
return this._acl;
|
|
}
|
|
|
|
get i18n() {
|
|
return this._i18n;
|
|
}
|
|
|
|
get pm() {
|
|
return this._pm;
|
|
}
|
|
|
|
get version() {
|
|
return this._version;
|
|
}
|
|
|
|
get appManager() {
|
|
return this._appManager;
|
|
}
|
|
|
|
protected init() {
|
|
const options = this.options;
|
|
// @ts-ignore
|
|
this._events = [];
|
|
// @ts-ignore
|
|
this._eventsCount = [];
|
|
this.middleware = [];
|
|
// this.context = Object.create(context);
|
|
this.plugins = new Map<string, Plugin>();
|
|
this._acl = createACL();
|
|
this._db = this.createDatabase(options);
|
|
this._resourcer = createResourcer(options);
|
|
this._cli = new Command('nocobase').usage('[command] [options]');
|
|
this._i18n = createI18n(options);
|
|
this.context.db = this._db;
|
|
this.context.resourcer = this._resourcer;
|
|
|
|
this._pm = new PluginManager({
|
|
app: this,
|
|
});
|
|
|
|
this._appManager = new AppManager(this);
|
|
|
|
registerMiddlewares(this, options);
|
|
|
|
if (options.registerActions !== false) {
|
|
registerActions(this);
|
|
}
|
|
|
|
this.loadPluginConfig(options.plugins || []);
|
|
|
|
registerCli(this);
|
|
|
|
this._version = new ApplicationVersion(this);
|
|
}
|
|
|
|
private createDatabase(options: ApplicationOptions) {
|
|
if (options.database instanceof Database) {
|
|
return options.database;
|
|
} else {
|
|
return new Database({
|
|
...options.database,
|
|
migrator: {
|
|
context: { app: this },
|
|
},
|
|
});
|
|
}
|
|
}
|
|
|
|
getVersion() {
|
|
return packageJson.version;
|
|
}
|
|
|
|
plugin<O = any>(pluginClass: any, options?: O): Plugin<O> {
|
|
return this.pm.add(pluginClass, options);
|
|
}
|
|
|
|
loadPluginConfig(pluginsConfigurations: PluginConfiguration[]) {
|
|
for (let pluginConfiguration of pluginsConfigurations) {
|
|
if (typeof pluginConfiguration == 'string') {
|
|
pluginConfiguration = [pluginConfiguration, {}];
|
|
}
|
|
|
|
const plugin = PluginManager.resolvePlugin(pluginConfiguration[0]);
|
|
const pluginOptions = pluginConfiguration[1];
|
|
|
|
this.plugin(plugin, pluginOptions);
|
|
}
|
|
}
|
|
|
|
use<NewStateT = {}, NewContextT = {}>(
|
|
middleware: Koa.Middleware<StateT & NewStateT, ContextT & NewContextT>,
|
|
options?: MiddlewareOptions,
|
|
) {
|
|
// @ts-ignore
|
|
return super.use(middleware);
|
|
}
|
|
|
|
collection(options: CollectionOptions) {
|
|
return this.db.collection(options);
|
|
}
|
|
|
|
resource(options: ResourceOptions) {
|
|
return this.resourcer.define(options);
|
|
}
|
|
|
|
actions(handlers: any, options?: ActionsOptions) {
|
|
return this.resourcer.registerActions(handlers);
|
|
}
|
|
|
|
command(name: string, desc?: string, opts?: CommandOptions): Command {
|
|
return this.cli.command(name, desc, opts).allowUnknownOption();
|
|
}
|
|
|
|
findCommand(name: string): Command {
|
|
return (<any>this.cli)._findCommand(name);
|
|
}
|
|
|
|
async load() {
|
|
await this.pm.load();
|
|
}
|
|
|
|
async reload() {
|
|
this.init();
|
|
await this.pm.load();
|
|
}
|
|
|
|
getPlugin<P extends Plugin>(name: string) {
|
|
return this.pm.get(name) as P;
|
|
}
|
|
|
|
async parse(argv = process.argv) {
|
|
return this.runAsCLI(argv);
|
|
}
|
|
|
|
async runAsCLI(argv = process.argv, options?: ParseOptions) {
|
|
if (argv?.[2] !== 'install') {
|
|
await this.load();
|
|
}
|
|
return this.cli.parseAsync(argv, options);
|
|
}
|
|
|
|
async start(options: StartOptions = {}) {
|
|
// reconnect database
|
|
if (this.db.closed()) {
|
|
await this.db.reconnect();
|
|
}
|
|
|
|
await this.emitAsync('beforeStart', this, options);
|
|
|
|
if (options?.listen?.port) {
|
|
const listen = () =>
|
|
new Promise((resolve, reject) => {
|
|
const Server = this.listen(options?.listen, () => {
|
|
resolve(Server);
|
|
});
|
|
|
|
Server.on('error', (err) => {
|
|
reject(err);
|
|
});
|
|
});
|
|
|
|
try {
|
|
//@ts-ignore
|
|
this.listenServer = await listen();
|
|
} catch (e) {
|
|
console.error(e);
|
|
process.exit(1);
|
|
}
|
|
}
|
|
|
|
await this.emitAsync('afterStart', this, options);
|
|
}
|
|
|
|
listen(...args): Server {
|
|
return this.appManager.listen(...args);
|
|
}
|
|
|
|
async stop(options: any = {}) {
|
|
await this.emitAsync('beforeStop', this, options);
|
|
|
|
try {
|
|
// close database connection
|
|
// silent if database already closed
|
|
await this.db.close();
|
|
} catch (e) {
|
|
console.log(e);
|
|
}
|
|
|
|
// close http server
|
|
if (this.listenServer) {
|
|
const closeServer = () =>
|
|
new Promise((resolve, reject) => {
|
|
this.listenServer.close((err) => {
|
|
if (err) {
|
|
return reject(err);
|
|
}
|
|
this.listenServer = null;
|
|
resolve(true);
|
|
});
|
|
});
|
|
|
|
await closeServer();
|
|
}
|
|
|
|
await this.emitAsync('afterStop', this, options);
|
|
}
|
|
|
|
async destroy(options: any = {}) {
|
|
await this.emitAsync('beforeDestroy', this, options);
|
|
await this.stop(options);
|
|
await this.emitAsync('afterDestroy', this, options);
|
|
}
|
|
|
|
async install(options: InstallOptions = {}) {
|
|
const r = await this.db.version.satisfies({
|
|
mysql: '>=8.0.17',
|
|
sqlite: '3.x',
|
|
postgres: '>=10',
|
|
});
|
|
|
|
if (!r) {
|
|
console.log('The database only supports MySQL 8.0.17 and above, SQLite 3.x and PostgreSQL 10+');
|
|
return;
|
|
}
|
|
|
|
if (options?.clean) {
|
|
await this.db.clean(isBoolean(options.clean) ? { drop: options.clean } : options.clean);
|
|
}
|
|
|
|
await this.emitAsync('beforeInstall', this, options);
|
|
|
|
await this.load();
|
|
await this.db.sync(options?.sync);
|
|
await this.pm.install(options);
|
|
await this.version.update();
|
|
|
|
await this.emitAsync('afterInstall', this, options);
|
|
}
|
|
|
|
async upgrade(options: any = {}) {
|
|
await this.emitAsync('beforeUpgrade', this, options);
|
|
const force = false;
|
|
await this.db.migrator.up();
|
|
await this.db.sync({
|
|
force,
|
|
alter: {
|
|
drop: force,
|
|
},
|
|
});
|
|
await this.version.update();
|
|
await this.emitAsync('afterUpgrade', this, options);
|
|
}
|
|
|
|
declare emitAsync: (event: string | symbol, ...args: any[]) => Promise<boolean>;
|
|
}
|
|
|
|
applyMixins(Application, [AsyncEmitter]);
|
|
|
|
export default Application;
|