new odr strategy

Author: julianbenegas

packages/basehub/CHANGELOG.md

@@ -1,5 +1,11 @@
 # basehub
 
+## 8.1.21
+
+### Patch Changes
+
+- new odr strategy
+
 ## 8.1.20
 
 ### Patch Changes

packages/basehub/package.json

@@ -2,7 +2,7 @@
   "name": "basehub",
   "description": "A very fast Headless CMS.",
   "author": "JB <[email protected]>",
-  "version": "8.1.20",
+  "version": "8.1.21",
   "license": "MIT",
   "repository": "basehub-ai/basehub",
   "bugs": "https://github.com/basehub-ai/basehub/issues",

packages/basehub/src/bin/util/get-stuff-from-env.ts

@@ -9,7 +9,7 @@ import { ResolvedRef } from "../../common-types";
 
 export const basehubAPIOrigin = "https://api.basehub.com";
 const defaultEnvVarPrefix = "BASEHUB";
-const DEFAULT_API_VERSION = "3";
+const DEFAULT_API_VERSION = "4";
 
 export type Options = {
   forceDraft?: boolean;

packages/basehub/src/next/toolbar/client-conditional-renderer.tsx

@@ -17,23 +17,20 @@ export const ClientConditionalRenderer = ({
   revalidateTags,
   resolvedRef,
   getLatestBranches,
-  humanRevalidatePendingTags,
 }: {
   draft: boolean;
   isForcedDraft: boolean;
   enableDraftMode: (o: {
     bshbPreviewToken: string;
   }) => Promise<{ status: number; response: object }>;
   disableDraftMode: () => Promise<void>;
-  revalidateTags: (o: { tags: string[] }) => Promise<{ success: boolean }>;
+  revalidateTags: (o: {
+    bshbPreviewToken: string;
+  }) => Promise<{ success: boolean }>;
   getLatestBranches: (o: { bshbPreviewToken: string | undefined }) => Promise<{
     status: number;
     response: LatestBranch[] | { error: string };
   }>;
-  humanRevalidatePendingTags: (o: {
-    bshbPreviewToken: string;
-    ref: string;
-  }) => Promise<{ success: boolean }>;
   resolvedRef: ResolvedRef;
 }) => {
   const [hasRendered, setHasRendered] = React.useState(false);
@@ -87,17 +84,19 @@ export const ClientConditionalRenderer = ({
 
   React.useEffect(() => {
     const url = new URL(window.location.href);
-    const tags = url.searchParams.get("bshb-odr-tags");
-    if (tags) {
-      url.searchParams.delete("bshb-odr-tags");
-      window.history.replaceState(null, "", url);
-      revalidateTags({ tags: tags.split(",") })
+    const shouldRevalidate = url.searchParams.get("__bshb-odr") === "true";
+    const odrToken = url.searchParams.get("__bshb-odr-token");
+
+    if (shouldRevalidate && odrToken) {
+      revalidateTags({ bshbPreviewToken: odrToken })
         .then(({ success }) => {
           document.documentElement.dataset.basehubOdrStatus = success
             ? "success"
             : "error";
-          document.documentElement.dataset.basehubOdrErrorMessage =
-            "Response failed";
+          if (!success) {
+            document.documentElement.dataset.basehubOdrErrorMessage =
+              "Response failed";
+          }
         })
         .catch((e) => {
           document.documentElement.dataset.basehubOdrStatus = "error";
@@ -132,7 +131,6 @@ export const ClientConditionalRenderer = ({
       seekAndStoreBshbPreviewToken={seekAndStoreBshbPreviewToken}
       resolvedRef={resolvedRef}
       getLatestBranches={getLatestBranches}
-      humanRevalidatePendingTags={humanRevalidatePendingTags}
       bshbPreviewLSName={bshbPreviewLSName}
     />,
     document.body

packages/basehub/src/next/toolbar/client-toolbar.tsx

@@ -42,10 +42,6 @@ export const ClientToolbar = ({
     status: number;
     response: LatestBranch[] | { error: string };
   }>;
-  humanRevalidatePendingTags: (o: {
-    bshbPreviewToken: string;
-    ref: string;
-  }) => Promise<{ success: boolean }>;
 }) => {
   const [toolbarRef, setToolbarRef] = React.useState<HTMLDivElement | null>(
     null
@@ -232,22 +228,6 @@ export const ClientToolbar = ({
     setRefWithEvents,
   ]);
 
-  // // human revalidate pending tags
-  // const lastHumanRevalidatedRef = React.useRef<string | null>(null);
-  // React.useEffect(() => {
-  //   if (!bshbPreviewToken) return;
-  //   if (!previewRef) return;
-  //   if (isForcedDraft) return;
-  //   if (lastHumanRevalidatedRef.current === previewRef) return;
-  //   lastHumanRevalidatedRef.current = previewRef;
-
-  //   humanRevalidatePendingTags({ bshbPreviewToken, ref: previewRef }).catch(
-  //     () => {
-  //       // ignore
-  //     }
-  //   );
-  // }, [bshbPreviewToken, humanRevalidatePendingTags, previewRef, isForcedDraft]);
-
   /** Position tooltip when message changes. */
   React.useLayoutEffect(() => {
     tooltipRef.current?.checkOverflow();

packages/basehub/src/next/toolbar/server-toolbar.tsx

@@ -110,28 +110,17 @@ export const ServerToolbar = async ({
     (await draftMode()).disable();
   };
 
-  const revalidateTags = async ({ tags }: { tags: string[] }) => {
-    "use server";
-    await Promise.all(
-      tags.map(async (tag) => {
-        if (tag.startsWith("basehub-")) {
-          await revalidateTag(tag);
-        }
-      })
-    );
-    return { success: true };
-  };
-
-  // used by a client that's authenticated to the toolbar
-  // sort of as a fallback to the headless browser's revalidation failing
-  const humanRevalidatePendingTags = async ({
+  const revalidateTags = async ({
     bshbPreviewToken,
-    ref,
   }: {
     bshbPreviewToken: string;
-    ref: string;
   }) => {
     "use server";
+
+    if (!bshbPreviewToken) {
+      return { success: false, error: "Unauthorized" };
+    }
+
     const { headers, url } = getStuffFromEnv(basehubProps);
     const appApiEndpoint = getBaseHubAppApiEndpoint(
       url,
@@ -145,7 +134,6 @@ export const ServerToolbar = async ({
         "content-type": "application/json",
         "x-basehub-token": headers["x-basehub-token"],
         "x-basehub-preview-token": bshbPreviewToken,
-        "x-basehub-ref": ref,
       },
     });
 
@@ -159,7 +147,15 @@ export const ServerToolbar = async ({
       return { success: false };
     }
 
-    return await revalidateTags({ tags });
+    await Promise.all(
+      tags.map(async (tag) => {
+        if (tag.startsWith("basehub-")) {
+          await revalidateTag(tag);
+        }
+      })
+    );
+
+    return { success: true };
   };
 
   return (
@@ -171,7 +167,6 @@ export const ServerToolbar = async ({
       revalidateTags={revalidateTags}
       getLatestBranches={getLatestBranches}
       resolvedRef={resolvedRef}
-      humanRevalidatePendingTags={humanRevalidatePendingTags}
     />
   );
 };

playground/CHANGELOG.md

@@ -1,5 +1,12 @@
 # playground
 
+## 0.0.190
+
+### Patch Changes
+
+- Updated dependencies
+  - [email protected]
+
 ## 0.0.189
 
 ### Patch Changes

playground/package.json

@@ -1,7 +1,7 @@
 {
   "name": "playground",
   "private": true,
-  "version": "0.0.189",
+  "version": "0.0.190",
   "scripts": {
     "dev": "basehub dev & next dev --port 3003",
     "build": "basehub && next build",