README
LSK.js – module
@lskjs/module – Module system with dependency injection, event emitter, logger and submodules tree
Table of contents
⌨️ Install
# yarn
yarn i @lskjs/module @types/lodash bluebird lodash
# npm
npm i @lskjs/module @types/lodash bluebird lodash
@lskjs/module
Весь мир модуль и мы в нём подмодули
Модуль - модули это классы с определнным жизненным циклом. Из модулей будет собираться комплексное приложение, у модулей могут быть подмодули.
Манифест модульной архитектуры
Основные цели
- простая инициализация
- расширение через наследование
- расширение через параметры конструктора
- модульность (древовидная архитектура)
- ленивость (асинхронность всего что только возможно)
Побочные фишки
- встроенный логгер и дебаг режим
- встроенный event emitter и event driven
- кофигурирование из единой родительской точки
- удобный inject'инг из дерева модулей
- легковесность
Modules lifecycle
- null - после конструктора
- init - стадия инициализации, по сути это асинхронный конструктор, нужно сделать все необходимые require. на этой стадии работаем внутри себя, остальные сестренские объекты (модели, модули, сокеты, файлы) еще не существуют.
- run - стадия запуска, делаем все необоходимые внешние подключения, тут можно обращяться к внешний модулям системы: модели, модули
- stop - выключаем модуль, или для остановки приложения, или для переконфигурирования, или просто чтобы выключить соединения и очистить память
Modules stage statuses
- null - хуй знает что с ним, еще не запускался
- initing - стадия инициализации
- inited - уже инициализировался
- runing - стадия запуска
- runned - уже запустился
- stopping - стадия остановки
- stoped - уже остановился
Modules public static methods
module.init() - как консструктор но асинхронный, делает необходимые импорты и устанвливет правильное состояние модуля
module.run() - запускает все процессы в модуле
module.start() - init and run and some magic?
Module.new() - only create object
Module.create() - new + init
Module.start() - new + init + run -- init and run and some magic?
Просто взять и юзать
const theModule = await TheModule.start();
theModule.name === 'TheModule'
Прокидывать props в конструктор
const theModule = await TheModule.start({
mode: 'private',
config: {
value: 1
},
});
theModule.mode === 'private'
theModule.config.value === 1
Разные способы создавать
// === Example 1 - common use ===
const m = await Module.start(props);
// === Example 2 - if you need inited modules for connection ===
const m1 = await Module.create(props);
const m2 = await Module.create(props);
m1.m2 = m2;
m2.m1 = m1;
await m1.start();
await m2.start();
// === Example 3 – if you need uninited module ===
const m = Module.new(props);
await m.start()
Наследование
class SomeModule extends Module {
async run() {
await super.run(); // очень важно не забывать super
if (this.param) {
doSomething();
}
}
}
// Прокидывание параметров через конструктор
const sm = await SomeModule.start({
param: 1312,
});
Конфиги
class OtherModule extends Module {
async init() {
await super.init(); // очень важно не забывать super
if (this.config.param) {
doSomething();
}
}
}
// SomeModule from the previous example
const some = await SomeModule.start({
param: 1,
modules: {
other: OtherModule,
},
config: {
param: 2
some
}
});
const other = await m.module('other');
Прокидывать подмодули, разным образом
Как props в конструкторе
- как класс через require
- как промис через асинхронный import
- как функцию при вызове которой будет происхолить асинхрронный import
const theModule = new TheModule({
modules: {
permit: require('@lskjs/permit/server'),
upload: import('@lskjs/upload/server'),
mailer: () => import('@lskjs/mailer/server'),
}
});
await theModule.start()
Прокидывать подмодули с параметрами конструктора
const theModule = new TheModule({
modules: {
permit: [require('@lskjs/permit/server'), { value: 1 }],
upload: [import('@lskjs/upload/server'), { value:2 } ],
mailer: () => [import('@lskjs/mailer/server', { value: 3 })],
}
});
await theModule.start()
как field в классе
class TheModule extends Module {
modules = {
permit: require('@lskjs/permit/server'),
upload: import('@lskjs/upload/server'),
mailer: () => import('@lskjs/mailer/server'),
}
}
как расширения getter'a в классе
class TheModule extends Module {
async getModules() {
return {
...await super.getModules(),
permit: require('@lskjs/permit/server'),
upload: import('@lskjs/upload/server'),
mailer: () => import('@lskjs/mailer/server'),
}
}
}
как создаем модуль
class TheModule extends Module {
name = 'TheModule2'; // можно переопределить имя, чтобы это имя было в логгере например
async init() {
await super.init();
// делаем то, что нам нужно для инициализации
this.client = new Telegraf(this.config)
}
async run() {
await super.run();
// делаем то, что нам нужно для запуска модуля
this.client.launch();
}
}
Еще не написана документация
проблема провайдеров
у модуля должен быть логгер
у модуля должен быть event emitter
проблема конфигов, централизованных конфигов
проблема моделей и модуля db (в init нужен mongoose)
модуль
подмодули
провайдеры
модели
ee
inject
getModules
modules={}
new TheModule(, {providers: {}})
как прокидывать конфиги дальше?
Гипотетическое использование
Всякие ссылки
- https://v8.dev/blog/fast-async ======================== При переинициализации мы должны получать тот же самый объект
=======================================
Модули и конфиги
Case 1 – empty config
class SomeModule extends Module { }
const some = await SomeModule.start();
console.log(some.config); // {}
Case 2 – default config
class SomeModule extends Module {
config = {
a: 1,
b: 2
};
}
const some = await SomeModule.start();
console.log(some.config);
// {
// a: 1,
// b: 2,
// }
Case 3 - config while creation
const some = await SomeModule.start({
config: {
a: 11,
}
});
console.log(some.config);
// {
// a: 11,
// }
Case 4 - merging default and top config
class SomeModule extends Module {
config = {
a: 1,
b: 2,
z: {
za: 1,
zb: 2
}
};
other = {
e: 5,
f: 6,
};
}
const some = await SomeModule.create({
config: {
a: 11,
c: 33,
z: {
za: 11,
zc: 33
}
},
other: {
e: 55,
g: 77,
};
})
// Мердж работает только с плоскими, конфигами. Но если очень хочется можно сделать глубокий merge
console.log(some.config);
// {
// a: 11,
// b: 2,
// c: 33,
// z: {
// za: 11,
// zc: 33,
// },
// }
// Другие объекты перетираются, но если очень хочется то можно сделать как в конфигах
console.log(some.other);
// {
// e: 55,
// g: 77,
// }
Case 5 - async config from db
class SomeModule extends Module {
config = {
a: 1,
b: 2,
};
async getConfigFromDb() {
return {
fields: true,
from: true,
db: true,
}
}
async getConfig() {
const localConfig = await super.getConfig();
const dbConfig = await this.getConfigFromDb().catch(err => {
this.log.error('something wrong', err);
if (neededFallApp) throw err
// throw err;
return {}
})
return {
...localConfig,
...dbConfig,
};
}
}
const some = await SomeModule.create({
config: {
a: 11,
c: 33
}
})
// if all ok
some.config === {
a: 11,
b: 2,
c: 33,
fields: true,
from: true,
db: true,
}
// if all error not ok
some.config === {
a: 11,
b: 2,
c: 33,
}
Case 6 - deep config merge
class Module {
async getConfig() {
return {
...this.defaultConfig,
...this.config,
}
}
}
class Module {
async getConfig() {
return {
...this.defaultConfig,
...this.config,
...this.__config,
deep: {
...this.defaultConfig.deep,
...this.config.deep,
...this.__config.deep,
deepest: {
...this.defaultConfig.deep.deepest,
...this.config.deep.deepest,
...this.__config.deep.deepest,
}
}
}
}
// or
async getConfig() {
return mergeDeep(
this.defaultConfig,
this.config,
this.__config,
}
}
defaultConfig = {
a: 1,
b: 2,
};
}
const some = await SomeModule.create({
config: {
a: 2,
c: 3
}
})
some.config === {
a: 2,
b: 2,
c: 3,
}
=================
May be in future
class Uapp {
getModules() {
return {
appstate: () => import('./modules/appstate'),
i18: () => import('./modules/i18'),
}
}
provide() {
return {
...super.provide(),
i18: this.modules.i18
}
}
}
async injectAndAwait(props) {
const i18 = await props.i18;
const res = {};
if (!i18.runned) {
await i18.run();
res.i18 = i18;
}
return res;
}
@injectAndAwait('i18')
class Component {
render() {
const {i18} = this.props;
return <div />
}
}
📖 License
This project is licensed under the MIT License - see the LICENSE file for details
👥 Contributors
 Igor Suvorov 💻 🎨 🤔 |
👏 Contributing
- Fork it (https://github.com/yourname/yourproject/fork)
- Create your feature branch (
git checkout -b features/fooBar) - Commit your changes (
git commit -am 'feat(image): Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - Create a new Pull Request