Skip to content

Extract scopes transforms from Zod schemas into accessor functions#6951

Draft
ryancbahan wants to merge 2 commits intorcb/extract-extension-dir-transformsfrom
rcb/extract-scopes-transform
Draft

Extract scopes transforms from Zod schemas into accessor functions#6951
ryancbahan wants to merge 2 commits intorcb/extract-extension-dir-transformsfrom
rcb/extract-scopes-transform

Conversation

@ryancbahan
Copy link
Contributor

@ryancbahan ryancbahan commented Mar 7, 2026

WHY are these changes introduced?

Phase 2b of config model cleanup. The normalizeDelimitedString transform on scopes (sort, deduplicate, trim) is applied at parse time in 3 Zod schemas across 2 files. This means config.access_scopes.scopes doesn't match what the user wrote in their TOML — "write_products,read_products" silently becomes "read_products,write_products". Config objects should preserve the source value; normalization belongs in the accessor layer.

WHAT is this pull request doing?

Removes parse-time transforms from 3 schemas:

  • LegacyAppSchema.scopes in app.ts
  • TemplateConfigSchema.scopes and .access_scopes.scopes in app.ts
  • AppAccessSchema.access_scopes.scopes in app_config_app_access.ts

Moves normalization into accessor functions:

  • getAppScopes() — now calls normalizeDelimitedString() before returning
  • getTemplateScopesArray() — now calls normalizeDelimitedString() instead of manual .sort()

getAppScopesArray() delegates to getAppScopes() so it gets normalization for free.

Why this is safe:

  • All CLI consumers read scopes through getAppScopes()/getAppScopesArray()/getTemplateScopesArray()
  • Deploy path (transformLocalToRemote) is pure path remapping — platform normalizes server-side
  • warnIfScopesDifferBeforeDev in dev.ts does its own rationaliseScopes() normalization before comparing
  • Re-normalizing already-normalized scopes is a no-op

How to test your changes?

npx vitest run packages/app/src/cli/models/app/app.test.ts
npx vitest run packages/app/src/cli/models/extensions/specifications/app_config_app_access.test.ts
npx vitest run packages/app/src/cli/services/app/config-pipeline-snapshot.test.ts

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

@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2026

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 79.24% 14597/18422
🟡 Branches 73.53% 7251/9861
🟡 Functions 79.36% 3714/4680
🟡 Lines 79.56% 13791/17334

Test suite run success

3833 tests passing in 1467 suites.

Report generated by 🧪jest coverage report action from 01deb4a

@ryancbahan ryancbahan force-pushed the rcb/extract-extension-dir-transforms branch from 00ccb2a to b2a5e51 Compare March 9, 2026 15:38
@ryancbahan ryancbahan force-pushed the rcb/extract-scopes-transform branch 3 times, most recently from f9cdcda to c3b1deb Compare March 9, 2026 17:08
@ryancbahan ryancbahan force-pushed the rcb/extract-extension-dir-transforms branch from 81d3f1f to c8f3dde Compare March 11, 2026 14:11
@ryancbahan ryancbahan force-pushed the rcb/extract-scopes-transform branch from c3b1deb to 93b9d18 Compare March 11, 2026 14:12
@github-actions
Copy link
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/toml/codec.d.ts
import { JsonMap } from '../../../private/common/json.js';
export type JsonMapType = JsonMap;
/**
 * Given a TOML string, it returns a JSON object.
 *
 * @param input - TOML string.
 * @returns JSON object.
 */
export declare function decodeToml(input: string): JsonMapType;
/**
 * Given a JSON object, it returns a TOML string.
 *
 * @param content - JSON object.
 * @returns TOML string.
 */
export declare function encodeToml(content: JsonMap | object): string;
packages/cli-kit/dist/public/node/toml/index.d.ts
export type { JsonMapType } from './codec.js';
packages/cli-kit/dist/public/node/toml/toml-file.d.ts
import { JsonMapType } from './codec.js';
/**
 * Thrown when a TOML file cannot be parsed. Includes the file path for context.
 */
export declare class TomlParseError extends Error {
    readonly path: string;
    constructor(path: string, cause: Error);
}
/**
 * General-purpose TOML file abstraction.
 *
 * Provides a unified interface for reading, patching, removing keys from, and replacing
 * the content of TOML files on disk.
 *
 * - `read` populates content from disk
 * - `patch` does surgical WASM-based edits (preserves comments and formatting)
 * - `remove` deletes a key by dotted path (preserves comments and formatting)
 * - `replace` does a full re-serialization (comments and formatting are NOT preserved).
 * - `transformRaw` applies a function to the raw TOML string on disk.
 */
export declare class TomlFile {
    /**
     * Read and parse a TOML file from disk. Throws if the file doesn't exist or contains invalid TOML.
     * Parse errors are wrapped in {@link TomlParseError} with the file path for context.
     *
     * @param path - Absolute path to the TOML file.
     * @returns A TomlFile instance with parsed content.
     */
    static read(path: string): Promise<TomlFile>;
    readonly path: string;
    content: JsonMapType;
    constructor(path: string, content: JsonMapType);
    /**
     * Surgically patch values in the TOML file, preserving comments and formatting.
     *
     * Accepts a nested object whose leaf values are set in the TOML. Intermediate tables are
     * created automatically. Setting a leaf to `undefined` removes it (use `remove()` for a
     * clearer API when deleting keys).
     *
     * @example
     * ```ts
     * await file.patch({build: {dev_store_url: 'my-store.myshopify.com'}})
     * await file.patch({application_url: 'https://example.com', auth: {redirect_urls: ['...']}})
     * ```
     */
    patch(changes: {
        [key: string]: unknown;
    }): Promise<void>;
    /**
     * Remove a key from the TOML file by dotted path, preserving comments and formatting.
     *
     * @param keyPath - Dotted key path to remove (e.g. 'build.include_config_on_deploy').
     * @example
     * ```ts
     * await file.remove('build.include_config_on_deploy')
     * ```
     */
    remove(keyPath: string): Promise<void>;
    /**
     * Replace the entire file content. The file is fully re-serialized — comments and formatting
     * are NOT preserved.
     *
     * @param content - The new content to write.
     * @example
     * ```ts
     * await file.replace({client_id: 'abc', name: 'My App'})
     * ```
     */
    replace(content: JsonMapType): Promise<void>;
    /**
     * Transform the raw TOML string on disk. Reads the file, applies the transform function
     * to the raw text, writes back, and re-parses to keep `content` in sync.
     *
     * Use this for text-level operations that can't be expressed as structured edits —
     * e.g. Injecting comments or positional insertion of keys in arrays-of-tables.
     * Subsequent `patch()` calls will preserve any comments added this way.
     *
     * @param transform - A function that receives the raw TOML string and returns the modified string.
     * @example
     * ```ts
     * await file.transformRaw((raw) => `# Header comment\n${raw}`)
     * ```
     */
    transformRaw(transform: (raw: string) => string): Promise<void>;
    private decode;
}

Existing type declarations

We found no diffs with existing type declarations

ryancbahan and others added 2 commits March 11, 2026 16:12
Move normalizeDelimitedString (sort, deduplicate, trim) from parse-time
Zod transforms to getAppScopes(), getTemplateScopesArray() accessors.
Config objects now preserve the raw TOML value; normalization happens
on read through the existing chokepoint functions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
getAppConfigurationState returns raw config values in startingOptions;
scopes normalization now happens at read time via getAppScopes(). Update
the test assertion to match the raw TOML value.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ryancbahan ryancbahan force-pushed the rcb/extract-extension-dir-transforms branch from c8f3dde to 23b6a86 Compare March 11, 2026 22:13
@ryancbahan ryancbahan force-pushed the rcb/extract-scopes-transform branch from 93b9d18 to 01deb4a Compare March 11, 2026 22:13
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