Engine version error for waitpoint token list

Author: matt-aitken

apps/webapp/app/presenters/v3/WaitpointTokenListPresenter.server.ts

@@ -5,6 +5,7 @@ import { sqlDatabaseSchema } from "~/db.server";
 import { type AuthenticatedEnvironment } from "~/services/apiAuth.server";
 import { BasePresenter } from "./basePresenter.server";
 import { type WaitpointFilterStatus } from "~/components/runs/v3/WaitpointTokenFilters";
+import { determineEngineVersion } from "~/v3/engineVersion.server";
 
 const DEFAULT_PAGE_SIZE = 25;
 
@@ -24,6 +25,40 @@ export type WaitpointTokenListOptions = {
   pageSize?: number;
 };
 
+type WaitpointToken = {
+  friendlyId: string;
+  status: WaitpointStatus;
+  completedAt: Date | null;
+  completedAfter: Date | null;
+  idempotencyKey: string | null;
+  idempotencyKeyExpiresAt: Date | null;
+  tags: string[];
+  isTimeout: boolean;
+  createdAt: Date;
+};
+
+type Result =
+  | {
+      success: true;
+      tokens: WaitpointToken[];
+      pagination: {
+        next: string | undefined;
+        previous: string | undefined;
+      };
+      hasFilters: boolean;
+    }
+  | {
+      success: false;
+      code: "ENGINE_VERSION_MISMATCH" | "UNKNOWN";
+      error: string;
+      tokens: [];
+      pagination: {
+        next: undefined;
+        previous: undefined;
+      };
+      hasFilters: false;
+    };
+
 export class WaitpointTokenListPresenter extends BasePresenter {
   public async call({
     environment,
@@ -37,7 +72,22 @@ export class WaitpointTokenListPresenter extends BasePresenter {
     direction = "forward",
     cursor,
     pageSize = DEFAULT_PAGE_SIZE,
-  }: WaitpointTokenListOptions) {
+  }: WaitpointTokenListOptions): Promise<Result> {
+    const engineVersion = await determineEngineVersion({ environment });
+    if (engineVersion === "V1") {
+      return {
+        success: false,
+        code: "ENGINE_VERSION_MISMATCH",
+        error: "Upgrade to SDK version 4+ to use Waitpoint tokens.",
+        tokens: [],
+        pagination: {
+          next: undefined,
+          previous: undefined,
+        },
+        hasFilters: false,
+      };
+    }
+
     const hasStatusFilters = statuses && statuses.length > 0;
 
     const hasFilters =
@@ -190,6 +240,7 @@ export class WaitpointTokenListPresenter extends BasePresenter {
         : tokens.slice(0, pageSize);
 
     return {
+      success: true,
       tokens: tokensToReturn.map((token) => ({
         friendlyId: token.friendlyId,
         status: token.status,
@@ -208,13 +259,6 @@ export class WaitpointTokenListPresenter extends BasePresenter {
         next,
         previous,
       },
-      filters: {
-        id: id || undefined,
-        statuses: statuses || [],
-        idempotencyKey: idempotencyKey || undefined,
-        from,
-        to,
-      },
       hasFilters,
     };
   }

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.waitpoints.tokens/route.tsx

@@ -1,15 +1,11 @@
+import upgradeForWaitpointsPath from "~/assets/images/waitpoints-dashboard.png";
 import { BookOpenIcon } from "@heroicons/react/20/solid";
-import { useParams, type MetaFunction, Outlet } from "@remix-run/react";
+import { Outlet, useParams, type MetaFunction } from "@remix-run/react";
 import { type LoaderFunctionArgs } from "@remix-run/server-runtime";
 import { typedjson, useTypedLoaderData } from "remix-typedjson";
 import { AdminDebugTooltip } from "~/components/admin/debugTooltip";
 import { NoWaitpointTokens } from "~/components/BlankStatePanels";
-import {
-  MainCenteredContainer,
-  MainHorizontallyCenteredContainer,
-  PageBody,
-  PageContainer,
-} from "~/components/layout/AppLayout";
+import { MainCenteredContainer, PageBody, PageContainer } from "~/components/layout/AppLayout";
 import { ListPagination } from "~/components/ListPagination";
 import { LinkButton } from "~/components/primitives/Buttons";
 import { DateTime } from "~/components/primitives/DateTime";
@@ -43,6 +39,7 @@ import { findEnvironmentBySlug } from "~/models/runtimeEnvironment.server";
 import { WaitpointTokenListPresenter } from "~/presenters/v3/WaitpointTokenListPresenter.server";
 import { requireUserId } from "~/services/session.server";
 import { docsPath, EnvironmentParamSchema, v3WaitpointTokenPath } from "~/utils/pathBuilder";
+import { determineEngineVersion } from "~/v3/engineVersion.server";
 
 export const meta: MetaFunction = () => {
   return [
@@ -105,7 +102,7 @@ export const loader = async ({ request, params }: LoaderFunctionArgs) => {
 };
 
 export default function Page() {
-  const { tokens, pagination, filters, hasFilters } = useTypedLoaderData<typeof loader>();
+  const { success, tokens, pagination, hasFilters } = useTypedLoaderData<typeof loader>();
 
   const organization = useOrganization();
   const project = useProject();
@@ -120,11 +117,7 @@ export default function Page() {
         <PageTitle title="Waitpoint Tokens" />
         <PageAccessories>
           <AdminDebugTooltip />
-          <LinkButton
-            variant={"docs/small"}
-            LeadingIcon={BookOpenIcon}
-            to={docsPath("/waitpoints")}
-          >
+          <LinkButton variant={"docs/small"} LeadingIcon={BookOpenIcon} to={docsPath("/wait")}>
             Waitpoints docs
           </LinkButton>
         </PageAccessories>