feat: support specific framework & plugin in scanner (#158)

src/scanner/scan.ts

@@ -1,6 +1,7 @@
 import 'reflect-metadata';
 import * as path from 'path';
 import * as fs from 'fs/promises';
+import deepmerge from 'deepmerge';
 import { Container } from '@artus/injection';
 import {
   ArtusInjectEnum,
@@ -16,7 +17,7 @@ import ConfigurationHandler, { ConfigObject } from '../configuration';
 import { FrameworkConfig, FrameworkHandler } from '../framework';
 import { BasePlugin, PluginFactory } from '../plugin';
 import { ScanUtils } from './utils';
-import { PluginMetadata } from '../plugin/types';
+import { PluginConfigItem, PluginMetadata } from '../plugin/types';
 import { getConfigMetaFromFilename } from '../loader/utils/config_file_meta';
 
 export class Scanner {
@@ -95,7 +96,8 @@ export class Scanner {
     const config = await this.getAllConfig(root, env);
 
     // 2. scan all file in framework
-    const frameworkDirs = await this.getFrameworkDirs(config.framework, root, env);
+    const frameworkConfig = this.options.framework ?? config.framework;
+    const frameworkDirs = await this.getFrameworkDirs(frameworkConfig, root, env);
     for (const frameworkDir of frameworkDirs) {
       await this.walk(frameworkDir, this.formatWalkOptions('framework', frameworkDir));
     }
@@ -107,7 +109,8 @@ export class Scanner {
       configList.forEach(config => this.configHandle.setConfig(env, config));
     }
     const { plugin } = this.configHandle.getMergedConfig(env);
-    const pluginSortedList = await PluginFactory.createFromConfig(plugin || {});
+    const pluginConfig = deepmerge.all([plugin || {}, this.options.plugin || {}]) as Record<string, PluginConfigItem>;
+    const pluginSortedList = await PluginFactory.createFromConfig(pluginConfig);
     for (const plugin of pluginSortedList) {
       if (!plugin.enable) continue;
       this.setPluginMeta(plugin);
@@ -153,7 +156,7 @@ export class Scanner {
     const container = new Container(ArtusInjectEnum.DefaultContainerName);
     container.set({ type: ConfigurationHandler });
     const loaderFactory = LoaderFactory.create(container);
-    const configItemList: (ManifestItem|null)[] = await Promise.all(configFileList.map(async filename => {
+    const configItemList: (ManifestItem | null)[] = await Promise.all(configFileList.map(async filename => {
       const extname = path.extname(filename);
       if (ScanUtils.isExclude(filename, extname, this.options.exclude, this.options.extensions)) {
         return null;

src/scanner/types.ts

@@ -1,4 +1,6 @@
 import { BaseLoader, ManifestItem } from "../loader";
+import { FrameworkConfig } from "../framework";
+import { PluginConfigItem } from "../plugin/types";
 
 export interface ScannerOptions {
   appName: string;
@@ -8,6 +10,8 @@ export interface ScannerOptions {
   exclude: string[];
   configDir: string;
   envs?: string[];
+  framework?: FrameworkConfig;
+  plugin?: Record<string, Partial<PluginConfigItem>>;
   loaderListGenerator: (defaultLoaderList: string[]) => (string | typeof BaseLoader)[];
 }
 

test/fixtures/application_specific/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "application-specific"
+}

test/fixtures/application_specific/src/config/config.default.ts

@@ -0,0 +1 @@
+export const name = 'from application';

test/fixtures/application_specific/src/config/config.private.ts

@@ -0,0 +1 @@
+export const name = 'from application <private>';

test/fixtures/application_specific/src/config/plugin.default.ts

@@ -0,0 +1,16 @@
+import path from 'path';
+
+export default {
+  mysql: {
+    enable: true,
+    path: path.resolve(__dirname, '../plugins/artus_plugin_mysql_rds'),
+  },
+  redis: {
+    enable: true,
+    path: path.resolve(__dirname, '../plugins/artus_plugin_redis'),
+  },
+  base: {
+    enable: true,
+    path: path.resolve(__dirname, '../plugins/artus_plugin_base'),
+  },
+};

test/fixtures/application_specific/src/controller/conifg.ts

@@ -0,0 +1,17 @@
+import { Context } from '@artus/pipeline';
+import { HttpController, HttpMethod, HTTPMethodEnum } from '../../../frameworks/bar/src';
+
+@HttpController()
+export default class Hello {
+  @HttpMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/config',
+  })
+  async index(ctx: Context) {
+    const { params: { config } } = ctx.input;
+    return {
+      message: `get conifg succeed`,
+      config,
+    };
+  }
+}

test/fixtures/application_specific/src/controller/hello.ts

@@ -0,0 +1,32 @@
+import { Context } from '@artus/pipeline';
+import { HttpController, HttpMethod, HTTPMethodEnum } from '../../../frameworks/bar/src';
+
+@HttpController()
+export default class Hello {
+  @HttpMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/home',
+  })
+  async index(ctx: Context) {
+    const { params: { config } } = ctx.input;
+    return { title: `Hello Artus ${config.name}` };
+  }
+
+  @HttpMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/get_name2',
+  })
+  async name2(ctx: Context) {
+    const { params: { config } } = ctx.input;
+    return { title: `Hello Artus ${config.name2}` };
+  }
+
+  @HttpMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/get_name3',
+  })
+  async name3(ctx: Context) {
+    const { params: { config } } = ctx.input;
+    return { title: `Hello Artus ${config.name3}` };
+  }
+}

test/fixtures/application_specific/src/controller/plugin.ts

@@ -0,0 +1,39 @@
+import { HttpController, HttpMethod, HTTPMethodEnum } from '../../../frameworks/bar/src';
+import { Inject } from '@artus/injection';
+import { ArtusApplication } from '../../../../../src';
+import { Context } from '@artus/pipeline';
+
+@HttpController()
+export default class Hello {
+  @Inject('ARTUS_MYSQL')
+  private client: any;
+
+  @HttpMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/plugin-mysql',
+  })
+  async getMysqlClient() {
+    return {
+      client: await this.client.getClient(),
+    };
+  }
+
+  @HttpMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/plugin-redis',
+  })
+  async getRedisClient(ctx: Context) {
+    const app: ArtusApplication = ctx.input.params.app;
+    let client;
+    try {
+      client = app.container.get('ARTUS_REDIS');
+    } catch {
+
+    }
+
+    const result = client ? {
+      client: await client.getClient(),
+    } : { message: 'plugin redis not enabled' };
+    return result;
+  }
+}

test/fixtures/application_specific/src/index.ts

@@ -0,0 +1,33 @@
+import path from 'path';
+import { Manifest, ArtusApplication, ArtusInjectEnum } from "../../../../src";
+import { AbstractBar } from '../../frameworks/bar/src';
+import { Inject, Injectable } from "@artus/injection";
+
+@Injectable()
+export default class MyArtusApplication {
+  @Inject('ABSTRACT_BAR')
+  private bar: AbstractBar;
+  @Inject(ArtusInjectEnum.Application)
+  public artus: ArtusApplication;
+
+  static async instance(manifest: Manifest): Promise<MyArtusApplication> {
+    const app = new ArtusApplication();
+    await app.load(manifest, path.join(__dirname, '..'));
+    const instance = app.container.get(MyArtusApplication);
+    return instance;
+  }
+
+  isListening(): boolean {
+    return this.bar.isListening();
+  }
+
+  async run() {
+    await this.artus.run();
+  }
+}
+
+export async function main(manifest: Manifest) {
+  const app = await MyArtusApplication.instance(manifest);
+  await app.run();
+  return app;
+}

test/fixtures/application_specific/src/plugins/artus_plugin_base/meta.json

@@ -0,0 +1,3 @@
+{
+  "name": "base"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_base/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@artus/plugin-base"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_base/src/config.default.ts

@@ -0,0 +1,5 @@
+export default {
+  mysql: {
+    clientName: 'mysql-ob-base',
+  },
+};

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_ob/meta.json

@@ -0,0 +1,9 @@
+{
+  "name": "mysql",
+  "configDir": "src/custom_config",
+  "dependencies": [
+      {
+          "name": "base"
+      }
+  ]
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_ob/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@artus/plugin-mysql-ob"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_ob/src/app.ts

@@ -0,0 +1,19 @@
+import { Server } from 'http';
+import { LifecycleHookUnit, LifecycleHook } from '../../../../../../../src/decorator';
+import { ApplicationLifecycle } from '../../../../../../../src/types';
+import { ArtusApplication, Inject, ArtusInjectEnum } from '../../../../../../../src';
+import Client, { MysqlConfig } from './client';
+
+export let server: Server;
+
+@LifecycleHookUnit()
+export default class MyLifecycle implements ApplicationLifecycle {
+  @Inject(ArtusInjectEnum.Application)
+  app: ArtusApplication;
+
+  @LifecycleHook()
+  async willReady() {
+    const mysql = this.app.container.get('ARTUS_MYSQL') as Client;
+    await mysql.init(this.app.config.mysql as MysqlConfig);
+  }
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_ob/src/client.ts

@@ -0,0 +1,20 @@
+import { Injectable } from "@artus/injection";
+
+export interface MysqlConfig {
+  clientName: string
+}
+
+@Injectable({
+  id: 'ARTUS_MYSQL',
+})
+export default class Client {
+  private clientName = '';
+
+  async init(config: MysqlConfig) {
+    this.clientName = config.clientName;
+  }
+
+  async getClient(): Promise<string> {
+    return this.clientName;
+  }
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_ob/src/custom_config/config.default.ts

@@ -0,0 +1,5 @@
+export default {
+  mysql: {
+    clientName: 'mysql-ob',
+  },
+};

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_rds/meta.json

@@ -0,0 +1,3 @@
+{
+  "name": "mysql"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_rds/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@artus/plugin-mysql-rds"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_rds/src/app.ts

@@ -0,0 +1,19 @@
+import { Server } from 'http';
+import { LifecycleHookUnit, LifecycleHook } from '../../../../../../../src/decorator';
+import { ApplicationLifecycle } from '../../../../../../../src/types';
+import { ArtusApplication, Inject, ArtusInjectEnum } from '../../../../../../../src';
+import Client, { MysqlConfig } from './client';
+
+export let server: Server;
+
+@LifecycleHookUnit()
+export default class MyLifecycle implements ApplicationLifecycle {
+  @Inject(ArtusInjectEnum.Application)
+  app: ArtusApplication;
+
+  @LifecycleHook()
+  async willReady() {
+    const mysql = this.app.container.get('ARTUS_MYSQL') as Client;
+    await mysql.init(this.app.config.mysql as MysqlConfig);
+  }
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_rds/src/client.ts

@@ -0,0 +1,20 @@
+import { Injectable } from "@artus/injection";
+
+export interface MysqlConfig {
+  clientName: string
+}
+
+@Injectable({
+  id: 'ARTUS_MYSQL',
+})
+export default class Client {
+  private clientName = '';
+
+  async init(config: MysqlConfig) {
+    this.clientName = config.clientName;
+  }
+
+  async getClient(): Promise<string> {
+    return this.clientName;
+  }
+}

test/fixtures/application_specific/src/plugins/artus_plugin_mysql_rds/src/config/config.default.ts

@@ -0,0 +1,5 @@
+export default {
+  mysql: {
+    clientName: 'mysql-rds',
+  },
+};

test/fixtures/application_specific/src/plugins/artus_plugin_redis/meta.json

@@ -0,0 +1,3 @@
+{
+    "name": "redis"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_redis/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "@artus/plugin-redis"
+}

test/fixtures/application_specific/src/plugins/artus_plugin_redis/src/app.ts

@@ -0,0 +1,19 @@
+import { Server } from 'http';
+import { LifecycleHookUnit, LifecycleHook } from '../../../../../../../src/decorator';
+import { ApplicationLifecycle } from '../../../../../../../src/types';
+import { ArtusApplication, Inject, ArtusInjectEnum } from '../../../../../../../src';
+import Client, { RedisConfig } from './client';
+
+export let server: Server;
+
+@LifecycleHookUnit()
+export default class MyLifecycle implements ApplicationLifecycle {
+  @Inject(ArtusInjectEnum.Application)
+  app: ArtusApplication;
+
+  @LifecycleHook()
+  async willReady() {
+    const redis = this.app.container.get('ARTUS_REDIS') as Client;
+    await redis.init(this.app.config.redis as RedisConfig);
+  }
+}