feat(cli): Add check-client command to verify bundle freshness #7517
There are no files selected for viewing
This file contains hidden or 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,6 @@ | ||
| --- | ||
| '@builder.io/qwik-city': patch | ||
| '@builder.io/qwik': patch | ||
| --- | ||
|
|
||
| feat(cli): Add check-client command to verify bundle freshness |
This file contains hidden or 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,155 @@ | ||
| import type { AppCommand } from '../utils/app-command'; | ||
| import { intro, log, outro } from '@clack/prompts'; | ||
| import { bgBlue, bgMagenta, bold, cyan, red } from 'kleur/colors'; | ||
| import { runInPkg } from '../utils/install-deps'; | ||
| import { getPackageManager, panic } from '../utils/utils'; | ||
| import fs from 'fs/promises'; | ||
| import type { Stats } from 'fs'; | ||
| import path from 'path'; | ||
|
|
||
| const getDiskPath = (dist: string) => path.resolve(dist); | ||
| const getSrcPath = (src: string) => path.resolve(src); | ||
| const getManifestPath = (dist: string) => path.resolve(dist, 'q-manifest.json'); | ||
|
|
||
| export async function runQwikClientCommand(app: AppCommand) { | ||
| try { | ||
| const src = app.args[1]; | ||
| const dist = app.args[2]; | ||
| await checkClientCommand(app, src, dist); | ||
| } catch (e) { | ||
| console.error(`❌ ${red(String(e))}\n`); | ||
| process.exit(1); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Handles the core logic for the 'check-client' command. Exports this function so other modules can | ||
| * import and call it. | ||
| * | ||
| * @param {AppCommand} app - Application command context (assuming structure). | ||
| */ | ||
| async function checkClientCommand(app: AppCommand, src: string, dist: string): Promise<void> { | ||
| if (!(await clientDirExists(dist))) { | ||
| intro(`🚀 ${bgBlue(bold(' Qwik Client Check '))}`); | ||
| log.step(`Checking Disk directory: ${cyan(dist)}`); | ||
|
|
||
| await goBuild(app); | ||
| } else { | ||
| log.step(`Checking q-manifest.json file: ${cyan(dist)}`); | ||
|
|
||
| const manifest = await getManifestTs(getManifestPath(dist)); | ||
| if (manifest === null) { | ||
| await goBuild(app); | ||
| } else { | ||
| log.step(`Compare source modification time with q-manifest.json modification time`); | ||
|
|
||
| if (await isNewerThan(getSrcPath(src), manifest)) { | ||
| await goBuild(app); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Builds the application using the appropriate package manager. | ||
| * | ||
| * @param {AppCommand} app - The application command object containing app details.e path to the | ||
| * manifest file (though it's not used in the current function). | ||
| * @throws {Error} Throws an error if the build process encounters any issues. | ||
| */ | ||
|
|
||
| async function goBuild(app: AppCommand) { | ||
| const pkgManager = getPackageManager(); | ||
| log.step('Building client (manifest missing or outdated)...'); | ||
|
|
||
| try { | ||
| const { install } = await runInPkg(pkgManager, ['run', 'build.client'], app.rootDir); | ||
| if (!(await install)) { | ||
| throw new Error('Client build command reported failure.'); | ||
| } | ||
| } catch (buildError: any) { | ||
| log.error(`Build error: ${buildError.message}`); | ||
| throw new Error('Client build process encountered an error.'); | ||
| } | ||
|
Comment on lines
+66
to
+69
There was a problem hiding this comment. no need for the catch, runInPkg already does that |
||
| outro(`✅ ${bgMagenta(bold(' Check complete '))}`); | ||
|
There was a problem hiding this comment. change this to say |
||
| } | ||
|
|
||
| /** | ||
| * Retrieves the last modified timestamp of the manifest file. | ||
| * | ||
| * @param {string} manifestPath - The path to the manifest file. | ||
| * @returns {Promise<number | null>} Returns the last modified timestamp (in milliseconds) of the | ||
| * manifest file, or null if an error occurs. | ||
| */ | ||
| async function getManifestTs(manifestPath: string) { | ||
| try { | ||
| // Get stats for the manifest file | ||
| const stats: Stats = await fs.stat(manifestPath); | ||
| return stats.mtimeMs; | ||
| } catch (err: any) { | ||
| // Handle errors accessing the manifest file | ||
| if (err.code === 'ENOENT') { | ||
| log.warn(`q-manifest.json file not found`); | ||
| } else { | ||
| panic(`Error accessing manifest file ${manifestPath}: ${err.message}`); | ||
| } | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the specified disk directory exists and is accessible. | ||
| * | ||
| * @returns {Promise<boolean>} Returns true if the directory exists and can be accessed, returns | ||
| * false if it doesn't exist or an error occurs. | ||
| */ | ||
| export async function clientDirExists(dist: string): Promise<boolean> { | ||
|
There was a problem hiding this comment. since you're using it for both src and dist, and it doesn't have anything to do with the client, you should rename this to just |
||
| try { | ||
| await fs.access(getDiskPath(dist)); | ||
| return true; // Directory exists | ||
| } catch (err: any) { | ||
| panic(`Error accessing disk directory ${dist}: ${err.message}`); | ||
|
There was a problem hiding this comment. If the err.code is ENOENT then there's no need for panic |
||
| return false; // Directory doesn't exist or there was an error | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Recursively finds the latest modification time (mtime) of any file in the given directory. | ||
| * | ||
| * @param {string} srcPath - The directory path to search. | ||
| * @returns {Promise<number>} Returns the latest mtime (Unix timestamp in milliseconds), or 0 if the | ||
| * directory doesn't exist or is empty. | ||
| */ | ||
| export async function isNewerThan(srcPath: string, timestamp: number): Promise<boolean> { | ||
| let returnValue = false; | ||
| async function traverse(dir: string): Promise<void> { | ||
| if (returnValue) { | ||
| return; | ||
| } | ||
| let items: Array<import('fs').Dirent>; | ||
| try { | ||
| items = await fs.readdir(dir, { withFileTypes: true }); | ||
| } catch (err: any) { | ||
| if (err.code !== 'ENOENT') { | ||
| console.warn(`Cannot read directory ${dir}: ${err.message}`); | ||
|
|
||
| } | ||
| return; | ||
| } | ||
|
|
||
| for (const item of items) { | ||
| const fullPath = path.join(dir, item.name); | ||
|
There was a problem hiding this comment. put the |
||
| try { | ||
| if (item.isDirectory()) { | ||
| await traverse(fullPath); | ||
| } else if (item.isFile()) { | ||
| const stats = await fs.stat(fullPath); | ||
| if (stats.mtimeMs > timestamp) { | ||
| returnValue = true; | ||
| return; | ||
| } | ||
| } | ||
| } catch (err: any) { | ||
| console.warn(`Cannot access ${fullPath}: ${err.message}`); | ||
|
|
||
| } | ||
| } | ||
| } | ||
|
|
||
| await traverse(srcPath); | ||
| return returnValue; | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this