[Themes] Store and track theme asset upload errors during theme dev

[jamesmengo]

WHY are these changes introduced?

This will be used to access data + render an overlay when asset upload errors occur during the theme dev command

These errors can come from two places. The theme uploader, where we do the initial theme upload when we start the command (in the background) as well as changes made to your theme files while the development server is running.

Original attempt for context - link

WHAT is this pull request doing?

Introduces a new uploadErrors Map to track and persist file-specific upload errors in the theme file system. This enables:

• Storage of upload errors at the file system level
• Clearing of errors when files upload successfully
• O(1) lookup to determine whether we have errors / should render an overlay

How to test your changes?

1. No visual changes.
2. You can run the tests in the test suite
3. Run theme dev in the javascript debug terminal - place some breakpoints in theme-uploader and theme-fs

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

[jamesmengo]

• [Feature] Render error page when theme dev encounters asset upload error #5221
• [Themes] Store and track theme asset upload errors during theme dev #5220 👈 (View in Graphite)
• main

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

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	75.23%	8871/11792
🟡	Branches	70.42%	4325/6142
🟡	Functions	75.03%	2323/3096
🟡	Lines	75.79% (+0.01% 🔼)	8387/11066

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / app-event-watcher.ts	93.83% (-1.23% 🔻)	86.49% (-2.7% 🔻)	90.48%	98.61%

Test suite run success

2000 tests passing in 904 suites.

Report generated by 🧪jest coverage report action from 7e34195

[graygilmore]

Don't forget to add a changelog!

[graygilmore]

patch

[jamesmengo]

I was waffling on this as well - I feel like it should it be a minor since this isn't a bugfix?

[graygilmore]

I thought this repo went patch for all changes since it doesn't really follow semver but I can't find any documentation on that.

[jamesmengo]

Judging off the current contents of .changeset it doesn't seems like to be a convention.

I see other similar changes with patch let's go with that for this PR.

I'll follow up with the foundations team to confirm

[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/public/node/themes/types.d.ts

@@ -92,6 +92,10 @@ export interface ThemeFileSystem extends VirtualFileSystem {
     applyIgnoreFilters: <T extends {
         key: string;
     }>(files: T[]) => T[];
+    /**
+     * Stores upload errors returned when uploading files via the Asset API
+     */
+    uploadErrors: Map<Key, string[]>;
 }
 /**
  * Represents a theme on the file system.