@nocobase/plugin-multi-app-manager 0.9.0-alpha.2 → 0.9.1-alpha.2

package/README.md

@@ -0,0 +1,13 @@
+# multi-app-manager
+
+English | [中文](./README.zh-CN.md)
+
+多应用管理插件。
+
+## 安装激活
+
+```bash
+yarn pm enable multi-app-manager
+```
+
+## 使用方法

package/README.zh-CN.md

@@ -0,0 +1,13 @@
+# multi-app-manager
+
+[English](./README.md) | 中文
+
+多应用管理插件。
+
+## 安装激活
+
+```bash
+yarn pm enable multi-app-manager
+```
+
+## 使用方法

package/lib/collections/applications.js

@@ -16,6 +16,8 @@ function _database() {
 }
 
 var _default = (0, _database().defineCollection)({
+  namespace: 'multi-app-manager',
+  duplicator: 'optional',
   name: 'applications',
   model: 'ApplicationModel',
   autoGenId: false,

package/lib/models/application.d.ts

@@ -1,52 +1,12 @@
-import { IDatabaseOptions, Model, Transactionable } from '@nocobase/database';
+import { Model, Transactionable } from '@nocobase/database';
 import { Application } from '@nocobase/server';
+import { AppDbCreator, AppOptionsFactory } from '../server';
 export interface registerAppOptions extends Transactionable {
     skipInstall?: boolean;
+    dbCreator: AppDbCreator;
+    appOptionsFactory: AppOptionsFactory;
 }
 export declare class ApplicationModel extends Model {
-    static getDatabaseConfig(app: Application): IDatabaseOptions;
-    static handleAppStart(app: Application, options: registerAppOptions): Promise<void>;
+    static handleAppStart(mainApp: Application, app: Application, options: registerAppOptions): Promise<void>;
     registerToMainApp(mainApp: Application, options: registerAppOptions): Promise<void>;
-    static initOptions(appName: string, mainApp: Application): {
-        database: {
-            tablePrefix: string;
-            migrator?: any;
-            usingBigIntForId?: boolean;
-            dialect?: import("sequelize").Dialect;
-            dialectModule?: object;
-            dialectModulePath?: string;
-            dialectOptions?: object;
-            storage?: string;
-            database?: string;
-            username?: string;
-            password?: string;
-            host?: string;
-            port?: number;
-            ssl?: boolean;
-            protocol?: string;
-            define?: import("sequelize").ModelOptions<import("sequelize").Model<any, any>>;
-            query?: import("sequelize").QueryOptions;
-            set?: import("sequelize").DefaultSetOptions;
-            sync?: import("@nocobase/database").SyncOptions;
-            timezone?: string;
-            omitNull?: boolean;
-            native?: boolean;
-            replication?: false | import("sequelize").ReplicationOptions;
-            pool?: import("sequelize").PoolOptions;
-            quoteIdentifiers?: boolean;
-            isolationLevel?: string;
-            transactionType?: import("sequelize").Transaction.TYPES;
-            typeValidation?: boolean;
-            operatorsAliases?: import("sequelize").OperatorsAliases;
-            standardConformingStrings?: boolean;
-            clientMinMessages?: string | boolean;
-            hooks?: Partial<import("sequelize/types/hooks").SequelizeHooks<import("sequelize").Model<any, any>, any, any>>;
-            minifyAliases?: boolean;
-            logQueryParameters?: boolean;
-            retry?: import("sequelize").RetryOptions;
-            schema?: string;
-            logging?: boolean | ((sql: string, timing?: number) => void);
-            benchmark?: boolean;
-        };
-    };
 }

package/lib/models/application.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.ApplicationModel = void 0;
 
 function _database() {
-  const data = _interopRequireWildcard(require("@nocobase/database"));
+  const data = require("@nocobase/database");
 
   _database = function _database() {
     return data;
@@ -15,32 +15,6 @@ function _database() {
   return data;
 }
 
-function _lodash() {
-  const data = _interopRequireDefault(require("lodash"));
-
-  _lodash = function _lodash() {
-    return data;
-  };
-
-  return data;
-}
-
-function path() {
-  const data = _interopRequireWildcard(require("path"));
-
-  path = function path() {
-    return data;
-  };
-
-  return data;
-}
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -52,17 +26,23 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 
 class ApplicationModel extends _database().Model {
-  static getDatabaseConfig(app) {
-    const oldConfig = app.options.database instanceof _database().default ? app.options.database.options : app.options.database;
-    return _lodash().default.cloneDeep(_lodash().default.omit(oldConfig, ['migrator']));
-  }
-
-  static handleAppStart(app, options) {
+  static handleAppStart(mainApp, app, options) {
     return _asyncToGenerator(function* () {
+      yield mainApp.emitAsync('beforeSubAppLoad', {
+        mainApp,
+        subApp: app
+      });
       yield app.load();
 
-      if (!(options === null || options === void 0 ? void 0 : options.skipInstall)) {
-        yield app.install();
+      if (!(yield app.isInstalled())) {
+        yield app.db.sync();
+        yield app.install(); // emit an event on mainApp
+        // current if you add listener on subApp through `subApp.on('afterInstall')` , it will be clear after subApp installed
+
+        yield mainApp.emitAsync('afterSubAppInstalled', {
+          mainApp,
+          subApp: app
+        });
       }
 
       yield app.start();
@@ -77,62 +57,26 @@ class ApplicationModel extends _database().Model {
 
       const appOptions = _this.get('options') || {};
       const AppModel = _this.constructor;
-
-      const createDatabase = /*#__PURE__*/function () {
-        var _ref = _asyncToGenerator(function* () {
-          const database = appName;
-          const _mainApp$db$options = mainApp.db.options,
-                host = _mainApp$db$options.host,
-                port = _mainApp$db$options.port,
-                username = _mainApp$db$options.username,
-                password = _mainApp$db$options.password,
-                dialect = _mainApp$db$options.dialect;
-
-          if (dialect === 'mysql') {
-            const mysql = require('mysql2/promise');
-
-            const connection = yield mysql.createConnection({
-              host,
-              port,
-              user: username,
-              password
-            });
-            yield connection.query(`CREATE DATABASE IF NOT EXISTS \`${database}\`;`);
-            yield connection.close();
+      const app = mainApp.appManager.createApplication(appName, _objectSpread(_objectSpread(_objectSpread({}, options.appOptionsFactory(appName, mainApp)), appOptions), {}, {
+        name: appName
+      }));
+      const isInstalled = yield _asyncToGenerator(function* () {
+        try {
+          return yield app.isInstalled();
+        } catch (e) {
+          if (e.message.includes('does not exist') || e.message.includes('Unknown database')) {
+            return false;
           }
 
-          if (dialect === 'postgres') {
-            const _require = require('pg'),
-                  Client = _require.Client;
-
-            const client = new Client({
-              host,
-              port,
-              user: username,
-              password,
-              database: 'postgres'
-            });
-            yield client.connect();
+          throw e;
+        }
+      })();
 
-            try {
-              yield client.query(`CREATE DATABASE "${database}"`);
-            } catch (e) {}
-
-            yield client.end();
-          }
-        });
-
-        return function createDatabase() {
-          return _ref.apply(this, arguments);
-        };
-      }();
-
-      if (!(options === null || options === void 0 ? void 0 : options.skipInstall)) {
-        yield createDatabase();
+      if (!isInstalled) {
+        yield options.dbCreator(app);
       }
 
-      const app = mainApp.appManager.createApplication(appName, _objectSpread(_objectSpread({}, AppModel.initOptions(appName, mainApp)), appOptions));
-      yield AppModel.handleAppStart(app, options);
+      yield AppModel.handleAppStart(mainApp, app, options);
       yield AppModel.update({
         status: 'running'
       }, {
@@ -145,27 +89,6 @@ class ApplicationModel extends _database().Model {
     })();
   }
 
-  static initOptions(appName, mainApp) {
-    const rawDatabaseOptions = this.getDatabaseConfig(mainApp);
-
-    if (rawDatabaseOptions.dialect === 'sqlite') {
-      const mainAppStorage = rawDatabaseOptions.storage;
-
-      if (mainAppStorage !== ':memory:') {
-        const mainStorageDir = path().dirname(mainAppStorage);
-        rawDatabaseOptions.storage = path().join(mainStorageDir, `${appName}.sqlite`);
-      }
-    } else {
-      rawDatabaseOptions.database = appName;
-    }
-
-    return {
-      database: _objectSpread(_objectSpread({}, rawDatabaseOptions), {}, {
-        tablePrefix: ''
-      })
-    };
-  }
-
 }
 
 exports.ApplicationModel = ApplicationModel;

package/lib/server.d.ts

@@ -1,5 +1,14 @@
-import { InstallOptions, Plugin } from '@nocobase/server';
+import Application, { InstallOptions, Plugin } from '@nocobase/server';
+import { IDatabaseOptions } from '@nocobase/database';
+export declare type AppDbCreator = (app: Application) => Promise<void>;
+export declare type AppOptionsFactory = (appName: string, mainApp: Application) => any;
 export declare class PluginMultiAppManager extends Plugin {
+    appDbCreator: AppDbCreator;
+    appOptionsFactory: AppOptionsFactory;
+    setAppOptionsFactory(factory: AppOptionsFactory): void;
+    setAppDbCreator(appDbCreator: AppDbCreator): void;
+    static getDatabaseConfig(app: Application): IDatabaseOptions;
     install(options?: InstallOptions): Promise<void>;
+    beforeLoad(): void;
     load(): Promise<void>;
 }

package/lib/server.js

@@ -15,10 +15,10 @@ function _server() {
   return data;
 }
 
-function _path() {
-  const data = require("path");
+function path() {
+  const data = _interopRequireWildcard(require("path"));
 
-  _path = function _path() {
+  path = function path() {
     return data;
   };
 
@@ -27,11 +27,136 @@ function _path() {
 
 var _application = require("./models/application");
 
+function _database() {
+  const data = _interopRequireDefault(require("@nocobase/database"));
+
+  _database = function _database() {
+    return data;
+  };
+
+  return data;
+}
+
+function _lodash() {
+  const data = _interopRequireDefault(require("lodash"));
+
+  _lodash = function _lodash() {
+    return data;
+  };
+
+  return data;
+}
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 
+const defaultDbCreator = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(function* (app) {
+    const databaseOptions = app.options.database;
+    const host = databaseOptions.host,
+          port = databaseOptions.port,
+          username = databaseOptions.username,
+          password = databaseOptions.password,
+          dialect = databaseOptions.dialect,
+          database = databaseOptions.database;
+
+    if (dialect === 'mysql') {
+      const mysql = require('mysql2/promise');
+
+      const connection = yield mysql.createConnection({
+        host,
+        port,
+        user: username,
+        password
+      });
+      yield connection.query(`CREATE DATABASE IF NOT EXISTS \`${database}\`;`);
+      yield connection.close();
+    }
+
+    if (dialect === 'postgres') {
+      const _require = require('pg'),
+            Client = _require.Client;
+
+      const client = new Client({
+        host,
+        port,
+        user: username,
+        password,
+        database: 'postgres'
+      });
+      yield client.connect();
+
+      try {
+        yield client.query(`CREATE DATABASE "${database}"`);
+      } catch (e) {}
+
+      yield client.end();
+    }
+  });
+
+  return function defaultDbCreator(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+const defaultAppOptionsFactory = (appName, mainApp) => {
+  const rawDatabaseOptions = PluginMultiAppManager.getDatabaseConfig(mainApp);
+
+  if (rawDatabaseOptions.dialect === 'sqlite') {
+    const mainAppStorage = rawDatabaseOptions.storage;
+
+    if (mainAppStorage !== ':memory:') {
+      const mainStorageDir = path().dirname(mainAppStorage);
+      rawDatabaseOptions.storage = path().join(mainStorageDir, `${appName}.sqlite`);
+    }
+  } else {
+    rawDatabaseOptions.database = appName;
+  }
+
+  return {
+    database: _objectSpread(_objectSpread({}, rawDatabaseOptions), {}, {
+      tablePrefix: ''
+    }),
+    plugins: ['nocobase'],
+    resourcer: {
+      prefix: '/api'
+    }
+  };
+};
+
 class PluginMultiAppManager extends _server().Plugin {
+  constructor(...args) {
+    super(...args);
+    this.appDbCreator = defaultDbCreator;
+    this.appOptionsFactory = defaultAppOptionsFactory;
+  }
+
+  setAppOptionsFactory(factory) {
+    this.appOptionsFactory = factory;
+  }
+
+  setAppDbCreator(appDbCreator) {
+    this.appDbCreator = appDbCreator;
+  }
+
+  static getDatabaseConfig(app) {
+    const oldConfig = app.options.database instanceof _database().default ? app.options.database.options : app.options.database;
+    return _lodash().default.cloneDeep(_lodash().default.omit(oldConfig, ['migrator']));
+  }
+
   install(options) {
     var _this = this;
 
@@ -44,6 +169,12 @@ class PluginMultiAppManager extends _server().Plugin {
     })();
   }
 
+  beforeLoad() {
+    this.app.appManager.setAppSelector(req => {
+      return req.headers['x-app'] || null;
+    });
+  }
+
   load() {
     var _this2 = this;
 
@@ -53,57 +184,58 @@ class PluginMultiAppManager extends _server().Plugin {
       });
 
       yield _this2.db.import({
-        directory: (0, _path().resolve)(__dirname, 'collections')
+        directory: (0, path().resolve)(__dirname, 'collections')
       });
 
       _this2.db.on('applications.afterCreateWithAssociations', /*#__PURE__*/function () {
-        var _ref = _asyncToGenerator(function* (model, options) {
+        var _ref2 = _asyncToGenerator(function* (model, options) {
           const transaction = options.transaction;
           yield model.registerToMainApp(_this2.app, {
-            transaction
+            transaction,
+            dbCreator: _this2.appDbCreator,
+            appOptionsFactory: _this2.appOptionsFactory
           });
         });
 
-        return function (_x, _x2) {
-          return _ref.apply(this, arguments);
+        return function (_x2, _x3) {
+          return _ref2.apply(this, arguments);
         };
       }());
 
       _this2.db.on('applications.afterDestroy', /*#__PURE__*/function () {
-        var _ref2 = _asyncToGenerator(function* (model) {
+        var _ref3 = _asyncToGenerator(function* (model) {
           yield _this2.app.appManager.removeApplication(model.get('name'));
         });
 
-        return function (_x3) {
-          return _ref2.apply(this, arguments);
+        return function (_x4) {
+          return _ref3.apply(this, arguments);
         };
       }());
 
       _this2.app.appManager.on('beforeGetApplication', /*#__PURE__*/function () {
-        var _lazyLoadApplication = _asyncToGenerator(function* ({
+        var _ref4 = _asyncToGenerator(function* ({
           appManager,
           name
         }) {
           if (!appManager.applications.has(name)) {
-            const existsApplication = yield this.app.db.getRepository('applications').findOne({
+            const existsApplication = yield _this2.app.db.getRepository('applications').findOne({
               filter: {
                 name
               }
             });
 
             if (existsApplication) {
-              yield existsApplication.registerToMainApp(this.app, {
-                skipInstall: true
+              yield existsApplication.registerToMainApp(_this2.app, {
+                dbCreator: _this2.appDbCreator,
+                appOptionsFactory: _this2.appOptionsFactory
               });
             }
           }
         });
 
-        function lazyLoadApplication(_x4) {
-          return _lazyLoadApplication.apply(this, arguments);
-        }
-
-        return lazyLoadApplication;
+        return function (_x5) {
+          return _ref4.apply(this, arguments);
+        };
       }());
 
       _this2.app.acl.registerSnippet({

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@nocobase/plugin-multi-app-manager",
-  "version": "0.9.0-alpha.2",
+  "version": "0.9.1-alpha.2",
   "description": "",
   "license": "AGPL-3.0",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@nocobase/server": "0.9.0-alpha.2"
+    "@nocobase/server": "0.9.1-alpha.2"
   },
-  "gitHead": "b8f76ad38e60e677c5bb4aab0a4cdb28d98a0f49"
+  "gitHead": "d588a68eca4feed4642a4cb317301011266fe5c9"
 }