Skip to content

Commit 1f775ea

Browse files
brockallenbrockallen
committed
consolidate ctor params into settings objects
1 parent 1a9b95e commit 1f775ea

11 files changed

Lines changed: 238 additions & 78 deletions

‎dist/oidc-client.js‎

Lines changed: 7 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Global.js‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,37 @@ const timer = {
1010
}
1111
};
1212

13+
let testing = false;
14+
1315
export default class Global {
16+
17+
static _testing() {
18+
testing = true;
19+
}
20+
1421
static get location() {
15-
return location;
22+
if (!testing) {
23+
return location;
24+
}
1625
}
1726
static get localStorage() {
18-
return localStorage;
27+
if (!testing) {
28+
return localStorage;
29+
}
1930
}
2031
static get sessionStorage() {
21-
return sessionStorage;
32+
if (!testing) {
33+
return sessionStorage;
34+
}
2235
}
2336
static get XMLHttpRequest() {
24-
return XMLHttpRequest;
37+
if (!testing) {
38+
return XMLHttpRequest;
39+
}
2540
}
2641
static get timer() {
27-
return timer;
42+
if (!testing) {
43+
return timer;
44+
}
2845
}
2946
};

‎src/MetadataService.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// Copyright (c) Brock Allen & Dominick Baier. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
33

4-
import JsonService from './JsonService';
54
import Log from './Log';
5+
import JsonService from './JsonService';
66

77
export default class MetadataService {
88
constructor(settings, JsonServiceCtor = JsonService) {

‎src/OidcClient.js‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,36 @@
33

44
import Log from './Log';
55
import OidcClientSettings from './OidcClientSettings';
6-
import MetadataService from './MetadataService';
76
import ErrorResponse from './ErrorResponse';
87
import SigninRequest from './SigninRequest';
98
import SigninResponse from './SigninResponse';
109
import SignoutRequest from './SignoutRequest';
1110
import SignoutResponse from './SignoutResponse';
12-
import WebStorageStateStore from './WebStorageStateStore';
13-
import ResponseValidator from './ResponseValidator';
1411
import State from './State';
1512

1613
export default class OidcClient {
17-
constructor(settings, {
18-
stateStore = new WebStorageStateStore(),
19-
ResponseValidatorCtor = ResponseValidator,
20-
MetadataServiceCtor = MetadataService
21-
} = {}) {
14+
constructor(settings = {}) {
2215
if (settings instanceof OidcClientSettings) {
2316
this._settings = settings;
2417
}
2518
else {
2619
this._settings = new OidcClientSettings(settings);
2720
}
28-
this._stateStore = stateStore;
29-
this._validator = new ResponseValidatorCtor(this._settings);
30-
this._metadataService = new MetadataServiceCtor(this._settings);
21+
}
22+
23+
get _stateStore() {
24+
return this.settings.stateStore;
25+
}
26+
get _validator() {
27+
return this.settings.validator;
28+
}
29+
get _metadataService() {
30+
return this.settings.metadataService;
3131
}
3232

3333
get settings() {
3434
return this._settings;
3535
}
36-
3736
get metadataService() {
3837
return this._metadataService;
3938
}
@@ -83,14 +82,14 @@ export default class OidcClient {
8382
Log.info("OidcClient.processSigninResponse");
8483

8584
var response = new SigninResponse(url);
86-
85+
8786
if (!response.state) {
8887
Log.error("No state in response");
8988
return Promise.reject(new Error("No state in response"));
9089
}
9190

9291
stateStore = stateStore || this._stateStore;
93-
92+
9493
return stateStore.remove(response.state).then(storedStateString => {
9594
if (!storedStateString) {
9695
Log.error("No matching state found in storage");
@@ -124,7 +123,7 @@ export default class OidcClient {
124123
var state = request.state;
125124
if (state) {
126125
Log.info("Signout request has state to persist");
127-
126+
128127
stateStore = stateStore || this._stateStore;
129128
stateStore.set(state.id, state.toStorageString());
130129
}
@@ -139,12 +138,12 @@ export default class OidcClient {
139138
var response = new SignoutResponse(url);
140139
if (!response.state) {
141140
Log.info("No state in response");
142-
141+
143142
if (response.error) {
144143
Log.warn("Response was error", response.error);
145144
return Promise.reject(new ErrorResponse(response));
146145
}
147-
146+
148147
return Promise.resolve(response);
149148
}
150149

‎src/OidcClientSettings.js‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
33

44
import Log from './Log';
5+
import WebStorageStateStore from './WebStorageStateStore';
6+
import ResponseValidator from './ResponseValidator';
7+
import MetadataService from './MetadataService';
58

69
const OidcMetadataUrlPath = '.well-known/openid-configuration';
710

@@ -21,7 +24,11 @@ export default class OidcClientSettings {
2124
prompt, display, max_age, ui_locales, acr_values,
2225
// behavior flags
2326
filterProtocolClaims = true, loadUserInfo = true,
24-
staleStateAge = DefaultStaleStateAge, clockSkew = DefaultClockSkewInSeconds
27+
staleStateAge = DefaultStaleStateAge, clockSkew = DefaultClockSkewInSeconds,
28+
// other behavior
29+
stateStore = new WebStorageStateStore(),
30+
ResponseValidatorCtor = ResponseValidator,
31+
MetadataServiceCtor = MetadataService
2532
} = {}) {
2633

2734
this._authority = authority;
@@ -45,6 +52,10 @@ export default class OidcClientSettings {
4552
this._loadUserInfo = !!loadUserInfo;
4653
this._staleStateAge = staleStateAge;
4754
this._clockSkew = clockSkew;
55+
56+
this._stateStore = stateStore;
57+
this._validator = new ResponseValidatorCtor(this);
58+
this._metadataService = new MetadataServiceCtor(this);
4859
}
4960

5061
// client config
@@ -130,4 +141,14 @@ export default class OidcClientSettings {
130141
get clockSkew() {
131142
return this._clockSkew;
132143
}
144+
145+
get stateStore() {
146+
return this._stateStore;
147+
}
148+
get validator() {
149+
return this._validator;
150+
}
151+
get metadataService() {
152+
return this._metadataService;
153+
}
133154
}

‎src/UserManager.js‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,17 @@
44
import Log from './Log';
55
import OidcClient from './OidcClient';
66
import UserManagerSettings from './UserManagerSettings';
7-
import WebStorageStateStore from './WebStorageStateStore';
8-
import Global from './Global';
97
import User from './User';
10-
import RedirectNavigator from './RedirectNavigator';
11-
import PopupNavigator from './PopupNavigator';
12-
import IFrameNavigator from './IFrameNavigator';
138
import UserManagerEvents from './UserManagerEvents';
149
import SilentRenewService from './SilentRenewService';
1510

1611
export default class UserManager extends OidcClient {
17-
constructor(settings, {
18-
redirectNavigator = new RedirectNavigator(),
19-
popupNavigator = new PopupNavigator(),
20-
iframeNavigator = new IFrameNavigator(),
21-
userStore = new WebStorageStateStore({ store: Global.sessionStorage })
22-
} = {}) {
12+
constructor(settings = {}) {
13+
2314
if (!(settings instanceof UserManagerSettings)) {
2415
settings = new UserManagerSettings(settings);
2516
}
26-
super(settings, arguments[1]);
27-
28-
this._redirectNavigator = redirectNavigator;
29-
this._popupNavigator = popupNavigator;
30-
this._iframeNavigator = iframeNavigator;
31-
32-
this._userStore = userStore;
17+
super(settings);
3318

3419
this._events = new UserManagerEvents(settings);
3520

@@ -39,6 +24,19 @@ export default class UserManager extends OidcClient {
3924
}
4025
}
4126

27+
get _redirectNavigator() {
28+
return this.settings.redirectNavigator;
29+
}
30+
get _popupNavigator() {
31+
return this.settings.popupNavigator;
32+
}
33+
get _iframeNavigator() {
34+
return this.settings.iframeNavigator;
35+
}
36+
get _userStore() {
37+
return this.settings.userStore;
38+
}
39+
4240
get events() {
4341
return this._events;
4442
}
@@ -83,10 +81,10 @@ export default class UserManager extends OidcClient {
8381
args.redirect_uri = url;
8482
args.display = "popup";
8583

86-
return this._signin(args, this._popupNavigator, {
87-
startUrl: url,
88-
popupWindowFeatures : args.popupWindowFeatures || this.settings.popupWindowFeatures,
89-
popupWindowTarget : args.popupWindowTarget || this.settings.popupWindowTarget
84+
return this._signin(args, this._popupNavigator, {
85+
startUrl: url,
86+
popupWindowFeatures: args.popupWindowFeatures || this.settings.popupWindowFeatures,
87+
popupWindowTarget: args.popupWindowTarget || this.settings.popupWindowTarget
9088
});
9189
}
9290
signinPopupCallback(url) {

‎src/UserManagerSettings.js‎

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33

44
import Log from './Log';
55
import OidcClientSettings from './OidcClientSettings';
6+
import RedirectNavigator from './RedirectNavigator';
7+
import PopupNavigator from './PopupNavigator';
8+
import IFrameNavigator from './IFrameNavigator';
9+
import WebStorageStateStore from './WebStorageStateStore';
10+
import Global from './Global';
611

712
const DefaultAccessTokenExpiringNotificationTime = 60;
813

@@ -13,25 +18,36 @@ export default class UserManagerSettings extends OidcClientSettings {
1318
popupWindowTarget,
1419
silent_redirect_uri,
1520
automaticSilentRenew = false,
16-
accessTokenExpiringNotificationTime = DefaultAccessTokenExpiringNotificationTime
21+
accessTokenExpiringNotificationTime = DefaultAccessTokenExpiringNotificationTime,
22+
redirectNavigator = new RedirectNavigator(),
23+
popupNavigator = new PopupNavigator(),
24+
iframeNavigator = new IFrameNavigator(),
25+
userStore = new WebStorageStateStore({ store: Global.sessionStorage })
1726
} = {}) {
1827
super(arguments[0]);
19-
28+
2029
this._popup_redirect_uri = popup_redirect_uri;
2130
this._popupWindowFeatures = popupWindowFeatures;
2231
this._popupWindowTarget = popupWindowTarget;
32+
2333
this._silent_redirect_uri = silent_redirect_uri;
2434
this._automaticSilentRenew = !!automaticSilentRenew;
2535
this._accessTokenExpiringNotificationTime = accessTokenExpiringNotificationTime;
36+
37+
this._redirectNavigator = redirectNavigator;
38+
this._popupNavigator = popupNavigator;
39+
this._iframeNavigator = iframeNavigator;
40+
41+
this._userStore = userStore;
2642
}
27-
28-
get popup_redirect_uri(){
43+
44+
get popup_redirect_uri() {
2945
return this._popup_redirect_uri;
3046
}
31-
get popupWindowFeatures(){
47+
get popupWindowFeatures() {
3248
return this._popupWindowFeatures;
3349
}
34-
get popupWindowTarget(){
50+
get popupWindowTarget() {
3551
return this._popupWindowTarget;
3652
}
3753

@@ -41,8 +57,22 @@ export default class UserManagerSettings extends OidcClientSettings {
4157
get automaticSilentRenew() {
4258
return !!(this.silent_redirect_uri && this._automaticSilentRenew);
4359
}
44-
45-
get accessTokenExpiringNotificationTime(){
60+
61+
get accessTokenExpiringNotificationTime() {
4662
return this._accessTokenExpiringNotificationTime;
4763
}
64+
65+
get redirectNavigator() {
66+
return this._redirectNavigator;
67+
}
68+
get popupNavigator() {
69+
return this._popupNavigator;
70+
}
71+
get iframeNavigator() {
72+
return this._iframeNavigator;
73+
}
74+
75+
get userStore() {
76+
return this._userStore;
77+
}
4878
}

‎test/unit/OidcClient.spec.js‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Copyright (c) Brock Allen & Dominick Baier. All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
33

4+
import Global from '../../src/Global';
45
import OidcClient from '../../src/OidcClient';
56
import SigninRequest from '../../src/SigninRequest';
67
import SigninResponse from '../../src/SigninResponse';
@@ -29,23 +30,24 @@ describe("OidcClient", function () {
2930
let stubValidator;
3031

3132
beforeEach(function () {
33+
34+
Global._testing();
35+
3236
Log.logger = console;
3337
Log.level = Log.NONE;
3438

35-
settings = {
36-
client_id: 'client',
37-
redirect_uri: "http://app"
38-
};
39-
4039
stubStore = new StubStateStore();
4140
stubValidator = new StubResponseValidator();
4241
stubMetadataService = new StubMetadataService();
43-
44-
subject = new OidcClient(settings, {
42+
43+
settings = {
44+
client_id: 'client',
45+
redirect_uri: "http://app",
4546
stateStore: stubStore,
4647
ResponseValidatorCtor: () => stubValidator,
4748
MetadataServiceCtor: () => stubMetadataService
48-
});
49+
};
50+
subject = new OidcClient(settings);
4951
});
5052

5153
describe("constructor", function () {

0 commit comments

Comments
 (0)