commit 9ffb23a56032301cb6e7449b279eef2a1973f16b · edouard.paris/did-method-plc

+19 -12

packages/lib/src/client.ts

···

       17
       17
        
           return res.data

     

       18
       18
        
         }

     

       19
       19
        
       

     

       20
       20
       -
         async getOperationLog(

     

       21
       21
       -
           did: string,

     

       22
       22
       -
           includeNull = false,

     

       23
       23
       -
         ): Promise<t.CompatibleOpOrTombstone[]> {

     

       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)

     

       29
       29
       -
           return res.data.log

     

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

     

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

     

       22
       22
       +
           return res.data

     

       23
       23
       +
         }

     

       24
       24
       +
       

     

       25
       25
       +
         async getAuditableLog(did: string): Promise<t.ExportedOp[]> {

     

       26
       26
       +
           const res = await axios.get(

     

       27
       27
       +
             `${this.url}/${encodeURIComponent(did)}/auditable`,

     

       28
       28
       +
           )

     

       29
       29
       +
           return res.data

     

       30
       30
        
         }

     

       31
       31
        
       

     

       32
       32
        
         postOpUrl(did: string): string {

     
···

       83
       83
        
           await axios.post(this.postOpUrl(did), op)

     

       84
       84
        
         }

     

       85
       85
        
       

     

       86
       86
       -
         async export(): Promise<t.ExportedOp[]> {

     

       87
       87
       -
           const res = await axios.get(`${this.url}/export`)

     

       86
       86
       +
         async export(after?: string, count?: number): Promise<t.ExportedOp[]> {

     

       87
       87
       +
           const url = new URL(`${this.url}/export`)

     

       88
       88
       +
           if (after) {

     

       89
       89
       +
             url.searchParams.append('after', after)

     

       90
       90
       +
           }

     

       91
       91
       +
           if (count !== undefined) {

     

       92
       92
       +
             url.searchParams.append('count', count.toString(10))

     

       93
       93
       +
           }

     

       94
       94
       +
           const res = await axios.get(url.toString())

     

       88
       95
        
           const lines = res.data.split('\n')

     

       89
       96
        
           return lines.map((l) => JSON.parse(l))

     

       90
       97
        
         }

+10 -7

packages/lib/src/types.ts

···

       68
       68
        
       })

     

       69
       69
        
       export type IndexedOperation = z.infer<typeof indexedOperation>

     

       70
       70
        
       

     

       71
       71
       -
       export type ExportedOp = {

     

       72
       72
       -
         did: string

     

       73
       73
       -
         operation: CompatibleOpOrTombstone

     

       74
       74
       -
         cid: string

     

       75
       75
       -
         nullified: boolean

     

       76
       76
       -
         createdAt: Date

     

       77
       77
       -
       }

     

       71
       71
       +
       export const exportedOp = z.object({

     

       72
       72
       +
         did: z.string(),

     

       73
       73
       +
         operation: compatibleOpOrTombstone,

     

       74
       74
       +
         cid: z.string(),

     

       75
       75
       +
         nullified: z.boolean(),

     

       76
       76
       +
         createdAt: z.string(),

     

       77
       77
       +
       })

     

       78
       78
       +
       export type ExportedOp = z.infer<typeof exportedOp>

     

       78
       79
        
       

     

       79
       80
        
       export const didDocVerificationMethod = z.object({

     

       80
       81
        
         id: z.string(),

     
···

       110
       111
        
         opOrTombstone,

     

       111
       112
        
         compatibleOp,

     

       112
       113
        
         compatibleOpOrTombstone,

     

       114
       114
       +
         indexedOperation,

     

       115
       115
       +
         exportedOp,

     

       113
       116
        
         didDocument,

     

       114
       117
        
       }

+1 -1

packages/lib/tests/compatibility.test.ts

···

       78
       78
        
       

     

       79
       79
        
           const result = await assureValidNextOp(did, [indexedLegacy], nextOp)

     

       80
       80
        
           expect(result.nullified.length).toBe(0)

     

       81
       81
       -
           expect(result.prev?.equals(legacyCid))

     

       81
       81
       +
           expect(result.prev?.equals(legacyCid)).toBeTruthy()

     

       82
       82
        
         })

     

       83
       83
        
       })

+3 -3

packages/lib/tests/recovery.test.ts

···

       106
       106
        
           expect(res.nullified.length).toBe(2)

     

       107
       107
        
           expect(res.nullified[0].equals(log[1].cid))

     

       108
       108
        
           expect(res.nullified[1].equals(log[2].cid))

     

       109
       109
       -
           expect(res.prev?.equals(createCid))

     

       109
       109
       +
           expect(res.prev?.equals(createCid)).toBeTruthy()

     

       110
       110
        
       

     

       111
       111
        
           log = [log[0], rotate.indexed]

     

       112
       112
        
         })

     
···

       124
       124
        
           const res = await data.assureValidNextOp(did, log, rotate.op)

     

       125
       125
        
           expect(res.nullified.length).toBe(1)

     

       126
       126
        
           expect(res.nullified[0].equals(log[1].cid))

     

       127
       127
       -
           expect(res.prev?.equals(createCid))

     

       127
       127
       +
           expect(res.prev?.equals(createCid)).toBeTruthy()

     

       128
       128
        
       

     

       129
       129
        
           log = [log[0], rotate.indexed]

     

       130
       130
        
         })

     
···

       185
       185
        
           )

     

       186
       186
        
           expect(result.nullified.length).toBe(1)

     

       187
       187
        
           expect(result.nullified[0].equals(cid))

     

       188
       188
       -
           expect(result.prev?.equals(createCid))

     

       188
       188
       +
           expect(result.prev?.equals(createCid)).toBeTruthy()

     

       189
       189
        
         })

     

       190
       190
        
       })

+6 -2

packages/server/src/db/index.ts

···

       201
       201
        
           let builder = this.db

     

       202
       202
        
             .selectFrom('operations')

     

       203
       203
        
             .selectAll()

     

       204
       204
       -
             .orderBy('createdAt', 'desc')

     

       204
       204
       +
             .orderBy('createdAt', 'asc')

     

       205
       205
        
             .limit(count)

     

       206
       206
        
           if (after) {

     

       207
       207
        
             builder = builder.where('createdAt', '>', after)

     

       208
       208
        
           }

     

       209
       209
       -
           return builder.execute()

     

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

     

       210
       210
       +
           return res.map((row) => ({

     

       211
       211
       +
             ...row,

     

       212
       212
       +
             createdAt: row.createdAt.toISOString(),

     

       213
       213
       +
           }))

     

       210
       214
        
         }

     

       211
       215
        
       }

     

       212
       216

+18 -7

packages/server/src/routes.ts

···

       69
       69
        
         // Get operation log for a DID

     

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

     

       71
       71
        
           const { did } = req.params

     

       72
       72
       -
           const includeNull = req.query.includeNull === 'true'

     

       72
       72
       +
           const log = await ctx.db.opsForDid(did)

     

       73
       73
       +
           if (log.length === 0) {

     

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

     

       75
       75
       +
           }

     

       76
       76
       +
           res.json(log)

     

       77
       77
       +
         })

     

       73
       78
        
       

     

       74
       74
       -
           const log = includeNull

     

       75
       75
       -
             ? await ctx.db.indexedOpsForDid(did, includeNull)

     

       76
       76
       -
             : await ctx.db.opsForDid(did)

     

       77
       77
       -
       

     

       78
       78
       -
           if (log.length === 0) {

     

       79
       79
       +
         // Get operation log for a DID

     

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

     

       81
       81
       +
           const { did } = req.params

     

       82
       82
       +
           const ops = await ctx.db.indexedOpsForDid(did, true)

     

       83
       83
       +
           if (ops.length === 0) {

     

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

     

       80
       85
        
           }

     

       81
       81
       -
           res.json({ log })

     

       86
       86
       +
           const log = ops.map((op) => ({

     

       87
       87
       +
             ...op,

     

       88
       88
       +
             cid: op.cid.toString(),

     

       89
       89
       +
             createdAt: op.createdAt.toISOString(),

     

       90
       90
       +
           }))

     

       91
       91
       +
       

     

       92
       92
       +
           res.json(log)

     

       82
       93
        
         })

     

       83
       94
        
       

     

       84
       95
        
         // Get the most recent operation in the log for a DID

+19 -2

packages/server/tests/server.test.ts

···

       159
       159
        
           expect(doc.services).toEqual({ atpPds })

     

       160
       160
        
         })

     

       161
       161
        
       

     

       162
       162
       +
         it('retrieves the auditable operation log', async () => {

     

       163
       163
       +
           const log = await client.getOperationLog(did)

     

       164
       164
       +
           const auditable = await client.getAuditableLog(did)

     

       165
       165
       +
           // has one nullifed op

     

       166
       166
       +
           expect(auditable.length).toBe(log.length + 1)

     

       167
       167
       +
           expect(auditable.filter((op) => op.nullified).length).toBe(1)

     

       168
       168
       +
           expect(auditable.at(-2)?.nullified).toBe(true)

     

       169
       169
       +
           expect(

     

       170
       170
       +
             auditable.every((op) => check.is(op, plc.def.exportedOp)),

     

       171
       171
       +
           ).toBeTruthy()

     

       172
       172
       +
         })

     

       173
       173
       +
       

     

       162
       174
        
         it('retrieves the did doc', async () => {

     

       163
       175
        
           const data = await client.getDocumentData(did)

     

       164
       176
        
           const doc = await client.getDocument(did)

     
···

       166
       178
        
         })

     

       167
       179
        
       

     

       168
       180
        
         it('handles concurrent requests to many docs', async () => {

     

       169
       169
       -
           const COUNT = 100

     

       181
       181
       +
           const COUNT = 50

     

       170
       182
        
           const keys: EcdsaKeypair[] = []

     

       171
       183
        
           for (let i = 0; i < COUNT; i++) {

     

       172
       184
        
             keys.push(await EcdsaKeypair.create())

     
···

       220
       232
        
         })

     

       221
       233
        
       

     

       222
       234
        
         it('exports the data set', async () => {

     

       223
       223
       -
           await client.export()

     

       235
       235
       +
           const data = await client.export()

     

       236
       236
       +
           expect(data.every((row) => check.is(row, plc.def.exportedOp))).toBeTruthy()

     

       237
       237
       +
           expect(data.length).toBe(58)

     

       238
       238
       +
           for (let i = 1; i < data.length; i++) {

     

       239
       239
       +
             expect(data[i].createdAt >= data[i - 1].createdAt).toBeTruthy()

     

       240
       240
       +
           }

     

       224
       241
        
         })

     

       225
       242
        
       

     

       226
       243
        
         it('healthcheck succeeds when database is available.', async () => {