@nocobase/server 0.7.6-alpha.2 → 0.8.0-alpha.4

package/lib/plugin-manager/PluginManager.js

@@ -0,0 +1,669 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.PluginManager = void 0;
+
+function _utils() {
+  const data = require("@nocobase/utils");
+
+  _utils = function _utils() {
+    return data;
+  };
+
+  return data;
+}
+
+function _execa() {
+  const data = _interopRequireDefault(require("execa"));
+
+  _execa = function _execa() {
+    return data;
+  };
+
+  return data;
+}
+
+function _fs() {
+  const data = _interopRequireDefault(require("fs"));
+
+  _fs = function _fs() {
+    return data;
+  };
+
+  return data;
+}
+
+function _net() {
+  const data = _interopRequireDefault(require("net"));
+
+  _net = function _net() {
+    return data;
+  };
+
+  return data;
+}
+
+function _path() {
+  const data = require("path");
+
+  _path = function _path() {
+    return data;
+  };
+
+  return data;
+}
+
+function _xpipe() {
+  const data = _interopRequireDefault(require("xpipe"));
+
+  _xpipe = function _xpipe() {
+    return data;
+  };
+
+  return data;
+}
+
+var _collection = _interopRequireDefault(require("./options/collection"));
+
+var _resource = _interopRequireDefault(require("./options/resource"));
+
+var _PluginManagerRepository = require("./PluginManagerRepository");
+
+const _excluded = ["enabled", "builtIn", "installed"];
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+
+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 _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+
+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); }); }; }
+
+class PluginManager {
+  constructor(options) {
+    var _this = this;
+
+    this.app = void 0;
+    this.collection = void 0;
+    this.repository = void 0;
+    this.plugins = new Map();
+    this.server = void 0;
+    this.pmSock = void 0;
+    this._tmpPluginArgs = [];
+    this.app = options.app;
+    const f = (0, _path().resolve)(process.cwd(), 'storage', 'pm.sock');
+    this.pmSock = _xpipe().default.eq(this.app.options.pmSock || f);
+    this.app.db.registerRepositories({
+      PluginManagerRepository: _PluginManagerRepository.PluginManagerRepository
+    });
+    this.collection = this.app.db.collection(_collection.default);
+    this.repository = this.collection.repository;
+    this.repository.setPluginManager(this);
+    this.app.resourcer.define(_resource.default);
+    this.app.acl.use( /*#__PURE__*/function () {
+      var _ref = _asyncToGenerator(function* (ctx, next) {
+        if (ctx.action.resourceName === 'pm') {
+          ctx.permission = {
+            skip: true
+          };
+        }
+
+        yield next();
+      });
+
+      return function (_x, _x2) {
+        return _ref.apply(this, arguments);
+      };
+    }());
+    this.server = _net().default.createServer(socket => {
+      socket.on('data', /*#__PURE__*/function () {
+        var _ref2 = _asyncToGenerator(function* (data) {
+          const _JSON$parse = JSON.parse(data.toString()),
+                method = _JSON$parse.method,
+                plugins = _JSON$parse.plugins;
+
+          try {
+            console.log(method, plugins);
+            yield _this[method](plugins);
+          } catch (error) {
+            console.error(error.message);
+          }
+        });
+
+        return function (_x3) {
+          return _ref2.apply(this, arguments);
+        };
+      }());
+      socket.pipe(socket);
+    });
+    this.app.on('beforeLoad', /*#__PURE__*/function () {
+      var _ref3 = _asyncToGenerator(function* (app, options) {
+        if ((options === null || options === void 0 ? void 0 : options.method) && ['install', 'upgrade'].includes(options.method)) {
+          yield _this.collection.sync();
+        }
+
+        const exists = yield _this.app.db.collectionExistsInDb('applicationPlugins');
+
+        if (!exists) {
+          return;
+        }
+
+        if ((options === null || options === void 0 ? void 0 : options.method) !== 'install' || options.reload) {
+          yield _this.repository.load();
+        }
+      });
+
+      return function (_x4, _x5) {
+        return _ref3.apply(this, arguments);
+      };
+    }());
+    this.addStaticMultiple(options.plugins);
+  }
+
+  addStaticMultiple(plugins) {
+    var _iterator = _createForOfIteratorHelper(plugins || []),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        let plugin = _step.value;
+
+        if (typeof plugin == 'string') {
+          this.addStatic(plugin);
+        } else {
+          this.addStatic(...plugin);
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+
+  getPlugins() {
+    return this.plugins;
+  }
+
+  get(name) {
+    return this.plugins.get(name);
+  }
+
+  clientWrite(data) {
+    var _this2 = this;
+
+    const method = data.method,
+          plugins = data.plugins;
+
+    if (method === 'create') {
+      try {
+        console.log(method, plugins);
+        this[method](plugins);
+      } catch (error) {
+        console.error(error.message);
+      }
+
+      return;
+    }
+
+    const client = new (_net().default.Socket)();
+    client.connect(this.pmSock, () => {
+      client.write(JSON.stringify(data));
+      client.end();
+    });
+    client.on('error', /*#__PURE__*/_asyncToGenerator(function* () {
+      try {
+        console.log(method, plugins);
+        yield _this2[method](plugins);
+      } catch (error) {
+        console.error(error.message);
+      }
+    }));
+  }
+
+  listen() {
+    var _this3 = this;
+
+    return _asyncToGenerator(function* () {
+      if (_fs().default.existsSync(_this3.pmSock)) {
+        yield _fs().default.promises.unlink(_this3.pmSock);
+      }
+
+      return new Promise(resolve => {
+        _this3.server.listen(_this3.pmSock, () => {
+          resolve(_this3.server);
+        });
+      });
+    })();
+  }
+
+  create(name) {
+    return _asyncToGenerator(function* () {
+      console.log('creating...');
+      const pluginNames = Array.isArray(name) ? name : [name];
+
+      const _require = require('@nocobase/cli/src/util'),
+            run = _require.run;
+
+      const createPlugin = /*#__PURE__*/function () {
+        var _ref5 = _asyncToGenerator(function* (name) {
+          const _require2 = require('@nocobase/cli/src/plugin-generator'),
+                PluginGenerator = _require2.PluginGenerator;
+
+          const generator = new PluginGenerator({
+            cwd: (0, _path().resolve)(process.cwd(), name),
+            args: {},
+            context: {
+              name
+            }
+          });
+          yield generator.run();
+        });
+
+        return function createPlugin(_x6) {
+          return _ref5.apply(this, arguments);
+        };
+      }();
+
+      yield Promise.all(pluginNames.map(pluginName => createPlugin(pluginName)));
+      yield run('yarn', ['install']);
+    })();
+  }
+
+  clone() {
+    const pm = new PluginManager({
+      app: this.app
+    });
+
+    var _iterator2 = _createForOfIteratorHelper(this._tmpPluginArgs),
+        _step2;
+
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        const arg = _step2.value;
+        pm.addStatic(...arg);
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
+
+    return pm;
+  }
+
+  addStatic(plugin, options) {
+    if (!(options === null || options === void 0 ? void 0 : options.async)) {
+      this._tmpPluginArgs.push([plugin, options]);
+    }
+
+    let name;
+
+    if (typeof plugin === 'string') {
+      name = plugin;
+      plugin = PluginManager.resolvePlugin(plugin);
+    } else {
+      name = plugin.name;
+
+      if (!name) {
+        throw new Error(`plugin name invalid`);
+      }
+    }
+
+    const instance = new plugin(this.app, _objectSpread({
+      name,
+      enabled: true
+    }, options));
+    const pluginName = instance.getName();
+
+    if (this.plugins.has(pluginName)) {
+      throw new Error(`plugin name [${pluginName}] exists`);
+    }
+
+    this.plugins.set(pluginName, instance);
+    return instance;
+  }
+
+  add(plugin, options = {}) {
+    var _this4 = this;
+
+    return _asyncToGenerator(function* () {
+      if (Array.isArray(plugin)) {
+        return Promise.all(plugin.map(p => _this4.add(p, options)));
+      } // console.log(`adding ${plugin} plugin`);
+
+
+      const packageName = yield PluginManager.findPackage(plugin);
+
+      const packageJson = require(`${packageName}/package.json`);
+
+      const instance = _this4.addStatic(plugin, _objectSpread(_objectSpread({}, options), {}, {
+        async: true
+      }));
+
+      let model = yield _this4.repository.findOne({
+        filter: {
+          name: plugin
+        }
+      });
+
+      if (model) {
+        throw new Error(`${plugin} plugin already exists`);
+      }
+
+      const enabled = options.enabled,
+            builtIn = options.builtIn,
+            installed = options.installed,
+            others = _objectWithoutProperties(options, _excluded);
+
+      yield _this4.repository.create({
+        values: {
+          name: plugin,
+          version: packageJson.version,
+          enabled: !!enabled,
+          builtIn: !!builtIn,
+          installed: !!installed,
+          options: _objectSpread({}, others)
+        }
+      });
+      const file = (0, _path().resolve)(process.cwd(), 'packages', process.env.APP_PACKAGE_ROOT || 'app', 'client/src/plugins', `${plugin}.ts`);
+
+      if (!_fs().default.existsSync(file)) {
+        try {
+          require.resolve(`${packageName}/client`);
+
+          yield _fs().default.promises.writeFile(file, `export { default } from '${packageName}/client';`);
+
+          const _require3 = require('@nocobase/cli/src/util'),
+                run = _require3.run;
+
+          yield run('yarn', ['nocobase', 'postinstall']);
+        } catch (error) {}
+      }
+
+      return instance;
+    })();
+  }
+
+  load(options = {}) {
+    var _this5 = this;
+
+    return _asyncToGenerator(function* () {
+      var _iterator3 = _createForOfIteratorHelper(_this5.plugins),
+          _step3;
+
+      try {
+        for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+          const _step3$value = _slicedToArray(_step3.value, 2),
+                name = _step3$value[0],
+                plugin = _step3$value[1];
+
+          if (!plugin.enabled) {
+            continue;
+          }
+
+          yield plugin.beforeLoad();
+        }
+      } catch (err) {
+        _iterator3.e(err);
+      } finally {
+        _iterator3.f();
+      }
+
+      var _iterator4 = _createForOfIteratorHelper(_this5.plugins),
+          _step4;
+
+      try {
+        for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+          const _step4$value = _slicedToArray(_step4.value, 2),
+                name = _step4$value[0],
+                plugin = _step4$value[1];
+
+          if (!plugin.enabled) {
+            continue;
+          }
+
+          yield _this5.app.emitAsync('beforeLoadPlugin', plugin, options);
+          yield plugin.load();
+          yield _this5.app.emitAsync('afterLoadPlugin', plugin, options);
+        }
+      } catch (err) {
+        _iterator4.e(err);
+      } finally {
+        _iterator4.f();
+      }
+    })();
+  }
+
+  install(options = {}) {
+    var _this6 = this;
+
+    return _asyncToGenerator(function* () {
+      var _iterator5 = _createForOfIteratorHelper(_this6.plugins),
+          _step5;
+
+      try {
+        for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
+          const _step5$value = _slicedToArray(_step5.value, 2),
+                name = _step5$value[0],
+                plugin = _step5$value[1];
+
+          if (!plugin.enabled) {
+            continue;
+          }
+
+          yield _this6.app.emitAsync('beforeInstallPlugin', plugin, options);
+          yield plugin.install(options);
+          yield _this6.app.emitAsync('afterInstallPlugin', plugin, options);
+        }
+      } catch (err) {
+        _iterator5.e(err);
+      } finally {
+        _iterator5.f();
+      }
+    })();
+  }
+
+  enable(name) {
+    var _this7 = this;
+
+    return _asyncToGenerator(function* () {
+      try {
+        const pluginNames = yield _this7.repository.enable(name);
+        yield _this7.app.reload();
+        yield _this7.app.db.sync();
+
+        var _iterator6 = _createForOfIteratorHelper(pluginNames),
+            _step6;
+
+        try {
+          for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+            const pluginName = _step6.value;
+
+            const plugin = _this7.app.getPlugin(pluginName);
+
+            if (!plugin) {
+              throw new Error(`${name} plugin does not exist`);
+            }
+
+            yield plugin.install();
+            yield plugin.afterEnable();
+          }
+        } catch (err) {
+          _iterator6.e(err);
+        } finally {
+          _iterator6.f();
+        }
+      } catch (error) {
+        throw error;
+      }
+    })();
+  }
+
+  disable(name) {
+    var _this8 = this;
+
+    return _asyncToGenerator(function* () {
+      try {
+        const pluginNames = yield _this8.repository.disable(name);
+        yield _this8.app.reload();
+
+        var _iterator7 = _createForOfIteratorHelper(pluginNames),
+            _step7;
+
+        try {
+          for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
+            const pluginName = _step7.value;
+
+            const plugin = _this8.app.getPlugin(pluginName);
+
+            if (!plugin) {
+              throw new Error(`${name} plugin does not exist`);
+            }
+
+            yield plugin.afterDisable();
+          }
+        } catch (err) {
+          _iterator7.e(err);
+        } finally {
+          _iterator7.f();
+        }
+      } catch (error) {
+        throw error;
+      }
+    })();
+  }
+
+  remove(name) {
+    var _this9 = this;
+
+    return _asyncToGenerator(function* () {
+      const pluginNames = typeof name === 'string' ? [name] : name;
+
+      var _iterator8 = _createForOfIteratorHelper(pluginNames),
+          _step8;
+
+      try {
+        for (_iterator8.s(); !(_step8 = _iterator8.n()).done;) {
+          const pluginName = _step8.value;
+
+          const plugin = _this9.app.getPlugin(pluginName);
+
+          if (!plugin) {
+            throw new Error(`${name} plugin does not exist`);
+          }
+
+          yield plugin.remove();
+        }
+      } catch (err) {
+        _iterator8.e(err);
+      } finally {
+        _iterator8.f();
+      }
+
+      yield _this9.repository.remove(name);
+
+      _this9.app.reload();
+    })();
+  }
+
+  static getPackageName(name) {
+    const prefixes = (process.env.PLUGIN_PACKAGE_PREFIX || '@nocobase/plugin-,@nocobase/preset-').split(',');
+
+    var _iterator9 = _createForOfIteratorHelper(prefixes),
+        _step9;
+
+    try {
+      for (_iterator9.s(); !(_step9 = _iterator9.n()).done;) {
+        const prefix = _step9.value;
+
+        try {
+          require.resolve(`${prefix}${name}`);
+
+          return `${prefix}${name}`;
+        } catch (error) {
+          continue;
+        }
+      }
+    } catch (err) {
+      _iterator9.e(err);
+    } finally {
+      _iterator9.f();
+    }
+
+    throw new Error(`${name} plugin does not exist`);
+  }
+
+  static findPackage(name) {
+    var _this10 = this;
+
+    return _asyncToGenerator(function* () {
+      try {
+        const packageName = _this10.getPackageName(name);
+
+        return packageName;
+      } catch (error) {
+        const prefixes = (process.env.PLUGIN_PACKAGE_PREFIX || '@nocobase/plugin-,@nocobase/preset-').split(',');
+
+        var _iterator10 = _createForOfIteratorHelper(prefixes),
+            _step10;
+
+        try {
+          for (_iterator10.s(); !(_step10 = _iterator10.n()).done;) {
+            const prefix = _step10.value;
+
+            try {
+              const packageName = `${prefix}${name}`;
+              yield (0, _execa().default)('npm', ['v', packageName, 'versions']);
+              console.log(`${packageName} is downloading...`);
+              yield (0, _execa().default)('yarn', ['add', packageName, '-W']);
+              return packageName;
+            } catch (error) {
+              continue;
+            }
+          }
+        } catch (err) {
+          _iterator10.e(err);
+        } finally {
+          _iterator10.f();
+        }
+      }
+
+      throw new Error(`${name} plugin does not exist`);
+    })();
+  }
+
+  static resolvePlugin(pluginName) {
+    const packageName = this.getPackageName(pluginName);
+    return (0, _utils().requireModule)(packageName);
+  }
+
+}
+
+exports.PluginManager = PluginManager;
+var _default = PluginManager;
+exports.default = _default;

package/lib/plugin-manager/PluginManagerRepository.d.ts

@@ -0,0 +1,10 @@
+import { Repository } from '@nocobase/database';
+import { PluginManager } from './PluginManager';
+export declare class PluginManagerRepository extends Repository {
+    pm: PluginManager;
+    setPluginManager(pm: PluginManager): void;
+    remove(name: string | string[]): Promise<void>;
+    enable(name: string | string[]): Promise<string[]>;
+    disable(name: string | string[]): Promise<string[]>;
+    load(): Promise<void>;
+}