From dec430f0e5d2f334eb77a0d809f7b0a408d8c4c1 Mon Sep 17 00:00:00 2001 From: JGiter Date: Wed, 17 Nov 2021 11:57:41 +0200 Subject: [PATCH] fix(cacheClient): test cache login --- ...cacheClient_cacheClient_service.CacheClient.md | 15 --------------- ...dules_cacheClient_ICacheClient.ICacheClient.md | 11 ----------- docs/api/modules/index.md | 7 +++++++ docs/api/modules/modules_cacheClient.md | 7 +++++++ .../modules_cacheClient_cacheClient_types.md | 10 ++++++++++ src/modules/cacheClient/ICacheClient.ts | 1 - src/modules/cacheClient/cacheClient.service.ts | 14 +++++++------- src/modules/cacheClient/cacheClient.types.ts | 2 ++ 8 files changed, 33 insertions(+), 34 deletions(-) diff --git a/docs/api/classes/modules_cacheClient_cacheClient_service.CacheClient.md b/docs/api/classes/modules_cacheClient_cacheClient_service.CacheClient.md index 87b3ee27..0af1661b 100644 --- a/docs/api/classes/modules_cacheClient_cacheClient_service.CacheClient.md +++ b/docs/api/classes/modules_cacheClient_cacheClient_service.CacheClient.md @@ -54,7 +54,6 @@ - [login](modules_cacheClient_cacheClient_service.CacheClient.md#login) - [rejectClaim](modules_cacheClient_cacheClient_service.CacheClient.md#rejectclaim) - [requestClaim](modules_cacheClient_cacheClient_service.CacheClient.md#requestclaim) -- [testLogin](modules_cacheClient_cacheClient_service.CacheClient.md#testlogin) ## Constructors @@ -764,17 +763,3 @@ ___ #### Implementation of [ICacheClient](../interfaces/modules_cacheClient_ICacheClient.ICacheClient.md).[requestClaim](../interfaces/modules_cacheClient_ICacheClient.ICacheClient.md#requestclaim) - -___ - -### testLogin - -▸ **testLogin**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -[ICacheClient](../interfaces/modules_cacheClient_ICacheClient.ICacheClient.md).[testLogin](../interfaces/modules_cacheClient_ICacheClient.ICacheClient.md#testlogin) diff --git a/docs/api/interfaces/modules_cacheClient_ICacheClient.ICacheClient.md b/docs/api/interfaces/modules_cacheClient_ICacheClient.ICacheClient.md index 4589a5de..a4cca8a3 100644 --- a/docs/api/interfaces/modules_cacheClient_ICacheClient.ICacheClient.md +++ b/docs/api/interfaces/modules_cacheClient_ICacheClient.ICacheClient.md @@ -45,7 +45,6 @@ - [login](modules_cacheClient_ICacheClient.ICacheClient.md#login) - [rejectClaim](modules_cacheClient_ICacheClient.ICacheClient.md#rejectclaim) - [requestClaim](modules_cacheClient_ICacheClient.ICacheClient.md#requestclaim) -- [testLogin](modules_cacheClient_ICacheClient.ICacheClient.md#testlogin) ## Properties @@ -546,13 +545,3 @@ ___ #### Returns `Promise`<`void`\> - -___ - -### testLogin - -▸ **testLogin**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> diff --git a/docs/api/modules/index.md b/docs/api/modules/index.md index a1ee42d7..fb2a312a 100644 --- a/docs/api/modules/index.md +++ b/docs/api/modules/index.md @@ -61,6 +61,7 @@ - [StakeStatus](index.md#stakestatus) - [StakingPool](index.md#stakingpool) - [StakingService](index.md#stakingservice) +- [TEST\_LOGIN\_NAMESPACE](index.md#test_login_namespace) - [VOLTA\_CHAIN\_ID](index.md#volta_chain_id) - [addSupportedDID](index.md#addsupporteddid) - [agreement\_type\_hash](index.md#agreement_type_hash) @@ -441,6 +442,12 @@ Re-exports: [StakingService](../classes/modules_staking_staking_service.StakingS ___ +### TEST\_LOGIN\_NAMESPACE + +Re-exports: [TEST\_LOGIN\_NAMESPACE](modules_cacheClient_cacheClient_types.md#test_login_namespace) + +___ + ### VOLTA\_CHAIN\_ID Re-exports: [VOLTA\_CHAIN\_ID](utils_constants.md#volta_chain_id) diff --git a/docs/api/modules/modules_cacheClient.md b/docs/api/modules/modules_cacheClient.md index 1eb5526b..9c84cb09 100644 --- a/docs/api/modules/modules_cacheClient.md +++ b/docs/api/modules/modules_cacheClient.md @@ -11,6 +11,7 @@ - [ICacheClient](modules_cacheClient.md#icacheclient) - [Order](modules_cacheClient.md#order) - [SearchType](modules_cacheClient.md#searchtype) +- [TEST\_LOGIN\_NAMESPACE](modules_cacheClient.md#test_login_namespace) ## References @@ -53,3 +54,9 @@ ___ ### SearchType Re-exports: [SearchType](../enums/modules_cacheClient_cacheClient_types.SearchType.md) + +___ + +### TEST\_LOGIN\_NAMESPACE + +Re-exports: [TEST\_LOGIN\_NAMESPACE](modules_cacheClient_cacheClient_types.md#test_login_namespace) diff --git a/docs/api/modules/modules_cacheClient_cacheClient_types.md b/docs/api/modules/modules_cacheClient_cacheClient_types.md index 09ba45e9..0dc4ecea 100644 --- a/docs/api/modules/modules_cacheClient_cacheClient_types.md +++ b/docs/api/modules/modules_cacheClient_cacheClient_types.md @@ -16,6 +16,10 @@ - [AssetsFilter](modules_cacheClient_cacheClient_types.md#assetsfilter) - [ClaimsFilter](modules_cacheClient_cacheClient_types.md#claimsfilter) +### Variables + +- [TEST\_LOGIN\_NAMESPACE](modules_cacheClient_cacheClient_types.md#test_login_namespace) + ## Type aliases ### AssetsFilter @@ -43,3 +47,9 @@ ___ | :------ | :------ | | `isAccepted?` | `boolean` | | `namespace?` | `string` | + +## Variables + +### TEST\_LOGIN\_NAMESPACE + +• `Const` **TEST\_LOGIN\_NAMESPACE**: ``"testing.if.logged.in"`` diff --git a/src/modules/cacheClient/ICacheClient.ts b/src/modules/cacheClient/ICacheClient.ts index 3c12e563..864886a2 100644 --- a/src/modules/cacheClient/ICacheClient.ts +++ b/src/modules/cacheClient/ICacheClient.ts @@ -10,7 +10,6 @@ import { SearchType } from "."; export interface ICacheClient { pubKeyAndIdentityToken: IPubKeyAndIdentityToken | undefined; - testLogin: () => Promise; login: () => Promise; isAuthEnabled: () => boolean; diff --git a/src/modules/cacheClient/cacheClient.service.ts b/src/modules/cacheClient/cacheClient.service.ts index 5f41ca5f..54570ece 100644 --- a/src/modules/cacheClient/cacheClient.service.ts +++ b/src/modules/cacheClient/cacheClient.service.ts @@ -12,7 +12,7 @@ import { IPubKeyAndIdentityToken } from "../signer/signer.types"; import { cacheConfigs } from "../../config/cache.config"; import { ICacheClient } from "./ICacheClient"; import { AssetsFilter, ClaimsFilter } from "./cacheClient.types"; -import { SearchType } from "."; +import { SearchType, TEST_LOGIN_NAMESPACE } from "."; export class CacheClient implements ICacheClient { public pubKeyAndIdentityToken: IPubKeyAndIdentityToken | undefined; @@ -87,12 +87,6 @@ export class CacheClient implements ICacheClient { return Promise.reject(error); } - async testLogin(): Promise { - // Simple test to check if logged in or no. TODO: have dedicated endpoint on the cache-server - // If receive unauthorized response, expect that refreshToken() will be called - await this.getRoleDefinition("testing.if.logged.in"); - } - async login() { await this.testLogin(); } @@ -302,4 +296,10 @@ export class CacheClient implements ICacheClient { return { token, refreshToken }; } } + + private async testLogin(): Promise { + // Simple test to check if logged in or no. TODO: have dedicated endpoint on the cache-server + // If receive unauthorized response, expect that refreshToken() will be called + await this.getRoleDefinition(TEST_LOGIN_NAMESPACE); + } } diff --git a/src/modules/cacheClient/cacheClient.types.ts b/src/modules/cacheClient/cacheClient.types.ts index 5b3ae995..1aed274a 100644 --- a/src/modules/cacheClient/cacheClient.types.ts +++ b/src/modules/cacheClient/cacheClient.types.ts @@ -27,3 +27,5 @@ export enum SearchType { Org = "Org", Role = "Role", } + +export const TEST_LOGIN_NAMESPACE = "testing.if.logged.in";