@axa-fr/oidc-client 7.22.18 → 7.22.19

package/src/logout.spec.ts

@@ -2,85 +2,140 @@
 
 import { describe, expect, it, vi } from 'vitest';
 
-import { logoutAsync } from "./logout";
-import {ILOidcLocation, OidcLocation} from "./location";
+import { ILOidcLocation } from './location';
+import { logoutAsync } from './logout';
 
 describe('Logout test suite', () => {
-    const expectedFinalUrl = "http://api/connect/endsession?id_token_hint=abcd&post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A4200%2Flogged_out";
-    it.each([
-        {logout_tokens_to_invalidate:['access_token', 'refresh_token'], extras:null, expectedResults: ["token=abcd&token_type_hint=access_token&client_id=interactive.public.short","token=abdc&token_type_hint=refresh_token&client_id=interactive.public.short"], expectedFinalUrl}, 
-        {logout_tokens_to_invalidate:['refresh_token'],extras:null, expectedResults: ["token=abdc&token_type_hint=refresh_token&client_id=interactive.public.short"], expectedFinalUrl}, 
-        {logout_tokens_to_invalidate:['access_token'],extras:null, expectedResults: ["token=abcd&token_type_hint=access_token&client_id=interactive.public.short"], expectedFinalUrl}, 
-        {logout_tokens_to_invalidate:[],extras:null, expectedResults: [], expectedFinalUrl}, 
-        {logout_tokens_to_invalidate:[],extras: {"id_token_hint": undefined}, expectedResults: [], expectedFinalUrl: "http://api/connect/endsession?post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A4200%2Flogged_out" }, 
-        {logout_tokens_to_invalidate:[],extras: {"no_reload:oidc":"true"}, expectedResults: [], expectedFinalUrl:""},
-        {logout_tokens_to_invalidate:['refresh_token'],extras:{"client_secret:revoke_refresh_token":"secret"}, expectedResults: ["token=abdc&token_type_hint=refresh_token&client_id=interactive.public.short&client_secret=secret"], expectedFinalUrl},
-        {logout_tokens_to_invalidate:['access_token'],extras:{"client_secret:revoke_access_token":"secret"}, expectedResults: ["token=abcd&token_type_hint=access_token&client_id=interactive.public.short&client_secret=secret"], expectedFinalUrl},
-    ])('Logout should revoke tokens $logout_tokens_to_invalidate', async ({ logout_tokens_to_invalidate, extras =null, expectedResults, expectedFinalUrl}) => {
-
-        const configuration = {
-            client_id: 'interactive.public.short',
-            redirect_uri: 'http://localhost:4200/authentication/callback',
-            scope: 'openid profile email api offline_access',
-            authority: 'http://api',
-            refresh_time_before_tokens_expiration_in_second: 70,
-            logout_tokens_to_invalidate,
-        };
-
-        const fetch = (url, data) => {
-            if(url === "http://api/connect/revocation") {
-                return Promise.resolve({status: 200});
-            }
-            return Promise.resolve({
-                status : 200,
-            });
-        };
-
-        const mockFetchFn = vi.fn().mockImplementation(fetch);
-        
-        const oidc = { 
-            configuration,
-            tokens : {idToken: "abcd", accessToken: "abcd", refreshToken: "abdc" }, 
-            initAsync: ()  => Promise.resolve({
-                revocationEndpoint: "http://api/connect/revocation",
-                endSessionEndpoint: "http://api/connect/endsession",
-            }),
-            destroyAsync: () => Promise.resolve(),
-            logoutSameTabAsync: () => Promise.resolve(),
-        };
-        
-        const oidcDatabase = {default: () => oidc};
-                
-        let finalUrl = "";
-        class OidcLocationMock implements ILOidcLocation{
-            open(url: string): void {
-                finalUrl = url;
-            }
-
-            getCurrentHref(): string {
-                return "";
-            }
-
-            getPath(): string {
-                return "";
-            }
-
-            reload(): void {
-            }
-
-            getOrigin(): string {
-                return "http://localhost:4200";
-            }
-            
+  const expectedFinalUrl =
+    'http://api/connect/endsession?id_token_hint=abcd&post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A4200%2Flogged_out';
+  it.each([
+    {
+      logout_tokens_to_invalidate: ['access_token', 'refresh_token'],
+      extras: null,
+      expectedResults: [
+        'token=abcd&token_type_hint=access_token&client_id=interactive.public.short',
+        'token=abdc&token_type_hint=refresh_token&client_id=interactive.public.short',
+      ],
+      expectedFinalUrl,
+    },
+    {
+      logout_tokens_to_invalidate: ['refresh_token'],
+      extras: null,
+      expectedResults: [
+        'token=abdc&token_type_hint=refresh_token&client_id=interactive.public.short',
+      ],
+      expectedFinalUrl,
+    },
+    {
+      logout_tokens_to_invalidate: ['access_token'],
+      extras: null,
+      expectedResults: [
+        'token=abcd&token_type_hint=access_token&client_id=interactive.public.short',
+      ],
+      expectedFinalUrl,
+    },
+    { logout_tokens_to_invalidate: [], extras: null, expectedResults: [], expectedFinalUrl },
+    {
+      logout_tokens_to_invalidate: [],
+      extras: { id_token_hint: undefined },
+      expectedResults: [],
+      expectedFinalUrl:
+        'http://api/connect/endsession?post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A4200%2Flogged_out',
+    },
+    {
+      logout_tokens_to_invalidate: [],
+      extras: { 'no_reload:oidc': 'true' },
+      expectedResults: [],
+      expectedFinalUrl: '',
+    },
+    {
+      logout_tokens_to_invalidate: ['refresh_token'],
+      extras: { 'client_secret:revoke_refresh_token': 'secret' },
+      expectedResults: [
+        'token=abdc&token_type_hint=refresh_token&client_id=interactive.public.short&client_secret=secret',
+      ],
+      expectedFinalUrl,
+    },
+    {
+      logout_tokens_to_invalidate: ['access_token'],
+      extras: { 'client_secret:revoke_access_token': 'secret' },
+      expectedResults: [
+        'token=abcd&token_type_hint=access_token&client_id=interactive.public.short&client_secret=secret',
+      ],
+      expectedFinalUrl,
+    },
+  ])(
+    'Logout should revoke tokens $logout_tokens_to_invalidate',
+    async ({ logout_tokens_to_invalidate, extras = null, expectedResults, expectedFinalUrl }) => {
+      const configuration = {
+        client_id: 'interactive.public.short',
+        redirect_uri: 'http://localhost:4200/authentication/callback',
+        scope: 'openid profile email api offline_access',
+        authority: 'http://api',
+        refresh_time_before_tokens_expiration_in_second: 70,
+        logout_tokens_to_invalidate,
+      };
+
+      const fetch = (url, data) => {
+        if (url === 'http://api/connect/revocation') {
+          return Promise.resolve({ status: 200 });
+        }
+        return Promise.resolve({
+          status: 200,
+        });
+      };
+
+      const mockFetchFn = vi.fn().mockImplementation(fetch);
+
+      const oidc = {
+        configuration,
+        tokens: { idToken: 'abcd', accessToken: 'abcd', refreshToken: 'abdc' },
+        initAsync: () =>
+          Promise.resolve({
+            revocationEndpoint: 'http://api/connect/revocation',
+            endSessionEndpoint: 'http://api/connect/endsession',
+          }),
+        destroyAsync: () => Promise.resolve(),
+        logoutSameTabAsync: () => Promise.resolve(),
+      };
+
+      const oidcDatabase = { default: () => oidc };
+
+      let finalUrl = '';
+      class OidcLocationMock implements ILOidcLocation {
+        open(url: string): void {
+          finalUrl = url;
+        }
+
+        getCurrentHref(): string {
+          return '';
         }
 
-        await logoutAsync(oidc, oidcDatabase, mockFetchFn, console, new OidcLocationMock())("/logged_out", extras);
-        
-        // @ts-ignore
+        getPath(): string {
+          return '';
+        }
+
+        reload(): void {}
+
+        getOrigin(): string {
+          return 'http://localhost:4200';
+        }
+      }
+
+      await logoutAsync(
+        oidc,
+        oidcDatabase,
+        mockFetchFn,
+        console,
+        new OidcLocationMock(),
+      )('/logged_out', extras);
+
+      // @ts-ignore
+
+      const results = mockFetchFn.mock.calls.map((call, index) => call[1].body);
 
-        const results =  mockFetchFn.mock.calls.map((call, index) => call[1].body);
-    
-        expect(results).toEqual(expectedResults);
-        expect(finalUrl).toBe(expectedFinalUrl);
-    });
+      expect(results).toEqual(expectedResults);
+      expect(finalUrl).toBe(expectedFinalUrl);
+    },
+  );
 });

package/src/logout.ts

@@ -1,153 +1,168 @@
+import { eventNames } from './events';
 import { initSession } from './initSession.js';
 import { initWorkerAsync } from './initWorker.js';
+import { ILOidcLocation } from './location';
 import { performRevocationRequestAsync, TOKEN_TYPE } from './requests.js';
 import timer from './timer.js';
 import { StringMap } from './types.js';
-import {ILOidcLocation} from "./location";
-import {eventNames} from "./events";
 
 export const oidcLogoutTokens = {
-    access_token: 'access_token',
-    refresh_token: 'refresh_token',
+  access_token: 'access_token',
+  refresh_token: 'refresh_token',
 };
 
-const extractExtras = (extras: StringMap, postKey: string):StringMap => {
-    const postExtras:StringMap = {};
-    if (extras) {
-        for (const [key, value] of Object.entries(extras)) {
-            if (key.endsWith(postKey)) {
-                const newKey = key.replace(postKey, '');
-                postExtras[newKey] = value;
-            }
-        }
-        return postExtras;
+const extractExtras = (extras: StringMap, postKey: string): StringMap => {
+  const postExtras: StringMap = {};
+  if (extras) {
+    for (const [key, value] of Object.entries(extras)) {
+      if (key.endsWith(postKey)) {
+        const newKey = key.replace(postKey, '');
+        postExtras[newKey] = value;
+      }
     }
     return postExtras;
-}
+  }
+  return postExtras;
+};
 
-const keepExtras = (extras: StringMap):StringMap => {
-    const postExtras : StringMap = {};
-    if (extras) {
-        for (const [key, value] of Object.entries(extras)) {
-            if (!key.includes(':')) {
-                postExtras[key] = value;
-            }
-        }
-        return postExtras;
+const keepExtras = (extras: StringMap): StringMap => {
+  const postExtras: StringMap = {};
+  if (extras) {
+    for (const [key, value] of Object.entries(extras)) {
+      if (!key.includes(':')) {
+        postExtras[key] = value;
+      }
     }
     return postExtras;
-}
+  }
+  return postExtras;
+};
 
-export const destroyAsync = (oidc) => async (status) => {
-    timer.clearTimeout(oidc.timeoutId);
-    oidc.timeoutId = null;
-    if (oidc.checkSessionIFrame) {
-        oidc.checkSessionIFrame.stop();
-    }
-    const serviceWorker = await initWorkerAsync(oidc.configuration, oidc.configurationName);
-    if (!serviceWorker) {
-        const session = initSession(oidc.configurationName, oidc.configuration.storage);
-        await session.clearAsync(status);
-    } else {
-        await serviceWorker.clearAsync(status);
-    }
-    oidc.tokens = null;
-    oidc.userInfo = null;
+export const destroyAsync = oidc => async status => {
+  timer.clearTimeout(oidc.timeoutId);
+  oidc.timeoutId = null;
+  if (oidc.checkSessionIFrame) {
+    oidc.checkSessionIFrame.stop();
+  }
+  const serviceWorker = await initWorkerAsync(oidc.configuration, oidc.configurationName);
+  if (!serviceWorker) {
+    const session = initSession(oidc.configurationName, oidc.configuration.storage);
+    await session.clearAsync(status);
+  } else {
+    await serviceWorker.clearAsync(status);
+  }
+  oidc.tokens = null;
+  oidc.userInfo = null;
 };
 
-export const logoutAsync = (oidc, 
-                            oidcDatabase, 
-                            fetch, 
-                            console, oicLocation:ILOidcLocation) => async (callbackPathOrUrl: string | null | undefined = undefined, extras: StringMap = null) => {
+export const logoutAsync =
+  (oidc, oidcDatabase, fetch, console, oicLocation: ILOidcLocation) =>
+  async (callbackPathOrUrl: string | null | undefined = undefined, extras: StringMap = null) => {
     const configuration = oidc.configuration;
-    const oidcServerConfiguration = await oidc.initAsync(configuration.authority, configuration.authority_configuration);
-    if (callbackPathOrUrl && (typeof callbackPathOrUrl !== 'string')) {
-        callbackPathOrUrl = undefined;
-        console.warn('callbackPathOrUrl path is not a string');
+    const oidcServerConfiguration = await oidc.initAsync(
+      configuration.authority,
+      configuration.authority_configuration,
+    );
+    if (callbackPathOrUrl && typeof callbackPathOrUrl !== 'string') {
+      callbackPathOrUrl = undefined;
+      console.warn('callbackPathOrUrl path is not a string');
     }
-    const path = (callbackPathOrUrl === null || callbackPathOrUrl === undefined) ? oicLocation.getPath() : callbackPathOrUrl;
+    const path =
+      callbackPathOrUrl === null || callbackPathOrUrl === undefined
+        ? oicLocation.getPath()
+        : callbackPathOrUrl;
     let isUri = false;
     if (callbackPathOrUrl) {
-        isUri = callbackPathOrUrl.includes('https://') || callbackPathOrUrl.includes('http://');
+      isUri = callbackPathOrUrl.includes('https://') || callbackPathOrUrl.includes('http://');
     }
-    const url = isUri ? callbackPathOrUrl : oicLocation.getOrigin() + path 
+    const url = isUri ? callbackPathOrUrl : oicLocation.getOrigin() + path;
     // @ts-ignore
     const idToken = oidc.tokens ? oidc.tokens.idToken : '';
     try {
-        const revocationEndpoint = oidcServerConfiguration.revocationEndpoint;
-        if (revocationEndpoint) {
-            const promises = [];
-            const accessToken = oidc.tokens ? oidc.tokens.accessToken : null;
-            if (accessToken && configuration.logout_tokens_to_invalidate.includes(oidcLogoutTokens.access_token)) {
-                const revokeAccessTokenExtras = extractExtras(extras, ':revoke_access_token');
-                const revokeAccessTokenPromise = performRevocationRequestAsync(fetch)(revocationEndpoint, 
-                    accessToken, 
-                    TOKEN_TYPE.access_token, 
-                    configuration.client_id,
-                    revokeAccessTokenExtras);
-                promises.push(revokeAccessTokenPromise);
-            }
-            const refreshToken = oidc.tokens ? oidc.tokens.refreshToken : null;
-            if (refreshToken && configuration.logout_tokens_to_invalidate.includes(oidcLogoutTokens.refresh_token)) {
-                const revokeAccessTokenExtras = extractExtras(extras, ':revoke_refresh_token');
-                const revokeRefreshTokenPromise = performRevocationRequestAsync(fetch)(revocationEndpoint, 
-                    refreshToken, 
-                    TOKEN_TYPE.refresh_token, 
-                    configuration.client_id,
-                    revokeAccessTokenExtras);
-                promises.push(revokeRefreshTokenPromise);
-            }
-            if (promises.length > 0) {
-                await Promise.all(promises);
-            }
+      const revocationEndpoint = oidcServerConfiguration.revocationEndpoint;
+      if (revocationEndpoint) {
+        const promises = [];
+        const accessToken = oidc.tokens ? oidc.tokens.accessToken : null;
+        if (
+          accessToken &&
+          configuration.logout_tokens_to_invalidate.includes(oidcLogoutTokens.access_token)
+        ) {
+          const revokeAccessTokenExtras = extractExtras(extras, ':revoke_access_token');
+          const revokeAccessTokenPromise = performRevocationRequestAsync(fetch)(
+            revocationEndpoint,
+            accessToken,
+            TOKEN_TYPE.access_token,
+            configuration.client_id,
+            revokeAccessTokenExtras,
+          );
+          promises.push(revokeAccessTokenPromise);
+        }
+        const refreshToken = oidc.tokens ? oidc.tokens.refreshToken : null;
+        if (
+          refreshToken &&
+          configuration.logout_tokens_to_invalidate.includes(oidcLogoutTokens.refresh_token)
+        ) {
+          const revokeAccessTokenExtras = extractExtras(extras, ':revoke_refresh_token');
+          const revokeRefreshTokenPromise = performRevocationRequestAsync(fetch)(
+            revocationEndpoint,
+            refreshToken,
+            TOKEN_TYPE.refresh_token,
+            configuration.client_id,
+            revokeAccessTokenExtras,
+          );
+          promises.push(revokeRefreshTokenPromise);
+        }
+        if (promises.length > 0) {
+          await Promise.all(promises);
         }
+      }
     } catch (exception) {
-        console.warn('logoutAsync: error when revoking tokens, if the error persist, you ay configure property logout_tokens_to_invalidate from configuration to avoid this error');
-        console.warn(exception);
+      console.warn(
+        'logoutAsync: error when revoking tokens, if the error persist, you ay configure property logout_tokens_to_invalidate from configuration to avoid this error',
+      );
+      console.warn(exception);
     }
-    // @ts-ignore
-    const sub = oidc.tokens && oidc.tokens.idTokenPayload ? oidc.tokens.idTokenPayload.sub : null;
-    
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const sub = oidc.tokens?.idTokenPayload?.sub ?? null;
+
     await oidc.destroyAsync('LOGGED_OUT');
-    for (const [key, itemOidc] of Object.entries(oidcDatabase)) {
-        if (itemOidc !== oidc) {
-            // @ts-ignore
-            await oidc.logoutSameTabAsync(oidc.configuration.client_id, sub);
-        } else {
-            oidc.publishEvent(eventNames.logout_from_same_tab, {} );
-        }
+    for (const [, itemOidc] of Object.entries(oidcDatabase)) {
+      if (itemOidc !== oidc) {
+        // @ts-ignore
+        await oidc.logoutSameTabAsync(oidc.configuration.client_id, sub);
+      } else {
+        oidc.publishEvent(eventNames.logout_from_same_tab, {});
+      }
     }
-    
+
     const oidcExtras = extractExtras(extras, ':oidc');
-    let noReload = oidcExtras && oidcExtras['no_reload'] === 'true';
-    
-    if(noReload) {
-        return;
+    const noReload = oidcExtras && oidcExtras['no_reload'] === 'true';
+
+    if (noReload) {
+      return;
     }
 
     const endPointExtras = keepExtras(extras);
-    
+
     if (oidcServerConfiguration.endSessionEndpoint) {
-        if (!('id_token_hint' in endPointExtras)) {
-            endPointExtras['id_token_hint'] = idToken;
-        }
-        if (!('post_logout_redirect_uri' in endPointExtras) && callbackPathOrUrl !== null) {
-            endPointExtras['post_logout_redirect_uri'] = url;
+      if (!('id_token_hint' in endPointExtras)) {
+        endPointExtras['id_token_hint'] = idToken;
+      }
+      if (!('post_logout_redirect_uri' in endPointExtras) && callbackPathOrUrl !== null) {
+        endPointExtras['post_logout_redirect_uri'] = url;
+      }
+      let queryString = '';
+      for (const [key, value] of Object.entries(endPointExtras)) {
+        if (value !== null && value !== undefined) {
+          if (queryString === '') {
+            queryString += '?';
+          } else {
+            queryString += '&';
+          }
+          queryString += `${key}=${encodeURIComponent(value)}`;
         }
-        let queryString = '';
-        for (const [key, value] of Object.entries(endPointExtras)) {
-            if(value !== null && value !== undefined) {
-                if (queryString === '') {
-                    queryString += '?';
-                } else {
-                    queryString += '&';
-                }
-                queryString += `${key}=${encodeURIComponent(value)}`;
-            }
-        }
-        oicLocation.open(`${oidcServerConfiguration.endSessionEndpoint}${queryString}`);
+      }
+      oicLocation.open(`${oidcServerConfiguration.endSessionEndpoint}${queryString}`);
     } else {
-        oicLocation.reload();
+      oicLocation.reload();
     }
-};
+  };