✨ Allow appealing a moderator decision through special report type (#…

…1969) * ✨ Allow appealing a moderator decision through special report type * ✨ Allow querying subjects by appealed status * ✨ Move to appealed boolean state column * ✨ Remove leftover * ✨ Move appealed status to new boolean column * ✨ Throw when non-author attempts to appeal a subject * 🚨 Appease the linter gods * build --------- Co-authored-by: Devin Ivy <devinivy@gmail.com>
bluesky-social · Jan 3, 2024 · 5e7b013 · 5e7b013
1 parent ad0d976
commit 5e7b013
Show file tree

Hide file tree

Showing 32 changed files with 574 additions and 14 deletions.
diff --git a/.github/workflows/build-and-push-bsky-aws.yaml b/.github/workflows/build-and-push-bsky-aws.yaml
@@ -3,7 +3,7 @@ on:
   push:
     branches:
       - main
-      - bsky-node-clustering
+      - appeal-report
 env:
   REGISTRY: ${{ secrets.AWS_ECR_REGISTRY_USEAST2_PACKAGES_REGISTRY }}
   USERNAME: ${{ secrets.AWS_ECR_REGISTRY_USEAST2_PACKAGES_USERNAME }}

diff --git a/lexicons/com/atproto/admin/defs.json b/lexicons/com/atproto/admin/defs.json
@@ -69,7 +69,8 @@
             "#modEventLabel",
             "#modEventAcknowledge",
             "#modEventEscalate",
-            "#modEventMute"
+            "#modEventMute",
+            "#modEventResolveAppeal"
           ]
         },
         "subject": {
@@ -167,9 +168,18 @@
           "type": "string",
           "format": "datetime"
         },
+        "lastAppealedAt": {
+          "type": "string",
+          "format": "datetime",
+          "description": "Timestamp referencing when the author of the subject appealed a moderation action"
+        },
         "takendown": {
           "type": "boolean"
         },
+        "appealed": {
+          "type": "boolean",
+          "description": "True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators."
+        },
         "suspendUntil": {
           "type": "string",
           "format": "datetime"
@@ -469,6 +479,16 @@
         }
       }
     },
+    "modEventResolveAppeal": {
+      "type": "object",
+      "description": "Resolve appeal on a subject",
+      "properties": {
+        "comment": {
+          "type": "string",
+          "description": "Describe resolution."
+        }
+      }
+    },
     "modEventComment": {
       "type": "object",
       "description": "Add a comment to a subject",

diff --git a/lexicons/com/atproto/admin/queryModerationStatuses.json b/lexicons/com/atproto/admin/queryModerationStatuses.json
@@ -64,6 +64,10 @@
             "type": "boolean",
             "description": "Get subjects that were taken down"
           },
+          "appealed": {
+            "type": "boolean",
+            "description": "Get subjects in unresolved appealed status"
+          },
           "limit": {
             "type": "integer",
             "minimum": 1,

diff --git a/lexicons/com/atproto/moderation/defs.json b/lexicons/com/atproto/moderation/defs.json
@@ -10,7 +10,8 @@
         "com.atproto.moderation.defs#reasonMisleading",
         "com.atproto.moderation.defs#reasonSexual",
         "com.atproto.moderation.defs#reasonRude",
-        "com.atproto.moderation.defs#reasonOther"
+        "com.atproto.moderation.defs#reasonOther",
+        "com.atproto.moderation.defs#reasonAppeal"
       ]
     },
     "reasonSpam": {
@@ -36,6 +37,10 @@
     "reasonOther": {
       "type": "token",
       "description": "Other: reports not falling under another report category"
+    },
+    "reasonAppeal": {
+      "type": "token",
+      "description": "Appeal: appeal a previously taken moderation action"
     }
   }
 }
diff --git a/packages/api/src/client/index.ts b/packages/api/src/client/index.ts
@@ -297,6 +297,7 @@ export const COM_ATPROTO_MODERATION = {
   DefsReasonSexual: 'com.atproto.moderation.defs#reasonSexual',
   DefsReasonRude: 'com.atproto.moderation.defs#reasonRude',
   DefsReasonOther: 'com.atproto.moderation.defs#reasonOther',
+  DefsReasonAppeal: 'com.atproto.moderation.defs#reasonAppeal',
 }
 export const APP_BSKY_GRAPH = {
   DefsModlist: 'app.bsky.graph.defs#modlist',

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -102,6 +102,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#modEventResolveAppeal',
             ],
           },
           subject: {
@@ -237,9 +238,20 @@ export const schemaDict = {
             type: 'string',
             format: 'datetime',
           },
+          lastAppealedAt: {
+            type: 'string',
+            format: 'datetime',
+            description:
+              'Timestamp referencing when the author of the subject appealed a moderation action',
+          },
           takendown: {
             type: 'boolean',
           },
+          appealed: {
+            type: 'boolean',
+            description:
+              'True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators.',
+          },
           suspendUntil: {
             type: 'string',
             format: 'datetime',
@@ -717,6 +729,16 @@ export const schemaDict = {
           },
         },
       },
+      modEventResolveAppeal: {
+        type: 'object',
+        description: 'Resolve appeal on a subject',
+        properties: {
+          comment: {
+            type: 'string',
+            description: 'Describe resolution.',
+          },
+        },
+      },
       modEventComment: {
         type: 'object',
         description: 'Add a comment to a subject',
@@ -1361,6 +1383,10 @@ export const schemaDict = {
               type: 'boolean',
               description: 'Get subjects that were taken down',
             },
+            appealed: {
+              type: 'boolean',
+              description: 'Get subjects in unresolved appealed status',
+            },
             limit: {
               type: 'integer',
               minimum: 1,
@@ -1946,6 +1972,7 @@ export const schemaDict = {
           'com.atproto.moderation.defs#reasonSexual',
           'com.atproto.moderation.defs#reasonRude',
           'com.atproto.moderation.defs#reasonOther',
+          'com.atproto.moderation.defs#reasonAppeal',
         ],
       },
       reasonSpam: {
@@ -1973,6 +2000,10 @@ export const schemaDict = {
         type: 'token',
         description: 'Other: reports not falling under another report category',
       },
+      reasonAppeal: {
+        type: 'token',
+        description: 'Appeal: appeal a previously taken moderation action',
+      },
     },
   },
   ComAtprotoRepoApplyWrites: {

diff --git a/packages/api/src/client/types/com/atproto/admin/defs.ts b/packages/api/src/client/types/com/atproto/admin/defs.ts
@@ -76,6 +76,7 @@ export interface ModEventViewDetail {
     | ModEventAcknowledge
     | ModEventEscalate
     | ModEventMute
+    | ModEventResolveAppeal
     | { $type: string; [k: string]: unknown }
   subject:
     | RepoView
@@ -147,7 +148,11 @@ export interface SubjectStatusView {
   lastReviewedBy?: string
   lastReviewedAt?: string
   lastReportedAt?: string
+  /** Timestamp referencing when the author of the subject appealed a moderation action */
+  lastAppealedAt?: string
   takendown?: boolean
+  /** True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators. */
+  appealed?: boolean
   suspendUntil?: string
   [k: string]: unknown
 }
@@ -538,6 +543,27 @@ export function validateModEventReverseTakedown(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.admin.defs#modEventReverseTakedown', v)
 }
 
+/** Resolve appeal on a subject */
+export interface ModEventResolveAppeal {
+  /** Describe resolution. */
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventResolveAppeal(
+  v: unknown,
+): v is ModEventResolveAppeal {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.defs#modEventResolveAppeal'
+  )
+}
+
+export function validateModEventResolveAppeal(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.admin.defs#modEventResolveAppeal', v)
+}
+
 /** Add a comment to a subject */
 export interface ModEventComment {
   comment: string

diff --git a/packages/api/src/client/types/com/atproto/admin/queryModerationStatuses.ts b/packages/api/src/client/types/com/atproto/admin/queryModerationStatuses.ts
@@ -31,6 +31,8 @@ export interface QueryParams {
   sortDirection?: 'asc' | 'desc'
   /** Get subjects that were taken down */
   takendown?: boolean
+  /** Get subjects in unresolved appealed status */
+  appealed?: boolean
   limit?: number
   cursor?: string
 }

diff --git a/packages/api/src/client/types/com/atproto/moderation/defs.ts b/packages/api/src/client/types/com/atproto/moderation/defs.ts
@@ -13,6 +13,7 @@ export type ReasonType =
   | 'com.atproto.moderation.defs#reasonSexual'
   | 'com.atproto.moderation.defs#reasonRude'
   | 'com.atproto.moderation.defs#reasonOther'
+  | 'com.atproto.moderation.defs#reasonAppeal'
   | (string & {})
 
 /** Spam: frequent unwanted promotion, replies, mentions */
@@ -27,3 +28,5 @@ export const REASONSEXUAL = 'com.atproto.moderation.defs#reasonSexual'
 export const REASONRUDE = 'com.atproto.moderation.defs#reasonRude'
 /** Other: reports not falling under another report category */
 export const REASONOTHER = 'com.atproto.moderation.defs#reasonOther'
+/** Appeal: appeal a previously taken moderation action */
+export const REASONAPPEAL = 'com.atproto.moderation.defs#reasonAppeal'
diff --git a/packages/bsky/src/api/com/atproto/admin/queryModerationStatuses.ts b/packages/bsky/src/api/com/atproto/admin/queryModerationStatuses.ts
@@ -9,6 +9,7 @@ export default function (server: Server, ctx: AppContext) {
       const {
         subject,
         takendown,
+        appealed,
         reviewState,
         reviewedAfter,
         reviewedBefore,
@@ -28,6 +29,7 @@ export default function (server: Server, ctx: AppContext) {
         reviewState: getReviewState(reviewState),
         subject,
         takendown,
+        appealed,
         reviewedAfter,
         reviewedBefore,
         reportedAfter,

diff --git a/packages/bsky/src/api/com/atproto/moderation/createReport.ts b/packages/bsky/src/api/com/atproto/moderation/createReport.ts
@@ -1,8 +1,9 @@
-import { AuthRequiredError } from '@atproto/xrpc-server'
+import { AuthRequiredError, ForbiddenError } from '@atproto/xrpc-server'
 import { Server } from '../../../../lexicon'
 import AppContext from '../../../../context'
 import { getReasonType, getSubject } from './util'
 import { softDeleted } from '../../../../db/util'
+import { REASONAPPEAL } from '../../../../lexicon/types/com/atproto/moderation/defs'
 
 export default function (server: Server, ctx: AppContext) {
   server.com.atproto.moderation.createReport({
@@ -22,12 +23,22 @@ export default function (server: Server, ctx: AppContext) {
         }
       }
 
+      const reportReasonType = getReasonType(reasonType)
+      const reportSubject = getSubject(subject)
+      const subjectDid =
+        'did' in reportSubject ? reportSubject.did : reportSubject.uri.host
+
+      // If the report is an appeal, the requester must be the author of the subject
+      if (reasonType === REASONAPPEAL && requester !== subjectDid) {
+        throw new ForbiddenError('You cannot appeal this report')
+      }
+
       const report = await db.transaction(async (dbTxn) => {
         const moderationTxn = ctx.services.moderation(dbTxn)
         return moderationTxn.report({
-          reasonType: getReasonType(reasonType),
+          reasonType: reportReasonType,
           reason,
-          subject: getSubject(subject),
+          subject: reportSubject,
           reportedBy: requester || ctx.cfg.serverDid,
         })
       })

diff --git a/packages/bsky/src/api/com/atproto/moderation/util.ts b/packages/bsky/src/api/com/atproto/moderation/util.ts
@@ -10,6 +10,7 @@ import {
   REASONRUDE,
   REASONSEXUAL,
   REASONVIOLATION,
+  REASONAPPEAL,
 } from '../../../../lexicon/types/com/atproto/moderation/defs'
 import {
   REVIEWCLOSED,
@@ -73,6 +74,7 @@ const reasonTypes = new Set([
   REASONRUDE,
   REASONSEXUAL,
   REASONVIOLATION,
+  REASONAPPEAL,
 ])
 
 const eventTypes = new Set([

diff --git a/packages/bsky/src/db/migrations/20231213T181744386Z-moderation-subject-appeal.ts b/packages/bsky/src/db/migrations/20231213T181744386Z-moderation-subject-appeal.ts
@@ -0,0 +1,23 @@
+import { Kysely } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('moderation_subject_status')
+    .addColumn('lastAppealedAt', 'varchar')
+    .execute()
+  await db.schema
+    .alterTable('moderation_subject_status')
+    .addColumn('appealed', 'boolean')
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('moderation_subject_status')
+    .dropColumn('lastAppealedAt')
+    .execute()
+  await db.schema
+    .alterTable('moderation_subject_status')
+    .dropColumn('appealed')
+    .execute()
+}
diff --git a/packages/bsky/src/db/migrations/index.ts b/packages/bsky/src/db/migrations/index.ts
@@ -32,3 +32,4 @@ export * as _20230920T213858047Z from './20230920T213858047Z-add-tags-to-post'
 export * as _20230929T192920807Z from './20230929T192920807Z-record-cursor-indexes'
 export * as _20231003T202833377Z from './20231003T202833377Z-create-moderation-subject-status'
 export * as _20231205T000257238Z from './20231205T000257238Z-remove-did-cache'
+export * as _20231213T181744386Z from './20231213T181744386Z-moderation-subject-appeal'
diff --git a/packages/bsky/src/db/tables/moderation.ts b/packages/bsky/src/db/tables/moderation.ts
@@ -20,6 +20,7 @@ export interface ModerationEvent {
     | 'com.atproto.admin.defs#modEventMute'
     | 'com.atproto.admin.defs#modEventReverseTakedown'
     | 'com.atproto.admin.defs#modEventEmail'
+    | 'com.atproto.admin.defs#modEventResolveAppeal'
   subjectType: 'com.atproto.admin.defs#repoRef' | 'com.atproto.repo.strongRef'
   subjectDid: string
   subjectUri: string | null
@@ -47,9 +48,11 @@ export interface ModerationSubjectStatus {
   lastReviewedBy: string | null
   lastReviewedAt: string | null
   lastReportedAt: string | null
+  lastAppealedAt: string | null
   muteUntil: string | null
   suspendUntil: string | null
   takendown: boolean
+  appealed: boolean | null
   comment: string | null
 }
 

diff --git a/packages/bsky/src/lexicon/index.ts b/packages/bsky/src/lexicon/index.ts
@@ -135,6 +135,7 @@ export const COM_ATPROTO_MODERATION = {
   DefsReasonSexual: 'com.atproto.moderation.defs#reasonSexual',
   DefsReasonRude: 'com.atproto.moderation.defs#reasonRude',
   DefsReasonOther: 'com.atproto.moderation.defs#reasonOther',
+  DefsReasonAppeal: 'com.atproto.moderation.defs#reasonAppeal',
 }
 export const APP_BSKY_GRAPH = {
   DefsModlist: 'app.bsky.graph.defs#modlist',