@cloudflare/pages-shared 0.0.0-ship-js

package/dist/__tests__/metadata-generator/parseRedirects.invalid.test.js

@@ -0,0 +1,243 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Snapshot values
+const maxDynamicRedirectRules = 100;
+const maxLineLength = 2000;
+const maxStaticRedirectRules = 2000;
+const parseRedirects_1 = require("../..//metadata-generator/parseRedirects");
+test("parseRedirects should reject malformed lines", () => {
+    const input = `
+    # Single token
+    /c
+    # Four tokens
+    /d /e 302 !important
+  `;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [],
+        invalid: [
+            {
+                line: `/c`,
+                lineNumber: 3,
+                message: "Expected exactly 2 or 3 whitespace-separated tokens. Got 1.",
+            },
+            {
+                line: `/d /e 302 !important`,
+                lineNumber: 5,
+                message: "Expected exactly 2 or 3 whitespace-separated tokens. Got 4.",
+            },
+        ],
+    });
+});
+test("parseRedirects should reject invalid status codes", () => {
+    const input = `
+    # Valid token sails through
+    /a /b 301
+    # 200 NOT OK
+    /c /d 200
+  `;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 301, to: "/b", lineNumber: 3 }],
+        invalid: [
+            {
+                line: `/c /d 200`,
+                lineNumber: 5,
+                message: "Valid status codes are 301, 302 (default), 303, 307, or 308. Got 200.",
+            },
+        ],
+    });
+});
+test(`parseRedirects should reject duplicate 'from' paths`, () => {
+    const input = `
+    # Valid entry
+    /a /b
+    # Nonsensical but permitted (for now)
+    /b /a
+    # Duplicate 'from'
+    /a /c
+  `;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [
+            { from: "/a", status: 302, to: "/b", lineNumber: 3 },
+            { from: "/b", status: 302, to: "/a", lineNumber: 5 },
+        ],
+        invalid: [
+            {
+                line: `/a /c`,
+                lineNumber: 7,
+                message: `Ignoring duplicate rule for path /a.`,
+            },
+        ],
+    });
+});
+test(`parseRedirects should reject lines longer than ${maxLineLength} chars`, () => {
+    const huge_line = `/${Array(maxLineLength).fill("a").join("")} /${Array(maxLineLength)
+        .fill("b")
+        .join("")} 301`;
+    const input = `
+    # Valid entry
+    /a /b
+    # Jumbo comment line OK, ignored as normal
+    ${Array(maxLineLength + 1)
+        .fill("#")
+        .join("")}
+    # Huge path names rejected
+    ${huge_line}
+  `;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 302, to: "/b", lineNumber: 3 }],
+        invalid: [
+            {
+                message: `Ignoring line 7 as it exceeds the maximum allowed length of ${maxLineLength}.`,
+            },
+        ],
+    });
+});
+test("parseRedirects should reject any dynamic rules after the first 100", () => {
+    const input = `
+    # COMMENTS DON'T COUNT TOWARDS TOTAL VALID RULES
+    ${Array(150)
+        .fill(undefined)
+        .map((_, i) => `/a/${i}/* /b/${i}/:splat`)
+        .join("\n")}
+    # BUT DO GET COUNTED AS TOTAL LINES SKIPPED
+  `;
+    expect((0, parseRedirects_1.parseRedirects)(input)).toEqual({
+        rules: Array(100)
+            .fill(undefined)
+            .map((_, i) => ({
+            from: `/a/${i}/*`,
+            to: `/b/${i}/:splat`,
+            status: 302,
+            lineNumber: i + 3,
+        })),
+        invalid: [
+            {
+                message: `Maximum number of dynamic rules supported is 100. Skipping remaining 52 lines of file.`,
+            },
+        ],
+    });
+});
+test(`parseRedirects should reject any static rules after the first ${maxStaticRedirectRules}`, () => {
+    const input = `
+    # COMMENTS DON'T COUNT TOWARDS TOTAL VALID RULES
+    ${Array(maxStaticRedirectRules + 50)
+        .fill(undefined)
+        .map((_, i) => `/a/${i} /b/${i}`)
+        .join("\n")}
+    # BUT DO GET COUNTED AS TOTAL LINES SKIPPED
+  `;
+    expect((0, parseRedirects_1.parseRedirects)(input)).toEqual({
+        rules: Array(maxStaticRedirectRules)
+            .fill(undefined)
+            .map((_, i) => ({
+            from: `/a/${i}`,
+            to: `/b/${i}`,
+            status: 302,
+            lineNumber: i + 3,
+        })),
+        invalid: Array(50)
+            .fill(undefined)
+            .map(() => ({
+            message: `Maximum number of static rules supported is ${maxStaticRedirectRules}. Skipping line.`,
+        })),
+    });
+});
+test("parseRedirects should reject a combination of lots of static and dynamic rules", () => {
+    const input = `
+    # COMMENTS DON'T COUNT TOWARDS TOTAL VALID RULES
+    ${Array(maxStaticRedirectRules + 50)
+        .fill(undefined)
+        .map((_, i) => `/a/${i} /b/${i}`)
+        .join("\n")}
+      ${Array(maxDynamicRedirectRules + 50)
+        .fill(undefined)
+        .map((_, i) => `/a/${i}/* /b/${i}/:splat`)
+        .join("\n")}
+    # BUT DO GET COUNTED AS TOTAL LINES SKIPPED
+  `;
+    expect((0, parseRedirects_1.parseRedirects)(input)).toEqual({
+        rules: [
+            ...Array(maxStaticRedirectRules)
+                .fill(undefined)
+                .map((_, i) => ({
+                from: `/a/${i}`,
+                to: `/b/${i}`,
+                status: 302,
+                lineNumber: i + 3,
+            })),
+            ...Array(maxDynamicRedirectRules)
+                .fill(undefined)
+                .map((_, i) => ({
+                from: `/a/${i}/*`,
+                to: `/b/${i}/:splat`,
+                status: 302,
+                lineNumber: i + maxStaticRedirectRules + 53,
+            })),
+        ],
+        invalid: [
+            ...Array(50)
+                .fill(undefined)
+                .map(() => ({
+                message: `Maximum number of static rules supported is ${maxStaticRedirectRules}. Skipping line.`,
+            })),
+            {
+                message: `Maximum number of dynamic rules supported is ${maxDynamicRedirectRules}. Skipping remaining 52 lines of file.`,
+            },
+        ],
+    });
+});
+test("parseRedirects should reject malformed URLs", () => {
+    const input = `
+  # Spaces rejected on token length
+  /some page /somewhere else
+  # OK with URL escaped encoding
+  /some%20page /somewhere%20else
+  # Unescaped URLs are handled OK by Deno, so escape & pass them through
+  /://so;\`me /nons:/&@%+~{}ense
+  # Absolute URLs aren't OK for 'from', but are fine for 'to'
+  https://yeah.com https://nah.com
+  /nah https://yeah.com
+  # This is actually parsed as /yeah.com, which we might want to detect but is ok for now
+  yeah.com https://nah.com
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        invalid: [
+            {
+                line: `/some page /somewhere else`,
+                lineNumber: 3,
+                message: "Expected exactly 2 or 3 whitespace-separated tokens. Got 4.",
+            },
+            {
+                line: `https://yeah.com https://nah.com`,
+                lineNumber: 9,
+                message: "Only relative URLs are allowed. Skipping absolute URL https://yeah.com.",
+            },
+        ],
+        rules: [
+            {
+                from: "/some%20page",
+                status: 302,
+                to: "/somewhere%20else",
+                lineNumber: 5,
+            },
+            {
+                from: "/://so;%60me",
+                status: 302,
+                to: "/nons:/&@%+~%7B%7Dense",
+                lineNumber: 7,
+            },
+            { from: "/nah", status: 302, to: "https://yeah.com/", lineNumber: 10 },
+            {
+                from: "/yeah.com",
+                status: 302,
+                to: "https://nah.com/",
+                lineNumber: 12,
+            },
+        ],
+    });
+});

package/dist/__tests__/metadata-generator/parseRedirects.valid.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=parseRedirects.valid.test.d.ts.map

package/dist/__tests__/metadata-generator/parseRedirects.valid.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseRedirects.valid.test.d.ts","sourceRoot":"","sources":["../../../__tests__/metadata-generator/parseRedirects.valid.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/metadata-generator/parseRedirects.valid.test.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const parseRedirects_1 = require("../../metadata-generator/parseRedirects");
+test("parseRedirects should handle a single rule", () => {
+    const input = `/a /b 301`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 301, to: "/b", lineNumber: 1 }],
+        invalid: [],
+    });
+});
+test("parseRedirects should ignore blank lines", () => {
+    const input = `
+/a /b 301
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 301, to: "/b", lineNumber: 2 }],
+        invalid: [],
+    });
+});
+test("parseRedirects should trim whitespace", () => {
+    const input = `
+  /a /b 301
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 301, to: "/b", lineNumber: 2 }],
+        invalid: [],
+    });
+});
+test("parseRedirects should ignore comments", () => {
+    const input = `
+  # This is a comment
+  /a /b 301
+  # And one here too.
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 301, to: "/b", lineNumber: 3 }],
+        invalid: [],
+    });
+});
+test("parseRedirects should default to 302", () => {
+    const input = `
+  /a /b 302
+  /c /d
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [
+            { from: "/a", status: 302, to: "/b", lineNumber: 2 },
+            { from: "/c", status: 302, to: "/d", lineNumber: 3 },
+        ],
+        invalid: [],
+    });
+});
+test("parseRedirects should preserve querystrings on to", () => {
+    const input = `
+  /a /b?query=string 302
+  /c?this=rejected /d 301
+  /ext https://some.domain:1234/route?q=string#anchor
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [
+            { from: "/a", status: 302, to: "/b?query=string", lineNumber: 2 },
+            { from: "/c", status: 301, to: "/d", lineNumber: 3 },
+            {
+                from: "/ext",
+                status: 302,
+                to: "https://some.domain:1234/route?q=string#anchor",
+                lineNumber: 4,
+            },
+        ],
+        invalid: [],
+    });
+});
+test("parseRedirects should preserve fragments", () => {
+    const input = `
+  /a /b#blah 302
+`;
+    const result = (0, parseRedirects_1.parseRedirects)(input);
+    expect(result).toEqual({
+        rules: [{ from: "/a", status: 302, to: "/b#blah", lineNumber: 2 }],
+        invalid: [],
+    });
+});

package/dist/asset-server/handler.d.ts

@@ -0,0 +1,44 @@
+import type { Metadata, MetadataHeadersRulesV2, MetadataHeadersV1, MetadataHeadersV2 } from "./metadata";
+export declare const ASSET_PRESERVATION_CACHE = "assetPreservationCache";
+export declare const CACHE_CONTROL_BROWSER = "public, max-age=0, must-revalidate";
+export declare const REDIRECTS_VERSION = 1;
+export declare const HEADERS_VERSION = 2;
+export declare const HEADERS_VERSION_V1 = 1;
+export declare const ANALYTICS_VERSION = 1;
+export declare function normaliseHeaders(headers: MetadataHeadersV1 | MetadataHeadersV2): MetadataHeadersRulesV2;
+declare type FindAssetEntryForPath<AssetEntry> = (path: string) => Promise<null | AssetEntry>;
+declare type ServeAsset<AssetEntry> = (assetEntry: AssetEntry, options?: {
+    preserve: boolean;
+}) => Promise<Response>;
+declare type FullHandlerContext<AssetEntry, ContentNegotiation, Asset> = {
+    request: Request;
+    metadata: Metadata;
+    xServerEnvHeader?: string;
+    logError: (err: Error) => void;
+    findAssetEntryForPath: FindAssetEntryForPath<AssetEntry>;
+    getAssetKey(assetEntry: AssetEntry, content: ContentNegotiation): string;
+    negotiateContent(request: Request, assetEntry: AssetEntry): ContentNegotiation;
+    fetchAsset: (assetKey: string) => Promise<Asset>;
+    generateNotFoundResponse?: (request: Request, findAssetEntryForPath: FindAssetEntryForPath<AssetEntry>, serveAsset: ServeAsset<AssetEntry>) => Promise<Response>;
+    attachAdditionalHeaders?: (response: Response, content: ContentNegotiation, assetEntry: AssetEntry, asset: Asset) => void;
+    caches: CacheStorage;
+    waitUntil: (promise: Promise<unknown>) => void;
+};
+export declare type HandlerContext<AssetEntry, ContentNegotiation, Asset> = FullHandlerContext<AssetEntry, ContentNegotiation, Asset> | (Omit<FullHandlerContext<AssetEntry, ContentNegotiation, Asset>, "caches" | "waitUntil"> & {
+    caches?: undefined;
+    waitUntil?: undefined;
+});
+export declare function generateHandler<AssetEntry, ContentNegotiation extends {
+    encoding: string | null;
+} = {
+    encoding: string | null;
+}, Asset extends {
+    body: ReadableStream | null;
+    contentType: string;
+} = {
+    body: ReadableStream | null;
+    contentType: string;
+}>({ request, metadata, xServerEnvHeader, logError, findAssetEntryForPath, getAssetKey, negotiateContent, fetchAsset, generateNotFoundResponse, attachAdditionalHeaders, caches, waitUntil, }: HandlerContext<AssetEntry, ContentNegotiation, Asset>): Promise<Response>;
+export declare function parseQualityWeightedList(list?: string): Record<string, number>;
+export {};
+//# sourceMappingURL=handler.d.ts.map

package/dist/asset-server/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../asset-server/handler.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EACX,QAAQ,EAER,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,YAAY,CAAC;AAOpB,eAAO,MAAM,wBAAwB,2BAA2B,CAAC;AAGjE,eAAO,MAAM,qBAAqB,uCAAuC,CAAC;AAC1E,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,eAAO,MAAM,eAAe,IAAI,CAAC;AACjC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AASnC,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,iBAAiB,GAAG,iBAAiB,GAC5C,sBAAsB,CAgBxB;AAED,aAAK,qBAAqB,CAAC,UAAU,IAAI,CACxC,IAAI,EAAE,MAAM,KACR,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC;AAEhC,aAAK,UAAU,CAAC,UAAU,IAAI,CAC7B,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAA;CAAE,KAC3B,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB,aAAK,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,EAAE,KAAK,IAAI;IAChE,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAC;IAC/B,qBAAqB,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACzD,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAAC;IACzE,gBAAgB,CACf,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,UAAU,GACpB,kBAAkB,CAAC;IACtB,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC;IACjD,wBAAwB,CAAC,EAAE,CAC1B,OAAO,EAAE,OAAO,EAChB,qBAAqB,EAAE,qBAAqB,CAAC,UAAU,CAAC,EACxD,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,KAC9B,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvB,uBAAuB,CAAC,EAAE,CACzB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE,kBAAkB,EAC3B,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,KAAK,KACR,IAAI,CAAC;IACV,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;CAC/C,CAAC;AAEF,oBAAY,cAAc,CAAC,UAAU,EAAE,kBAAkB,EAAE,KAAK,IAC7D,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,EAAE,KAAK,CAAC,GACzD,CAAC,IAAI,CACL,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,EAAE,KAAK,CAAC,EACzD,QAAQ,GAAG,WAAW,CACrB,GAAG;IACJ,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,SAAS,CAAC,EAAE,SAAS,CAAC;CACrB,CAAC,CAAC;AAEN,wBAAsB,eAAe,CACpC,UAAU,EACV,kBAAkB,SAAS;IAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAAG;IACxD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,EACD,KAAK,SAAS;IAAE,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG;IACpE,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACpB,EACA,EACD,OAAO,EACP,QAAQ,EACR,gBAAgB,EAChB,QAAQ,EACR,qBAAqB,EACrB,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,wBAYC,EACD,uBAAkC,EAClC,MAAM,EACN,SAAS,GACT,EAAE,cAAc,CAAC,UAAU,EAAE,kBAAkB,EAAE,KAAK,CAAC,qBAicvD;AAID,wBAAgB,wBAAwB,CAAC,IAAI,SAAK,0BAWjD"}