@bleedingdev/modern-js-renderer-octane 0.0.0-stage → 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.
- package/LICENSE +21 -0
- package/bin/octane-tsc.mjs +4 -0
- package/dist/cjs/bootstrap.js +68 -0
- package/dist/cjs/client.js +371 -0
- package/dist/cjs/entry-application.js +83 -0
- package/dist/cjs/entry-client.js +92 -0
- package/dist/cjs/entry-server.js +127 -0
- package/dist/cjs/federation-context.js +72 -0
- package/dist/cjs/federation.js +103 -0
- package/dist/cjs/i18n/I18nProvider.js +67 -0
- package/dist/cjs/i18n/LocalizedLink.js +89 -0
- package/dist/cjs/i18n/context.js +41 -0
- package/dist/cjs/i18n/index.js +86 -0
- package/dist/cjs/i18n/languageSync.js +99 -0
- package/dist/cjs/i18n/types.js +18 -0
- package/dist/cjs/i18n/useI18n.js +110 -0
- package/dist/cjs/index.js +46 -0
- package/dist/cjs/manifest.js +167 -0
- package/dist/cjs/plugin/compiler.js +125 -0
- package/dist/cjs/plugin/create.js +265 -0
- package/dist/cjs/plugin/index.js +151 -0
- package/dist/cjs/plugin/profile.js +89 -0
- package/dist/cjs/plugin/source.js +56 -0
- package/dist/cjs/router-client.js +139 -0
- package/dist/cjs/router-handler.js +168 -0
- package/dist/cjs/router-injection.js +139 -0
- package/dist/cjs/router-server-cleanup.js +46 -0
- package/dist/cjs/router-server-snapshot.js +405 -0
- package/dist/cjs/router-server.js +108 -0
- package/dist/cjs/router-snapshot.js +270 -0
- package/dist/cjs/router.js +218 -0
- package/dist/cjs/routes.js +187 -0
- package/dist/cjs/server.js +224 -0
- package/dist/cjs/typecheck.js +615 -0
- package/dist/esm/bootstrap.mjs +24 -0
- package/dist/esm/client.mjs +327 -0
- package/dist/esm/entry-application.mjs +39 -0
- package/dist/esm/entry-client.mjs +54 -0
- package/dist/esm/entry-server.mjs +86 -0
- package/dist/esm/federation-context.mjs +25 -0
- package/dist/esm/federation.mjs +65 -0
- package/dist/esm/i18n/I18nProvider.mjs +29 -0
- package/dist/esm/i18n/LocalizedLink.mjs +48 -0
- package/dist/esm/i18n/context.mjs +3 -0
- package/dist/esm/i18n/index.mjs +8 -0
- package/dist/esm/i18n/languageSync.mjs +61 -0
- package/dist/esm/i18n/types.mjs +0 -0
- package/dist/esm/i18n/useI18n.mjs +72 -0
- package/dist/esm/index.mjs +8 -0
- package/dist/esm/manifest.mjs +117 -0
- package/dist/esm/router-client.mjs +98 -0
- package/dist/esm/router-handler.mjs +130 -0
- package/dist/esm/router-injection.mjs +101 -0
- package/dist/esm/router-server-cleanup.mjs +8 -0
- package/dist/esm/router-server-snapshot.mjs +367 -0
- package/dist/esm/router-server.mjs +12 -0
- package/dist/esm/router-snapshot.mjs +199 -0
- package/dist/esm/router.mjs +94 -0
- package/dist/esm/routes.mjs +134 -0
- package/dist/esm/server.mjs +183 -0
- package/dist/esm-node/bootstrap.mjs +24 -0
- package/dist/esm-node/manifest.mjs +117 -0
- package/dist/esm-node/plugin/compiler.mjs +70 -0
- package/dist/esm-node/plugin/create.mjs +227 -0
- package/dist/esm-node/plugin/index.mjs +103 -0
- package/dist/esm-node/plugin/profile.mjs +51 -0
- package/dist/esm-node/plugin/source.mjs +7 -0
- package/dist/esm-node/typecheck.mjs +560 -0
- package/dist/types/bootstrap.d.ts +10 -0
- package/dist/types/client.d.ts +36 -0
- package/dist/types/entry-application.d.ts +19 -0
- package/dist/types/entry-client.d.ts +8 -0
- package/dist/types/entry-server.d.ts +11 -0
- package/dist/types/federation-context.d.ts +28 -0
- package/dist/types/federation.d.ts +18 -0
- package/dist/types/i18n/I18nProvider.d.ts +8 -0
- package/dist/types/i18n/LocalizedLink.d.ts +41 -0
- package/dist/types/i18n/context.d.ts +9 -0
- package/dist/types/i18n/index.d.ts +9 -0
- package/dist/types/i18n/languageSync.d.ts +26 -0
- package/dist/types/i18n/types.d.ts +34 -0
- package/dist/types/i18n/useI18n.d.ts +21 -0
- package/dist/types/index.d.ts +9 -0
- package/dist/types/manifest.d.ts +34 -0
- package/dist/types/plugin/compiler-manifest.d.cts +10 -0
- package/dist/types/plugin/compiler.d.ts +5 -0
- package/dist/types/plugin/create.d.ts +23 -0
- package/dist/types/plugin/index.d.ts +3 -0
- package/dist/types/plugin/profile.d.ts +2 -0
- package/dist/types/plugin/source.d.ts +1 -0
- package/dist/types/plugin/svg-component-template.d.cts +6 -0
- package/dist/types/router-client.d.ts +12 -0
- package/dist/types/router-handler.d.ts +13 -0
- package/dist/types/router-injection.d.ts +8 -0
- package/dist/types/router-server-cleanup.d.ts +3 -0
- package/dist/types/router-server-snapshot.d.ts +15 -0
- package/dist/types/router-server.d.ts +13 -0
- package/dist/types/router-snapshot.d.ts +14 -0
- package/dist/types/router.d.ts +30 -0
- package/dist/types/routes.d.ts +18 -0
- package/dist/types/server.d.ts +41 -0
- package/dist/types/typecheck.d.ts +31 -0
- package/package.json +216 -4
- package/src/bootstrap.ts +60 -0
- package/src/client.ts +485 -0
- package/src/entry-application.ts +72 -0
- package/src/entry-client.ts +80 -0
- package/src/entry-server.ts +142 -0
- package/src/federation-context.ts +53 -0
- package/src/federation.ts +158 -0
- package/src/i18n/I18nProvider.ts +56 -0
- package/src/i18n/LocalizedLink.ts +112 -0
- package/src/i18n/context.ts +12 -0
- package/src/i18n/index.ts +35 -0
- package/src/i18n/languageSync.ts +132 -0
- package/src/i18n/types.ts +36 -0
- package/src/i18n/useI18n.ts +119 -0
- package/src/index.ts +10 -0
- package/src/manifest.ts +253 -0
- package/src/plugin/compiler-manifest.cjs +178 -0
- package/src/plugin/compiler.ts +112 -0
- package/src/plugin/create.ts +272 -0
- package/src/plugin/index.ts +105 -0
- package/src/plugin/profile.ts +46 -0
- package/src/plugin/source.ts +16 -0
- package/src/plugin/svg-component-template.cjs +17 -0
- package/src/router-client.ts +144 -0
- package/src/router-handler.ts +182 -0
- package/src/router-injection.ts +145 -0
- package/src/router-server-cleanup.ts +11 -0
- package/src/router-server-snapshot.ts +564 -0
- package/src/router-server.ts +23 -0
- package/src/router-snapshot.ts +251 -0
- package/src/router.ts +192 -0
- package/src/routes.ts +263 -0
- package/src/server.ts +300 -0
- package/src/typecheck.ts +723 -0
- package/README.md +0 -3
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { createRequestLanguageRedirect, detectRequestLanguage, languageFromPathname, resolveRequestLanguage } from "@modern-js/i18n-runtime-extensions/request-language";
|
|
2
|
+
export { I18N_SSR_HANDOFF_ELEMENT_ID, createI18nSsrHandoffInlineData, readI18nSsrHandoff } from "@modern-js/i18n-runtime-extensions/ssrLanguageHandoff";
|
|
3
|
+
export { createI18nUrlRewrite } from "@modern-js/i18n-runtime-extensions/urlRewrite";
|
|
4
|
+
export { I18nContext } from "./context.mjs";
|
|
5
|
+
export { I18nProvider } from "./I18nProvider.mjs";
|
|
6
|
+
export { LocalizedLink, useIsLocalizedActive } from "./LocalizedLink.mjs";
|
|
7
|
+
export { useLatestLanguageSync } from "./languageSync.mjs";
|
|
8
|
+
export { useI18n } from "./useI18n.mjs";
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { createLatestLanguageSyncBinding } from "@modern-js/i18n-runtime-extensions/language-sync/controller";
|
|
2
|
+
import { hookSlots, useCallback, useEffect, useRef } from "octane";
|
|
3
|
+
const bindingSlot = Symbol(hookSlots(1));
|
|
4
|
+
const callbacksSlot = Symbol(hookSlots(1));
|
|
5
|
+
const activationSlot = Symbol(hookSlots(1));
|
|
6
|
+
const requestSlot = Symbol(hookSlots(1));
|
|
7
|
+
const retrySlot = Symbol(hookSlots(1));
|
|
8
|
+
const requestCallbackSlot = Symbol(hookSlots(1));
|
|
9
|
+
const useLatestLanguageSync = ({ changeLanguage, commitLanguage, desiredLanguage, enabled = true, policy, readLanguage, reportFailure, target })=>{
|
|
10
|
+
const bindingRef = useRef(null, bindingSlot);
|
|
11
|
+
if (null === bindingRef.current) bindingRef.current = createLatestLanguageSyncBinding(policy);
|
|
12
|
+
const binding = bindingRef.current;
|
|
13
|
+
useEffect(()=>{
|
|
14
|
+
binding.updateCallbacks({
|
|
15
|
+
changeLanguage,
|
|
16
|
+
commitLanguage,
|
|
17
|
+
readLanguage,
|
|
18
|
+
reportFailure
|
|
19
|
+
});
|
|
20
|
+
}, void 0, callbacksSlot);
|
|
21
|
+
useEffect(()=>{
|
|
22
|
+
if (!enabled || !target) return;
|
|
23
|
+
binding.activate(target);
|
|
24
|
+
return ()=>binding.deactivate();
|
|
25
|
+
}, [
|
|
26
|
+
binding,
|
|
27
|
+
enabled,
|
|
28
|
+
target
|
|
29
|
+
], activationSlot);
|
|
30
|
+
useEffect(()=>{
|
|
31
|
+
if (!enabled || !target || !desiredLanguage) return void binding.clearRequest();
|
|
32
|
+
binding.request(desiredLanguage);
|
|
33
|
+
}, [
|
|
34
|
+
binding,
|
|
35
|
+
desiredLanguage,
|
|
36
|
+
enabled,
|
|
37
|
+
target
|
|
38
|
+
], requestSlot);
|
|
39
|
+
useEffect(()=>{
|
|
40
|
+
if (!enabled || !target || !desiredLanguage || "u" < typeof window) return;
|
|
41
|
+
const retryCurrentIntent = ()=>binding.request(desiredLanguage);
|
|
42
|
+
const retryVisibleIntent = ()=>{
|
|
43
|
+
if ('visible' === document.visibilityState) retryCurrentIntent();
|
|
44
|
+
};
|
|
45
|
+
window.addEventListener('online', retryCurrentIntent);
|
|
46
|
+
document.addEventListener('visibilitychange', retryVisibleIntent);
|
|
47
|
+
return ()=>{
|
|
48
|
+
window.removeEventListener('online', retryCurrentIntent);
|
|
49
|
+
document.removeEventListener('visibilitychange', retryVisibleIntent);
|
|
50
|
+
};
|
|
51
|
+
}, [
|
|
52
|
+
binding,
|
|
53
|
+
desiredLanguage,
|
|
54
|
+
enabled,
|
|
55
|
+
target
|
|
56
|
+
], retrySlot);
|
|
57
|
+
return useCallback((language)=>binding.request(language), [
|
|
58
|
+
binding
|
|
59
|
+
], requestCallbackSlot);
|
|
60
|
+
};
|
|
61
|
+
export { useLatestLanguageSync };
|
|
File without changes
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { configuredLanguage, localizePath } from "@modern-js/i18n-runtime-extensions/paths";
|
|
2
|
+
import { languageFromPathname } from "@modern-js/i18n-runtime-extensions/request-language";
|
|
3
|
+
import { useContext } from "octane";
|
|
4
|
+
import { useRouter } from "../router.mjs";
|
|
5
|
+
import { I18nContext } from "./context.mjs";
|
|
6
|
+
const languageSwitches = new WeakMap();
|
|
7
|
+
function useI18n() {
|
|
8
|
+
const context = useContext(I18nContext);
|
|
9
|
+
if (!context) throw new Error('[renderer-octane] useI18n() was called outside of an I18nProvider.');
|
|
10
|
+
const { instance, languages, localisedUrls, language } = context;
|
|
11
|
+
const t = (key, options)=>instance.t(key, options);
|
|
12
|
+
const router = useRouter({
|
|
13
|
+
warn: false
|
|
14
|
+
});
|
|
15
|
+
const changeLanguage = (requested)=>{
|
|
16
|
+
let nextLanguage;
|
|
17
|
+
try {
|
|
18
|
+
nextLanguage = configuredLanguage(requested, languages);
|
|
19
|
+
} catch (error) {
|
|
20
|
+
return Promise.reject(error);
|
|
21
|
+
}
|
|
22
|
+
const state = languageSwitches.get(instance) ?? {
|
|
23
|
+
latest: 0,
|
|
24
|
+
queue: Promise.resolve()
|
|
25
|
+
};
|
|
26
|
+
languageSwitches.set(instance, state);
|
|
27
|
+
const generation = ++state.latest;
|
|
28
|
+
const run = state.queue.then(async ()=>{
|
|
29
|
+
if (state.latest !== generation) return;
|
|
30
|
+
const committed = instance.language;
|
|
31
|
+
const publicLanguage = ()=>router ? languageFromPathname(new URL(router.state.location.publicHref, 'http://localhost').pathname, languages, router.options.basepath) : void 0;
|
|
32
|
+
const reconcile = async ()=>{
|
|
33
|
+
const language = publicLanguage() ?? committed;
|
|
34
|
+
if (instance.language !== language) await instance.changeLanguage?.(language);
|
|
35
|
+
};
|
|
36
|
+
try {
|
|
37
|
+
await instance.changeLanguage?.(nextLanguage);
|
|
38
|
+
} catch (error) {
|
|
39
|
+
await reconcile();
|
|
40
|
+
throw error;
|
|
41
|
+
}
|
|
42
|
+
if (!router) return;
|
|
43
|
+
const href = localizePath(router.state.location.href, nextLanguage, {
|
|
44
|
+
languages: [
|
|
45
|
+
...languages
|
|
46
|
+
],
|
|
47
|
+
localisedUrls
|
|
48
|
+
});
|
|
49
|
+
try {
|
|
50
|
+
await router.navigate({
|
|
51
|
+
to: '.',
|
|
52
|
+
href,
|
|
53
|
+
replace: true
|
|
54
|
+
});
|
|
55
|
+
} catch (error) {
|
|
56
|
+
await reconcile();
|
|
57
|
+
throw error;
|
|
58
|
+
}
|
|
59
|
+
if (publicLanguage() !== nextLanguage) await reconcile();
|
|
60
|
+
});
|
|
61
|
+
state.queue = run.catch(()=>{});
|
|
62
|
+
return run;
|
|
63
|
+
};
|
|
64
|
+
return {
|
|
65
|
+
t,
|
|
66
|
+
language,
|
|
67
|
+
languages,
|
|
68
|
+
instance,
|
|
69
|
+
changeLanguage
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
export { useI18n };
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { nativeModuleManifestFilename, readRendererIdentity } from "@modern-js/renderer-core/identity";
|
|
2
|
+
import { assertNativeHydrationBuildId, assertOctaneIdentity } from "./bootstrap.mjs";
|
|
3
|
+
const OCTANE_RUNTIME_VERSION = '0.7.1+ultramodern.1331985ea3b0';
|
|
4
|
+
const OCTANE_COMPILER_VERSION = '0.1.55';
|
|
5
|
+
function octaneModuleManifestFileName(entryName) {
|
|
6
|
+
return nativeModuleManifestFilename('octane', entryName);
|
|
7
|
+
}
|
|
8
|
+
function record(value, fields) {
|
|
9
|
+
if (!value || 'object' != typeof value || Array.isArray(value)) throw new Error('Malformed Octane compiler manifest object.');
|
|
10
|
+
if (Object.keys(value).some((key)=>!fields.includes(key))) throw new Error('Octane compiler manifest contains an unknown field.');
|
|
11
|
+
return value;
|
|
12
|
+
}
|
|
13
|
+
function digest(value) {
|
|
14
|
+
return 'string' == typeof value && /^[a-f\d]{64}$/u.test(value);
|
|
15
|
+
}
|
|
16
|
+
function nonempty(value) {
|
|
17
|
+
return 'string' == typeof value && value.trim().length > 0 && !value.includes('\0');
|
|
18
|
+
}
|
|
19
|
+
function assetPath(value) {
|
|
20
|
+
return nonempty(value) && value.endsWith('.js') && !value.startsWith('/') && !value.includes('\\') && !value.split('/').some((part)=>'..' === part || '.' === part || !part);
|
|
21
|
+
}
|
|
22
|
+
const validatedManifests = new WeakMap();
|
|
23
|
+
function validateOctaneModuleManifest(value, expectedIdentity, expectedNativeHydrationBuildId) {
|
|
24
|
+
assertOctaneIdentity(expectedIdentity);
|
|
25
|
+
const cached = value && 'object' == typeof value ? validatedManifests.get(value) : void 0;
|
|
26
|
+
const manifest = cached ?? readOctaneModuleManifest(value);
|
|
27
|
+
readRendererIdentity(manifest.rendererIdentity, expectedIdentity);
|
|
28
|
+
if (void 0 !== expectedNativeHydrationBuildId) {
|
|
29
|
+
assertNativeHydrationBuildId(expectedNativeHydrationBuildId);
|
|
30
|
+
if (manifest.nativeHydrationBuildId !== expectedNativeHydrationBuildId) throw new Error('Octane native hydration build differs from the compiled client.');
|
|
31
|
+
}
|
|
32
|
+
if (!cached) {
|
|
33
|
+
validatedManifests.set(value, manifest);
|
|
34
|
+
validatedManifests.set(manifest, manifest);
|
|
35
|
+
}
|
|
36
|
+
return manifest;
|
|
37
|
+
}
|
|
38
|
+
function readOctaneModuleManifest(value) {
|
|
39
|
+
const manifest = record(value, [
|
|
40
|
+
'schemaVersion',
|
|
41
|
+
'renderer',
|
|
42
|
+
'runtimeVersion',
|
|
43
|
+
'compilerVersion',
|
|
44
|
+
'rendererIdentity',
|
|
45
|
+
'nativeHydrationBuildId',
|
|
46
|
+
'sourceModules',
|
|
47
|
+
'assets'
|
|
48
|
+
]);
|
|
49
|
+
if (1 !== manifest.schemaVersion || 'octane' !== manifest.renderer || manifest.runtimeVersion !== OCTANE_RUNTIME_VERSION || manifest.compilerVersion !== OCTANE_COMPILER_VERSION) throw new Error('Octane compiler manifest ABI conflicts with the application.');
|
|
50
|
+
const rendererIdentity = readRendererIdentity(manifest.rendererIdentity, manifest.rendererIdentity);
|
|
51
|
+
const nativeHydrationBuildId = manifest.nativeHydrationBuildId;
|
|
52
|
+
assertNativeHydrationBuildId(nativeHydrationBuildId);
|
|
53
|
+
if (!Array.isArray(manifest.assets) || !manifest.assets.length) throw new Error('Octane compiler manifest has no emitted JavaScript closure.');
|
|
54
|
+
const assetNames = new Set();
|
|
55
|
+
const assets = manifest.assets.map((value)=>{
|
|
56
|
+
const asset = record(value, [
|
|
57
|
+
'file',
|
|
58
|
+
'sha256'
|
|
59
|
+
]);
|
|
60
|
+
if (!assetPath(asset.file) || !digest(asset.sha256) || assetNames.has(asset.file)) throw new Error('Invalid Octane emitted asset digest.');
|
|
61
|
+
assetNames.add(asset.file);
|
|
62
|
+
return Object.freeze({
|
|
63
|
+
file: asset.file,
|
|
64
|
+
sha256: asset.sha256
|
|
65
|
+
});
|
|
66
|
+
});
|
|
67
|
+
if (!Array.isArray(manifest.sourceModules) || !manifest.sourceModules.length) throw new Error('Octane compiler manifest has no authenticated native sources.');
|
|
68
|
+
const resources = new Set();
|
|
69
|
+
const sourceModules = manifest.sourceModules.map((value)=>{
|
|
70
|
+
const source = record(value, [
|
|
71
|
+
'resource',
|
|
72
|
+
'canonicalId',
|
|
73
|
+
'moduleId',
|
|
74
|
+
'transformKind',
|
|
75
|
+
'emittedSourceSha256',
|
|
76
|
+
'assets'
|
|
77
|
+
]);
|
|
78
|
+
if (!nonempty(source.resource) || source.resource.startsWith('/') || source.resource.includes('\\') || !nonempty(source.canonicalId) || !('string' == typeof source.moduleId && nonempty(source.moduleId) || 'number' == typeof source.moduleId && Number.isFinite(source.moduleId)) || !('compile' === source.transformKind || 'slots' === source.transformKind || 'client-only-stub' === source.transformKind) || !digest(source.emittedSourceSha256) || !Array.isArray(source.assets) || !source.assets.length || source.assets.some((file)=>'string' != typeof file || !assetNames.has(file)) || new Set(source.assets).size !== source.assets.length || resources.has(source.resource)) throw new Error('Invalid Octane native source-to-asset provenance.');
|
|
79
|
+
resources.add(source.resource);
|
|
80
|
+
return Object.freeze({
|
|
81
|
+
resource: source.resource,
|
|
82
|
+
canonicalId: source.canonicalId,
|
|
83
|
+
moduleId: source.moduleId,
|
|
84
|
+
transformKind: source.transformKind,
|
|
85
|
+
emittedSourceSha256: source.emittedSourceSha256,
|
|
86
|
+
assets: Object.freeze([
|
|
87
|
+
...source.assets
|
|
88
|
+
])
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
return Object.freeze({
|
|
92
|
+
schemaVersion: 1,
|
|
93
|
+
renderer: 'octane',
|
|
94
|
+
runtimeVersion: OCTANE_RUNTIME_VERSION,
|
|
95
|
+
compilerVersion: OCTANE_COMPILER_VERSION,
|
|
96
|
+
rendererIdentity,
|
|
97
|
+
nativeHydrationBuildId,
|
|
98
|
+
sourceModules: Object.freeze(sourceModules),
|
|
99
|
+
assets: Object.freeze(assets)
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
const compilerArtifacts = {
|
|
103
|
+
clientManifestFile: octaneModuleManifestFileName,
|
|
104
|
+
async validateClientManifest (value, identity, context) {
|
|
105
|
+
const hydrationBuildId = context.compilationHash ?? context.hydrationBuildId;
|
|
106
|
+
if (context.development && ('string' != typeof hydrationBuildId || !hydrationBuildId.trim())) throw new Error('Octane development snapshot has no native hydration build.');
|
|
107
|
+
const nativeManifest = validateOctaneModuleManifest(value, identity, hydrationBuildId);
|
|
108
|
+
return {
|
|
109
|
+
nativeManifest,
|
|
110
|
+
hydrationBuildId: nativeManifest.nativeHydrationBuildId
|
|
111
|
+
};
|
|
112
|
+
},
|
|
113
|
+
isMutableDevelopmentAsset (filename, entryNames) {
|
|
114
|
+
return 'octane-client-build.json' === filename || entryNames.some((entry)=>filename === octaneModuleManifestFileName(entry));
|
|
115
|
+
}
|
|
116
|
+
};
|
|
117
|
+
export { OCTANE_COMPILER_VERSION, OCTANE_RUNTIME_VERSION, compilerArtifacts, octaneModuleManifestFileName, validateOctaneModuleManifest };
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { RouterProvider } from "@octanejs/tanstack-router";
|
|
2
|
+
import { hydrate } from "@octanejs/tanstack-router/ssr/client";
|
|
3
|
+
import { createElement, hookSlots, initializeHydrationEventCapture, useEffect } from "octane";
|
|
4
|
+
import { octaneRouterSnapshotAdapter } from "./router-snapshot.mjs";
|
|
5
|
+
const hydration = new WeakMap();
|
|
6
|
+
function abortReason(signal) {
|
|
7
|
+
return void 0 === signal.reason ? new DOMException('Octane router hydration aborted', 'AbortError') : signal.reason;
|
|
8
|
+
}
|
|
9
|
+
function awaitHydration(promise, signal) {
|
|
10
|
+
if (!signal) return promise;
|
|
11
|
+
signal.throwIfAborted();
|
|
12
|
+
return new Promise((resolve, reject)=>{
|
|
13
|
+
let settled = false;
|
|
14
|
+
const finish = (success, error)=>{
|
|
15
|
+
if (settled) return;
|
|
16
|
+
settled = true;
|
|
17
|
+
signal.removeEventListener('abort', onAbort);
|
|
18
|
+
if (success) resolve();
|
|
19
|
+
else reject(error);
|
|
20
|
+
};
|
|
21
|
+
const onAbort = ()=>finish(false, abortReason(signal));
|
|
22
|
+
signal.addEventListener('abort', onAbort, {
|
|
23
|
+
once: true
|
|
24
|
+
});
|
|
25
|
+
promise.then(()=>finish(true), (error)=>finish(false, error));
|
|
26
|
+
if (signal.aborted) onAbort();
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
function isReactiveMatchIds(value) {
|
|
30
|
+
return 'object' == typeof value && null !== value && 'function' == typeof Reflect.get(value, 'get') && 'function' == typeof Reflect.get(value, 'subscribe');
|
|
31
|
+
}
|
|
32
|
+
function waitForCommittedMatches(router, signal) {
|
|
33
|
+
signal?.throwIfAborted();
|
|
34
|
+
const matchesId = router.stores.matchesId;
|
|
35
|
+
if (matchesId.get().length > 0) return Promise.resolve();
|
|
36
|
+
if (!isReactiveMatchIds(matchesId)) throw new Error('Octane router hydration requires its native reactive match store');
|
|
37
|
+
return new Promise((resolve, reject)=>{
|
|
38
|
+
let subscription;
|
|
39
|
+
let settled = false;
|
|
40
|
+
const cleanup = ()=>{
|
|
41
|
+
subscription?.unsubscribe();
|
|
42
|
+
signal?.removeEventListener('abort', onAbort);
|
|
43
|
+
};
|
|
44
|
+
const finish = ()=>{
|
|
45
|
+
if (settled || 0 === matchesId.get().length) return;
|
|
46
|
+
settled = true;
|
|
47
|
+
cleanup();
|
|
48
|
+
resolve();
|
|
49
|
+
};
|
|
50
|
+
const onAbort = ()=>{
|
|
51
|
+
if (settled) return;
|
|
52
|
+
settled = true;
|
|
53
|
+
cleanup();
|
|
54
|
+
if (signal) reject(abortReason(signal));
|
|
55
|
+
};
|
|
56
|
+
signal?.addEventListener('abort', onAbort, {
|
|
57
|
+
once: true
|
|
58
|
+
});
|
|
59
|
+
if (signal?.aborted) return void onAbort();
|
|
60
|
+
subscription = matchesId.subscribe(finish);
|
|
61
|
+
if (settled) subscription.unsubscribe();
|
|
62
|
+
else finish();
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
async function prepareOctaneRouterHydration(router, options = {}) {
|
|
66
|
+
initializeHydrationEventCapture();
|
|
67
|
+
options.signal?.throwIfAborted();
|
|
68
|
+
const adapters = router.options.serializationAdapters ?? [];
|
|
69
|
+
if (!adapters.includes(octaneRouterSnapshotAdapter)) {
|
|
70
|
+
const nativeOptions = {
|
|
71
|
+
...router.options,
|
|
72
|
+
serializationAdapters: [
|
|
73
|
+
octaneRouterSnapshotAdapter,
|
|
74
|
+
...adapters
|
|
75
|
+
]
|
|
76
|
+
};
|
|
77
|
+
router.update(nativeOptions);
|
|
78
|
+
}
|
|
79
|
+
let pending = hydration.get(router);
|
|
80
|
+
if (!pending) {
|
|
81
|
+
pending = Promise.resolve(hydrate(router)).then(()=>{});
|
|
82
|
+
pending.catch(()=>{});
|
|
83
|
+
hydration.set(router, pending);
|
|
84
|
+
}
|
|
85
|
+
await awaitHydration(pending, options.signal);
|
|
86
|
+
await waitForCommittedMatches(router, options.signal);
|
|
87
|
+
options.signal?.throwIfAborted();
|
|
88
|
+
}
|
|
89
|
+
const routerHydrationEffectSlot = Symbol(hookSlots(1));
|
|
90
|
+
function OctaneRouterRoot({ router }) {
|
|
91
|
+
useEffect(()=>{
|
|
92
|
+
window.$_TSR?.h();
|
|
93
|
+
}, [], routerHydrationEffectSlot);
|
|
94
|
+
return createElement(RouterProvider, {
|
|
95
|
+
router
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
export { OctaneRouterRoot, prepareOctaneRouterHydration };
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { createMemoryHistory } from "@octanejs/tanstack-router";
|
|
2
|
+
import { attachRouterServerSsrUtils, getNormalizedURL, getOrigin, normalizeSsrResponse } from "@octanejs/tanstack-router/ssr/server";
|
|
3
|
+
import { cleanupOctaneRouterSSR } from "./router-server-cleanup.mjs";
|
|
4
|
+
import { prepareOctaneRouterSerialization } from "./router-server-snapshot.mjs";
|
|
5
|
+
function withAbort(pending, signal) {
|
|
6
|
+
signal.throwIfAborted();
|
|
7
|
+
return new Promise((resolve, reject)=>{
|
|
8
|
+
let settled = false;
|
|
9
|
+
const finish = (success, value)=>{
|
|
10
|
+
if (settled) return;
|
|
11
|
+
settled = true;
|
|
12
|
+
signal.removeEventListener('abort', onAbort);
|
|
13
|
+
if (success) resolve(value);
|
|
14
|
+
else reject(value);
|
|
15
|
+
};
|
|
16
|
+
const onAbort = ()=>finish(false, signal.reason);
|
|
17
|
+
signal.addEventListener('abort', onAbort, {
|
|
18
|
+
once: true
|
|
19
|
+
});
|
|
20
|
+
pending.then((value)=>finish(true, value), (error)=>finish(false, error));
|
|
21
|
+
if (signal.aborted) onAbort();
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
const CSP_HEADERS = new Set([
|
|
25
|
+
'content-security-policy',
|
|
26
|
+
'content-security-policy-report-only',
|
|
27
|
+
'link',
|
|
28
|
+
'server-timing'
|
|
29
|
+
]);
|
|
30
|
+
function appendHeaders(destination, value) {
|
|
31
|
+
if (null == value) return;
|
|
32
|
+
const source = value instanceof Headers ? value : new Headers(value);
|
|
33
|
+
for (const [key, item] of Headers.prototype.entries.call(source))if ('set-cookie' !== key) if (CSP_HEADERS.has(key)) destination.append(key, item);
|
|
34
|
+
else if ('vary' === key) {
|
|
35
|
+
const fields = new Map();
|
|
36
|
+
for (const field of `${destination.get('vary') ?? ''},${item}`.split(',')){
|
|
37
|
+
const name = field.trim();
|
|
38
|
+
if (name && !fields.has(name.toLowerCase())) fields.set(name.toLowerCase(), name);
|
|
39
|
+
}
|
|
40
|
+
destination.set('vary', [
|
|
41
|
+
...fields.values()
|
|
42
|
+
].join(', '));
|
|
43
|
+
} else destination.set(key, item);
|
|
44
|
+
for (const cookie of Headers.prototype.getSetCookie.call(source))destination.append('set-cookie', cookie);
|
|
45
|
+
}
|
|
46
|
+
function requestHeaders(router) {
|
|
47
|
+
const headers = new Headers({
|
|
48
|
+
'content-type': 'text/html; charset=utf-8'
|
|
49
|
+
});
|
|
50
|
+
for (const match of router.stores.matches.get()){
|
|
51
|
+
const field = Object.getOwnPropertyDescriptor(match, 'headers');
|
|
52
|
+
if (field?.get || field?.set) throw new TypeError('Native Octane response headers must be owned values');
|
|
53
|
+
appendHeaders(headers, field?.value);
|
|
54
|
+
}
|
|
55
|
+
const redirect = router.stores.redirect.get();
|
|
56
|
+
if (redirect) appendHeaders(headers, redirect.headers);
|
|
57
|
+
return headers;
|
|
58
|
+
}
|
|
59
|
+
function createOctaneRequestHandler({ createRouter, request, session, getRouterManifest, serialization }) {
|
|
60
|
+
return async (callback)=>{
|
|
61
|
+
session.signal.throwIfAborted();
|
|
62
|
+
const router = createRouter();
|
|
63
|
+
let responseOwnsCleanup = false;
|
|
64
|
+
try {
|
|
65
|
+
const manifest = getRouterManifest ? await withAbort(Promise.resolve(getRouterManifest()), session.signal) : void 0;
|
|
66
|
+
attachRouterServerSsrUtils({
|
|
67
|
+
router,
|
|
68
|
+
manifest
|
|
69
|
+
});
|
|
70
|
+
const guard = prepareOctaneRouterSerialization(router, session, {
|
|
71
|
+
...serialization,
|
|
72
|
+
forbiddenValues: [
|
|
73
|
+
request,
|
|
74
|
+
...serialization?.forbiddenValues ?? []
|
|
75
|
+
]
|
|
76
|
+
});
|
|
77
|
+
session.registerCleanup(()=>router.cancelMatches());
|
|
78
|
+
const { url } = getNormalizedURL(request.url, 'http://localhost');
|
|
79
|
+
const href = url.href.replace(url.origin, '');
|
|
80
|
+
router.update({
|
|
81
|
+
...router.options,
|
|
82
|
+
history: createMemoryHistory({
|
|
83
|
+
initialEntries: [
|
|
84
|
+
href
|
|
85
|
+
]
|
|
86
|
+
}),
|
|
87
|
+
origin: router.options.origin ?? getOrigin(request)
|
|
88
|
+
});
|
|
89
|
+
await withAbort(router.load(), session.signal);
|
|
90
|
+
guard.assertActive();
|
|
91
|
+
const redirect = router.stores.redirect.get();
|
|
92
|
+
if (redirect) {
|
|
93
|
+
const resolved = router.resolveRedirect(redirect);
|
|
94
|
+
const headers = requestHeaders(router);
|
|
95
|
+
return new Response(null, {
|
|
96
|
+
status: resolved.status,
|
|
97
|
+
statusText: resolved.statusText,
|
|
98
|
+
headers
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
guard.assertMatches();
|
|
102
|
+
const serverSsr = router.serverSsr;
|
|
103
|
+
if (!serverSsr) throw new Error('Native Octane router SSR state is required');
|
|
104
|
+
await withAbort(serverSsr.dehydrate(), session.signal);
|
|
105
|
+
guard.assertActive();
|
|
106
|
+
const responseHeaders = requestHeaders(router);
|
|
107
|
+
const rendered = Promise.resolve(callback({
|
|
108
|
+
request,
|
|
109
|
+
router,
|
|
110
|
+
responseHeaders
|
|
111
|
+
}));
|
|
112
|
+
const result = normalizeSsrResponse(await withAbort(rendered, session.signal).catch((error)=>{
|
|
113
|
+
if (session.signal.aborted) rendered.then((late)=>{
|
|
114
|
+
try {
|
|
115
|
+
normalizeSsrResponse(late).response.body?.cancel().catch(()=>{});
|
|
116
|
+
} catch {}
|
|
117
|
+
}, ()=>{});
|
|
118
|
+
throw error;
|
|
119
|
+
}));
|
|
120
|
+
responseOwnsCleanup = 'stream' === result.serverSsrCleanup;
|
|
121
|
+
return result.response;
|
|
122
|
+
} catch (error) {
|
|
123
|
+
session.fail(error);
|
|
124
|
+
throw error;
|
|
125
|
+
} finally{
|
|
126
|
+
if (!responseOwnsCleanup) cleanupOctaneRouterSSR(router);
|
|
127
|
+
}
|
|
128
|
+
};
|
|
129
|
+
}
|
|
130
|
+
export { createOctaneRequestHandler };
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { cleanupOctaneRouterSSR } from "./router-server-cleanup.mjs";
|
|
2
|
+
const SERIALIZATION_TIMEOUT_MS = 60000;
|
|
3
|
+
function createOctaneRouterInjection(router, session, options = {}) {
|
|
4
|
+
const serverSsr = router.serverSsr;
|
|
5
|
+
if (!serverSsr) throw new Error('Native Octane router.serverSsr is required for streaming');
|
|
6
|
+
const timeoutMs = options.serializationTimeoutMs ?? SERIALIZATION_TIMEOUT_MS;
|
|
7
|
+
if (!Number.isInteger(timeoutMs) || timeoutMs <= 0 || timeoutMs > SERIALIZATION_TIMEOUT_MS) throw new TypeError('Octane router serialization timeout must be 1 to 60000 ms');
|
|
8
|
+
session.signal.throwIfAborted();
|
|
9
|
+
let settled = false;
|
|
10
|
+
let released = false;
|
|
11
|
+
let renderFinished = false;
|
|
12
|
+
let timer;
|
|
13
|
+
let stopSerialization;
|
|
14
|
+
const subscriptions = new Set();
|
|
15
|
+
let resolveDone;
|
|
16
|
+
let rejectDone;
|
|
17
|
+
const done = new Promise((resolve, reject)=>{
|
|
18
|
+
resolveDone = resolve;
|
|
19
|
+
rejectDone = reject;
|
|
20
|
+
});
|
|
21
|
+
done.catch(()=>{});
|
|
22
|
+
const settle = (error)=>{
|
|
23
|
+
if (settled) return;
|
|
24
|
+
settled = true;
|
|
25
|
+
if (void 0 !== timer) clearTimeout(timer);
|
|
26
|
+
timer = void 0;
|
|
27
|
+
stopSerialization?.();
|
|
28
|
+
stopSerialization = void 0;
|
|
29
|
+
if (void 0 === error) resolveDone();
|
|
30
|
+
else rejectDone(error);
|
|
31
|
+
};
|
|
32
|
+
const release = ()=>{
|
|
33
|
+
if (released) return;
|
|
34
|
+
released = true;
|
|
35
|
+
if (void 0 !== timer) clearTimeout(timer);
|
|
36
|
+
timer = void 0;
|
|
37
|
+
stopSerialization?.();
|
|
38
|
+
stopSerialization = void 0;
|
|
39
|
+
for (const unsubscribe of subscriptions)unsubscribe();
|
|
40
|
+
subscriptions.clear();
|
|
41
|
+
session.signal.removeEventListener('abort', onAbort);
|
|
42
|
+
if (!settled) settle(session.signal.reason ?? new Error('Octane router serialization was interrupted'));
|
|
43
|
+
};
|
|
44
|
+
function onAbort() {
|
|
45
|
+
settle(session.signal.reason ?? new DOMException('Octane request aborted', 'AbortError'));
|
|
46
|
+
release();
|
|
47
|
+
}
|
|
48
|
+
if (serverSsr.isSerializationFinished()) settle();
|
|
49
|
+
else stopSerialization = serverSsr.onSerializationFinished(()=>settle());
|
|
50
|
+
serverSsr.onCleanup(release);
|
|
51
|
+
session.signal.addEventListener('abort', onAbort, {
|
|
52
|
+
once: true
|
|
53
|
+
});
|
|
54
|
+
try {
|
|
55
|
+
session.registerCleanup(()=>{
|
|
56
|
+
release();
|
|
57
|
+
cleanupOctaneRouterSSR(router);
|
|
58
|
+
});
|
|
59
|
+
} catch (error) {
|
|
60
|
+
release();
|
|
61
|
+
cleanupOctaneRouterSSR(router);
|
|
62
|
+
throw error;
|
|
63
|
+
}
|
|
64
|
+
return {
|
|
65
|
+
take () {
|
|
66
|
+
if (released) return '';
|
|
67
|
+
serverSsr.liftScriptBarrier();
|
|
68
|
+
return serverSsr.takeBufferedHtml() ?? '';
|
|
69
|
+
},
|
|
70
|
+
subscribe (notify) {
|
|
71
|
+
if (released) return ()=>{};
|
|
72
|
+
const stop = serverSsr.onInjectedHtml(notify);
|
|
73
|
+
let subscribed = true;
|
|
74
|
+
const unsubscribe = ()=>{
|
|
75
|
+
if (!subscribed) return;
|
|
76
|
+
subscribed = false;
|
|
77
|
+
subscriptions.delete(unsubscribe);
|
|
78
|
+
stop();
|
|
79
|
+
};
|
|
80
|
+
subscriptions.add(unsubscribe);
|
|
81
|
+
return unsubscribe;
|
|
82
|
+
},
|
|
83
|
+
done,
|
|
84
|
+
cancel (reason) {
|
|
85
|
+
settle(reason ?? new DOMException('Octane rendering cancelled', 'AbortError'));
|
|
86
|
+
release();
|
|
87
|
+
session.abort(reason);
|
|
88
|
+
},
|
|
89
|
+
renderComplete () {
|
|
90
|
+
if (released || renderFinished) return;
|
|
91
|
+
renderFinished = true;
|
|
92
|
+
serverSsr.setRenderFinished();
|
|
93
|
+
if (!serverSsr.isSerializationFinished() && !settled) timer = setTimeout(()=>{
|
|
94
|
+
const error = new Error('Octane router serialization timed out after app rendering');
|
|
95
|
+
settle(error);
|
|
96
|
+
session.fail(error);
|
|
97
|
+
}, timeoutMs);
|
|
98
|
+
}
|
|
99
|
+
};
|
|
100
|
+
}
|
|
101
|
+
export { createOctaneRouterInjection };
|