fix(dashboard): properly handle GitHub auth errors with specific messages (#4785)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Kapil Gowru <[email protected]>

Author: devin-ai-integration[bot]

packages/fern-dashboard/src/app/services/dal/github/validators.ts

@@ -10,6 +10,7 @@ import type { RepoIdentifier } from "./types";
 export type GithubRepoValidationError =
     | { type: "REPO_NOT_CONNECTED" }
     | { type: "MALFORMED_GITHUB_URL"; url: string }
+    | { type: "DOMAIN_NOT_REGISTERED" }
     | { type: "FERN_BOT_NOT_INSTALLED" }
     | { type: "FERN_CONFIG_JSON_ORG_MISMATCH" }
     | FernConfigJsonErrors

packages/fern-dashboard/src/components/docs-page/visual-editor-section/VisualEditorSection.tsx

@@ -32,21 +32,42 @@ export async function VisualEditorSection({
 
     const githubUrl = githubUrlResult.success ? githubUrlResult.githubUrl : undefined;
 
-    // Ensure we have a proper GithubAuthState, not an error result
-    const githubAuthState: GithubAuthState =
-        "validationResult" in githubAuthStateResult
-            ? githubAuthStateResult
-            : {
-                  validationResult: {
-                      ok: false,
-                      error: {
-                          type: "UNEXPECTED_ERROR",
-                          message: "Failed to load GitHub auth state"
-                      }
-                  },
-                  sourceRepo: undefined,
-                  isLoading: false
-              };
+    // Ensure we have a proper GithubAuthState, handling both error shapes
+    let githubAuthState: GithubAuthState;
+
+    if (!githubUrlResult.success) {
+        githubAuthState = {
+            validationResult: {
+                ok: false,
+                error: githubUrlResult.error
+            },
+            sourceRepo: undefined,
+            isLoading: false
+        };
+    } else if ("success" in githubAuthStateResult && githubAuthStateResult.success === false) {
+        githubAuthState = {
+            validationResult: {
+                ok: false,
+                error: githubAuthStateResult.error
+            },
+            sourceRepo: undefined,
+            isLoading: false
+        };
+    } else if ("validationResult" in githubAuthStateResult) {
+        githubAuthState = githubAuthStateResult;
+    } else {
+        githubAuthState = {
+            validationResult: {
+                ok: false,
+                error: {
+                    type: "UNEXPECTED_ERROR",
+                    message: "Failed to load GitHub auth state"
+                }
+            },
+            sourceRepo: undefined,
+            isLoading: false
+        };
+    }
 
     if (!githubAuthState.validationResult.ok) {
         return (

packages/fern-dashboard/src/components/docs-page/visual-editor-section/VisualEditorValidationErrorHandler.tsx

@@ -43,6 +43,9 @@ export function VisualEditorValidationErrorHandler({ error, orgName, site, githu
         case "MALFORMED_GITHUB_URL":
             return <WarningNote>{getValidationErrorMessage(error)}</WarningNote>;
 
+        case "DOMAIN_NOT_REGISTERED":
+            return <WarningNote>{getValidationErrorMessage(error)}</WarningNote>;
+
         case "REPO_NOT_FOUND":
             return <WarningNote>{getValidationErrorMessage(error)}</WarningNote>;
 

packages/fern-dashboard/src/utils/errors.ts

@@ -29,6 +29,7 @@ export const ERROR_DIGEST_MESSAGES: Record<ERROR_DIGEST_KEYS, string> = {
         "You do not have write permission to the underlying GitHub repo. Please contact your GitHub admin for access.",
     MALFORMED_GITHUB_URL:
         "The provided GitHub URL is not valid. Please ensure you're using a valid GitHub repository URL.",
+    DOMAIN_NOT_REGISTERED: "This docs domain is not registered. Please contact support to register your domain.",
     FERN_CONFIG_JSON_ORG_MISMATCH:
         "The organization in fern.config.json does not match your current organization. Please update the configuration file.",
     FERN_CONFIG_JSON_MISSING:
@@ -51,6 +52,8 @@ export function getValidationErrorMessage(error: GithubRepoValidationError): str
             return ERROR_DIGEST_MESSAGES.REPO_NOT_CONNECTED;
         case "MALFORMED_GITHUB_URL":
             return `${ERROR_DIGEST_MESSAGES.MALFORMED_GITHUB_URL} URL: ${error.url}`;
+        case "DOMAIN_NOT_REGISTERED":
+            return ERROR_DIGEST_MESSAGES.DOMAIN_NOT_REGISTERED;
         case "FERN_BOT_NOT_INSTALLED":
             return ERROR_DIGEST_MESSAGES.FERN_BOT_NOT_INSTALLED;
         case "FERN_CONFIG_JSON_ORG_MISMATCH":