fix: handle circular references in HMR check

sxzz · sxzz · commit df28f799bada · 2024-07-23T17:56:06.000+08:00
ref: vitejs/vite-plugin-vue@eddcfa8
diff --git a/src/core/handleHotUpdate.ts b/src/core/handleHotUpdate.ts
@@ -197,14 +197,25 @@ export function isOnlyTemplateChanged(
   )
 }
 
-function deepEqual(obj1: any, obj2: any, excludeProps: string[] = []): boolean {
+function deepEqual(
+  obj1: any,
+  obj2: any,
+  excludeProps: string[] = [],
+  deepParentsOfObj1: any[] = [],
+): boolean {
   // Check if both objects are of the same type
   if (typeof obj1 !== typeof obj2) {
     return false
   }
 
   // Check if both objects are primitive types or null
-  if (obj1 == null || obj2 == null || typeof obj1 !== 'object') {
+  // or circular reference
+  if (
+    obj1 == null ||
+    obj2 == null ||
+    typeof obj1 !== 'object' ||
+    deepParentsOfObj1.includes(obj1)
+  ) {
     return obj1 === obj2
   }
 
@@ -224,7 +235,12 @@ function deepEqual(obj1: any, obj2: any, excludeProps: string[] = []): boolean {
       continue
     }
 
-    if (!deepEqual(obj1[key], obj2[key], excludeProps)) {
+    if (
+      !deepEqual(obj1[key], obj2[key], excludeProps, [
+        ...deepParentsOfObj1,
+        obj1,
+      ])
+    ) {
       return false
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -197,14 +197,25 @@ export function isOnlyTemplateChanged(`
`197`	`197`	`)`
`198`	`198`	`}`
`199`	`199`
`200`		`-function deepEqual(obj1: any, obj2: any, excludeProps: string[] = []): boolean {`
	`200`	`+function deepEqual(`
	`201`	`+ obj1: any,`
	`202`	`+ obj2: any,`
	`203`	`+ excludeProps: string[] = [],`
	`204`	`+ deepParentsOfObj1: any[] = [],`
	`205`	`+): boolean {`
`201`	`206`	`// Check if both objects are of the same type`
`202`	`207`	`if (typeof obj1 !== typeof obj2) {`
`203`	`208`	`return false`
`204`	`209`	`}`
`205`	`210`
`206`	`211`	`// Check if both objects are primitive types or null`
`207`		`- if (obj1 == null \|\| obj2 == null \|\| typeof obj1 !== 'object') {`
	`212`	`+ // or circular reference`
	`213`	`+ if (`
	`214`	`+ obj1 == null \|\|`
	`215`	`+ obj2 == null \|\|`
	`216`	`+ typeof obj1 !== 'object' \|\|`
	`217`	`+ deepParentsOfObj1.includes(obj1)`
	`218`	`+ ) {`
`208`	`219`	`return obj1 === obj2`
`209`	`220`	`}`
`210`	`221`
`@@ -224,7 +235,12 @@ function deepEqual(obj1: any, obj2: any, excludeProps: string[] = []): boolean {`
`224`	`235`	`continue`
`225`	`236`	`}`
`226`	`237`
`227`		`- if (!deepEqual(obj1[key], obj2[key], excludeProps)) {`
	`238`	`+ if (`
	`239`	`+ !deepEqual(obj1[key], obj2[key], excludeProps, [`
	`240`	`+ ...deepParentsOfObj1,`
	`241`	`+ obj1,`
	`242`	`+ ])`
	`243`	`+ ) {`
`228`	`244`	`return false`
`229`	`245`	`}`
`230`	`246`	`}`