Skip to content

Commit

Permalink
Fixed the tenant switching after timeout (opensearch-project#1090)
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Liang <[email protected]>
  • Loading branch information
RyanL1997 authored Sep 14, 2022
1 parent 7e4b6c3 commit 5d018b0
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 17 deletions.
48 changes: 48 additions & 0 deletions public/apps/account/test/plugin.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* Copyright OpenSearch Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

import { interceptError } from '../../../utils/logout-utils';
import { setShouldShowTenantPopup } from '../../../utils/storage-utils';
import { LOGIN_PAGE_URI } from '../../../../common';

jest.mock('../../../utils/storage-utils', () => ({
setShouldShowTenantPopup: jest.fn(),
}));

describe('Intercept error handler', () => {
const fakeError401 = {
response: {
status: 401,
},
};

const fakeError400 = {
response: {
status: 400,
},
};

it('Intercept error handler Should call setShouldShowTenantPopup on session timeout', () => {
const sessionTimeoutFn = interceptError(LOGIN_PAGE_URI, window);
sessionTimeoutFn(fakeError401, null);
expect(setShouldShowTenantPopup).toBeCalledTimes(1);
});

it('Intercept error handler Should not call setShouldShowTenantPopup on session timeout', () => {
const sessionTimeoutFn = interceptError(LOGIN_PAGE_URI, window);
sessionTimeoutFn(fakeError400, null);
expect(setShouldShowTenantPopup).toBeCalledTimes(0);
});
});
19 changes: 2 additions & 17 deletions public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ import {
SecurityPluginStart,
} from './types';
import { addTenantToShareURL } from './services/shared-link';
import { interceptError } from './utils/logout-utils';

async function hasApiPermission(core: CoreSetup): Promise<boolean | undefined> {
try {
Expand Down Expand Up @@ -149,23 +150,7 @@ export class SecurityPlugin implements Plugin<SecurityPluginSetup, SecurityPlugi
if (config.ui.autologout) {
// logout the user when getting 401 unauthorized, e.g. when session timed out.
core.http.intercept({
responseError: (httpErrorResponse, controller) => {
if (
httpErrorResponse.response?.status === 401 &&
!(
window.location.pathname.toLowerCase().includes(LOGIN_PAGE_URI) ||
window.location.pathname.toLowerCase().includes(CUSTOM_ERROR_PAGE_URI)
)
) {
if (config.auth.logout_url) {
window.location.href = config.auth.logout_url;
} else {
// when session timed out, user credentials in cookie are wiped out
// refres the page will direct the user to go through login process
window.location.reload();
}
}
},
responseError: interceptError(config.auth.logout_url, window),
});
}

Expand Down
43 changes: 43 additions & 0 deletions public/utils/logout-utils.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
* Copyright OpenSearch Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

import { setShouldShowTenantPopup } from './storage-utils';
import {
HttpInterceptorResponseError,
IHttpInterceptController,
} from '../../../../src/core/public';
import { CUSTOM_ERROR_PAGE_URI, LOGIN_PAGE_URI } from '../../common';

export function interceptError(logoutUrl: string, thisWindow: Window): any {
return (httpErrorResponse: HttpInterceptorResponseError, _: IHttpInterceptController) => {
if (httpErrorResponse.response?.status === 401) {
setShouldShowTenantPopup(null);
if (
!(
thisWindow.location.pathname.toLowerCase().includes(LOGIN_PAGE_URI) ||
thisWindow.location.pathname.toLowerCase().includes(CUSTOM_ERROR_PAGE_URI)
)
) {
if (logoutUrl) {
thisWindow.location.href = logoutUrl;
} else {
// when session timed out, user credentials in cookie are wiped out
// refres the page will direct the user to go through login process
thisWindow.location.reload();
}
}
}
};
}

0 comments on commit 5d018b0

Please sign in to comment.