Faster startup (4/4): Lazy imports and V8 compile cache#7054
Draft
gonzaloriestra wants to merge 1 commit intofaster-startup-3from
Draft
Faster startup (4/4): Lazy imports and V8 compile cache#7054gonzaloriestra wants to merge 1 commit intofaster-startup-3from
gonzaloriestra wants to merge 1 commit intofaster-startup-3from
Conversation
3 tasks
Contributor
Author
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
3 tasks
39c47da to
377c2e4
Compare
35d5a30 to
ea5104e
Compare
377c2e4 to
29e09f4
Compare
29e09f4 to
e1916a4
Compare
ea5104e to
7682630
Compare
Contributor
Coverage report
Test suite run success4000 tests passing in 1531 suites. Report generated by 🧪jest coverage report action from 0b07426 |
e1916a4 to
8909fbd
Compare
1c3373e to
efa9dd4
Compare
8909fbd to
222f528
Compare
Defer heavy module imports to point of use across the codebase: - base-command: lazy ui.js (600KB React/Ink), error-handler, notifications - prerun hook: parallel imports via Promise.all - postrun hook: lazy analytics and deprecations - node-package-manager: lazy latest-version import - context/local: lazy fs.js and system.js (break circular deps) - is-global: lazy output.js, system.js, version.js, ui.js - custom-oclif-loader: fire-and-forget init hooks via runHook override Enable V8 compile cache via module.enableCompileCache() in dev.js/run.js, caching bytecode between runs to eliminate ~30ms compile overhead. Combined improvement: ~130ms across all commands Made-with: Cursor
efa9dd4 to
40f806b
Compare
222f528 to
0b07426
Compare
Contributor
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationspackages/cli-kit/dist/public/node/custom-oclif-loader.d.tsimport { Command, Config } from '@oclif/core';
import { Options } from '@oclif/core/interfaces';
/**
* Optional lazy command loader function.
* If set, ShopifyConfig will use it to load individual commands on demand
* instead of importing the entire COMMANDS module (which triggers loading all packages).
*/
export type LazyCommandLoader = (id: string) => Promise<typeof Command | undefined>;
export declare class ShopifyConfig extends Config {
private lazyCommandLoader?;
constructor(options: Options);
/**
* Set a lazy command loader that will be used to load individual command classes on demand,
* bypassing the default oclif behavior of importing the entire COMMANDS module.
*
* @param loader - The lazy command loader function.
*/
setLazyCommandLoader(loader: LazyCommandLoader): void;
/**
* Override runHook to make init hooks non-blocking for faster startup.
* Init hooks (app-init, hydrogen-init) set up LocalStorage and check hydrogen —
* these are setup tasks that don't need to complete before commands run.
*
* @param event - The hook event name.
* @param opts - Options to pass to the hook.
* @param timeout - Optional timeout for the hook.
* @param captureErrors - Whether to capture errors instead of throwing.
* @returns The hook result with successes and failures arrays.
*/
runHook(event: string, opts: any, timeout?: number, captureErrors?: boolean): Promise<any>;
/**
* Override runCommand to use lazy loading when available.
* Instead of calling cmd.load() which triggers loading ALL commands via index.js,
* we directly import only the needed command module.
*
* @param id - The command ID to run.
* @param argv - The arguments to pass to the command.
* @param cachedCommand - An optional cached command loadable.
* @returns The command result.
*/
runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable | null): Promise<T>;
customPriority(commands: Command.Loadable[]): Command.Loadable | undefined;
}
Existing type declarationspackages/cli-kit/dist/public/node/cli-launcher.d.ts@@ -1,6 +1,8 @@
+import type { LazyCommandLoader } from './custom-oclif-loader.js';
interface Options {
moduleURL: string;
argv?: string[];
+ lazyCommandLoader?: LazyCommandLoader;
}
/**
* Launches the CLI.
packages/cli-kit/dist/public/node/cli.d.ts@@ -1,3 +1,4 @@
+import type { LazyCommandLoader } from './custom-oclif-loader.js';
/**
* IMPORTANT NOTE: Imports in this module are dynamic to ensure that "setupEnvironmentVariables" can dynamically
* set the DEBUG environment variable before the 'debug' package sets up its configuration when modules
@@ -7,6 +8,8 @@ interface RunCLIOptions {
/** The value of import.meta.url of the CLI executable module */
moduleURL: string;
development: boolean;
+ /** Optional lazy command loader for on-demand command loading */
+ lazyCommandLoader?: LazyCommandLoader;
}
/**
* A function that abstracts away setting up the environment and running
@@ -17,6 +20,7 @@ export declare function runCLI(options: RunCLIOptions & {
runInCreateMode?: boolean;
}, launchCLI?: (options: {
moduleURL: string;
+ lazyCommandLoader?: LazyCommandLoader;
}) => Promise<void>, argv?: string[], env?: NodeJS.ProcessEnv, versions?: NodeJS.ProcessVersions): Promise<void>;
/**
* A function for create-x CLIs that automatically runs the "init" command.
@@ -38,5 +42,5 @@ export declare const jsonFlag: {
/**
* Clear the CLI cache, used to store some API responses and handle notifications status
*/
-export declare function clearCache(): void;
+export declare function clearCache(): Promise<void>;
export {};
\ No newline at end of file
packages/cli-kit/dist/public/node/error.d.ts@@ -1,4 +1,4 @@
-import { AlertCustomSection } from './ui.js';
+import type { AlertCustomSection } from './ui.js';
import { OutputMessage } from './output.js';
import { InlineToken, TokenItem } from '../../private/node/ui/components/TokenizedText.js';
export { ExtendableError } from 'ts-error';
packages/cli-kit/dist/public/node/is-global.d.ts@@ -1,4 +1,4 @@
-import { PackageManager } from './node-package-manager.js';
+import type { PackageManager } from './node-package-manager.js';
/**
* Returns true if the current process is running in a global context.
*
packages/cli-kit/dist/public/node/hooks/postrun.d.ts@@ -1,3 +1,7 @@
+/**
+ * Postrun hook — uses dynamic imports to avoid loading heavy modules (base-command, analytics)
+ * at module evaluation time. These are only needed after the command has already finished.
+ */
import { Hook } from '@oclif/core';
/**
* Check if post run hook has completed.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.

WHY are these changes introduced?
The CLI requires too much time to start working, it feels slow
WHAT is this pull request doing?
Defers heavy module imports to point of use across the codebase and enables V8 compile caching for faster subsequent runs.
ui.js(600KB React/Ink),error-handler.js,notifications-system.js,environments.js— only loaded when actually neededPromise.allfor analytics, notifications, and package-manager moduleslatest-versionimport (~113ms saved)fs.jsandsystem.jsto break circular dependency chainsoutput.js,system.js,version.js,ui.jsrunHookoverride soapp-initandhydrogen-initrun in backgroundmodule.enableCompileCache()indev.js/run.jscaches bytecode between runs, eliminating ~30ms compile overheadCombined improvement: ~130ms across all commands
How to test your changes?
shopify version/shopify helpreturn correct outputMeasuring impact
Checklist
Made with Cursor