@atproto/ozone 0.0.16 → 0.0.17-next.0

package/src/lexicon/types/com/atproto/label/defs.ts

@@ -71,3 +71,71 @@ export function isSelfLabel(v: unknown): v is SelfLabel {
 export function validateSelfLabel(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.label.defs#selfLabel', v)
 }
+
+/** Declares a label value and its expected interpertations and behaviors. */
+export interface LabelValueDefinition {
+  /** The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+). */
+  identifier: string
+  /** How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing. */
+  severity: 'inform' | 'alert' | 'none' | (string & {})
+  /** What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing. */
+  blurs: 'content' | 'media' | 'none' | (string & {})
+  locales: LabelValueDefinitionStrings[]
+  [k: string]: unknown
+}
+
+export function isLabelValueDefinition(v: unknown): v is LabelValueDefinition {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.label.defs#labelValueDefinition'
+  )
+}
+
+export function validateLabelValueDefinition(v: unknown): ValidationResult {
+  return lexicons.validate('com.atproto.label.defs#labelValueDefinition', v)
+}
+
+/** Strings which describe the label in the UI, localized into a specific language. */
+export interface LabelValueDefinitionStrings {
+  /** The code of the language these strings are written in. */
+  lang: string
+  /** A short human-readable name for the label. */
+  name: string
+  /** A longer description of what the label means and why it might be applied. */
+  description: string
+  [k: string]: unknown
+}
+
+export function isLabelValueDefinitionStrings(
+  v: unknown,
+): v is LabelValueDefinitionStrings {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.label.defs#labelValueDefinitionStrings'
+  )
+}
+
+export function validateLabelValueDefinitionStrings(
+  v: unknown,
+): ValidationResult {
+  return lexicons.validate(
+    'com.atproto.label.defs#labelValueDefinitionStrings',
+    v,
+  )
+}
+
+export type LabelValue =
+  | '!hide'
+  | '!no-promote'
+  | '!warn'
+  | '!no-unauthenticated'
+  | 'dmca-violation'
+  | 'doxxing'
+  | 'porn'
+  | 'sexual'
+  | 'nudity'
+  | 'nsfl'
+  | 'gore'
+  | (string & {})

package/src/mod-service/index.ts

@@ -455,7 +455,8 @@ export class ModerationService {
     const takedownRef = `BSKY-${
       isSuspend ? 'SUSPEND' : 'TAKEDOWN'
     }-${takedownId}`
-    const values = TAKEDOWNS.map((eventType) => ({
+
+    const values = this.eventPusher.takedowns.map((eventType) => ({
       eventType,
       subjectDid: subject.did,
       takedownRef,
@@ -516,7 +517,7 @@ export class ModerationService {
   async takedownRecord(subject: RecordSubject, takedownId: number) {
     this.db.assertTransaction()
     const takedownRef = `BSKY-TAKEDOWN-${takedownId}`
-    const values = TAKEDOWNS.map((eventType) => ({
+    const values = this.eventPusher.takedowns.map((eventType) => ({
       eventType,
       subjectDid: subject.did,
       subjectUri: subject.uri,
@@ -555,7 +556,7 @@ export class ModerationService {
 
     if (blobCids && blobCids.length > 0) {
       const blobValues: Insertable<BlobPushEvent>[] = []
-      for (const eventType of TAKEDOWNS) {
+      for (const eventType of this.eventPusher.takedowns) {
         for (const cid of blobCids) {
           blobValues.push({
             eventType,

package/src/mod-service/status.ts

@@ -7,6 +7,7 @@ import {
   REVIEWOPEN,
   REVIEWCLOSED,
   REVIEWESCALATED,
+  REVIEWNONE,
 } from '../lexicon/types/com/atproto/admin/defs'
 import { ModerationEventRow, ModerationSubjectStatusRow } from './types'
 import { HOUR } from '@atproto/common'
@@ -14,16 +15,22 @@ import { REASONAPPEAL } from '../lexicon/types/com/atproto/moderation/defs'
 import { jsonb } from '../db/types'
 
 const getSubjectStatusForModerationEvent = ({
+  currentStatus,
   action,
   createdBy,
   createdAt,
   durationInHours,
 }: {
+  currentStatus?: ModerationSubjectStatusRow
   action: string
   createdBy: string
   createdAt: string
   durationInHours: number | null
-}): Partial<ModerationSubjectStatusRow> | null => {
+}): Partial<ModerationSubjectStatusRow> => {
+  const defaultReviewState = currentStatus
+    ? currentStatus.reviewState
+    : REVIEWNONE
+
   switch (action) {
     case 'com.atproto.admin.defs#modEventAcknowledge':
       return {
@@ -54,7 +61,9 @@ const getSubjectStatusForModerationEvent = ({
       return {
         lastReviewedBy: createdBy,
         muteUntil: null,
-        reviewState: REVIEWOPEN,
+        // It's not likely to receive an unmute event that does not already have a status row
+        // but if it does happen, default to unnecessary
+        reviewState: defaultReviewState,
         lastReviewedAt: createdAt,
       }
     case 'com.atproto.admin.defs#modEventTakedown':
@@ -70,26 +79,29 @@ const getSubjectStatusForModerationEvent = ({
     case 'com.atproto.admin.defs#modEventMute':
       return {
         lastReviewedBy: createdBy,
-        reviewState: REVIEWOPEN,
         lastReviewedAt: createdAt,
         // By default, mute for 24hrs
         muteUntil: new Date(
           Date.now() + (durationInHours || 24) * HOUR,
         ).toISOString(),
+        // It's not likely to receive a mute event on a subject that does not already have a status row
+        // but if it does happen, default to unnecessary
+        reviewState: defaultReviewState,
       }
     case 'com.atproto.admin.defs#modEventComment':
       return {
         lastReviewedBy: createdBy,
         lastReviewedAt: createdAt,
+        reviewState: defaultReviewState,
       }
     case 'com.atproto.admin.defs#modEventTag':
-      return { tags: [] }
+      return { tags: [], reviewState: defaultReviewState }
     case 'com.atproto.admin.defs#modEventResolveAppeal':
       return {
         appealed: false,
       }
     default:
-      return null
+      return {}
   }
 }
 
@@ -114,23 +126,6 @@ export const adjustModerationSubjectStatus = async (
     createdAt,
   } = moderationEvent
 
-  const isAppealEvent =
-    action === 'com.atproto.admin.defs#modEventReport' &&
-    meta?.reportType === REASONAPPEAL
-
-  const subjectStatus = getSubjectStatusForModerationEvent({
-    action,
-    createdBy,
-    createdAt,
-    durationInHours: moderationEvent.durationInHours,
-  })
-
-  // If there are no subjectStatus that means there are no side-effect of the incoming event
-  if (!subjectStatus) {
-    return null
-  }
-
-  const now = new Date().toISOString()
   // If subjectUri exists, it's not a repoRef so pass along the uri to get identifier back
   const identifier = getStatusIdentifierFromSubject(subjectUri || subjectDid)
 
@@ -140,25 +135,46 @@ export const adjustModerationSubjectStatus = async (
     .selectFrom('moderation_subject_status')
     .where('did', '=', identifier.did)
     .where('recordPath', '=', identifier.recordPath)
+    // Make sure we respect other updates that may be happening at the same time
+    .forUpdate()
     .selectAll()
     .executeTakeFirst()
 
+  const isAppealEvent =
+    action === 'com.atproto.admin.defs#modEventReport' &&
+    meta?.reportType === REASONAPPEAL
+
+  const subjectStatus = getSubjectStatusForModerationEvent({
+    currentStatus,
+    action,
+    createdBy,
+    createdAt,
+    durationInHours: moderationEvent.durationInHours,
+  })
+
+  const now = new Date().toISOString()
   if (
     currentStatus?.reviewState === REVIEWESCALATED &&
-    subjectStatus.reviewState === REVIEWOPEN
+    subjectStatus.reviewState !== REVIEWCLOSED
   ) {
-    // If the current status is escalated and the incoming event is to open the review
-    // We want to keep the status as escalated
+    // If the current status is escalated only allow incoming events to move the state to
+    // reviewClosed because escalated subjects should never move to any other state
     subjectStatus.reviewState = REVIEWESCALATED
   }
 
+  if (currentStatus && subjectStatus.reviewState === REVIEWNONE) {
+    // reviewNone is ONLY allowed when there is no current status
+    // If there is a current status, it should not be allowed to move back to reviewNone
+    subjectStatus.reviewState = currentStatus.reviewState
+  }
+
   // Set these because we don't want to override them if they're already set
   const defaultData = {
     comment: null,
     // Defaulting reviewState to open for any event may not be the desired behavior.
     // For instance, if a subject never had any event and we just want to leave a comment to keep an eye on it
     // that shouldn't mean we want to review the subject
-    reviewState: REVIEWOPEN,
+    reviewState: REVIEWNONE,
     recordCid: subjectCid || null,
   }
   const newStatus = {

package/tests/__snapshots__/get-record.test.ts.snap

@@ -11,7 +11,7 @@ Object {
       "cid": "cids(0)",
       "cts": "1970-01-01T00:00:00.000Z",
       "neg": false,
-      "src": "user(1)",
+      "src": "user(2)",
       "uri": "record(0)",
       "val": "!unspecced-takedown",
     },
@@ -30,7 +30,7 @@ Object {
       "id": 1,
       "lastReportedAt": "1970-01-01T00:00:00.000Z",
       "lastReviewedAt": "1970-01-01T00:00:00.000Z",
-      "lastReviewedBy": "did:example:admin",
+      "lastReviewedBy": "user(1)",
       "reviewState": "com.atproto.admin.defs#reviewClosed",
       "subject": Object {
         "$type": "com.atproto.repo.strongRef",
@@ -108,7 +108,7 @@ Object {
       "cid": "cids(0)",
       "cts": "1970-01-01T00:00:00.000Z",
       "neg": false,
-      "src": "user(1)",
+      "src": "user(2)",
       "uri": "record(0)",
       "val": "!unspecced-takedown",
     },
@@ -127,7 +127,7 @@ Object {
       "id": 1,
       "lastReportedAt": "1970-01-01T00:00:00.000Z",
       "lastReviewedAt": "1970-01-01T00:00:00.000Z",
-      "lastReviewedBy": "did:example:admin",
+      "lastReviewedBy": "user(1)",
       "reviewState": "com.atproto.admin.defs#reviewClosed",
       "subject": Object {
         "$type": "com.atproto.repo.strongRef",

package/tests/__snapshots__/get-repo.test.ts.snap

@@ -12,7 +12,7 @@ Object {
     Object {
       "cts": "1970-01-01T00:00:00.000Z",
       "neg": false,
-      "src": "user(1)",
+      "src": "user(2)",
       "uri": "user(0)",
       "val": "!unspecced-takedown",
     },
@@ -23,7 +23,7 @@ Object {
       "id": 1,
       "lastReportedAt": "1970-01-01T00:00:00.000Z",
       "lastReviewedAt": "1970-01-01T00:00:00.000Z",
-      "lastReviewedBy": "did:example:admin",
+      "lastReviewedBy": "user(1)",
       "reviewState": "com.atproto.admin.defs#reviewClosed",
       "subject": Object {
         "$type": "com.atproto.admin.defs#repoRef",

package/tests/communication-templates.test.ts

@@ -31,7 +31,7 @@ describe('communication-templates', () => {
       await agent.api.com.atproto.admin.listCommunicationTemplates(
         {},
         {
-          headers: network.ozone.adminAuthHeaders('moderator'),
+          headers: await network.ozone.modHeaders('moderator'),
         },
       )
     return data.communicationTemplates
@@ -44,7 +44,7 @@ describe('communication-templates', () => {
           { ...templateOne, createdBy: sc.dids.bob },
           {
             encoding: 'application/json',
-            headers: network.ozone.adminAuthHeaders('moderator'),
+            headers: await network.ozone.modHeaders('moderator'),
           },
         )
       await expect(moderatorReq).rejects.toThrow(
@@ -55,7 +55,7 @@ describe('communication-templates', () => {
           { ...templateOne, createdBy: sc.dids.bob },
           {
             encoding: 'application/json',
-            headers: network.ozone.adminAuthHeaders('admin'),
+            headers: await network.ozone.modHeaders('admin'),
           },
         )
 
@@ -79,7 +79,7 @@ describe('communication-templates', () => {
         { ...templateTwo, createdBy: sc.dids.bob },
         {
           encoding: 'application/json',
-          headers: network.ozone.adminAuthHeaders('admin'),
+          headers: await network.ozone.modHeaders('admin'),
         },
       )
 
@@ -95,7 +95,7 @@ describe('communication-templates', () => {
           { id: '1', updatedBy: sc.dids.bob, name: '1 Test template' },
           {
             encoding: 'application/json',
-            headers: network.ozone.adminAuthHeaders('admin'),
+            headers: await network.ozone.modHeaders('admin'),
           },
         )
 
@@ -109,7 +109,7 @@ describe('communication-templates', () => {
         { id: '1' },
         {
           encoding: 'application/json',
-          headers: network.ozone.adminAuthHeaders('moderator'),
+          headers: await network.ozone.modHeaders('moderator'),
         },
       )
 
@@ -121,7 +121,7 @@ describe('communication-templates', () => {
         { id: '1' },
         {
           encoding: 'application/json',
-          headers: network.ozone.adminAuthHeaders('admin'),
+          headers: await network.ozone.modHeaders('admin'),
         },
       )
       const list = await listTemplates()

package/tests/get-record.test.ts

@@ -1,4 +1,10 @@
-import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
+import {
+  SeedClient,
+  TestNetwork,
+  basicSeed,
+  TestOzone,
+  ModeratorClient,
+} from '@atproto/dev-env'
 import AtpAgent from '@atproto/api'
 import { AtUri } from '@atproto/syntax'
 import {
@@ -9,15 +15,19 @@ import { forSnapshot } from './_util'
 
 describe('admin get record view', () => {
   let network: TestNetwork
+  let ozone: TestOzone
   let agent: AtpAgent
   let sc: SeedClient
+  let modClient: ModeratorClient
 
   beforeAll(async () => {
     network = await TestNetwork.create({
       dbPostgresSchema: 'ozone_admin_get_record',
     })
-    agent = network.pds.getClient()
+    ozone = network.ozone
+    agent = ozone.getClient()
     sc = network.getSeedClient()
+    modClient = ozone.getModClient()
     await basicSeed(sc)
     await network.processAll()
   })
@@ -46,7 +56,7 @@ describe('admin get record view', () => {
         cid: sc.posts[sc.dids.alice][0].ref.cidStr,
       },
     })
-    await sc.emitModerationEvent({
+    await modClient.emitModerationEvent({
       event: { $type: 'com.atproto.admin.defs#modEventTakedown' },
       subject: {
         $type: 'com.atproto.repo.strongRef',
@@ -59,7 +69,7 @@ describe('admin get record view', () => {
   it('gets a record by uri, even when taken down.', async () => {
     const result = await agent.api.com.atproto.admin.getRecord(
       { uri: sc.posts[sc.dids.alice][0].ref.uriStr },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     expect(forSnapshot(result.data)).toMatchSnapshot()
   })
@@ -70,7 +80,7 @@ describe('admin get record view', () => {
         uri: sc.posts[sc.dids.alice][0].ref.uriStr,
         cid: sc.posts[sc.dids.alice][0].ref.cidStr,
       },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     expect(forSnapshot(result.data)).toMatchSnapshot()
   })
@@ -84,7 +94,7 @@ describe('admin get record view', () => {
           'badrkey',
         ).toString(),
       },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     await expect(promise).rejects.toThrow('Record not found')
   })
@@ -95,7 +105,7 @@ describe('admin get record view', () => {
         uri: sc.posts[sc.dids.alice][0].ref.uriStr,
         cid: sc.posts[sc.dids.alice][1].ref.cidStr, // Mismatching cid
       },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     await expect(promise).rejects.toThrow('Record not found')
   })

package/tests/get-repo.test.ts

@@ -1,4 +1,10 @@
-import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
+import {
+  SeedClient,
+  TestNetwork,
+  TestOzone,
+  basicSeed,
+  ModeratorClient,
+} from '@atproto/dev-env'
 import AtpAgent from '@atproto/api'
 import {
   REASONOTHER,
@@ -8,15 +14,21 @@ import { forSnapshot } from './_util'
 
 describe('admin get repo view', () => {
   let network: TestNetwork
+  let ozone: TestOzone
   let agent: AtpAgent
+  let pdsAgent: AtpAgent
   let sc: SeedClient
+  let modClient: ModeratorClient
 
   beforeAll(async () => {
     network = await TestNetwork.create({
       dbPostgresSchema: 'ozone_admin_get_repo',
     })
-    agent = network.pds.getClient()
+    ozone = network.ozone
+    agent = ozone.getClient()
+    pdsAgent = network.pds.getClient()
     sc = network.getSeedClient()
+    modClient = ozone.getModClient()
     await basicSeed(sc)
     await network.processAll()
   })
@@ -26,7 +38,7 @@ describe('admin get repo view', () => {
   })
 
   beforeAll(async () => {
-    await sc.emitModerationEvent({
+    await modClient.emitModerationEvent({
       event: { $type: 'com.atproto.admin.defs#modEventAcknowledge' },
       subject: {
         $type: 'com.atproto.admin.defs#repoRef',
@@ -50,7 +62,7 @@ describe('admin get repo view', () => {
         did: sc.dids.alice,
       },
     })
-    await sc.emitModerationEvent({
+    await modClient.emitModerationEvent({
       event: { $type: 'com.atproto.admin.defs#modEventTakedown' },
       subject: {
         $type: 'com.atproto.admin.defs#repoRef',
@@ -62,7 +74,7 @@ describe('admin get repo view', () => {
   it('gets a repo by did, even when taken down.', async () => {
     const result = await agent.api.com.atproto.admin.getRepo(
       { did: sc.dids.alice },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     expect(forSnapshot(result.data)).toMatchSnapshot()
   })
@@ -70,15 +82,15 @@ describe('admin get repo view', () => {
   it('does not include account emails for triage mods.', async () => {
     const { data: admin } = await agent.api.com.atproto.admin.getRepo(
       { did: sc.dids.bob },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     const { data: moderator } = await agent.api.com.atproto.admin.getRepo(
       { did: sc.dids.bob },
-      { headers: network.pds.adminAuthHeaders('moderator') },
+      { headers: await ozone.modHeaders('moderator') },
     )
     const { data: triage } = await agent.api.com.atproto.admin.getRepo(
       { did: sc.dids.bob },
-      { headers: network.pds.adminAuthHeaders('triage') },
+      { headers: await ozone.modHeaders('triage') },
     )
     expect(admin.email).toEqual('bob@test.com')
     expect(moderator.email).toEqual('bob@test.com')
@@ -90,7 +102,7 @@ describe('admin get repo view', () => {
     const { data: beforeEmailVerification } =
       await agent.api.com.atproto.admin.getRepo(
         { did: sc.dids.bob },
-        { headers: network.pds.adminAuthHeaders() },
+        { headers: await ozone.modHeaders() },
       )
 
     expect(beforeEmailVerification.emailConfirmedAt).toBeUndefined()
@@ -101,7 +113,7 @@ describe('admin get repo view', () => {
         sc.dids.bob,
         'confirm_email',
       )
-    await agent.api.com.atproto.server.confirmEmail(
+    await pdsAgent.api.com.atproto.server.confirmEmail(
       { email: bobsAccount.email, token: verificationToken },
       {
         encoding: 'application/json',
@@ -112,7 +124,7 @@ describe('admin get repo view', () => {
     const { data: afterEmailVerification } =
       await agent.api.com.atproto.admin.getRepo(
         { did: sc.dids.bob },
-        { headers: network.pds.adminAuthHeaders() },
+        { headers: await ozone.modHeaders() },
       )
 
     expect(afterEmailVerification.emailConfirmedAt).toBeTruthy()
@@ -124,7 +136,7 @@ describe('admin get repo view', () => {
   it('fails when repo does not exist.', async () => {
     const promise = agent.api.com.atproto.admin.getRepo(
       { did: 'did:plc:doesnotexist' },
-      { headers: network.pds.adminAuthHeaders() },
+      { headers: await ozone.modHeaders() },
     )
     await expect(promise).rejects.toThrow('Repo not found')
   })