Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: user logged before discovery enabled #176

Merged
merged 3 commits into from
Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions sdk/src/SDK.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ export class SDK {
return this._cache;
}

public externals() {
return this._externals;
}

/* istanbul ignore next */
public send = async (options: SendOptions): Promise<Response> => this.platform().send(options);

Expand Down
42 changes: 21 additions & 21 deletions sdk/src/platform/Discovery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ export interface DiscoveryOptions {
retryInterval?: number;
}

export interface ExternalDisconveryAuthApiData {
export interface ExternalDiscoveryAuthApiData {
authorizationUri: string;
oidcDiscoveryUri: string;
baseUri: string;
tokenUri: string;
}

export interface InitialDisconveryAuthApiData {
export interface InitialDiscoveryAuthApiData {
authorizationUri: string;
oidcDiscoveryUri: string;
defaultTokenUri: string;
Expand All @@ -44,7 +44,7 @@ export interface InitialDiscoveryApiData {
defaultExternalUri: string;
}

export interface DisconveryGlipData {
export interface DiscoveryGlipData {
discovery: string;
entry: string;
}
Expand All @@ -69,15 +69,15 @@ export interface InitialDiscoveryData {
retryCount: number;
retryInterval: number;
discoveryApi: InitialDiscoveryApiData;
authApi: InitialDisconveryAuthApiData;
authApi: InitialDiscoveryAuthApiData;
coreApi: DiscoveryCoreApiData;
rcm: DiscoveryRcmData;
rcv: DiscoveryRcvData;
edc?: DiscoveryEdcData;
glip?: DisconveryGlipData;
glip?: DiscoveryGlipData;
}

export interface ExternalDisconveryData {
export interface ExternalDiscoveryData {
version: string;
tag?: string;
expiresIn: number;
Expand All @@ -86,12 +86,12 @@ export interface ExternalDisconveryData {
retryInterval: number;
retryCycleDelay: number;
discoveryApi: ExternalDiscoveryApiData;
authApi: ExternalDisconveryAuthApiData;
authApi: ExternalDiscoveryAuthApiData;
coreApi: DiscoveryCoreApiData;
rcm: DiscoveryRcmData;
rcv: DiscoveryRcvData;
edc?: DiscoveryEdcData;
glip?: DisconveryGlipData;
glip?: DiscoveryGlipData;
}

export enum events {
Expand Down Expand Up @@ -121,7 +121,7 @@ export default class Discovery extends EventEmitter {
private _initialPromise?: Promise<void>;
private _initialFetchPromise?: Promise<InitialDiscoveryData>;

private _externalFetchPromise?: Promise<ExternalDisconveryData>;
private _externalFetchPromise?: Promise<ExternalDiscoveryData>;
private _externalRefreshPromise?: Promise<void>;

private _initialized: boolean = false;
Expand Down Expand Up @@ -243,9 +243,9 @@ export default class Discovery extends EventEmitter {
}
}

private async _fetchExternalData(externalEndoint: string) {
private async _fetchExternalData(externalEndpoint: string) {
try {
const response = await this._fetchGet(externalEndoint, null, {skipDiscoveryCheck: true});
const response = await this._fetchGet(externalEndpoint, null, {skipDiscoveryCheck: true});
const externalData = await response.json();
const discoveryTag = response.headers.get('discovery-tag');
if (discoveryTag) {
Expand All @@ -259,17 +259,17 @@ export default class Discovery extends EventEmitter {
this._externalRetryCount += 1;
if (this._externalRetryCount < this._externalRetryMaxCount) {
await delay(this._externalRetryInterval * 1000);
return this._fetchExternalData(externalEndoint);
return this._fetchExternalData(externalEndpoint);
}
this._externalRetryCount = 0;
throw e;
}
}

public async fetchExternalData(externalEndoint: string) {
public async fetchExternalData(externalEndpoint: string) {
try {
if (!this._externalFetchPromise) {
this._externalFetchPromise = this._fetchExternalData(externalEndoint);
this._externalFetchPromise = this._fetchExternalData(externalEndpoint);
}
const externalData = await this._externalFetchPromise;
await this._setExternalData(externalData);
Expand All @@ -288,15 +288,15 @@ export default class Discovery extends EventEmitter {
}
await delay(this._refreshDelayMs);
const oldExternalData = await this.externalData();
let externalEndoint;
let externalEndpoint;
if (oldExternalData) {
externalEndoint = oldExternalData.discoveryApi.externalUri;
externalEndpoint = oldExternalData.discoveryApi.externalUri;
} else {
const initialData = await this.initialData();
externalEndoint = initialData.discoveryApi.defaultExternalUri;
externalEndpoint = initialData.discoveryApi.defaultExternalUri;
}
try {
await this.fetchExternalData(externalEndoint);
await this.fetchExternalData(externalEndpoint);
} catch (e) {
this._externalRetryCycleTimeout = setTimeout(() => {
this._externalRetryCycleTimeout = null;
Expand Down Expand Up @@ -327,7 +327,7 @@ export default class Discovery extends EventEmitter {
return data || null;
}

public async externalData(): Promise<ExternalDisconveryData | null> {
public async externalData(): Promise<ExternalDiscoveryData | null> {
const data = await this._cache.getItem(this._externalCacheId);
return data || null;
}
Expand All @@ -336,7 +336,7 @@ export default class Discovery extends EventEmitter {
await this._cache.setItem(this._initialCacheId, newData);
}

private async _setExternalData(newData: ExternalDisconveryData) {
private async _setExternalData(newData: ExternalDiscoveryData) {
let expireTime;
if (newData.expiresIn) {
expireTime = Date.now() + newData.expiresIn * 1000;
Expand Down Expand Up @@ -388,7 +388,7 @@ export default class Discovery extends EventEmitter {
}

public on(event: events.initialized, listener: (discoveryData: InitialDiscoveryData) => void);
public on(event: events.externalDataUpdated, listener: (discoveryData: ExternalDisconveryData) => void);
public on(event: events.externalDataUpdated, listener: (discoveryData: ExternalDiscoveryData) => void);
public on(event: events.initialFetchError, listener: (e: Error) => void);
public on(event: events.externalRefreshError, listener: (e: Error) => void);
public on(event: string, listener: (...args) => void) {
Expand Down
24 changes: 24 additions & 0 deletions sdk/src/platform/Platform-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1059,6 +1059,30 @@ describe('RingCentral.platform.Platform', () => {
expect(hasError).to.equal(true);
expect(clientFetchErrorSpy.calledThrice).to.equal(true);
});

it('should fetch discovery if user has logged before discovery enabled', async () => {
authentication();
const noDiscoverySdk = createSdk();
await noDiscoverySdk.platform().login({
code: 'whatever',
discovery_uri: 'http://whatever/.well-known/entry-points/external',
token_uri: 'http://whatever/restapi/oauth/token',
});
const initialDiscoveryData = getInitialDiscoveryMockData();
const externalDiscoveryData = getExternalDiscoveryMockData();
apiCall('GET', '/.well-known/entry-points/initial?clientId=whatever', initialDiscoveryData);
apiCall('GET', '/.well-known/entry-points/external', externalDiscoveryData);
const withDiscoverySDK = createSdk({
enableDiscovery: true,
discoveryServer: 'http://whatever',
server: '',
localStorage: noDiscoverySdk.externals().localStorage,
});
apiCall('GET', '/restapi/v1.0/foo/1', {increment: 1});
const res = await withDiscoverySDK.get('/restapi/v1.0/foo/1');
const data = await res.json();
expect(data.increment).to.equal(1);
});
});

describe('API request with discovery', () => {
Expand Down
3 changes: 3 additions & 0 deletions sdk/src/platform/Platform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,9 @@ export default class Platform extends EventEmitter {

public async send(options: SendOptions = {}) {
if (!options.skipAuthCheck && !options.skipDiscoveryCheck && this._discovery) {
if (this._discoveryInitPromise) {
await this._discoveryInitPromise;
}
const discoveryExpired = await this._discovery.externalDataExpired();
if (discoveryExpired) {
await this._discovery.refreshExternalData();
Expand Down