Added ServiceManager to elect leader for token auto renew service #1117
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1117 +/- ##
==========================================
- Coverage 93.51% 93.43% -0.08%
==========================================
Files 154 158 +4
Lines 4147 4251 +104
Branches 906 922 +16
==========================================
+ Hits 3878 3972 +94
- Misses 253 263 +10
Partials 16 16
Continue to review full report at Codecov.
|
denysoblohin-okta
force-pushed
the
od-broadcast-channel-OKTA-456234
branch
from
0cb18c7 to
4dc6e37
Compare
|
|
||
| private static knownServices = ['autoRenew', 'syncStorage']; | ||
|
|
||
| constructor(tokenManager: TokenManager, options: TokenManagerOptions = {}) { |
There was a problem hiding this comment.
ServiceManager could accept an instance of OktaAuth (like the AuthStateManager does https://github.com/okta/okta-auth-js/blob/master/lib/AuthStateManager.ts#L53). This would still give it access to the tokenManager and it's config options, but also future-proofs the ServiceManager, in case we need to add a Service in the future that needs different configs
constructor(sdk: OktaAuth) {
this.sdk = sdk;
this.tokenManager = sdk.tokenManager;
...
}| this.services = new Map(); | ||
| } | ||
|
|
||
| private startElector() { |
There was a problem hiding this comment.
What happens if the elected leader dies? For example the tab is closed. Is a new leader elected?
| @@ -89,6 +87,9 @@ export class TokenManager implements TokenManagerInterface { | |||
| if (!isLocalhost()) { | |||
| options.expireEarlySeconds = DEFAULT_OPTIONS.expireEarlySeconds; | |||
| } | |||
| if (!options.broadcastChannelName) { | |||
There was a problem hiding this comment.
this config should moved outside of the TokenManager
| export class AutoRenewService extends TokenService { | ||
| private renewTimeQueue: Array<number>; | ||
|
|
||
| constructor(tokenManager: TokenManager, options: TokenManagerOptions = {}) { |
There was a problem hiding this comment.
This service should have it's own Options type
| private storageListener?: (event: StorageEvent) => void; | ||
| private onTokenExpiredHandler?: (key: string) => void; | ||
| private syncTimeout: unknown; | ||
| export abstract class TokenService implements TokenServiceInterface { |
There was a problem hiding this comment.
TokenService abstract class probably isn't necessary for this effort. A simple Interface with start/stop is probably sufficient
| import { TokenManagerOptions } from '../types'; | ||
| import { isBrowser } from '../features'; | ||
|
|
||
| export class AutoRenewService extends TokenService { |
There was a problem hiding this comment.
Should implement ServiceInterface
| @@ -0,0 +1,7 @@ | |||
| export interface TokenServiceInterface { | |||
There was a problem hiding this comment.
rename this to ServiceInterface. Future services may not be Token/TokenManager related
|
Included in #1124 |
Added broadcast-channel package to solve cross-tab token renewal issues with tab leader election method.
Added
ServiceManagerthat is responsible for:broadcast-channelAutoRenewService(depending on leadership status) andSyncStorageService.(
TokenServiceis splitted intoAutoRenewServiceandSyncStorageService, based on https://github.com/okta/okta-auth-js/pull/1108/files)Notes:
syncStorageshould be set to true to start auto-renew only on 1 leader tab. Otherwise auto-renew service will run on every tab.tokenManager.start()does not start token service anymore.serviceManager.start()is responsible for starting services and is called inoktaAuth.start()Internal ref: OKTA-456234 (and OKTA-456251)
Resolves #1001
Cross-tab simulation
before:
cross1.mov
after:
cross2.mov