detect GitHub SAML SSO session expiry and prompt users to re-authorize (#3253)

Author: Karthik Jeeyar

workspaces/orchestrator/.changeset/nervous-dolphins-compete.md

@@ -0,0 +1,8 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator-form-widgets': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-form-react': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator-form-api': patch
+'@red-hat-developer-hub/backstage-plugin-orchestrator': patch
+---
+
+detect GitHub SAML SSO session expiry and prompt users to re-authorize

workspaces/orchestrator/plugins/orchestrator-form-api/report.api.md

@@ -53,6 +53,7 @@ export type OrchestratorFormContextProps = {
   setIsChangedByUser: (id: string, isChangedByUser: boolean) => void;
   handleFetchStarted?: () => void;
   handleFetchEnded?: () => void;
+  onSamlSsoError?: (error: Error) => void;
 };
 
 // @public
@@ -90,7 +91,7 @@ export const useOrchestratorFormApiOrDefault: () => OrchestratorFormApi;
 
 // Warnings were encountered during analysis:
 //
-// src/api.d.ts:131:22 - (ae-undocumented) Missing documentation for "useOrchestratorFormApiOrDefault".
+// src/api.d.ts:132:22 - (ae-undocumented) Missing documentation for "useOrchestratorFormApiOrDefault".
 
 // (No @packageDocumentation comment for this package)
 ```

workspaces/orchestrator/plugins/orchestrator-form-api/src/api.ts

@@ -46,6 +46,7 @@ export type OrchestratorFormContextProps = {
   setIsChangedByUser: (id: string, isChangedByUser: boolean) => void;
   handleFetchStarted?: () => void;
   handleFetchEnded?: () => void;
+  onSamlSsoError?: (error: Error) => void;
 };
 
 /**

workspaces/orchestrator/plugins/orchestrator-form-react/report.api.md

@@ -58,6 +58,7 @@ export type OrchestratorFormProps = {
   schema: JSONSchema7;
   updateSchema: OrchestratorFormContextProps['updateSchema'];
   setAuthTokenDescriptors: OrchestratorFormContextProps['setAuthTokenDescriptors'];
+  onSamlSsoError?: OrchestratorFormContextProps['onSamlSsoError'];
   isExecuting: boolean;
   handleExecute: (parameters: JsonObject) => Promise<void>;
   handleExecuteAsEvent?: (parameters: JsonObject) => Promise<void>;

workspaces/orchestrator/plugins/orchestrator-form-react/src/components/OrchestratorForm.tsx

@@ -57,6 +57,7 @@ export type OrchestratorFormProps = {
   schema: JSONSchema7;
   updateSchema: OrchestratorFormContextProps['updateSchema'];
   setAuthTokenDescriptors: OrchestratorFormContextProps['setAuthTokenDescriptors'];
+  onSamlSsoError?: OrchestratorFormContextProps['onSamlSsoError'];
   isExecuting: boolean;
   handleExecute: (parameters: JsonObject) => Promise<void>;
   handleExecuteAsEvent?: (parameters: JsonObject) => Promise<void>;
@@ -157,6 +158,7 @@ const OrchestratorForm = ({
   isExecuting,
   initialFormData,
   setAuthTokenDescriptors,
+  onSamlSsoError,
   t,
   executeLabel,
   executeAsEventLabel,
@@ -270,6 +272,7 @@ const OrchestratorForm = ({
           formData={formData}
           setFormData={setFormData}
           setAuthTokenDescriptors={setAuthTokenDescriptors}
+          onSamlSsoError={onSamlSsoError}
           getIsChangedByUser={getIsChangedByUser}
           setIsChangedByUser={setIsChangedByUser}
         >
@@ -284,6 +287,7 @@ const OrchestratorForm = ({
           formData={formData}
           setFormData={setFormData}
           setAuthTokenDescriptors={setAuthTokenDescriptors}
+          onSamlSsoError={onSamlSsoError}
           getIsChangedByUser={getIsChangedByUser}
           setIsChangedByUser={setIsChangedByUser}
         />

workspaces/orchestrator/plugins/orchestrator-form-react/src/components/SingleStepForm.tsx

@@ -32,6 +32,7 @@ type SingleStepFormProps = Pick<
   | 'formData'
   | 'setFormData'
   | 'setAuthTokenDescriptors'
+  | 'onSamlSsoError'
   | 'getIsChangedByUser'
   | 'setIsChangedByUser'
 >;

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/utils/useFetch.ts

@@ -48,6 +48,7 @@ export const useFetch = (
   formData: JsonObject,
   uiProps: UiProps,
   retrigger: ReturnType<typeof useRetriggerEvaluate>,
+  onSamlSsoError?: (error: Error) => void,
 ) => {
   const fetchApi = useApi(fetchApiRef);
 
@@ -173,7 +174,18 @@ export const useFetch = (
             () => fetchApi.fetch(evaluatedFetchUrl, evaluatedRequestInit),
             retryOptions,
           );
+
           if (!response.ok) {
+            const ssoHeader = response.headers.get('x-github-sso');
+            if (response.status === 403 && ssoHeader) {
+              const urlMatch = ssoHeader.match(/url=(\S+)/);
+              const reauthorizeUrl = urlMatch?.[1];
+              const samlError = new Error(
+                `GitHub SAML SSO session expired.${reauthorizeUrl ? ` Re-authorize at: ${reauthorizeUrl}` : ''}`,
+              );
+              onSamlSsoError?.(samlError);
+              return;
+            }
             throw new Error(
               `Request ${evaluatedFetchUrl} returned status ${response.status}. Status text: ${response.statusText}.`,
             );

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/widgets/ActiveDropdown.tsx

@@ -101,7 +101,12 @@ export const ActiveDropdown: Widget<
     uiProps['fetch:retrigger'] as string[],
   );
 
-  const { data, error, loading } = useFetch(formData ?? {}, uiProps, retrigger);
+  const { data, error, loading } = useFetch(
+    formData ?? {},
+    uiProps,
+    retrigger,
+    formContext?.onSamlSsoError,
+  );
 
   // Track the complete loading state (fetch + processing)
   const { completeLoading, wrapProcessing } = useProcessingState(

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/widgets/ActiveMultiSelect.tsx

@@ -142,7 +142,12 @@ export const ActiveMultiSelect: Widget<
     uiProps['fetch:retrigger'] as string[],
   );
 
-  const { data, error, loading } = useFetch(formData ?? {}, uiProps, retrigger);
+  const { data, error, loading } = useFetch(
+    formData ?? {},
+    uiProps,
+    retrigger,
+    formContext?.onSamlSsoError,
+  );
 
   // Track the complete loading state (fetch + processing)
   const { completeLoading, wrapProcessing } = useProcessingState(

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/widgets/ActiveTextInput.tsx

@@ -96,7 +96,12 @@ export const ActiveTextInput: Widget<
     uiProps['fetch:retrigger'] as string[],
   );
 
-  const { data, error, loading } = useFetch(formData ?? {}, uiProps, retrigger);
+  const { data, error, loading } = useFetch(
+    formData ?? {},
+    uiProps,
+    retrigger,
+    formContext?.onSamlSsoError,
+  );
 
   // Track the complete loading state (fetch + processing)
   const { completeLoading, wrapProcessing } = useProcessingState(