From 9f790fd2f32e6fbcee0300d8b47be187d9937c9e Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 17 Mar 2021 15:34:17 -0700 Subject: [PATCH 1/4] feat(lib/vscode): add log out to application menu This adds a new option to the Application Menu called Log out. It deletes the code-server cookie and logs a user out. --- .../browser/parts/titlebar/menubarControl.ts | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts b/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts index 7b4220fdb..d241c5fb9 100644 --- a/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts +++ b/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts @@ -9,6 +9,7 @@ import { registerThemingParticipant, IThemeService } from 'vs/platform/theme/com import { MenuBarVisibility, getTitleBarStyle, IWindowOpenable, getMenuBarVisibility } from 'vs/platform/windows/common/windows'; import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey'; import { IAction, Action, SubmenuAction, Separator } from 'vs/base/common/actions'; +import * as DOM from 'vs/base/browser/dom'; import { addDisposableListener, Dimension, EventType } from 'vs/base/browser/dom'; import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding'; import { isMacintosh, isWeb, isIOS, isNative } from 'vs/base/common/platform'; @@ -38,6 +39,7 @@ import { KeyCode } from 'vs/base/common/keyCodes'; import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry'; import { IsWebContext } from 'vs/platform/contextkey/common/contextkeys'; import { ICommandService } from 'vs/platform/commands/common/commands'; +import { ILogService } from 'vs/platform/log/common/log'; export abstract class MenubarControl extends Disposable { @@ -312,7 +314,8 @@ export class CustomMenubarControl extends MenubarControl { @IThemeService private readonly themeService: IThemeService, @IWorkbenchLayoutService private readonly layoutService: IWorkbenchLayoutService, @IHostService protected readonly hostService: IHostService, - @ICommandService commandService: ICommandService + @ICommandService commandService: ICommandService, + @ILogService private readonly logService: ILogService ) { super(menuService, workspacesService, contextKeyService, keybindingService, configurationService, labelService, updateService, storageService, notificationService, preferencesService, environmentService, accessibilityService, hostService, commandService); @@ -711,6 +714,28 @@ export class CustomMenubarControl extends MenubarControl { webNavigationActions.pop(); } + webNavigationActions.push(new Action('logout', localize('logout', "Log out"), undefined, true, + async (event?: MouseEvent) => { + const COOKIE_KEY = 'key'; + const loginCookie = DOM.getCookieValue(COOKIE_KEY); + + this.logService.info('Logging out of code-server'); + + if(loginCookie) { + this.logService.info(`Removing cookie under ${COOKIE_KEY}`); + + if (document && document.cookie) { + // We delete the cookie by setting the expiration to a date/time in the past + document.cookie = COOKIE_KEY +'=; Path=/; Expires=Thu, 01 Jan 1970 00:00:01 GMT;'; + window.location.href = '/login'; + } else { + this.logService.warn('Could not delete cookie because document and/or document.cookie is undefined'); + } + } else { + this.logService.warn('Could not log out because we could not find cookie'); + } + })) + return webNavigationActions; } From 5cec6208d0da6863e5db0535da210b485c799825 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 17 Mar 2021 16:08:25 -0700 Subject: [PATCH 2/4] refactor: add cookie.ts to lib/vscode --- lib/vscode/src/vs/server/common/cookie.ts | 3 +++ .../vs/workbench/browser/parts/titlebar/menubarControl.ts | 1 + src/node/routes/login.ts | 5 +---- 3 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 lib/vscode/src/vs/server/common/cookie.ts diff --git a/lib/vscode/src/vs/server/common/cookie.ts b/lib/vscode/src/vs/server/common/cookie.ts new file mode 100644 index 000000000..88b3f108f --- /dev/null +++ b/lib/vscode/src/vs/server/common/cookie.ts @@ -0,0 +1,3 @@ +export enum Cookie { + Key = "key", +} \ No newline at end of file diff --git a/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts b/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts index d241c5fb9..8059abc99 100644 --- a/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts +++ b/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts @@ -40,6 +40,7 @@ import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegis import { IsWebContext } from 'vs/platform/contextkey/common/contextkeys'; import { ICommandService } from 'vs/platform/commands/common/commands'; import { ILogService } from 'vs/platform/log/common/log'; +import { Cookie } from 'vs/server/common/cookie'; export abstract class MenubarControl extends Disposable { diff --git a/src/node/routes/login.ts b/src/node/routes/login.ts index b89470aea..a8835f750 100644 --- a/src/node/routes/login.ts +++ b/src/node/routes/login.ts @@ -3,14 +3,11 @@ import { promises as fs } from "fs" import { RateLimiter as Limiter } from "limiter" import * as path from "path" import safeCompare from "safe-compare" +import { Cookie } from "../../../lib/vscode/src/vs/server/common/cookie" import { rootPath } from "../constants" import { authenticated, getCookieDomain, redirect, replaceTemplates } from "../http" import { hash, humanPath } from "../util" -export enum Cookie { - Key = "key", -} - // RateLimiter wraps around the limiter library for logins. // It allows 2 logins every minute and 12 logins every hour. class RateLimiter { From 090687d0571a251a00e84b8436d1c2656d89f100 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 17 Mar 2021 16:23:17 -0700 Subject: [PATCH 3/4] feat: add e2e test for logout --- lib/vscode/src/vs/server/common/cookie.ts | 4 +- .../browser/parts/titlebar/menubarControl.ts | 9 ++- src/node/routes/login.ts | 5 +- test/e2e/logout.test.ts | 58 +++++++++++++++++++ 4 files changed, 68 insertions(+), 8 deletions(-) create mode 100644 test/e2e/logout.test.ts diff --git a/lib/vscode/src/vs/server/common/cookie.ts b/lib/vscode/src/vs/server/common/cookie.ts index 88b3f108f..e2720a04a 100644 --- a/lib/vscode/src/vs/server/common/cookie.ts +++ b/lib/vscode/src/vs/server/common/cookie.ts @@ -1,3 +1,3 @@ export enum Cookie { - Key = "key", -} \ No newline at end of file + Key = 'key', +} diff --git a/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts b/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts index 8059abc99..3951f29ce 100644 --- a/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts +++ b/lib/vscode/src/vs/workbench/browser/parts/titlebar/menubarControl.ts @@ -9,8 +9,7 @@ import { registerThemingParticipant, IThemeService } from 'vs/platform/theme/com import { MenuBarVisibility, getTitleBarStyle, IWindowOpenable, getMenuBarVisibility } from 'vs/platform/windows/common/windows'; import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey'; import { IAction, Action, SubmenuAction, Separator } from 'vs/base/common/actions'; -import * as DOM from 'vs/base/browser/dom'; -import { addDisposableListener, Dimension, EventType } from 'vs/base/browser/dom'; +import { addDisposableListener, Dimension, EventType, getCookieValue } from 'vs/base/browser/dom'; import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding'; import { isMacintosh, isWeb, isIOS, isNative } from 'vs/base/common/platform'; import { IConfigurationService, IConfigurationChangeEvent } from 'vs/platform/configuration/common/configuration'; @@ -717,8 +716,8 @@ export class CustomMenubarControl extends MenubarControl { webNavigationActions.push(new Action('logout', localize('logout', "Log out"), undefined, true, async (event?: MouseEvent) => { - const COOKIE_KEY = 'key'; - const loginCookie = DOM.getCookieValue(COOKIE_KEY); + const COOKIE_KEY = Cookie.Key; + const loginCookie = getCookieValue(COOKIE_KEY); this.logService.info('Logging out of code-server'); @@ -735,7 +734,7 @@ export class CustomMenubarControl extends MenubarControl { } else { this.logService.warn('Could not log out because we could not find cookie'); } - })) + })); return webNavigationActions; } diff --git a/src/node/routes/login.ts b/src/node/routes/login.ts index a8835f750..b89470aea 100644 --- a/src/node/routes/login.ts +++ b/src/node/routes/login.ts @@ -3,11 +3,14 @@ import { promises as fs } from "fs" import { RateLimiter as Limiter } from "limiter" import * as path from "path" import safeCompare from "safe-compare" -import { Cookie } from "../../../lib/vscode/src/vs/server/common/cookie" import { rootPath } from "../constants" import { authenticated, getCookieDomain, redirect, replaceTemplates } from "../http" import { hash, humanPath } from "../util" +export enum Cookie { + Key = "key", +} + // RateLimiter wraps around the limiter library for logins. // It allows 2 logins every minute and 12 logins every hour. class RateLimiter { diff --git a/test/e2e/logout.test.ts b/test/e2e/logout.test.ts new file mode 100644 index 000000000..71110562c --- /dev/null +++ b/test/e2e/logout.test.ts @@ -0,0 +1,58 @@ +import { chromium, Page, Browser, BrowserContext } from "playwright" +import { CODE_SERVER_ADDRESS, PASSWORD, E2E_VIDEO_DIR } from "../utils/constants" + +describe("logout", () => { + let browser: Browser + let page: Page + let context: BrowserContext + + beforeAll(async () => { + browser = await chromium.launch() + context = await browser.newContext({ + recordVideo: { dir: E2E_VIDEO_DIR }, + }) + }) + + afterAll(async () => { + await browser.close() + }) + + beforeEach(async () => { + page = await context.newPage() + }) + + afterEach(async () => { + await page.close() + // Remove password from local storage + await context.clearCookies() + }) + + it("should be able login and logout", async () => { + await page.goto(CODE_SERVER_ADDRESS) + // Type in password + await page.fill(".password", PASSWORD) + // Click the submit button and login + await page.click(".submit") + // See the editor + const codeServerEditor = await page.isVisible(".monaco-workbench") + expect(codeServerEditor).toBeTruthy() + + // Click the Application menu + await page.click("[aria-label='Application Menu']") + + // See the Log out button + const logoutButton = "a.action-menu-item span[aria-label='Log out']" + expect(await page.isVisible(logoutButton)) + + await page.hover(logoutButton) + + await page.click(logoutButton) + // it takes a second to navigate + // and since page.url comes back immediately + // we need this waitForNavigation, otherwise it will check + // before navigation has finished and fail + await page.waitForNavigation({ url: `${CODE_SERVER_ADDRESS}/login` }) + const currentUrl = page.url() + expect(currentUrl).toBe(`${CODE_SERVER_ADDRESS}/login`) + }) +}) From 9eff1f070249627e0434aaefcf6743731875721b Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Tue, 23 Mar 2021 12:14:42 -0700 Subject: [PATCH 4/4] fix: add timeout to logout test --- test/e2e/logout.test.ts | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/test/e2e/logout.test.ts b/test/e2e/logout.test.ts index 71110562c..74df799a5 100644 --- a/test/e2e/logout.test.ts +++ b/test/e2e/logout.test.ts @@ -47,11 +47,8 @@ describe("logout", () => { await page.hover(logoutButton) await page.click(logoutButton) - // it takes a second to navigate - // and since page.url comes back immediately - // we need this waitForNavigation, otherwise it will check - // before navigation has finished and fail - await page.waitForNavigation({ url: `${CODE_SERVER_ADDRESS}/login` }) + // it takes a couple seconds to navigate + await page.waitForTimeout(2000) const currentUrl = page.url() expect(currentUrl).toBe(`${CODE_SERVER_ADDRESS}/login`) })