Eric/tag sanitization (#2247)

* Don't remove hash from muted words

* Split out crud actions, only sanitize on inserts

* Add changeset

* Handle hash emoji in mute words

* Add sanitization for invalid chars

* Remove console

* Add util

* Clean up changesets

* Format

* Wow forgot to commit change

.changeset/rotten-actors-dance.md

@@ -0,0 +1,5 @@
+---
+'@atproto/api': patch
+---
+
+Fix double sanitization bug when editing muted words.

.changeset/silly-carrots-repair.md

@@ -0,0 +1,5 @@
+---
+'@atproto/api': patch
+---
+
+More sanitization of muted words, including newlines and leading/trailing whitespace

.changeset/small-dragons-cry.md

@@ -0,0 +1,5 @@
+---
+'@atproto/api': patch
+---
+
+Add `sanitizeMutedWordValue` util

.changeset/sour-gorillas-unite.md

@@ -0,0 +1,5 @@
+---
+'@atproto/api': patch
+---
+
+Handle hash emoji in mute words

packages/api/src/bsky-agent.ts

@@ -13,6 +13,7 @@ import {
   BskyThreadViewPreference,
   BskyInterestsPreference,
 } from './types'
+import { sanitizeMutedWordValue } from './util'
 
 const FEED_VIEW_PREF_DEFAULTS = {
   hideReplies: false,
@@ -565,16 +566,108 @@ export class BskyAgent extends AtpAgent {
     })
   }
 
-  async upsertMutedWords(mutedWords: AppBskyActorDefs.MutedWord[]) {
-    await updateMutedWords(this, mutedWords, 'upsert')
+  async upsertMutedWords(newMutedWords: AppBskyActorDefs.MutedWord[]) {
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      let mutedWordsPref = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isMutedWordsPref(pref) &&
+          AppBskyActorDefs.validateMutedWordsPref(pref).success,
+      )
+
+      if (mutedWordsPref && AppBskyActorDefs.isMutedWordsPref(mutedWordsPref)) {
+        for (const updatedWord of newMutedWords) {
+          let foundMatch = false
+          const sanitizedUpdatedValue = sanitizeMutedWordValue(
+            updatedWord.value,
+          )
+
+          // was trimmed down to an empty string e.g. single `#`
+          if (!sanitizedUpdatedValue) continue
+
+          for (const existingItem of mutedWordsPref.items) {
+            if (existingItem.value === sanitizedUpdatedValue) {
+              existingItem.targets = Array.from(
+                new Set([...existingItem.targets, ...updatedWord.targets]),
+              )
+              foundMatch = true
+              break
+            }
+          }
+
+          if (!foundMatch) {
+            mutedWordsPref.items.push({
+              ...updatedWord,
+              value: sanitizedUpdatedValue,
+            })
+          }
+        }
+      } else {
+        // if the pref doesn't exist, create it
+        mutedWordsPref = {
+          items: newMutedWords.map((w) => ({
+            ...w,
+            value: sanitizeMutedWordValue(w.value),
+          })),
+        }
+      }
+
+      return prefs
+        .filter((p) => !AppBskyActorDefs.isMutedWordsPref(p))
+        .concat([
+          { ...mutedWordsPref, $type: 'app.bsky.actor.defs#mutedWordsPref' },
+        ])
+    })
   }
 
   async updateMutedWord(mutedWord: AppBskyActorDefs.MutedWord) {
-    await updateMutedWords(this, [mutedWord], 'update')
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      let mutedWordsPref = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isMutedWordsPref(pref) &&
+          AppBskyActorDefs.validateMutedWordsPref(pref).success,
+      )
+
+      if (mutedWordsPref && AppBskyActorDefs.isMutedWordsPref(mutedWordsPref)) {
+        for (const existingItem of mutedWordsPref.items) {
+          if (existingItem.value === mutedWord.value) {
+            existingItem.targets = mutedWord.targets
+            break
+          }
+        }
+      }
+
+      return prefs
+        .filter((p) => !AppBskyActorDefs.isMutedWordsPref(p))
+        .concat([
+          { ...mutedWordsPref, $type: 'app.bsky.actor.defs#mutedWordsPref' },
+        ])
+    })
   }
 
   async removeMutedWord(mutedWord: AppBskyActorDefs.MutedWord) {
-    await updateMutedWords(this, [mutedWord], 'remove')
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      let mutedWordsPref = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isMutedWordsPref(pref) &&
+          AppBskyActorDefs.validateMutedWordsPref(pref).success,
+      )
+
+      if (mutedWordsPref && AppBskyActorDefs.isMutedWordsPref(mutedWordsPref)) {
+        for (let i = 0; i < mutedWordsPref.items.length; i++) {
+          const existing = mutedWordsPref.items[i]
+          if (existing.value === mutedWord.value) {
+            mutedWordsPref.items.splice(i, 1)
+            break
+          }
+        }
+      }
+
+      return prefs
+        .filter((p) => !AppBskyActorDefs.isMutedWordsPref(p))
+        .concat([
+          { ...mutedWordsPref, $type: 'app.bsky.actor.defs#mutedWordsPref' },
+        ])
+    })
   }
 
   async hidePost(postUri: string) {
@@ -646,76 +739,6 @@ async function updateFeedPreferences(
   return res
 }
 
-/**
- * A helper specifically for updating muted words preferences
- */
-async function updateMutedWords(
-  agent: BskyAgent,
-  mutedWords: AppBskyActorDefs.MutedWord[],
-  action: 'upsert' | 'update' | 'remove',
-) {
-  const sanitizeMutedWord = (word: AppBskyActorDefs.MutedWord) => ({
-    value: word.value.replace(/^#/, ''),
-    targets: word.targets,
-  })
-
-  await updatePreferences(agent, (prefs: AppBskyActorDefs.Preferences) => {
-    let mutedWordsPref = prefs.findLast(
-      (pref) =>
-        AppBskyActorDefs.isMutedWordsPref(pref) &&
-        AppBskyActorDefs.validateMutedWordsPref(pref).success,
-    )
-
-    if (mutedWordsPref && AppBskyActorDefs.isMutedWordsPref(mutedWordsPref)) {
-      if (action === 'upsert' || action === 'update') {
-        for (const word of mutedWords) {
-          let foundMatch = false
-
-          for (const existingItem of mutedWordsPref.items) {
-            if (existingItem.value === sanitizeMutedWord(word).value) {
-              existingItem.targets =
-                action === 'upsert'
-                  ? Array.from(
-                      new Set([...existingItem.targets, ...word.targets]),
-                    )
-                  : word.targets
-              foundMatch = true
-              break
-            }
-          }
-
-          if (action === 'upsert' && !foundMatch) {
-            mutedWordsPref.items.push(sanitizeMutedWord(word))
-          }
-        }
-      } else if (action === 'remove') {
-        for (const word of mutedWords) {
-          for (let i = 0; i < mutedWordsPref.items.length; i++) {
-            const existing = mutedWordsPref.items[i]
-            if (existing.value === sanitizeMutedWord(word).value) {
-              mutedWordsPref.items.splice(i, 1)
-              break
-            }
-          }
-        }
-      }
-    } else {
-      // if the pref doesn't exist, create it
-      if (action === 'upsert') {
-        mutedWordsPref = {
-          items: mutedWords.map(sanitizeMutedWord),
-        }
-      }
-    }
-
-    return prefs
-      .filter((p) => !AppBskyActorDefs.isMutedWordsPref(p))
-      .concat([
-        { ...mutedWordsPref, $type: 'app.bsky.actor.defs#mutedWordsPref' },
-      ])
-  })
-}
-
 async function updateHiddenPost(
   agent: BskyAgent,
   postUri: string,

packages/api/src/index.ts

@@ -8,6 +8,7 @@ export {
 } from '@atproto/lexicon'
 export { parseLanguage } from '@atproto/common-web'
 export * from './types'
+export * from './util'
 export * from './client'
 export * from './agent'
 export * from './rich-text/rich-text'

packages/api/src/util.ts

@@ -0,0 +1,6 @@
+export function sanitizeMutedWordValue(value: string) {
+  return value
+    .trim()
+    .replace(/^#(?!\ufe0f)/, '')
+    .replace(/[\r\n\u00AD\u2060\u200D\u200C\u200B]+/, '')
+}