vovk-cli 0.0.1-draft.30 → 0.0.1-draft.300
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +29 -1
- package/client-templates/cjs/index.cjs.ejs +19 -0
- package/client-templates/cjs/index.d.cts.ejs +25 -0
- package/client-templates/mixins/mixins.d.ts.ejs +64 -0
- package/client-templates/mixins/mixins.json.ejs +1 -0
- package/client-templates/mjs/index.d.mts.ejs +25 -0
- package/client-templates/mjs/index.mjs.ejs +23 -0
- package/client-templates/packageJson/package.json.ejs +1 -0
- package/client-templates/readme/README.md.ejs +38 -0
- package/client-templates/schemaCjs/schema.cjs.ejs +26 -0
- package/client-templates/schemaCjs/schema.d.cts.ejs +10 -0
- package/client-templates/schemaJson/schema.json.ejs +1 -0
- package/client-templates/schemaTs/schema.ts.ejs +35 -0
- package/client-templates/ts/index.ts.ejs +33 -0
- package/dist/bundle/index.d.mts +8 -0
- package/dist/bundle/index.mjs +90 -0
- package/dist/dev/diffSegmentSchema.d.mts +36 -0
- package/dist/dev/{diffSchema.mjs → diffSegmentSchema.mjs} +3 -11
- package/dist/dev/ensureSchemaFiles.d.mts +3 -0
- package/dist/dev/ensureSchemaFiles.mjs +15 -31
- package/dist/dev/index.d.mts +6 -1
- package/dist/dev/index.mjs +169 -76
- package/dist/dev/logDiffResult.d.mts +1 -1
- package/dist/dev/logDiffResult.mjs +6 -43
- package/dist/dev/writeMetaJson.d.mts +2 -0
- package/dist/dev/writeMetaJson.mjs +17 -0
- package/dist/dev/writeOneSegmentSchemaFile.d.mts +12 -0
- package/dist/dev/{writeOneSchemaFile.mjs → writeOneSegmentSchemaFile.mjs} +10 -6
- package/dist/generate/ensureClient.d.mts +3 -0
- package/dist/generate/ensureClient.mjs +32 -0
- package/dist/generate/generate.d.mts +15 -0
- package/dist/generate/generate.mjs +291 -0
- package/dist/generate/getClientTemplateFiles.d.mts +20 -0
- package/dist/generate/getClientTemplateFiles.mjs +89 -0
- package/dist/generate/getProjectFullSchema.d.mts +7 -0
- package/dist/generate/getProjectFullSchema.mjs +65 -0
- package/dist/generate/getTemplateClientImports.d.mts +18 -0
- package/dist/generate/getTemplateClientImports.mjs +38 -0
- package/dist/generate/index.d.mts +33 -0
- package/dist/generate/index.mjs +189 -0
- package/dist/generate/mergePackages.d.mts +7 -0
- package/dist/generate/mergePackages.mjs +55 -0
- package/dist/generate/writeOneClientFile.d.mts +36 -0
- package/dist/generate/writeOneClientFile.mjs +120 -0
- package/dist/getProjectInfo/getConfig/getConfigAbsolutePaths.d.mts +5 -0
- package/dist/getProjectInfo/{getConfigAbsolutePaths.mjs → getConfig/getConfigAbsolutePaths.mjs} +4 -1
- package/dist/getProjectInfo/{getRelativeSrcRoot.d.mts → getConfig/getRelativeSrcRoot.d.mts} +1 -1
- package/dist/getProjectInfo/{getRelativeSrcRoot.mjs → getConfig/getRelativeSrcRoot.mjs} +2 -2
- package/dist/getProjectInfo/getConfig/getTemplateDefs.d.mts +16 -0
- package/dist/getProjectInfo/getConfig/getTemplateDefs.mjs +98 -0
- package/dist/getProjectInfo/{getUserConfig.d.mts → getConfig/getUserConfig.d.mts} +3 -2
- package/dist/getProjectInfo/{getUserConfig.mjs → getConfig/getUserConfig.mjs} +6 -4
- package/dist/getProjectInfo/{importUncachedModule.mjs → getConfig/importUncachedModule.mjs} +1 -5
- package/dist/getProjectInfo/{importUncachedModuleWorker.mjs → getConfig/importUncachedModuleWorker.mjs} +0 -1
- package/dist/getProjectInfo/getConfig/index.d.mts +120 -0
- package/dist/getProjectInfo/getConfig/index.mjs +94 -0
- package/dist/getProjectInfo/index.d.mts +12 -9
- package/dist/getProjectInfo/index.mjs +21 -22
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +99 -36
- package/dist/init/createConfig.d.mts +2 -2
- package/dist/init/createConfig.mjs +18 -12
- package/dist/init/getTemplateFilesFromPackage.mjs +10 -5
- package/dist/init/index.d.mts +2 -2
- package/dist/init/index.mjs +90 -60
- package/dist/init/installDependencies.mjs +4 -2
- package/dist/init/logUpdateDependenciesError.d.mts +3 -1
- package/dist/init/logUpdateDependenciesError.mjs +7 -1
- package/dist/init/updateDependenciesWithoutInstalling.mjs +39 -9
- package/dist/init/updateNPMScripts.d.mts +3 -1
- package/dist/init/updateNPMScripts.mjs +9 -7
- package/dist/init/updateTypeScriptConfig.d.mts +4 -1
- package/dist/init/updateTypeScriptConfig.mjs +11 -7
- package/dist/initProgram.d.mts +1 -1
- package/dist/initProgram.mjs +17 -16
- package/dist/locateSegments.d.mts +8 -1
- package/dist/locateSegments.mjs +14 -4
- package/dist/new/addClassToSegmentCode.d.mts +1 -2
- package/dist/new/addClassToSegmentCode.mjs +3 -3
- package/dist/new/addCommonTerms.mjs +1 -0
- package/dist/new/index.d.mts +1 -1
- package/dist/new/index.mjs +3 -2
- package/dist/new/newModule.d.mts +2 -1
- package/dist/new/newModule.mjs +18 -16
- package/dist/new/newSegment.d.mts +2 -1
- package/dist/new/newSegment.mjs +19 -10
- package/dist/new/render.d.mts +7 -3
- package/dist/new/render.mjs +29 -8
- package/dist/types.d.mts +50 -40
- package/dist/utils/compileJSONSchemaToTypeScriptType.d.mts +5 -0
- package/dist/utils/compileJSONSchemaToTypeScriptType.mjs +9 -0
- package/dist/utils/compileTs.d.mts +12 -0
- package/dist/utils/compileTs.mjs +261 -0
- package/dist/utils/debounceWithArgs.d.mts +2 -2
- package/dist/utils/debounceWithArgs.mjs +24 -6
- package/dist/utils/formatLoggedSegmentName.d.mts +3 -1
- package/dist/utils/formatLoggedSegmentName.mjs +3 -2
- package/dist/utils/getAvailablePort.mjs +1 -1
- package/dist/utils/getPackageJson.d.mts +3 -0
- package/dist/utils/getPackageJson.mjs +22 -0
- package/dist/utils/getPublicModuleNameFromPath.d.mts +4 -0
- package/dist/utils/getPublicModuleNameFromPath.mjs +9 -0
- package/dist/utils/normalizeOpenAPIMixins.d.mts +7 -0
- package/dist/utils/normalizeOpenAPIMixins.mjs +67 -0
- package/dist/utils/pickSegmentFullSchema.d.mts +3 -0
- package/dist/utils/pickSegmentFullSchema.mjs +15 -0
- package/dist/utils/removeUnlistedDirectories.d.mts +10 -0
- package/dist/utils/removeUnlistedDirectories.mjs +61 -0
- package/dist/utils/resolveAbsoluteModulePath.d.mts +2 -0
- package/dist/utils/resolveAbsoluteModulePath.mjs +32 -0
- package/module-templates/controller.ts.ejs +56 -0
- package/module-templates/service.ts.ejs +28 -0
- package/package.json +41 -22
- package/dist/dev/diffSchema.d.mts +0 -43
- package/dist/dev/ensureClient.d.mts +0 -5
- package/dist/dev/ensureClient.mjs +0 -31
- package/dist/dev/isMetadataEmpty.d.mts +0 -2
- package/dist/dev/isMetadataEmpty.mjs +0 -4
- package/dist/dev/writeOneSchemaFile.d.mts +0 -11
- package/dist/generateClient.d.mts +0 -7
- package/dist/generateClient.mjs +0 -97
- package/dist/getProjectInfo/getConfig.d.mts +0 -11
- package/dist/getProjectInfo/getConfig.mjs +0 -29
- package/dist/getProjectInfo/getConfigAbsolutePaths.d.mts +0 -4
- package/dist/postinstall.d.mts +0 -1
- package/dist/postinstall.mjs +0 -24
- package/templates/controller.ejs +0 -51
- package/templates/service.ejs +0 -27
- package/templates/worker.ejs +0 -24
- /package/dist/getProjectInfo/{importUncachedModule.d.mts → getConfig/importUncachedModule.d.mts} +0 -0
- /package/dist/getProjectInfo/{importUncachedModuleWorker.d.mts → getConfig/importUncachedModuleWorker.d.mts} +0 -0
package/dist/dev/index.mjs
CHANGED
|
@@ -1,32 +1,51 @@
|
|
|
1
1
|
import fs from 'node:fs/promises';
|
|
2
2
|
import path from 'node:path';
|
|
3
|
+
import { VovkSchemaIdEnum } from 'vovk';
|
|
3
4
|
import * as chokidar from 'chokidar';
|
|
4
5
|
import { Agent, setGlobalDispatcher } from 'undici';
|
|
5
6
|
import keyBy from 'lodash/keyBy.js';
|
|
6
7
|
import capitalize from 'lodash/capitalize.js';
|
|
7
8
|
import debounce from 'lodash/debounce.js';
|
|
9
|
+
import once from 'lodash/once.js';
|
|
8
10
|
import isEmpty from 'lodash/isEmpty.js';
|
|
9
|
-
import { debouncedEnsureSchemaFiles } from './ensureSchemaFiles.mjs';
|
|
10
|
-
import
|
|
11
|
+
import ensureSchemaFiles, { debouncedEnsureSchemaFiles } from './ensureSchemaFiles.mjs';
|
|
12
|
+
import writeOneSegmentSchemaFile from './writeOneSegmentSchemaFile.mjs';
|
|
11
13
|
import logDiffResult from './logDiffResult.mjs';
|
|
12
|
-
import ensureClient from '
|
|
14
|
+
import ensureClient from '../generate/ensureClient.mjs';
|
|
13
15
|
import getProjectInfo from '../getProjectInfo/index.mjs';
|
|
14
|
-
import
|
|
15
|
-
import locateSegments from '../locateSegments.mjs';
|
|
16
|
+
import { generate } from '../generate/generate.mjs';
|
|
17
|
+
import { locateSegments } from '../locateSegments.mjs';
|
|
16
18
|
import debounceWithArgs from '../utils/debounceWithArgs.mjs';
|
|
17
19
|
import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
|
|
20
|
+
import writeMetaJson from './writeMetaJson.mjs';
|
|
18
21
|
export class VovkDev {
|
|
19
22
|
#projectInfo;
|
|
20
23
|
#segments = [];
|
|
21
|
-
#
|
|
24
|
+
#fullSchema = {
|
|
25
|
+
$schema: VovkSchemaIdEnum.SCHEMA,
|
|
26
|
+
segments: {},
|
|
27
|
+
meta: {
|
|
28
|
+
$schema: VovkSchemaIdEnum.META,
|
|
29
|
+
config: {
|
|
30
|
+
$schema: VovkSchemaIdEnum.CONFIG,
|
|
31
|
+
},
|
|
32
|
+
},
|
|
33
|
+
};
|
|
22
34
|
#isWatching = false;
|
|
23
35
|
#modulesWatcher = null;
|
|
24
36
|
#segmentWatcher = null;
|
|
25
|
-
#
|
|
37
|
+
#onFirstTimeGenerate = null;
|
|
38
|
+
#schemaOut = null;
|
|
39
|
+
constructor({ schemaOut }) {
|
|
40
|
+
this.#schemaOut = schemaOut ?? null;
|
|
41
|
+
}
|
|
42
|
+
#watchSegments = (callback) => {
|
|
26
43
|
const segmentReg = /\/?\[\[\.\.\.[a-zA-Z-_]+\]\]\/route.ts$/;
|
|
27
|
-
const { cwd, log, config,
|
|
28
|
-
|
|
29
|
-
|
|
44
|
+
const { cwd, log, config, apiDirAbsolutePath } = this.#projectInfo;
|
|
45
|
+
if (!apiDirAbsolutePath) {
|
|
46
|
+
throw new Error('Unable to watch segments. It looks like CWD is not a Next.js app.');
|
|
47
|
+
}
|
|
48
|
+
const schemaOutAbsolutePath = path.resolve(cwd, this.#schemaOut ?? config.schemaOutDir);
|
|
30
49
|
const getSegmentName = (filePath) => path.relative(apiDirAbsolutePath, filePath).replace(segmentReg, '');
|
|
31
50
|
log.debug(`Watching segments at ${apiDirAbsolutePath}`);
|
|
32
51
|
this.#segmentWatcher = chokidar
|
|
@@ -40,7 +59,13 @@ export class VovkDev {
|
|
|
40
59
|
const segmentName = getSegmentName(filePath);
|
|
41
60
|
this.#segments = this.#segments.find((s) => s.segmentName === segmentName)
|
|
42
61
|
? this.#segments
|
|
43
|
-
: [
|
|
62
|
+
: [
|
|
63
|
+
...this.#segments,
|
|
64
|
+
{
|
|
65
|
+
routeFilePath: filePath,
|
|
66
|
+
segmentName,
|
|
67
|
+
},
|
|
68
|
+
];
|
|
44
69
|
log.info(`${capitalize(formatLoggedSegmentName(segmentName))} has been added`);
|
|
45
70
|
log.debug(`Full list of segments: ${this.#segments.map((s) => s.segmentName).join(', ')}`);
|
|
46
71
|
void debouncedEnsureSchemaFiles(this.#projectInfo, schemaOutAbsolutePath, this.#segments.map((s) => s.segmentName));
|
|
@@ -54,14 +79,22 @@ export class VovkDev {
|
|
|
54
79
|
})
|
|
55
80
|
.on('addDir', async (dirPath) => {
|
|
56
81
|
log.debug(`Directory ${dirPath} has been added to segments folder`);
|
|
57
|
-
this.#segments = await locateSegments(
|
|
82
|
+
this.#segments = await locateSegments({
|
|
83
|
+
dir: apiDirAbsolutePath,
|
|
84
|
+
config,
|
|
85
|
+
log: this.#projectInfo.log,
|
|
86
|
+
});
|
|
58
87
|
for (const { segmentName } of this.#segments) {
|
|
59
88
|
void this.#requestSchema(segmentName);
|
|
60
89
|
}
|
|
61
90
|
})
|
|
62
91
|
.on('unlinkDir', async (dirPath) => {
|
|
63
92
|
log.debug(`Directory ${dirPath} has been removed from segments folder`);
|
|
64
|
-
this.#segments = await locateSegments(
|
|
93
|
+
this.#segments = await locateSegments({
|
|
94
|
+
dir: apiDirAbsolutePath,
|
|
95
|
+
config,
|
|
96
|
+
log: this.#projectInfo.log,
|
|
97
|
+
});
|
|
65
98
|
for (const { segmentName } of this.#segments) {
|
|
66
99
|
void this.#requestSchema(segmentName);
|
|
67
100
|
}
|
|
@@ -77,13 +110,14 @@ export class VovkDev {
|
|
|
77
110
|
}
|
|
78
111
|
})
|
|
79
112
|
.on('ready', () => {
|
|
113
|
+
callback();
|
|
80
114
|
log.debug('Segments watcher is ready');
|
|
81
115
|
})
|
|
82
116
|
.on('error', (error) => {
|
|
83
117
|
log.error(`Error watching segments folder: ${error?.message ?? 'Unknown error'}`);
|
|
84
118
|
});
|
|
85
119
|
};
|
|
86
|
-
#watchModules = () => {
|
|
120
|
+
#watchModules = (callback) => {
|
|
87
121
|
const { config, cwd, log } = this.#projectInfo;
|
|
88
122
|
const modulesDirAbsolutePath = path.join(cwd, config.modulesDir);
|
|
89
123
|
log.debug(`Watching modules at ${modulesDirAbsolutePath}`);
|
|
@@ -115,30 +149,49 @@ export class VovkDev {
|
|
|
115
149
|
}
|
|
116
150
|
})
|
|
117
151
|
.on('ready', () => {
|
|
152
|
+
callback();
|
|
118
153
|
log.debug('Modules watcher is ready');
|
|
119
154
|
})
|
|
120
155
|
.on('error', (error) => {
|
|
121
156
|
log.error(`Error watching modules folder: ${error?.message ?? 'Unknown error'}`);
|
|
122
157
|
});
|
|
123
158
|
};
|
|
124
|
-
#watchConfig = () => {
|
|
159
|
+
#watchConfig = (callback) => {
|
|
125
160
|
const { log, cwd } = this.#projectInfo;
|
|
126
161
|
log.debug(`Watching config files`);
|
|
127
162
|
let isInitial = true;
|
|
128
163
|
let isReady = false;
|
|
129
164
|
const handle = debounce(async () => {
|
|
130
165
|
this.#projectInfo = await getProjectInfo();
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
isInitial = false;
|
|
134
|
-
}
|
|
166
|
+
const { config, apiDirAbsolutePath } = this.#projectInfo;
|
|
167
|
+
this.#segments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
|
|
135
168
|
await this.#modulesWatcher?.close();
|
|
136
169
|
await this.#segmentWatcher?.close();
|
|
137
|
-
|
|
138
|
-
|
|
170
|
+
await Promise.all([
|
|
171
|
+
new Promise((resolve) => this.#watchModules(() => resolve(0))),
|
|
172
|
+
new Promise((resolve) => this.#watchSegments(() => resolve(0))),
|
|
173
|
+
]);
|
|
174
|
+
const schemaOutAbsolutePath = path.join(cwd, this.#schemaOut ?? this.#projectInfo.config.schemaOutDir);
|
|
175
|
+
if (isInitial) {
|
|
176
|
+
callback();
|
|
177
|
+
}
|
|
178
|
+
else {
|
|
179
|
+
log.info('Config file has been updated');
|
|
180
|
+
this.#generate();
|
|
181
|
+
}
|
|
182
|
+
await writeMetaJson(schemaOutAbsolutePath, this.#projectInfo);
|
|
183
|
+
isInitial = false;
|
|
139
184
|
}, 1000);
|
|
140
185
|
chokidar
|
|
141
|
-
.watch(['vovk.config.{js,mjs,cjs}', '.config/vovk.config.{js,mjs,cjs}'], {
|
|
186
|
+
// .watch(['vovk.config.{js,mjs,cjs}', '.config/vovk.config.{js,mjs,cjs}'], {
|
|
187
|
+
.watch([
|
|
188
|
+
'vovk.config.js',
|
|
189
|
+
'vovk.config.mjs',
|
|
190
|
+
'vovk.config.cjs',
|
|
191
|
+
'.config/vovk.config.js',
|
|
192
|
+
'.config/vovk.config.mjs',
|
|
193
|
+
'.config/vovk.config.cjs',
|
|
194
|
+
], {
|
|
142
195
|
persistent: true,
|
|
143
196
|
cwd,
|
|
144
197
|
ignoreInitial: false,
|
|
@@ -157,14 +210,13 @@ export class VovkDev {
|
|
|
157
210
|
.on('error', (error) => log.error(`Error watching config files: ${error?.message ?? 'Unknown error'}`));
|
|
158
211
|
void handle();
|
|
159
212
|
};
|
|
160
|
-
async #watch() {
|
|
213
|
+
async #watch(callback) {
|
|
161
214
|
if (this.#isWatching)
|
|
162
215
|
throw new Error('Already watching');
|
|
163
216
|
const { log } = this.#projectInfo;
|
|
164
217
|
log.debug(`Starting segments and modules watcher. Detected initial segments: ${JSON.stringify(this.#segments.map((s) => s.segmentName))}.`);
|
|
165
|
-
await ensureClient(this.#projectInfo);
|
|
166
218
|
// automatically watches segments and modules
|
|
167
|
-
this.#watchConfig();
|
|
219
|
+
this.#watchConfig(callback);
|
|
168
220
|
}
|
|
169
221
|
#processControllerChange = async (filePath) => {
|
|
170
222
|
const { log } = this.#projectInfo;
|
|
@@ -175,21 +227,17 @@ export class VovkDev {
|
|
|
175
227
|
}
|
|
176
228
|
const nameOfClasReg = /\bclass\s+([A-Za-z_]\w*)(?:\s*<[^>]*>)?\s*\{/g;
|
|
177
229
|
const namesOfClasses = [...code.matchAll(nameOfClasReg)].map((match) => match[1]);
|
|
178
|
-
const importRegex = /import\s*{[^}]*\b(get|post|put|del|head|options
|
|
230
|
+
const importRegex = /import\s*{[^}]*\b(get|post|put|del|head|options)\b[^}]*}\s*from\s*['"]vovk['"]/;
|
|
179
231
|
if (importRegex.test(code) && namesOfClasses.length) {
|
|
180
232
|
const affectedSegments = this.#segments.filter((s) => {
|
|
181
|
-
const
|
|
182
|
-
if (!
|
|
233
|
+
const segmentSchema = this.#fullSchema.segments[s.segmentName];
|
|
234
|
+
if (!segmentSchema)
|
|
183
235
|
return false;
|
|
184
|
-
const controllersByOriginalName = keyBy(
|
|
185
|
-
|
|
186
|
-
return namesOfClasses.some((name) => schema.controllers[name] ||
|
|
187
|
-
schema.workers[name] ||
|
|
188
|
-
controllersByOriginalName[name] ||
|
|
189
|
-
workersByOriginalName[name]);
|
|
236
|
+
const controllersByOriginalName = keyBy(segmentSchema.controllers, 'originalControllerName');
|
|
237
|
+
return namesOfClasses.some((name) => segmentSchema.controllers[name] || controllersByOriginalName[name]);
|
|
190
238
|
});
|
|
191
239
|
if (affectedSegments.length) {
|
|
192
|
-
log.debug(`A file with controller
|
|
240
|
+
log.debug(`A file with controller ${namesOfClasses.join(', ')} have been modified at path "${filePath}". Segment(s) affected: ${JSON.stringify(affectedSegments.map((s) => s.segmentName))}`);
|
|
193
241
|
for (const segment of affectedSegments) {
|
|
194
242
|
await this.#requestSchema(segment.segmentName);
|
|
195
243
|
}
|
|
@@ -199,50 +247,58 @@ export class VovkDev {
|
|
|
199
247
|
}
|
|
200
248
|
}
|
|
201
249
|
else {
|
|
202
|
-
log.debug(`The file does not contain any controller
|
|
250
|
+
log.debug(`The file ${filePath} does not contain any controller`);
|
|
203
251
|
}
|
|
204
252
|
};
|
|
205
253
|
#requestSchema = debounceWithArgs(async (segmentName) => {
|
|
206
|
-
const {
|
|
254
|
+
const { apiRoot, log, port, config } = this.#projectInfo;
|
|
207
255
|
const { devHttps } = config;
|
|
208
|
-
const endpoint = `${
|
|
256
|
+
const endpoint = `${apiRoot.startsWith(`http${devHttps ? 's' : ''}://`) ? apiRoot : `http${devHttps ? 's' : ''}://localhost:${port}${apiRoot}`}/${segmentName ? `${segmentName}/` : ''}_schema_`;
|
|
209
257
|
log.debug(`Requesting schema for ${formatLoggedSegmentName(segmentName)} at ${endpoint}`);
|
|
210
|
-
const resp = await fetch(endpoint);
|
|
211
|
-
if (resp.status !== 200) {
|
|
212
|
-
const probableCause = {
|
|
213
|
-
404: 'The segment is not compiled.',
|
|
214
|
-
}[resp.status];
|
|
215
|
-
log.warn(`Schema request to ${formatLoggedSegmentName(segmentName)} failed with status code ${resp.status} but expected 200.${probableCause ? ` Probable cause: ${probableCause}` : ''}`);
|
|
216
|
-
return;
|
|
217
|
-
}
|
|
218
|
-
let schema = null;
|
|
219
258
|
try {
|
|
220
|
-
|
|
259
|
+
const resp = await fetch(endpoint);
|
|
260
|
+
if (resp.status !== 200) {
|
|
261
|
+
const probableCause = {
|
|
262
|
+
404: 'The segment did not compile or config.origin is wrong.',
|
|
263
|
+
}[resp.status];
|
|
264
|
+
log.warn(`Schema request to ${formatLoggedSegmentName(segmentName)} failed with status code ${resp.status} but expected 200.${probableCause ? ` Probable cause: ${probableCause}` : ''}`);
|
|
265
|
+
return { isError: true };
|
|
266
|
+
}
|
|
267
|
+
let segmentSchema = null;
|
|
268
|
+
try {
|
|
269
|
+
({ schema: segmentSchema } = (await resp.json()));
|
|
270
|
+
}
|
|
271
|
+
catch (error) {
|
|
272
|
+
log.error(`Error parsing schema for ${formatLoggedSegmentName(segmentName)}: ${error?.message}`);
|
|
273
|
+
}
|
|
274
|
+
await this.#handleSegmentSchema(segmentName, segmentSchema);
|
|
221
275
|
}
|
|
222
276
|
catch (error) {
|
|
223
|
-
log.error(`Error
|
|
277
|
+
log.error(`Error requesting schema for ${formatLoggedSegmentName(segmentName)} at ${endpoint}: ${error?.message}`);
|
|
278
|
+
return { isError: true };
|
|
224
279
|
}
|
|
225
|
-
|
|
280
|
+
return { isError: false };
|
|
226
281
|
}, 500);
|
|
227
|
-
|
|
282
|
+
#generate = debounce(() => generate({ projectInfo: this.#projectInfo, fullSchema: this.#fullSchema, locatedSegments: this.#segments }).then(this.#onFirstTimeGenerate), 1000);
|
|
283
|
+
async #handleSegmentSchema(segmentName, segmentSchema) {
|
|
228
284
|
const { log, config, cwd } = this.#projectInfo;
|
|
229
|
-
if (!
|
|
230
|
-
log.warn(
|
|
285
|
+
if (!segmentSchema) {
|
|
286
|
+
log.warn(`${formatLoggedSegmentName(segmentName)} schema is null`);
|
|
231
287
|
return;
|
|
232
288
|
}
|
|
233
|
-
log.debug(`Handling received schema from ${formatLoggedSegmentName(
|
|
234
|
-
const schemaOutAbsolutePath = path.
|
|
235
|
-
const segment = this.#segments.find((s) => s.segmentName ===
|
|
289
|
+
log.debug(`Handling received schema from ${formatLoggedSegmentName(segmentName)}`);
|
|
290
|
+
const schemaOutAbsolutePath = path.resolve(cwd, this.#schemaOut ?? config.schemaOutDir);
|
|
291
|
+
const segment = this.#segments.find((s) => s.segmentName === segmentName);
|
|
236
292
|
if (!segment) {
|
|
237
|
-
log.warn(
|
|
293
|
+
log.warn(`${formatLoggedSegmentName(segmentName)} not found`);
|
|
238
294
|
return;
|
|
239
295
|
}
|
|
240
|
-
this.#
|
|
241
|
-
if (
|
|
296
|
+
this.#fullSchema.segments[segmentName] = segmentSchema;
|
|
297
|
+
if (segmentSchema.emitSchema) {
|
|
242
298
|
const now = Date.now();
|
|
243
|
-
const { diffResult } = await
|
|
299
|
+
const { diffResult } = await writeOneSegmentSchemaFile({
|
|
244
300
|
schemaOutAbsolutePath,
|
|
245
|
-
|
|
301
|
+
segmentSchema,
|
|
246
302
|
skipIfExists: false,
|
|
247
303
|
});
|
|
248
304
|
const timeTook = Date.now() - now;
|
|
@@ -251,17 +307,25 @@ export class VovkDev {
|
|
|
251
307
|
log.info(`Schema for ${formatLoggedSegmentName(segment.segmentName)} has been updated in ${timeTook}ms`);
|
|
252
308
|
}
|
|
253
309
|
}
|
|
254
|
-
else if (
|
|
255
|
-
log.error(`Non-empty schema provided for ${formatLoggedSegmentName(segment.segmentName)} but emitSchema is false`);
|
|
310
|
+
else if (segmentSchema && !isEmpty(segmentSchema.controllers)) {
|
|
311
|
+
log.error(`Non-empty schema provided for ${formatLoggedSegmentName(segment.segmentName)} but "emitSchema" is false`);
|
|
256
312
|
}
|
|
257
|
-
if (this.#segments.every((s) => this.#
|
|
313
|
+
if (this.#segments.every((s) => this.#fullSchema.segments[s.segmentName])) {
|
|
258
314
|
log.debug(`All segments with "emitSchema" have schema.`);
|
|
259
|
-
|
|
315
|
+
this.#generate();
|
|
260
316
|
}
|
|
261
317
|
}
|
|
262
|
-
async start() {
|
|
318
|
+
async start({ exit }) {
|
|
319
|
+
const now = Date.now();
|
|
263
320
|
this.#projectInfo = await getProjectInfo();
|
|
264
|
-
const { log, config, cwd,
|
|
321
|
+
const { log, config, cwd, apiDirAbsolutePath } = this.#projectInfo;
|
|
322
|
+
this.#segments = await locateSegments({ dir: apiDirAbsolutePath, config, log });
|
|
323
|
+
log.info('Starting...');
|
|
324
|
+
if (exit) {
|
|
325
|
+
this.#onFirstTimeGenerate = once(() => {
|
|
326
|
+
log.info('The schemas and the RPC client have been generated. Exiting...');
|
|
327
|
+
});
|
|
328
|
+
}
|
|
265
329
|
if (config.devHttps) {
|
|
266
330
|
const agent = new Agent({
|
|
267
331
|
connect: {
|
|
@@ -276,20 +340,49 @@ export class VovkDev {
|
|
|
276
340
|
process.on('unhandledRejection', (reason) => {
|
|
277
341
|
log.error(`Unhandled Rejection: ${String(reason)}`);
|
|
278
342
|
});
|
|
279
|
-
const
|
|
280
|
-
const
|
|
281
|
-
this.#
|
|
282
|
-
await
|
|
283
|
-
|
|
343
|
+
const schemaOutAbsolutePath = path.resolve(cwd, this.#schemaOut ?? config.schemaOutDir);
|
|
344
|
+
const segmentNames = this.#segments.map((s) => s.segmentName);
|
|
345
|
+
await ensureSchemaFiles(this.#projectInfo, schemaOutAbsolutePath, segmentNames);
|
|
346
|
+
await ensureClient(this.#projectInfo, this.#segments);
|
|
347
|
+
const MAX_ATTEMPTS = 5;
|
|
348
|
+
const DELAY = 5000;
|
|
349
|
+
// Request schema every segment in 5 seconds in order to update schema on start
|
|
284
350
|
setTimeout(() => {
|
|
285
351
|
for (const { segmentName } of this.#segments) {
|
|
286
|
-
|
|
352
|
+
let attempts = 0;
|
|
353
|
+
void this.#requestSchema(segmentName).then(({ isError }) => {
|
|
354
|
+
if (isError) {
|
|
355
|
+
const interval = setInterval(() => {
|
|
356
|
+
attempts++;
|
|
357
|
+
if (attempts >= MAX_ATTEMPTS) {
|
|
358
|
+
clearInterval(interval);
|
|
359
|
+
log.error(`Failed to request schema for ${formatLoggedSegmentName(segmentName)} after ${MAX_ATTEMPTS} attempts`);
|
|
360
|
+
return;
|
|
361
|
+
}
|
|
362
|
+
void this.#requestSchema(segmentName).then(({ isError: isError2 }) => {
|
|
363
|
+
if (!isError2) {
|
|
364
|
+
clearInterval(interval);
|
|
365
|
+
log.info(`Requested schema for ${formatLoggedSegmentName(segmentName)} after ${attempts} attempts`);
|
|
366
|
+
}
|
|
367
|
+
});
|
|
368
|
+
}, DELAY);
|
|
369
|
+
}
|
|
370
|
+
});
|
|
287
371
|
}
|
|
288
|
-
|
|
289
|
-
|
|
372
|
+
}, DELAY);
|
|
373
|
+
if (!exit) {
|
|
374
|
+
this.#watch(() => {
|
|
375
|
+
log.info(`Ready in ${Date.now() - now}ms. Making initial requests for schemas in a moment...`);
|
|
376
|
+
});
|
|
377
|
+
}
|
|
378
|
+
else {
|
|
379
|
+
log.info(`Ready in ${Date.now() - now}ms. Making requests for schemas in a moment...`);
|
|
380
|
+
}
|
|
290
381
|
}
|
|
291
382
|
}
|
|
292
383
|
const env = process.env;
|
|
293
384
|
if (env.__VOVK_START_WATCHER_IN_STANDALONE_MODE__ === 'true') {
|
|
294
|
-
void new VovkDev().start(
|
|
385
|
+
void new VovkDev({ schemaOut: env.__VOVK_SCHEMA_OUT_FLAG__ || undefined }).start({
|
|
386
|
+
exit: env.__VOVK_EXIT__ === 'true',
|
|
387
|
+
});
|
|
295
388
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import type { DiffResult } from './
|
|
1
|
+
import type { DiffResult } from './diffSegmentSchema.mjs';
|
|
2
2
|
import type { ProjectInfo } from '../getProjectInfo/index.mjs';
|
|
3
3
|
export default function logDiffResult(segmentName: string, diffResult: DiffResult, projectInfo: ProjectInfo): void;
|
|
@@ -3,23 +3,6 @@ import formatLoggedSegmentName from '../utils/formatLoggedSegmentName.mjs';
|
|
|
3
3
|
import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
|
|
4
4
|
export default function logDiffResult(segmentName, diffResult, projectInfo) {
|
|
5
5
|
const diffNormalized = [];
|
|
6
|
-
diffResult.workers.added.forEach((name) => {
|
|
7
|
-
diffNormalized.push({ what: 'worker', type: 'added', name });
|
|
8
|
-
});
|
|
9
|
-
diffResult.workers.removed.forEach((name) => {
|
|
10
|
-
diffNormalized.push({ what: 'worker', type: 'removed', name });
|
|
11
|
-
});
|
|
12
|
-
diffResult.workers.handlers.forEach((handler) => {
|
|
13
|
-
handler.added.forEach((name) => {
|
|
14
|
-
diffNormalized.push({ what: 'workerHandler', type: 'added', name: `${handler.nameOfClass}.${name}` });
|
|
15
|
-
});
|
|
16
|
-
handler.removed.forEach((name) => {
|
|
17
|
-
diffNormalized.push({ what: 'workerHandler', type: 'removed', name: `${handler.nameOfClass}.${name}` });
|
|
18
|
-
});
|
|
19
|
-
handler.changed.forEach((name) => {
|
|
20
|
-
diffNormalized.push({ what: 'workerHandler', type: 'changed', name: `${handler.nameOfClass}.${name}` });
|
|
21
|
-
});
|
|
22
|
-
});
|
|
23
6
|
diffResult.controllers.added.forEach((name) => {
|
|
24
7
|
diffNormalized.push({ what: 'controller', type: 'added', name });
|
|
25
8
|
});
|
|
@@ -37,52 +20,32 @@ export default function logDiffResult(segmentName, diffResult, projectInfo) {
|
|
|
37
20
|
diffNormalized.push({ what: 'controllerHandler', type: 'changed', name: `${handler.nameOfClass}.${name}` });
|
|
38
21
|
});
|
|
39
22
|
});
|
|
40
|
-
const LIMIT = diffNormalized.length <
|
|
23
|
+
const LIMIT = diffNormalized.length < 17 ? diffNormalized.length : 15;
|
|
41
24
|
const addedText = chalk.green('added');
|
|
42
25
|
const removedText = chalk.red('removed');
|
|
43
26
|
const changedText = chalk.cyan('changed');
|
|
44
27
|
for (const diffNormalizedItem of diffNormalized.slice(0, LIMIT)) {
|
|
45
28
|
switch (diffNormalizedItem.what) {
|
|
46
|
-
case 'worker':
|
|
47
|
-
switch (diffNormalizedItem.type) {
|
|
48
|
-
case 'added':
|
|
49
|
-
projectInfo.log.info(`Schema for worker ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
|
|
50
|
-
break;
|
|
51
|
-
case 'removed':
|
|
52
|
-
projectInfo.log.info(`Schema for worker ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
|
|
53
|
-
break;
|
|
54
|
-
}
|
|
55
|
-
break;
|
|
56
29
|
case 'controller':
|
|
57
30
|
switch (diffNormalizedItem.type) {
|
|
58
31
|
case 'added':
|
|
59
|
-
projectInfo.log.info(`Schema for
|
|
60
|
-
break;
|
|
61
|
-
case 'removed':
|
|
62
|
-
projectInfo.log.info(`Schema for controller ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
|
|
63
|
-
break;
|
|
64
|
-
}
|
|
65
|
-
break;
|
|
66
|
-
case 'workerHandler':
|
|
67
|
-
switch (diffNormalizedItem.type) {
|
|
68
|
-
case 'added':
|
|
69
|
-
projectInfo.log.info(`Schema for worker method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
|
|
32
|
+
projectInfo.log.info(`Schema for RPC module ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
|
|
70
33
|
break;
|
|
71
34
|
case 'removed':
|
|
72
|
-
projectInfo.log.info(`Schema for
|
|
35
|
+
projectInfo.log.info(`Schema for RPC module ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
|
|
73
36
|
break;
|
|
74
37
|
}
|
|
75
38
|
break;
|
|
76
39
|
case 'controllerHandler':
|
|
77
40
|
switch (diffNormalizedItem.type) {
|
|
78
41
|
case 'added':
|
|
79
|
-
projectInfo.log.info(`Schema for
|
|
42
|
+
projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${addedText} at ${formatLoggedSegmentName(segmentName)}`);
|
|
80
43
|
break;
|
|
81
44
|
case 'removed':
|
|
82
|
-
projectInfo.log.info(`Schema for
|
|
45
|
+
projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${removedText} from ${formatLoggedSegmentName(segmentName)}`);
|
|
83
46
|
break;
|
|
84
47
|
case 'changed':
|
|
85
|
-
projectInfo.log.info(`Schema for
|
|
48
|
+
projectInfo.log.info(`Schema for RPC method ${chalkHighlightThing(diffNormalizedItem.name)} has been ${changedText} at ${formatLoggedSegmentName(segmentName)}`);
|
|
86
49
|
break;
|
|
87
50
|
}
|
|
88
51
|
break;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import fs from 'node:fs/promises';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import pick from 'lodash/pick.js';
|
|
4
|
+
import { META_FILE_NAME } from './writeOneSegmentSchemaFile.mjs';
|
|
5
|
+
import chalkHighlightThing from '../utils/chalkHighlightThing.mjs';
|
|
6
|
+
export default async function writeMetaJson(schemaOutAbsolutePath, projectInfo) {
|
|
7
|
+
const metaJsonPath = path.join(schemaOutAbsolutePath, META_FILE_NAME + '.json');
|
|
8
|
+
const metaStr = JSON.stringify({ config: projectInfo ? pick(projectInfo.config, projectInfo.config.emitConfig) : {} }, null, 2);
|
|
9
|
+
const existingStr = await fs.readFile(metaJsonPath, 'utf-8').catch(() => null);
|
|
10
|
+
if (existingStr !== metaStr) {
|
|
11
|
+
await fs.writeFile(metaJsonPath, metaStr);
|
|
12
|
+
projectInfo?.log.info(`Meta JSON is written to ${chalkHighlightThing(metaJsonPath)}`);
|
|
13
|
+
}
|
|
14
|
+
else {
|
|
15
|
+
projectInfo?.log.debug(`Meta JSON is up to date at ${chalkHighlightThing(metaJsonPath)}`);
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { VovkSegmentSchema } from 'vovk';
|
|
2
|
+
import { type DiffResult } from './diffSegmentSchema.mjs';
|
|
3
|
+
export declare const ROOT_SEGMENT_FILE_NAME = "root";
|
|
4
|
+
export declare const META_FILE_NAME = "_meta";
|
|
5
|
+
export default function writeOneSegmentSchemaFile({ schemaOutAbsolutePath, segmentSchema, skipIfExists, }: {
|
|
6
|
+
schemaOutAbsolutePath: string;
|
|
7
|
+
segmentSchema: VovkSegmentSchema;
|
|
8
|
+
skipIfExists?: boolean;
|
|
9
|
+
}): Promise<{
|
|
10
|
+
isCreated: boolean;
|
|
11
|
+
diffResult: DiffResult | null;
|
|
12
|
+
}>;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import path from 'node:path';
|
|
2
2
|
import fs from 'node:fs/promises';
|
|
3
|
-
import
|
|
3
|
+
import diffSegmentSchema from './diffSegmentSchema.mjs';
|
|
4
4
|
import getFileSystemEntryType from '../utils/getFileSystemEntryType.mjs';
|
|
5
|
-
export const
|
|
6
|
-
export
|
|
7
|
-
|
|
5
|
+
export const ROOT_SEGMENT_FILE_NAME = 'root';
|
|
6
|
+
export const META_FILE_NAME = '_meta';
|
|
7
|
+
export default async function writeOneSegmentSchemaFile({ schemaOutAbsolutePath, segmentSchema, skipIfExists = false, }) {
|
|
8
|
+
const segmentPath = path.join(schemaOutAbsolutePath, `${segmentSchema.segmentName || ROOT_SEGMENT_FILE_NAME}.json`);
|
|
8
9
|
if (skipIfExists && (await getFileSystemEntryType(segmentPath))) {
|
|
9
10
|
try {
|
|
10
11
|
await fs.stat(segmentPath);
|
|
@@ -15,14 +16,17 @@ export default async function writeOneSchemaFile({ schemaOutAbsolutePath, schema
|
|
|
15
16
|
}
|
|
16
17
|
}
|
|
17
18
|
await fs.mkdir(path.dirname(segmentPath), { recursive: true });
|
|
18
|
-
const schemaStr = JSON.stringify(
|
|
19
|
+
const schemaStr = JSON.stringify(segmentSchema, null, 2);
|
|
19
20
|
const existing = await fs.readFile(segmentPath, 'utf-8').catch(() => null);
|
|
20
21
|
if (existing === schemaStr) {
|
|
21
22
|
return { isCreated: false, diffResult: null };
|
|
22
23
|
}
|
|
23
24
|
await fs.writeFile(segmentPath, schemaStr);
|
|
24
25
|
if (existing) {
|
|
25
|
-
return {
|
|
26
|
+
return {
|
|
27
|
+
isCreated: false,
|
|
28
|
+
diffResult: diffSegmentSchema(JSON.parse(existing), segmentSchema),
|
|
29
|
+
};
|
|
26
30
|
}
|
|
27
31
|
return { isCreated: true, diffResult: null };
|
|
28
32
|
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { VovkSchemaIdEnum } from 'vovk';
|
|
2
|
+
import { generate } from './generate.mjs';
|
|
3
|
+
const getEmptySegmentRecordSchema = (segmentNames) => {
|
|
4
|
+
const result = {};
|
|
5
|
+
for (const segmentName of segmentNames) {
|
|
6
|
+
result[segmentName] = {
|
|
7
|
+
$schema: VovkSchemaIdEnum.SEGMENT,
|
|
8
|
+
segmentName,
|
|
9
|
+
segmentType: 'segment',
|
|
10
|
+
emitSchema: false,
|
|
11
|
+
controllers: {},
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
return result;
|
|
15
|
+
};
|
|
16
|
+
export default async function ensureClient(projectInfo, locatedSegments) {
|
|
17
|
+
return generate({
|
|
18
|
+
isEnsuringClient: true,
|
|
19
|
+
projectInfo,
|
|
20
|
+
fullSchema: {
|
|
21
|
+
$schema: VovkSchemaIdEnum.SCHEMA,
|
|
22
|
+
segments: getEmptySegmentRecordSchema(locatedSegments.map(({ segmentName }) => segmentName)),
|
|
23
|
+
meta: {
|
|
24
|
+
$schema: VovkSchemaIdEnum.META,
|
|
25
|
+
config: {
|
|
26
|
+
$schema: VovkSchemaIdEnum.CONFIG,
|
|
27
|
+
},
|
|
28
|
+
},
|
|
29
|
+
},
|
|
30
|
+
locatedSegments,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { type VovkSchema, type VovkStrictConfig } from 'vovk';
|
|
2
|
+
import type { PackageJson } from 'type-fest';
|
|
3
|
+
import type { ProjectInfo } from '../getProjectInfo/index.mjs';
|
|
4
|
+
import type { GenerateOptions } from '../types.mjs';
|
|
5
|
+
import type { Segment } from '../locateSegments.mjs';
|
|
6
|
+
export declare function generate({ isEnsuringClient, projectInfo, forceNothingWrittenLog, fullSchema, locatedSegments, cliGenerateOptions, package: argPackageJson, readme: argReadme, }: {
|
|
7
|
+
isEnsuringClient?: boolean;
|
|
8
|
+
projectInfo: ProjectInfo;
|
|
9
|
+
forceNothingWrittenLog?: boolean;
|
|
10
|
+
fullSchema: VovkSchema;
|
|
11
|
+
locatedSegments: Segment[];
|
|
12
|
+
cliGenerateOptions?: GenerateOptions;
|
|
13
|
+
package?: PackageJson;
|
|
14
|
+
readme?: VovkStrictConfig['bundle']['readme'];
|
|
15
|
+
}): Promise<void>;
|