chore: update cSpell and fix isNotificationTextPrefixed (#4076)

jsjoeio · web-flow · commit b8bd3208caa0 · 2022-09-15T16:59:22.000-03:00
* chore: update cSpell words

* chore: add ignorePaths for cSpell

* fix: update isNotificationTextPrefixed

This removes an eslint-disable rule and adds two new tests to ensure
isNotificationTextPrefixed is working as expected.

* fix(e2e): remove filter in workspacesPage
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -8,6 +8,8 @@
     "circbuf",
     "cliflag",
     "cliui",
+    "codecov",
+    "Codespaces",
     "coderd",
     "coderdtest",
     "codersdk",
@@ -80,6 +82,7 @@
     "ptty",
     "ptys",
     "ptytest",
+    "quickstart",
     "reconfig",
     "retrier",
     "rpty",
@@ -117,10 +120,12 @@
     "tstun",
     "turnconn",
     "typegen",
+    "typesafe",
     "unconvert",
     "Untar",
     "Userspace",
     "VMID",
+    "walkthrough",
     "weblinks",
     "webrtc",
     "wgcfg",
@@ -140,6 +145,10 @@
     "xstate",
     "yamux"
   ],
+  "cSpell.ignorePaths": [
+    "site/package.json",
+    ".vscode/settings.json"
+  ],
   "emeraldwalk.runonsave": {
     "commands": [
       {
diff --git a/site/e2e/tests/login.spec.ts b/site/e2e/tests/login.spec.ts
@@ -1,7 +1,6 @@
 import { test } from "@playwright/test"
 import { email, password } from "../constants"
-import { SignInPage, WorkspacesPage } from "../pom"
-import { waitForClientSideNavigation } from "./../util"
+import { SignInPage } from "../pom"
 
 test("Login takes user to /workspaces", async ({ baseURL, page }) => {
   await page.goto(baseURL + "/", { waitUntil: "networkidle" })
@@ -10,8 +9,5 @@ test("Login takes user to /workspaces", async ({ baseURL, page }) => {
   const signInPage = new SignInPage(baseURL, page)
   await signInPage.submitBuiltInAuthentication(email, password)
 
-  const workspacesPage = new WorkspacesPage(baseURL, page, "?filter=owner%3Ame")
-  await waitForClientSideNavigation(page, { to: workspacesPage.url })
-
   await page.waitForSelector("text=Workspaces")
 })
diff --git a/site/e2e/util.ts b/site/e2e/util.ts
diff --git a/site/src/components/GlobalSnackbar/utils.test.ts b/site/src/components/GlobalSnackbar/utils.test.ts
@@ -4,6 +4,7 @@ import {
   isNotificationTextPrefixed,
   MsgType,
   NotificationMsg,
+  NotificationTextPrefixed,
   SnackbarEventType,
 } from "./utils"
 
@@ -17,6 +18,29 @@ describe("Snackbar", () => {
       // When
       const isTextPrefixed = isNotificationTextPrefixed(msg)
 
+      // Then
+      expect(isTextPrefixed).toBe(false)
+    })
+    it("returns true if prefixed", () => {
+      // Given
+      const msg: NotificationTextPrefixed = {
+        prefix: "warning",
+        text: "careful with this workspace",
+      }
+
+      // When
+      const isTextPrefixed = isNotificationTextPrefixed(msg)
+
+      // Then
+      expect(isTextPrefixed).toBe(true)
+    })
+    it("returns false if not prefixed", () => {
+      // Given
+      const msg = "plain ol' message"
+
+      // When
+      const isTextPrefixed = isNotificationTextPrefixed(msg)
+
       // Then
       expect(isTextPrefixed).toBe(false)
     })
diff --git a/site/src/components/GlobalSnackbar/utils.ts b/site/src/components/GlobalSnackbar/utils.ts
@@ -27,8 +27,10 @@ export const isNotificationText = (msg: AdditionalMessage): msg is string => {
 export const isNotificationTextPrefixed = (
   msg: AdditionalMessage | null,
 ): msg is NotificationTextPrefixed => {
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  return typeof (msg as NotificationTextPrefixed)?.prefix !== "undefined"
+  if (msg) {
+    return typeof msg !== "string" && Object.prototype.hasOwnProperty.call(msg, "prefix")
+  }
+  return false
 }
 
 export const isNotificationList = (msg: AdditionalMessage): msg is string[] => {
