Add small fixes and code comments to reset state logic

scm-ui/ui-webapp/package.json

@@ -39,6 +39,7 @@
     "@types/react-dom": "^16.9.2",
     "@types/react-redux": "5.0.7",
     "@types/react-router-dom": "^5.1.0",
+    "@types/redux-logger": "^3.0.8",
     "@types/styled-components": "^5.1.0",
     "@types/systemjs": "^0.20.6",
     "fetch-mock": "^7.5.1",

scm-ui/ui-webapp/src/createReduxStore.ts

@@ -40,12 +40,13 @@ import roles from "./admin/roles/modules/roles";
 import namespaceStrategies from "./admin/modules/namespaceStrategies";
 import indexResources from "./modules/indexResource";
 import plugins from "./admin/plugins/modules/plugins";
-import { apiClient } from "@scm-manager/ui-components";
-
+import { apiClient, UnauthorizedError } from "@scm-manager/ui-components";
 import branches from "./repos/branches/modules/branches";
-import { UnauthorizedError } from "@scm-manager/ui-components/src";
+
+const EMPTY_STATE = {} as any;
 
 function createReduxStore() {
+  // @ts-ignore __REDUX_DEVTOOLS_EXTENSION_COMPOSE__ is defined by react dev tools
   const composeEnhancers = window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose;
 
   const appReducer = combineReducers({
@@ -67,27 +68,38 @@ function createReduxStore() {
     plugins
   });
 
+  // We assume that an UnauthorizedError means that the access token is expired.
+  // If the token is expired we want to show an error with the login link.
+  // This error should be displayed with the state (e.g. navigation) of the previous logged in user.
+  // But if the user navigates away, we want to reset the state to an anonymous one.
+
   const reducer = (state: any, action: AnyAction) => {
-    console.log(action.type, state?.tokenExpired);
-    if (state?.tokenExpired && action.type.indexOf("FAILURE") === -1) {
-      console.log("reset state");
-      return appReducer({}, action);
+    // Reset the state if the token is expired and a new action is dispatched (e.g. navigation).
+    // We exclude failures, because the fetch which had triggered the unauthorized error
+    // will likely end with an failure action.
+    if (state.tokenExpired && !action.type.includes("FAILURE")) {
+      // reset state by passing an empty state down to the app reducer
+      // we do not use the captured action, because the data is derived from the old state
+      return appReducer(EMPTY_STATE, { type: "_" });
     }
 
+    // If the user is authenticated and response is an unauthorized error,
+    // we assume that the token is expired.
     if (action.type === "API_CLIENT_UNAUTHORIZED" && isAuthenticated(state)) {
       return { ...state, tokenExpired: true };
     }
 
-    return { ...appReducer(state, action), tokenExpired: state?.tokenExpired };
+    // Keep the tokenExpired after calling appReducer,
+    // this is required because the appReducer would remove any unknown property.
+    return { ...appReducer(state, action), tokenExpired: state.tokenExpired };
   };
 
-  const store = createStore(reducer, composeEnhancers(applyMiddleware(thunk, logger)));
+  const store = createStore(reducer, EMPTY_STATE, composeEnhancers(applyMiddleware(thunk, logger)));
   apiClient.onError(error => {
     if (error instanceof UnauthorizedError) {
       store.dispatch({ type: "API_CLIENT_UNAUTHORIZED", error });
     }
   });
-
   return store;
 }
 

yarn.lock

@@ -3397,6 +3397,13 @@
     "@types/prop-types" "*"
     csstype "^2.2.0"
 
+"@types/redux-logger@^3.0.8":
+  version "3.0.8"
+  resolved "https://registry.yarnpkg.com/@types/redux-logger/-/redux-logger-3.0.8.tgz#1fb6d26917bb198792bb1cf57feb31cae1532c5d"
+  integrity sha512-zM+cxiSw6nZtRbxpVp9SE3x/X77Z7e7YAfHD1NkxJyJbAGSXJGF0E9aqajZfPOa/sTYnuwutmlCldveExuCeLw==
+  dependencies:
+    redux "^4.0.0"
+
 "@types/sinonjs__fake-timers@^6.0.1":
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/@types/sinonjs__fake-timers/-/sinonjs__fake-timers-6.0.1.tgz#681df970358c82836b42f989188d133e218c458e"