From ab78081f2fdaaab0a11b4d0a7a98b74e64fc7972 Mon Sep 17 00:00:00 2001 From: Bruno Date: Mon, 16 May 2022 18:30:29 +0000 Subject: [PATCH 1/3] chore: Rename Preferences to Settings --- site/src/AppRouter.tsx | 8 ++++---- .../SettingsAccountForm.tsx} | 4 ++-- .../SettingsLayout.tsx} | 10 +++++----- site/src/components/UserDropdown/UserDropdown.test.tsx | 2 +- site/src/components/UserDropdown/UsersDropdown.tsx | 2 +- .../AccountPage/AccountPage.test.tsx | 4 ++-- .../AccountPage/AccountPage.tsx | 2 +- .../AccountPage/LinkedAccountsPage.tsx | 0 .../SSHKeysPage/SSHKeysPage.test.tsx | 0 .../SSHKeysPage/SSHKeysPage.tsx | 0 site/src/xServices/auth/authXService.ts | 2 +- 11 files changed, 17 insertions(+), 17 deletions(-) rename site/src/components/{PreferencesAccountForm/PreferencesAccountForm.tsx => SettingsAccountForm/SettingsAccountForm.tsx} (95%) rename site/src/components/{PreferencesLayout/PreferencesLayout.tsx => SettingsLayout/SettingsLayout.tsx} (65%) rename site/src/pages/{PreferencesPages => SettingsPages}/AccountPage/AccountPage.test.tsx (95%) rename site/src/pages/{PreferencesPages => SettingsPages}/AccountPage/AccountPage.tsx (93%) rename site/src/pages/{PreferencesPages => SettingsPages}/AccountPage/LinkedAccountsPage.tsx (100%) rename site/src/pages/{PreferencesPages => SettingsPages}/SSHKeysPage/SSHKeysPage.test.tsx (100%) rename site/src/pages/{PreferencesPages => SettingsPages}/SSHKeysPage/SSHKeysPage.tsx (100%) diff --git a/site/src/AppRouter.tsx b/site/src/AppRouter.tsx index 782915af565a7..c7da46f5fcb1b 100644 --- a/site/src/AppRouter.tsx +++ b/site/src/AppRouter.tsx @@ -1,17 +1,17 @@ import React from "react" import { Route, Routes } from "react-router-dom" import { AuthAndFrame } from "./components/AuthAndFrame/AuthAndFrame" -import { PreferencesLayout } from "./components/PreferencesLayout/PreferencesLayout" import { RequireAuth } from "./components/RequireAuth/RequireAuth" +import { SettingsLayout } from "./components/SettingsLayout/SettingsLayout" import { IndexPage } from "./pages" import { NotFoundPage } from "./pages/404Page/404Page" import { CliAuthenticationPage } from "./pages/CliAuthPage/CliAuthPage" import { HealthzPage } from "./pages/HealthzPage/HealthzPage" import { LoginPage } from "./pages/LoginPage/LoginPage" import { OrgsPage } from "./pages/OrgsPage/OrgsPage" -import { AccountPage } from "./pages/PreferencesPages/AccountPage/AccountPage" -import { SSHKeysPage } from "./pages/PreferencesPages/SSHKeysPage/SSHKeysPage" import { SettingsPage } from "./pages/SettingsPage/SettingsPage" +import { AccountPage } from "./pages/SettingsPages/AccountPage/AccountPage" +import { SSHKeysPage } from "./pages/SettingsPages/SSHKeysPage/SSHKeysPage" import { CreateWorkspacePage } from "./pages/TemplatesPages/OrganizationPage/TemplatePage/CreateWorkspacePage" import { TemplatePage } from "./pages/TemplatesPages/OrganizationPage/TemplatePage/TemplatePage" import { TemplatesPage } from "./pages/TemplatesPages/TemplatesPage" @@ -131,7 +131,7 @@ export const AppRouter: React.FC = () => ( } /> - }> + }> } /> } /> diff --git a/site/src/components/PreferencesAccountForm/PreferencesAccountForm.tsx b/site/src/components/SettingsAccountForm/SettingsAccountForm.tsx similarity index 95% rename from site/src/components/PreferencesAccountForm/PreferencesAccountForm.tsx rename to site/src/components/SettingsAccountForm/SettingsAccountForm.tsx index 5b950e4c6af37..3abbed65ad096 100644 --- a/site/src/components/PreferencesAccountForm/PreferencesAccountForm.tsx +++ b/site/src/components/SettingsAccountForm/SettingsAccountForm.tsx @@ -17,7 +17,7 @@ export const Language = { emailLabel: "Email", emailInvalid: "Please enter a valid email address.", emailRequired: "Please enter an email address.", - updatePreferences: "Update preferences", + updateSettings: "Update settings", } const validationSchema = Yup.object({ @@ -73,7 +73,7 @@ export const AccountForm: React.FC = ({
- {isLoading ? "" : Language.updatePreferences} + {isLoading ? "" : Language.updateSettings}
diff --git a/site/src/components/PreferencesLayout/PreferencesLayout.tsx b/site/src/components/SettingsLayout/SettingsLayout.tsx similarity index 65% rename from site/src/components/PreferencesLayout/PreferencesLayout.tsx rename to site/src/components/SettingsLayout/SettingsLayout.tsx index e30bf8d0453d4..d02b48a696d5a 100644 --- a/site/src/components/PreferencesLayout/PreferencesLayout.tsx +++ b/site/src/components/SettingsLayout/SettingsLayout.tsx @@ -8,20 +8,20 @@ import { TabPanel } from "../TabPanel/TabPanel" export const Language = { accountLabel: "Account", sshKeysLabel: "SSH Keys", - preferencesLabel: "Preferences", + settingsLabel: "Settings", } const menuItems = [ - { label: Language.accountLabel, path: "/preferences/account" }, - { label: Language.sshKeysLabel, path: "/preferences/ssh-keys" }, + { label: Language.accountLabel, path: "/settings/account" }, + { label: Language.sshKeysLabel, path: "/settings/ssh-keys" }, ] -export const PreferencesLayout: React.FC = () => { +export const SettingsLayout: React.FC = () => { return ( - + diff --git a/site/src/components/UserDropdown/UserDropdown.test.tsx b/site/src/components/UserDropdown/UserDropdown.test.tsx index c0e7e16f86226..3a71246eaa9e4 100644 --- a/site/src/components/UserDropdown/UserDropdown.test.tsx +++ b/site/src/components/UserDropdown/UserDropdown.test.tsx @@ -63,6 +63,6 @@ describe("UserDropdown", () => { throw new Error("Anchor tag not found for the account menu item") } - expect(link.getAttribute("href")).toBe("/preferences/account") + expect(link.getAttribute("href")).toBe("/settings/account") }) }) diff --git a/site/src/components/UserDropdown/UsersDropdown.tsx b/site/src/components/UserDropdown/UsersDropdown.tsx index fad788b95c03f..dc61cd6215302 100644 --- a/site/src/components/UserDropdown/UsersDropdown.tsx +++ b/site/src/components/UserDropdown/UsersDropdown.tsx @@ -68,7 +68,7 @@ export const UserDropdown: React.FC = ({ user, onSignOut }: U - + diff --git a/site/src/pages/PreferencesPages/AccountPage/AccountPage.test.tsx b/site/src/pages/SettingsPages/AccountPage/AccountPage.test.tsx similarity index 95% rename from site/src/pages/PreferencesPages/AccountPage/AccountPage.test.tsx rename to site/src/pages/SettingsPages/AccountPage/AccountPage.test.tsx index 492e3d8ee25cd..1e36c150bb30e 100644 --- a/site/src/pages/PreferencesPages/AccountPage/AccountPage.test.tsx +++ b/site/src/pages/SettingsPages/AccountPage/AccountPage.test.tsx @@ -2,7 +2,7 @@ import { fireEvent, screen, waitFor } from "@testing-library/react" import React from "react" import * as API from "../../../api/api" import { GlobalSnackbar } from "../../../components/GlobalSnackbar/GlobalSnackbar" -import * as AccountForm from "../../../components/PreferencesAccountForm/PreferencesAccountForm" +import * as AccountForm from "../../../components/SettingsAccountForm/SettingsAccountForm" import { renderWithAuth } from "../../../testHelpers/renderHelpers" import * as AuthXService from "../../../xServices/auth/authXService" import { AccountPage, Language } from "./AccountPage" @@ -25,7 +25,7 @@ const fillAndSubmitForm = async () => { await waitFor(() => screen.findByLabelText("Email")) fireEvent.change(screen.getByLabelText("Email"), { target: { value: newData.email } }) fireEvent.change(screen.getByLabelText("Username"), { target: { value: newData.username } }) - fireEvent.click(screen.getByText(AccountForm.Language.updatePreferences)) + fireEvent.click(screen.getByText(AccountForm.Language.updateSettings)) } describe("AccountPage", () => { diff --git a/site/src/pages/PreferencesPages/AccountPage/AccountPage.tsx b/site/src/pages/SettingsPages/AccountPage/AccountPage.tsx similarity index 93% rename from site/src/pages/PreferencesPages/AccountPage/AccountPage.tsx rename to site/src/pages/SettingsPages/AccountPage/AccountPage.tsx index df778cffbbe2f..5f9cf4282028d 100644 --- a/site/src/pages/PreferencesPages/AccountPage/AccountPage.tsx +++ b/site/src/pages/SettingsPages/AccountPage/AccountPage.tsx @@ -1,8 +1,8 @@ import { useActor } from "@xstate/react" import React, { useContext } from "react" import { isApiError, mapApiErrorToFieldErrors } from "../../../api/errors" -import { AccountForm } from "../../../components/PreferencesAccountForm/PreferencesAccountForm" import { Section } from "../../../components/Section/Section" +import { AccountForm } from "../../../components/SettingsAccountForm/SettingsAccountForm" import { XServiceContext } from "../../../xServices/StateContext" export const Language = { diff --git a/site/src/pages/PreferencesPages/AccountPage/LinkedAccountsPage.tsx b/site/src/pages/SettingsPages/AccountPage/LinkedAccountsPage.tsx similarity index 100% rename from site/src/pages/PreferencesPages/AccountPage/LinkedAccountsPage.tsx rename to site/src/pages/SettingsPages/AccountPage/LinkedAccountsPage.tsx diff --git a/site/src/pages/PreferencesPages/SSHKeysPage/SSHKeysPage.test.tsx b/site/src/pages/SettingsPages/SSHKeysPage/SSHKeysPage.test.tsx similarity index 100% rename from site/src/pages/PreferencesPages/SSHKeysPage/SSHKeysPage.test.tsx rename to site/src/pages/SettingsPages/SSHKeysPage/SSHKeysPage.test.tsx diff --git a/site/src/pages/PreferencesPages/SSHKeysPage/SSHKeysPage.tsx b/site/src/pages/SettingsPages/SSHKeysPage/SSHKeysPage.tsx similarity index 100% rename from site/src/pages/PreferencesPages/SSHKeysPage/SSHKeysPage.tsx rename to site/src/pages/SettingsPages/SSHKeysPage/SSHKeysPage.tsx diff --git a/site/src/xServices/auth/authXService.ts b/site/src/xServices/auth/authXService.ts index c5958ca566368..d9e88a3c72f37 100644 --- a/site/src/xServices/auth/authXService.ts +++ b/site/src/xServices/auth/authXService.ts @@ -4,7 +4,7 @@ import * as TypesGen from "../../api/typesGenerated" import { displayError, displaySuccess } from "../../components/GlobalSnackbar/utils" export const Language = { - successProfileUpdate: "Updated preferences.", + successProfileUpdate: "Updated settings.", successRegenerateSSHKey: "SSH Key regenerated successfully", errorRegenerateSSHKey: "Error on regenerate the SSH Key", } From d3a90220b8939bb21b6f93545a5fef5589b2149a Mon Sep 17 00:00:00 2001 From: Bruno Date: Mon, 16 May 2022 18:31:27 +0000 Subject: [PATCH 2/3] Rename menu item to be settings --- site/src/components/UserDropdown/UserDropdown.test.tsx | 4 ++-- site/src/components/UserDropdown/UsersDropdown.tsx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/site/src/components/UserDropdown/UserDropdown.test.tsx b/site/src/components/UserDropdown/UserDropdown.test.tsx index 3a71246eaa9e4..83ec19c15b1ea 100644 --- a/site/src/components/UserDropdown/UserDropdown.test.tsx +++ b/site/src/components/UserDropdown/UserDropdown.test.tsx @@ -26,7 +26,7 @@ describe("UserDropdown", () => { describe("when the trigger is clicked", () => { it("opens the menu", async () => { await renderAndClick() - expect(screen.getByText(Language.accountLabel)).toBeDefined() + expect(screen.getByText(Language.settingsLabel)).toBeDefined() expect(screen.getByText(Language.docsLabel)).toBeDefined() expect(screen.getByText(Language.signOutLabel)).toBeDefined() }) @@ -58,7 +58,7 @@ describe("UserDropdown", () => { it("has the correct link for the account item", async () => { await renderAndClick() - const link = screen.getByText(Language.accountLabel).closest("a") + const link = screen.getByText(Language.settingsLabel).closest("a") if (!link) { throw new Error("Anchor tag not found for the account menu item") } diff --git a/site/src/components/UserDropdown/UsersDropdown.tsx b/site/src/components/UserDropdown/UsersDropdown.tsx index dc61cd6215302..25e246b0a2c0d 100644 --- a/site/src/components/UserDropdown/UsersDropdown.tsx +++ b/site/src/components/UserDropdown/UsersDropdown.tsx @@ -16,7 +16,7 @@ import { UserAvatar } from "../UserAvatar/UserAvatar" import { UserProfileCard } from "../UserProfileCard/UserProfileCard" export const Language = { - accountLabel: "Account", + settingsLabel: "Settings", docsLabel: "Documentation", signOutLabel: "Sign Out", } @@ -73,7 +73,7 @@ export const UserDropdown: React.FC = ({ user, onSignOut }: U - + From 3ef67f11a5f1a89dbdf27777370a7b58c7851275 Mon Sep 17 00:00:00 2001 From: Bruno Date: Mon, 16 May 2022 18:33:47 +0000 Subject: [PATCH 3/3] Revert dropdown change --- site/src/components/UserDropdown/UserDropdown.test.tsx | 4 ++-- site/src/components/UserDropdown/UsersDropdown.tsx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/site/src/components/UserDropdown/UserDropdown.test.tsx b/site/src/components/UserDropdown/UserDropdown.test.tsx index 83ec19c15b1ea..3a71246eaa9e4 100644 --- a/site/src/components/UserDropdown/UserDropdown.test.tsx +++ b/site/src/components/UserDropdown/UserDropdown.test.tsx @@ -26,7 +26,7 @@ describe("UserDropdown", () => { describe("when the trigger is clicked", () => { it("opens the menu", async () => { await renderAndClick() - expect(screen.getByText(Language.settingsLabel)).toBeDefined() + expect(screen.getByText(Language.accountLabel)).toBeDefined() expect(screen.getByText(Language.docsLabel)).toBeDefined() expect(screen.getByText(Language.signOutLabel)).toBeDefined() }) @@ -58,7 +58,7 @@ describe("UserDropdown", () => { it("has the correct link for the account item", async () => { await renderAndClick() - const link = screen.getByText(Language.settingsLabel).closest("a") + const link = screen.getByText(Language.accountLabel).closest("a") if (!link) { throw new Error("Anchor tag not found for the account menu item") } diff --git a/site/src/components/UserDropdown/UsersDropdown.tsx b/site/src/components/UserDropdown/UsersDropdown.tsx index 25e246b0a2c0d..dc61cd6215302 100644 --- a/site/src/components/UserDropdown/UsersDropdown.tsx +++ b/site/src/components/UserDropdown/UsersDropdown.tsx @@ -16,7 +16,7 @@ import { UserAvatar } from "../UserAvatar/UserAvatar" import { UserProfileCard } from "../UserProfileCard/UserProfileCard" export const Language = { - settingsLabel: "Settings", + accountLabel: "Account", docsLabel: "Documentation", signOutLabel: "Sign Out", } @@ -73,7 +73,7 @@ export const UserDropdown: React.FC = ({ user, onSignOut }: U - +