-
Notifications
You must be signed in to change notification settings - Fork 692
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat[pages]: Add new internal pages functions
optimize-routes comma…
…nd (#1648) This PR adds a new pages functions command called `optimize-routes`. This is an internal-use ONLY command at the moment, and is therefore not exposed to external consumers. The command is meant to parse a given `_routes.json` file, optimize and consolidate the route paths defined in it, and output the resulting optimized file. Co-authored-by: Carmen Popoviciu <[email protected]>
- Loading branch information
1 parent
c40fca4
commit af669a1
Showing
5 changed files
with
180 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "wrangler": patch | ||
| --- | ||
|
|
||
| Implement new wrangler pages functions optimize-routes command |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| import { existsSync, lstatSync, readFileSync, writeFileSync } from "node:fs"; | ||
| import path from "node:path"; | ||
| import { FatalError } from "../errors"; | ||
| import { logger } from "../logger"; | ||
| import { isInPagesCI, ROUTES_SPEC_VERSION } from "./constants"; | ||
| import { | ||
| isRoutesJSONSpec, | ||
| optimizeRoutesJSONSpec, | ||
| } from "./functions/routes-transformation"; | ||
| import { pagesBetaWarning } from "./utils"; | ||
| import type { YargsOptionsToInterface } from "./types"; | ||
| import type { Argv } from "yargs"; | ||
|
|
||
| type OptimizeRoutesArgs = YargsOptionsToInterface<typeof OptimizeRoutesOptions>; | ||
|
|
||
| export function OptimizeRoutesOptions(yargs: Argv) { | ||
| return yargs | ||
| .options({ | ||
| "routes-path": { | ||
| type: "string", | ||
| demandOption: true, | ||
| description: "The location of the _routes.json file", | ||
| }, | ||
| }) | ||
| .options({ | ||
| "output-routes-path": { | ||
| type: "string", | ||
| demandOption: true, | ||
| description: "The location of the optimized output routes file", | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| export async function OptimizeRoutesHandler({ | ||
| routesPath, | ||
| outputRoutesPath, | ||
| }: OptimizeRoutesArgs) { | ||
| if (!isInPagesCI) { | ||
| // Beta message for `wrangler pages <commands>` usage | ||
| logger.log(pagesBetaWarning); | ||
| } | ||
|
|
||
| let routesFileContents: string; | ||
| const routesOutputDirectory = path.dirname(outputRoutesPath); | ||
|
|
||
| if (!existsSync(routesPath)) { | ||
| throw new FatalError( | ||
| `Oops! File ${routesPath} does not exist. Please make sure --routes-path is a valid file path (for example "/public/_routes.json").`, | ||
| 1 | ||
| ); | ||
| } | ||
|
|
||
| if ( | ||
| !existsSync(routesOutputDirectory) || | ||
| !lstatSync(routesOutputDirectory).isDirectory() | ||
| ) { | ||
| throw new FatalError( | ||
| `Oops! Folder ${routesOutputDirectory} does not exist. Please make sure --output-routes-path is a valid file path (for example "/public/_routes.json").`, | ||
| 1 | ||
| ); | ||
| } | ||
|
|
||
| try { | ||
| routesFileContents = readFileSync(routesPath, "utf-8"); | ||
| } catch (err) { | ||
| throw new FatalError(`Error while reading ${routesPath} file: ${err}`); | ||
| } | ||
|
|
||
| const routes = JSON.parse(routesFileContents); | ||
|
|
||
| if (!isRoutesJSONSpec(routes)) { | ||
| throw new FatalError( | ||
| ` | ||
| Invalid _routes.json file found at: ${routesPath}. Please make sure the JSON object has the following format: | ||
| { | ||
| version: ${ROUTES_SPEC_VERSION}; | ||
| include: string[]; | ||
| exclude: string[]; | ||
| } | ||
| `, | ||
| 1 | ||
| ); | ||
| } | ||
|
|
||
| const optimizedRoutes = optimizeRoutesJSONSpec(routes); | ||
| const optimizedRoutesContents = JSON.stringify(optimizedRoutes); | ||
|
|
||
| try { | ||
| writeFileSync(outputRoutesPath, optimizedRoutesContents); | ||
| } catch (err) { | ||
| throw new FatalError( | ||
| `Error writing to ${outputRoutesPath} file: ${err}`, | ||
| 1 | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters