feat: add audit page title, subtitle, and CLI snippet (#3419)

Kira-Pilot · web-flow · commit e62677efabaf · 2022-08-08T21:08:36.000-04:00
* resolves #3356 * scaffolded out new audit page header resolves #3357 * added tests and stories * run prettier
diff --git a/site/src/components/CodeExample/CodeExample.tsx b/site/src/components/CodeExample/CodeExample.tsx
@@ -8,18 +8,28 @@ export interface CodeExampleProps {
   code: string
   className?: string
   buttonClassName?: string
+  tooltipTitle?: string
 }
 
 /**
  * Component to show single-line code examples, with a copy button
  */
-export const CodeExample: FC<CodeExampleProps> = ({ code, className, buttonClassName }) => {
+export const CodeExample: FC<CodeExampleProps> = ({
+  code,
+  className,
+  buttonClassName,
+  tooltipTitle,
+}) => {
   const styles = useStyles()
 
   return (
     <div className={combineClasses([styles.root, className])}>
       <code className={styles.code}>{code}</code>
-      <CopyButton text={code} buttonClassName={combineClasses([styles.button, buttonClassName])} />
+      <CopyButton
+        text={code}
+        tooltipTitle={tooltipTitle}
+        buttonClassName={combineClasses([styles.button, buttonClassName])}
+      />
     </div>
   )
 }
diff --git a/site/src/components/CopyButton/CopyButton.tsx b/site/src/components/CopyButton/CopyButton.tsx
@@ -11,6 +11,12 @@ interface CopyButtonProps {
   ctaCopy?: string
   wrapperClassName?: string
   buttonClassName?: string
+  tooltipTitle?: string
+}
+
+export const Language = {
+  tooltipTitle: "Copy to clipboard",
+  ariaLabel: "Copy to clipboard",
 }
 
 /**
@@ -21,6 +27,7 @@ export const CopyButton: React.FC<CopyButtonProps> = ({
   ctaCopy,
   wrapperClassName = "",
   buttonClassName = "",
+  tooltipTitle = Language.tooltipTitle,
 }) => {
   const styles = useStyles()
   const [isCopied, setIsCopied] = useState<boolean>(false)
@@ -56,12 +63,13 @@ export const CopyButton: React.FC<CopyButtonProps> = ({
   }
 
   return (
-    <Tooltip title="Copy to Clipboard" placement="top">
+    <Tooltip title={tooltipTitle} placement="top">
       <div className={combineClasses([styles.copyButtonWrapper, wrapperClassName])}>
         <IconButton
           className={combineClasses([styles.copyButton, buttonClassName])}
           onClick={copyToClipboard}
           size="small"
+          aria-label={Language.ariaLabel}
         >
           {isCopied ? (
             <Check className={styles.fileCopyIcon} />
diff --git a/site/src/components/Stack/Stack.tsx b/site/src/components/Stack/Stack.tsx
@@ -5,40 +5,39 @@ import { combineClasses } from "../../util/combineClasses"
 
 type Direction = "column" | "row"
 
-interface StyleProps {
-  direction: Direction
-  spacing: number
+export interface StackProps {
+  className?: string
+  direction?: Direction
+  spacing?: number
   alignItems?: CSSProperties["alignItems"]
+  justifyContent?: CSSProperties["justifyContent"]
 }
 
+type StyleProps = Omit<StackProps, "className">
+
 const useStyles = makeStyles((theme) => ({
   stack: {
     display: "flex",
     flexDirection: ({ direction }: StyleProps) => direction,
-    gap: ({ spacing }: StyleProps) => theme.spacing(spacing),
+    gap: ({ spacing }: StyleProps) => spacing && theme.spacing(spacing),
     alignItems: ({ alignItems }: StyleProps) => alignItems,
+    justifyContent: ({ justifyContent }: StyleProps) => justifyContent,
 
     [theme.breakpoints.down("sm")]: {
       width: "100%",
     },
   },
 }))
 
-export interface StackProps {
-  className?: string
-  direction?: Direction
-  spacing?: number
-  alignItems?: CSSProperties["alignItems"]
-}
-
 export const Stack: FC<StackProps> = ({
   children,
   className,
   direction = "column",
   spacing = 2,
   alignItems,
+  justifyContent,
 }) => {
-  const styles = useStyles({ spacing, direction, alignItems })
+  const styles = useStyles({ spacing, direction, alignItems, justifyContent })
 
   return <div className={combineClasses([styles.stack, className])}>{children}</div>
 }
diff --git a/site/src/components/Tooltips/AuditHelpTooltip.tsx b/site/src/components/Tooltips/AuditHelpTooltip.tsx
@@ -0,0 +1,16 @@
+import { FC } from "react"
+import { HelpTooltip, HelpTooltipText, HelpTooltipTitle } from "./HelpTooltip"
+
+export const Language = {
+  title: "What is an audit log?",
+  body: "An audit log is a record of events and changes made throughout a system.",
+}
+
+export const AuditHelpTooltip: FC = () => {
+  return (
+    <HelpTooltip>
+      <HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
+      <HelpTooltipText>{Language.body}</HelpTooltipText>
+    </HelpTooltip>
+  )
+}
diff --git a/site/src/components/Tooltips/HelpTooltip/HelpTooltip.tsx b/site/src/components/Tooltips/HelpTooltip/HelpTooltip.tsx
@@ -15,6 +15,10 @@ export interface HelpTooltipProps {
   size?: Size
 }
 
+export const Language = {
+  ariaLabel: "tooltip",
+}
+
 const HelpTooltipContext = createContext<{ open: boolean; onClose: () => void } | undefined>(
   undefined,
 )
@@ -52,6 +56,7 @@ export const HelpTooltip: React.FC<HelpTooltipProps> = ({ children, open, size =
         onMouseEnter={() => {
           setIsOpen(true)
         }}
+        aria-label={Language.ariaLabel}
       >
         <HelpIcon className={styles.icon} />
       </button>
diff --git a/site/src/components/Tooltips/index.ts b/site/src/components/Tooltips/index.ts
@@ -1,4 +1,5 @@
 export { AgentHelpTooltip } from "./AgentHelpTooltip"
+export { AuditHelpTooltip } from "./AuditHelpTooltip"
 export { OutdatedHelpTooltip } from "./OutdatedHelpTooltip"
 export { ResourcesHelpTooltip } from "./ResourcesHelpTooltip"
 export { WorkspaceHelpTooltip } from "./WorkspaceHelpTooltip"
diff --git a/site/src/pages/AuditPage/AuditPage.test.tsx b/site/src/pages/AuditPage/AuditPage.test.tsx
@@ -0,0 +1,32 @@
+import { fireEvent, screen } from "@testing-library/react"
+import { Language as CopyButtonLanguage } from "components/CopyButton/CopyButton"
+import { Language as AuditTooltipLanguage } from "components/Tooltips/AuditHelpTooltip"
+import { Language as TooltipLanguage } from "components/Tooltips/HelpTooltip/HelpTooltip"
+import { render } from "testHelpers/renderHelpers"
+import AuditPage from "./AuditPage"
+import { Language as AuditViewLanguage } from "./AuditPageView"
+
+describe("AuditPage", () => {
+  it("renders a page with a title and subtitle", async () => {
+    // When
+    render(<AuditPage />)
+
+    // Then
+    await screen.findByText(AuditViewLanguage.title)
+    await screen.findByText(AuditViewLanguage.subtitle)
+    const tooltipIcon = await screen.findByRole("button", { name: TooltipLanguage.ariaLabel })
+    fireEvent.mouseOver(tooltipIcon)
+    expect(await screen.findByText(AuditTooltipLanguage.title)).toBeInTheDocument()
+  })
+
+  it("describes the CLI command", async () => {
+    // When
+    render(<AuditPage />)
+
+    // Then
+    await screen.findByText("coder audit [organization_ID]") // CLI command; untranslated
+    const copyIcon = await screen.findByRole("button", { name: CopyButtonLanguage.ariaLabel })
+    fireEvent.mouseOver(copyIcon)
+    expect(await screen.findByText(AuditViewLanguage.tooltipTitle)).toBeInTheDocument()
+  })
+})
diff --git a/site/src/pages/AuditPage/AuditPage.tsx b/site/src/pages/AuditPage/AuditPage.tsx
@@ -1,8 +1,9 @@
 import { FC } from "react"
+import { AuditPageView } from "./AuditPageView"
 
 // REMARK: This page is in-progress and hidden from users
 const AuditPage: FC = () => {
-  return <div>Audit</div>
+  return <AuditPageView />
 }
 
 export default AuditPage
diff --git a/site/src/pages/AuditPage/AuditPageView.stories.tsx b/site/src/pages/AuditPage/AuditPageView.stories.tsx
@@ -0,0 +1,16 @@
+import { ComponentMeta, Story } from "@storybook/react"
+import { AuditPageView } from "./AuditPageView"
+
+export default {
+  title: "pages/AuditPageView",
+  component: AuditPageView,
+} as ComponentMeta<typeof AuditPageView>
+
+const Template: Story = (args) => <AuditPageView {...args} />
+
+export const AuditPage = Template.bind({})
+
+export const AuditPageSmallViewport = Template.bind({})
+AuditPageSmallViewport.parameters = {
+  chromatic: { viewports: [600] },
+}
diff --git a/site/src/pages/AuditPage/AuditPageView.tsx b/site/src/pages/AuditPage/AuditPageView.tsx
@@ -0,0 +1,59 @@
+import { makeStyles } from "@material-ui/core/styles"
+import { CodeExample } from "components/CodeExample/CodeExample"
+import { Margins } from "components/Margins/Margins"
+import { PageHeader, PageHeaderSubtitle, PageHeaderTitle } from "components/PageHeader/PageHeader"
+import { Stack } from "components/Stack/Stack"
+import { AuditHelpTooltip } from "components/Tooltips"
+import { FC } from "react"
+
+export const Language = {
+  title: "Audit",
+  subtitle: "View events in your audit log.",
+  tooltipTitle: "Copy to clipboard and try the Coder CLI",
+}
+
+export const AuditPageView: FC = () => {
+  const styles = useStyles()
+
+  return (
+    <Margins>
+      <Stack justifyContent="space-between" className={styles.headingContainer}>
+        <PageHeader className={styles.headingStyles}>
+          <PageHeaderTitle>
+            <Stack direction="row" spacing={1} alignItems="center">
+              <span>{Language.title}</span>
+              <AuditHelpTooltip />
+            </Stack>
+          </PageHeaderTitle>
+          <PageHeaderSubtitle>{Language.subtitle}</PageHeaderSubtitle>
+        </PageHeader>
+        <CodeExample
+          className={styles.codeExampleStyles}
+          tooltipTitle={Language.tooltipTitle}
+          code="coder audit [organization_ID]"
+        />
+      </Stack>
+    </Margins>
+  )
+}
+
+const useStyles = makeStyles((theme) => ({
+  headingContainer: {
+    marginTop: theme.spacing(6),
+    marginBottom: theme.spacing(5),
+    flexDirection: "row",
+    alignItems: "center",
+
+    [theme.breakpoints.down("sm")]: {
+      flexDirection: "column",
+      alignItems: "start",
+    },
+  },
+  headingStyles: {
+    paddingTop: "0px",
+    paddingBottom: "0px",
+  },
+  codeExampleStyles: {
+    height: "fit-content",
+  },
+}))

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,10 @@ export interface HelpTooltipProps {`
`15`	`15`	`size?: Size`
`16`	`16`	`}`
`17`	`17`
	`18`	`+export const Language = {`
	`19`	`+ ariaLabel: "tooltip",`
	`20`	`+}`
	`21`	`+`
`18`	`22`	`const HelpTooltipContext = createContext<{ open: boolean; onClose: () => void } \| undefined>(`
`19`	`23`	`undefined,`
`20`	`24`	`)`
`@@ -52,6 +56,7 @@ export const HelpTooltip: React.FC<HelpTooltipProps> = ({ children, open, size =`
`52`	`56`	`onMouseEnter={() => {`
`53`	`57`	`setIsOpen(true)`
`54`	`58`	`}}`
	`59`	`+ aria-label={Language.ariaLabel}`
`55`	`60`	`>`
`56`	`61`	`<HelpIcon className={styles.icon} />`
`57`	`62`	`</button>`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`import { FC } from "react"`
	`2`	`+import { AuditPageView } from "./AuditPageView"`
`2`	`3`
`3`	`4`	`// REMARK: This page is in-progress and hidden from users`
`4`	`5`	`const AuditPage: FC = () => {`
`5`		`- return <div>Audit</div>`
	`6`	`+ return <AuditPageView />`
`6`	`7`	`}`
`7`	`8`
`8`	`9`	`export default AuditPage`