fix: handle error sidecar API (#2269)

Fix #2169 Co-authored-by: Chandrasekhar Ramakrishnan <[email protected]>
SwissDataScienceCenter · Jan 10, 2023 · 8f0f3cd · 8f0f3cd
1 parent d3f4fe9
commit 8f0f3cd
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 8 deletions.
diff --git a/client/src/features/session/sidecarApi.ts b/client/src/features/session/sidecarApi.ts
@@ -1,6 +1,11 @@
 import { createApi, fetchBaseQuery } from "@reduxjs/toolkit/query/react";
 
-type HealthState = { status: string };
+type HealthState = { status: string,
+  error?: {
+    code: number;
+    message: string;
+  };
+};
 
 interface SidecarRequestArgs {
   serverName: string;
@@ -24,6 +29,10 @@ interface GitStatusResult extends JsonRpcResult {
     commit: string;
     status: string;
   };
+  error?: {
+    code: number;
+    message: string;
+  };
 }
 
 interface RenkuOpResult extends JsonRpcResult {
@@ -36,7 +45,6 @@ interface RenkuOpResult extends JsonRpcResult {
 
 interface SaveResult extends RenkuOpResult {}
 interface PullResult extends RenkuOpResult {}
-
 export const sessionSidecarApi = createApi({
   reducerPath: "sessionSidecarApi",
   baseQuery: fetchBaseQuery({ baseUrl: "/sessions/" }),

diff --git a/client/src/notebooks/components/PullSession.tsx b/client/src/notebooks/components/PullSession.tsx
@@ -59,7 +59,7 @@ function RunningPullSessionBody(props: PullSessionProps) {
   if (isLoading)
     body = <CenteredLoader />;
 
-  else if (error != null || data == null || data.status !== "running")
+  else if (error != null || data == null || data.status !== "running" || data.error)
     body = <NoSidecarBody closeModal={closeModal} />;
 
   else body = <PullSessionStatusBody closeModal={closeModal} isOpen={isOpen} sessionName={serverName} />;
@@ -97,9 +97,9 @@ function PullSessionStatusBody({ closeModal, isOpen, sessionName }: PullSessionS
   };
 
   if (isFetching || data == null) return <CenteredLoader />;
-  if (error) return <NoSidecarBody closeModal={closeModal} />;
+  if (error || data.error) return <NoSidecarBody closeModal={closeModal} />;
   if (succeeded === false) return <PullSessionFailedBody closeModal={closeModal} />;
-  if (succeeded === true) return <PullSessionUpToDateBody closeModal={closeModal}/>;
+  if (succeeded === true) return <PullSessionUpToDateBody closeModal={closeModal} />;
   if (data.result.behind < 1) return <PullSessionUpToDateBody closeModal={closeModal} />;
   if (!data.result.clean || data.result.ahead > 0)
     return <PullSessionDivergedBody clean={data.result.clean} closeModal={closeModal} />;

diff --git a/client/src/notebooks/components/SaveSession.tsx b/client/src/notebooks/components/SaveSession.tsx
@@ -64,7 +64,7 @@ function RunningSaveSessionBody(props: SaveSessionProps) {
   else if (isLoading)
     body = <CenteredLoader />;
 
-  else if (error != null || data == null || data.status !== "running")
+  else if (error != null || data == null || data.status !== "running" || data.error)
     body = <NoSidecarBody closeModal={closeModal} />;
 
   else body = <SaveSessionStatusBody closeModal={closeModal} isOpen={isOpen} sessionName={serverName} />;
@@ -118,7 +118,7 @@ function SaveSessionStatusBody({ closeModal, isOpen, sessionName }: SaveSessionS
   };
 
   if (isFetching || data == null) return <CenteredLoader />;
-  if (error) return <NoSidecarBody closeModal={closeModal} />;
+  if (error || data.error) return <NoSidecarBody closeModal={closeModal} />;
   if (data.result.behind > 0)
     return <SaveSessionNoFFBody closeModal={closeModal} gitStatus={data} isOpen={isOpen} sessionName={sessionName} />;
   if (succeeded === false) return <SaveSessionFailedBody closeModal={closeModal} />;

diff --git a/tests/cypress/e2e/local/session.spec.ts b/tests/cypress/e2e/local/session.spec.ts
@@ -143,6 +143,17 @@ describe("display a session", () => {
       .contains("It is not possible to offer a one-click refresh for this session.").should("be.visible");
   });
 
+  it("pull changes button -- sidecar error`", () => {
+    fixtures.getSidecarHealth().getGitStatusError();
+    cy.gui_open_session();
+    // pull changes
+    cy.get_cy("pull-changes-button").click();
+    cy.get(".modal-dialog").should("exist");
+    cy.get(".modal-dialog").get("h5").contains("Refresh Session").should("be.visible");
+    cy.get(".modal-dialog").get("div")
+      .contains("It is not possible to offer a one-click refresh for this session.").should("be.visible");
+  });
+
   it("pull changes button -- session clean", () => {
     fixtures.getSidecarHealth().getGitStatusClean();
     cy.gui_open_session();

diff --git a/tests/cypress/support/renkulab-fixtures/sessions.ts b/tests/cypress/support/renkulab-fixtures/sessions.ts
@@ -176,8 +176,26 @@ function Sessions<T extends FixturesConstructor>(Parent: T) {
       ).as(name);
       return this;
     }
-  };
 
+    getGitStatusError(name = "getGitStatus") {
+      const fixture = {
+        body: {
+          "error": {
+            "code": -32000,
+            // eslint-disable-next-line max-len
+            "message": "Running a git command failed with the error: fatal: could not read Username for 'https://gitlab.dev.renku.ch': No such device or address\n"
+          },
+          "id": 0,
+          "jsonrpc": "2.0"
+        } };
+
+      cy.intercept(
+        "/sessions/*/sidecar/jsonrpc",
+        fixture
+      ).as(name);
+      return this;
+    }
+  };
 }
 
 export { Sessions };