Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/serious-beans-trade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"wrangler": patch
---

fix: ensure `console.log()`s during startup are displayed

Previously, `console.log()` calls before the Workers runtime was ready to
receive requests wouldn't be shown. This meant any logs in the global scope
likely weren't visible. This change ensures startup logs are shown. In particular,
this should [fix Remix's HMR](https://github.com/remix-run/remix/issues/7616),
which relies on startup logs to know when the Worker is ready.
5 changes: 3 additions & 2 deletions fixtures/shared/src/run-wrangler-long-lived.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ async function runLongLivedWrangler(command: string[], cwd: string) {
const chunks: Buffer[] = [];
wranglerProcess.stdout?.on("data", (chunk) => chunks.push(chunk));
wranglerProcess.stderr?.on("data", (chunk) => chunks.push(chunk));
const getOutput = () => Buffer.concat(chunks).toString();

const timeoutHandle = setTimeout(() => {
if (settledReadyPromise) return;
Expand All @@ -65,7 +66,7 @@ async function runLongLivedWrangler(command: string[], cwd: string) {
const message = [
"Timed out starting long-lived Wrangler:",
separator,
Buffer.concat(chunks).toString(),
getOutput(),
separator,
].join("\n");
rejectReadyPromise(new Error(message));
Expand All @@ -85,5 +86,5 @@ async function runLongLivedWrangler(command: string[], cwd: string) {
}

const { ip, port } = await ready;
return { ip, port, stop };
return { ip, port, stop, getOutput };
}
4 changes: 4 additions & 0 deletions fixtures/worker-app/src/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { now } from "./dep";
import { randomBytes } from "isomorphic-random-example";

console.log("startup log");

/** @param {Uint8Array} array */
function hexEncode(array) {
return Array.from(array)
Expand All @@ -10,6 +12,8 @@ function hexEncode(array) {

export default {
async fetch(request) {
console.log("request log");

const { pathname } = new URL(request.url);
if (pathname === "/random") return new Response(hexEncode(randomBytes(8)));

Expand Down
18 changes: 13 additions & 5 deletions fixtures/worker-app/tests/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ import { describe, it, beforeAll, afterAll } from "vitest";
import { runWranglerDev } from "../../shared/src/run-wrangler-long-lived";

describe("'wrangler dev' correctly renders pages", () => {
let ip: string, port: number, stop: (() => Promise<unknown>) | undefined;
let ip: string,
port: number,
stop: (() => Promise<unknown>) | undefined,
getOutput: () => string;

beforeAll(async () => {
({ ip, port, stop } = await runWranglerDev(resolve(__dirname, ".."), [
"--local",
"--port=0",
]));
({ ip, port, stop, getOutput } = await runWranglerDev(
resolve(__dirname, ".."),
["--local", "--port=0"]
));
});

afterAll(async () => {
Expand All @@ -21,6 +24,11 @@ describe("'wrangler dev' correctly renders pages", () => {
const response = await fetch(`http://${ip}:${port}/`);
const text = await response.text();
expect(text).toContain(`http://${ip}:${port}/`);

// Ensure `console.log()`s from startup and requests are shown
const output = getOutput();
expect(output).toContain("startup log");
expect(output).toContain("request log");
});

it("uses `workerd` condition when bundling", async ({ expect }) => {
Expand Down
8 changes: 4 additions & 4 deletions packages/wrangler/src/dev/inspect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,10 @@ export default function useInspector(props: InspectorProps) {
*/
function close(): void {
if (!isClosed()) {
send({
method: "Runtime.discardConsoleEntries",
id: messageCounterRef.current++,
});
try {
ws.close();
} catch (err) {
Expand Down Expand Up @@ -378,10 +382,6 @@ export default function useInspector(props: InspectorProps) {
}

ws.addEventListener("open", () => {
send({
method: "Runtime.discardConsoleEntries",
id: messageCounterRef.current++,
});
send({ method: "Runtime.enable", id: messageCounterRef.current++ });
// TODO: This doesn't actually work. Must fix.
send({ method: "Network.enable", id: messageCounterRef.current++ });
Expand Down