Send analytics in background

[gonzaloriestra]

WHY are these changes introduced?

HackDays project: https://vault.shopify.io/hackdays/154/projects/24279-Shopify-CLI-UX-improvements

Analytics delivery currently blocks command completion, adding noticeable latency to every CLI invocation.

WHAT is this pull request doing?

Passes the completed analytics payload over stdin to a detached internal command, allowing the original command to exit immediately.

This works for Mac and Linux, but on Windows we still have to wait for the process because of a known issue. We also wait on CI to avoid issues with the job teardown.

Benchmark for shopify version:

Version	Average time (10 runs)
4.5.0	1.352s
snapshot	0.248s

demo.mp4

How to test your changes?

• pnpm i -g @shopify/cli@0.0.0-snapshot-20260811121607
• shopify version --verbose
• shopify deploy --wrong-flag-analytics-test
• Check that the payload was processed:

SELECT *
FROM `sdp-ingest.monorail.monorail_app_cli3_command_1`
WHERE event_timestamp >= TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR) AND CONTAINS_SUBSTR(
    payload.error_message,
    'Nonexistent flag: --wrong-flag-analytics-test'
  )

Checklist

• I've considered possible cross-platform impacts (Mac, Linux, Windows)
• I've considered possible documentation changes
• I've considered analytics changes to measure impact
• The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

[gonzaloriestra]

/snapit

[github-actions]

This PR seems inactive. If it's still relevant, please add a comment saying so. Otherwise, take no action.
→ If there's no activity within a week, then a bot will automatically close this.
Thanks for helping to improve Shopify's dev tooling and experience.

[gonzaloriestra]

• New app dev layout with filters #8137
• Add mouse support #8131
• New loading indicator #8136
• Send analytics in background #7615 👈 (View in Graphite)
• main

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

[gonzaloriestra]

/snapit

[gonzaloriestra]

/snapit

[github-actions]

🫰✨ Thanks @gonzaloriestra! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20260727091503

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

[isaacroldan]

I think we should replace these command-name and launcher exceptions with command metadata.

For example, add static requiresSyncAnalytics = false to BaseCommand, then set it to true on app init and app dev. We can capture that value in startAnalytics, where the command class is available, and store it with the internal command metadata so that reportAnalyticsEvent can select synchronous delivery.

This also covers app dev stop: it is derived from the app dev command through analyticsStopCommand(), so it can keep the same delivery requirement.

This keeps command lifecycle knowledge on the command and removes the create-app, app dev, and app dev stop checks from the analytics transport.

[gonzaloriestra]

@isaacroldan Good point. That's something we need to improve for other things like notifications, but it's better to do it now. Fixed!

[isaacroldan]

/snapit

[github-actions]

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20260812085842

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

[isaacroldan]

One stale change remains from the earlier file-based implementation.

---

🤖 Generated by the review-pr skill

[isaacroldan]

Two more command shutdown paths need synchronous analytics.

---

🤖 Generated by the review-pr skill

[isaacroldan]

One remaining issue with background delivery.

---

🤖 Generated by the review-pr skill

[isaacroldan]

Approving! great work, wasn't an easy change. We should keep an eye on analytics after the next release

[github-actions]

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

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/private/node/otel-metrics.d.ts

@@ -2,7 +2,7 @@ import { OtelService } from '../../public/node/vendor/otel-js/service/types.js';
 import { DefaultOtelServiceOptions } from '../../public/node/vendor/otel-js/service/DefaultOtelService/DefaultOtelService.js';
 type MetricRecorder = 'console' | {
     type: 'otel';
-    otel: Pick<OtelService, 'record'>;
+    otel: Pick<OtelService, 'getMeterProvider' | 'record'>;
 };
 interface Timing {
     active: number;

packages/cli-kit/dist/public/node/analytics.d.ts

@@ -6,6 +6,7 @@ interface ReportAnalyticsEventOptions {
     errorMessage?: string;
     exitMode: CommandExitMode;
 }
+export declare function sendAnalyticsEventFromStdin(): Promise<void>;
 /**
  * Report an analytics event, sending it off to Monorail -- Shopify's internal analytics service.
  *

packages/cli-kit/dist/public/node/base-command.d.ts

@@ -10,6 +10,7 @@ export interface NonTTYFlagRequirement {
 }
 declare abstract class BaseCommand extends Command {
     static baseFlags: FlagInput<{}>;
+    static get requiresSyncAnalytics(): boolean;
     static nonTTYFlagRequirements(_flags: FlagOutput): NonTTYFlagRequirement[];
     static descriptionWithoutMarkdown(): string | undefined;
     static analyticsNameOverride(): string | undefined;

packages/cli-kit/dist/public/node/metadata.d.ts

@@ -42,6 +42,7 @@ declare const coreData: RuntimeMetadataManager<CmdFieldsFromMonorail, {
         startCommand: string;
         startTopic?: string;
         startArgs: string[];
+        requiresSyncAnalytics?: boolean;
     };
 } & {
     environmentFlags: string;
@@ -63,6 +64,7 @@ export declare const getAllPublicMetadata: () => Partial<CmdFieldsFromMonorail>,
         startCommand: string;
         startTopic?: string;
         startArgs: string[];
+        requiresSyncAnalytics?: boolean;
     };
 } & {
     environmentFlags: string;
@@ -83,6 +85,7 @@ export declare const getAllPublicMetadata: () => Partial<CmdFieldsFromMonorail>,
         startCommand: string;
         startTopic?: string;
         startArgs: string[];
+        requiresSyncAnalytics?: boolean;
     };
 } & {
     environmentFlags: string;

packages/cli-kit/dist/public/node/system.d.ts

@@ -128,6 +128,12 @@ interface WslDetectionOverrides {
  * @returns True if the current environment is a WSL environment.
  */
 export declare function isWsl(overrides?: WslDetectionOverrides): Promise<boolean>;
+/**
+ * Check if the current process is running inside a container.
+ *
+ * @returns True if the current process is running inside a container.
+ */
+export declare function isInsideContainer(): boolean;
 /**
  * Check if stdin has piped data available.
  * This distinguishes between actual piped input (e.g., `echo "query" | cmd`)

packages/cli-kit/dist/public/node/vendor/otel-js/service/types.d.ts

@@ -1,5 +1,5 @@
-import type { Counter, Histogram, MeterProvider, MetricAttributes, MetricOptions, UpDownCounter } from '@opentelemetry/api';
-import type { ViewOptions } from '@opentelemetry/sdk-metrics';
+import type { Counter, Histogram, MetricAttributes, MetricOptions, UpDownCounter } from '@opentelemetry/api';
+import type { MeterProvider, ViewOptions } from '@opentelemetry/sdk-metrics';
 export type CustomMetricLabels<TLabels extends Record<TKeys, MetricAttributes>, TKeys extends string = keyof TLabels & string> = {
     [P in TKeys]: TLabels[P] extends MetricAttributes ? TLabels[P] : never;
 };