Benchmarks for @shopify/toml-patch

[shauns]

WHY are these changes introduced?

To benchmark and compare the performance of two different approaches for updating TOML configuration files: a new WASM-based implementation versus the existing JavaScript implementation.

WHAT is this pull request doing?

• Adds a benchmark file (toml-patch-wasm.bench.ts) to measure and compare the performance of TOML patching implementations

How to test your changes?

Run the benchmark tests with pnpm vitest bench. It'll give a comparison between pure JS & WASM based patching. At time of writing they're roughly equivalent.

[shauns]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• Benchmarks for @shopify/toml-patch #5678 👈 (View in Graphite)
• Add dependency on @shopify/toml-patch #5677
• Specific methods for patch app configuration file scenarios #5641 : 1 other dependent PR (#5642 )
• Remember randomly selected ports, and don't reuse them #5685
• main

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

[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/common/object.d.ts

@@ -1,4 +1,4 @@
-import { Dictionary, ObjectIterator, PropertyPath, ValueKeyIteratee } from 'lodash';
+import { Dictionary, ObjectIterator, ValueKeyIteratee } from 'lodash';
 /**
  * Deep merges the two objects and returns a new object with the merge result.
  *
@@ -53,7 +53,7 @@ export declare function deepDifference(one: object, two: object): [object, objec
  * @param path - The path of the property to get.
  * @returns - Returns the resolved value.
  */
-export declare function getPathValue<T = object>(object: object, path: PropertyPath): T | undefined;
+export declare function getPathValue<T = object>(object: object, path: string): T | undefined;
 /**
  * Sets the value at path of object. If a portion of path doesn't exist, it's create.
  *
@@ -62,7 +62,7 @@ export declare function getPathValue<T = object>(object: object, path: PropertyP
  * @param value - The value to set.
  * @returns - Returns object.
  */
-export declare function setPathValue(object: object, path: PropertyPath, value?: unknown): object;
+export declare function setPathValue(object: object, path: string, value?: unknown): object;
 /**
  * Removes the property at path of object.
  *
@@ -70,7 +70,7 @@ export declare function setPathValue(object: object, path: PropertyPath, value?:
  * @param path - The path of the property to unset.
  * @returns - Returns true if the property is deleted or not found, else false.
  */
-export declare function unsetPathValue(object: object, path: PropertyPath): boolean;
+export declare function unsetPathValue(object: object, path: string): boolean;
 /**
  * Checks if value is an empty object, collection, map, or set.
  *

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	76.63% (-0.15% 🔻)	9546/12457
🟡	Branches	71.78% (-0.05% 🔻)	4686/6528
🟡	Functions	76.45% (-0.11% 🔻)	2473/3235
🟡	Lines	77.16% (-0.16% 🔻)	9025/11697

Show new covered files 🐣

St.❔	File	Statements	Branches	Functions	Lines
🔴	... / toml-patch-wasm.bench.ts	0%	0%	0%	0%

Test suite run success

2235 tests passing in 973 suites.

Report generated by 🧪jest coverage report action from d24b6d3

[github-actions]

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.

[github-actions]

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.