forked from cloudflare/workers-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathminiflare-options.ts
More file actions
895 lines (803 loc) · 25.6 KB
/
miniflare-options.ts
File metadata and controls
895 lines (803 loc) · 25.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
import assert from "node:assert";
import * as fs from "node:fs";
import * as fsp from "node:fs/promises";
import * as path from "node:path";
import { fileURLToPath } from "node:url";
import {
generateContainerBuildId,
resolveDockerHost,
} from "@cloudflare/containers-shared";
import {
getDefaultDevRegistryPath,
kCurrentWorker,
kUnsafeEphemeralUniqueKey,
Log,
LogLevel,
Response as MiniflareResponse,
} from "miniflare";
import colors from "picocolors";
import { globSync } from "tinyglobby";
import * as vite from "vite";
import {
maybeStartOrUpdateRemoteProxySession,
unstable_convertConfigBindingsToStartWorkerBindings,
unstable_getMiniflareWorkerOptions,
} from "wrangler";
import { getAssetsConfig } from "./asset-config";
import {
ASSET_WORKER_NAME,
kRequestType,
ROUTER_WORKER_NAME,
VITE_PROXY_WORKER_NAME,
} from "./constants";
import { getContainerOptions, getDockerPath } from "./containers";
import { additionalModuleRE } from "./plugins/additional-modules";
import { withTrailingSlash } from "./utils";
import type { CloudflareDevEnvironment } from "./cloudflare-environment";
import type {
AssetsOnlyResolvedConfig,
PersistState,
PreviewResolvedConfig,
WorkerConfig,
WorkersResolvedConfig,
} from "./plugin-config";
import type {
MiniflareOptions,
WorkerdStructuredLog,
WorkerOptions,
} from "miniflare";
import type {
Binding,
RemoteProxySession,
SourcelessWorkerOptions,
} from "wrangler";
const INTERNAL_WORKERS_COMPATIBILITY_DATE = "2024-10-04";
// Used to mark HTML assets as being in the public directory so that they can be resolved from their root relative paths
const PUBLIC_DIR_PREFIX = "/__vite_public_dir__";
function getPersistenceRoot(
root: string,
persistState: PersistState
): string | undefined {
if (persistState === false) {
return;
}
const defaultPersistPath = ".wrangler/state";
const persistPath = path.resolve(
root,
typeof persistState === "object" ? persistState.path : defaultPersistPath,
"v3"
);
return persistPath;
}
function missingWorkerErrorMessage(workerName: string) {
return `${workerName} does not match a worker name.`;
}
function getWorkerToWorkerEntrypointNamesMap(
workers: Array<Pick<WorkerOptions, "serviceBindings"> & { name: string }>
) {
const workerToWorkerEntrypointNamesMap = new Map(
workers.map((workerOptions) => [workerOptions.name, new Set<string>()])
);
for (const worker of workers) {
for (const value of Object.values(worker.serviceBindings ?? {})) {
if (
typeof value === "object" &&
"name" in value &&
value.entrypoint !== undefined &&
value.entrypoint !== "default"
) {
const targetWorkerName =
value.name === kCurrentWorker ? worker.name : value.name;
const entrypointNames =
workerToWorkerEntrypointNamesMap.get(targetWorkerName);
if (entrypointNames) {
entrypointNames.add(value.entrypoint);
}
}
}
}
return workerToWorkerEntrypointNamesMap;
}
function getWorkerToDurableObjectClassNamesMap(
workers: Array<Pick<WorkerOptions, "durableObjects"> & { name: string }>
) {
const workerToDurableObjectClassNamesMap = new Map(
workers.map((workerOptions) => [workerOptions.name, new Set<string>()])
);
for (const worker of workers) {
for (const value of Object.values(worker.durableObjects ?? {})) {
if (typeof value === "string") {
const classNames = workerToDurableObjectClassNamesMap.get(worker.name);
assert(classNames, missingWorkerErrorMessage(worker.name));
classNames.add(value);
} else if (typeof value === "object") {
if (value.scriptName) {
const classNames = workerToDurableObjectClassNamesMap.get(
value.scriptName
);
assert(classNames, missingWorkerErrorMessage(value.scriptName));
classNames.add(value.className);
} else {
const classNames = workerToDurableObjectClassNamesMap.get(
worker.name
);
assert(classNames, missingWorkerErrorMessage(worker.name));
classNames.add(value.className);
}
}
}
}
return workerToDurableObjectClassNamesMap;
}
function getWorkerToWorkflowEntrypointClassNamesMap(
workers: Array<Pick<WorkerOptions, "workflows"> & { name: string }>
) {
const workerToWorkflowEntrypointClassNamesMap = new Map(
workers.map((workerOptions) => [workerOptions.name, new Set<string>()])
);
for (const worker of workers) {
for (const value of Object.values(worker.workflows ?? {})) {
if (value.scriptName) {
const classNames = workerToWorkflowEntrypointClassNamesMap.get(
value.scriptName
);
assert(classNames, missingWorkerErrorMessage(value.scriptName));
classNames.add(value.className);
} else {
const classNames = workerToWorkflowEntrypointClassNamesMap.get(
worker.name
);
assert(classNames, missingWorkerErrorMessage(worker.name));
classNames.add(value.className);
}
}
}
return workerToWorkflowEntrypointClassNamesMap;
}
// We want module names to be their absolute path without the leading slash
// (i.e. the modules root should be the root directory). On Windows, we need
// paths to include the drive letter (i.e. `C:/a/b/c/index.mjs`).
// Internally, Miniflare uses `path.relative(modulesRoot, path)` to compute
// module names. Setting `modulesRoot` to a drive letter and prepending this
// to paths ensures correct names. This requires us to specify `contents` in
// the miniflare module definitions though, as the new paths don't exist.
const miniflareModulesRoot = process.platform === "win32" ? "Z:\\" : "/";
const ROUTER_WORKER_PATH = "./workers/router-worker.js";
const ASSET_WORKER_PATH = "./workers/asset-worker.js";
const VITE_PROXY_WORKER_PATH = "./workers/vite-proxy-worker.js";
const RUNNER_PATH = "./workers/runner-worker.js";
const WRAPPER_PATH = "__VITE_WORKER_ENTRY__";
export function getEntryWorkerConfig(
resolvedPluginConfig: AssetsOnlyResolvedConfig | WorkersResolvedConfig
): WorkerConfig | undefined {
if (resolvedPluginConfig.type === "assets-only") {
return;
}
return resolvedPluginConfig.workers[
resolvedPluginConfig.entryWorkerEnvironmentName
];
}
function logUnknownTails(
tails: WorkerOptions["tails"],
userWorkers: { name?: string }[],
log: (msg: string) => void
) {
// Only connect the tail consumers that represent Workers that are defined in the Vite config. Warn that a tail might be omitted otherwise
// This _differs from service bindings_ because tail consumers are "optional" in a sense, and shouldn't affect the runtime behaviour of a Worker
for (const tailService of tails ?? []) {
let name: string;
if (typeof tailService === "string") {
name = tailService;
} else if (
typeof tailService === "object" &&
"name" in tailService &&
typeof tailService.name === "string"
) {
name = tailService.name;
} else {
// Don't interfere with network-based tail connections (e.g. via the dev registry), or kCurrentWorker
continue;
}
const found = userWorkers.some((w) => w.name === name);
if (!found) {
log(
colors.dim(
colors.yellow(
`Tail consumer "${name}" was not found in your config. Make sure you add it to the config or run it in another dev session if you'd like to simulate receiving tail events locally.`
)
)
);
}
}
}
/** Map that maps worker configPaths to their existing remote proxy session data (if any) */
const remoteProxySessionsDataMap = new Map<
string,
{
session: RemoteProxySession;
remoteBindings: Record<string, Binding>;
} | null
>();
export async function getDevMiniflareOptions(config: {
resolvedPluginConfig: AssetsOnlyResolvedConfig | WorkersResolvedConfig;
viteDevServer: vite.ViteDevServer;
inspectorPort: number | false;
containerBuildId?: string;
}): Promise<{
config: Extract<MiniflareOptions, { workers: WorkerOptions[] }>;
allContainerOptions: Map<
string,
NonNullable<ReturnType<typeof getContainerOptions>>[number]
>;
}> {
const { resolvedPluginConfig, viteDevServer, inspectorPort } = config;
const resolvedViteConfig = viteDevServer.config;
const entryWorkerConfig = getEntryWorkerConfig(resolvedPluginConfig);
const assetsConfig = getAssetsConfig(
resolvedPluginConfig,
entryWorkerConfig,
resolvedViteConfig
);
const assetWorkers: Array<WorkerOptions> = [
{
name: ROUTER_WORKER_NAME,
compatibilityDate: INTERNAL_WORKERS_COMPATIBILITY_DATE,
modulesRoot: miniflareModulesRoot,
modules: [
{
type: "ESModule",
path: path.join(miniflareModulesRoot, ROUTER_WORKER_PATH),
contents: fs.readFileSync(
fileURLToPath(new URL(ROUTER_WORKER_PATH, import.meta.url))
),
},
],
bindings: {
CONFIG: {
has_user_worker: resolvedPluginConfig.type === "workers",
},
},
serviceBindings: {
ASSET_WORKER: ASSET_WORKER_NAME,
...(entryWorkerConfig ? { USER_WORKER: entryWorkerConfig.name } : {}),
},
},
{
name: ASSET_WORKER_NAME,
compatibilityDate: INTERNAL_WORKERS_COMPATIBILITY_DATE,
modulesRoot: miniflareModulesRoot,
modules: [
{
type: "ESModule",
path: path.join(miniflareModulesRoot, ASSET_WORKER_PATH),
contents: fs.readFileSync(
fileURLToPath(new URL(ASSET_WORKER_PATH, import.meta.url))
),
},
],
bindings: {
CONFIG: assetsConfig,
__VITE_HEADERS__: JSON.stringify(viteDevServer.config.server.headers),
},
serviceBindings: {
__VITE_HTML_EXISTS__: async (request) => {
const { pathname } = new URL(request.url);
if (pathname.endsWith(".html")) {
const { root, publicDir } = resolvedViteConfig;
const publicDirInRoot = publicDir.startsWith(
withTrailingSlash(root)
);
const publicPath = withTrailingSlash(publicDir.slice(root.length));
// Assets in the public directory should be served at the root path
if (publicDirInRoot && pathname.startsWith(publicPath)) {
return MiniflareResponse.json(null);
}
const publicDirFilePath = path.join(publicDir, pathname);
const rootDirFilePath = path.join(root, pathname);
for (const resolvedPath of [publicDirFilePath, rootDirFilePath]) {
try {
const stats = await fsp.stat(resolvedPath);
if (stats.isFile()) {
return MiniflareResponse.json(
resolvedPath === publicDirFilePath
? `${PUBLIC_DIR_PREFIX}${pathname}`
: pathname
);
}
} catch (error) {}
}
}
return MiniflareResponse.json(null);
},
__VITE_FETCH_HTML__: async (request) => {
const { pathname } = new URL(request.url);
const { root, publicDir } = resolvedViteConfig;
const isInPublicDir = pathname.startsWith(PUBLIC_DIR_PREFIX);
const resolvedPath = isInPublicDir
? path.join(publicDir, pathname.slice(PUBLIC_DIR_PREFIX.length))
: path.join(root, pathname);
try {
let html = await fsp.readFile(resolvedPath, "utf-8");
// HTML files in the public directory should not be transformed
if (!isInPublicDir) {
html = await viteDevServer.transformIndexHtml(resolvedPath, html);
}
return new MiniflareResponse(html, {
headers: { "Content-Type": "text/html" },
});
} catch (error) {
throw new Error(`Unexpected error. Failed to load "${pathname}".`);
}
},
},
},
{
name: VITE_PROXY_WORKER_NAME,
compatibilityDate: INTERNAL_WORKERS_COMPATIBILITY_DATE,
modulesRoot: miniflareModulesRoot,
modules: [
{
type: "ESModule",
path: path.join(miniflareModulesRoot, VITE_PROXY_WORKER_PATH),
contents: fs.readFileSync(
fileURLToPath(new URL(VITE_PROXY_WORKER_PATH, import.meta.url))
),
},
],
serviceBindings: {
...(entryWorkerConfig
? { ENTRY_USER_WORKER: entryWorkerConfig.name }
: {}),
__VITE_MIDDLEWARE__: {
node: (req, res) => viteDevServer.middlewares(req, res),
},
},
},
];
let allContainerOptions = new Map<
string,
NonNullable<ReturnType<typeof getContainerOptions>>[number]
>();
const workersFromConfig =
resolvedPluginConfig.type === "workers"
? await Promise.all(
Object.entries(resolvedPluginConfig.workers).map(
async ([environmentName, workerConfig]) => {
const bindings =
unstable_convertConfigBindingsToStartWorkerBindings(
workerConfig
);
const preExistingRemoteProxySession = workerConfig.configPath
? remoteProxySessionsDataMap.get(workerConfig.configPath)
: undefined;
const remoteProxySessionData =
await maybeStartOrUpdateRemoteProxySession(
{
name: workerConfig.name,
bindings: bindings ?? {},
},
preExistingRemoteProxySession ?? null
);
if (workerConfig.configPath && remoteProxySessionData) {
remoteProxySessionsDataMap.set(
workerConfig.configPath,
remoteProxySessionData
);
}
let containerBuildId: string | undefined;
if (
workerConfig.containers?.length &&
workerConfig.dev.enable_containers
) {
const dockerPath = getDockerPath();
workerConfig.dev.container_engine =
resolveDockerHost(dockerPath);
containerBuildId = generateContainerBuildId();
const options = await getContainerOptions({
containersConfig: workerConfig.containers,
containerBuildId,
configPath: workerConfig.configPath,
});
for (const option of options ?? []) {
allContainerOptions.set(option.image_tag, option);
}
}
const miniflareWorkerOptions = unstable_getMiniflareWorkerOptions(
{
...workerConfig,
assets: undefined,
},
resolvedPluginConfig.cloudflareEnv,
{
remoteProxyConnectionString:
remoteProxySessionData?.session
?.remoteProxyConnectionString,
containerBuildId,
}
);
const { externalWorkers } = miniflareWorkerOptions;
const workerOptions = miniflareWorkerOptions.workerOptions;
return {
externalWorkers,
worker: {
...workerOptions,
name: workerOptions.name ?? workerConfig.name,
unsafeInspectorProxy: inspectorPort !== false,
unsafeDirectSockets:
environmentName ===
resolvedPluginConfig.entryWorkerEnvironmentName
? [
{
// This exposes the default entrypoint of the asset proxy worker
// on the dev registry with the name of the entry worker
serviceName: VITE_PROXY_WORKER_NAME,
entrypoint: undefined,
proxy: true,
},
]
: [],
modulesRoot: miniflareModulesRoot,
unsafeEvalBinding: "__VITE_UNSAFE_EVAL__",
serviceBindings: {
...workerOptions.serviceBindings,
...(environmentName ===
resolvedPluginConfig.entryWorkerEnvironmentName &&
workerConfig.assets?.binding
? {
[workerConfig.assets.binding]: {
node: (req, res) => {
req[kRequestType] = "asset";
viteDevServer.middlewares(req, res);
},
},
}
: {}),
__VITE_INVOKE_MODULE__: async (request) => {
const payload =
(await request.json()) as vite.CustomPayload;
const devEnvironment = viteDevServer.environments[
environmentName
] as CloudflareDevEnvironment;
const result =
await devEnvironment.hot.handleInvoke(payload);
return MiniflareResponse.json(result);
},
},
} satisfies Partial<WorkerOptions>,
};
}
)
)
: [];
const userWorkers = workersFromConfig.map((options) => options.worker);
const externalWorkers = workersFromConfig.flatMap(
(options) => options.externalWorkers
);
const workerToWorkerEntrypointNamesMap =
getWorkerToWorkerEntrypointNamesMap(userWorkers);
const workerToDurableObjectClassNamesMap =
getWorkerToDurableObjectClassNamesMap(userWorkers);
const workerToWorkflowEntrypointClassNamesMap =
getWorkerToWorkflowEntrypointClassNamesMap(userWorkers);
const logger = new ViteMiniflareLogger(resolvedViteConfig);
return {
config: {
log: logger,
logRequests: false,
inspectorPort: inspectorPort === false ? undefined : inspectorPort,
unsafeDevRegistryPath: getDefaultDevRegistryPath(),
unsafeTriggerHandlers: true,
handleStructuredLogs: getStructuredLogsLogger(logger),
defaultPersistRoot: getPersistenceRoot(
resolvedViteConfig.root,
resolvedPluginConfig.persistState
),
workers: [
...assetWorkers,
...externalWorkers,
...userWorkers.map((workerOptions) => {
const wrappers = [
`import { createWorkerEntrypointWrapper, createDurableObjectWrapper, createWorkflowEntrypointWrapper } from '${RUNNER_PATH}';`,
`export { __VITE_RUNNER_OBJECT__ } from '${RUNNER_PATH}';`,
`export default createWorkerEntrypointWrapper('default');`,
];
const workerEntrypointNames = workerToWorkerEntrypointNamesMap.get(
workerOptions.name
);
assert(
workerEntrypointNames,
`WorkerEntrypoint names not found for worker ${workerOptions.name}`
);
for (const entrypointName of [...workerEntrypointNames].sort()) {
wrappers.push(
`export const ${entrypointName} = createWorkerEntrypointWrapper('${entrypointName}');`
);
}
const durableObjectClassNames =
workerToDurableObjectClassNamesMap.get(workerOptions.name);
assert(
durableObjectClassNames,
`DurableObject class names not found for worker ${workerOptions.name}`
);
for (const className of [...durableObjectClassNames].sort()) {
wrappers.push(
`export const ${className} = createDurableObjectWrapper('${className}');`
);
}
const workflowEntrypointClassNames =
workerToWorkflowEntrypointClassNamesMap.get(workerOptions.name);
assert(
workflowEntrypointClassNames,
`WorkflowEntrypoint class names not found for worker: ${workerOptions.name}`
);
for (const className of [...workflowEntrypointClassNames].sort()) {
wrappers.push(
`export const ${className} = createWorkflowEntrypointWrapper('${className}');`
);
}
logUnknownTails(
workerOptions.tails,
userWorkers,
viteDevServer.config.logger.warn
);
return {
...workerOptions,
durableObjects: {
...workerOptions.durableObjects,
__VITE_RUNNER_OBJECT__: {
className: "__VITE_RUNNER_OBJECT__",
unsafeUniqueKey: kUnsafeEphemeralUniqueKey,
unsafePreventEviction: true,
},
},
modules: [
{
type: "ESModule",
path: path.join(miniflareModulesRoot, WRAPPER_PATH),
contents: wrappers.join("\n"),
},
{
type: "ESModule",
path: path.join(miniflareModulesRoot, RUNNER_PATH),
contents: fs.readFileSync(
fileURLToPath(new URL(RUNNER_PATH, import.meta.url))
),
},
],
unsafeUseModuleFallbackService: true,
} satisfies WorkerOptions;
}),
],
async unsafeModuleFallbackService(request) {
const url = new URL(request.url);
const rawSpecifier = url.searchParams.get("rawSpecifier");
assert(
rawSpecifier,
`Unexpected error: no specifier in request to module fallback service.`
);
const match = additionalModuleRE.exec(rawSpecifier);
assert(
match,
`Unexpected error: no match for module: ${rawSpecifier}.`
);
const [full, moduleType, modulePath] = match;
assert(
moduleType,
`Unexpected error: module type not found in reference: ${full}.`
);
assert(
modulePath,
`Unexpected error: module path not found in reference: ${full}.`
);
let contents: Buffer;
try {
contents = await fsp.readFile(modulePath);
} catch (error) {
throw new Error(
`Import "${modulePath}" not found. Does the file exist?`
);
}
switch (moduleType) {
case "CompiledWasm": {
return MiniflareResponse.json({ wasm: Array.from(contents) });
}
case "Data": {
return MiniflareResponse.json({ data: Array.from(contents) });
}
case "Text": {
return MiniflareResponse.json({ text: contents.toString() });
}
default: {
return MiniflareResponse.error();
}
}
},
},
allContainerOptions,
};
}
function getPreviewModules(
main: string,
modulesRules: SourcelessWorkerOptions["modulesRules"]
) {
assert(modulesRules, `Unexpected error: 'modulesRules' is undefined`);
const rootPath = path.dirname(main);
const entryPath = path.basename(main);
return {
rootPath,
modules: [
{
type: "ESModule",
path: entryPath,
} as const,
...modulesRules.flatMap(({ type, include }) =>
globSync(include, { cwd: rootPath, ignore: entryPath }).map((path) => ({
type,
path,
}))
),
],
} satisfies Pick<WorkerOptions, "rootPath" | "modules">;
}
export async function getPreviewMiniflareOptions(config: {
resolvedPluginConfig: PreviewResolvedConfig;
vitePreviewServer: vite.PreviewServer;
inspectorPort: number | false;
}): Promise<{
config: Extract<MiniflareOptions, { workers: WorkerOptions[] }>;
allContainerOptions: Map<
string,
NonNullable<ReturnType<typeof getContainerOptions>>[number]
>;
}> {
const { resolvedPluginConfig, vitePreviewServer, inspectorPort } = config;
const resolvedViteConfig = vitePreviewServer.config;
let allContainerOptions = new Map<
string,
NonNullable<ReturnType<typeof getContainerOptions>>[number]
>();
const workers: Array<WorkerOptions> = (
await Promise.all(
resolvedPluginConfig.workers.map(async (workerConfig, i) => {
const bindings =
unstable_convertConfigBindingsToStartWorkerBindings(workerConfig);
const preExistingRemoteProxySessionData = workerConfig.configPath
? remoteProxySessionsDataMap.get(workerConfig.configPath)
: undefined;
const remoteProxySessionData =
await maybeStartOrUpdateRemoteProxySession(
{
name: workerConfig.name,
bindings: bindings ?? {},
},
preExistingRemoteProxySessionData ?? null
);
if (workerConfig.configPath && remoteProxySessionData) {
remoteProxySessionsDataMap.set(
workerConfig.configPath,
remoteProxySessionData
);
}
let containerBuildId: string | undefined;
if (
workerConfig.containers?.length &&
workerConfig.dev.enable_containers
) {
const dockerPath = getDockerPath();
workerConfig.dev.container_engine = resolveDockerHost(dockerPath);
containerBuildId = generateContainerBuildId();
const options = await getContainerOptions({
containersConfig: workerConfig.containers,
containerBuildId,
configPath: workerConfig.configPath,
});
for (const option of options ?? []) {
allContainerOptions.set(option.image_tag, option);
}
}
const miniflareWorkerOptions = unstable_getMiniflareWorkerOptions(
workerConfig,
undefined,
{
remoteProxyConnectionString:
remoteProxySessionData?.session?.remoteProxyConnectionString,
containerBuildId,
}
);
const { externalWorkers } = miniflareWorkerOptions;
const { modulesRules, ...workerOptions } =
miniflareWorkerOptions.workerOptions;
logUnknownTails(
workerOptions.tails,
resolvedPluginConfig.workers,
vitePreviewServer.config.logger.warn
);
return [
{
...workerOptions,
name: workerOptions.name ?? workerConfig.name,
unsafeInspectorProxy: inspectorPort !== false,
unsafeDirectSockets:
// This exposes the default entrypoint of the entry worker on the dev registry
// Assuming that the first worker config to be the entry worker.
i === 0 ? [{ entrypoint: undefined, proxy: true }] : [],
...(miniflareWorkerOptions.main
? getPreviewModules(miniflareWorkerOptions.main, modulesRules)
: { modules: true, script: "" }),
},
...externalWorkers,
] satisfies Array<WorkerOptions>;
})
)
).flat();
const logger = new ViteMiniflareLogger(resolvedViteConfig);
return {
config: {
log: logger,
inspectorPort: inspectorPort === false ? undefined : inspectorPort,
unsafeDevRegistryPath: getDefaultDevRegistryPath(),
unsafeTriggerHandlers: true,
handleStructuredLogs: getStructuredLogsLogger(logger),
defaultPersistRoot: getPersistenceRoot(
resolvedViteConfig.root,
resolvedPluginConfig.persistState
),
workers,
},
allContainerOptions,
};
}
/**
* A Miniflare logger that forwards messages onto a Vite logger.
*/
class ViteMiniflareLogger extends Log {
private logger: vite.Logger;
constructor(config: vite.ResolvedConfig) {
super(miniflareLogLevelFromViteLogLevel(config.logLevel));
this.logger = config.logger;
}
override logWithLevel(level: LogLevel, message: string) {
switch (level) {
case LogLevel.ERROR:
return this.logger.error(message);
case LogLevel.WARN:
return this.logger.warn(message);
case LogLevel.INFO:
return this.logger.info(message);
}
}
override logReady() {
// Noop so that Miniflare server start messages are not logged
}
}
function miniflareLogLevelFromViteLogLevel(
level: vite.LogLevel = "info"
): LogLevel {
switch (level) {
case "error":
return LogLevel.ERROR;
case "warn":
return LogLevel.WARN;
case "info":
return LogLevel.INFO;
case "silent":
return LogLevel.NONE;
}
}
/**
* Generates a log handler to be passed as the `handleStructuredLogs` option to miniflare
*
* @param logger the vite logger to use
* @returns the log handler to pass to miniflare
*/
function getStructuredLogsLogger(logger: Log) {
return ({ level, message }: WorkerdStructuredLog) => {
if (level === "warn") {
return logger.warn(message);
}
if (level === "error") {
return logger.logWithLevel(LogLevel.ERROR, message);
}
return logger.info(message);
};
}