refactor: #20 do not allow to create UserManager or OidcClient withou…

…t settings
authts · Aug 18, 2021 · e369d13 · e369d13
1 parent 89101e7
commit e369d13
Show file tree

Hide file tree

Showing 13 changed files with 107 additions and 52 deletions.
diff --git a/src/MetadataService.ts b/src/MetadataService.ts
@@ -18,11 +18,6 @@ export class MetadataService {
     private _metadata: Partial<OidcMetadata> | null;
 
     constructor(settings: OidcClientSettingsStore) {
-        if (!settings) {
-            Log.error("MetadataService: No settings passed to MetadataService");
-            throw new Error("settings");
-        }
-
         this._settings = settings;
         this._jsonService = new JsonService(["application/jwk-set+json"]);
 

diff --git a/src/OidcClient.ts b/src/OidcClient.ts
@@ -19,7 +19,7 @@ export class OidcClient {
     public readonly metadataService: MetadataService;
     private readonly _validator: ResponseValidator;
 
-    constructor(settings: OidcClientSettings = {}) {
+    constructor(settings: OidcClientSettings) {
         this.settings = new OidcClientSettingsStore(settings);
 
         this.metadataService = new MetadataService(this.settings);

diff --git a/src/OidcClientSettings.ts b/src/OidcClientSettings.ts
@@ -14,7 +14,7 @@ const DefaultClockSkewInSeconds = 60 * 5;
 
 export interface OidcClientSettings {
     /** The URL of the OIDC/OAuth2 provider */
-    authority?: string;
+    authority: string;
     metadataUrl?: string;
     /** Provide metadata when authority server does not allow CORS on the metadata endpoint */
     metadata?: Partial<OidcMetadata>;
@@ -24,7 +24,7 @@ export interface OidcClientSettings {
     signingKeys?: any[];
 
     /** Your client application's identifier as registered with the OIDC/OAuth2 */
-    client_id?: string;
+    client_id: string;
     client_secret?: string;
     /** The type of response desired from the OIDC/OAuth2 provider (default: 'id_token') */
     response_type?: string;
@@ -106,9 +106,9 @@ export class OidcClientSettingsStore {
 
     constructor({
         // metadata related
-        authority = "", metadataUrl, metadata, signingKeys, metadataSeed,
+        authority, metadataUrl, metadata, signingKeys, metadataSeed,
         // client related
-        client_id = "", client_secret, response_type = DefaultResponseType, scope = DefaultScope,
+        client_id, client_secret, response_type = DefaultResponseType, scope = DefaultScope,
         redirect_uri, post_logout_redirect_uri,
         client_authentication = DefaultClientAuthentication,
         // optional protocol
@@ -125,7 +125,7 @@ export class OidcClientSettingsStore {
         // extra query params
         extraQueryParams = {},
         extraTokenParams = {}
-    }: OidcClientSettings = {}) {
+    }: OidcClientSettings) {
 
         this.authority = authority;
         this.metadataUrl = metadataUrl;

diff --git a/src/ResponseValidator.ts b/src/ResponseValidator.ts
@@ -21,11 +21,6 @@ export class ResponseValidator {
     private readonly _tokenClient: TokenClient;
 
     constructor(settings: OidcClientSettingsStore, metadataService: MetadataService) {
-        if (!settings) {
-            Log.error("ResponseValidator.ctor: No settings passed to ResponseValidator");
-            throw new Error("settings");
-        }
-
         this._settings = settings;
         this._metadataService = metadataService;
         this._userInfoService = new UserInfoService(this._settings, metadataService);

diff --git a/src/TokenClient.ts b/src/TokenClient.ts
@@ -12,11 +12,6 @@ export class TokenClient {
     private readonly _metadataService: MetadataService;
 
     constructor(settings: OidcClientSettingsStore, metadataService: MetadataService) {
-        if (!settings) {
-            Log.error("TokenClient.ctor: No settings passed");
-            throw new Error("settings");
-        }
-
         this._settings = settings;
         this._jsonService = new JsonService();
         this._metadataService = metadataService;

diff --git a/src/TokenRevocationClient.ts b/src/TokenRevocationClient.ts
@@ -13,11 +13,6 @@ export class TokenRevocationClient {
     private _metadataService: MetadataService;
 
     constructor(settings: OidcClientSettingsStore, metadataService: MetadataService) {
-        if (!settings) {
-            Log.error("TokenRevocationClient.ctor: No settings provided");
-            throw new Error("No settings provided.");
-        }
-
         this._settings = settings;
         this._metadataService = metadataService;
     }

diff --git a/src/UserInfoService.ts b/src/UserInfoService.ts
@@ -12,11 +12,6 @@ export class UserInfoService {
     private _metadataService: MetadataService;
 
     constructor(settings: OidcClientSettingsStore, metadataService: MetadataService) {
-        if (!settings) {
-            Log.error("UserInfoService.ctor: No settings passed");
-            throw new Error("settings");
-        }
-
         this._settings = settings;
         this._jsonService = new JsonService(undefined, this._getClaimsFromJwt.bind(this));
         this._metadataService = metadataService;

diff --git a/src/UserManager.ts b/src/UserManager.ts
@@ -26,7 +26,7 @@ export class UserManager extends OidcClient {
     private readonly _tokenRevocationClient: TokenRevocationClient;
     private readonly _tokenClient: TokenClient;
 
-    constructor(settings: UserManagerSettings = {}) {
+    constructor(settings: UserManagerSettings) {
         super(settings);
         this.settings = new UserManagerSettingsStore(settings);
 

diff --git a/src/UserManagerSettings.ts b/src/UserManagerSettings.ts
@@ -72,7 +72,7 @@ export class UserManagerSettingsStore extends OidcClientSettingsStore {
 
     public readonly userStore: WebStorageStateStore;
 
-    constructor(args: UserManagerSettings = {}) {
+    constructor(args: UserManagerSettings) {
         const {
             popup_redirect_uri,
             popup_post_logout_redirect_uri,

diff --git a/test/unit/OidcClient.test.ts b/test/unit/OidcClient.test.ts
@@ -31,12 +31,6 @@ describe("OidcClient", () => {
     });
 
     describe("constructor", () => {
-
-        it("should allow no settings", () => {
-            // act
-            new OidcClient();
-        });
-
         it("should expose settings", () => {
             // assert
             expect(subject.settings).not.toBeNull();
@@ -46,7 +40,8 @@ describe("OidcClient", () => {
         it("should accept OidcClientSettings", () => {
             // arrange
             const settings = {
-                client_id: "client"
+                authority: "authority",
+                client_id: "client",
             };
 
             // act