orc-shared 1.2.0-dev.2 → 1.2.0-dev.6

package/src/actions/scopes.test.js

@@ -1,16 +1,17 @@
 import { RSAA } from "redux-api-middleware";
 import {
-	GET_SCOPES_REQUEST,
-	GET_SCOPES_SUCCESS,
-	GET_SCOPES_FAILURE,
 	getScopes,
 	GET_MY_SCOPE_REQUEST,
 	GET_MY_SCOPE_SUCCESS,
 	GET_MY_SCOPE_FAILURE,
 	getDefaultScope,
-	validateOvertureModule,
+	validateOvertureApplication,
 	APPLICATION_SCOPE_HAS_CHANGED,
 	applicationScopeHasChanged,
+	getAppModules,
+	GET_APPLICATION_MODULES_REQUEST,
+	GET_APPLICATION_MODULES_SUCCESS,
+	GET_APPLICATION_MODULES_FAILURE,
 } from "./scopes";
 
 jest.mock("../utils/buildUrl", () => {
@@ -20,19 +21,71 @@ jest.mock("../utils/buildUrl", () => {
 	return modExport;
 });
 
+describe("getAppModules", () => {
+	it("creates a RSAA to fetch application modules", () => {
+		expect(getAppModules, "when called", "to exhaustively satisfy", {
+			[RSAA]: {
+				types: [GET_APPLICATION_MODULES_REQUEST, GET_APPLICATION_MODULES_SUCCESS, GET_APPLICATION_MODULES_FAILURE],
+				endpoint: 'URL: modules/byApplicationName/anApplication ""',
+				method: "GET",
+				body: undefined,
+				credentials: "include",
+				bailout: expect.it("to be a function"),
+				headers: {
+					Accept: "application/json; charset=utf-8",
+					"Content-Type": "application/json",
+				},
+				options: { redirect: "follow" },
+			},
+		});
+	});
+});
+
 describe("getScopes", () => {
-	beforeEach(() => {});
-	afterEach(() => {});
+	let originalApplication;
+
+	beforeEach(() => {
+		originalApplication = global.OVERTURE_APPLICATION;
+	});
+
+	afterEach(() => {
+		global.OVERTURE_APPLICATION = originalApplication;
+	});
 
 	it("creates a RSAA to fetch authorized scope tree", () =>
-		expect(getScopes, "when called", "to exhaustively satisfy", {
+		expect(getScopes, "when called with", ["aModule"], "to exhaustively satisfy", {
 			[RSAA]: {
-				types: [GET_SCOPES_REQUEST, GET_SCOPES_SUCCESS, GET_SCOPES_FAILURE],
+				types: [
+					{ type: "GET_SCOPES_REQUEST", meta: { module: "aModule" } },
+					{ type: "GET_SCOPES_SUCCESS", meta: { module: "aModule" } },
+					{ type: "GET_SCOPES_FAILURE", meta: { module: "aModule" } },
+				],
 				endpoint: "URL: my/scope/aModule/tree {}",
 				method: "GET",
 				body: undefined,
 				credentials: "include",
-				bailout: expect.it("to be a function"),
+				bailout: false,
+				headers: {
+					Accept: "application/json; charset=utf-8",
+					"Content-Type": "application/json",
+				},
+				options: { redirect: "follow" },
+			},
+		}));
+
+	it("creates a RSAA to fetch authorized scope tree for system module", () =>
+		expect(getScopes, "when called with", ["System"], "to exhaustively satisfy", {
+			[RSAA]: {
+				types: [
+					{ type: "GET_SCOPES_REQUEST", meta: { module: "System" } },
+					{ type: "GET_SCOPES_SUCCESS", meta: { module: "System" } },
+					{ type: "GET_SCOPES_FAILURE", meta: { module: "System" } },
+				],
+				endpoint: "URL: my/scope/Order/tree {}",
+				method: "GET",
+				body: undefined,
+				credentials: "include",
+				bailout: false,
 				headers: {
 					Accept: "application/json; charset=utf-8",
 					"Content-Type": "application/json",
@@ -42,14 +95,31 @@ describe("getScopes", () => {
 		}));
 
 	it("creates a RSAA to fetch default user scope", () =>
-		expect(getDefaultScope, "when called", "to exhaustively satisfy", {
+		expect(getDefaultScope, "when called with", ["aModule"], "to exhaustively satisfy", {
 			[RSAA]: {
 				types: [GET_MY_SCOPE_REQUEST, GET_MY_SCOPE_SUCCESS, GET_MY_SCOPE_FAILURE],
 				endpoint: 'URL: my/scope/aModule ""',
 				method: "GET",
 				body: undefined,
 				credentials: "include",
-				bailout: expect.it("to be a function"),
+				bailout: false,
+				headers: {
+					Accept: "application/json; charset=utf-8",
+					"Content-Type": "application/json",
+				},
+				options: { redirect: "follow" },
+			},
+		}));
+
+	it("creates a RSAA to fetch default user scope for System module", () =>
+		expect(getDefaultScope, "when called with", ["System"], "to exhaustively satisfy", {
+			[RSAA]: {
+				types: [GET_MY_SCOPE_REQUEST, GET_MY_SCOPE_SUCCESS, GET_MY_SCOPE_FAILURE],
+				endpoint: 'URL: my/scope/Order ""',
+				method: "GET",
+				body: undefined,
+				credentials: "include",
+				bailout: false,
 				headers: {
 					Accept: "application/json; charset=utf-8",
 					"Content-Type": "application/json",
@@ -59,11 +129,11 @@ describe("getScopes", () => {
 		}));
 
 	it("throws an error if no class found on DOM element", () => {
-		global.OVERTURE_MODULE = "";
+		global.OVERTURE_APPLICATION = "";
 		expect(
-			() => expect(validateOvertureModule, "when called with", []),
+			() => expect(validateOvertureApplication, "when called with", []),
 			"to throw",
-			'"overtureModule.name" is missing in the configuration.',
+			'"overtureApplication.name" is missing in the configuration.',
 		);
 	});
 });

package/src/components/AppFrame/AppFrame.test.js

@@ -202,6 +202,15 @@ describe("AppFrame", () => {
 					bar: true,
 				},
 			},
+			modules: {
+				tree: "modulesTree",
+				visibleModules: ["a", "module123", "test1", "test2", "test3"],
+				lastScopeAndModuleSelection: {
+					scope: "Norway",
+					moduleName: "Profiles",
+					routingPerformed: false,
+				},
+			},
 			settings: { defaultScope: "myScope", defaultApp: "12" },
 			versionInfo: { version: "4.2", defaultHelpUrl: "help_url", moduleHelpUrls: [] },
 			view: { scopeSelector: { filter: "1" }, __prefsDialog: { show: false } },

package/src/components/AppFrame/MenuItem.js

@@ -1,5 +1,4 @@
 import React, { useRef } from "react";
-import { useSelector } from "react-redux";
 import styled, { css } from "styled-components";
 import transition from "styled-transition-group";
 import { Link } from "react-router-dom";
@@ -124,13 +123,11 @@ const MenuItem = ({
 	alert,
 	pageScopeSelector,
 	closingTabHandler,
-	hide,
+	hide, // This props is not used in the component, but we need to destructure it so props can be used in ItemWrapper
+	isHidden = false,
 	href,
 	...props
 }) => {
-	let hideSelector = state => (typeof hide === "function" ? hide(state) : hide ?? false);
-	const isHidden = useSelector(hideSelector);
-
 	let ItemWrapper = Block;
 	if (props.menuToggle) {
 		ItemWrapper = BlockWithA;
@@ -139,6 +136,7 @@ const MenuItem = ({
 	if (alert && alert.message) {
 		alertMessage.current = alert.message;
 	}
+
 	return (
 		!isHidden && (
 			<ItemWrapper to={href} {...props}>

package/src/components/AppFrame/MenuItem.test.js

@@ -168,7 +168,7 @@ describe("MenuItem", () => {
 			</MemoryRouter>,
 		));
 
-	it("shows nothing if hide is true", () => {
+	it("shows nothing if isHidden is true", () => {
 		expect(
 			<Provider store={store}>
 				<MemoryRouter>
@@ -178,29 +178,7 @@ describe("MenuItem", () => {
 						icon="cake"
 						label="Test"
 						alert={{ message: "Test message", type: "warn" }}
-						hide={true}
-					/>
-				</MemoryRouter>
-			</Provider>,
-			"when mounted",
-			"to equal",
-			null,
-		);
-	});
-
-	it("shows nothing if hide selector returns true", () => {
-		const hide = state => true;
-
-		expect(
-			<Provider store={store}>
-				<MemoryRouter>
-					<MenuItem
-						id="test"
-						href="/foo/test"
-						icon="cake"
-						label="Test"
-						alert={{ message: "Test message", type: "warn" }}
-						hide={hide}
+						isHidden={true}
 					/>
 				</MemoryRouter>
 			</Provider>,

package/src/components/AppFrame/Sidebar.js

@@ -5,6 +5,7 @@ import { useLocation } from "react-router-dom";
 import { getThemeProp } from "../../utils";
 import { selectPrependHrefConfig } from "../../selectors/navigation";
 import MenuItem from "./MenuItem";
+import { getScopeModuleInformationSelector } from "../../selectors/modules";
 
 export const Bar = styled.div`
 	box-sizing: border-box;
@@ -40,7 +41,13 @@ const useEnhancement = id => {
 	};
 };
 
-export const EnhancedMenuItem = ({ id, ...props }) => <MenuItem {...props} {...useEnhancement(id)} />;
+export const EnhancedMenuItem = ({ id, ...props }) => {
+	const defaultModule = useSelector(getScopeModuleInformationSelector);
+
+	const isHidden = !defaultModule.visibleModules.includes(id);
+
+	return <MenuItem {...props} {...useEnhancement(id)} isHidden={isHidden} />;
+};
 
 const LogoSvg = styled.svg`
 	flex: 0 0 auto;

package/src/components/AppFrame/Sidebar.test.js

@@ -24,6 +24,15 @@ describe("Sidebar", () => {
 		state = Immutable.fromJS({
 			navigation: { route: { match: { params: { scope: "Global" } } }, config: { prependHref: "/Global/" } },
 			settings: { defaultScope: "myScope" },
+			modules: {
+				tree: "modulesTree",
+				visibleModules: ["a", "module123"],
+				lastScopeAndModuleSelection: {
+					scope: "Norway",
+					moduleName: "Profiles",
+					routingPerformed: false,
+				},
+			},
 		});
 		store = {
 			subscribe: () => {},
@@ -153,6 +162,15 @@ describe("EnhancedMenuItem", () => {
 						},
 						config: { prependHref: "/Global/" },
 					},
+					modules: {
+						tree: "modulesTree",
+						visibleModules: ["route"],
+						lastScopeAndModuleSelection: {
+							scope: "Norway",
+							moduleName: "Profiles",
+							routingPerformed: false,
+						},
+					},
 					settings: { defaultScope: "myScope" },
 				}),
 		};

package/src/components/ApplicationModuleLoader.js

@@ -0,0 +1,52 @@
+import React, { useEffect, useState } from "react";
+import { useDispatch, useSelector } from "react-redux";
+import { getDefaultScope, getScopes } from "../actions/scopes";
+import {
+	defaultScopeSelector,
+	getApplicationModulesSelector,
+	getLoadedModulesScopeSelector,
+} from "../selectors/settings";
+import { Loader } from "./Authenticate";
+import { overtureModule, scopeTypes } from "../constants";
+import { initializeFirstModuleScope } from "../actions/modules";
+
+const ApplicationModuleLoader = ({ children }) => {
+	const dispatch = useDispatch();
+
+	const [scopesLoaded, setScopesLoaded] = useState(false);
+
+	const loadedModules = useSelector(getLoadedModulesScopeSelector);
+	const applicationModules = useSelector(getApplicationModulesSelector);
+	const defaultScope = useSelector(defaultScopeSelector);
+
+	useEffect(() => {
+		if (applicationModules.length > 0 && scopesLoaded === false) {
+			if (applicationModules.includes(overtureModule.System)) {
+				dispatch(initializeFirstModuleScope(scopeTypes.global));
+			}
+
+			applicationModules.forEach(x => {
+				// For the default scope, the latest that will be returned will be the chosen one
+				dispatch(getDefaultScope(x));
+				// For scopes, they need to be merged
+				dispatch(getScopes(x));
+			});
+
+			setScopesLoaded(true);
+		}
+	}, [dispatch, applicationModules, scopesLoaded]);
+
+	const scopeLoadedFromAllModules =
+		applicationModules.length > 0 &&
+		applicationModules.reduce((prev, current) => prev && loadedModules.includes(current), true);
+
+	const applicationModuleReady = scopeLoadedFromAllModules && defaultScope != null;
+
+	if (!applicationModuleReady) {
+		return <Loader />;
+	}
+
+	return React.Children.only(children);
+};
+
+export default ApplicationModuleLoader;

package/src/components/ApplicationModuleLoader.test.js

@@ -0,0 +1,149 @@
+import React from "react";
+import Immutable from "immutable";
+import { Provider } from "react-redux";
+import { ThemeProvider } from "styled-components";
+import { Loader } from "./Authenticate";
+import ApplicationModuleLoader from "./ApplicationModuleLoader";
+import { mount } from "enzyme";
+import { getDefaultScope, getScopes } from "../actions/scopes";
+import sinon from "sinon";
+import { initializeFirstModuleScope } from "../actions/modules";
+import { scopeTypes } from "../constants";
+
+const TestComp = () => {
+	return <div className="test" />;
+};
+
+jest.mock("../utils/buildUrl", () => {
+	const modExport = {};
+	modExport.loadConfig = () => Promise.resolve({});
+	modExport.buildUrl = (path = [], params = "") => "URL: " + path.join("/") + " " + JSON.stringify(params);
+	return modExport;
+});
+
+describe("ApplicationModuleLoader", () => {
+	let state, store;
+
+	beforeEach(() => {
+		state = Immutable.fromJS({
+			requests: {},
+			scopes: {
+				test1: {
+					id: "test1",
+					name: { "en-CA": "Test 1", "en-US": "Test 1" },
+					children: ["test2"],
+				},
+			},
+			authentication: {
+				name: "foo@bar.com",
+			},
+			settings: {
+				defaultScope: "aDefaultScope",
+				loadedModulesScope: ["moduleA", "moduleB"],
+				modules: ["moduleA", "moduleB"],
+			},
+		});
+		store = state => ({
+			subscribe: () => {},
+			getState: () => state,
+			dispatch: sinon.spy().named("dispatch"),
+		});
+	});
+
+	it("shows the component when scopes configuration are all loaded", () =>
+		expect(
+			<Provider store={store(state)}>
+				<ApplicationModuleLoader>
+					<TestComp />
+				</ApplicationModuleLoader>
+			</Provider>,
+			"when mounted",
+			"to exhaustively satisfy",
+			<TestComp />,
+		));
+
+	it("shows a load indicator component when default scope is still unknown", () => {
+		state = state.setIn(["settings", "defaultScope"], null);
+		return expect(
+			<Provider store={store(state)}>
+				<ThemeProvider theme={{}}>
+					<ApplicationModuleLoader>
+						<TestComp />
+					</ApplicationModuleLoader>
+				</ThemeProvider>
+			</Provider>,
+			"when mounted",
+			"to exhaustively satisfy",
+			<ThemeProvider theme={{}}>
+				<Loader />
+			</ThemeProvider>,
+		);
+	});
+
+	it("shows a load indicator component when scopes trees are not loaded for all modules", () => {
+		state = state.setIn(["settings", "loadedModulesScope"], Immutable.fromJS(["moduleA"]));
+		return expect(
+			<Provider store={store(state)}>
+				<ThemeProvider theme={{}}>
+					<ApplicationModuleLoader>
+						<TestComp />
+					</ApplicationModuleLoader>
+				</ThemeProvider>
+			</Provider>,
+			"when mounted",
+			"to exhaustively satisfy",
+			<ThemeProvider theme={{}}>
+				<Loader />
+			</ThemeProvider>,
+		);
+	});
+
+	it("scopes tree and default scope should be loaded when rendering the component", () => {
+		const theStore = store(state);
+
+		const component = (
+			<Provider store={theStore}>
+				<ThemeProvider theme={{}}>
+					<ApplicationModuleLoader>
+						<TestComp />
+					</ApplicationModuleLoader>
+				</ThemeProvider>
+			</Provider>
+		);
+
+		mount(component);
+
+		expect(theStore.dispatch, "to have calls satisfying", [
+			{ args: [getDefaultScope("moduleA")] },
+			{ args: [getScopes("moduleA")] },
+			{ args: [getDefaultScope("moduleB")] },
+			{ args: [getScopes("moduleB")] },
+		]);
+	});
+
+	it("First module scope should be initialized when System is part application modules", () => {
+		state = state.setIn(["settings", "modules"], Immutable.fromJS(["moduleA", "System"]));
+
+		const theStore = store(state);
+
+		const component = (
+			<Provider store={theStore}>
+				<ThemeProvider theme={{}}>
+					<ApplicationModuleLoader>
+						<TestComp />
+					</ApplicationModuleLoader>
+				</ThemeProvider>
+			</Provider>
+		);
+
+		mount(component);
+
+		expect(theStore.dispatch, "to have calls satisfying", [
+			{ args: [initializeFirstModuleScope(scopeTypes.global)] },
+			{ args: [getDefaultScope("moduleA")] },
+			{ args: [getScopes("moduleA")] },
+			{ args: [getDefaultScope("System")] },
+			{ args: [getScopes("System")] },
+		]);
+	});
+});

package/src/components/Authenticate.js

@@ -6,10 +6,10 @@ import { useSelector } from "react-redux";
 import { unwrapImmutable } from "../utils";
 import { GET_AUTHENTICATION_PROFILE } from "../actions/authentication";
 import { ERROR, LOGOUT } from "../reducers/request";
+import ApplicationModuleLoader from "./ApplicationModuleLoader";
 
 export const useAuthenticationData = () => ({
 	loading: useSelector(state => state.getIn(["requests", "actives", GET_AUTHENTICATION_PROFILE])),
-	defaultScope: useSelector(state => state.getIn(["settings", "defaultScope"])) || null,
 	authedUser: useSelector(state => state.getIn(["authentication", "name"])),
 	requestError: unwrapImmutable(useSelector(state => state.getIn(["requests", ERROR]) || null)),
 	needLogin: useSelector(state => state.getIn(["requests", LOGOUT])),
@@ -47,14 +47,15 @@ export const Error = ({ requestError, needLogin }) => {
 };
 
 const Authenticate = ({ children }) => {
-	const { loading, defaultScope, authedUser, requestError, needLogin } = useAuthenticationData();
-	if (loading || defaultScope === null) {
+	const { loading, authedUser, requestError, needLogin } = useAuthenticationData();
+
+	if (loading) {
 		return <Loader />;
 	}
 	if (!authedUser) {
 		return <Error {...{ requestError, needLogin }} />;
 	} else {
-		return React.Children.only(children);
+		return <ApplicationModuleLoader children={children} />;
 	}
 };
 

package/src/components/Authenticate.test.js

@@ -7,19 +7,36 @@ import { ERROR, LOGOUT } from "../reducers/request";
 import { GET_AUTHENTICATION_PROFILE } from "../actions/authentication";
 
 const TestComp = () => {
-	return <div className="test"></div>;
+	return <div className="test" />;
 };
 
+jest.mock("../utils/buildUrl", () => {
+	const modExport = {};
+	modExport.loadConfig = () => Promise.resolve({});
+	modExport.buildUrl = () => "URL";
+	return modExport;
+});
+
 describe("Authenticate", () => {
 	let state, store;
+
 	beforeEach(() => {
 		state = Immutable.fromJS({
 			requests: {},
+			scopes: {
+				test1: {
+					id: "test1",
+					name: { "en-CA": "Test 1", "en-US": "Test 1" },
+					children: ["test2"],
+				},
+			},
 			authentication: {
 				name: "foo@bar.com",
 			},
 			settings: {
 				defaultScope: "aDefaultScope",
+				loadedModulesScope: ["moduleA", "moduleB"],
+				modules: ["moduleA", "moduleB"],
 			},
 		});
 		store = state => ({
@@ -38,7 +55,9 @@ describe("Authenticate", () => {
 			</Provider>,
 			"when mounted",
 			"to exhaustively satisfy",
-			<TestComp />,
+			<Provider store={store(state)}>
+				<TestComp />
+			</Provider>,
 		));
 
 	it("shows a load indicator component if authentication is ongoing", () => {
@@ -59,12 +78,12 @@ describe("Authenticate", () => {
 		);
 	});
 
-	it("shows a load indicator component if default scope is unknown", () => {
+	it("shows a load indicator component when application modules not ready", () => {
 		state = state.setIn(["settings", "defaultScope"], null);
 		return expect(
 			<Provider store={store(state)}>
 				<ThemeProvider theme={{}}>
-					<Authenticate>
+					<Authenticate applicationModuleReady={false}>
 						<TestComp />
 					</Authenticate>
 				</ThemeProvider>

package/src/components/MaterialUI/DataDisplay/SelectionList.js

@@ -54,7 +54,7 @@ const formatOnChange = (data, ids) => {
 	const selectedItems = data.filter(dataItem => ids.includes(dataItem.id));
 
 	return {
-		selectedItems: [...selectedItems],
+		left: [...selectedItems],
 	};
 };
 

package/src/components/MaterialUI/DataDisplay/SelectionList.test.js

@@ -179,7 +179,7 @@ describe("SelectionList", () => {
 		let item = mountedComponent.find(ListItem).at(0);
 		item.invoke("onClick")();
 
-		expect(onChange.args[2][0], "to equal", { selectedItems: [list[0]] });
+		expect(onChange.args[2][0], "to equal", { left: [list[0]] });
 	});
 
 	it("Calls onChange with defaultSelection", () => {
@@ -196,7 +196,7 @@ describe("SelectionList", () => {
 
 		mount(component);
 
-		expect(onChange.args[1][0], "to equal", { selectedItems: [data[1]] });
+		expect(onChange.args[1][0], "to equal", { left: [data[1]] });
 	});
 
 	it("handle scrolling event", () => {

package/src/components/MaterialUI/Navigation/ExternalLink.js

@@ -0,0 +1,25 @@
+import React from "react";
+import Link from "@material-ui/core/Link";
+import Icon from "../DataDisplay/Icon";
+import { makeStyles } from "@material-ui/core/styles";
+
+const useStyles = makeStyles(theme => ({
+	icon: {
+		paddingLeft: theme.spacing(1),
+		width: theme.spacing(1.2),
+		color: theme.palette.primary.main,
+	},
+}));
+
+const ExternalLink = ({ id, url, children }) => {
+	const classes = useStyles();
+
+	return (
+		<Link id={id} href={url} rel="noreferrer" target="_blank" underline="always">
+			{children}
+			<Icon id="open-in-new-tab" className={classes.icon} />
+		</Link>
+	);
+};
+
+export default ExternalLink;

package/src/components/MaterialUI/Navigation/ExternalLink.test.js

@@ -0,0 +1,26 @@
+import React from "react";
+import Link from "@material-ui/core/Link";
+import Icon from "../DataDisplay/Icon";
+import ExternalLink from "./ExternalLink";
+
+describe("ExternalLink", () => {
+	it("render ExternalLink without errors", () => {
+		const children = <div>a div element</div>;
+
+		expect(
+			<ExternalLink id="an_Id" url="https://www.npmjs.com/package/orc-shared" children={children} />,
+			"when mounted",
+			"to satisfy",
+			<Link
+				id="an_Id"
+				href="https://www.npmjs.com/package/orc-shared"
+				rel="noreferrer"
+				target="_blank"
+				underline="always"
+			>
+				{children}
+				<Icon id="open-in-new-tab" />
+			</Link>,
+		);
+	});
+});

package/src/components/MaterialUI/muiThemes.js

@@ -158,6 +158,11 @@ const setThemeOverrides = theme => ({
 			},
 		},
 	},
+	MuiLink: {
+		root: {
+			fontSize: theme.spacing(1.3),
+		},
+	},
 	MuiButton: {
 		...theme.MuiButton,
 		root: {