Skip to content
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

[dashboard] Fix Arc favourites #20466

Merged
merged 3 commits into from
Jan 6, 2025
+53 −7
Merged

[dashboard] Fix Arc favourites #20466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
adc9963
[dashboard] Fix Arc favourites
filiptronicek Dec 19, 2024
9826ca5
💄
filiptronicek Dec 19, 2024
2f79564
Fix banner <> redirect race
filiptronicek Dec 19, 2024
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
13 changes: 8 additions & 5 deletions components/dashboard/src/components/podkit/buttons/LinkButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,30 @@

import { Link } from "react-router-dom";
import { Button, ButtonProps } from "@podkit/buttons/Button";
import React from "react";
import { forwardRef, HTMLAttributeAnchorTarget } from "react";

export interface LinkButtonProps extends ButtonProps {
asChild?: false;
href: string;
target?: HTMLAttributeAnchorTarget;
isExternalUrl?: boolean;
}

/**
* A HTML anchor element styled as a button.
*/
export const LinkButton = React.forwardRef<HTMLButtonElement, LinkButtonProps>(
({ asChild, children, href, ...props }, ref) => {
export const LinkButton = forwardRef<HTMLButtonElement, LinkButtonProps>(
({ asChild, children, href, target, ...props }, ref) => {
return (
<Button ref={ref} {...props} asChild>
{props.isExternalUrl ? (
<a href={href} target="_blank" rel="noreferrer">
<a href={href} target={target ?? "_blank"} rel="noreferrer">
{children}
</a>
) : (
<Link to={href}>{children}</Link>
<Link to={href} target={target}>
{children}
</Link>
)}
</Button>
);
Expand Down
47 changes: 45 additions & 2 deletions components/dashboard/src/start/StartWorkspace.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import {
import { PartialMessage } from "@bufbuild/protobuf";
import { trackEvent } from "../Analytics";
import { fromWorkspaceName } from "../workspaces/RenameWorkspaceModal";
import { LinkButton } from "@podkit/buttons/LinkButton";

const sessionId = v4();

Expand Down Expand Up @@ -102,6 +103,14 @@ export interface StartWorkspaceState {
ideOptions?: IDEOptions;
isSSHModalVisible?: boolean;
ownerToken?: string;
/**
* Set to prevent multiple redirects to the same URL when the User Agent ignores our wish to open links in the same tab (by setting window.location.href).
*/
redirected?: boolean;
/**
* Determines whether `redirected` has been `true` for long enough to display our "new tab" info banner without racing with same-tab redirection in regular setups
*/
showRedirectMessage?: boolean;
}

// TODO: use Function Components
Expand Down Expand Up @@ -183,7 +192,7 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
this.toDispose.dispose();
}

componentDidUpdate(prevPros: StartWorkspaceProps, prevState: StartWorkspaceState) {
componentDidUpdate(_prevProps: StartWorkspaceProps, prevState: StartWorkspaceState) {
const newPhase = this.state?.workspace?.status?.phase?.name;
const oldPhase = prevState.workspace?.status?.phase?.name;
const type = this.state.workspace?.spec?.type === WorkspaceSpec_WorkspaceType.PREBUILD ? "prebuild" : "regular";
Expand Down Expand Up @@ -458,11 +467,20 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
}

redirectTo(url: string) {
if (this.state.redirected) {
Copy link
Member

Choose a reason for hiding this comment

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

Nice!

🫧 What are situations where we need to reset this value? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

Good question: I'd say it's enough when React resets it when the page unmounts. On the page level, this prop should be permanent (or at least I don't see reasons why we'd forget about having redirected you somewhere).

console.info("Prevented another redirect", { url });
return;
}
if (this.props.runsInIFrame) {
this.ideFrontendService?.relocate(url);
} else {
window.location.href = url;
}

this.setState({ redirected: true });
setTimeout(() => {
this.setState({ showRedirectMessage: true });
}, 2000);
Copy link
Member

Choose a reason for hiding this comment

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

2s might be a tad too short, but let's see. Worked for me right now. 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

Wanted to find a threshold which was not too short to prevent races, but also not too long to actually show up in time to be useful to the user. Will leave as is for now

}

private openDesktopLink(link: string) {
Expand Down Expand Up @@ -503,7 +521,7 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
return <ImageBuildView workspaceId={this.state.workspace.id} />;

// Pending means the workspace does not yet consume resources in the cluster, but rather is looking for
// some space within the cluster. If for example the cluster needs to scale up to accomodate the
// some space within the cluster. If for example the cluster needs to scale up to accommodate the
// workspace, the workspace will be in Pending state until that happened.
case WorkspacePhase_Phase.PENDING:
phase = StartPhase.Preparing;
Expand Down Expand Up @@ -746,6 +764,7 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
);
break;
}

return (
<StartPage
phase={phase}
Expand All @@ -755,6 +774,30 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
workspaceId={this.props.workspaceId}
>
{statusMessage}
{this.state.showRedirectMessage && (
<>
<Alert type="info" className="mt-4 w-112">
geropl marked this conversation as resolved.
Show resolved Hide resolved
We redirected you to your workspace, but your browser probably opened it in another tab.
</Alert>

<div className="mt-4 justify-center flex space-x-2">
<LinkButton href={gitpodHostUrl.asWorkspacePage().toString()} target="_self" isExternalUrl>
Go to Dashboard
</LinkButton>
{this.state.workspace?.status?.workspaceUrl &&
this.state.workspace.status.phase?.name === WorkspacePhase_Phase.RUNNING && (
<LinkButton
variant={"secondary"}
href={this.state.workspace.status.workspaceUrl}
target="_self"
isExternalUrl
>
Re-open Workspace
</LinkButton>
)}
</div>
</>
)}
</StartPage>
);
}
Expand Down
Loading