Boosted http-client code coverage to 100% + minor updates (#234)

* Boosted http-client to have 100% code coverage + minor updates

* Fixed lint errors

* Addressed PR comments

packages/http-client/.c8rc.json

@@ -14,6 +14,7 @@
   ],
   "reporter": [
     "cobertura",
+    "html",
     "text"
   ]
 }

packages/http-client/src/client.ts

@@ -148,7 +148,7 @@ export class TbdexHttpClient {
       throw new RequestError({ message: `Failed to get offerings from ${pfiDid}`, recipientDid: pfiDid, url: apiRoute, cause: e })
     }
 
-    const data: Offering[] = []
+    const offerings: Offering[] = []
 
     if (!response.ok) {
       const errorDetails = await response.json() as ErrorDetail[]
@@ -159,10 +159,10 @@ export class TbdexHttpClient {
     const jsonOfferings = responseBody.data as any[]
     for (let jsonOffering of jsonOfferings) {
       const offering = await Offering.parse(jsonOffering)
-      data.push(offering)
+      offerings.push(offering)
     }
 
-    return data
+    return offerings
   }
 
   /**
@@ -221,7 +221,7 @@ export class TbdexHttpClient {
       throw new RequestError({ message: `Failed to get exchange from ${pfiDid}`, recipientDid: pfiDid, url: apiRoute, cause: e })
     }
 
-    const data: Message[] = []
+    const messages: Message[] = []
 
     if (!response.ok) {
       const errorDetails = await response.json() as ErrorDetail[]
@@ -231,17 +231,17 @@ export class TbdexHttpClient {
     const responseBody = await response.json() as { data: MessageModel[] }
     for (let jsonMessage of responseBody.data) {
       const message = await Parser.parseMessage(jsonMessage)
-      data.push(message)
+      messages.push(message)
     }
 
-    return data
+    return messages
 
   }
 
   // TODO: Wrap Message[] in Exchange object and verify each message
   /**
    * returns all exchanges created by requester
-   * @param _opts - options
+   * @param opts - options
    */
   static async getExchanges(opts: GetExchangesOptions): Promise<Message[][]> {
     const { pfiDid, filter, did } = opts
@@ -427,8 +427,11 @@ export type GetExchangeOptions = {
 export type GetExchangesOptions = {
   /** the DID of the PFI from whom you want to get offerings */
   pfiDid: string
+  /** the message author's DID */
   did: BearerDid,
+  /** the filter to select the desired exchanges */
   filter?: {
+    /** ID or IDs of exchanges to get */
     id: string | string[]
   }
 }

packages/http-client/src/errors/request-error.ts

@@ -25,7 +25,5 @@ export class RequestError extends Error {
     this.name = this.constructor.name
     this.recipientDid = params.recipientDid
     this.url = params.url
-
-    Object.setPrototypeOf(this, RequestError.prototype)
   }
 }

packages/http-client/src/errors/request-token-error.ts

@@ -18,67 +18,35 @@ export class RequestTokenError extends Error {
     super(params.message, { cause: params.cause })
 
     this.name = this.constructor.name
-
-    Object.setPrototypeOf(this, RequestTokenError.prototype)
   }
 }
 
 /**
    * Error thrown when a request token cannot be signed
    * @beta
    */
-export class RequestTokenSigningError extends RequestTokenError {
-  constructor(params: RequestTokenErrorParams) {
-    super(params)
-
-    Object.setPrototypeOf(this, RequestTokenSigningError.prototype)
-  }
-}
+export class RequestTokenSigningError extends RequestTokenError { }
 
 /**
    * Error thrown when a request token cannot be verified
    * @beta
    */
-export class RequestTokenVerificationError extends RequestTokenError {
-  constructor(params: RequestTokenErrorParams) {
-    super(params)
-
-    Object.setPrototypeOf(this, RequestTokenVerificationError.prototype)
-  }
-}
+export class RequestTokenVerificationError extends RequestTokenError { }
 
 /**
    * Error thrown when a request token is missing required claims
    * @beta
    */
-export class RequestTokenMissingClaimsError extends RequestTokenError {
-  constructor(params: RequestTokenErrorParams) {
-    super(params)
-
-    Object.setPrototypeOf(this, RequestTokenMissingClaimsError.prototype)
-  }
-}
+export class RequestTokenMissingClaimsError extends RequestTokenError { }
 
 /**
    * Error thrown when a request token aud does not match the PFI did for which its intended
    * @beta
    */
-export class RequestTokenAudienceMismatchError extends RequestTokenError {
-  constructor(params: RequestTokenErrorParams) {
-    super(params)
-
-    Object.setPrototypeOf(this, RequestTokenAudienceMismatchError.prototype)
-  }
-}
+export class RequestTokenAudienceMismatchError extends RequestTokenError { }
 
 /**
    * Error thrown when a request token payload iss does not match request token header kid
    * @beta
    */
-export class RequestTokenIssuerSignerMismatchError extends RequestTokenError {
-  constructor(params: RequestTokenErrorParams) {
-    super(params)
-
-    Object.setPrototypeOf(this, RequestTokenIssuerSignerMismatchError.prototype)
-  }
-}
+export class RequestTokenIssuerSignerMismatchError extends RequestTokenError { }

packages/http-client/src/errors/response-error.ts

@@ -37,7 +37,5 @@ export class ResponseError extends Error {
     this.details = params.details
     this.recipientDid = params.recipientDid
     this.url = params.url
-
-    Object.setPrototypeOf(this, ResponseError.prototype)
   }
 }

packages/http-client/src/errors/validation-error.ts

@@ -11,31 +11,17 @@ export class ValidationError extends Error {
     super(message)
 
     this.name = this.constructor.name
-
-    Object.setPrototypeOf(this, ValidationError.prototype)
   }
 }
 
 /**
  * Error thrown when a DID is invalid
  * @beta
  */
-export class InvalidDidError extends ValidationError {
-  constructor(message: string) {
-    super(message)
-
-    Object.setPrototypeOf(this, InvalidDidError.prototype)
-  }
-}
+export class InvalidDidError extends ValidationError { }
 
 /**
  * Error thrown when a PFI's service endpoint can't be found
  * @beta
  */
-export class MissingServiceEndpointError extends ValidationError {
-  constructor(message: string) {
-    super(message)
-
-    Object.setPrototypeOf(this, MissingServiceEndpointError.prototype)
-  }
-}
+export class MissingServiceEndpointError extends ValidationError { }

packages/http-client/tests/client.spec.ts

@@ -326,13 +326,17 @@ describe('client', () => {
     })
 
     it('returns offerings array if response is ok', async () => {
+      const pfiDid = await DidJwk.create()
+      const stubbedOffering = DevTools.createOffering({ from: pfiDid.uri })
+      await stubbedOffering.sign(pfiDid)
+      const stubbedOfferings = [stubbedOffering.toJSON()]
       fetchStub.resolves({
         ok   : true,
-        json : () => Promise.resolve({ data: [] })
+        json : () => Promise.resolve({ data: stubbedOfferings })
       } as Response)
 
       const offerings = await TbdexHttpClient.getOfferings({ pfiDid: pfiDid.uri })
-      expect(offerings).to.have.length(0)
+      expect(offerings).to.have.length(1)
     })
   })
 
@@ -426,13 +430,17 @@ describe('client', () => {
     })
 
     it('returns exchange array if response is ok', async () => {
+      const alice = await DidJwk.create()
+      const stubbedRfq = await DevTools.createRfq({ sender: alice })
+      await stubbedRfq.sign(alice)
+      const messages = [stubbedRfq.toJSON()]
       fetchStub.resolves({
         ok   : true,
-        json : () => Promise.resolve({ data: [] })
+        json : () => Promise.resolve({ data: messages })
       } as Response)
 
       const exchanges = await TbdexHttpClient.getExchange({ pfiDid: pfiDid.uri, exchangeId: '123', did: pfiDid })
-      expect(exchanges).to.have.length(0)
+      expect(exchanges).to.have.length(1)
     })
   })
 
@@ -475,14 +483,29 @@ describe('client', () => {
       }
     })
 
-    it('returns empty exchanges array if response is ok and body is empty array', async () => {
+
+    it('returns array of message exchanges given a list of exchange IDs', async () => {
+      const alice = await DidJwk.create()
+      const aliceRfq1 = await DevTools.createRfq({ sender: alice })
+      await aliceRfq1.sign(alice)
+
+      const aliceRfq2 = await DevTools.createRfq({ sender: alice })
+      await aliceRfq2.sign(alice)
+
       fetchStub.resolves({
         ok   : true,
-        json : () => Promise.resolve({ data: [] })
+        json : () => Promise.resolve({ data: [
+          [aliceRfq1.toJSON()],
+          [aliceRfq2.toJSON()]
+        ] })
       } as Response)
 
-      const exchanges = await TbdexHttpClient.getExchanges({ pfiDid: pfiDid.uri, did: pfiDid })
-      expect(exchanges).to.have.length(0)
+      const exchanges = await TbdexHttpClient.getExchanges({
+        pfiDid : pfiDid.uri,
+        did    : alice,
+        filter : { id: [aliceRfq1.metadata.id, aliceRfq2.metadata.id]}
+      })
+      expect(exchanges).to.have.length(2)
     })
   })
 
@@ -571,7 +594,7 @@ describe('client', () => {
         aud : pfiBearerDid.uri,
         iss : aliceBearerDid.uri,
         exp : Math.floor(Date.now() / 1000 + 60),
-        jti : 'randomnonce'
+        jti : 'random-nonce'
       }
     })
 

packages/http-client/tests/error.spec.ts

@@ -0,0 +1,16 @@
+import { expect } from 'chai'
+import {
+  RequestTokenMissingClaimsError,
+  RequestTokenSigningError,
+  RequestTokenError
+} from '../src/main.js'
+
+describe('Custom error class', () => {
+  it('has expected inheritance prototype chain', async () => {
+    const error = new RequestTokenSigningError({ message: 'any message' })
+    expect(error).to.be.instanceOf(Error)
+    expect(error).to.be.instanceOf(RequestTokenError)
+    expect(error).to.be.instanceOf(RequestTokenSigningError)
+    expect(error).to.not.be.instanceOf(RequestTokenMissingClaimsError)
+  })
+})

packages/http-server/.c8rc.json

@@ -14,6 +14,7 @@
   ],
   "reporter": [
     "cobertura",
+    "html",
     "text"
   ]
 }

packages/http-server/src/callback-error.ts

@@ -22,7 +22,5 @@ export class CallbackError extends Error {
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, this.constructor)
     }
-
-    Object.setPrototypeOf(this, CallbackError.prototype)
   }
 }

packages/protocol/.c8rc.json

@@ -13,6 +13,7 @@
   ],
   "reporter": [
     "cobertura",
+    "html",
     "text"
   ]
 }