feat: add e2e test for logout

Author: jsjoeio

lib/vscode/src/vs/server/common/cookie.ts

@@ -1,3 +1,3 @@
 export enum Cookie {
-  Key = "key",
-}
+  Key = 'key',
+}

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;
 	}

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 {

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`)
+  })
+})