Skip to content

chore: Update version flow updates deployment #4852

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 1 commit into from
Oct 2, 2024
+54 −45
Merged

chore: Update version flow updates deployment #4852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 14 additions & 11 deletions apps/dashboard/src/@3rdweb-sdk/react/hooks/useEngine.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ export type EngineInstance = {
name: string;
url: string;
lastAccessedAt: string;
cloudDeployedAt?: string;
status:
| "active"
| "pending"
| "requested"
| "deploying"
| "paymentFailed"
| "deploymentFailed";
deploymentId?: string;
};

// Not checking for null token because the token is required the tanstack useQuery hook
Expand Down Expand Up @@ -189,23 +189,26 @@ export function useEngineLatestVersion() {

interface UpdateVersionInput {
engineId: string;
serverVersion: string;
}

export function useEngineUpdateVersion() {
export function useEngineUpdateServerVersion() {
return useMutation({
mutationFn: async (input: UpdateVersionInput) => {
invariant(input.engineId, "engineId is required");

const res = await fetch(`${THIRDWEB_API_HOST}/v1/engine/update-version`, {
method: "POST",

headers: {
"Content-Type": "application/json",
const res = await fetch(
`${THIRDWEB_API_HOST}/v2/engine/${input.engineId}/infrastructure`,
{
method: "PUT",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify({
serverVersion: input.serverVersion,
}),
},
body: JSON.stringify({
engineId: input.engineId,
}),
});
);
// we never use the response body
res.body?.cancel();
if (!res.ok) {
Expand Down
60 changes: 35 additions & 25 deletions apps/dashboard/src/components/engine/badges/version.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
type EngineInstance,
useEngineLatestVersion,
useEngineSystemHealth,
useEngineUpdateVersion,
useEngineUpdateServerVersion,
} from "@3rdweb-sdk/react/hooks/useEngine";
import { CircleArrowDownIcon, CloudDownloadIcon } from "lucide-react";
import { useState } from "react";
Expand All @@ -30,15 +30,15 @@ export const EngineVersionBadge = ({
const latestVersionQuery = useEngineLatestVersion();
const [isModalOpen, setModalOpen] = useState(false);

const current = healthQuery.data?.engineVersion ?? "...";
const latest = latestVersionQuery.data ?? "...";
const isStale = current !== latest;
const currentVersion = healthQuery.data?.engineVersion ?? "...";
const latestVersion = latestVersionQuery.data;
const isStale = latestVersion && currentVersion !== latestVersion;

if (!isStale) {
return (
<ToolTipLabel label="Latest Version">
<Button variant="outline" asChild className="hover:bg-transparent">
<div>{current}</div>
<div>{currentVersion}</div>
</Button>
</ToolTipLabel>
);
Expand All @@ -57,7 +57,7 @@ export const EngineVersionBadge = ({
className="relative"
onClick={() => setModalOpen(true)}
>
{current}
{currentVersion}

{/* Notification Dot */}
<span className="-top-1 -right-1 absolute">
Expand All @@ -66,26 +66,28 @@ export const EngineVersionBadge = ({
</Button>
</ToolTipLabel>

<UpdateVersionModal
open={isModalOpen}
onOpenChange={setModalOpen}
latest={latest ?? ""}
instance={instance}
/>
{latestVersion && (
<UpdateVersionModal
open={isModalOpen}
onOpenChange={setModalOpen}
latestVersion={latestVersion}
instance={instance}
/>
)}
</>
);
};

const UpdateVersionModal = (props: {
open: boolean;
onOpenChange: (open: boolean) => void;
latest: string;
latestVersion: string;
instance: EngineInstance;
}) => {
const { open, onOpenChange, latest, instance } = props;
const updateEngine = useEngineUpdateVersion();
const { open, onOpenChange, latestVersion, instance } = props;
const updateEngineServerMutation = useEngineUpdateServerVersion();

if (!instance.cloudDeployedAt) {
if (!instance.deploymentId) {
// For self-hosted, show a prompt to the Github release page.
return (
<Dialog open={open} onOpenChange={onOpenChange}>
Expand All @@ -95,19 +97,20 @@ const UpdateVersionModal = (props: {
>
<DialogHeader>
<DialogTitle className="mb-6 pr-4 font-semibold text-2xl tracking-tight">
Update your self-hosted Engine to {latest}
Update your self-hosted Engine to {latestVersion}
</DialogTitle>
<DialogDescription>
View the changelog in the
View the{" "}
<TrackedLinkTW
href="https://github.com/thirdweb-dev/engine/releases"
category="engine"
label="clicked-engine-releases"
target="_blank"
className="text-link-foreground hover:text-foreground"
>
Engine Github repository
latest changelog
</TrackedLinkTW>
.
</DialogDescription>
</DialogHeader>
</DialogContent>
Expand All @@ -117,11 +120,13 @@ const UpdateVersionModal = (props: {

const onClick = async () => {
try {
const promise = updateEngine.mutateAsync({ engineId: instance.id });
const promise = updateEngineServerMutation.mutateAsync({
engineId: instance.id,
serverVersion: latestVersion,
});
toast.promise(promise, {
success:
"Submitted a request to update your Engine instance. Please allow 1-2 business days for this process.",
error: "Unexpected error updating your Engine instance.",
success: `Upgrading your Engine to ${latestVersion}. Please confirm after a few minutes.`,
error: "Unexpected error updating your Engine.",
});
await promise;
} finally {
Expand All @@ -136,7 +141,12 @@ const UpdateVersionModal = (props: {
dialogOverlayClassName="z-[10000]"
>
<DialogHeader>
<DialogTitle>Update Engine to {latest}?</DialogTitle>
<DialogTitle>Update Engine to {latestVersion}?</DialogTitle>

<DialogDescription>
It is recommended to pause traffic to Engine before performing this
upgrade. There is &lt; 1 minute of expected downtime.
</DialogDescription>
Copy link
Member

@MananTank MananTank Sep 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: Don't need to wrap entire text with {``} here - just "<"

Copy link
Contributor Author

@arcoraven arcoraven Sep 30, 2024

Choose a reason for hiding this comment

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

There's a < in the string, so I either need to do this or &lt;. I generally don't like the latter cause it makes it hard to grep for it in code.

Copy link
Member

@jnsdls jnsdls Oct 1, 2024

Choose a reason for hiding this comment

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

you should use the latter

</DialogHeader>

<DialogFooter className="mt-5">
Expand All @@ -153,7 +163,7 @@ const UpdateVersionModal = (props: {
variant="primary"
className="gap-2"
>
{updateEngine.isPending ? (
{updateEngineServerMutation.isPending ? (
<Spinner className="size-4" />
) : (
<CloudDownloadIcon className="size-4" />
Expand Down
2 changes: 1 addition & 1 deletion apps/dashboard/src/components/engine/configuration/ip-allowlist.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export const EngineIpAllowlistConfig: React.FC<
</Flex>

<Textarea
placeholder="8.8.8.8\nff06:0:0:0:0:0:0:c3"
placeholder={"8.8.8.8\nff06:0:0:0:0:0:0:c3"}
rows={4}
{...form.register("raw")}
/>
Expand Down
2 changes: 1 addition & 1 deletion apps/dashboard/src/components/engine/create/CreateEnginePage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export const CreateEnginePage = () => {
</h1>

<p className="mb-7 text-muted-foreground">
Host Engine on thirdweb with no setup or maintenance required
Host Engine on thirdweb with no setup or maintenance required.
</p>

<div className="grid grid-cols-1 gap-6 lg:grid-cols-3">
Expand Down
8 changes: 2 additions & 6 deletions apps/dashboard/src/components/engine/engine-instances-table.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,11 +266,7 @@ const EditModal = (props: {
className="gap-2"
disabled={!form.formState.isDirty}
>
{editInstance.isPending ? (
<Spinner className="size-4" />
) : (
<SendIcon className="size-4" />
)}
{editInstance.isPending && <Spinner className="size-4" />}
Update
</Button>
</DialogFooter>
Expand All @@ -292,7 +288,7 @@ const RemoveModal = (props: {
<Dialog open={open} onOpenChange={onOpenChange}>
<DialogContent className="z-[10001]" dialogOverlayClassName="z-[10000]">
{instance.status === "paymentFailed" ||
(instance.status === "active" && !instance.cloudDeployedAt) ? (
(instance.status === "active" && !instance.deploymentId) ? (
<RemoveFromDashboardModalContent
refetch={refetch}
instance={instance}
Expand Down
2 changes: 1 addition & 1 deletion apps/dashboard/src/components/engine/import/EngineImportPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ export const EngineImportPage = () => {
<div className="mt-2 flex items-center gap-2">
<CircleAlertIcon className="!static size-3 text-warning-foreground" />
<p className="text-muted-foreground text-sm">
Do not import a URL you do not recognize
Do not import a URL you do not recognize.
</p>
</div>
</FormControl>
Expand Down
Loading