feat(core): make plugins path configurable (#562)

apps/core/README.md

@@ -1,6 +1,6 @@
 # LEAV Engine - Core
 
-### Create and set the local environment.
+## Create and set the local environment.
 
 leav_core depends on some variables such as the port for the server, the address of the database, the auth scheme...
 Those different configurations can be found in the `config` folder.
@@ -30,7 +30,14 @@ module.exports = {
 };
 ```
 
-### Debugging in VS Code
+## Add plugins
+
+You can add plugins to the core by adding them to the plugins folder. Each plugin live in its own folder and have at least a `index.ts` file.
+
+The plugin folder is located by default in `apps/core/src/plugins` on development environment and `apps/core/dist/plugins` on build.
+It can be configured with the `PLUGINS_PATH` environment variable or the `pluginsPath` variable in the `config/local.js` file. ⚠️ The path must be under the `apps/core/src/plugins` folder (eg. `apps/core/src/plugins/my-own-repo/my-plugins`)
+
+## Debugging in VS Code
 
 In VS Code, the easiest way to debug the app in its Docker container is to install the extension "Remote Development".
 Then, you will be able to open a container inside VS Code.

apps/core/config/default.js

@@ -165,5 +165,6 @@ module.exports = {
     },
     elasticSearch: {
         url: process.env.ELASTIC_SEARCH_URL || 'http://elasticsearch:9200'
-    }
+    },
+    pluginsPath: process.env.PLUGINS_PATH || 'plugins'
 };

apps/core/src/_types/config.ts

@@ -32,6 +32,7 @@ export interface IConfig {
     dbProfiler: IDbProfilerConfig;
     instanceId: string;
     elasticSearch: IElasticSearchConfig;
+    pluginsPath: string;
 }
 
 export enum CoreMode {

apps/core/src/config.ts

@@ -181,7 +181,8 @@ export const validateConfig = (conf: IConfig) => {
         instanceId: Joi.string().required(),
         elasticSearch: Joi.object().keys({
             url: Joi.string().required()
-        })
+        }),
+        pluginsPath: Joi.string().required()
     });
 
     const isValid = configSchema.validate(conf);

apps/core/src/depsManager.ts

@@ -63,7 +63,10 @@ export async function initDI(additionalModulesToRegister?: {
     [registerKey: string]: any;
 }): Promise<{coreContainer: AwilixContainer; pluginsContainer: AwilixContainer}> {
     const srcFolder = __dirname;
-    const pluginsFolder = realpathSync(__dirname + '/plugins');
+    // Add a few extra dependencies
+    const coreConf = await getConfig();
+
+    const pluginsFolder = realpathSync(__dirname + '/' + coreConf.pluginsPath);
     const modulesGlob = '+(app|domain|infra|interface|utils)/**/index.+(ts|js)';
     const pluginsModulesGlob = `!(core)/${modulesGlob}`;
 
@@ -74,8 +77,6 @@ export async function initDI(additionalModulesToRegister?: {
 
     await _registerModules(coreContainer, srcFolder, modulesGlob, 'core');
 
-    // Add a few extra dependencies
-    const coreConf = await getConfig();
     coreContainer.register('config', asValue(coreConf));
     coreContainer.register('pluginsFolder', asValue(pluginsFolder));
 

docker/scripts/start-core.sh

@@ -3,10 +3,10 @@ echo "Install apps dependencies"
 yarn install
 
 # Install plugins dependencies
-for plugin in ./src/plugins/*/; do
-  echo "Install dependencies for $plugin"
-  yarn --cwd "$plugin" install
-done
+find ./src/plugins -name package.json -not -path "*/node_modules/*" -exec sh -c '
+  echo "🚧 Install dependencies for plugin $(basename $(dirname {}))"
+  (cd $(dirname {}) && yarn install)
+' \;
 
 yarn run db:migrate:dev