✨ Add date range and comment filter to queryModerationEvents endpoint (…

…#2124) * ✨ Add date range and comment filter to queryModerationEvents endpoint * ✨ Add report type and label filters and tests * tidy tests * ✨ commentKeyword -> comment and make comment and hasComment independent * ✨ Fix multiple label filter query * 📝 Add changesets * codegen tidy * add changeset * remove unused changeset --------- Co-authored-by: Devin Ivy <[email protected]>
bluesky-social · Feb 6, 2024 · e4ec7af · e4ec7af
1 parent 4f25b0f
commit e4ec7af
Show file tree

Hide file tree

Showing 20 changed files with 426 additions and 1 deletion.
diff --git a/.changeset/sharp-ducks-pump.md b/.changeset/sharp-ducks-pump.md
@@ -0,0 +1,5 @@
+---
+'@atproto/api': patch
+---
+
+Allow filtering for comment, label, report type and date range on queryModerationEvents endpoint.
diff --git a/lexicons/com/atproto/admin/defs.json b/lexicons/com/atproto/admin/defs.json
@@ -33,7 +33,8 @@
             "#modEventAcknowledge",
             "#modEventEscalate",
             "#modEventMute",
-            "#modEventEmail"
+            "#modEventEmail",
+            "#modEventResolveAppeal"
           ]
         },
         "subject": {
@@ -70,6 +71,7 @@
             "#modEventAcknowledge",
             "#modEventEscalate",
             "#modEventMute",
+            "#modEventEmail",
             "#modEventResolveAppeal"
           ]
         },

diff --git a/lexicons/com/atproto/admin/queryModerationEvents.json b/lexicons/com/atproto/admin/queryModerationEvents.json
@@ -23,6 +23,16 @@
             "enum": ["asc", "desc"],
             "description": "Sort direction for the events. Defaults to descending order of created at timestamp."
           },
+          "createdAfter": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Retrieve events created after a given timestamp"
+          },
+          "createdBefore": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Retrieve events created before a given timestamp"
+          },
           "subject": { "type": "string", "format": "uri" },
           "includeAllUserRecords": {
             "type": "boolean",
@@ -35,6 +45,30 @@
             "maximum": 100,
             "default": 50
           },
+          "hasComment": {
+            "type": "boolean",
+            "description": "If true, only events with comments are returned"
+          },
+          "comment": {
+            "type": "string",
+            "description": "If specified, only events with comments containing the keyword are returned"
+          },
+          "addedLabels": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "If specified, only events where all of these labels were added are returned"
+          },
+          "removedLabels": {
+            "type": "array",
+            "items": { "type": "string" },
+            "description": "If specified, only events where all of these labels were removed are returned"
+          },
+          "reportTypes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "cursor": { "type": "string" }
         }
       },

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -91,6 +91,7 @@ export const schemaDict = {
               'lex:com.atproto.admin.defs#modEventEscalate',
               'lex:com.atproto.admin.defs#modEventMute',
               'lex:com.atproto.admin.defs#modEventEmail',
+              'lex:com.atproto.admin.defs#modEventResolveAppeal',
             ],
           },
           subject: {
@@ -147,6 +148,7 @@ export const schemaDict = {
               'lex:com.atproto.admin.defs#modEventAcknowledge',
               'lex:com.atproto.admin.defs#modEventEscalate',
               'lex:com.atproto.admin.defs#modEventMute',
+              'lex:com.atproto.admin.defs#modEventEmail',
               'lex:com.atproto.admin.defs#modEventResolveAppeal',
             ],
           },
@@ -1450,6 +1452,16 @@ export const schemaDict = {
               description:
                 'Sort direction for the events. Defaults to descending order of created at timestamp.',
             },
+            createdAfter: {
+              type: 'string',
+              format: 'datetime',
+              description: 'Retrieve events created after a given timestamp',
+            },
+            createdBefore: {
+              type: 'string',
+              format: 'datetime',
+              description: 'Retrieve events created before a given timestamp',
+            },
             subject: {
               type: 'string',
               format: 'uri',
@@ -1466,6 +1478,37 @@ export const schemaDict = {
               maximum: 100,
               default: 50,
             },
+            hasComment: {
+              type: 'boolean',
+              description: 'If true, only events with comments are returned',
+            },
+            comment: {
+              type: 'string',
+              description:
+                'If specified, only events with comments containing the keyword are returned',
+            },
+            addedLabels: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+              description:
+                'If specified, only events where all of these labels were added are returned',
+            },
+            removedLabels: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+              description:
+                'If specified, only events where all of these labels were removed are returned',
+            },
+            reportTypes: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+            },
             cursor: {
               type: 'string',
             },

diff --git a/packages/api/src/client/types/com/atproto/admin/defs.ts b/packages/api/src/client/types/com/atproto/admin/defs.ts
@@ -40,6 +40,7 @@ export interface ModEventView {
     | ModEventEscalate
     | ModEventMute
     | ModEventEmail
+    | ModEventResolveAppeal
     | { $type: string; [k: string]: unknown }
   subject:
     | RepoRef
@@ -76,6 +77,7 @@ export interface ModEventViewDetail {
     | ModEventAcknowledge
     | ModEventEscalate
     | ModEventMute
+    | ModEventEmail
     | ModEventResolveAppeal
     | { $type: string; [k: string]: unknown }
   subject:

diff --git a/packages/api/src/client/types/com/atproto/admin/queryModerationEvents.ts b/packages/api/src/client/types/com/atproto/admin/queryModerationEvents.ts
@@ -14,10 +14,23 @@ export interface QueryParams {
   createdBy?: string
   /** Sort direction for the events. Defaults to descending order of created at timestamp. */
   sortDirection?: 'asc' | 'desc'
+  /** Retrieve events created after a given timestamp */
+  createdAfter?: string
+  /** Retrieve events created before a given timestamp */
+  createdBefore?: string
   subject?: string
   /** If true, events on all record types (posts, lists, profile etc.) owned by the did are returned */
   includeAllUserRecords?: boolean
   limit?: number
+  /** If true, only events with comments are returned */
+  hasComment?: boolean
+  /** If specified, only events with comments containing the keyword are returned */
+  comment?: string
+  /** If specified, only events where all of these labels were added are returned */
+  addedLabels?: string[]
+  /** If specified, only events where all of these labels were removed are returned */
+  removedLabels?: string[]
+  reportTypes?: string[]
   cursor?: string
 }
 

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -91,6 +91,7 @@ export const schemaDict = {
               'lex:com.atproto.admin.defs#modEventEscalate',
               'lex:com.atproto.admin.defs#modEventMute',
               'lex:com.atproto.admin.defs#modEventEmail',
+              'lex:com.atproto.admin.defs#modEventResolveAppeal',
             ],
           },
           subject: {
@@ -147,6 +148,7 @@ export const schemaDict = {
               'lex:com.atproto.admin.defs#modEventAcknowledge',
               'lex:com.atproto.admin.defs#modEventEscalate',
               'lex:com.atproto.admin.defs#modEventMute',
+              'lex:com.atproto.admin.defs#modEventEmail',
               'lex:com.atproto.admin.defs#modEventResolveAppeal',
             ],
           },
@@ -1450,6 +1452,16 @@ export const schemaDict = {
               description:
                 'Sort direction for the events. Defaults to descending order of created at timestamp.',
             },
+            createdAfter: {
+              type: 'string',
+              format: 'datetime',
+              description: 'Retrieve events created after a given timestamp',
+            },
+            createdBefore: {
+              type: 'string',
+              format: 'datetime',
+              description: 'Retrieve events created before a given timestamp',
+            },
             subject: {
               type: 'string',
               format: 'uri',
@@ -1466,6 +1478,37 @@ export const schemaDict = {
               maximum: 100,
               default: 50,
             },
+            hasComment: {
+              type: 'boolean',
+              description: 'If true, only events with comments are returned',
+            },
+            comment: {
+              type: 'string',
+              description:
+                'If specified, only events with comments containing the keyword are returned',
+            },
+            addedLabels: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+              description:
+                'If specified, only events where all of these labels were added are returned',
+            },
+            removedLabels: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+              description:
+                'If specified, only events where all of these labels were removed are returned',
+            },
+            reportTypes: {
+              type: 'array',
+              items: {
+                type: 'string',
+              },
+            },
             cursor: {
               type: 'string',
             },

diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/defs.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/defs.ts
@@ -40,6 +40,7 @@ export interface ModEventView {
     | ModEventEscalate
     | ModEventMute
     | ModEventEmail
+    | ModEventResolveAppeal
     | { $type: string; [k: string]: unknown }
   subject:
     | RepoRef
@@ -76,6 +77,7 @@ export interface ModEventViewDetail {
     | ModEventAcknowledge
     | ModEventEscalate
     | ModEventMute
+    | ModEventEmail
     | ModEventResolveAppeal
     | { $type: string; [k: string]: unknown }
   subject:

diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/queryModerationEvents.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/queryModerationEvents.ts
@@ -15,10 +15,23 @@ export interface QueryParams {
   createdBy?: string
   /** Sort direction for the events. Defaults to descending order of created at timestamp. */
   sortDirection: 'asc' | 'desc'
+  /** Retrieve events created after a given timestamp */
+  createdAfter?: string
+  /** Retrieve events created before a given timestamp */
+  createdBefore?: string
   subject?: string
   /** If true, events on all record types (posts, lists, profile etc.) owned by the did are returned */
   includeAllUserRecords: boolean
   limit: number
+  /** If true, only events with comments are returned */
+  hasComment?: boolean
+  /** If specified, only events with comments containing the keyword are returned */
+  comment?: string
+  /** If specified, only events where all of these labels were added are returned */
+  addedLabels?: string[]
+  /** If specified, only events where all of these labels were removed are returned */
+  removedLabels?: string[]
+  reportTypes?: string[]
   cursor?: string
 }
 

diff --git a/packages/bsky/tests/auto-moderator/labeler.test.ts b/packages/bsky/tests/auto-moderator/labeler.test.ts
@@ -103,6 +103,8 @@ describe('labeler', () => {
       subject: uri.toString(),
       limit: 10,
       types: [],
+      addedLabels: [],
+      removedLabels: [],
     })
     expect(events.length).toBe(1)
     expect(events[0]).toMatchObject({

diff --git a/packages/ozone/src/api/admin/queryModerationEvents.ts b/packages/ozone/src/api/admin/queryModerationEvents.ts
@@ -13,7 +13,14 @@ export default function (server: Server, ctx: AppContext) {
         sortDirection = 'desc',
         types,
         includeAllUserRecords = false,
+        hasComment,
+        comment,
         createdBy,
+        createdAfter,
+        createdBefore,
+        addedLabels = [],
+        removedLabels = [],
+        reportTypes,
       } = params
       const db = ctx.db
       const modService = ctx.modService(db)
@@ -25,6 +32,13 @@ export default function (server: Server, ctx: AppContext) {
         cursor,
         sortDirection,
         includeAllUserRecords,
+        hasComment,
+        comment,
+        createdAfter,
+        createdBefore,
+        addedLabels,
+        removedLabels,
+        reportTypes,
       })
       return {
         encoding: 'application/json',

diff --git a/packages/ozone/src/api/moderation/util.ts b/packages/ozone/src/api/moderation/util.ts
@@ -62,4 +62,5 @@ const eventTypes = new Set([
   'com.atproto.admin.defs#modEventUnmute',
   'com.atproto.admin.defs#modEventReverseTakedown',
   'com.atproto.admin.defs#modEventEmail',
+  'com.atproto.admin.defs#modEventResolveAppeal',
 ])