@atproto/pds 0.5.12 → 0.5.14

package/tests/preferences.test.ts

@@ -1,352 +0,0 @@
-import { AtpAgent } from '@atproto/api'
-import { SeedClient, TestNetworkNoAppView } from '@atproto/dev-env'
-import type { Unknown$Type } from '@atproto/lex'
-import usersSeed from './seeds/users.js'
-
-describe('user preferences', () => {
-  let network: TestNetworkNoAppView
-  let agent: AtpAgent
-  let sc: SeedClient
-  let appPassHeaders: { authorization: string }
-
-  beforeAll(async () => {
-    network = await TestNetworkNoAppView.create({
-      dbPostgresSchema: 'preferences',
-    })
-    agent = network.pds.getAgent()
-    sc = network.getSeedClient()
-    await usersSeed(sc)
-    const appPass = await network.pds.ctx.accountManager.createAppPassword(
-      sc.dids.alice,
-      'test app pass',
-      false,
-    )
-    const res = await agent.com.atproto.server.createSession({
-      identifier: sc.dids.alice,
-      password: appPass.password,
-    })
-    appPassHeaders = { authorization: `Bearer ${res.data.accessJwt}` }
-  }, 20_000) // @NOTE seeding can take a while
-
-  afterAll(async () => {
-    await network?.close()
-  })
-
-  it('requires auth to set or put preferences.', async () => {
-    const tryPut = agent.api.app.bsky.actor.putPreferences({
-      preferences: [
-        { $type: 'app.bsky.actor.defs#adultContentPref', enabled: false },
-      ],
-    })
-    await expect(tryPut).rejects.toThrow('Authentication Required')
-    const tryGet = agent.api.app.bsky.actor.getPreferences()
-    await expect(tryGet).rejects.toThrow('Authentication Required')
-  })
-
-  it('gets preferences, before any are set.', async () => {
-    const { data } = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: sc.getHeaders(sc.dids.alice) },
-    )
-    expect(data).toEqual({
-      preferences: [],
-    })
-  })
-
-  it('only gets preferences in app.bsky namespace.', async () => {
-    await network.pds.ctx.actorStore.transact(sc.dids.alice, (store) =>
-      store.pref.putPreferences(
-        [{ $type: 'com.atproto.server.defs#unknown' as Unknown$Type }],
-        'com.atproto',
-        {
-          hasAccessFull: true,
-        },
-      ),
-    )
-    const { data } = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: sc.getHeaders(sc.dids.alice) },
-    )
-    expect(data).toEqual({ preferences: [] })
-  })
-
-  it('puts preferences, all creates.', async () => {
-    await agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [
-          { $type: 'app.bsky.actor.defs#adultContentPref', enabled: false },
-          {
-            $type: 'app.bsky.actor.defs#contentLabelPref',
-            label: 'dogs',
-            visibility: 'show',
-          },
-          {
-            $type: 'app.bsky.actor.defs#contentLabelPref',
-            label: 'cats',
-            visibility: 'warn',
-          },
-        ],
-      },
-      { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-    )
-    const { data } = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: sc.getHeaders(sc.dids.alice) },
-    )
-    expect(data).toEqual({
-      preferences: [
-        { $type: 'app.bsky.actor.defs#adultContentPref', enabled: false },
-        {
-          $type: 'app.bsky.actor.defs#contentLabelPref',
-          label: 'dogs',
-          visibility: 'show',
-        },
-        {
-          $type: 'app.bsky.actor.defs#contentLabelPref',
-          label: 'cats',
-          visibility: 'warn',
-        },
-      ],
-    })
-    // Ensure other prefs were not clobbered
-    const otherPrefs = await network.pds.ctx.actorStore.read(
-      sc.dids.alice,
-      (store) =>
-        store.pref.getPreferences('com.atproto', {
-          hasAccessFull: true,
-        }),
-    )
-    expect(otherPrefs).toEqual([{ $type: 'com.atproto.server.defs#unknown' }])
-  })
-
-  it('puts preferences, updates and removals.', async () => {
-    await agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [
-          { $type: 'app.bsky.actor.defs#adultContentPref', enabled: true },
-          {
-            $type: 'app.bsky.actor.defs#contentLabelPref',
-            label: 'dogs',
-            visibility: 'warn',
-          },
-        ],
-      },
-      { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-    )
-    const { data } = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: sc.getHeaders(sc.dids.alice) },
-    )
-    expect(data).toEqual({
-      preferences: [
-        { $type: 'app.bsky.actor.defs#adultContentPref', enabled: true },
-        {
-          $type: 'app.bsky.actor.defs#contentLabelPref',
-          label: 'dogs',
-          visibility: 'warn',
-        },
-      ],
-    })
-  })
-
-  it('puts preferences, clearing them.', async () => {
-    await agent.api.app.bsky.actor.putPreferences(
-      { preferences: [] },
-      { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-    )
-    const { data } = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: sc.getHeaders(sc.dids.alice) },
-    )
-    expect(data).toEqual({ preferences: [] })
-  })
-
-  it('fails putting preferences outside namespace.', async () => {
-    const tryPut = agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [
-          { $type: 'app.bsky.actor.defs#adultContentPref', enabled: false },
-          {
-            $type: 'com.atproto.server.defs#unknown',
-            // @ts-expect-error un-spec'ed prop
-            hello: 'world',
-          },
-        ],
-      },
-      { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-    )
-    await expect(tryPut).rejects.toThrow(
-      'Some preferences are not in the app.bsky namespace',
-    )
-  })
-
-  it('fails putting preferences without $type.', async () => {
-    const tryPut = agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [
-          { $type: 'app.bsky.actor.defs#adultContentPref', enabled: false },
-          // @ts-expect-error this is what we are testing !
-          {
-            label: 'dogs',
-            visibility: 'warn',
-          },
-        ],
-      },
-      { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-    )
-    await expect(tryPut).rejects.toMatchObject({
-      error: 'InvalidRequest',
-      message: expect.stringContaining(
-        'object which includes the "$type" property',
-      ),
-    })
-  })
-
-  it('does not read permissioned preferences with an app password', async () => {
-    await agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [
-          {
-            $type: 'app.bsky.actor.defs#personalDetailsPref',
-            birthDate: new Date().toISOString(),
-          },
-        ],
-      },
-      { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-    )
-    const res = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: appPassHeaders },
-    )
-    expect(res.data.preferences).toEqual([
-      {
-        $type: 'app.bsky.actor.defs#declaredAgePref',
-        isOverAge13: false,
-        isOverAge16: false,
-        isOverAge18: false,
-      },
-    ])
-  })
-
-  it('does not write permissioned preferences with an app password', async () => {
-    const tryPut = agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [
-          {
-            $type: 'app.bsky.actor.defs#personalDetailsPref',
-            birthDate: new Date().toISOString(),
-          },
-        ],
-      },
-      { headers: appPassHeaders, encoding: 'application/json' },
-    )
-    await expect(tryPut).rejects.toThrow(
-      /Do not have authorization to set preferences/,
-    )
-  })
-
-  it('does not remove permissioned preferences with an app password', async () => {
-    await agent.api.app.bsky.actor.putPreferences(
-      {
-        preferences: [],
-      },
-      { headers: appPassHeaders, encoding: 'application/json' },
-    )
-    const res = await agent.api.app.bsky.actor.getPreferences(
-      {},
-      { headers: sc.getHeaders(sc.dids.alice) },
-    )
-    const scopedPref = res.data.preferences.find(
-      (pref) => pref.$type === 'app.bsky.actor.defs#personalDetailsPref',
-    )
-    expect(scopedPref).toBeDefined()
-  })
-
-  describe('personalDetailsPref and declaredAgePref', () => {
-    const birthDate = new Date(1970, 0, 1).toISOString()
-
-    it('declaredAgePref is computed and returned for authed user', async () => {
-      await agent.api.app.bsky.actor.putPreferences(
-        {
-          preferences: [
-            {
-              $type: 'app.bsky.actor.defs#personalDetailsPref',
-              birthDate,
-            },
-          ],
-        },
-        { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-      )
-      const res = await agent.api.app.bsky.actor.getPreferences(
-        {},
-        { headers: sc.getHeaders(sc.dids.alice) },
-      )
-      expect(res.data.preferences).toContainEqual({
-        $type: 'app.bsky.actor.defs#declaredAgePref',
-        isOverAge13: true,
-        isOverAge16: true,
-        isOverAge18: true,
-      })
-    })
-
-    it('declaredAgePref is computed and returned for app password', async () => {
-      await agent.api.app.bsky.actor.putPreferences(
-        {
-          preferences: [
-            {
-              $type: 'app.bsky.actor.defs#personalDetailsPref',
-              birthDate,
-            },
-          ],
-        },
-        { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-      )
-      const res = await agent.api.app.bsky.actor.getPreferences(
-        {},
-        { headers: appPassHeaders },
-      )
-      expect(res.data.preferences).toContainEqual({
-        $type: 'app.bsky.actor.defs#declaredAgePref',
-        isOverAge13: true,
-        isOverAge16: true,
-        isOverAge18: true,
-      })
-    })
-
-    it('user cannot set declaredAgePref', async () => {
-      await agent.api.app.bsky.actor.putPreferences(
-        {
-          preferences: [
-            {
-              $type: 'app.bsky.actor.defs#personalDetailsPref',
-              birthDate,
-            },
-            {
-              $type: 'app.bsky.actor.defs#declaredAgePref',
-              isOverAge13: false,
-              isOverAge16: false,
-              isOverAge18: false,
-            },
-          ],
-        },
-        { headers: sc.getHeaders(sc.dids.alice), encoding: 'application/json' },
-      )
-      const res = await agent.api.app.bsky.actor.getPreferences(
-        {},
-        { headers: sc.getHeaders(sc.dids.alice) },
-      )
-      expect(res.data.preferences).toEqual([
-        {
-          $type: 'app.bsky.actor.defs#personalDetailsPref',
-          birthDate,
-        },
-        {
-          $type: 'app.bsky.actor.defs#declaredAgePref',
-          isOverAge13: true,
-          isOverAge16: true,
-          isOverAge18: true,
-        },
-      ])
-    })
-  })
-})