fix(stega): update default filter to skip paths that contain "type" (#689)

stipsan · web-flow · commit 1c6e4eaa0b1b · 2024-04-05T14:50:48.000+02:00
diff --git a/src/stega/filterDefault.ts b/src/stega/filterDefault.ts
@@ -1,6 +1,6 @@
-import type {FilterDefault} from './types'
+import type {ContentSourceMapParsedPath, FilterDefault} from './types'
 
-export const filterDefault: FilterDefault = ({sourcePath, value}) => {
+export const filterDefault: FilterDefault = ({sourcePath, resultPath, value}) => {
   // Skips encoding on URL or Date strings, similar to the `skip: 'auto'` parameter in vercelStegaCombine()
   if (isValidDate(value) || isValidURL(value)) {
     return false
@@ -50,6 +50,12 @@ export const filterDefault: FilterDefault = ({sourcePath, value}) => {
     return false
   }
 
+  // If the sourcePath or resultPath contains something that sounds like a type, like iconType, we skip encoding, as it's most
+  // of the time used for logic that breaks if it contains stega characters
+  if (hasTypeLike(sourcePath) || hasTypeLike(resultPath)) {
+    return false
+  }
+
   // Finally, we ignore a bunch of paths that are typically used for page building
   if (typeof endPath === 'string' && denylist.has(endPath)) {
     return false
@@ -111,3 +117,7 @@ function isValidURL(url: string) {
   }
   return true
 }
+
+function hasTypeLike(path: ContentSourceMapParsedPath): boolean {
+  return path.some((segment) => typeof segment === 'string' && segment.match(/type/i) !== null)
+}
