Refactored error messages based on review suggestions

inrupt · Oct 13, 2020 · 77e1054 · 77e1054
1 parent 44808e6
commit 77e1054
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 26 deletions.
diff --git a/packages/oidc-dpop-client-browser/src/dpop/dpop.spec.ts b/packages/oidc-dpop-client-browser/src/dpop/dpop.spec.ts
@@ -28,7 +28,7 @@ import {
   normalizeHttpUriClaim,
   signJwt,
 } from "./dpop";
-import { generateJwk, generateJwkForDpop } from "./keyGen";
+import { generateJwk, generateJwkForDpop } from "./keyGeneration";
 
 describe("signJwt/decodeJwt", () => {
   it("generates a JWT that can be decoded without signature verification", async () => {

diff --git a/packages/oidc-dpop-client-browser/src/dpop/tokenExchange.spec.ts b/packages/oidc-dpop-client-browser/src/dpop/tokenExchange.spec.ts
@@ -47,7 +47,7 @@ const mockJwk = (): JWKECKey => {
 // The two following modules introduce randomness in the process, which prevents
 // making assumptions on the returned values. Mocking them out makes keys and
 // DPoP headers predictible.
-jest.mock("./keyGen", () => {
+jest.mock("./keyGeneration", () => {
   return {
     generateJwkForDpop: (): JWKECKey => mockJwk(),
   };
@@ -223,7 +223,7 @@ describe("getTokens", () => {
       true
     );
     await expect(request).rejects.toThrow(
-      `Invalid token endpoint response: requested a [DPoP] token, got a token_type [Bearer].`
+      `Invalid token endpoint response: requested a [DPoP] token, but got a 'token_type' value of [Bearer].`
     );
   });
 
@@ -237,7 +237,7 @@ describe("getTokens", () => {
       false
     );
     await expect(request).rejects.toThrow(
-      `Invalid token endpoint response: requested a [Bearer] token, got a token_type [DPoP].`
+      `Invalid token endpoint response: requested a [Bearer] token, but got a 'token_type' value of [DPoP].`
     );
   });
 
@@ -255,9 +255,9 @@ describe("getTokens", () => {
       false
     );
     await expect(request).rejects.toThrow(
-      `Invalid token endpoint response: ${JSON.stringify(
+      `Invalid token endpoint response (missing the field 'token_type'): ${JSON.stringify(
         tokenResponse
-      )} is missing an token_type.`
+      )}`
     );
   });
 
@@ -327,9 +327,9 @@ describe("getTokens", () => {
     await expect(
       getTokens(mockIssuer(), mockClient(), mockEndpointInput(), true)
     ).rejects.toThrow(
-      `Invalid token endpoint response: ${JSON.stringify(
+      `Invalid token endpoint response (missing the field 'access_token'): ${JSON.stringify(
         tokenEndpointResponse
-      )} is missing an access_token.`
+      )}`
     );
   });
 
@@ -344,9 +344,9 @@ describe("getTokens", () => {
     await expect(
       getTokens(mockIssuer(), mockClient(), mockEndpointInput(), true)
     ).rejects.toThrow(
-      `Invalid token endpoint response: ${JSON.stringify(
+      `Invalid token endpoint response (missing the field 'id_token'): ${JSON.stringify(
         tokenEndpointResponse
-      )} is missing an id_token.`
+      )}`
     );
   });
 
@@ -415,7 +415,7 @@ describe("getTokens", () => {
     await expect(
       getTokens(mockIssuer(), mockClient(), mockEndpointInput(), false)
     ).rejects.toThrow(
-      `Cannot extract WebID from ID token: the ID token returned by ${mockIssuer().issuer.toString()} has no webid claim, nor an IRI-like sub claim: [some subject]`
+      `Cannot extract WebID from ID token: the ID token returned by [${mockIssuer().issuer.toString()}] has no 'webid' claim, nor an IRI-like 'sub' claim: [some subject]`
     );
   });
 

diff --git a/packages/oidc-dpop-client-browser/src/dpop/tokenExchange.ts b/packages/oidc-dpop-client-browser/src/dpop/tokenExchange.ts
@@ -67,7 +67,8 @@ export type TokenEndpointInput = {
 type WebIdOidcIdToken = {
   sub: string;
   iss: string;
-  webId?: string;
+  // The spec requires this capitalization of webid
+  webid?: string;
 };
 
 function isWebIdOidcIdToken(
@@ -78,8 +79,8 @@ function isWebIdOidcIdToken(
       typeof token.sub === "string" &&
       token.iss &&
       typeof token.iss === "string" &&
-      !token.webId) ||
-    typeof token.webId === "string"
+      !token.webid) ||
+    typeof token.webid === "string"
   );
 }
 
@@ -99,12 +100,12 @@ async function deriveWebIdFromIdToken(idToken: string): Promise<string> {
       )} is missing 'sub' or 'iss' claims`
     );
   }
-  if (decoded.webId) {
-    return decoded.webId;
+  if (decoded.webid) {
+    return decoded.webid;
   }
   if (!decoded.sub.match(/^https?:\/\/.+\..+$/)) {
     throw new Error(
-      `Cannot extract WebID from ID token: the ID token returned by ${decoded.iss} has no 'webid' claim, nor an IRI-like sub claim: [${decoded.sub}]`
+      `Cannot extract WebID from ID token: the ID token returned by [${decoded.iss}] has no 'webid' claim, nor an IRI-like 'sub' claim: [${decoded.sub}]`
     );
   }
   return decoded.sub;
@@ -138,37 +139,37 @@ function validateTokenEndpointResponse(
 ): Record<string, unknown> & { access_token: string; id_token: string } {
   if (!hasAccessToken(tokenResponse)) {
     throw new Error(
-      `Invalid token endpoint response: ${JSON.stringify(
+      `Invalid token endpoint response (missing the field 'access_token'): ${JSON.stringify(
         tokenResponse
-      )} is missing an access_token.`
+      )}`
     );
   }
 
   if (!hasIdToken(tokenResponse)) {
     throw new Error(
-      `Invalid token endpoint response: ${JSON.stringify(
+      `Invalid token endpoint response (missing the field 'id_token'): ${JSON.stringify(
         tokenResponse
-      )} is missing an id_token.`
+      )}.`
     );
   }
 
   if (!hasTokenType(tokenResponse)) {
     throw new Error(
-      `Invalid token endpoint response: ${JSON.stringify(
+      `Invalid token endpoint response (missing the field 'token_type'): ${JSON.stringify(
         tokenResponse
-      )} is missing an token_type.`
+      )}`
     );
   }
 
   if (dpop && tokenResponse.token_type.toLowerCase() !== "dpop") {
     throw new Error(
-      `Invalid token endpoint response: requested a [DPoP] token, got a token_type [${tokenResponse.token_type}].`
+      `Invalid token endpoint response: requested a [DPoP] token, but got a 'token_type' value of [${tokenResponse.token_type}].`
     );
   }
 
   if (!dpop && tokenResponse.token_type.toLowerCase() !== "bearer") {
     throw new Error(
-      `Invalid token endpoint response: requested a [Bearer] token, got a token_type [${tokenResponse.token_type}].`
+      `Invalid token endpoint response: requested a [Bearer] token, but got a 'token_type' value of [${tokenResponse.token_type}].`
     );
   }
   return tokenResponse;

diff --git a/packages/oidc-dpop-client-browser/src/index.ts b/packages/oidc-dpop-client-browser/src/index.ts
@@ -48,7 +48,7 @@ export {
   createDpopHeader,
   privateJwkToPublicJwk,
 } from "./dpop/dpop";
-export { generateJwkForDpop, generateJwkRsa } from "./dpop/keyGen";
+export { generateJwkForDpop, generateJwkRsa } from "./dpop/keyGeneration";
 export {
   getTokens,
   TokenEndpointInput,