-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
224 lines (194 loc) · 7.18 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/**
* @module kojo
*/
import path from 'path';
import url from 'url';
import fs from 'fs'; const readDir = promisify(fs.readdir);
import { promisify } from 'util';
import { EventEmitter } from 'events';
import TrID from 'trid';
import Service from './lib/Service.js';
import Logger from'./lib/Logger.js';
import { getParentPackageInfo } from './lib/util.js';
import kojoPackage from './package.json' assert { type: 'json' };
/**
* The Kojo class
*
* @class
* @alias module:kojo
* @example
* ```js
* const kojo = new Kojo({
* name: 'users',
* icon: 👥
* });
* ```
*/
class Kojo extends EventEmitter {
/**
* Create Kojo instance
*
* @param options {Object} - configuration options
* @param options.subsDir {string} - subscribers directory (relative to project root)
* @param options.serviceDir {string} - service directory (relative to project root)
* @param options.parentPackage {Object} - parent package, Kojo is running from. Needed to just display
* parent package name version. Default is current project package.json
* @param options.name {string} - Kojo name (default `工場`)
* @param options.icon {string} - Kojo icon, usually an emoji (default `☢`)
* @param options.logLevel {string} - the log level (default: `debug`)
* @param options.loggerIdSuffix {boolean} - shall logger use Kojo ID prefix? (default: false)
*/
constructor(options={}) {
super();
const defaults = {
subsDir: 'subscribers',
serviceDir: 'services',
parentPackage: null,
name: '工場',
icon: '☢',
logLevel: 'debug',
loggerIdSuffix: false
};
this._options = options;
/**
* Kojo instance configuration
*
* @type Object
*/
this.config = Object.assign(defaults, this._options);
const { name } = this.config;
const id = new TrID();
/**
* Kojo instance unique ID
*
* @type string
* @example
* ```
* user-service.zM8n6
* ```
*/
this.id = id.base();
/**
* Kojo name
*
* @type string
* @example
* ```
* user-service
* ```
*/
this.name = name;
this.state = {};
this._subscribers = [];
}
/**
* Bootstrap Kojo instance. Resolves after every service and
* subscriber has been loaded. Always `await` for it before using Kojo
* instance.
*
* @instance
* @return {Promise}
* @fulfil {Array} - 'tuple' with services and endpoints count
* @example
* ```js
* const kojo = new Kojo(options);
* await kojo.ready();
* ```
*/
async ready() {
const kojo = this;
if (! kojo.config.parentPackage)
kojo.config.parentPackage = (await getParentPackageInfo()).default;
const { icon, logLevel, parentPackage } = kojo.config;
process.stdout.write('\n*************************************************************\n');
process.stdout.write(` ${icon} ${kojo.id} | ${parentPackage.name}@${parentPackage.version} | ${kojoPackage.name}@${kojoPackage.version}\n`);
process.stdout.write('~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n');
// SERVICES
const servicesDir = path.join(process.cwd(), kojo.config.serviceDir);
const servicesAlias = path.basename(kojo.config.serviceDir);
kojo[servicesAlias] = {};
try {
const serviceDirs = await readDir(servicesDir);
process.stdout.write(` ${icon} loading ${servicesAlias}...`);
for (const srvDir of serviceDirs) {
const servicePath = path.join(servicesDir, srvDir);
if (! fs.lstatSync(servicePath).isDirectory())
continue;
const serviceName = path.basename(servicePath);
const service = new Service(serviceName, servicePath, kojo);
kojo[servicesAlias][serviceName] = await service.ready();
}
process.stdout.write(` done (${Object.keys(kojo[servicesAlias]).length})\n`);
} catch (error) {
if (error.code === 'ENOENT' && error.path === servicesDir && !kojo._options.serviceDir)
process.stdout.write(` ${icon} skipping ${servicesAlias}\n`);
else {
process.stderr.write(error.message);
throw error;
}
}
// SUBSCRIBERS
const subsDir = path.join(process.cwd(), kojo.config.subsDir);
try {
const subscriberFiles = await readDir(subsDir);
const subsAlias = path.basename(kojo.config.subsDir);
process.stdout.write(` ${icon} loading ${subsAlias}...`);
await Promise.all(subscriberFiles.map(async (subscriberFile) => {
const subName = path.basename(subscriberFile, '.js');
const importPath = path.join(subsDir, subscriberFile);
kojo._subscribers.push(subName);
const subsWrapper = await import(url.pathToFileURL(importPath));
const loggerId = kojo.config.loggerIdSuffix ? [ kojo.name, kojo.id ].join('.') : kojo.name;
return subsWrapper.default(kojo, new Logger({
id: loggerId, icon,
level: logLevel,
tagPieces: [ subName ],
color: 'bold' }))
}
));
process.stdout.write(` done (${kojo._subscribers.length})\n`);
} catch (error) {
if (error.code === 'ENOENT' && error.path === subsDir && !kojo._options.subsDir) {
process.stdout.write(` ${icon} skipping subscribers\n`);
} else {
process.stderr.write(error.message);
throw error;
}
}
process.stdout.write(` ${icon} kojo "${kojo.name}" ready [${process.env.NODE_ENV}]\n`);
process.stdout.write('*************************************************************\n');
return [ Object.keys(kojo[servicesAlias]).length, kojo._subscribers.length ];
}
/**
* Set key/value to the global context. Anything goes here - DB, transport connections,
* configuration objects, etc. This is also called setting an 'extra'.
*
* @instance
* @param {string} key - key string
* @param {*} value - value of any type
* @example
* ```js
* const client = await MongoClient.connect(config.mongodb.url);
* kojo.set('mongo', client);
* ```
*/
set(key, value) {
this.state[key] = value;
}
/**
* Get (previously `set`) value from state.
*
* @instance
* @param {string=} key - key string (optional). If omitted, returns state object.
* @returns {*}
* @example
* ```js
* const client = await MongoClient.connect(config.mongodb.url);
* kojo.get('mongo');
* ```
*/
get(key) {
return key ? this.state[key] : this.state;
}
}
export default Kojo;