Profanity filter for props

src/entities/game.ts

@@ -54,6 +54,9 @@ export default class Game {
   @Property()
   blockAliasIdentifierProfanity: boolean = false
 
+  @Property()
+  blockPropsProfanity: boolean = false
+
   @Property()
   createdAt: Date = new Date()
 

src/lib/props/filterProfaneProps.ts

@@ -0,0 +1,54 @@
+import { hasProfanity } from '../filters/profanity.js'
+import { isArrayKey, type UnsanitisedProp } from './sanitiseProps.js'
+
+export type RejectedProp = { key: string; error: string }
+
+function isProfaneValue(value: string | null) {
+  return value !== null && hasProfanity(value)
+}
+
+export function filterProfaneProps<T extends UnsanitisedProp>(
+  props: T[],
+  enabled: boolean,
+): { accepted: T[]; rejected: RejectedProp[] } {
+  if (!enabled) {
+    return { accepted: props, rejected: [] }
+  }
+
+  const accepted: T[] = []
+  const rejectedMap = new Map<string, RejectedProp>()
+
+  const arrayGroups = new Map<string, T[]>()
+  for (const prop of props) {
+    if (isArrayKey(prop.key)) {
+      const group = arrayGroups.get(prop.key) ?? []
+      group.push(prop)
+      arrayGroups.set(prop.key, group)
+    }
+  }
+
+  for (const [key, group] of arrayGroups) {
+    if (group.some((p) => isProfaneValue(p.value))) {
+      rejectedMap.set(key, { key, error: 'Prop value contains profanity' })
+    }
+  }
+
+  for (const prop of props) {
+    if (rejectedMap.has(prop.key)) {
+      continue
+    }
+
+    if (isArrayKey(prop.key)) {
+      accepted.push(prop)
+      continue
+    }
+
+    if (isProfaneValue(prop.value)) {
+      rejectedMap.set(prop.key, { key: prop.key, error: 'Prop value contains profanity' })
+    } else {
+      accepted.push(prop)
+    }
+  }
+
+  return { accepted, rejected: Array.from(rejectedMap.values()) }
+}

src/lib/props/sanitiseProps.ts

@@ -4,7 +4,7 @@ import { PropSizeError } from '../errors/propSizeError.js'
 
 export const MAX_ARRAY_LENGTH = 1000
 
-type UnsanitisedProp = { key: string; value: string | null }
+export type UnsanitisedProp = { key: string; value: string | null }
 
 export function isArrayKey(key: string): boolean {
   return key.endsWith('[]')

src/migrations/.snapshot-gs_dev.json

@@ -512,6 +512,22 @@
           "enumItems": [],
           "mappedType": "boolean"
         },
+        "block_props_profanity": {
+          "name": "block_props_profanity",
+          "type": "tinyint(1)",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "unique": false,
+          "length": null,
+          "precision": 3,
+          "scale": 0,
+          "default": "false",
+          "comment": null,
+          "enumItems": [],
+          "mappedType": "boolean"
+        },
         "created_at": {
           "name": "created_at",
           "type": "datetime",

src/migrations/20260515181220AddBlockPropsProfanityColumn.ts

@@ -0,0 +1,13 @@
+import { Migration } from '@mikro-orm/migrations'
+
+export class AddBlockPropsProfanityColumn extends Migration {
+  override up(): void | Promise<void> {
+    this.addSql(
+      `alter table \`game\` add \`block_props_profanity\` tinyint(1) not null default false;`,
+    )
+  }
+
+  override down(): void | Promise<void> {
+    this.addSql(`alter table \`game\` drop column \`block_props_profanity\`;`)
+  }
+}

src/migrations/index.ts

@@ -70,6 +70,7 @@ import { AddFailedJobFailedAtIndex } from './20260327225535AddFailedJobFailedAtI
 import { CreateGameCenterIntegrationEventTable } from './20260404213749CreateGameCenterIntegrationEventTable.js'
 import { MikroORMV7FKDecouple } from './20260509215853MikroORMV7FKDecouple.js'
 import { AddBlockAliasIdentifierProfanityColumn } from './20260514072111AddBlockAliasIdentifierProfanityColumn.js'
+import { AddBlockPropsProfanityColumn } from './20260515181220AddBlockPropsProfanityColumn.js'
 
 export default [
   {
@@ -360,4 +361,8 @@ export default [
     name: 'AddBlockAliasIdentifierProfanityColumn',
     class: AddBlockAliasIdentifierProfanityColumn,
   },
+  {
+    name: 'AddBlockPropsProfanityColumn',
+    class: AddBlockPropsProfanityColumn,
+  },
 ]

src/routes/api/game-channel/docs.ts

@@ -283,6 +283,7 @@ export const putDocs = {
           createdAt: '2024-12-09T12:00:00.000Z',
           updatedAt: '2024-12-09T12:01:00.000Z',
         },
+        rejectedProps: [{ key: 'messageOfTheDay', error: 'Prop value contains profanity' }],
       },
     },
   ],
@@ -482,7 +483,8 @@ export const listStorageDocs = {
 } satisfies RouteDocs
 
 export const putStorageDocs = {
-  description: 'Create or update storage properties in a game channel',
+  description:
+    'Create or update storage properties in a game channel. The failedProps array contains props that failed due to size constraints or because their values contain profanity (when profanity blocking is enabled).',
   samples: [
     {
       title: 'Sample request to create/update properties',
@@ -574,7 +576,7 @@ export const putStorageDocs = {
           },
         ],
         deletedProps: [],
-        failedProps: [],
+        failedProps: [{ key: 'guildMotto', error: 'Prop value contains profanity' }],
       },
     },
   ],

src/routes/api/game-channel/put-storage.ts

@@ -5,6 +5,7 @@ import GameChannelStorageProp from '../../../entities/game-channel-storage-prop.
 import GameChannel from '../../../entities/game-channel.js'
 import PlayerAlias from '../../../entities/player-alias.js'
 import { PropSizeError } from '../../../lib/errors/propSizeError.js'
+import { filterProfaneProps } from '../../../lib/props/filterProfaneProps.js'
 import {
   isArrayKey,
   MAX_ARRAY_LENGTH,
@@ -200,13 +201,17 @@ export const putStorageRoute = apiRoute({
       return ctx.throw(403, 'This player is not a member of the channel')
     }
 
+    const sanitised = sanitiseProps({ props })
+    const { accepted, rejected: profanityRejected } = filterProfaneProps(
+      sanitised,
+      ctx.state.game.blockPropsProfanity,
+    )
+
     const { upsertedProps, deletedProps, failedProps } = await em.transactional(
       async (trx): Promise<TransactionResult> => {
-        const sanitised = sanitiseProps({ props })
-
         const newScalarMap = new Map<string, string | null>()
         const newArrayMap = new Map<string, (string | null)[]>()
-        for (const { key, value } of sanitised) {
+        for (const { key, value } of accepted) {
           if (isArrayKey(key)) {
             const existing = newArrayMap.get(key) ?? []
             existing.push(value)
@@ -274,7 +279,7 @@ export const putStorageRoute = apiRoute({
         channel,
         upsertedProps,
         deletedProps,
-        failedProps,
+        failedProps: [...profanityRejected, ...failedProps],
       },
     }
   },

src/routes/api/leaderboard/docs.ts

@@ -153,6 +153,7 @@ export const postDocs = {
           updatedAt: '2022-02-16T16:03:53.123Z',
         },
         updated: true,
+        rejectedProps: [{ key: 'nickname', error: 'Prop value contains profanity' }],
       },
     },
   ],

src/routes/api/leaderboard/post.ts

@@ -7,6 +7,7 @@ import buildErrorResponse from '../../../lib/errors/buildErrorResponse.js'
 import { PropSizeError } from '../../../lib/errors/propSizeError.js'
 import { UniqueLeaderboardEntryPropsDigestError } from '../../../lib/errors/uniqueLeaderboardEntryPropsDigestError.js'
 import triggerIntegrations from '../../../lib/integrations/triggerIntegrations.js'
+import { filterProfaneProps } from '../../../lib/props/filterProfaneProps.js'
 import { hardSanitiseProps, mergeAndSanitiseProps } from '../../../lib/props/sanitiseProps.js'
 import { apiRoute, withMiddleware } from '../../../lib/routing/router.js'
 import { playerAliasHeaderSchema } from '../../../lib/validation/playerAliasHeaderSchema.js'
@@ -71,6 +72,10 @@ export const postRoute = apiRoute({
   ),
   handler: async (ctx) => {
     const { score, props = [] } = ctx.state.validated.body
+    const { accepted: acceptedProps, rejected: rejectedProps } = filterProfaneProps(
+      props,
+      ctx.state.game.blockPropsProfanity,
+    )
     const em = ctx.em
 
     const leaderboard = ctx.state.leaderboard
@@ -85,7 +90,9 @@ export const postRoute = apiRoute({
       let updated = false
 
       // filter out props with null values for createEntry (only used for merging in updates)
-      const createProps = props.filter((p): p is { key: string; value: string } => p.value !== null)
+      const createProps = acceptedProps.filter(
+        (p): p is { key: string; value: string } => p.value !== null,
+      )
 
       try {
         if (leaderboard.unique) {
@@ -115,9 +122,12 @@ export const postRoute = apiRoute({
           if (shouldUpdate) {
             entry.score = score
             entry.createdAt = ctx.state.continuityDate ?? new Date()
-            if (props.length > 0) {
+            if (acceptedProps.length > 0) {
               entry.setProps(
-                mergeAndSanitiseProps({ prevProps: entry.props.getItems(), newProps: props }),
+                mergeAndSanitiseProps({
+                  prevProps: entry.props.getItems(),
+                  newProps: acceptedProps,
+                }),
               )
             }
             updated = true
@@ -215,6 +225,7 @@ export const postRoute = apiRoute({
       body: {
         entry: { position, ...entry.toJSON() },
         updated,
+        rejectedProps,
       },
     }
   },

src/routes/api/player/docs.ts

@@ -187,6 +187,7 @@ export const patchDocs = {
           lastSeenAt: '2022-04-12T15:09:43.066Z',
           groups: [{ id: '5826ca71-1964-4a1b-abcb-a61ffbe003be', name: 'Winners' }],
         },
+        rejectedProps: [{ key: 'nickname', error: 'Prop value contains profanity' }],
       },
     },
   ],

src/routes/protected/game-channel/update.ts

@@ -6,6 +6,7 @@ import User from '../../../entities/user.js'
 import buildErrorResponse from '../../../lib/errors/buildErrorResponse.js'
 import { PropSizeError } from '../../../lib/errors/propSizeError.js'
 import createGameActivity from '../../../lib/logging/createGameActivity.js'
+import { filterProfaneProps, type RejectedProp } from '../../../lib/props/filterProfaneProps.js'
 import { mergeAndSanitiseProps } from '../../../lib/props/sanitiseProps.js'
 import { protectedRoute, withMiddleware } from '../../../lib/routing/router.js'
 import { updatePropsSchema } from '../../../lib/validation/propsSchema.js'
@@ -43,6 +44,7 @@ export async function updateChannelHandler({
   temporaryMembership,
 }: UpdateChannelParams) {
   const changedProperties: string[] = []
+  let rejectedProps: RejectedProp[] = []
 
   if (typeof name === 'string' && name.trim().length > 0) {
     channel.name = name.trim()
@@ -51,9 +53,18 @@ export async function updateChannelHandler({
 
   if (props) {
     try {
-      channel.setProps(
-        mergeAndSanitiseProps({ prevProps: channel.props.getItems(), newProps: props }),
-      )
+      const mergedProps = mergeAndSanitiseProps({
+        prevProps: channel.props.getItems(),
+        newProps: props,
+      })
+
+      if (forwarded && channel.game.blockPropsProfanity) {
+        const { accepted, rejected } = filterProfaneProps(mergedProps, true)
+        channel.setProps(accepted)
+        rejectedProps = rejected
+      } else {
+        channel.setProps(mergedProps)
+      }
     } catch (err) {
       if (err instanceof PropSizeError) {
         return buildErrorResponse({ props: [err.message] })
@@ -158,6 +169,7 @@ export async function updateChannelHandler({
     status: 200,
     body: {
       channel: channel.toJSONWithCount(counts),
+      rejectedProps,
     },
   }
 }

src/routes/protected/game/settings.ts

@@ -17,8 +17,9 @@ export const settingsRoute = protectedRoute({
           purgeLivePlayers: game.purgeLivePlayers,
           purgeDevPlayersRetention: game.purgeDevPlayersRetention,
           purgeLivePlayersRetention: game.purgeLivePlayersRetention,
-          website: game.website,
           blockAliasIdentifierProfanity: game.blockAliasIdentifierProfanity,
+          blockPropsProfanity: game.blockPropsProfanity,
+          website: game.website,
           gameToken: game.getToken(),
         },
       },

src/routes/protected/game/update.ts

@@ -43,6 +43,7 @@ export const updateRoute = protectedRoute({
       purgeLivePlayersRetention: z.number().optional(),
       website: z.string().nullable().optional(),
       blockAliasIdentifierProfanity: z.boolean().optional(),
+      blockPropsProfanity: z.boolean().optional(),
     }),
   }),
   middleware: withMiddleware(userTypeGate([UserType.ADMIN], 'update games'), loadGame),
@@ -56,6 +57,7 @@ export const updateRoute = protectedRoute({
       purgeLivePlayersRetention,
       website,
       blockAliasIdentifierProfanity,
+      blockPropsProfanity,
     } = ctx.state.validated.body
 
     const em = ctx.em
@@ -144,14 +146,19 @@ export const updateRoute = protectedRoute({
       throwUnlessOwner(ctx)
       settingsToUpdate.blockAliasIdentifierProfanity = blockAliasIdentifierProfanity
     }
+    if (typeof blockPropsProfanity === 'boolean') {
+      throwUnlessOwner(ctx)
+      settingsToUpdate.blockPropsProfanity = blockPropsProfanity
+    }
 
     const [, changedProperties] = updateAllowedKeys(game, settingsToUpdate, [
       'purgeDevPlayers',
       'purgeLivePlayers',
       'purgeDevPlayersRetention',
       'purgeLivePlayersRetention',
-      'website',
       'blockAliasIdentifierProfanity',
+      'blockPropsProfanity',
+      'website',
     ])
 
     if (changedProperties.length > 0) {