✨ Add Search against normalized email column

bluesky-social · Apr 22, 2024 · ec0bebd · ec0bebd
1 parent 01f15c3
commit ec0bebd
Show file tree

Hide file tree

Showing 17 changed files with 400 additions and 85 deletions.
diff --git a/lexicons/com/atproto/admin/searchAccounts.json b/lexicons/com/atproto/admin/searchAccounts.json
@@ -8,26 +8,37 @@
       "parameters": {
         "type": "params",
         "properties": {
-          "email": { "type": "string" }
+          "email": { "type": "string" },
+          "cursor": { "type": "string" }
         }
       },
       "output": {
         "encoding": "application/json",
         "schema": {
           "type": "object",
-          "required": ["cursor", "accounts"],
+          "required": ["accounts"],
           "properties": {
             "cursor": { "type": "string" },
             "accounts": {
               "type": "array",
               "items": {
                 "type": "ref",
-                "ref": "com.atproto.admin.defs#accountView"
+                "ref": "#accountSearchResult"
               }
             }
           }
         }
       }
+    },
+    "accountSearchResult": {
+      "type": "object",
+      "required": ["did", "email"],
+      "properties": {
+        "did": { "type": "string" },
+        "email": { "type": "string" },
+        "normalizedEmail": { "type": "string" },
+        "handle": { "type": "string" }
+      }
     }
   }
 }
diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -383,13 +383,16 @@ export const schemaDict = {
             email: {
               type: 'string',
             },
+            cursor: {
+              type: 'string',
+            },
           },
         },
         output: {
           encoding: 'application/json',
           schema: {
             type: 'object',
-            required: ['cursor', 'accounts'],
+            required: ['accounts'],
             properties: {
               cursor: {
                 type: 'string',
@@ -398,13 +401,31 @@ export const schemaDict = {
                 type: 'array',
                 items: {
                   type: 'ref',
-                  ref: 'lex:com.atproto.admin.defs#accountView',
+                  ref: 'lex:com.atproto.admin.searchAccounts#accountSearchResult',
                 },
               },
             },
           },
         },
       },
+      accountSearchResult: {
+        type: 'object',
+        required: ['did', 'email'],
+        properties: {
+          did: {
+            type: 'string',
+          },
+          email: {
+            type: 'string',
+          },
+          normalizedEmail: {
+            type: 'string',
+          },
+          handle: {
+            type: 'string',
+          },
+        },
+      },
     },
   },
   ComAtprotoAdminSendEmail: {

diff --git a/packages/api/src/client/types/com/atproto/admin/searchAccounts.ts b/packages/api/src/client/types/com/atproto/admin/searchAccounts.ts
@@ -6,17 +6,17 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
-import * as ComAtprotoAdminDefs from './defs'
 
 export interface QueryParams {
   email?: string
+  cursor?: string
 }
 
 export type InputSchema = undefined
 
 export interface OutputSchema {
-  cursor: string
-  accounts: ComAtprotoAdminDefs.AccountView[]
+  cursor?: string
+  accounts: AccountSearchResult[]
   [k: string]: unknown
 }
 
@@ -35,3 +35,26 @@ export function toKnownErr(e: any) {
   }
   return e
 }
+
+export interface AccountSearchResult {
+  did: string
+  email: string
+  normalizedEmail?: string
+  handle?: string
+  [k: string]: unknown
+}
+
+export function isAccountSearchResult(v: unknown): v is AccountSearchResult {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.searchAccounts#accountSearchResult'
+  )
+}
+
+export function validateAccountSearchResult(v: unknown): ValidationResult {
+  return lexicons.validate(
+    'com.atproto.admin.searchAccounts#accountSearchResult',
+    v,
+  )
+}
diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -383,13 +383,16 @@ export const schemaDict = {
             email: {
               type: 'string',
             },
+            cursor: {
+              type: 'string',
+            },
           },
         },
         output: {
           encoding: 'application/json',
           schema: {
             type: 'object',
-            required: ['cursor', 'accounts'],
+            required: ['accounts'],
             properties: {
               cursor: {
                 type: 'string',
@@ -398,13 +401,31 @@ export const schemaDict = {
                 type: 'array',
                 items: {
                   type: 'ref',
-                  ref: 'lex:com.atproto.admin.defs#accountView',
+                  ref: 'lex:com.atproto.admin.searchAccounts#accountSearchResult',
                 },
               },
             },
           },
         },
       },
+      accountSearchResult: {
+        type: 'object',
+        required: ['did', 'email'],
+        properties: {
+          did: {
+            type: 'string',
+          },
+          email: {
+            type: 'string',
+          },
+          normalizedEmail: {
+            type: 'string',
+          },
+          handle: {
+            type: 'string',
+          },
+        },
+      },
     },
   },
   ComAtprotoAdminSendEmail: {

diff --git a/packages/bsky/src/lexicon/types/com/atproto/admin/searchAccounts.ts b/packages/bsky/src/lexicon/types/com/atproto/admin/searchAccounts.ts
@@ -7,17 +7,17 @@ import { lexicons } from '../../../../lexicons'
 import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
-import * as ComAtprotoAdminDefs from './defs'
 
 export interface QueryParams {
   email?: string
+  cursor?: string
 }
 
 export type InputSchema = undefined
 
 export interface OutputSchema {
-  cursor: string
-  accounts: ComAtprotoAdminDefs.AccountView[]
+  cursor?: string
+  accounts: AccountSearchResult[]
   [k: string]: unknown
 }
 
@@ -45,3 +45,26 @@ export type HandlerReqCtx<HA extends HandlerAuth = never> = {
 export type Handler<HA extends HandlerAuth = never> = (
   ctx: HandlerReqCtx<HA>,
 ) => Promise<HandlerOutput> | HandlerOutput
+
+export interface AccountSearchResult {
+  did: string
+  email: string
+  normalizedEmail?: string
+  handle?: string
+  [k: string]: unknown
+}
+
+export function isAccountSearchResult(v: unknown): v is AccountSearchResult {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.searchAccounts#accountSearchResult'
+  )
+}
+
+export function validateAccountSearchResult(v: unknown): ValidationResult {
+  return lexicons.validate(
+    'com.atproto.admin.searchAccounts#accountSearchResult',
+    v,
+  )
+}
diff --git a/packages/ozone/src/lexicon/lexicons.ts b/packages/ozone/src/lexicon/lexicons.ts
@@ -383,13 +383,16 @@ export const schemaDict = {
             email: {
               type: 'string',
             },
+            cursor: {
+              type: 'string',
+            },
           },
         },
         output: {
           encoding: 'application/json',
           schema: {
             type: 'object',
-            required: ['cursor', 'accounts'],
+            required: ['accounts'],
             properties: {
               cursor: {
                 type: 'string',
@@ -398,13 +401,31 @@ export const schemaDict = {
                 type: 'array',
                 items: {
                   type: 'ref',
-                  ref: 'lex:com.atproto.admin.defs#accountView',
+                  ref: 'lex:com.atproto.admin.searchAccounts#accountSearchResult',
                 },
               },
             },
           },
         },
       },
+      accountSearchResult: {
+        type: 'object',
+        required: ['did', 'email'],
+        properties: {
+          did: {
+            type: 'string',
+          },
+          email: {
+            type: 'string',
+          },
+          normalizedEmail: {
+            type: 'string',
+          },
+          handle: {
+            type: 'string',
+          },
+        },
+      },
     },
   },
   ComAtprotoAdminSendEmail: {

diff --git a/packages/ozone/src/lexicon/types/com/atproto/admin/searchAccounts.ts b/packages/ozone/src/lexicon/types/com/atproto/admin/searchAccounts.ts
@@ -7,17 +7,17 @@ import { lexicons } from '../../../../lexicons'
 import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
-import * as ComAtprotoAdminDefs from './defs'
 
 export interface QueryParams {
   email?: string
+  cursor?: string
 }
 
 export type InputSchema = undefined
 
 export interface OutputSchema {
-  cursor: string
-  accounts: ComAtprotoAdminDefs.AccountView[]
+  cursor?: string
+  accounts: AccountSearchResult[]
   [k: string]: unknown
 }
 
@@ -45,3 +45,26 @@ export type HandlerReqCtx<HA extends HandlerAuth = never> = {
 export type Handler<HA extends HandlerAuth = never> = (
   ctx: HandlerReqCtx<HA>,
 ) => Promise<HandlerOutput> | HandlerOutput
+
+export interface AccountSearchResult {
+  did: string
+  email: string
+  normalizedEmail?: string
+  handle?: string
+  [k: string]: unknown
+}
+
+export function isAccountSearchResult(v: unknown): v is AccountSearchResult {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.searchAccounts#accountSearchResult'
+  )
+}
+
+export function validateAccountSearchResult(v: unknown): ValidationResult {
+  return lexicons.validate(
+    'com.atproto.admin.searchAccounts#accountSearchResult',
+    v,
+  )
+}
diff --git a/packages/pds/src/account-manager/db/migrations/003-normalized-email.ts b/packages/pds/src/account-manager/db/migrations/003-normalized-email.ts
@@ -0,0 +1,12 @@
+import { Kysely } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('account')
+    .addColumn('normalizedEmail', 'varchar')
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema.alterTable('account').dropColumn('normalizedEmail').execute()
+}
diff --git a/packages/pds/src/account-manager/db/migrations/index.ts b/packages/pds/src/account-manager/db/migrations/index.ts
@@ -1,7 +1,9 @@
 import * as mig001 from './001-init'
 import * as mig002 from './002-account-deactivation'
+import * as mig003 from './003-normalized-email'
 
 export default {
   '001': mig001,
   '002': mig002,
+  '003': mig003,
 }
diff --git a/packages/pds/src/account-manager/db/schema/account.ts b/packages/pds/src/account-manager/db/schema/account.ts
@@ -3,6 +3,7 @@ import { Generated, Selectable } from 'kysely'
 export interface Account {
   did: string
   email: string
+  normalizedEmail: string | null
   passwordScrypt: string
   emailConfirmedAt: string | null
   invitesDisabled: Generated<0 | 1>