Use graphQL to delete theme files #4799

catlee · 2024-11-05T22:07:25Z

WHY are these changes introduced?

Use graphQL to delete theme files. This gets us off REST, and also allows us to delete multiple files in one request, which should improve the developer experience.

Measuring impact

How do we know this change was effective? Please choose one:

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
Existing analytics will cater for this addition
PR includes analytics changes to measure impact

Checklist

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

github-actions · 2024-11-05T22:11:37Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	75.14% (-0.08% 🔻)	8852/11781
🟡	Branches	70.39% (-0.08% 🔻)	4293/6099
🟡	Functions	75.06% (-0.08% 🔻)	2315/3084
🟡	Lines	75.68% (-0.08% 🔻)	8368/11057

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / theme_files_delete.ts	100%	100%	100%	100%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / app-event-watcher.ts	93.83% (-1.23% 🔻)	86.49%	90.48%	98.61%
🔴	`...` / api.ts	55.32% (-3.98% 🔻)	41.11% (-4.01% 🔻)	54.76% (-5.24% 🔻)	56.18% (-4.56% 🔻)

Test suite run success

1995 tests passing in 903 suites.

Report generated by 🧪jest coverage report action from a6d2353

github-actions · 2024-11-06T15:56:02Z

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run "pnpm changeset add" to track your changes and include them in the next release CHANGELOG.

graygilmore

no 🎩 yet but code part looks good, one small question about the progress bar

graygilmore · 2024-11-06T19:13:46Z

packages/theme/src/cli/utilities/theme-environment/theme-reconciliation.ts

@@ -179,9 +179,13 @@ async function performFileReconciliation(
    )
  })

-  const deleteRemoteFiles = remoteFilesToDelete.map((file) => deleteThemeAsset(targetTheme.id, file.key, session))
+  const deleteRemoteFiles = deleteThemeAssets(


This should be so much faster!

graygilmore · 2024-11-06T19:18:28Z

packages/theme/src/cli/utilities/theme-uploader.ts

+        if (!success) {
+          createSyncingCatchError(key, 'delete')(new Error(`Failed to delete ${key}`))
+        }
+        progress.current++


I wonder if there's any point to the progress tracking here now? By the time we're doing progress.current++ all of the remote calls have already been completed.

yeah, I wasn't sure about that either....

In the case where we have multiple batches, progress tracking could be useful....but the batching is being handled by the underlying function right now.

I implemented batching in the uploader as well, so if we have multiple batches of files to delete we'll get progress.

I also hooked up the delete errors to the uploadResults so that the CLI reports that the push finished with errors.

lucyxiang · 2024-11-06T19:38:57Z

While 🎩 I found we run into a nil error here (see observe logs). I guess the CLI (or at least in dev) doesn't have an associated user 🤔

Edit: I can't 🎩 further until this is fixed :/

github-actions · 2025-01-03T03:37:47Z

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.

github-actions · 2025-01-07T15:37:37Z

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/cli/api/graphql/admin/generated/theme_files_delete.d.ts

import * as Types from './types.js';
import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
export type ThemeFilesDeleteMutationVariables = Types.Exact<{
    themeId: Types.Scalars['ID']['input'];
    files: Types.Scalars['String']['input'][] | Types.Scalars['String']['input'];
}>;
export type ThemeFilesDeleteMutation = {
    themeFilesDelete?: {
        deletedThemeFiles?: {
            filename: string;
        }[] | null;
        userErrors: {
            filename?: string | null;
            code?: Types.OnlineStoreThemeFilesUserErrorsCode | null;
            message: string;
        }[];
    } | null;
};
export declare const ThemeFilesDelete: DocumentNode<ThemeFilesDeleteMutation, Types.Exact<{
    themeId: Types.Scalars['ID']['input'];
    files: Types.Scalars['String']['input'][] | Types.Scalars['String']['input'];
}>>;

Existing type declarations

packages/cli-kit/dist/public/node/themes/api.d.ts

@@ -7,7 +7,7 @@ export declare function fetchTheme(id: number, session: AdminSession): Promise<T
 export declare function fetchThemes(session: AdminSession): Promise<Theme[]>;
 export declare function createTheme(params: ThemeParams, session: AdminSession): Promise<Theme | undefined>;
 export declare function fetchThemeAssets(id: number, filenames: Key[], session: AdminSession): Promise<ThemeAsset[]>;
-export declare function deleteThemeAsset(id: number, key: Key, session: AdminSession): Promise<boolean>;
+export declare function deleteThemeAssets(id: number, filenames: Key[], session: AdminSession): Promise<Result[]>;
 export declare function bulkUploadThemeAssets(id: number, assets: AssetParams[], session: AdminSession): Promise<Result[]>;
 export declare function fetchChecksums(id: number, session: AdminSession): Promise<Checksum[]>;
 export declare function themeUpdate(id: number, params: ThemeParams, session: AdminSession): Promise<Theme | undefined>;

graygilmore · 2025-01-07T17:15:17Z

packages/cli-kit/src/public/node/themes/api.ts

While 🎩 I found we run into a nil error here (see observe logs). I guess the CLI (or at least in dev) doesn't have an associated user 🤔

Are we ready to look and 🎩 this PR again or are we waiting on this to be resolved?

This should be resolved now

I top hatted when using --password and was able to successfully delete theme files.

amcaplan

The previous implementation used an API throttler, while this new implementation doesn't seem to have any kind of throttling enabled. Is that a cause for concern?

catlee · 2025-01-13T22:55:40Z

The previous implementation used an API throttler, while this new implementation doesn't seem to have any kind of throttling enabled. Is that a cause for concern?

Good point, I'm not sure if our graphQL implementation respects throttling.

https://shopify.dev/docs/api/admin-graphql#status_and_error_codes says we should look for extensions.code == THROTTLING.

I'll file an issue for this.

catlee force-pushed the catlee/theme_files_delete branch from c8f17c5 to b06f9d4 Compare November 5, 2024 22:53

catlee changed the title ~~WIP - port over theme files delete~~ Use graphQL to delete theme files Nov 6, 2024

catlee self-assigned this Nov 6, 2024

catlee marked this pull request as ready for review November 6, 2024 15:55

catlee requested review from a team as code owners November 6, 2024 15:55

catlee requested a review from lucyxiang November 6, 2024 15:55

catlee added the #gsd:40351 label Nov 6, 2024

graygilmore approved these changes Nov 6, 2024

View reviewed changes

catlee force-pushed the catlee/theme_files_delete branch 3 times, most recently from 5ee226f to be5792f Compare November 7, 2024 16:29

shauns added the Area: @shopify/theme @shopify/theme package issues label Nov 13, 2024 — with Graphite App

catlee force-pushed the catlee/theme_files_delete branch from be5792f to fc9d92b Compare December 3, 2024 16:07

catlee enabled auto-merge December 18, 2024 14:49

github-actions bot added the no-pr-activity label Jan 3, 2025

Port theme file deletes to graphQL

a6d2353

catlee force-pushed the catlee/theme_files_delete branch from fc9d92b to a6d2353 Compare January 7, 2025 15:35

catlee removed the no-pr-activity label Jan 7, 2025

graygilmore reviewed Jan 7, 2025

View reviewed changes

amcaplan reviewed Jan 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use graphQL to delete theme files #4799

Use graphQL to delete theme files #4799

catlee commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 6, 2024

graygilmore left a comment

graygilmore Nov 6, 2024

graygilmore Nov 6, 2024

catlee Nov 6, 2024

catlee Nov 7, 2024

lucyxiang commented Nov 6, 2024 •

edited

Loading

github-actions bot commented Jan 3, 2025

github-actions bot commented Jan 7, 2025

graygilmore Jan 7, 2025

catlee Jan 7, 2025

catlee Jan 10, 2025

amcaplan left a comment

catlee commented Jan 13, 2025

Use graphQL to delete theme files #4799

Are you sure you want to change the base?

Use graphQL to delete theme files #4799

Conversation

catlee commented Nov 5, 2024 • edited Loading

WHY are these changes introduced?

Measuring impact

Checklist

github-actions bot commented Nov 5, 2024 • edited Loading

Coverage report

Test suite run success

github-actions bot commented Nov 6, 2024

graygilmore left a comment

Choose a reason for hiding this comment

graygilmore Nov 6, 2024

Choose a reason for hiding this comment

graygilmore Nov 6, 2024

Choose a reason for hiding this comment

catlee Nov 6, 2024

Choose a reason for hiding this comment

catlee Nov 7, 2024

Choose a reason for hiding this comment

lucyxiang commented Nov 6, 2024 • edited Loading

github-actions bot commented Jan 3, 2025

github-actions bot commented Jan 7, 2025

Differences in type declarations

New type declarations

Existing type declarations

graygilmore Jan 7, 2025

Choose a reason for hiding this comment

catlee Jan 7, 2025

Choose a reason for hiding this comment

catlee Jan 10, 2025

Choose a reason for hiding this comment

amcaplan left a comment

Choose a reason for hiding this comment

catlee commented Jan 13, 2025

catlee commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

lucyxiang commented Nov 6, 2024 •

edited

Loading