commit d66ceb437320b78f5a0c1b936925f91e6249d0ad · edouard.paris/did-method-plc

+11 -4

packages/lib/src/client.ts

···

       13
       13
        
         }

     

       14
       14
        
       

     

       15
       15
        
         async getDocumentData(did: string): Promise<t.DocumentData> {

     

       16
       16
       -
           const res = await axios.get(`${this.url}/data/${encodeURIComponent(did)}`)

     

       16
       16
       +
           const res = await axios.get(`${this.url}/${encodeURIComponent(did)}/data`)

     

       17
       17
        
           return res.data

     

       18
       18
        
         }

     

       19
       19
        
       

     

       20
       20
       -
         async getOperationLog(did: string): Promise<t.Operation[]> {

     

       21
       21
       -
           const res = await axios.get(`${this.url}/log/${encodeURIComponent(did)}`)

     

       20
       20
       +
         async getOperationLog(

     

       21
       21
       +
           did: string,

     

       22
       22
       +
           includeNull = false,

     

       23
       23
       +
         ): Promise<t.Operation[]> {

     

       24
       24
       +
           let url = `${this.url}/${encodeURIComponent(did)}/log`

     

       25
       25
       +
           if (includeNull) {

     

       26
       26
       +
             url += '?includeNull=true'

     

       27
       27
       +
           }

     

       28
       28
       +
           const res = await axios.get(url)

     

       22
       29
        
           return res.data.log

     

       23
       30
        
         }

     

       24
       31
        
       

     
···

       27
       34
        
         }

     

       28
       35
        
       

     

       29
       36
        
         async getLastOp(did: string): Promise<t.Operation> {

     

       30
       30
       -
           const res = await axios.get(`${this.url}/last/${encodeURIComponent(did)}`)

     

       37
       37
       +
           const res = await axios.get(`${this.url}/${encodeURIComponent(did)}/last`)

     

       31
       38
        
           return res.data

     

       32
       39
        
         }

     

       33
       40

+41 -46

packages/server/src/db/index.ts

···

       1
       1
       -
       import { Generated, Kysely, Migrator, PostgresDialect, sql } from 'kysely'

     

       1
       1
       +
       import { Kysely, Migrator, PostgresDialect, Selectable, sql } from 'kysely'

     

       2
       2
        
       import { Pool as PgPool, types as pgTypes } from 'pg'

     

       3
       3
        
       import { CID } from 'multiformats/cid'

     

       4
       4
       -
       import { cidForCbor, check } from '@atproto/common'

     

       4
       4
       +
       import { cidForCbor } from '@atproto/common'

     

       5
       5
        
       import * as plc from '@did-plc/lib'

     

       6
       6
        
       import { ServerError } from '../error'

     

       7
       7
        
       import * as migrations from '../migrations'

     

       8
       8
       -
       import { OpLogExport, PlcDatabase } from './types'

     

       8
       8
       +
       import { DatabaseSchema, OperationsTable, PlcDatabase } from './types'

     

       9
       9
        
       import MockDatabase from './mock'

     

       10
       10
        
       

     

       11
       11
        
       export * from './mock'

     
···

       93
       93
        
         }

     

       94
       94
        
       

     

       95
       95
        
         async validateAndAddOp(did: string, proposed: plc.Operation): Promise<void> {

     

       96
       96
       -
           const ops = await this._opsForDid(did)

     

       96
       96
       +
           const ops = await this.indexedOpsForDid(did)

     

       97
       97
        
           // throws if invalid

     

       98
       98
        
           const { nullified, prev } = await plc.assureValidNextOp(did, ops, proposed)

     

       99
       99
        
           const cid = await cidForCbor(proposed)

     
···

       158
       158
        
           return found ? CID.parse(found.cid) : null

     

       159
       159
        
         }

     

       160
       160
        
       

     

       161
       161
       -
         async opsForDid(did: string): Promise<plc.OpOrTombstone[]> {

     

       162
       162
       -
           const ops = await this._opsForDid(did)

     

       163
       163
       -
           return ops.map((op) => {

     

       164
       164
       -
             if (check.is(op.operation, plc.def.createOpV1)) {

     

       165
       165
       -
               return plc.normalizeOp(op.operation)

     

       166
       166
       -
             }

     

       167
       167
       -
             return op.operation

     

       168
       168
       -
           })

     

       161
       161
       +
         async opsForDid(did: string): Promise<plc.CompatibleOpOrTombstone[]> {

     

       162
       162
       +
           const ops = await this.indexedOpsForDid(did)

     

       163
       163
       +
           return ops.map((op) => op.operation)

     

       169
       164
        
         }

     

       170
       165
        
       

     

       171
       171
       -
         async _opsForDid(did: string): Promise<plc.IndexedOperation[]> {

     

       172
       172
       -
           const res = await this.db

     

       166
       166
       +
         async indexedOpsForDid(

     

       167
       167
       +
           did: string,

     

       168
       168
       +
           includeNullified = false,

     

       169
       169
       +
         ): Promise<plc.IndexedOperation[]> {

     

       170
       170
       +
           let builder = this.db

     

       173
       171
        
             .selectFrom('operations')

     

       174
       172
        
             .selectAll()

     

       175
       173
        
             .where('did', '=', did)

     

       176
       176
       -
             .where('nullified', '=', false)

     

       177
       174
        
             .orderBy('createdAt', 'asc')

     

       178
       178
       -
             .execute()

     

       179
       179
       -
       

     

       175
       175
       +
           if (!includeNullified) {

     

       176
       176
       +
             builder = builder.where('nullified', '=', false)

     

       177
       177
       +
           }

     

       178
       178
       +
           const res = await builder.execute()

     

       180
       179
        
           return res.map((row) => ({

     

       181
       180
        
             did: row.did,

     

       182
       181
        
             operation: row.operation,

     
···

       186
       185
        
           }))

     

       187
       186
        
         }

     

       188
       187
        
       

     

       189
       189
       -
         async fullExport(): Promise<Record<string, OpLogExport>> {

     

       190
       190
       -
           return {}

     

       191
       191
       -
           //   const res = await this.db

     

       192
       192
       -
           //     .selectFrom('operations')

     

       193
       193
       -
           //     .selectAll()

     

       194
       194
       -
           //     .orderBy('did')

     

       195
       195
       -
           //     .orderBy('createdAt')

     

       196
       196
       -
           //     .execute()

     

       197
       197
       -
           //   return res.reduce((acc, cur) => {

     

       198
       198
       -
           //     acc[cur.did] ??= []

     

       199
       199
       -
           //     acc[cur.did].push({

     

       200
       200
       -
           //       op: cur.operation),

     

       201
       201
       -
           //       nullified: cur.nullified === 1,

     

       202
       202
       -
           //       createdAt: cur.createdAt,

     

       203
       203
       -
           //     })

     

       204
       204
       -
           //     return acc

     

       205
       205
       -
           //   }, {} as Record<string, OpLogExport>)

     

       188
       188
       +
         async lastOpForDid(did: string): Promise<plc.CompatibleOpOrTombstone | null> {

     

       189
       189
       +
           const res = await this.db

     

       190
       190
       +
             .selectFrom('operations')

     

       191
       191
       +
             .selectAll()

     

       192
       192
       +
             .where('did', '=', did)

     

       193
       193
       +
             .where('nullified', '=', false)

     

       194
       194
       +
             .orderBy('createdAt', 'desc')

     

       195
       195
       +
             .limit(1)

     

       196
       196
       +
             .executeTakeFirst()

     

       197
       197
       +
           return res?.operation ?? null

     

       198
       198
       +
         }

     

       199
       199
       +
       

     

       200
       200
       +
         async exportOps(

     

       201
       201
       +
           count: number,

     

       202
       202
       +
           after?: Date,

     

       203
       203
       +
         ): Promise<Selectable<OperationsTable>[]> {

     

       204
       204
       +
           let builder = this.db

     

       205
       205
       +
             .selectFrom('operations')

     

       206
       206
       +
             .selectAll()

     

       207
       207
       +
             .orderBy('createdAt', 'desc')

     

       208
       208
       +
             .limit(count)

     

       209
       209
       +
           if (after) {

     

       210
       210
       +
             builder = builder.where('createdAt', '>', after)

     

       211
       211
       +
           }

     

       212
       212
       +
           return builder.execute()

     

       206
       213
        
         }

     

       207
       214
        
       }

     

       208
       215
        
       

     

       209
       216
        
       export default Database

     

       210
       210
       -
       

     

       211
       211
       -
       interface OperationsTable {

     

       212
       212
       -
         did: string

     

       213
       213
       -
         operation: plc.CompatibleOpOrTombstone

     

       214
       214
       -
         cid: string

     

       215
       215
       -
         nullified: boolean

     

       216
       216
       -
         createdAt: Generated<Date>

     

       217
       217
       -
       }

     

       218
       218
       -
       

     

       219
       219
       -
       interface DatabaseSchema {

     

       220
       220
       -
         operations: OperationsTable

     

       221
       221
       -
       }

+26 -7

packages/server/src/db/mock.ts

···

       1
       1
        
       import { cidForCbor, check } from '@atproto/common'

     

       2
       2
        
       import * as plc from '@did-plc/lib'

     

       3
       3
       +
       import { Selectable } from 'kysely'

     

       3
       4
        
       import { ServerError } from '../error'

     

       4
       4
       -
       import { OpLogExport, PlcDatabase } from './types'

     

       5
       5
       +
       import { OperationsTable, PlcDatabase } from './types'

     

       5
       6
        
       

     

       6
       7
        
       type Contents = Record<string, plc.IndexedOperation[]>

     

       7
       8
        
       

     
···

       43
       44
        
           }

     

       44
       45
        
         }

     

       45
       46
        
       

     

       46
       46
       -
         async opsForDid(did: string): Promise<plc.OpOrTombstone[]> {

     

       47
       47
       -
           const ops = await this._opsForDid(did)

     

       47
       47
       +
         async opsForDid(did: string): Promise<plc.CompatibleOpOrTombstone[]> {

     

       48
       48
       +
           const ops = await this.indexedOpsForDid(did)

     

       48
       49
        
           return ops.map((op) => {

     

       49
       50
        
             if (check.is(op.operation, plc.def.createOpV1)) {

     

       50
       51
        
               return plc.normalizeOp(op.operation)

     
···

       53
       54
        
           })

     

       54
       55
        
         }

     

       55
       56
        
       

     

       56
       56
       -
         async _opsForDid(did: string): Promise<plc.IndexedOperation[]> {

     

       57
       57
       -
           return this.contents[did] ?? []

     

       57
       57
       +
         async indexedOpsForDid(

     

       58
       58
       +
           did: string,

     

       59
       59
       +
           includeNull = false,

     

       60
       60
       +
         ): Promise<plc.IndexedOperation[]> {

     

       61
       61
       +
           const ops = this.contents[did] ?? []

     

       62
       62
       +
           if (includeNull) {

     

       63
       63
       +
             return ops

     

       64
       64
       +
           }

     

       65
       65
       +
           return ops.filter((op) => op.nullified === false)

     

       58
       66
        
         }

     

       59
       67
        
       

     

       60
       60
       -
         async fullExport(): Promise<Record<string, OpLogExport>> {

     

       61
       61
       -
           return {}

     

       68
       68
       +
         async lastOpForDid(did: string): Promise<plc.CompatibleOpOrTombstone | null> {

     

       69
       69
       +
           const op = this.contents[did]?.at(-1)

     

       70
       70
       +
       

     

       71
       71
       +
           if (!op) return null

     

       72
       72
       +
           return op.operation

     

       73
       73
       +
         }

     

       74
       74
       +
       

     

       75
       75
       +
         // disabled in mocks

     

       76
       76
       +
         async exportOps(

     

       77
       77
       +
           _count: number,

     

       78
       78
       +
           _after?: Date,

     

       79
       79
       +
         ): Promise<Selectable<OperationsTable>[]> {

     

       80
       80
       +
           return []

     

       62
       81
        
         }

     

       63
       82
        
       }

     

       64
       83

+17 -8

packages/server/src/db/types.ts

···

       1
       1
        
       import * as plc from '@did-plc/lib'

     

       2
       2
       +
       import { Generated, Selectable } from 'kysely'

     

       2
       3
        
       

     

       3
       4
        
       export interface PlcDatabase {

     

       4
       5
        
         close(): Promise<void>

     

       5
       6
        
         healthCheck(): Promise<void>

     

       6
       7
        
         validateAndAddOp(did: string, proposed: plc.Operation): Promise<void>

     

       7
       7
       -
         opsForDid(did: string): Promise<plc.OpOrTombstone[]>

     

       8
       8
       -
         _opsForDid(did: string): Promise<plc.IndexedOperation[]>

     

       9
       9
       -
         fullExport(): Promise<Record<string, OpLogExport>>

     

       8
       8
       +
         opsForDid(did: string): Promise<plc.CompatibleOpOrTombstone[]>

     

       9
       9
       +
         indexedOpsForDid(

     

       10
       10
       +
           did: string,

     

       11
       11
       +
           includeNull?: boolean,

     

       12
       12
       +
         ): Promise<plc.IndexedOperation[]>

     

       13
       13
       +
         lastOpForDid(did: string): Promise<plc.CompatibleOpOrTombstone | null>

     

       14
       14
       +
         exportOps(count: number, after?: Date): Promise<Selectable<OperationsTable>[]>

     

       10
       15
        
       }

     

       11
       16
        
       

     

       12
       12
       -
       export type OpLogExport = OpExport[]

     

       13
       13
       -
       

     

       14
       14
       -
       export type OpExport = {

     

       15
       15
       -
         op: Record<string, unknown>

     

       17
       17
       +
       export interface OperationsTable {

     

       18
       18
       +
         did: string

     

       19
       19
       +
         operation: plc.CompatibleOpOrTombstone

     

       20
       20
       +
         cid: string

     

       16
       21
        
         nullified: boolean

     

       17
       17
       -
         createdAt: string

     

       22
       22
       +
         createdAt: Generated<Date>

     

       23
       23
       +
       }

     

       24
       24
       +
       

     

       25
       25
       +
       export interface DatabaseSchema {

     

       26
       26
       +
         operations: OperationsTable

     

       18
       27
        
       }

+19 -12

packages/server/src/routes.ts

···

       18
       18
        
           res.send({ version })

     

       19
       19
        
         })

     

       20
       20
        
       

     

       21
       21
       -
         // @TODO paginate & test this

     

       21
       21
       +
         // Export ops in the form of paginated json lines

     

       22
       22
        
         router.get('/export', async function (req, res) {

     

       23
       23
       -
           const fullExport = await ctx.db.fullExport()

     

       23
       23
       +
           const parsedCount = parseInt(req.query.count)

     

       24
       24
       +
           const count = isNaN(parsedCount) ? 1000 : Math.min(parsedCount, 1000)

     

       25
       25
       +
           const after = req.query.after ? new Date(req.query.after) : undefined

     

       26
       26
       +
           const ops = await ctx.db.exportOps(count, after)

     

       24
       27
        
           res.setHeader('content-type', 'application/jsonlines')

     

       25
       28
        
           res.status(200)

     

       26
       26
       -
           for (const [did, ops] of Object.entries(fullExport)) {

     

       27
       27
       -
             const line = JSON.stringify({ did, ops })

     

       29
       29
       +
           for (const op of ops) {

     

       30
       30
       +
             const line = JSON.stringify(op)

     

       28
       31
        
             res.write(line)

     

       29
       32
        
             res.write('\n')

     

       30
       33
        
           }

     
···

       48
       51
        
         })

     

       49
       52
        
       

     

       50
       53
        
         // Get data for a DID document

     

       51
       51
       -
         router.get('/data/:did', async function (req, res) {

     

       54
       54
       +
         router.get('/:did/data', async function (req, res) {

     

       52
       55
        
           const { did } = req.params

     

       53
       56
        
           const log = await ctx.db.opsForDid(did)

     

       54
       57
        
           if (log.length === 0) {

     
···

       62
       65
        
         })

     

       63
       66
        
       

     

       64
       67
        
         // Get operation log for a DID

     

       65
       65
       -
         router.get('/log/:did', async function (req, res) {

     

       68
       68
       +
         router.get('/:did/log', async function (req, res) {

     

       66
       69
        
           const { did } = req.params

     

       67
       67
       -
           const log = await ctx.db.opsForDid(did)

     

       70
       70
       +
           const includeNull = req.query.includeNull === 'true'

     

       71
       71
       +
       

     

       72
       72
       +
           const log = includeNull

     

       73
       73
       +
             ? await ctx.db.indexedOpsForDid(did, includeNull)

     

       74
       74
       +
             : await ctx.db.opsForDid(did)

     

       75
       75
       +
       

     

       68
       76
        
           if (log.length === 0) {

     

       69
       77
        
             throw new ServerError(404, `DID not registered: ${did}`)

     

       70
       78
        
           }

     
···

       72
       80
        
         })

     

       73
       81
        
       

     

       74
       82
        
         // Get the most recent operation in the log for a DID

     

       75
       75
       -
         router.get('/last/:did', async function (req, res) {

     

       83
       83
       +
         router.get('/:did/last', async function (req, res) {

     

       76
       84
        
           const { did } = req.params

     

       77
       77
       -
           const log = await ctx.db.opsForDid(did)

     

       78
       78
       -
           const curr = log.at(-1)

     

       79
       79
       -
           if (!curr) {

     

       85
       85
       +
           const last = await ctx.db.lastOpForDid(did)

     

       86
       86
       +
           if (!last) {

     

       80
       87
        
             throw new ServerError(404, `DID not registered: ${did}`)

     

       81
       88
        
           }

     

       82
       82
       -
           res.json(curr)

     

       89
       89
       +
           res.json(last)

     

       83
       90
        
         })

     

       84
       91
        
       

     

       85
       92
        
         // Update or create a DID doc