Skip to content

Faster startup (3/4): Inline app-init and hydrogen-init hooks#7053

Draft
gonzaloriestra wants to merge 1 commit intofaster-startup-2from
faster-startup-3
Draft

Faster startup (3/4): Inline app-init and hydrogen-init hooks#7053
gonzaloriestra wants to merge 1 commit intofaster-startup-2from
faster-startup-3

Conversation

@gonzaloriestra
Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

The CLI requires too much time to start working, it feels slow

WHAT is this pull request doing?

Replaces the re-export hook stubs from PR 1/4 with inlined implementations that avoid loading heavy package dependency chains.

  • Inlined app-init.ts: lazily imports LocalStorage instead of pulling in the entire @shopify/app chain (~1s of imports). Uses Node's native crypto.randomUUID() instead of importing from cli-kit
  • Inlined hydrogen-init.ts: skips loading @shopify/cli-hydrogen entirely for non-hydrogen commands (~300ms+ saved). Only loads the module when options.id starts with hydrogen:

Startup time: 710ms → 530ms (-25%)

How to test your changes?

  • shopify app dev still initializes correctly (LocalStorage cleared, run ID set)
  • shopify hydrogen dev still runs hydrogen init hook
  • Non-hydrogen commands skip hydrogen module loading

Measuring impact

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

Made with Cursor

Copy link
Copy Markdown
Contributor Author

gonzaloriestra commented Mar 19, 2026

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.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 30, 2026

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 82.24% 15165/18439
🟡 Branches 74.55% 7462/10010
🟢 Functions 81.33% 3808/4682
🟢 Lines 82.62% 14339/17355

Test suite run success

4000 tests passing in 1531 suites.

Report generated by 🧪jest coverage report action from 40f806b

@gonzaloriestra gonzaloriestra force-pushed the faster-startup-3 branch 2 times, most recently from 1c3373e to efa9dd4 Compare March 30, 2026 13:38
Replace re-exports from @shopify/app and @shopify/cli-hydrogen with
inlined versions. app-init now lazily imports LocalStorage instead of
pulling the entire @shopify/app chain (~1s). hydrogen-init skips loading
@shopify/cli-hydrogen entirely for non-hydrogen commands (~300ms).

Startup time: 710ms → 530ms (-25%)

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

Differences in type declarations

We 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:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

packages/cli-kit/dist/public/node/custom-oclif-loader.d.ts
import { 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 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 declarations

packages/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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant