Renamed "safeSerialize" to "serializeToString" and added inline comment

Brian Vaughn · Brian Vaughn · commit 80931fb924a0 · 2019-12-18T11:56:42.000-08:00
diff --git a/packages/react-devtools-shared/src/backend/utils.js b/packages/react-devtools-shared/src/backend/utils.js
@@ -39,7 +39,7 @@ export function cleanForBridge(
 }
 
 export function copyToClipboard(value: any): void {
-  const safeToCopy = safeSerialize(value);
+  const safeToCopy = serializeToString(value);
   copy(safeToCopy === undefined ? 'undefined' : safeToCopy);
 }
 
@@ -59,8 +59,9 @@ export function copyWithSet(
   return updated;
 }
 
-export function safeSerialize(data: any): string {
+export function serializeToString(data: any): string {
   const cache = new Set();
+  // Use a custom replacer function to protect against circular references.
   return JSON.stringify(data, (key, value) => {
     if (typeof value === 'object' && value !== null) {
       if (cache.has(value)) {

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ export function cleanForBridge(`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`export function copyToClipboard(value: any): void {`
`42`		`- const safeToCopy = safeSerialize(value);`
	`42`	`+ const safeToCopy = serializeToString(value);`
`43`	`43`	`copy(safeToCopy === undefined ? 'undefined' : safeToCopy);`
`44`	`44`	`}`
`45`	`45`
`@@ -59,8 +59,9 @@ export function copyWithSet(`
`59`	`59`	`return updated;`
`60`	`60`	`}`
`61`	`61`
`62`		`-export function safeSerialize(data: any): string {`
	`62`	`+export function serializeToString(data: any): string {`
`63`	`63`	`const cache = new Set();`
	`64`	`+ // Use a custom replacer function to protect against circular references.`
`64`	`65`	`return JSON.stringify(data, (key, value) => {`
`65`	`66`	`if (typeof value === 'object' && value !== null) {`
`66`	`67`	`if (cache.has(value)) {`