Repository navigation
[5.0] Backport 5.0.1 fixes (#9012, #9014, and ten more) - #9063
Merged
Merged
Conversation
dmerand
approved these changes
Nov 3, 2026
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 declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/public/common/json-output-schema.d.ts@@ -1,5 +1,4 @@
import { z } from 'zod';
-export declare const jsonOutputStoreDomainSchema: z.ZodString;
/** UTC instants in CLI-owned JSON use whole seconds and the Z timezone marker. */
export declare const jsonOutputTimestampSchema: z.ZodString;
/**
packages/cli-kit/dist/private/node/conf-store.d.ts@@ -73,7 +73,7 @@ export declare function cacheStore(key: ExportedKey, value: string, config?: Loc
/**
* Fetch from cache if already populated, otherwise return undefined.
* @param key - The key to use for the cache.
- * @returns The cache element.
+ * @returns The chache element.
*/
export declare function cacheRetrieve(key: ExportedKey, config?: LocalStorage<ConfSchema>): CacheValue<string> | undefined;
export declare function cacheClear(config?: LocalStorage<ConfSchema>): void;
packages/cli-kit/dist/private/node/constants.d.ts@@ -8,7 +8,6 @@ export declare const environmentVariables: {
env: string;
noAnalytics: string;
optOutInstrumentation: string;
- doNotTrack: string;
serviceAccountToken: string;
appAutomationToken: string;
partnersToken: string;
packages/cli-kit/dist/public/node/base-command.d.ts@@ -13,7 +13,7 @@ export interface NonTTYFlagRequirement {
declare abstract class BaseCommand extends Command {
static baseFlags: FlagInput<{}>;
static descriptionWithMarkdown?: string;
- static jsonOutputSchema?: JsonOutputSchema;
+ static get jsonOutputSchema(): JsonOutputSchema | undefined;
static get requiresSyncAnalytics(): boolean;
static nonTTYFlagRequirements(_flags: FlagOutput): NonTTYFlagRequirement[];
static descriptionForHelp(): string | undefined;
packages/cli-kit/dist/public/node/json-output-schema.d.ts@@ -1,6 +1,6 @@
import { zodToJsonSchema } from 'zod-to-json-schema';
import type { ZodTypeAny, z } from 'zod';
-export { formatJsonOutputTimestamp, jsonOutputTimestampSchema, jsonOutputStoreDomainSchema, } from '../common/json-output-schema.js';
+export { formatJsonOutputTimestamp, jsonOutputTimestampSchema } from '../common/json-output-schema.js';
interface JsonOutputSchemaDefinition<TSchema extends ZodTypeAny = ZodTypeAny> {
readonly name: string;
readonly schema: TSchema;
packages/cli-kit/dist/public/node/notifications-system.d.ts@@ -172,7 +172,7 @@ export declare function showNotificationsIfNeeded(currentSurfaces?: string[], en
*/
export declare function getNotifications(): Promise<Notifications>;
/**
- * Fetch notifications from the CDN and cache them.
+ * Fetch notifications from the CDN and chache them.
*
* @returns A string with the notifications.
*/
packages/cli-kit/dist/public/node/context/local.d.ts@@ -52,7 +52,7 @@ export declare function isUnitTest(env?: NodeJS.ProcessEnv): boolean;
* Returns true if reporting analytics is enabled.
*
* @param env - The environment variables from the environment of the current process.
- * @returns True unless SHOPIFY_CLI_NO_ANALYTICS, OPT_OUT_INSTRUMENTATION or DO_NOT_TRACK is truthy, or debug mode is enabled.
+ * @returns True unless SHOPIFY_CLI_NO_ANALYTICS or OPT_OUT_INSTRUMENTATION is truthy, or debug mode is enabled.
*/
export declare function analyticsDisabled(env?: NodeJS.ProcessEnv): boolean;
/**
packages/cli-kit/dist/public/node/graphiql/server.d.ts@@ -27,14 +27,13 @@ export declare function resolveGraphiQLKey(providedKey: string | undefined, apiS
* - `getToken` may return a cached token; the proxy calls it for every request.
* - `refreshToken` (optional) is invoked when the upstream Admin API returns 401.
* When omitted, the proxy falls back to calling `getToken` again on 401.
- * - Both operations receive a cancellation signal to pass to token requests.
*
* Implementations must throw `TokenRefreshError` (or any thrown error) when the
* token cannot be obtained; the proxy renders the unauthorized template in that case.
*/
export interface TokenProvider {
- getToken: (signal?: AbortSignal) => Promise<string>;
- refreshToken?: (signal?: AbortSignal) => Promise<string>;
+ getToken: () => Promise<string>;
+ refreshToken?: () => Promise<string>;
}
/**
* Optional app-specific context, used to render the app pill and scopes note in the
@@ -66,10 +65,6 @@ export interface SetupGraphiQLServerOptions {
* interactive UI.
*/
protectMutations?: boolean;
- /** Called for request failures that leave the server available for subsequent requests. */
- onRequestError?: (message: string) => void;
- /** Routes diagnostics through command events and leaves readiness output to the session. */
- json?: boolean;
}
export declare const MUTATIONS_BLOCKED_MESSAGE = "Mutations are disabled. Re-run with --allow-mutations to enable mutations.";
/**
packages/cli-kit/dist/public/node/graphiql/session.d.ts@@ -22,7 +22,6 @@ export interface RunGraphiQLSessionOptions {
additionalReadyMessages?: OutputMessage[];
abortSignal?: AbortSignal;
stdout?: Writable;
- outputFormat?: 'text' | 'json';
}
/**
* Generates a random key suitable for authenticating a single local GraphiQL session.
|
Contributor
|
| File | Removed Fields | Reason |
|---|---|---|
packages/app/src/cli/models/extensions/specifications/theme.ts |
allowed_sources, network_access, capabilities |
Fields removed |
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?
Backports merged changes from
maintostable/5.0so they can ship in the next 5.0 patch (5.0.1). It started with these two:It now also includes ten additional 5.0.x fixes; see "Additional 5.0.x fixes" below.
Following the grouping convention used for earlier stable backports (#8855, #8895): one commit per original PR, in merge order, each with a backref to the original.
Please merge without squashing (keep one commit per original PR).
WHAT is this pull request doing?
One commit per original PR, each cherry-picked from its merge commit on
mainwithgit cherry-pick -x -m 1, so each carries a(cherry picked from commit …)trailer and aBackport of …link.main7c300eac85669f380577a1ef4cf6f468bc5ab559d1a21ba9285fffce8934372d1b85a07cbdd25dd21fc6b148f852c9ce91d023223eee57aa65fbb476e854ced24f853ea3520a41b786d8d87d67856817Both were cherry-picked from the merge commits on
main. Conflicts: none. Each backport commit has the same patch ID as its original PR's merge diff, and the files each PR touches have no other changes onstable/5.0.Note for #9014: the
[extensions.capabilities.network_access] allowed_sourcessetting it removes was added in #9003 and is listed in the 5.0.0 changelog, so this removes behavior that already shipped in 5.0.0 as a patch change. The replacement is the app-level[network_access] allowed_sourcessetting inshopify.app.toml.Changesets: both original changesets are kept unchanged, both
patch:.changeset/theme-dev-external-links.md:@shopify/apppatch,@shopify/themepatch.changeset/remove-theme-extension-network-access-allowed-sources.md:@shopify/apppatchCHANGELOG.mdandpackage.jsonversions are not touched; the Version Packages PR handles those.Validation (clean checkout of this branch, Node 26.12.1, pnpm 10.11.1,
pnpm install --frozen-lockfile):storefront-renderer,proxyandhtmltests, 92/92; apploaderandutilities/extensions/themetests, 142/142.theme-environment,theme-ext-environmentandservices/dev, 25 files, 326/326; apploader,models/extensions, theme bundle and deploy steps,utilities/extensions/themeand dev extension payload, 39 files, 622/622.pnpm type-checkandpnpm lintpass for@shopify/themeand@shopify/app.prettier --checkon the changed files andgit diff --checkare clean.Additional 5.0.x fixes
This PR now also carries ten more fixes from
mainfor 5.0.1, one commit each after the two above, in merge order, each cherry-picked withgit cherry-pick -x -m 1from its merge commit (so each has the(cherry picked from commit …)trailer and aBackport of …link):mainc2948e0f22397cd9cbe8fba07163c501dbcb2ee5d613da079643ba6dfaef77a068a2b39f353cdd469403cabd5c92b9b263c49d21424ba72a8a8848780ef4c791a1c1f4de52cef1b54c62ac44ab82bdbd8be099c393d18dbfd8d63d3c4b98a139644750a0fafefe3e199eb1ce50e5c3d7a13911e648513c8f77063feaf1699cd1cafe5d08a70dda4ab3780a2c563e7c30f61f18747418a876a4a48b9eb0d1afd6d92c0a0d62f149c2d458a98dbaf89f7cc2e7669dcbd26c3dad70bc9d7e9428138bfacee94021ca77f22f94ddb5a4ec61cefd29bbd460aabaa89796a4b9ef7ad00f0a1d6c5ec31cc89300325a45032e8467c6cb5e0fe136a5abe985dd0196f4b4d405120558ada0f7015bae15de3dba5a1b039e3fffb08c99bd10dd0304d440ccc72b5fa140d6752c77a117af38957695ac4b829f29c27a8879375ac677942545a25396eedec0afe16183eb4027c8e7f8ada4147cb474cb207b89029d26e066808f93acb9d2d50952fa827ab5cded292dcba181ae386a9f00e95d67e4afe53c6834ffb031cf70a8d118f1bdd25db00566Conflicts: none. All ten applied cleanly, and each backport commit has the same patch ID as its original PR's merge diff. #9013 and #9029 touch generated files (
packages/cli/oclif.manifest.json,packages/cli/README.md, and for #9029docs-shopify.dev/generated/generated_docs_data_v2.json) and picked cleanly. After all picks,pnpm refresh-manifests,pnpm refresh-readmeandpnpm refresh-code-documentationleavegit diffclean.Changesets: every added changeset is
patchand unchanged.pnpm changeset status --verboseshows only patch bumps:@shopify/cli-kit,@shopify/cli,@shopify/appand@shopify/themego to 5.0.1, and the other fixed-group packages follow to 5.0.1. It reports no minor or major releases.Additional validation (same setup as above; head
afe53c6834ffb031cf70a8d118f1bdd25db00566):commands/store/auth-output.test.ts, a file none of these PRs touch: a 5 second timeout in the full-suite run only. The file passes on its own on this branch, and the same two tests fail the same way in a full-suite run on the 5.0.0 tag (573 passed, 2 failed).type-checkandlintpass with--skip-nx-cachefor@shopify/app,@shopify/theme,@shopify/cli-kit,@shopify/cli,@shopify/organizationsand@shopify/store.prettier --checkon the 59 changed non-generated files andgit diff --checkare clean.How to manually test your changes?
shopify theme devagainst a dev store, click a link to another site, and confirm the browser goes to that site instead of stopping on the storefront's "leaving this store" page. Other redirects, such as/cart/clear, should still stay on the local server.[extensions.capabilities.network_access]to anallowed_sourcestable and confirm config validation rejects it; a theme extension without that setting should load and build as before.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset addIncludes 85706e4 (regenerated GraphQL types) so the codegen check passes on stable/5.0.