Add account details to queryStatuses (#3236)

* Moderation subjectStatusView with statistics

* add account stats to queue entries

* fix

* adapt

* review changes

* style

* review comments

* wip

* add indexes

* refresh materialized view

* use the background queue to refresh materialized views

* tidy

* fix verrify

* tidy

* Add filtering based on "minAccountSuspendCount"

* fix tests

* Update test snapshots

* update materialized views when running `processAll`

* tidy

* processAll sequentially

* tidy

* tidy

* fix dead lock

lexicons/tools/ozone/moderation/defs.json

@@ -182,6 +182,80 @@
         "tags": {
           "type": "array",
           "items": { "type": "string" }
+        },
+        "accountStats": {
+          "description": "Statistics related to the account subject",
+          "type": "ref",
+          "ref": "#accountStats"
+        },
+        "recordsStats": {
+          "description": "Statistics related to the record subjects authored by the subject's account",
+          "type": "ref",
+          "ref": "#recordsStats"
+        }
+      }
+    },
+    "accountStats": {
+      "description": "Statistics about a particular account subject",
+      "type": "object",
+      "properties": {
+        "reportCount": {
+          "description": "Total number of reports on the account",
+          "type": "integer"
+        },
+        "appealCount": {
+          "description": "Total number of appeals against a moderation action on the account",
+          "type": "integer"
+        },
+        "suspendCount": {
+          "description": "Number of times the account was suspended",
+          "type": "integer"
+        },
+        "escalateCount": {
+          "description": "Number of times the account was escalated",
+          "type": "integer"
+        },
+        "takedownCount": {
+          "description": "Number of times the account was taken down",
+          "type": "integer"
+        }
+      }
+    },
+    "recordsStats": {
+      "description": "Statistics about a set of record subject items",
+      "type": "object",
+      "properties": {
+        "totalReports": {
+          "description": "Cumulative sum of the number of reports on the items in the set",
+          "type": "integer"
+        },
+        "reportedCount": {
+          "description": "Number of items that were reported at least once",
+          "type": "integer"
+        },
+        "escalatedCount": {
+          "description": "Number of items that were escalated at least once",
+          "type": "integer"
+        },
+        "appealedCount": {
+          "description": "Number of items that were appealed at least once",
+          "type": "integer"
+        },
+        "subjectCount": {
+          "description": "Total number of item in the set",
+          "type": "integer"
+        },
+        "pendingCount": {
+          "description": "Number of item currently in \"reviewOpen\" or \"reviewEscalated\" state",
+          "type": "integer"
+        },
+        "processedCount": {
+          "description": "Number of item currently in \"reviewNone\" or \"reviewClosed\" state",
+          "type": "integer"
+        },
+        "takendownCount": {
+          "description": "Number of item currently taken down",
+          "type": "integer"
         }
       }
     },

lexicons/tools/ozone/moderation/queryStatuses.json

@@ -107,7 +107,12 @@
           "sortField": {
             "type": "string",
             "default": "lastReportedAt",
-            "enum": ["lastReviewedAt", "lastReportedAt"]
+            "enum": [
+              "lastReviewedAt",
+              "lastReportedAt",
+              "reportedRecordsCount",
+              "takendownRecordsCount"
+            ]
           },
           "sortDirection": {
             "type": "string",
@@ -158,6 +163,18 @@
             "type": "string",
             "description": "If specified, subjects of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.",
             "knownValues": ["account", "record"]
+          },
+          "minAccountSuspendCount": {
+            "type": "integer",
+            "description": "If specified, only subjects that belong to an account that has at least this many suspensions will be returned."
+          },
+          "minReportedRecordsCount": {
+            "type": "integer",
+            "description": "If specified, only subjects that belong to an account that has at least this many reported records will be returned."
+          },
+          "minTakendownRecordsCount": {
+            "type": "integer",
+            "description": "If specified, only subjects that belong to an account that has at least this many taken down records will be returned."
           }
         }
       },

packages/api/src/client/lexicons.ts

@@ -11322,6 +11322,85 @@ export const schemaDict = {
               type: 'string',
             },
           },
+          accountStats: {
+            description: 'Statistics related to the account subject',
+            type: 'ref',
+            ref: 'lex:tools.ozone.moderation.defs#accountStats',
+          },
+          recordsStats: {
+            description:
+              "Statistics related to the record subjects authored by the subject's account",
+            type: 'ref',
+            ref: 'lex:tools.ozone.moderation.defs#recordsStats',
+          },
+        },
+      },
+      accountStats: {
+        description: 'Statistics about a particular account subject',
+        type: 'object',
+        properties: {
+          reportCount: {
+            description: 'Total number of reports on the account',
+            type: 'integer',
+          },
+          appealCount: {
+            description:
+              'Total number of appeals against a moderation action on the account',
+            type: 'integer',
+          },
+          suspendCount: {
+            description: 'Number of times the account was suspended',
+            type: 'integer',
+          },
+          escalateCount: {
+            description: 'Number of times the account was escalated',
+            type: 'integer',
+          },
+          takedownCount: {
+            description: 'Number of times the account was taken down',
+            type: 'integer',
+          },
+        },
+      },
+      recordsStats: {
+        description: 'Statistics about a set of record subject items',
+        type: 'object',
+        properties: {
+          totalReports: {
+            description:
+              'Cumulative sum of the number of reports on the items in the set',
+            type: 'integer',
+          },
+          reportedCount: {
+            description: 'Number of items that were reported at least once',
+            type: 'integer',
+          },
+          escalatedCount: {
+            description: 'Number of items that were escalated at least once',
+            type: 'integer',
+          },
+          appealedCount: {
+            description: 'Number of items that were appealed at least once',
+            type: 'integer',
+          },
+          subjectCount: {
+            description: 'Total number of item in the set',
+            type: 'integer',
+          },
+          pendingCount: {
+            description:
+              'Number of item currently in "reviewOpen" or "reviewEscalated" state',
+            type: 'integer',
+          },
+          processedCount: {
+            description:
+              'Number of item currently in "reviewNone" or "reviewClosed" state',
+            type: 'integer',
+          },
+          takendownCount: {
+            description: 'Number of item currently taken down',
+            type: 'integer',
+          },
         },
       },
       subjectReviewState: {
@@ -12570,7 +12649,12 @@ export const schemaDict = {
             sortField: {
               type: 'string',
               default: 'lastReportedAt',
-              enum: ['lastReviewedAt', 'lastReportedAt'],
+              enum: [
+                'lastReviewedAt',
+                'lastReportedAt',
+                'reportedRecordsCount',
+                'takendownRecordsCount',
+              ],
             },
             sortDirection: {
               type: 'string',
@@ -12625,6 +12709,21 @@ export const schemaDict = {
                 "If specified, subjects of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored.",
               knownValues: ['account', 'record'],
             },
+            minAccountSuspendCount: {
+              type: 'integer',
+              description:
+                'If specified, only subjects that belong to an account that has at least this many suspensions will be returned.',
+            },
+            minReportedRecordsCount: {
+              type: 'integer',
+              description:
+                'If specified, only subjects that belong to an account that has at least this many reported records will be returned.',
+            },
+            minTakendownRecordsCount: {
+              type: 'integer',
+              description:
+                'If specified, only subjects that belong to an account that has at least this many taken down records will be returned.',
+            },
           },
         },
         output: {

packages/api/src/client/types/tools/ozone/moderation/defs.ts

@@ -136,6 +136,8 @@ export interface SubjectStatusView {
   appealed?: boolean
   suspendUntil?: string
   tags?: string[]
+  accountStats?: AccountStats
+  recordsStats?: RecordsStats
   [k: string]: unknown
 }
 
@@ -151,6 +153,66 @@ export function validateSubjectStatusView(v: unknown): ValidationResult {
   return lexicons.validate('tools.ozone.moderation.defs#subjectStatusView', v)
 }
 
+/** Statistics about a particular account subject */
+export interface AccountStats {
+  /** Total number of reports on the account */
+  reportCount?: number
+  /** Total number of appeals against a moderation action on the account */
+  appealCount?: number
+  /** Number of times the account was suspended */
+  suspendCount?: number
+  /** Number of times the account was escalated */
+  escalateCount?: number
+  /** Number of times the account was taken down */
+  takedownCount?: number
+  [k: string]: unknown
+}
+
+export function isAccountStats(v: unknown): v is AccountStats {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#accountStats'
+  )
+}
+
+export function validateAccountStats(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#accountStats', v)
+}
+
+/** Statistics about a set of record subject items */
+export interface RecordsStats {
+  /** Cumulative sum of the number of reports on the items in the set */
+  totalReports?: number
+  /** Number of items that were reported at least once */
+  reportedCount?: number
+  /** Number of items that were escalated at least once */
+  escalatedCount?: number
+  /** Number of items that were appealed at least once */
+  appealedCount?: number
+  /** Total number of item in the set */
+  subjectCount?: number
+  /** Number of item currently in "reviewOpen" or "reviewEscalated" state */
+  pendingCount?: number
+  /** Number of item currently in "reviewNone" or "reviewClosed" state */
+  processedCount?: number
+  /** Number of item currently taken down */
+  takendownCount?: number
+  [k: string]: unknown
+}
+
+export function isRecordsStats(v: unknown): v is RecordsStats {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#recordsStats'
+  )
+}
+
+export function validateRecordsStats(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#recordsStats', v)
+}
+
 export type SubjectReviewState =
   | 'lex:tools.ozone.moderation.defs#reviewOpen'
   | 'lex:tools.ozone.moderation.defs#reviewEscalated'

packages/api/src/client/types/tools/ozone/moderation/queryStatuses.ts

@@ -48,7 +48,11 @@ export interface QueryParams {
   ignoreSubjects?: string[]
   /** Get all subject statuses that were reviewed by a specific moderator */
   lastReviewedBy?: string
-  sortField?: 'lastReviewedAt' | 'lastReportedAt'
+  sortField?:
+    | 'lastReviewedAt'
+    | 'lastReportedAt'
+    | 'reportedRecordsCount'
+    | 'takendownRecordsCount'
   sortDirection?: 'asc' | 'desc'
   /** Get subjects that were taken down */
   takendown?: boolean
@@ -62,6 +66,12 @@ export interface QueryParams {
   collections?: string[]
   /** If specified, subjects of the given type (account or record) will be returned. When this is set to 'account' the 'collections' parameter will be ignored. When includeAllUserRecords or subject is set, this will be ignored. */
   subjectType?: 'account' | 'record' | (string & {})
+  /** If specified, only subjects that belong to an account that has at least this many suspensions will be returned. */
+  minAccountSuspendCount?: number
+  /** If specified, only subjects that belong to an account that has at least this many reported records will be returned. */
+  minReportedRecordsCount?: number
+  /** If specified, only subjects that belong to an account that has at least this many taken down records will be returned. */
+  minTakendownRecordsCount?: number
 }
 
 export type InputSchema = undefined

packages/dev-env/src/bin.ts

@@ -30,6 +30,7 @@ const run = async () => {
       port: 2587,
       chatUrl: 'http://localhost:2590', // must run separate chat service
       chatDid: 'did:example:chat',
+      dbMaterializedViewRefreshIntervalMs: 30_000,
     },
     introspect: { port: 2581 },
   })