New app events watcher

[isaacroldan]

WHY are these changes introduced?

Introducing a new App watcher that handles all possible filesystem events for a given app.

WHAT is this pull request doing?

2 Main files to review here:

• file-watcher.ts is the actual filesystem watcher, receives events from chokidar and transforms them.
• app-event-watcher.ts receives the events from file-watcher and interprets them in the app context, reloading the app if necessary. It then emits a more high level event with the changes to the app.

Also added:

• A new demo watcher command to test this features
• Some improvements to loader or utility functions

How to test your changes?

The best way is to pull this branch and run pnpm shopify demo watcher --path <path_to_an_app>
And then try all changes you can think of!

Post-release steps

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
• I've made sure that any changes to dev or deploy have been reflected in the internal flowchart.

[github-actions]

We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** 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.

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	72.65% (+0.08% 🔼)	7628/10500
🟡	Branches	69.21% (-0% 🔻)	3714/5366
🟡	Functions	71.64% (+0.17% 🔼)	2028/2831
🟡	Lines	72.96% (+0.05% 🔼)	7185/9848

Show new covered files 🐣

St.❔	File	Statements	Branches	Functions	Lines
🔴	... / watcher.ts	0%	0%	0%	0%
🟢	... / app-event-watcher.ts	90.2%	71.43%	90.24%	91.78%
🟢	... / file-watcher.ts	89.47%	84.62%	80%	90.57%
🔴	... / promises.ts	0%	100%	0%	0%

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / ConcurrentOutput.tsx	98.39% (-1.61% 🔻)	90.91% (-4.55% 🔻)	100%	98.33% (-1.67% 🔻)
🟡	... / path.ts	73.33% (-5.24% 🔻)	72.22% (-9.03% 🔻)	68.75% (-4.58% 🔻)	74.07% (-5.93% 🔻)

Test suite run success

1742 tests passing in 798 suites.

Report generated by 🧪jest coverage report action from 5a19e64

[isaacroldan]

/snapit

[github-actions]

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

Test the snapshot by installing the package globally:

pnpm i -g @shopify/[email protected]

[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

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

/**
 * Flushes all pending promises.
 *
 * @returns A promise that resolves when all pending promises are resolved.
 */
export declare function flushPromises(): Promise<void>;

Existing type declarations

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

 /// <reference types="node" resolution-mode="require"/>
 import type { URL } from 'url';
 /**
  * Joins a list of paths together.
  *
  * @param paths - Paths to join.
  * @returns Joined path.
  */
 export declare function joinPath(...paths: string[]): string;
 /**
  * Normalizes a path.
  *
  * @param path - Path to normalize.
  * @returns Normalized path.
  */
 export declare function normalizePath(path: string): string;
 /**
  * Resolves a list of paths together.
  *
  * @param paths - Paths to resolve.
  * @returns Resolved path.
  */
 export declare function resolvePath(...paths: string[]): string;
 /**
  * Returns the relative path from one path to another.
  *
  * @param from - Path to resolve from.
  * @param to - Path to resolve to.
  * @returns Relative path.
  */
 export declare function relativePath(from: string, to: string): string;
 /**
  * Returns whether the path is absolute.
  *
  * @param path - Path to check.
  * @returns Whether the path is absolute.
  */
 export declare function isAbsolutePath(path: string): boolean;
 /**
  * Returns the directory name of a path.
  *
  * @param path - Path to get the directory name of.
  * @returns Directory name.
  */
 export declare function dirname(path: string): string;
 /**
  * Returns the base name of a path.
  *
  * @param path - Path to get the base name of.
  * @param ext - Optional extension to remove from the result.
  * @returns Base name.
  */
 export declare function basename(path: string, ext?: string): string;
 /**
  * Returns the extension of the path.
  *
  * @param path - Path to get the extension of.
  * @returns Extension.
  */
 export declare function extname(path: string): string;
 /**
  * Given an absolute filesystem path, it makes it relative to
  * the current working directory. This is useful when logging paths
  * to allow the users to click on the file and let the OS open it
  * in the editor of choice.
  *
  * @param path - Path to relativize.
  * @param dir - Current working directory.
  * @returns Relativized path.
  */
 export declare function relativizePath(path: string, dir?: string): string;
 /**
+ * Given 2 paths, it returns whether the second path is a subpath of the first path.
+ *
+ * @param mainPath - The main path.
+ * @param subpath - The subpath.
+ * @returns Whether the subpath is a subpath of the main path.
+ */
+export declare function isSubpath(mainPath: string, subpath: string): boolean;
+/**
  * Given a module's import.meta.url it returns the directory containing the module.
  *
  * @param moduleURL - The value of import.meta.url in the context of the caller module.
  * @returns The path to the directory containing the caller module.
  */
 export declare function moduleDirectory(moduleURL: string | URL): string;
 /**
  * When running a script using `npm run`, something interesting happens. If the current
  * folder does not have a `package.json` or a `node_modules` folder, npm will traverse
  * the directory tree upwards until it finds one. Then it will run the script and set
  * `process.cwd()` to that folder, while the actual path is stored in the INIT_CWD
  * environment variable (see here: https://docs.npmjs.com/cli/v9/commands/npm-run-script#description).
  *
  * @returns The path to the current working directory.
  */
 export declare function cwd(): string;
 /**
  * Tries to get the value of the `--path` argument, if provided.
  *
  * @param argv - The arguments to search for the `--path` argument.
  * @returns The value of the `--path` argument, if provided.
  */
 export declare function sniffForPath(argv?: string[]): string | undefined;
 /**
  * Returns whether the `--json` flag is present in the arguments.
  *
  * @param argv - The arguments to search for the `--json` flag.
  * @returns Whether the `--json` flag is present in the arguments.
  */
 export declare function sniffForJson(argv?: string[]): boolean;