@atproto/api 0.10.5 → 0.11.0-next

package/tests/moderation-custom-labels.test.ts

@@ -0,0 +1,358 @@
+import {
+  moderateProfile,
+  moderatePost,
+  mock,
+  ModerationOpts,
+  InterprettedLabelValueDefinition,
+  interpretLabelValueDefinition,
+} from '../src'
+import './util/moderation-behavior'
+
+interface ScenarioResult {
+  profileList?: string[]
+  profileView?: string[]
+  avatar?: string[]
+  banner?: string[]
+  displayName?: string[]
+  contentList?: string[]
+  contentView?: string[]
+  contentMedia?: string[]
+}
+
+interface Scenario {
+  blurs: 'content' | 'media' | 'none'
+  severity: 'alert' | 'inform' | 'none'
+  account: ScenarioResult
+  profile: ScenarioResult
+  post: ScenarioResult
+}
+
+const TESTS: Scenario[] = [
+  {
+    blurs: 'content',
+    severity: 'alert',
+    account: {
+      profileList: ['filter', 'alert'],
+      profileView: ['alert'],
+      contentList: ['filter', 'blur'],
+      contentView: ['alert'],
+    },
+    profile: {
+      profileList: ['filter'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      displayName: ['blur'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter', 'blur'],
+      contentView: ['alert'],
+    },
+  },
+  {
+    blurs: 'content',
+    severity: 'inform',
+    account: {
+      profileList: ['filter', 'inform'],
+      profileView: ['inform'],
+      contentList: ['filter', 'blur'],
+      contentView: ['inform'],
+    },
+    profile: {
+      profileList: ['filter'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      displayName: ['blur'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter', 'blur'],
+      contentView: ['inform'],
+    },
+  },
+  {
+    blurs: 'content',
+    severity: 'none',
+    account: {
+      profileList: ['filter'],
+      profileView: [],
+      contentList: ['filter', 'blur'],
+      contentView: [],
+    },
+    profile: {
+      profileList: ['filter'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      displayName: ['blur'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter', 'blur'],
+      contentView: [],
+    },
+  },
+
+  {
+    blurs: 'media',
+    severity: 'alert',
+    account: {
+      profileList: ['filter', 'alert'],
+      profileView: ['alert'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      contentList: ['filter'],
+      contentMedia: ['blur'],
+    },
+    profile: {
+      profileList: ['filter'],
+      profileView: ['alert'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter'],
+      contentMedia: ['blur'],
+    },
+  },
+  {
+    blurs: 'media',
+    severity: 'inform',
+    account: {
+      profileList: ['filter', 'inform'],
+      profileView: ['inform'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      contentList: ['filter'],
+      contentMedia: ['blur'],
+    },
+    profile: {
+      profileList: ['filter'],
+      profileView: ['inform'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter'],
+      contentMedia: ['blur'],
+    },
+  },
+  {
+    blurs: 'media',
+    severity: 'none',
+    account: {
+      profileList: ['filter'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      contentList: ['filter'],
+      contentMedia: ['blur'],
+    },
+    profile: {
+      profileList: ['filter'],
+      avatar: ['blur'],
+      banner: ['blur'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter'],
+      contentMedia: ['blur'],
+    },
+  },
+
+  {
+    blurs: 'none',
+    severity: 'alert',
+    account: {
+      profileList: ['filter', 'alert'],
+      profileView: ['alert'],
+      contentList: ['filter', 'alert'],
+      contentView: ['alert'],
+    },
+    profile: {
+      profileList: ['filter'],
+      profileView: ['alert'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter', 'alert'],
+      contentView: ['alert'],
+    },
+  },
+  {
+    blurs: 'none',
+    severity: 'inform',
+    account: {
+      profileList: ['filter', 'inform'],
+      profileView: ['inform'],
+      contentList: ['filter', 'inform'],
+      contentView: ['inform'],
+    },
+    profile: {
+      profileList: ['filter'],
+      profileView: ['inform'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter', 'inform'],
+      contentView: ['inform'],
+    },
+  },
+  {
+    blurs: 'none',
+    severity: 'none',
+    account: {
+      profileList: ['filter'],
+      contentList: ['filter'],
+    },
+    profile: {
+      profileList: ['filter'],
+      contentList: ['filter'],
+    },
+    post: {
+      profileList: ['filter'],
+      contentList: ['filter'],
+    },
+  },
+]
+
+describe('Moderation: custom labels', () => {
+  const scenarios = TESTS.flatMap((test) => [
+    {
+      blurs: test.blurs,
+      severity: test.severity,
+      target: 'post',
+      expected: test.post,
+    },
+    {
+      blurs: test.blurs,
+      severity: test.severity,
+      target: 'profile',
+      expected: test.profile,
+    },
+    {
+      blurs: test.blurs,
+      severity: test.severity,
+      target: 'account',
+      expected: test.account,
+    },
+  ])
+  it.each(scenarios)(
+    'blurs=$blurs, severity=$severity, target=$target',
+    ({ blurs, severity, target, expected }) => {
+      let res
+      if (target === 'post') {
+        res = moderatePost(
+          mock.postView({
+            record: {
+              text: 'Hello',
+              createdAt: new Date().toISOString(),
+            },
+            author: mock.profileViewBasic({
+              handle: 'bob.test',
+              displayName: 'Bob',
+            }),
+            labels: [
+              mock.label({
+                val: 'custom',
+                uri: 'at://did:web:bob.test/app.bsky.feed.post/fake',
+                src: 'did:web:labeler.test',
+              }),
+            ],
+          }),
+          modOpts(blurs, severity),
+        )
+      } else if (target === 'profile') {
+        res = moderateProfile(
+          mock.profileViewBasic({
+            handle: 'bob.test',
+            displayName: 'Bob',
+            labels: [
+              mock.label({
+                val: 'custom',
+                uri: 'at://did:web:bob.test/app.bsky.actor.profile/self',
+                src: 'did:web:labeler.test',
+              }),
+            ],
+          }),
+          modOpts(blurs, severity),
+        )
+      } else {
+        res = moderateProfile(
+          mock.profileViewBasic({
+            handle: 'bob.test',
+            displayName: 'Bob',
+            labels: [
+              mock.label({
+                val: 'custom',
+                uri: 'did:web:bob.test',
+                src: 'did:web:labeler.test',
+              }),
+            ],
+          }),
+          modOpts(blurs, severity),
+        )
+        expect(res.ui('profileList')).toBeModerationResult(
+          expected.profileList || [],
+        )
+        expect(res.ui('profileView')).toBeModerationResult(
+          expected.profileView || [],
+        )
+        expect(res.ui('avatar')).toBeModerationResult(expected.avatar || [])
+        expect(res.ui('banner')).toBeModerationResult(expected.banner || [])
+        expect(res.ui('displayName')).toBeModerationResult(
+          expected.displayName || [],
+        )
+        expect(res.ui('contentList')).toBeModerationResult(
+          expected.contentList || [],
+        )
+        expect(res.ui('contentView')).toBeModerationResult(
+          expected.contentView || [],
+        )
+        expect(res.ui('contentMedia')).toBeModerationResult(
+          expected.contentMedia || [],
+        )
+      }
+    },
+  )
+})
+
+function modOpts(blurs: string, severity: string): ModerationOpts {
+  return {
+    userDid: 'did:web:alice.test',
+    prefs: {
+      adultContentEnabled: true,
+      labels: {},
+      mods: [
+        {
+          did: 'did:web:labeler.test',
+          labels: { custom: 'hide' },
+        },
+      ],
+    },
+    labelDefs: {
+      'did:web:labeler.test': [makeCustomLabel(blurs, severity)],
+    },
+  }
+}
+
+function makeCustomLabel(
+  blurs: string,
+  severity: string,
+): InterprettedLabelValueDefinition {
+  return interpretLabelValueDefinition({
+    identifier: 'custom',
+    blurs,
+    severity,
+    defaultSetting: 'warn',
+    locales: [],
+  })
+}

package/tests/moderation-prefs.test.ts

@@ -0,0 +1,276 @@
+import { TestNetworkNoAppView } from '@atproto/dev-env'
+import { BskyAgent, BSKY_MODSERVICE_DID, DEFAULT_LABEL_SETTINGS } from '..'
+import './util/moderation-behavior'
+
+describe('agent', () => {
+  let network: TestNetworkNoAppView
+
+  beforeAll(async () => {
+    network = await TestNetworkNoAppView.create({
+      dbPostgresSchema: 'bsky_agent',
+    })
+  })
+
+  afterAll(async () => {
+    await network.close()
+  })
+
+  it('migrates legacy content-label prefs (no mutations)', async () => {
+    const agent = new BskyAgent({ service: network.pds.url })
+
+    await agent.createAccount({
+      handle: 'user1.test',
+      email: 'user1@test.com',
+      password: 'password',
+    })
+
+    await agent.app.bsky.actor.putPreferences({
+      preferences: [
+        {
+          $type: 'app.bsky.actor.defs#contentLabelPref',
+          label: 'nsfw',
+          visibility: 'show',
+        },
+        {
+          $type: 'app.bsky.actor.defs#contentLabelPref',
+          label: 'nudity',
+          visibility: 'show',
+        },
+        {
+          $type: 'app.bsky.actor.defs#contentLabelPref',
+          label: 'suggestive',
+          visibility: 'show',
+        },
+        {
+          $type: 'app.bsky.actor.defs#contentLabelPref',
+          label: 'gore',
+          visibility: 'show',
+        },
+      ],
+    })
+    await expect(agent.getPreferences()).resolves.toStrictEqual({
+      feeds: {
+        pinned: undefined,
+        saved: undefined,
+      },
+      hiddenPosts: [],
+      interests: { tags: [] },
+      moderationPrefs: {
+        adultContentEnabled: false,
+        labels: {
+          porn: 'ignore',
+          nudity: 'ignore',
+          sexual: 'ignore',
+          gore: 'ignore',
+        },
+        mods: [
+          {
+            did: BSKY_MODSERVICE_DID,
+            labels: {},
+          },
+        ],
+      },
+      birthDate: undefined,
+      feedViewPrefs: {
+        home: {
+          hideQuotePosts: false,
+          hideReplies: false,
+          hideRepliesByLikeCount: 0,
+          hideRepliesByUnfollowed: true,
+          hideReposts: false,
+        },
+      },
+      mutedWords: [],
+      threadViewPrefs: {
+        prioritizeFollowedUsers: true,
+        sort: 'oldest',
+      },
+    })
+    expect(agent.labelersHeader).toStrictEqual([BSKY_MODSERVICE_DID])
+  })
+
+  it('adds/removes moderation services', async () => {
+    const agent = new BskyAgent({ service: network.pds.url })
+
+    await agent.createAccount({
+      handle: 'user5.test',
+      email: 'user5@test.com',
+      password: 'password',
+    })
+
+    await agent.addModService('did:plc:other')
+    expect(agent.labelersHeader).toStrictEqual([
+      BSKY_MODSERVICE_DID,
+      'did:plc:other',
+    ])
+    await expect(agent.getPreferences()).resolves.toStrictEqual({
+      feeds: { pinned: undefined, saved: undefined },
+      hiddenPosts: [],
+      interests: { tags: [] },
+      moderationPrefs: {
+        adultContentEnabled: false,
+        labels: DEFAULT_LABEL_SETTINGS,
+        mods: [
+          {
+            did: BSKY_MODSERVICE_DID,
+            labels: {},
+          },
+          {
+            did: 'did:plc:other',
+            labels: {},
+          },
+        ],
+      },
+      birthDate: undefined,
+      feedViewPrefs: {
+        home: {
+          hideReplies: false,
+          hideRepliesByUnfollowed: true,
+          hideRepliesByLikeCount: 0,
+          hideReposts: false,
+          hideQuotePosts: false,
+        },
+      },
+      mutedWords: [],
+      threadViewPrefs: {
+        sort: 'oldest',
+        prioritizeFollowedUsers: true,
+      },
+    })
+    expect(agent.labelersHeader).toStrictEqual([
+      BSKY_MODSERVICE_DID,
+      'did:plc:other',
+    ])
+
+    await agent.removeModService('did:plc:other')
+    expect(agent.labelersHeader).toStrictEqual([BSKY_MODSERVICE_DID])
+    await expect(agent.getPreferences()).resolves.toStrictEqual({
+      feeds: { pinned: undefined, saved: undefined },
+      hiddenPosts: [],
+      interests: { tags: [] },
+      moderationPrefs: {
+        adultContentEnabled: false,
+        labels: DEFAULT_LABEL_SETTINGS,
+        mods: [
+          {
+            did: BSKY_MODSERVICE_DID,
+            labels: {},
+          },
+        ],
+      },
+      birthDate: undefined,
+      feedViewPrefs: {
+        home: {
+          hideReplies: false,
+          hideRepliesByUnfollowed: true,
+          hideRepliesByLikeCount: 0,
+          hideReposts: false,
+          hideQuotePosts: false,
+        },
+      },
+      mutedWords: [],
+      threadViewPrefs: {
+        sort: 'oldest',
+        prioritizeFollowedUsers: true,
+      },
+    })
+    expect(agent.labelersHeader).toStrictEqual([BSKY_MODSERVICE_DID])
+  })
+
+  it('cant remove the default moderation service', async () => {
+    const agent = new BskyAgent({ service: network.pds.url })
+
+    await agent.createAccount({
+      handle: 'user6.test',
+      email: 'user6@test.com',
+      password: 'password',
+    })
+
+    await agent.removeModService(BSKY_MODSERVICE_DID)
+    expect(agent.labelersHeader).toStrictEqual([BSKY_MODSERVICE_DID])
+    await expect(agent.getPreferences()).resolves.toStrictEqual({
+      feeds: { pinned: undefined, saved: undefined },
+      hiddenPosts: [],
+      interests: { tags: [] },
+      moderationPrefs: {
+        adultContentEnabled: false,
+        labels: DEFAULT_LABEL_SETTINGS,
+        mods: [
+          {
+            did: BSKY_MODSERVICE_DID,
+            labels: {},
+          },
+        ],
+      },
+      birthDate: undefined,
+      feedViewPrefs: {
+        home: {
+          hideReplies: false,
+          hideRepliesByUnfollowed: true,
+          hideRepliesByLikeCount: 0,
+          hideReposts: false,
+          hideQuotePosts: false,
+        },
+      },
+      mutedWords: [],
+      threadViewPrefs: {
+        sort: 'oldest',
+        prioritizeFollowedUsers: true,
+      },
+    })
+    expect(agent.labelersHeader).toStrictEqual([BSKY_MODSERVICE_DID])
+  })
+
+  it('sets label preferences globally and per-moderator', async () => {
+    const agent = new BskyAgent({ service: network.pds.url })
+
+    await agent.createAccount({
+      handle: 'user7.test',
+      email: 'user7@test.com',
+      password: 'password',
+    })
+
+    await agent.addModService('did:plc:other')
+    await agent.setContentLabelPref('porn', 'ignore')
+    await agent.setContentLabelPref('porn', 'hide', 'did:plc:other')
+    await agent.setContentLabelPref('x-custom', 'warn', 'did:plc:other')
+
+    await expect(agent.getPreferences()).resolves.toStrictEqual({
+      feeds: { pinned: undefined, saved: undefined },
+      hiddenPosts: [],
+      interests: { tags: [] },
+      moderationPrefs: {
+        adultContentEnabled: false,
+        labels: { ...DEFAULT_LABEL_SETTINGS, porn: 'ignore' },
+        mods: [
+          {
+            did: BSKY_MODSERVICE_DID,
+            labels: {},
+          },
+          {
+            did: 'did:plc:other',
+            labels: {
+              porn: 'hide',
+              'x-custom': 'warn',
+            },
+          },
+        ],
+      },
+      birthDate: undefined,
+      feedViewPrefs: {
+        home: {
+          hideReplies: false,
+          hideRepliesByUnfollowed: true,
+          hideRepliesByLikeCount: 0,
+          hideReposts: false,
+          hideQuotePosts: false,
+        },
+      },
+      mutedWords: [],
+      threadViewPrefs: {
+        sort: 'oldest',
+        prioritizeFollowedUsers: true,
+      },
+    })
+  })
+})