Use cached web service token to renew SplatNet 3 tokens and fix retrying getting web service tokens after renewing coral token

This commit is contained in:
Samuel Elliott
2022-10-11 20:47:26 +01:00
parent 79b1d9eaae
commit e2ac4bbfb3
5 changed files with 116 additions and 19 deletions

View File

@@ -224,6 +224,7 @@ export default class CoralApi {
return await this.call<WebServiceToken>('/v2/Game/GetWebServiceToken', req, false);
} catch (err) {
if (err instanceof ErrorResponse && err.data.status === CoralStatus.TOKEN_EXPIRED && !_attempt && this.onTokenExpired) {
debug('Error getting web service token, renewing token before retrying', err);
// _renewToken will be awaited when calling getWebServiceToken
this._renewToken = this._renewToken ?? this.onTokenExpired.call(null, err.data, err.response as Response).then(data => {
if (data) this.setTokenWithSavedToken(data);

View File

@@ -2,6 +2,7 @@ import * as util from 'node:util';
import { Response as NodeFetchResponse } from 'node-fetch';
export const ResponseSymbol = Symbol('Response');
const ErrorResponseSymbol = Symbol('IsErrorResponse');
export interface ResponseData<R> {
[ResponseSymbol]: R;
@@ -24,6 +25,8 @@ export class ErrorResponse<T = unknown> extends Error {
) {
super(message);
Object.defineProperty(this, ErrorResponseSymbol, {enumerable: false, value: ErrorResponseSymbol});
if (typeof body === 'string') {
this.body = body;
try {
@@ -51,9 +54,6 @@ export class ErrorResponse<T = unknown> extends Error {
Object.defineProperty(ErrorResponse, Symbol.hasInstance, {
configurable: true,
value: (instance: ErrorResponse) => {
return instance instanceof Error &&
'response' in instance &&
'body' in instance &&
'data' in instance;
return instance && ErrorResponseSymbol in instance;
},
});

View File

@@ -53,8 +53,10 @@ export async function getBulletToken(
await storage.setItem('BulletToken.' + token, existingToken);
const splatnet = SplatNet3Api.createWithSavedToken(existingToken);
splatnet.onTokenExpired = createTokenExpiredHandler(storage, token, splatnet, existingToken, proxy_url);
splatnet.onTokenShouldRenew = createTokenShouldRenewHandler(storage, token, splatnet, existingToken, proxy_url);
const renew_token_data = {existingToken, znc_proxy_url: proxy_url};
splatnet.onTokenExpired = createTokenExpiredHandler(storage, token, splatnet, renew_token_data);
splatnet.onTokenShouldRenew = createTokenShouldRenewHandler(storage, token, splatnet, renew_token_data);
return {splatnet, data: existingToken};
}
@@ -64,45 +66,47 @@ export async function getBulletToken(
const splatnet = SplatNet3Api.createWithSavedToken(existingToken);
if (allow_fetch_token) {
splatnet.onTokenExpired = createTokenExpiredHandler(storage, token, splatnet, existingToken, proxy_url);
splatnet.onTokenShouldRenew = createTokenShouldRenewHandler(storage, token, splatnet, existingToken, proxy_url);
const renew_token_data = {existingToken, znc_proxy_url: proxy_url};
splatnet.onTokenExpired = createTokenExpiredHandler(storage, token, splatnet, renew_token_data);
splatnet.onTokenShouldRenew = createTokenShouldRenewHandler(storage, token, splatnet, renew_token_data);
}
return {splatnet, data: existingToken};
}
function createTokenExpiredHandler(
storage: persist.LocalStorage, token: string, splatnet: SplatNet3Api, existingToken: SavedBulletToken,
znc_proxy_url?: string
storage: persist.LocalStorage, token: string, splatnet: SplatNet3Api,
data: {existingToken: SavedBulletToken; znc_proxy_url?: string}
) {
return (response: Response) => {
debug('Token expired, renewing');
return renewToken(storage, token, splatnet, existingToken, znc_proxy_url);
return renewToken(storage, token, splatnet, data);
};
}
function createTokenShouldRenewHandler(
storage: persist.LocalStorage, token: string, splatnet: SplatNet3Api, existingToken: SavedBulletToken,
znc_proxy_url?: string
storage: persist.LocalStorage, token: string, splatnet: SplatNet3Api,
data: {existingToken: SavedBulletToken; znc_proxy_url?: string}
) {
return (remaining: number, response: Response) => {
debug('Token will expire in %d seconds, renewing', remaining);
return renewToken(storage, token, splatnet, existingToken, znc_proxy_url);
return renewToken(storage, token, splatnet, data);
};
}
async function renewToken(
storage: persist.LocalStorage, token: string, splatnet: SplatNet3Api, previousToken: SavedBulletToken,
znc_proxy_url?: string
storage: persist.LocalStorage, token: string, splatnet: SplatNet3Api,
renew_token_data: {existingToken: SavedBulletToken; znc_proxy_url?: string}
) {
try {
const data: SavedToken | undefined = await storage.getItem('NsoToken.' + token);
if (data) {
const existingToken: SavedBulletToken =
await splatnet.renewTokenWithWebServiceToken(previousToken.webserviceToken, data.user);
await splatnet.renewTokenWithWebServiceToken(renew_token_data.existingToken.webserviceToken, data.user);
await storage.setItem('BulletToken.' + token, existingToken);
renew_token_data.existingToken = existingToken;
return;
} else {
@@ -117,7 +121,7 @@ async function renewToken(
}
}
const {nso, data} = await getToken(storage, token, znc_proxy_url);
const {nso, data} = await getToken(storage, token, renew_token_data.znc_proxy_url);
if (data[Login]) {
const announcements = await nso.getAnnouncements();
@@ -129,4 +133,5 @@ async function renewToken(
const existingToken: SavedBulletToken = await splatnet.renewTokenWithCoral(nso, data.user);
await storage.setItem('BulletToken.' + token, existingToken);
renew_token_data.existingToken = existingToken;
}