@bleedingdev/modern-js-plugin-bff-extensions 3.9.0-ultramodern.11 → 3.9.0-ultramodern.13
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/README.md +3 -3
- package/dist/cjs/backend-federation/identity.js +23 -22
- package/dist/cjs/backend-federation/node-evaluator.js +48 -0
- package/dist/cjs/backend-federation/node.js +2 -2
- package/dist/cjs/backend-federation-manifest/node.js +2 -2
- package/dist/cjs/backend-federation-manifest/validation.js +11 -7
- package/dist/cjs/cross-project-policy/node.js +8 -28
- package/dist/cjs/{effect-adapter → effect-server}/cross-project-policy.js +5 -5
- package/dist/cjs/effect-server/entry.js +63 -0
- package/dist/cjs/{effect-adapter → effect-server}/error-response.js +4 -4
- package/dist/cjs/effect-server/index.js +199 -0
- package/dist/cjs/effect-source-loader/built-entry.js +4 -5
- package/dist/cjs/effect-source-loader/loader.js +2 -1
- package/dist/cjs/effect-source-loader/operation-contracts.js +8 -31
- package/dist/cjs/effect-source-loader/paths.js +38 -10
- package/dist/esm/backend-federation/identity.mjs +18 -23
- package/dist/esm/backend-federation/node-evaluator.mjs +7 -0
- package/dist/esm/backend-federation/node.mjs +2 -2
- package/dist/esm/backend-federation-manifest/node.mjs +2 -2
- package/dist/esm/backend-federation-manifest/validation.mjs +12 -8
- package/dist/esm/cross-project-policy/node.mjs +9 -19
- package/dist/esm/{effect-adapter → effect-server}/cross-project-policy.mjs +3 -3
- package/dist/esm/effect-server/entry.mjs +15 -0
- package/dist/esm/{effect-adapter → effect-server}/error-response.mjs +2 -2
- package/dist/esm/effect-server/index.mjs +151 -0
- package/dist/esm/effect-source-loader/built-entry.mjs +5 -6
- package/dist/esm/effect-source-loader/loader.mjs +2 -1
- package/dist/esm/effect-source-loader/operation-contracts.mjs +10 -33
- package/dist/esm/effect-source-loader/paths.mjs +30 -11
- package/dist/esm-node/backend-federation/identity.mjs +18 -23
- package/dist/esm-node/backend-federation/node-evaluator.mjs +8 -0
- package/dist/esm-node/backend-federation/node.mjs +2 -2
- package/dist/esm-node/backend-federation-manifest/node.mjs +2 -2
- package/dist/esm-node/backend-federation-manifest/validation.mjs +12 -8
- package/dist/esm-node/cross-project-policy/node.mjs +9 -19
- package/dist/esm-node/{effect-adapter → effect-server}/cross-project-policy.mjs +3 -3
- package/dist/esm-node/effect-server/entry.mjs +16 -0
- package/dist/esm-node/{effect-adapter → effect-server}/error-response.mjs +2 -2
- package/dist/esm-node/effect-server/index.mjs +152 -0
- package/dist/esm-node/effect-source-loader/built-entry.mjs +5 -6
- package/dist/esm-node/effect-source-loader/loader.mjs +2 -1
- package/dist/esm-node/effect-source-loader/operation-contracts.mjs +10 -33
- package/dist/esm-node/effect-source-loader/paths.mjs +30 -11
- package/dist/types/backend-federation/identity.d.ts +3 -6
- package/dist/types/backend-federation/node-evaluator.d.ts +2 -0
- package/dist/types/cross-project-policy/node.d.ts +2 -2
- package/dist/types/effect-server/cross-project-policy.d.ts +5 -0
- package/dist/types/{effect-adapter → effect-server}/entry.d.ts +1 -1
- package/dist/types/effect-server/error-response.d.ts +2 -0
- package/dist/types/effect-server/index.d.ts +4 -0
- package/dist/types/effect-source-loader/paths.d.ts +20 -2
- package/package.json +27 -27
- package/src/backend-federation/identity.ts +39 -47
- package/src/backend-federation/node-evaluator.ts +13 -0
- package/src/backend-federation/node.ts +2 -3
- package/src/backend-federation-manifest/node.ts +2 -3
- package/src/backend-federation-manifest/validation.ts +22 -29
- package/src/cross-project-policy/node.ts +7 -38
- package/src/{effect-adapter → effect-server}/cross-project-policy.ts +8 -2
- package/src/effect-server/entry.ts +18 -0
- package/src/{effect-adapter → effect-server}/error-response.ts +1 -1
- package/src/effect-server/index.ts +242 -0
- package/src/effect-source-loader/built-entry.ts +11 -9
- package/src/effect-source-loader/loader.ts +10 -5
- package/src/effect-source-loader/operation-contracts.ts +7 -41
- package/src/effect-source-loader/paths.ts +55 -21
- package/dist/cjs/effect-adapter/entry.js +0 -99
- package/dist/cjs/effect-adapter/index.js +0 -194
- package/dist/esm/effect-adapter/entry.mjs +0 -51
- package/dist/esm/effect-adapter/index.mjs +0 -143
- package/dist/esm-node/effect-adapter/entry.mjs +0 -52
- package/dist/esm-node/effect-adapter/index.mjs +0 -144
- package/dist/types/effect-adapter/cross-project-policy.d.ts +0 -4
- package/dist/types/effect-adapter/error-response.d.ts +0 -2
- package/dist/types/effect-adapter/index.d.ts +0 -21
- package/src/effect-adapter/entry.ts +0 -96
- package/src/effect-adapter/index.ts +0 -251
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
// @effect-diagnostics nodeBuiltinImport:off strictBooleanExpressions:off
|
|
2
|
-
|
|
3
|
-
import path from 'node:path';
|
|
4
|
-
import '@modern-js/server-runtime-extensions/server-config';
|
|
5
|
-
import type { ServerPluginAPI } from '@modern-js/server-core';
|
|
6
|
-
import { API_DIR, findExists, fs, isProd } from '@modern-js/utils';
|
|
7
|
-
|
|
8
|
-
const JS_OR_TS_EXTS = [
|
|
9
|
-
'.js',
|
|
10
|
-
'.jsx',
|
|
11
|
-
'.ts',
|
|
12
|
-
'.tsx',
|
|
13
|
-
'.mjs',
|
|
14
|
-
'.mts',
|
|
15
|
-
'.cjs',
|
|
16
|
-
'.cts',
|
|
17
|
-
] as const;
|
|
18
|
-
|
|
19
|
-
type JsOrTsExtension = (typeof JS_OR_TS_EXTS)[number];
|
|
20
|
-
|
|
21
|
-
function resolveJsOrTsEntry(entryWithoutOrWithExt: string) {
|
|
22
|
-
const extension = path.extname(entryWithoutOrWithExt) as JsOrTsExtension;
|
|
23
|
-
if (JS_OR_TS_EXTS.includes(extension)) {
|
|
24
|
-
return fs.existsSync(entryWithoutOrWithExt)
|
|
25
|
-
? entryWithoutOrWithExt
|
|
26
|
-
: undefined;
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
return (
|
|
30
|
-
findExists(JS_OR_TS_EXTS.map(ext => `${entryWithoutOrWithExt}${ext}`)) ||
|
|
31
|
-
undefined
|
|
32
|
-
);
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
function builtEntryPath(entryPath: string) {
|
|
36
|
-
return entryPath.replace(/\.(?:[cm]?ts|tsx|jsx)$/u, '.js');
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
function relativeAppPath(appDirectory: string, entryPath: string) {
|
|
40
|
-
const relativePath = path.relative(appDirectory, entryPath);
|
|
41
|
-
return relativePath === '..' || relativePath.startsWith(`..${path.sep}`)
|
|
42
|
-
? undefined
|
|
43
|
-
: relativePath;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
function isDependencyPath(relativePath: string | undefined) {
|
|
47
|
-
return relativePath?.split(/[\\/]/u).includes('node_modules') ?? false;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
export function resolveEffectAdapterEntryFile(api: ServerPluginAPI) {
|
|
51
|
-
const { appDirectory, apiDirectory, distDirectory } = api.getServerContext();
|
|
52
|
-
const appRoot = path.resolve(appDirectory || process.cwd());
|
|
53
|
-
const productionRoot =
|
|
54
|
-
isProd() && distDirectory ? path.resolve(distDirectory) : undefined;
|
|
55
|
-
const configuredEntry = api.getServerConfig()?.bff?.effect?.entry;
|
|
56
|
-
|
|
57
|
-
if (configuredEntry) {
|
|
58
|
-
const sourceEntry = path.isAbsolute(configuredEntry)
|
|
59
|
-
? configuredEntry
|
|
60
|
-
: path.resolve(appRoot, configuredEntry);
|
|
61
|
-
if (productionRoot) {
|
|
62
|
-
const relativeEntry = relativeAppPath(appRoot, sourceEntry);
|
|
63
|
-
if (relativeEntry === undefined || isDependencyPath(relativeEntry)) {
|
|
64
|
-
return resolveJsOrTsEntry(sourceEntry);
|
|
65
|
-
}
|
|
66
|
-
return relativeEntry
|
|
67
|
-
? resolveJsOrTsEntry(
|
|
68
|
-
builtEntryPath(path.resolve(productionRoot, relativeEntry)),
|
|
69
|
-
)
|
|
70
|
-
: undefined;
|
|
71
|
-
}
|
|
72
|
-
return resolveJsOrTsEntry(sourceEntry);
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
const resolvedApiDirectory = path.resolve(appRoot, apiDirectory || API_DIR);
|
|
76
|
-
const productionApiDirectory = productionRoot
|
|
77
|
-
? relativeAppPath(productionRoot, resolvedApiDirectory) !== undefined
|
|
78
|
-
? resolvedApiDirectory
|
|
79
|
-
: (() => {
|
|
80
|
-
const relativeApiDirectory = relativeAppPath(
|
|
81
|
-
appRoot,
|
|
82
|
-
resolvedApiDirectory,
|
|
83
|
-
);
|
|
84
|
-
if (isDependencyPath(relativeApiDirectory)) {
|
|
85
|
-
return resolvedApiDirectory;
|
|
86
|
-
}
|
|
87
|
-
return relativeApiDirectory
|
|
88
|
-
? path.resolve(productionRoot, relativeApiDirectory)
|
|
89
|
-
: undefined;
|
|
90
|
-
})()
|
|
91
|
-
: resolvedApiDirectory;
|
|
92
|
-
|
|
93
|
-
return productionApiDirectory
|
|
94
|
-
? resolveJsOrTsEntry(path.resolve(productionApiDirectory, 'index'))
|
|
95
|
-
: undefined;
|
|
96
|
-
}
|
|
@@ -1,251 +0,0 @@
|
|
|
1
|
-
// @effect-diagnostics anyUnknownInErrorContext:off asyncFunction:off nodeBuiltinImport:off strictBooleanExpressions:off
|
|
2
|
-
|
|
3
|
-
import path from 'node:path';
|
|
4
|
-
import '@modern-js/server-runtime-extensions/server-config';
|
|
5
|
-
import {
|
|
6
|
-
dispatchEffectBffRequest,
|
|
7
|
-
type EffectApiModule,
|
|
8
|
-
type EffectBffRequestHandler,
|
|
9
|
-
resolveEffectBffModuleHandler,
|
|
10
|
-
useEffectContext,
|
|
11
|
-
} from '@modern-js/bff-effect/effect';
|
|
12
|
-
import type { Context, Next, ServerPluginAPI } from '@modern-js/server-core';
|
|
13
|
-
import {
|
|
14
|
-
createDisposableServerRuntimeHandle,
|
|
15
|
-
type DisposableServerRuntimeHandle,
|
|
16
|
-
registerServerRuntimeDisposer,
|
|
17
|
-
} from '@modern-js/server-runtime-extensions/runtime-lifecycle';
|
|
18
|
-
import { fs, isProd, logger } from '@modern-js/utils';
|
|
19
|
-
|
|
20
|
-
import { checkCrossProjectPolicyForRequest } from '../cross-project-policy/evaluation';
|
|
21
|
-
import {
|
|
22
|
-
loadEffectBuiltModule,
|
|
23
|
-
loadEffectSourceModule,
|
|
24
|
-
} from '../effect-source-loader/loader';
|
|
25
|
-
import { resolveEffectAdapterCrossProjectPolicy } from './cross-project-policy';
|
|
26
|
-
import { resolveEffectAdapterEntryFile } from './entry';
|
|
27
|
-
import { createEffectAdapterRuntimeErrorResponse } from './error-response';
|
|
28
|
-
|
|
29
|
-
const EFFECT_MIDDLEWARE_BEFORE = [
|
|
30
|
-
'custom-server-hook',
|
|
31
|
-
'custom-server-middleware',
|
|
32
|
-
'render',
|
|
33
|
-
];
|
|
34
|
-
|
|
35
|
-
interface EffectAdapterMiddlewareOptions {
|
|
36
|
-
prefix: string | readonly string[];
|
|
37
|
-
enableHandleWeb?: boolean;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
export class EffectAdapter {
|
|
41
|
-
private api: ServerPluginAPI;
|
|
42
|
-
|
|
43
|
-
private handler: DisposableServerRuntimeHandle | null = null;
|
|
44
|
-
private unregisterRuntimeDisposer?: () => void;
|
|
45
|
-
private prefix = '/api';
|
|
46
|
-
private prefixes = ['/api'];
|
|
47
|
-
private matchingPrefixes = ['/api'];
|
|
48
|
-
private retired = false;
|
|
49
|
-
|
|
50
|
-
constructor(api: ServerPluginAPI) {
|
|
51
|
-
this.api = api;
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
registerMiddleware = async (options: EffectAdapterMiddlewareOptions) => {
|
|
55
|
-
const { enableHandleWeb } = options;
|
|
56
|
-
const { bffRuntimeFramework, middlewares: globalMiddlewares } =
|
|
57
|
-
this.api.getServerContext();
|
|
58
|
-
|
|
59
|
-
if (bffRuntimeFramework === 'hono') {
|
|
60
|
-
return;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
const configuredPrefixes = Array.isArray(options.prefix)
|
|
64
|
-
? options.prefix.filter(Boolean)
|
|
65
|
-
: [options.prefix || '/api'];
|
|
66
|
-
this.prefixes = [
|
|
67
|
-
...new Set(configuredPrefixes.length > 0 ? configuredPrefixes : ['/api']),
|
|
68
|
-
];
|
|
69
|
-
this.matchingPrefixes = [...this.prefixes].sort(
|
|
70
|
-
(left, right) => right.length - left.length,
|
|
71
|
-
);
|
|
72
|
-
this.prefix = this.prefixes[0] || '/api';
|
|
73
|
-
const { serverBase } = this.api.getServerContext() as {
|
|
74
|
-
serverBase?: object;
|
|
75
|
-
};
|
|
76
|
-
if (serverBase) {
|
|
77
|
-
this.unregisterRuntimeDisposer = registerServerRuntimeDisposer(
|
|
78
|
-
serverBase,
|
|
79
|
-
this.dispose,
|
|
80
|
-
);
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
try {
|
|
84
|
-
await this.loadHandler();
|
|
85
|
-
} catch (error) {
|
|
86
|
-
await this.dispose();
|
|
87
|
-
throw error;
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
const middlewarePrefixes = enableHandleWeb
|
|
91
|
-
? [this.prefix]
|
|
92
|
-
: this.matchingPrefixes;
|
|
93
|
-
const middlewares = middlewarePrefixes.map(middlewarePrefix => ({
|
|
94
|
-
name: 'effect-api-handler',
|
|
95
|
-
path: enableHandleWeb ? '*' : `${middlewarePrefix}/*`,
|
|
96
|
-
method: 'all' as const,
|
|
97
|
-
order: 'post' as const,
|
|
98
|
-
before: EFFECT_MIDDLEWARE_BEFORE,
|
|
99
|
-
handler: async (context: Context, next: Next) => {
|
|
100
|
-
const handler = this.handler;
|
|
101
|
-
if (!handler) {
|
|
102
|
-
if (enableHandleWeb) {
|
|
103
|
-
await next();
|
|
104
|
-
return;
|
|
105
|
-
}
|
|
106
|
-
return createEffectAdapterRuntimeErrorResponse(
|
|
107
|
-
this.api,
|
|
108
|
-
new Error(
|
|
109
|
-
'[BFF][Effect] Missing Effect entry. Define api/index or configure bff.effect.entry.',
|
|
110
|
-
),
|
|
111
|
-
context,
|
|
112
|
-
);
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
const prefix = enableHandleWeb
|
|
116
|
-
? this.matchingPrefixes.find(
|
|
117
|
-
item =>
|
|
118
|
-
item === '/' ||
|
|
119
|
-
context.req.path === item ||
|
|
120
|
-
context.req.path.startsWith(`${item}/`),
|
|
121
|
-
) || this.prefix
|
|
122
|
-
: middlewarePrefix;
|
|
123
|
-
const response = await dispatchEffectBffRequest(
|
|
124
|
-
handler as EffectBffRequestHandler,
|
|
125
|
-
context.req.raw,
|
|
126
|
-
{
|
|
127
|
-
prefix,
|
|
128
|
-
env: context.env as Record<string, unknown>,
|
|
129
|
-
path: context.req.path,
|
|
130
|
-
method: context.req.method,
|
|
131
|
-
onError: error =>
|
|
132
|
-
createEffectAdapterRuntimeErrorResponse(this.api, error, context),
|
|
133
|
-
},
|
|
134
|
-
);
|
|
135
|
-
|
|
136
|
-
if (response.status === 404 && enableHandleWeb) {
|
|
137
|
-
await next();
|
|
138
|
-
return;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
return new Response(response.body, response);
|
|
142
|
-
},
|
|
143
|
-
}));
|
|
144
|
-
|
|
145
|
-
globalMiddlewares.push(...middlewares);
|
|
146
|
-
};
|
|
147
|
-
|
|
148
|
-
dispose = async () => {
|
|
149
|
-
this.retired = true;
|
|
150
|
-
this.unregisterRuntimeDisposer?.();
|
|
151
|
-
this.unregisterRuntimeDisposer = undefined;
|
|
152
|
-
const previous = this.handler;
|
|
153
|
-
this.handler = null;
|
|
154
|
-
await previous?.dispose();
|
|
155
|
-
};
|
|
156
|
-
|
|
157
|
-
private async loadHandler() {
|
|
158
|
-
const entryFile = resolveEffectAdapterEntryFile(this.api);
|
|
159
|
-
if (!entryFile || !(await fs.pathExists(entryFile))) {
|
|
160
|
-
this.handler = null;
|
|
161
|
-
return;
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
let mod: EffectApiModule;
|
|
165
|
-
try {
|
|
166
|
-
const { appDirectory } = this.api.getServerContext();
|
|
167
|
-
mod = (await (isProd()
|
|
168
|
-
? loadEffectBuiltModule(entryFile)
|
|
169
|
-
: loadEffectSourceModule({
|
|
170
|
-
resourcePath: entryFile,
|
|
171
|
-
appDir: appDirectory || path.dirname(entryFile),
|
|
172
|
-
}))) as EffectApiModule;
|
|
173
|
-
} catch (error) {
|
|
174
|
-
logger.error(
|
|
175
|
-
`[BFF][Effect] Failed to load Effect entry: ${entryFile}\n${String(error)}`,
|
|
176
|
-
);
|
|
177
|
-
throw error;
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
const crossProjectPolicies = new Map(
|
|
181
|
-
await Promise.all(
|
|
182
|
-
this.prefixes.map(
|
|
183
|
-
async prefix =>
|
|
184
|
-
[
|
|
185
|
-
prefix,
|
|
186
|
-
await resolveEffectAdapterCrossProjectPolicy(
|
|
187
|
-
this.api,
|
|
188
|
-
prefix,
|
|
189
|
-
mod,
|
|
190
|
-
),
|
|
191
|
-
] as const,
|
|
192
|
-
),
|
|
193
|
-
),
|
|
194
|
-
);
|
|
195
|
-
const effectConfig = this.api.getServerConfig()?.bff?.effect;
|
|
196
|
-
const loaded = await resolveEffectBffModuleHandler(mod, {
|
|
197
|
-
openapi: effectConfig?.openapi,
|
|
198
|
-
dataPlatform: effectConfig?.dataPlatform,
|
|
199
|
-
validateRequest: request => {
|
|
200
|
-
const { path: mountedPathname } = useEffectContext();
|
|
201
|
-
const prefix = this.matchingPrefixes.find(
|
|
202
|
-
item =>
|
|
203
|
-
item === '/' ||
|
|
204
|
-
mountedPathname === item ||
|
|
205
|
-
mountedPathname.startsWith(`${item}/`),
|
|
206
|
-
);
|
|
207
|
-
if (!prefix) {
|
|
208
|
-
return null;
|
|
209
|
-
}
|
|
210
|
-
const requestUrl = new URL(request.url);
|
|
211
|
-
if (prefix !== '/') {
|
|
212
|
-
requestUrl.pathname =
|
|
213
|
-
requestUrl.pathname === '/'
|
|
214
|
-
? prefix
|
|
215
|
-
: `${prefix}${requestUrl.pathname}`;
|
|
216
|
-
}
|
|
217
|
-
return checkCrossProjectPolicyForRequest(
|
|
218
|
-
new Request(requestUrl, request),
|
|
219
|
-
crossProjectPolicies.get(prefix),
|
|
220
|
-
);
|
|
221
|
-
},
|
|
222
|
-
onWarning: message => logger.warn(message),
|
|
223
|
-
});
|
|
224
|
-
|
|
225
|
-
if (!loaded) {
|
|
226
|
-
const error = new Error(
|
|
227
|
-
`[BFF][Effect] Invalid Effect entry module: ${entryFile}. Export defineEffectBff(...) or a { api, layer } HttpApi module.`,
|
|
228
|
-
);
|
|
229
|
-
logger.warn(error.message);
|
|
230
|
-
throw error;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
const candidateOwner = {};
|
|
234
|
-
if (loaded.dispose) {
|
|
235
|
-
registerServerRuntimeDisposer(candidateOwner, loaded.dispose);
|
|
236
|
-
}
|
|
237
|
-
const candidate = createDisposableServerRuntimeHandle(
|
|
238
|
-
candidateOwner,
|
|
239
|
-
loaded.handler,
|
|
240
|
-
);
|
|
241
|
-
if (this.retired) {
|
|
242
|
-
await candidate.dispose();
|
|
243
|
-
throw new Error('Cannot initialize a retired Effect adapter.');
|
|
244
|
-
}
|
|
245
|
-
this.handler = candidate;
|
|
246
|
-
}
|
|
247
|
-
}
|
|
248
|
-
|
|
249
|
-
export const createRuntimeAdapters = (api: ServerPluginAPI) => [
|
|
250
|
-
new EffectAdapter(api),
|
|
251
|
-
];
|