Thanks to visit codestin.com
Credit goes to github.com

Skip to content

refactor: Do not display port forward button if it is disabled #5604

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 4 commits into from
Jan 9, 2023
Merged

refactor: Do not display port forward button if it is disabled #5604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
165ec63
refactor: Do not display port forward button if it is disabled
BrunoQuaresma Jan 6, 2023
058c204
Merge branch 'main' of github.com:coder/coder into bq/refact-port-for…
BrunoQuaresma Jan 6, 2023
0ed5e51
Fix storybook
BrunoQuaresma Jan 9, 2023
84babab
Add port forwarding
BrunoQuaresma Jan 9, 2023
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
45 changes: 2 additions & 43 deletions site/src/components/PortForwardButton/PortForwardButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ 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 { ChooseOne, Cond } from "components/Conditionals/ChooseOne"
import { Stack } from "components/Stack/Stack"
import { useRef, useState, Fragment } from "react"
import { colors } from "theme/colors"
Expand Down Expand Up @@ -42,7 +41,7 @@ const portForwardURL = (
return `${location.protocol}//${host}`.replace("*", subdomain)
}

const EnabledView: React.FC<PortForwardButtonProps> = (props) => {
const TooltipView: React.FC<PortForwardButtonProps> = (props) => {
const { host, workspaceName, agentName, agentId, username } = props
const styles = useStyles()
const [port, setPort] = useState("3000")
Expand Down Expand Up @@ -137,40 +136,7 @@ const EnabledView: React.FC<PortForwardButtonProps> = (props) => {
)
}

const DisabledView: React.FC<PortForwardButtonProps> = ({
workspaceName,
agentName,
}) => {
const cliExample = `coder port-forward ${workspaceName}.${agentName} --tcp 3000`
const styles = useStyles()

return (
<>
<HelpTooltipText>
<strong>
Your deployment does not have web port forwarding enabled.
</strong>{" "}
See the docs for more details.
</HelpTooltipText>

<HelpTooltipText>
You can use the Coder CLI to forward ports from your workspace to your
local machine, as shown below.
</HelpTooltipText>

<CodeExample code={cliExample} className={styles.code} />

<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/networking/port-forwarding#dashboard">
Learn more about web port forwarding
</HelpTooltipLink>
</HelpTooltipLinksGroup>
</>
)
}

export const PortForwardButton: React.FC<PortForwardButtonProps> = (props) => {
const { host } = props
const anchorRef = useRef<HTMLButtonElement>(null)
const [isOpen, setIsOpen] = useState(false)
const id = isOpen ? "schedule-popover" : undefined
Expand Down Expand Up @@ -208,14 +174,7 @@ export const PortForwardButton: React.FC<PortForwardButtonProps> = (props) => {
}}
>
<HelpTooltipTitle>Port forward</HelpTooltipTitle>
<ChooseOne>
<Cond condition={host !== ""}>
<EnabledView {...props} />
</Cond>
<Cond>
<DisabledView {...props} />
</Cond>
</ChooseOne>
<TooltipView {...props} />
</Popover>
</>
)
Expand Down
8 changes: 8 additions & 0 deletions site/src/components/Resources/AgentRow.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,11 @@ Timeout.args = {
applicationsHost: "",
showApps: true,
}

export const ShowingPortForward = Template.bind({})
ShowingPortForward.args = {
agent: MockWorkspaceAgent,
workspace: MockWorkspace,
applicationsHost: "https://coder.com",
showApps: true,
}
2 changes: 1 addition & 1 deletion site/src/components/Resources/AgentRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ export const AgentRow: FC<AgentRowProps> = ({
agentName={agent.name}
/>
)}
{applicationsHost !== undefined && (
{applicationsHost !== undefined && applicationsHost !== "" && (
<PortForwardButton
host={applicationsHost}
workspaceName={workspace.name}
Expand Down
3 changes: 3 additions & 0 deletions site/src/pages/DeploySettingsPage/NetworkSettingsPage/NetworkSettingsPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ export default {
},
},
},
wildcard_access_url: {
Copy link
Contributor

Choose a reason for hiding this comment

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

Ah I see it now!

value: "https://coder.com",
},
},
},
},
Expand Down
57 changes: 41 additions & 16 deletions site/src/pages/DeploySettingsPage/NetworkSettingsPage/NetworkSettingsPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,53 @@
import { DeploymentConfig } from "api/typesGenerated"
import {
Badges,
EnabledBadge,
DisabledBadge,
} from "components/DeploySettingsLayout/Badges"
import { Header } from "components/DeploySettingsLayout/Header"
import OptionsTable from "components/DeploySettingsLayout/OptionsTable"
import { Stack } from "components/Stack/Stack"

export type NetworkSettingsPageViewProps = {
deploymentConfig: Pick<DeploymentConfig, "derp">
deploymentConfig: Pick<DeploymentConfig, "derp" | "wildcard_access_url">
}

export const NetworkSettingsPageView = ({
deploymentConfig,
}: NetworkSettingsPageViewProps): JSX.Element => (
<>
<Header
title="Network"
description="Configure your deployment connectivity."
docsHref="https://coder.com/docs/coder-oss/latest/networking"
/>
<Stack direction="column" spacing={6}>
<div>
<Header
title="Network"
description="Configure your deployment connectivity."
docsHref="https://coder.com/docs/coder-oss/latest/networking"
/>
<OptionsTable
options={{
derp_server_enable: deploymentConfig.derp.server.enable,
derp_server_region_name: deploymentConfig.derp.server.region_name,
derp_server_stun_addresses:
deploymentConfig.derp.server.stun_addresses,
derp_config_url: deploymentConfig.derp.config.url,
}}
/>
</div>

<OptionsTable
options={{
derp_server_enable: deploymentConfig.derp.server.enable,
derp_server_region_name: deploymentConfig.derp.server.region_name,
derp_server_stun_addresses: deploymentConfig.derp.server.stun_addresses,
derp_config_url: deploymentConfig.derp.config.url,
}}
/>
</>
<div>
<Header
title="Port Forwarding"
secondary
description="Port forwarding lets developers securely access processes on their Coder workspace from a local machine."
docsHref="https://coder.com/docs/coder-oss/latest/networking/port-forwarding"
/>

<Badges>
{deploymentConfig.wildcard_access_url.value !== "" ? (
<EnabledBadge />
) : (
<DisabledBadge />
)}
</Badges>
</div>
</Stack>
)