Skip to content

[wranger] fix: createMetadataObject to use logging levels (#4265) #4819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
petebacondarwin merged 2 commits into from
Jan 29, 2024
Merged

[wranger] fix: createMetadataObject to use logging levels (#4265) #4819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1584c0
[wranger] fix: createMetadataObject to use logging levels (#4265)
magnusdahlstrand Jan 23, 2024
c3a2396
Update .changeset/wet-lemons-wash.md
magnusdahlstrand Jan 29, 2024
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
6 changes: 6 additions & 0 deletions .changeset/wet-lemons-wash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@cloudflare/pages-shared": patch
"wrangler": patch
---

fix: Use appropriate logging levels when parsing headers and redirects in `wrangler pages dev`.
36 changes: 25 additions & 11 deletions packages/pages-shared/metadata-generator/createMetadataObject.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,21 @@ import type {
ParsedRedirects,
} from "./types";

const noopLogger = {
debug: (_message: string) => {},
log: (_message: string) => {},
info: (_message: string) => {},
warn: (_message: string) => {},
error: (_error: Error) => {},
};

export function createMetadataObject({
redirects,
headers,
webAnalyticsToken,
deploymentId,
failOpen,
logger = (_message: string) => {},
logger = noopLogger,
}: {
redirects?: ParsedRedirects;
headers?: ParsedHeaders;
Expand Down Expand Up @@ -51,15 +59,17 @@ function constructRedirects({
const num_valid = redirects.rules.length;
const num_invalid = redirects.invalid.length;

logger(
logger.log(
`Parsed ${num_valid} valid redirect rule${num_valid === 1 ? "" : "s"}.`
);

if (num_invalid > 0) {
logger(`Found invalid redirect lines:`);
logger.warn(`Found invalid redirect lines:`);
for (const { line, lineNumber, message } of redirects.invalid) {
if (line) logger(` - ${lineNumber ? `#${lineNumber}: ` : ""}${line}`);
logger(` ${message}`);
if (line) {
logger.warn(` - ${lineNumber ? `#${lineNumber}: ` : ""}${line}`);
}
logger.warn(` ${message}`);
}
}

Expand All @@ -81,8 +91,8 @@ function constructRedirects({
};
continue;
} else {
logger(
`Info: the redirect rule ${rule.from} → ${rule.status} ${rule.to} could be made more performant by bringing it above any lines with splats or placeholders.`
logger.info(
`The redirect rule ${rule.from} → ${rule.status} ${rule.to} could be made more performant by bringing it above any lines with splats or placeholders.`
);
}
}
Expand Down Expand Up @@ -112,13 +122,17 @@ function constructHeaders({
const num_valid = headers.rules.length;
const num_invalid = headers.invalid.length;

logger(`Parsed ${num_valid} valid header rule${num_valid === 1 ? "" : "s"}.`);
logger.log(
`Parsed ${num_valid} valid header rule${num_valid === 1 ? "" : "s"}.`
);

if (num_invalid > 0) {
logger(`Found invalid header lines:`);
logger.warn(`Found invalid header lines:`);
for (const { line, lineNumber, message } of headers.invalid) {
if (line) logger(` - ${lineNumber ? `#${lineNumber}: ` : ""} ${line}`);
logger(` ${message}`);
if (line) {
logger.warn(` - ${lineNumber ? `#${lineNumber}: ` : ""} ${line}`);
}
logger.warn(` ${message}`);
}
}

Expand Down
8 changes: 7 additions & 1 deletion packages/pages-shared/metadata-generator/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,10 @@ export type Metadata = {
failOpen?: boolean;
};

export type Logger = (message: string) => void;
export interface Logger {
debug: (message: string) => void;
log: (message: string) => void;
info: (message: string) => void;
warn: (message: string) => void;
error: (error: Error) => void;
}
11 changes: 3 additions & 8 deletions packages/wrangler/src/miniflare-cli/assets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { watch } from "chokidar";
import { getType } from "mime";
import { fetch, Request, Response } from "miniflare";
import { hashFile } from "../pages/hash";
import type { Logger } from "../logger";
import type { Metadata } from "@cloudflare/pages-shared/asset-server/metadata";
import type {
ParsedHeaders,
Expand All @@ -15,12 +16,6 @@ import type {
import type { Request as WorkersRequest } from "@cloudflare/workers-types/experimental";
import type { RequestInit } from "miniflare";

interface Logger {
log: (message: string) => void;
warn: (message: string) => void;
error: (error: Error) => void;
}

export interface Options {
log: Logger;
proxyPort?: number;
Expand Down Expand Up @@ -109,7 +104,7 @@ async function generateAssetsFetch(
let metadata = createMetadataObject({
redirects,
headers,
logger: log.warn.bind(log),
logger: log,
});

watch([headersFile, redirectsFile], { persistent: true }).on(
Expand All @@ -133,7 +128,7 @@ async function generateAssetsFetch(
metadata = createMetadataObject({
redirects,
headers,
logger: log.warn,
logger: log,
});
}
);
Expand Down