Skip to content

feat: Add portforward to the UI #3812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 13, 2022
Merged

feat: Add portforward to the UI #3812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a6f976e
feat: Add portforward to the UI
BrunoQuaresma Sep 1, 2022
8556bc9
Update site/src/components/PortForwardButton/PortForwardButton.tsx
BrunoQuaresma Sep 2, 2022
8e7f8bd
Merge branch 'main' of github.com:coder/coder into bq/3516
BrunoQuaresma Sep 6, 2022
ba52fed
Add CODER_ENABLE_WILDCARD_APPS env var
BrunoQuaresma Sep 6, 2022
1072f96
Merge branch 'bq/3516' of github.com:coder/coder into bq/3516
BrunoQuaresma Sep 6, 2022
f0f7156
Fix portforward link
BrunoQuaresma Sep 9, 2022
e965305
Remove t file
BrunoQuaresma Sep 9, 2022
38a0f7b
Merge branch 'main' of github.com:coder/coder into bq/3516
BrunoQuaresma Sep 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions site/src/components/PortForwardButton/PortForwardButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Story } from "@storybook/react"
import { MockWorkspace, MockWorkspaceAgent } from "../../testHelpers/renderHelpers"
import { PortForwardButton, PortForwardButtonProps } from "./PortForwardButton"

export default {
title: "components/PortForwardButton",
component: PortForwardButton,
}

const Template: Story<PortForwardButtonProps> = (args) => <PortForwardButton {...args} />

export const Closed = Template.bind({})
Closed.args = {
username: MockWorkspace.owner_name,
workspaceName: MockWorkspace.name,
agentName: MockWorkspaceAgent.name,
}

export const Opened = Template.bind({})
Opened.args = {
username: MockWorkspace.owner_name,
workspaceName: MockWorkspace.name,
agentName: MockWorkspaceAgent.name,
defaultIsOpen: true,
}
131 changes: 131 additions & 0 deletions site/src/components/PortForwardButton/PortForwardButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
import Button from "@material-ui/core/Button"
import Link from "@material-ui/core/Link"
import Popover from "@material-ui/core/Popover"
import { makeStyles } from "@material-ui/core/styles"
import TextField from "@material-ui/core/TextField"
import OpenInNewOutlined from "@material-ui/icons/OpenInNewOutlined"
import { Stack } from "components/Stack/Stack"
import { useRef, useState } from "react"
import { colors } from "theme/colors"
import { CodeExample } from "../CodeExample/CodeExample"
import { HelpTooltipLink, HelpTooltipLinksGroup, HelpTooltipText } from "../Tooltips/HelpTooltip"

export interface PortForwardButtonProps {
username: string
workspaceName: string
agentName: string
defaultIsOpen?: boolean
}

export const PortForwardButton: React.FC<React.PropsWithChildren<PortForwardButtonProps>> = ({
workspaceName,
agentName,
username,
defaultIsOpen = false,
}) => {
const anchorRef = useRef<HTMLButtonElement>(null)
const [isOpen, setIsOpen] = useState(defaultIsOpen)
const id = isOpen ? "schedule-popover" : undefined
const styles = useStyles()
const [port, setPort] = useState("3000")
const { location } = window
const urlExample =
process.env.CODER_ENABLE_WILDCARD_APPS === "true"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be compiled by webpack, and isn't a dynamic environment variable at runtime. If we want to have a proper environment variable passed through, it'll have to come via the backend.

? `${location.protocol}//${port}--${agentName}--${workspaceName}--${username}.${location.host}`
: `${location.protocol}//${location.host}/@${username}/${workspaceName}.${agentName}/apps/${port}`

const onClose = () => {
setIsOpen(false)
}

return (
<>
<Button
startIcon={<OpenInNewOutlined />}
size="small"
ref={anchorRef}
onClick={() => {
setIsOpen(true)
}}
>
Port forward
</Button>
<Popover
classes={{ paper: styles.popoverPaper }}
id={id}
open={isOpen}
anchorEl={anchorRef.current}
onClose={onClose}
anchorOrigin={{
vertical: "bottom",
horizontal: "left",
}}
transformOrigin={{
vertical: "top",
horizontal: "left",
}}
>
<Stack direction="column" spacing={1}>
<HelpTooltipText>
You can port forward this resource by typing the{" "}
<strong>port, workspace name, agent name</strong> and <strong>your username</strong> in
the URL like the example below
</HelpTooltipText>

<CodeExample code={urlExample} />

<HelpTooltipText>
Or you can use the following form to open it in a new tab.
</HelpTooltipText>

<Stack direction="row" spacing={1} alignItems="center">
<TextField
label="Port"
type="number"
value={port}
className={styles.portField}
onChange={(e) => {
setPort(e.currentTarget.value)
}}
/>
<Link
underline="none"
href={urlExample}
target="_blank"
rel="noreferrer"
className={styles.openUrlButton}
>
<Button>Open URL</Button>
</Link>
</Stack>

<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/port-forward">
Port forward
</HelpTooltipLink>
</HelpTooltipLinksGroup>
</Stack>
</Popover>
</>
)
}

const useStyles = makeStyles((theme) => ({
popoverPaper: {
padding: `${theme.spacing(2.5)}px ${theme.spacing(3.5)}px ${theme.spacing(3.5)}px`,
width: theme.spacing(46),
color: theme.palette.text.secondary,
marginTop: theme.spacing(0.25),
},

openUrlButton: {
flexShrink: 0,
},

portField: {
// The default border don't contrast well with the popover
"& .MuiOutlinedInput-root .MuiOutlinedInput-notchedOutline": {
borderColor: colors.gray[10],
},
},
}))
6 changes: 6 additions & 0 deletions site/src/components/Resources/Resources.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { Skeleton } from "@material-ui/lab"
import useTheme from "@material-ui/styles/useTheme"
import { CloseDropdown, OpenDropdown } from "components/DropdownArrows/DropdownArrows"
import { ErrorSummary } from "components/ErrorSummary/ErrorSummary"
import { PortForwardButton } from "components/PortForwardButton/PortForwardButton"
import { TableCellDataPrimary } from "components/TableCellData/TableCellData"
import { FC, useState } from "react"
import { getDisplayAgentStatus, getDisplayVersionStatus } from "util/workspace"
Expand Down Expand Up @@ -150,6 +151,11 @@ export const Resources: FC<React.PropsWithChildren<ResourcesProps>> = ({
{canUpdateWorkspace && agent.status === "connected" && (
<>
<SSHButton workspaceName={workspace.name} agentName={agent.name} />
<PortForwardButton
username={workspace.owner_name}
workspaceName={workspace.name}
agentName={agent.name}
/>
<TerminalLink
workspaceName={workspace.name}
agentName={agent.name}
Expand Down
3 changes: 2 additions & 1 deletion site/src/components/Tooltips/HelpTooltip/HelpTooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,9 @@ const useStyles = makeStyles((theme) => ({
},

link: {
display: "flex",
display: "inline-flex",
alignItems: "center",
width: "fit-content",
},

linkIcon: {
Expand Down
4 changes: 4 additions & 0 deletions site/webpack.common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ import { Configuration, EnvironmentPlugin } from "webpack"
const environmentPlugin = new EnvironmentPlugin({
INSPECT_XSTATE: "",
CODER_VERSION: "main",
CODER_ENABLE_WILDCARD_APPS: "",
})
console.info(`--- Setting INSPECT_XSTATE to '${process.env.INSPECT_XSTATE || ""}'`)
console.info(`--- Setting CODER_VERSION to '${process.env.CODER_VERSION || "main"}'`)
console.info(
`--- Setting CODER_ENABLE_WILDCARD_APPS to '${process.env.CODER_ENABLE_WILDCARD_APPS ?? ""}'`,
)
console.info(`--- Setting NODE_ENV to '${process.env.NODE_ENV || ""}'`)

/**
Expand Down