@bleedingdev/modern-js-plugin-bff-extensions 3.9.0-ultramodern.8 → 3.9.3-ultramodern.1

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.
Files changed (120) hide show
  1. package/README.md +21 -4
  2. package/dist/cjs/backend-federation/edge.js +1 -1
  3. package/dist/cjs/backend-federation/identity.js +23 -22
  4. package/dist/cjs/backend-federation/integrity-plugin.js +112 -0
  5. package/dist/cjs/backend-federation/node-shared.js +85 -0
  6. package/dist/cjs/backend-federation/node.js +6 -1
  7. package/dist/cjs/backend-federation/plugin.js +40 -21
  8. package/dist/cjs/backend-federation/runtime.js +16 -84
  9. package/dist/cjs/backend-federation-manifest/load.js +31 -5
  10. package/dist/cjs/backend-federation-manifest/node.js +3 -1
  11. package/dist/cjs/backend-federation-manifest/remote.js +1 -7
  12. package/dist/cjs/backend-federation-manifest/validation.js +11 -7
  13. package/dist/cjs/cross-project-policy/node.js +8 -28
  14. package/dist/cjs/{effect-adapter → effect-server}/cross-project-policy.js +9 -9
  15. package/dist/cjs/effect-server/entry.js +63 -0
  16. package/dist/cjs/{effect-adapter → effect-server}/error-response.js +4 -4
  17. package/dist/cjs/effect-server/index.js +199 -0
  18. package/dist/cjs/effect-source-loader/built-entry.js +4 -5
  19. package/dist/cjs/effect-source-loader/http-api-runtime.js +4 -4
  20. package/dist/cjs/effect-source-loader/loader.js +8 -2
  21. package/dist/cjs/effect-source-loader/operation-contracts.js +8 -31
  22. package/dist/cjs/effect-source-loader/paths.js +38 -10
  23. package/dist/esm/backend-federation/edge.mjs +1 -1
  24. package/dist/esm/backend-federation/identity.mjs +18 -23
  25. package/dist/esm/backend-federation/integrity-plugin.mjs +68 -0
  26. package/dist/esm/backend-federation/node-shared.mjs +41 -0
  27. package/dist/esm/backend-federation/node.mjs +4 -2
  28. package/dist/esm/backend-federation/plugin.mjs +37 -18
  29. package/dist/esm/backend-federation/runtime.mjs +16 -84
  30. package/dist/esm/backend-federation-manifest/load.mjs +31 -5
  31. package/dist/esm/backend-federation-manifest/node.mjs +3 -1
  32. package/dist/esm/backend-federation-manifest/remote.mjs +1 -7
  33. package/dist/esm/backend-federation-manifest/validation.mjs +12 -8
  34. package/dist/esm/cross-project-policy/node.mjs +9 -19
  35. package/dist/esm/{effect-adapter → effect-server}/cross-project-policy.mjs +4 -4
  36. package/dist/esm/effect-server/entry.mjs +15 -0
  37. package/dist/esm/{effect-adapter → effect-server}/error-response.mjs +2 -2
  38. package/dist/esm/effect-server/index.mjs +151 -0
  39. package/dist/esm/effect-source-loader/built-entry.mjs +5 -6
  40. package/dist/esm/effect-source-loader/http-api-runtime.mjs +1 -1
  41. package/dist/esm/effect-source-loader/loader.mjs +8 -2
  42. package/dist/esm/effect-source-loader/operation-contracts.mjs +10 -33
  43. package/dist/esm/effect-source-loader/paths.mjs +30 -11
  44. package/dist/esm-node/backend-federation/edge.mjs +1 -1
  45. package/dist/esm-node/backend-federation/identity.mjs +18 -23
  46. package/dist/esm-node/backend-federation/integrity-plugin.mjs +69 -0
  47. package/dist/esm-node/backend-federation/node-shared.mjs +42 -0
  48. package/dist/esm-node/backend-federation/node.mjs +4 -2
  49. package/dist/esm-node/backend-federation/plugin.mjs +37 -18
  50. package/dist/esm-node/backend-federation/runtime.mjs +16 -84
  51. package/dist/esm-node/backend-federation-manifest/load.mjs +31 -5
  52. package/dist/esm-node/backend-federation-manifest/node.mjs +3 -1
  53. package/dist/esm-node/backend-federation-manifest/remote.mjs +1 -7
  54. package/dist/esm-node/backend-federation-manifest/validation.mjs +12 -8
  55. package/dist/esm-node/cross-project-policy/node.mjs +9 -19
  56. package/dist/esm-node/{effect-adapter → effect-server}/cross-project-policy.mjs +4 -4
  57. package/dist/esm-node/effect-server/entry.mjs +16 -0
  58. package/dist/esm-node/{effect-adapter → effect-server}/error-response.mjs +2 -2
  59. package/dist/esm-node/effect-server/index.mjs +152 -0
  60. package/dist/esm-node/effect-source-loader/built-entry.mjs +5 -6
  61. package/dist/esm-node/effect-source-loader/http-api-runtime.mjs +1 -1
  62. package/dist/esm-node/effect-source-loader/loader.mjs +8 -2
  63. package/dist/esm-node/effect-source-loader/operation-contracts.mjs +10 -33
  64. package/dist/esm-node/effect-source-loader/paths.mjs +30 -11
  65. package/dist/types/backend-federation/edge.d.ts +4 -2
  66. package/dist/types/backend-federation/identity.d.ts +3 -6
  67. package/dist/types/backend-federation/integrity-plugin.d.ts +13 -0
  68. package/dist/types/backend-federation/node-shared.d.ts +20 -0
  69. package/dist/types/backend-federation/node.d.ts +3 -0
  70. package/dist/types/backend-federation/plugin.d.ts +4 -0
  71. package/dist/types/backend-federation/types.d.ts +2 -7
  72. package/dist/types/backend-federation-manifest/types.d.ts +2 -1
  73. package/dist/types/cross-project-policy/node.d.ts +2 -2
  74. package/dist/types/effect-server/cross-project-policy.d.ts +5 -0
  75. package/dist/types/{effect-adapter → effect-server}/entry.d.ts +1 -1
  76. package/dist/types/effect-server/error-response.d.ts +2 -0
  77. package/dist/types/effect-server/index.d.ts +4 -0
  78. package/dist/types/effect-source-loader/paths.d.ts +20 -2
  79. package/package.json +35 -33
  80. package/src/backend-federation/edge.ts +7 -4
  81. package/src/backend-federation/identity.ts +39 -47
  82. package/src/backend-federation/integrity-plugin.ts +157 -0
  83. package/src/backend-federation/load.ts +0 -1
  84. package/src/backend-federation/node-shared.ts +76 -0
  85. package/src/backend-federation/node.ts +7 -3
  86. package/src/backend-federation/plugin.ts +73 -25
  87. package/src/backend-federation/runtime.ts +16 -90
  88. package/src/backend-federation/types.ts +2 -11
  89. package/src/backend-federation-manifest/load.ts +76 -27
  90. package/src/backend-federation-manifest/node.ts +3 -2
  91. package/src/backend-federation-manifest/remote.ts +0 -6
  92. package/src/backend-federation-manifest/types.ts +2 -0
  93. package/src/backend-federation-manifest/validation.ts +22 -29
  94. package/src/cross-project-policy/node.ts +7 -38
  95. package/src/{effect-adapter → effect-server}/cross-project-policy.ts +9 -3
  96. package/src/effect-server/entry.ts +18 -0
  97. package/src/{effect-adapter → effect-server}/error-response.ts +1 -1
  98. package/src/effect-server/index.ts +242 -0
  99. package/src/effect-source-loader/built-entry.ts +11 -9
  100. package/src/effect-source-loader/http-api-runtime.ts +1 -1
  101. package/src/effect-source-loader/loader.ts +17 -6
  102. package/src/effect-source-loader/operation-contracts.ts +7 -41
  103. package/src/effect-source-loader/paths.ts +55 -21
  104. package/src/effect-source-loader/rspack-loader.ts +0 -1
  105. package/dist/cjs/backend-federation/entry.js +0 -94
  106. package/dist/cjs/effect-adapter/entry.js +0 -99
  107. package/dist/cjs/effect-adapter/index.js +0 -194
  108. package/dist/esm/backend-federation/entry.mjs +0 -56
  109. package/dist/esm/effect-adapter/entry.mjs +0 -51
  110. package/dist/esm/effect-adapter/index.mjs +0 -143
  111. package/dist/esm-node/backend-federation/entry.mjs +0 -57
  112. package/dist/esm-node/effect-adapter/entry.mjs +0 -52
  113. package/dist/esm-node/effect-adapter/index.mjs +0 -144
  114. package/dist/types/backend-federation/entry.d.ts +0 -2
  115. package/dist/types/effect-adapter/cross-project-policy.d.ts +0 -4
  116. package/dist/types/effect-adapter/error-response.d.ts +0 -2
  117. package/dist/types/effect-adapter/index.d.ts +0 -21
  118. package/src/backend-federation/entry.ts +0 -125
  119. package/src/effect-adapter/entry.ts +0 -96
  120. package/src/effect-adapter/index.ts +0 -251
@@ -1,143 +0,0 @@
1
- import node_path from "node:path";
2
- import "@modern-js/server-runtime-extensions/server-config";
3
- import { dispatchEffectBffRequest, resolveEffectBffModuleHandler, useEffectContext } from "@modern-js/bff-effect/effect";
4
- import { createDisposableServerRuntimeHandle, registerServerRuntimeDisposer } from "@modern-js/server-runtime-extensions/runtime-lifecycle";
5
- import { fs, isProd, logger } from "@modern-js/utils";
6
- import { checkCrossProjectPolicyForRequest } from "../cross-project-policy/evaluation.mjs";
7
- import { loadEffectBuiltModule, loadEffectSourceModule } from "../effect-source-loader/loader.mjs";
8
- import { resolveEffectAdapterCrossProjectPolicy } from "./cross-project-policy.mjs";
9
- import { resolveEffectAdapterEntryFile } from "./entry.mjs";
10
- import { createEffectAdapterRuntimeErrorResponse } from "./error-response.mjs";
11
- const EFFECT_MIDDLEWARE_BEFORE = [
12
- 'custom-server-hook',
13
- 'custom-server-middleware',
14
- 'render'
15
- ];
16
- class EffectAdapter {
17
- async loadHandler() {
18
- const entryFile = resolveEffectAdapterEntryFile(this.api);
19
- if (!entryFile || !await fs.pathExists(entryFile)) {
20
- this.handler = null;
21
- return;
22
- }
23
- let mod;
24
- try {
25
- const { appDirectory } = this.api.getServerContext();
26
- mod = await (isProd() ? loadEffectBuiltModule(entryFile) : loadEffectSourceModule({
27
- resourcePath: entryFile,
28
- appDir: appDirectory || node_path.dirname(entryFile)
29
- }));
30
- } catch (error) {
31
- logger.error(`[BFF][Effect] Failed to load Effect entry: ${entryFile}\n${String(error)}`);
32
- throw error;
33
- }
34
- const crossProjectPolicies = new Map(await Promise.all(this.prefixes.map(async (prefix)=>[
35
- prefix,
36
- await resolveEffectAdapterCrossProjectPolicy(this.api, prefix, mod)
37
- ])));
38
- const effectConfig = this.api.getServerConfig()?.bff?.effect;
39
- const loaded = await resolveEffectBffModuleHandler(mod, {
40
- openapi: effectConfig?.openapi,
41
- dataPlatform: effectConfig?.dataPlatform,
42
- validateRequest: (request)=>{
43
- const { path: mountedPathname } = useEffectContext();
44
- const prefix = this.matchingPrefixes.find((item)=>'/' === item || mountedPathname === item || mountedPathname.startsWith(`${item}/`));
45
- if (!prefix) return null;
46
- const requestUrl = new URL(request.url);
47
- if ('/' !== prefix) requestUrl.pathname = '/' === requestUrl.pathname ? prefix : `${prefix}${requestUrl.pathname}`;
48
- return checkCrossProjectPolicyForRequest(new Request(requestUrl, request), crossProjectPolicies.get(prefix));
49
- },
50
- onWarning: (message)=>logger.warn(message)
51
- });
52
- if (!loaded) {
53
- const error = new Error(`[BFF][Effect] Invalid Effect entry module: ${entryFile}. Export defineEffectBff(...) or a { api, layer } HttpApi module.`);
54
- logger.warn(error.message);
55
- throw error;
56
- }
57
- const candidateOwner = {};
58
- if (loaded.dispose) registerServerRuntimeDisposer(candidateOwner, loaded.dispose);
59
- const candidate = createDisposableServerRuntimeHandle(candidateOwner, loaded.handler);
60
- if (this.retired) {
61
- await candidate.dispose();
62
- throw new Error('Cannot initialize a retired Effect adapter.');
63
- }
64
- this.handler = candidate;
65
- }
66
- constructor(api){
67
- this.handler = null;
68
- this.prefix = '/api';
69
- this.prefixes = [
70
- '/api'
71
- ];
72
- this.matchingPrefixes = [
73
- '/api'
74
- ];
75
- this.retired = false;
76
- this.registerMiddleware = async (options)=>{
77
- const { enableHandleWeb } = options;
78
- const { bffRuntimeFramework, middlewares: globalMiddlewares } = this.api.getServerContext();
79
- if ('hono' === bffRuntimeFramework) return;
80
- const configuredPrefixes = Array.isArray(options.prefix) ? options.prefix.filter(Boolean) : [
81
- options.prefix || '/api'
82
- ];
83
- this.prefixes = [
84
- ...new Set(configuredPrefixes.length > 0 ? configuredPrefixes : [
85
- '/api'
86
- ])
87
- ];
88
- this.matchingPrefixes = [
89
- ...this.prefixes
90
- ].sort((left, right)=>right.length - left.length);
91
- this.prefix = this.prefixes[0] || '/api';
92
- const { serverBase } = this.api.getServerContext();
93
- if (serverBase) this.unregisterRuntimeDisposer = registerServerRuntimeDisposer(serverBase, this.dispose);
94
- try {
95
- await this.loadHandler();
96
- } catch (error) {
97
- await this.dispose();
98
- throw error;
99
- }
100
- const middlewarePrefixes = enableHandleWeb ? [
101
- this.prefix
102
- ] : this.matchingPrefixes;
103
- const middlewares = middlewarePrefixes.map((middlewarePrefix)=>({
104
- name: 'effect-api-handler',
105
- path: enableHandleWeb ? '*' : `${middlewarePrefix}/*`,
106
- method: 'all',
107
- order: 'post',
108
- before: EFFECT_MIDDLEWARE_BEFORE,
109
- handler: async (context, next)=>{
110
- const handler = this.handler;
111
- if (!handler) {
112
- if (enableHandleWeb) return void await next();
113
- return createEffectAdapterRuntimeErrorResponse(this.api, new Error('[BFF][Effect] Missing Effect entry. Define api/index or configure bff.effect.entry.'), context);
114
- }
115
- const prefix = enableHandleWeb ? this.matchingPrefixes.find((item)=>'/' === item || context.req.path === item || context.req.path.startsWith(`${item}/`)) || this.prefix : middlewarePrefix;
116
- const response = await dispatchEffectBffRequest(handler, context.req.raw, {
117
- prefix,
118
- env: context.env,
119
- path: context.req.path,
120
- method: context.req.method,
121
- onError: (error)=>createEffectAdapterRuntimeErrorResponse(this.api, error, context)
122
- });
123
- if (404 === response.status && enableHandleWeb) return void await next();
124
- return new Response(response.body, response);
125
- }
126
- }));
127
- globalMiddlewares.push(...middlewares);
128
- };
129
- this.dispose = async ()=>{
130
- this.retired = true;
131
- this.unregisterRuntimeDisposer?.();
132
- this.unregisterRuntimeDisposer = void 0;
133
- const previous = this.handler;
134
- this.handler = null;
135
- await previous?.dispose();
136
- };
137
- this.api = api;
138
- }
139
- }
140
- const createRuntimeAdapters = (api)=>[
141
- new EffectAdapter(api)
142
- ];
143
- export { EffectAdapter, createRuntimeAdapters };
@@ -1,57 +0,0 @@
1
- import "node:module";
2
- import { evaluateBackendFederationCommonJsEntry, loadVerifiedBackendFederationEntry } from "@modern-js/server-runtime-extensions/backend-federation-security";
3
- import { isRecord, normalizeExpose } from "./utils.mjs";
4
- function decodeDataUrl(url) {
5
- const commaIndex = url.indexOf(',');
6
- if (commaIndex < 0) throw new Error('[BFF][Effect] Invalid backend federation data URL entry.');
7
- return decodeURIComponent(url.slice(commaIndex + 1));
8
- }
9
- async function readCommonJsEntrySource(remote) {
10
- if (remote.entry.startsWith('data:')) return decodeDataUrl(remote.entry);
11
- throw new Error(`[BFF][Effect] Backend federation remote ${remote.name} cannot load CommonJS entry ${remote.entry}.`);
12
- }
13
- async function importModuleEntry(remote) {
14
- const entry = await import(remote.entry);
15
- return entry.default ?? entry;
16
- }
17
- async function resolvePluginEntry(remote, plugins) {
18
- for (const plugin of plugins ?? []){
19
- const loadEntry = plugin.loadEntry;
20
- if ('function' != typeof loadEntry) continue;
21
- const entry = await loadEntry({
22
- remoteInfo: remote
23
- });
24
- if (entry) return entry;
25
- }
26
- }
27
- async function loadBackendFederationEntry(remote, options) {
28
- const requiresVerification = Boolean(remote.verification || options.entryPolicy?.expected);
29
- const isNetworkEntry = /^https?:\/\//iu.test(remote.entry);
30
- if (isNetworkEntry && !requiresVerification) throw new Error(`[BFF][Effect] Backend federation remote ${remote.name} requires verified entry bytes before network execution.`);
31
- if (requiresVerification) return loadVerifiedBackendFederationEntry({
32
- ...options.entryPolicy,
33
- remote,
34
- ...remote.verification ? {
35
- verification: remote.verification
36
- } : {}
37
- });
38
- const pluginEntry = await resolvePluginEntry(remote, options.plugins);
39
- if (pluginEntry) return pluginEntry;
40
- if (remote.entryGlobalName) {
41
- const globalEntry = globalThis[remote.entryGlobalName];
42
- if (isRecord(globalEntry)) return globalEntry;
43
- }
44
- if ('module' === remote.type || remote.entry.startsWith('file:')) return importModuleEntry(remote);
45
- return evaluateBackendFederationCommonJsEntry(remote, new TextEncoder().encode(await readCommonJsEntrySource(remote)), options.entryPolicy?.evaluateCommonJs);
46
- }
47
- async function loadBackendFederationExpose(remote, expose, options) {
48
- const entry = await loadBackendFederationEntry(remote, options);
49
- if ('function' == typeof entry.init) await entry.init({
50
- hostName: options.hostName
51
- });
52
- if ('function' != typeof entry.get) throw new Error(`[BFF][Effect] Backend federation remote ${remote.name} entry must expose get().`);
53
- const factory = await entry.get(expose);
54
- if ('function' != typeof factory) throw new Error(`[BFF][Effect] Backend federation expose ${remote.name}/${normalizeExpose(expose)} must load factory function.`);
55
- return factory();
56
- }
57
- export { loadBackendFederationExpose };
@@ -1,52 +0,0 @@
1
- import "node:module";
2
- import node_path from "node:path";
3
- import "@modern-js/server-runtime-extensions/server-config";
4
- import { API_DIR, findExists, fs, isProd } from "@modern-js/utils";
5
- const JS_OR_TS_EXTS = [
6
- '.js',
7
- '.jsx',
8
- '.ts',
9
- '.tsx',
10
- '.mjs',
11
- '.mts',
12
- '.cjs',
13
- '.cts'
14
- ];
15
- function resolveJsOrTsEntry(entryWithoutOrWithExt) {
16
- const extension = node_path.extname(entryWithoutOrWithExt);
17
- if (JS_OR_TS_EXTS.includes(extension)) return fs.existsSync(entryWithoutOrWithExt) ? entryWithoutOrWithExt : void 0;
18
- return findExists(JS_OR_TS_EXTS.map((ext)=>`${entryWithoutOrWithExt}${ext}`)) || void 0;
19
- }
20
- function builtEntryPath(entryPath) {
21
- return entryPath.replace(/\.(?:[cm]?ts|tsx|jsx)$/u, '.js');
22
- }
23
- function relativeAppPath(appDirectory, entryPath) {
24
- const relativePath = node_path.relative(appDirectory, entryPath);
25
- return '..' === relativePath || relativePath.startsWith(`..${node_path.sep}`) ? void 0 : relativePath;
26
- }
27
- function isDependencyPath(relativePath) {
28
- return relativePath?.split(/[\\/]/u).includes('node_modules') ?? false;
29
- }
30
- function resolveEffectAdapterEntryFile(api) {
31
- const { appDirectory, apiDirectory, distDirectory } = api.getServerContext();
32
- const appRoot = node_path.resolve(appDirectory || process.cwd());
33
- const productionRoot = isProd() && distDirectory ? node_path.resolve(distDirectory) : void 0;
34
- const configuredEntry = api.getServerConfig()?.bff?.effect?.entry;
35
- if (configuredEntry) {
36
- const sourceEntry = node_path.isAbsolute(configuredEntry) ? configuredEntry : node_path.resolve(appRoot, configuredEntry);
37
- if (productionRoot) {
38
- const relativeEntry = relativeAppPath(appRoot, sourceEntry);
39
- if (void 0 === relativeEntry || isDependencyPath(relativeEntry)) return resolveJsOrTsEntry(sourceEntry);
40
- return relativeEntry ? resolveJsOrTsEntry(builtEntryPath(node_path.resolve(productionRoot, relativeEntry))) : void 0;
41
- }
42
- return resolveJsOrTsEntry(sourceEntry);
43
- }
44
- const resolvedApiDirectory = node_path.resolve(appRoot, apiDirectory || API_DIR);
45
- const productionApiDirectory = productionRoot ? void 0 !== relativeAppPath(productionRoot, resolvedApiDirectory) ? resolvedApiDirectory : (()=>{
46
- const relativeApiDirectory = relativeAppPath(appRoot, resolvedApiDirectory);
47
- if (isDependencyPath(relativeApiDirectory)) return resolvedApiDirectory;
48
- return relativeApiDirectory ? node_path.resolve(productionRoot, relativeApiDirectory) : void 0;
49
- })() : resolvedApiDirectory;
50
- return productionApiDirectory ? resolveJsOrTsEntry(node_path.resolve(productionApiDirectory, 'index')) : void 0;
51
- }
52
- export { resolveEffectAdapterEntryFile };
@@ -1,144 +0,0 @@
1
- import "node:module";
2
- import node_path from "node:path";
3
- import "@modern-js/server-runtime-extensions/server-config";
4
- import { dispatchEffectBffRequest, resolveEffectBffModuleHandler, useEffectContext } from "@modern-js/bff-effect/effect";
5
- import { createDisposableServerRuntimeHandle, registerServerRuntimeDisposer } from "@modern-js/server-runtime-extensions/runtime-lifecycle";
6
- import { fs, isProd, logger } from "@modern-js/utils";
7
- import { checkCrossProjectPolicyForRequest } from "../cross-project-policy/evaluation.mjs";
8
- import { loadEffectBuiltModule, loadEffectSourceModule } from "../effect-source-loader/loader.mjs";
9
- import { resolveEffectAdapterCrossProjectPolicy } from "./cross-project-policy.mjs";
10
- import { resolveEffectAdapterEntryFile } from "./entry.mjs";
11
- import { createEffectAdapterRuntimeErrorResponse } from "./error-response.mjs";
12
- const EFFECT_MIDDLEWARE_BEFORE = [
13
- 'custom-server-hook',
14
- 'custom-server-middleware',
15
- 'render'
16
- ];
17
- class EffectAdapter {
18
- async loadHandler() {
19
- const entryFile = resolveEffectAdapterEntryFile(this.api);
20
- if (!entryFile || !await fs.pathExists(entryFile)) {
21
- this.handler = null;
22
- return;
23
- }
24
- let mod;
25
- try {
26
- const { appDirectory } = this.api.getServerContext();
27
- mod = await (isProd() ? loadEffectBuiltModule(entryFile) : loadEffectSourceModule({
28
- resourcePath: entryFile,
29
- appDir: appDirectory || node_path.dirname(entryFile)
30
- }));
31
- } catch (error) {
32
- logger.error(`[BFF][Effect] Failed to load Effect entry: ${entryFile}\n${String(error)}`);
33
- throw error;
34
- }
35
- const crossProjectPolicies = new Map(await Promise.all(this.prefixes.map(async (prefix)=>[
36
- prefix,
37
- await resolveEffectAdapterCrossProjectPolicy(this.api, prefix, mod)
38
- ])));
39
- const effectConfig = this.api.getServerConfig()?.bff?.effect;
40
- const loaded = await resolveEffectBffModuleHandler(mod, {
41
- openapi: effectConfig?.openapi,
42
- dataPlatform: effectConfig?.dataPlatform,
43
- validateRequest: (request)=>{
44
- const { path: mountedPathname } = useEffectContext();
45
- const prefix = this.matchingPrefixes.find((item)=>'/' === item || mountedPathname === item || mountedPathname.startsWith(`${item}/`));
46
- if (!prefix) return null;
47
- const requestUrl = new URL(request.url);
48
- if ('/' !== prefix) requestUrl.pathname = '/' === requestUrl.pathname ? prefix : `${prefix}${requestUrl.pathname}`;
49
- return checkCrossProjectPolicyForRequest(new Request(requestUrl, request), crossProjectPolicies.get(prefix));
50
- },
51
- onWarning: (message)=>logger.warn(message)
52
- });
53
- if (!loaded) {
54
- const error = new Error(`[BFF][Effect] Invalid Effect entry module: ${entryFile}. Export defineEffectBff(...) or a { api, layer } HttpApi module.`);
55
- logger.warn(error.message);
56
- throw error;
57
- }
58
- const candidateOwner = {};
59
- if (loaded.dispose) registerServerRuntimeDisposer(candidateOwner, loaded.dispose);
60
- const candidate = createDisposableServerRuntimeHandle(candidateOwner, loaded.handler);
61
- if (this.retired) {
62
- await candidate.dispose();
63
- throw new Error('Cannot initialize a retired Effect adapter.');
64
- }
65
- this.handler = candidate;
66
- }
67
- constructor(api){
68
- this.handler = null;
69
- this.prefix = '/api';
70
- this.prefixes = [
71
- '/api'
72
- ];
73
- this.matchingPrefixes = [
74
- '/api'
75
- ];
76
- this.retired = false;
77
- this.registerMiddleware = async (options)=>{
78
- const { enableHandleWeb } = options;
79
- const { bffRuntimeFramework, middlewares: globalMiddlewares } = this.api.getServerContext();
80
- if ('hono' === bffRuntimeFramework) return;
81
- const configuredPrefixes = Array.isArray(options.prefix) ? options.prefix.filter(Boolean) : [
82
- options.prefix || '/api'
83
- ];
84
- this.prefixes = [
85
- ...new Set(configuredPrefixes.length > 0 ? configuredPrefixes : [
86
- '/api'
87
- ])
88
- ];
89
- this.matchingPrefixes = [
90
- ...this.prefixes
91
- ].sort((left, right)=>right.length - left.length);
92
- this.prefix = this.prefixes[0] || '/api';
93
- const { serverBase } = this.api.getServerContext();
94
- if (serverBase) this.unregisterRuntimeDisposer = registerServerRuntimeDisposer(serverBase, this.dispose);
95
- try {
96
- await this.loadHandler();
97
- } catch (error) {
98
- await this.dispose();
99
- throw error;
100
- }
101
- const middlewarePrefixes = enableHandleWeb ? [
102
- this.prefix
103
- ] : this.matchingPrefixes;
104
- const middlewares = middlewarePrefixes.map((middlewarePrefix)=>({
105
- name: 'effect-api-handler',
106
- path: enableHandleWeb ? '*' : `${middlewarePrefix}/*`,
107
- method: 'all',
108
- order: 'post',
109
- before: EFFECT_MIDDLEWARE_BEFORE,
110
- handler: async (context, next)=>{
111
- const handler = this.handler;
112
- if (!handler) {
113
- if (enableHandleWeb) return void await next();
114
- return createEffectAdapterRuntimeErrorResponse(this.api, new Error('[BFF][Effect] Missing Effect entry. Define api/index or configure bff.effect.entry.'), context);
115
- }
116
- const prefix = enableHandleWeb ? this.matchingPrefixes.find((item)=>'/' === item || context.req.path === item || context.req.path.startsWith(`${item}/`)) || this.prefix : middlewarePrefix;
117
- const response = await dispatchEffectBffRequest(handler, context.req.raw, {
118
- prefix,
119
- env: context.env,
120
- path: context.req.path,
121
- method: context.req.method,
122
- onError: (error)=>createEffectAdapterRuntimeErrorResponse(this.api, error, context)
123
- });
124
- if (404 === response.status && enableHandleWeb) return void await next();
125
- return new Response(response.body, response);
126
- }
127
- }));
128
- globalMiddlewares.push(...middlewares);
129
- };
130
- this.dispose = async ()=>{
131
- this.retired = true;
132
- this.unregisterRuntimeDisposer?.();
133
- this.unregisterRuntimeDisposer = void 0;
134
- const previous = this.handler;
135
- this.handler = null;
136
- await previous?.dispose();
137
- };
138
- this.api = api;
139
- }
140
- }
141
- const createRuntimeAdapters = (api)=>[
142
- new EffectAdapter(api)
143
- ];
144
- export { EffectAdapter, createRuntimeAdapters };
@@ -1,2 +0,0 @@
1
- import type { BackendFederationRemote, BackendFederationRuntimeOptions } from './types.js';
2
- export declare function loadBackendFederationExpose(remote: BackendFederationRemote, expose: string, options: BackendFederationRuntimeOptions): Promise<unknown>;
@@ -1,4 +0,0 @@
1
- import { type EffectApiModule } from '@modern-js/bff-effect/effect';
2
- import type { ServerPluginAPI } from '@modern-js/server-core';
3
- import type { ResolvedCrossProjectPolicy } from '../cross-project-policy/evaluation.js';
4
- export declare function resolveEffectAdapterCrossProjectPolicy(api: ServerPluginAPI, prefix: string, mod: EffectApiModule | null): Promise<ResolvedCrossProjectPolicy | undefined>;
@@ -1,2 +0,0 @@
1
- import type { Context, ServerPluginAPI } from '@modern-js/server-core';
2
- export declare function createEffectAdapterRuntimeErrorResponse(api: ServerPluginAPI, error: unknown, context: Context): Promise<Response>;
@@ -1,21 +0,0 @@
1
- import '@modern-js/server-runtime-extensions/server-config';
2
- import type { ServerPluginAPI } from '@modern-js/server-core';
3
- interface EffectAdapterMiddlewareOptions {
4
- prefix: string | readonly string[];
5
- enableHandleWeb?: boolean;
6
- }
7
- export declare class EffectAdapter {
8
- private api;
9
- private handler;
10
- private unregisterRuntimeDisposer?;
11
- private prefix;
12
- private prefixes;
13
- private matchingPrefixes;
14
- private retired;
15
- constructor(api: ServerPluginAPI);
16
- registerMiddleware: (options: EffectAdapterMiddlewareOptions) => Promise<void>;
17
- dispose: () => Promise<void>;
18
- private loadHandler;
19
- }
20
- export declare const createRuntimeAdapters: (api: ServerPluginAPI) => EffectAdapter[];
21
- export {};
@@ -1,125 +0,0 @@
1
- // @effect-diagnostics asyncFunction:off globalFetch:off strictBooleanExpressions:off
2
-
3
- import {
4
- evaluateBackendFederationCommonJsEntry,
5
- loadVerifiedBackendFederationEntry,
6
- } from '@modern-js/server-runtime-extensions/backend-federation-security';
7
- import type { ModuleFederationRuntimePlugin } from '@module-federation/runtime';
8
-
9
- import type {
10
- BackendFederationEntryExports,
11
- BackendFederationLoadEntryPlugin,
12
- BackendFederationRemote,
13
- BackendFederationRuntimeOptions,
14
- } from './types';
15
- import { isRecord, normalizeExpose } from './utils';
16
-
17
- function decodeDataUrl(url: string) {
18
- const commaIndex = url.indexOf(',');
19
- if (commaIndex < 0) {
20
- throw new Error('[BFF][Effect] Invalid backend federation data URL entry.');
21
- }
22
- return decodeURIComponent(url.slice(commaIndex + 1));
23
- }
24
-
25
- async function readCommonJsEntrySource(remote: BackendFederationRemote) {
26
- if (remote.entry.startsWith('data:')) {
27
- return decodeDataUrl(remote.entry);
28
- }
29
-
30
- throw new Error(
31
- `[BFF][Effect] Backend federation remote ${remote.name} cannot load CommonJS entry ${remote.entry}.`,
32
- );
33
- }
34
-
35
- async function importModuleEntry(remote: BackendFederationRemote) {
36
- const entry = await import(/* webpackIgnore: true */ remote.entry);
37
- return (entry.default ?? entry) as BackendFederationEntryExports;
38
- }
39
-
40
- async function resolvePluginEntry(
41
- remote: BackendFederationRemote,
42
- plugins: ModuleFederationRuntimePlugin[] | undefined,
43
- ) {
44
- for (const plugin of plugins ?? []) {
45
- const loadEntry = (plugin as BackendFederationLoadEntryPlugin).loadEntry;
46
- if (typeof loadEntry !== 'function') {
47
- continue;
48
- }
49
- const entry = await loadEntry({ remoteInfo: remote });
50
- if (entry) {
51
- return entry;
52
- }
53
- }
54
- }
55
-
56
- async function loadBackendFederationEntry(
57
- remote: BackendFederationRemote,
58
- options: BackendFederationRuntimeOptions,
59
- ) {
60
- const requiresVerification = Boolean(
61
- remote.verification || options.entryPolicy?.expected,
62
- );
63
- const isNetworkEntry = /^https?:\/\//iu.test(remote.entry);
64
- if (isNetworkEntry && !requiresVerification) {
65
- throw new Error(
66
- `[BFF][Effect] Backend federation remote ${remote.name} requires verified entry bytes before network execution.`,
67
- );
68
- }
69
- if (requiresVerification) {
70
- return loadVerifiedBackendFederationEntry({
71
- ...options.entryPolicy,
72
- remote,
73
- ...(remote.verification ? { verification: remote.verification } : {}),
74
- });
75
- }
76
-
77
- const pluginEntry = await resolvePluginEntry(remote, options.plugins);
78
- if (pluginEntry) {
79
- return pluginEntry;
80
- }
81
-
82
- if (remote.entryGlobalName) {
83
- const globalEntry = (globalThis as Record<string, unknown>)[
84
- remote.entryGlobalName
85
- ];
86
- if (isRecord(globalEntry)) {
87
- return globalEntry as unknown as BackendFederationEntryExports;
88
- }
89
- }
90
-
91
- if (remote.type === 'module' || remote.entry.startsWith('file:')) {
92
- return importModuleEntry(remote);
93
- }
94
-
95
- return evaluateBackendFederationCommonJsEntry(
96
- remote,
97
- new TextEncoder().encode(await readCommonJsEntrySource(remote)),
98
- options.entryPolicy?.evaluateCommonJs,
99
- );
100
- }
101
-
102
- export async function loadBackendFederationExpose(
103
- remote: BackendFederationRemote,
104
- expose: string,
105
- options: BackendFederationRuntimeOptions,
106
- ) {
107
- const entry = await loadBackendFederationEntry(remote, options);
108
- if (typeof entry.init === 'function') {
109
- await entry.init({ hostName: options.hostName });
110
- }
111
- if (typeof entry.get !== 'function') {
112
- throw new Error(
113
- `[BFF][Effect] Backend federation remote ${remote.name} entry must expose get().`,
114
- );
115
- }
116
- const factory = await entry.get(expose);
117
- if (typeof factory !== 'function') {
118
- throw new Error(
119
- `[BFF][Effect] Backend federation expose ${remote.name}/${normalizeExpose(
120
- expose,
121
- )} must load factory function.`,
122
- );
123
- }
124
- return factory();
125
- }
@@ -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
- }