fix: Make applyPatches to accept readonly Patch[] (#1094)

Andarist · NMinhNguyen · web-flow · commit 4da2e0d5af3c · 2024-04-27T21:05:41.000+01:00
* Demonstrate possible regression

* Make `Patch[]` arrays `readonly` on the outer bounds

* Limit the change to `applyPatches`

---------

Co-authored-by: Minh Nguyen &lt;2852660+NMinhNguyen@users.noreply.github.com&gt;
diff --git a/__tests__/produce.ts b/__tests__/produce.ts
@@ -8,7 +8,8 @@ import {
 	Immutable,
 	Immer,
 	enableMapSet,
-	enablePatches
+	enablePatches,
+	produceWithPatches
 } from "../src/immer"
 
 enableMapSet()
@@ -162,6 +163,20 @@ it("can apply patches", () => {
 	expect(applyPatches({}, patches)).toEqual({x: 4})
 })
 
+it("can apply readonly patches", () => {
+	const [, patches]: readonly [
+		{
+			x: number
+		},
+		readonly Patch[],
+		readonly Patch[]
+	] = produceWithPatches({x: 3}, d => {
+		d.x++
+	})
+
+	expect(applyPatches({}, patches)).toEqual({x: 4})
+})
+
 describe("curried producer", () => {
 	it("supports rest parameters", () => {
 		type State = {readonly a: 1}
diff --git a/src/core/immerClass.ts b/src/core/immerClass.ts
@@ -172,7 +172,7 @@ export class Immer implements ProducersFns {
 		this.useStrictShallowCopy_ = value
 	}
 
-	applyPatches<T extends Objectish>(base: T, patches: Patch[]): T {
+	applyPatches<T extends Objectish>(base: T, patches: readonly Patch[]): T {
 		// If a patch replaces the entire state, take that replacement as base
 		// before applying patches
 		let i: number
diff --git a/src/plugins/patches.ts b/src/plugins/patches.ts
@@ -211,7 +211,7 @@ export function enablePatches() {
 		})
 	}
 
-	function applyPatches_<T>(draft: T, patches: Patch[]): T {
+	function applyPatches_<T>(draft: T, patches: readonly Patch[]): T {
 		patches.forEach(patch => {
 			const {path, op} = patch
 
diff --git a/src/utils/plugins.ts b/src/utils/plugins.ts
@@ -24,7 +24,7 @@ const plugins: {
 			patches: Patch[],
 			inversePatches: Patch[]
 		): void
-		applyPatches_<T>(draft: T, patches: Patch[]): T
+		applyPatches_<T>(draft: T, patches: readonly Patch[]): T
 	}
 	MapSet?: {
 		proxyMap_<T extends AnyMap>(target: T, parent?: ImmerState): T

Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ export class Immer implements ProducersFns {`
`172`	`172`	`this.useStrictShallowCopy_ = value`
`173`	`173`	`}`
`174`	`174`
`175`		`- applyPatches<T extends Objectish>(base: T, patches: Patch[]): T {`
	`175`	`+ applyPatches<T extends Objectish>(base: T, patches: readonly Patch[]): T {`
`176`	`176`	`// If a patch replaces the entire state, take that replacement as base`
`177`	`177`	`// before applying patches`
`178`	`178`	`let i: number`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ export function enablePatches() {`
`211`	`211`	`})`
`212`	`212`	`}`
`213`	`213`
`214`		`- function applyPatches_<T>(draft: T, patches: Patch[]): T {`
	`214`	`+ function applyPatches_<T>(draft: T, patches: readonly Patch[]): T {`
`215`	`215`	`patches.forEach(patch => {`
`216`	`216`	`const {path, op} = patch`
`217`	`217`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ const plugins: {`
`24`	`24`	`patches: Patch[],`
`25`	`25`	`inversePatches: Patch[]`
`26`	`26`	`): void`
`27`		`- applyPatches_<T>(draft: T, patches: Patch[]): T`
	`27`	`+ applyPatches_<T>(draft: T, patches: readonly Patch[]): T`
`28`	`28`	`}`
`29`	`29`	`MapSet?: {`
`30`	`30`	`proxyMap_<T extends AnyMap>(target: T, parent?: ImmerState): T`