orc-shared 1.5.0-dev.10 → 1.5.0-dev.11

package/src/components/TaskDetailsModal.test.js

@@ -0,0 +1,317 @@
+import React from "react";
+import Immutable from "immutable";
+import { mount } from "enzyme";
+import TaskDetailsModal from "./TaskDetailsModal";
+import Modal from "./MaterialUI/DataDisplay/Modal";
+import { defaultCulture } from "../selectors/locale";
+import sinon from "sinon";
+import { createMuiTheme, extractMessages, TestWrapper } from "../utils/testUtils";
+import sharedMessages from "../sharedMessages";
+import ModalProps from "./MaterialUI/DataDisplay/modalProps";
+import { Ignore } from "unexpected-reaction";
+import InformationItem from "./MaterialUI/DataDisplay/PredefinedElements/InformationItem";
+import { clearTaskLog, getTaskInfo, getTaskLog } from "../actions/tasks";
+import { taskStatuses } from "../constants";
+
+const messages = extractMessages(sharedMessages);
+
+jest.mock("../utils/buildUrl", () => {
+	const modExport = {};
+	modExport.loadConfig = () => Promise.resolve({});
+	modExport.buildUrl = (path = [], params = "") => "URL: " + path.join("/") + " " + JSON.stringify(params);
+	return modExport;
+});
+
+function removeBailout(obj) {
+	delete obj["@@redux-api-middleware/RSAA"].bailout;
+	return obj;
+}
+
+describe("TaskDetailsModal", () => {
+	let state, dispatch, store, clearIntervalSpy;
+	const theme = createMuiTheme();
+
+	beforeEach(() => {
+		//window.bypassDebounce = true;
+
+		dispatch = sinon.spy().named("dispatch");
+		jest.useFakeTimers();
+		clearIntervalSpy = sinon.spy(global, "clearInterval");
+
+		state = Immutable.fromJS({
+			requests: {
+				logout: false,
+			},
+			metadata: {
+				lookups: {},
+			},
+			tasks: {
+				taskInfos: {},
+				tasks: [],
+				logs: {},
+			},
+			locale: {
+				defaultCulture: defaultCulture,
+			},
+		});
+
+		store = {
+			getState: () => state,
+			subscribe: () => {},
+			dispatch: dispatch,
+		};
+	});
+	afterEach(() => {
+		jest.useRealTimers();
+		jest.restoreAllMocks();
+		clearIntervalSpy.restore();
+	});
+
+	it("renders a modal for task", () => {
+		const modalProps = new ModalProps();
+
+		modalProps.set(ModalProps.propNames.title, "Task In Progress");
+		modalProps.set(ModalProps.propNames.open, true);
+		modalProps.set(ModalProps.propNames.type, "wide");
+		modalProps.set(ModalProps.propNames.actionPanel, <Ignore />);
+
+		const expectedContent = (
+			<div>
+				<InformationItem label={sharedMessages.taskId}>1234</InformationItem>
+				<InformationItem label={sharedMessages.taskStatus}>
+					<Ignore />
+				</InformationItem>
+				<InformationItem label={sharedMessages.taskLogs}>
+					<textarea />
+				</InformationItem>
+			</div>
+		);
+
+		expect(
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<TaskDetailsModal taskId="1234" open={true} closeModal={() => {}} />
+			</TestWrapper>,
+			"when mounted",
+			"to satisfy",
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<Modal message={expectedContent} modalProps={modalProps} />
+			</TestWrapper>,
+		).then(() => expect(console.error, "was not called"));
+	});
+
+	it("renders a modal for task with status and logs", () => {
+		state = state.setIn(
+			["tasks", "logs", "1234"],
+			[
+				{ executionTime: "", message: null },
+				{ executionTime: "4", message: "msg\r\n" },
+				{ executionTime: "3", message: "another" },
+			],
+		);
+		state = state.setIn(["tasks", "taskInfos", "1234"], { status: taskStatuses.running });
+
+		const modalProps = new ModalProps();
+
+		modalProps.set(ModalProps.propNames.title, "Task In Progress");
+		modalProps.set(ModalProps.propNames.open, true);
+		modalProps.set(ModalProps.propNames.type, "wide");
+		modalProps.set(ModalProps.propNames.actionPanel, <Ignore />);
+
+		const expectedContent = (
+			<div>
+				<InformationItem label={sharedMessages.taskId}>1234</InformationItem>
+				<InformationItem label={sharedMessages.taskStatus}>[Running]</InformationItem>
+				<InformationItem label={sharedMessages.taskLogs}>
+					<textarea readOnly value={"another\nmsg"} />
+				</InformationItem>
+			</div>
+		);
+
+		expect(
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<TaskDetailsModal taskId="1234" open={true} closeModal={() => {}} />
+			</TestWrapper>,
+			"when mounted",
+			"to satisfy",
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<Modal message={expectedContent} modalProps={modalProps} />
+			</TestWrapper>,
+		).then(() => expect(console.error, "was not called"));
+	});
+
+	it("close the dialog", () => {
+		const closeSpy = sinon.spy().named("close");
+
+		const content = (
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<TaskDetailsModal taskId="1234" open={true} closeModal={closeSpy} />
+			</TestWrapper>
+		);
+
+		const mountedComponent = mount(content);
+		store.dispatch.resetHistory();
+
+		const input = mountedComponent.find("[data-qa='" + sharedMessages.close.id + "']").at(0);
+		input.simulate("click");
+
+		expect(closeSpy, "was called");
+		expect(store.dispatch, "to have calls satisfying", [
+			{
+				args: [clearTaskLog("1234")],
+			},
+		]);
+	});
+
+	it("clear timer on unmount", () => {
+		const closeSpy = sinon.spy().named("close");
+		const content = (
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<TaskDetailsModal taskId="1234" open={true} closeModal={closeSpy} />
+			</TestWrapper>
+		);
+
+		const mountedComponent = mount(content);
+		clearIntervalSpy.resetHistory();
+		mountedComponent.unmount();
+
+		expect(clearIntervalSpy, "was called");
+	});
+
+	it("taskInfo is called to load data", () => {
+		const content = (
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<TaskDetailsModal taskId="1234" open={true} closeModal={() => {}} />
+			</TestWrapper>
+		);
+
+		mount(content);
+
+		expect(store.dispatch, "to have calls satisfying", [
+			{
+				args: [removeBailout(getTaskInfo("1234"))],
+			},
+		]);
+		expect(store.dispatch, "not to have calls satisfying", [
+			{
+				args: [removeBailout(getTaskLog("1234"))],
+			},
+		]);
+	});
+
+	it("taskLogs is called to load data", () => {
+		const content = (
+			<TestWrapper
+				provider={{ store }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+				intlProvider={{ messages }}
+			>
+				<TaskDetailsModal taskId="1234" open={true} closeModal={() => {}} />
+			</TestWrapper>
+		);
+
+		mount(content);
+
+		expect(store.dispatch, "to have calls satisfying", [
+			{
+				args: [removeBailout(getTaskInfo("1234"))],
+			},
+		]);
+
+		store.dispatch.resetHistory();
+
+		jest.runOnlyPendingTimers();
+
+		expect(store.dispatch, "to have calls satisfying", [
+			{
+				args: [removeBailout(getTaskInfo("1234"))],
+			},
+			{
+				args: [removeBailout(getTaskLog("1234", false))],
+			},
+		]);
+	});
+
+	it.each([taskStatuses.faulted, taskStatuses.ranToCompletion, taskStatuses.canceled, taskStatuses.ignored])(
+		"taskLogs is not called because task is completed (%s)",
+		newStatus => {
+			state = state.setIn(["tasks", "taskInfos", "1234"], { status: newStatus });
+
+			const content = (
+				<TestWrapper
+					provider={{ store }}
+					memoryRouter
+					stylesProvider
+					muiThemeProvider={{ theme }}
+					intlProvider={{ messages }}
+				>
+					<TaskDetailsModal taskId="1234" open={true} closeModal={() => {}} />
+				</TestWrapper>
+			);
+
+			mount(content);
+
+			expect(store.dispatch, "not to have calls satisfying", [
+				{
+					args: [removeBailout(getTaskInfo("1234"))],
+				},
+			]);
+
+			store.dispatch.resetHistory();
+
+			jest.runOnlyPendingTimers();
+
+			expect(store.dispatch, "not to have calls satisfying", [
+				{
+					args: [removeBailout(getTaskInfo("1234"))],
+				},
+				{
+					args: [removeBailout(getTaskLog("1234"))],
+				},
+			]);
+		},
+	);
+});

package/src/components/Text.test.js

@@ -1,7 +1,8 @@
 import React from "react";
-import { Provider } from "react-redux";
-import { IntlProvider } from "react-intl";
 import Text, { Placeholder } from "./Text";
+import { createMuiTheme, TestWrapper } from "../utils/testUtils";
+
+const theme = createMuiTheme();
 
 describe("Text", () => {
 	let state, store;
@@ -16,11 +17,9 @@ describe("Text", () => {
 
 	it("renders a simple message", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text message="Test message" />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text message="Test message" />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			"Test message",
@@ -28,11 +27,9 @@ describe("Text", () => {
 
 	it("renders an empty string", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text message="" />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text message="" />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			"",
@@ -40,11 +37,9 @@ describe("Text", () => {
 
 	it("renders a translated message", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text message={{ id: "test.msg", defaultMessage: "Test message" }} />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text message={{ id: "test.msg", defaultMessage: "Test message" }} />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			"Test message",
@@ -52,17 +47,15 @@ describe("Text", () => {
 
 	it("renders a translated message with values", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text
-						message={{
-							id: "test.msg",
-							defaultMessage: "Test message {foo}",
-							values: { foo: 3 },
-						}}
-					/>
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text
+					message={{
+						id: "test.msg",
+						defaultMessage: "Test message {foo}",
+						values: { foo: 3 },
+					}}
+				/>
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			"Test message 3",
@@ -70,17 +63,15 @@ describe("Text", () => {
 
 	it("renders a translated message with a value selector", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text
-						message={{
-							id: "test.msg",
-							defaultMessage: "Test message {foo}",
-							values: state => state.dataVal,
-						}}
-					/>
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text
+					message={{
+						id: "test.msg",
+						defaultMessage: "Test message {foo}",
+						values: state => state.dataVal,
+					}}
+				/>
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			"Test message 3",
@@ -88,16 +79,14 @@ describe("Text", () => {
 
 	it("renders a translated message missing its values as a placeholder", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text
-						message={{
-							id: "test.msg",
-							defaultMessage: "Test message {foo}",
-						}}
-					/>
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text
+					message={{
+						id: "test.msg",
+						defaultMessage: "Test message {foo}",
+					}}
+				/>
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			<Placeholder />,
@@ -105,11 +94,9 @@ describe("Text", () => {
 
 	it("renders an error", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text message="Test message" error={{ message: "This failed" }} />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text message="Test message" error={{ message: "This failed" }} />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			<span
@@ -126,11 +113,9 @@ describe("Text", () => {
 
 	it("renders an error if no message given", () =>
 		expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<Text />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<Text />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			<span

package/src/constants.js

@@ -107,3 +107,16 @@ export const requestStateOperationMap = {
 	fetch: "fetches",
 	update: "updates",
 };
+
+export const taskStatuses = {
+	created: "Created",
+	waitingToRun: "WaitingToRun",
+	running: "Running",
+	ranToCompletion: "RanToCompletion",
+	canceled: "Canceled",
+	faulted: "Faulted",
+	idle: "Idle",
+	waitingToCancel: "WaitingToCancel",
+	ignored: "Ignored",
+	queuedForSequence: "QueuedForSequence",
+};

package/src/hooks/useLabelMessage.test.js

@@ -5,12 +5,14 @@ import Immutable from "immutable";
 import sinon from "sinon";
 import { messageContainsValues } from "./useLabelMessage";
 import useLabelMessage from "./useLabelMessage";
+import { createMuiTheme, extractMessages, TestWrapper } from "../utils/testUtils";
 
 const TestComp = ({ message, buildMessage }) => {
 	const [msgResult, missingValues = false] = useLabelMessage(message, buildMessage);
 
 	return <div missing-values={missingValues ? 1 : 0}>{msgResult}</div>;
 };
+const theme = createMuiTheme();
 
 describe("useLabelMessage", () => {
 	let store, state;
@@ -45,12 +47,18 @@ describe("useLabelMessage", () => {
 			values: { aValue: "testValue" },
 		};
 
+		const messages = extractMessages({ "test.msg": message });
+
 		return expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<TestComp message={message} />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper
+				provider={{ store }}
+				intlProvider={{ messages }}
+				memoryRouter
+				stylesProvider
+				muiThemeProvider={{ theme }}
+			>
+				<TestComp message={message} />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			<div>Test message testValue</div>,
@@ -65,11 +73,9 @@ describe("useLabelMessage", () => {
 		};
 
 		return expect(
-			<Provider store={store}>
-				<IntlProvider locale="en">
-					<TestComp message={message} />
-				</IntlProvider>
-			</Provider>,
+			<TestWrapper provider={{ store }} intlProvider memoryRouter stylesProvider muiThemeProvider={{ theme }}>
+				<TestComp message={message} />
+			</TestWrapper>,
 			"when mounted",
 			"to satisfy",
 			<div missing-values={1}></div>,

package/src/reducers/request.js

@@ -11,6 +11,10 @@ export const LOGOUT = "logout";
 
 const requestReducer = (state = initialState, action) => {
 	if (action.type.endsWith("_REQUEST")) {
+		if (safeGet(action, "meta", "addToActiveRequests") === false) {
+			// this flag should only be used by requests triggered by a background process to avoid the spinner
+			return state;
+		}
 		const requestName = action.type.replace(/_REQUEST$/, "");
 		return state.setIn(["actives", requestName], true);
 	}

package/src/reducers/request.test.js

@@ -28,6 +28,17 @@ describe("Request reducer", () => {
 		);
 	});
 
+	it("ignore activity flag when a request is started because addToActiveRequests is false", () => {
+		const oldState = Immutable.fromJS({
+			actives: {
+				SOME_FLAG: true,
+			},
+		});
+		const action = { type: "TEST_THIS_REQUEST", meta: { addToActiveRequests: false } };
+		const newState = reducer(oldState, action);
+		expect(newState, "to be", oldState);
+	});
+
 	it("clears activity and logout flag when a request succeeds", () => {
 		const oldState = Immutable.fromJS({
 			actives: {

package/src/reducers/tasks.js

@@ -0,0 +1,56 @@
+import Immutable from "immutable";
+import { safeGet } from "../utils";
+import {
+	GET_TASK_LIST_SUCCESS,
+	DELETE_TASK_REQUEST,
+	GET_TASK_LOG_SUCCESS,
+	CLEAR_TASK_LOG,
+	GET_TASKINFO_SUCCESS,
+} from "../actions/tasks";
+import { compareObjectProperty } from "../utils/propertyHelper";
+
+const initialState = Immutable.fromJS({
+	tasks: [],
+	taskInfos: {},
+	logs: {},
+});
+
+const tasks = (state = initialState, action) => {
+	switch (action.type) {
+		case GET_TASKINFO_SUCCESS:
+			return state.setIn(["taskInfos", action.payload.taskId], Immutable.fromJS(action.payload));
+		case GET_TASK_LIST_SUCCESS:
+			return state.set(
+				"tasks",
+				Immutable.fromJS(action.payload.sort((a, b) => compareObjectProperty(a, b, "created"))),
+			);
+		case DELETE_TASK_REQUEST:
+			const deleteTaskId = safeGet(action, "meta", "taskId");
+
+			return state.withMutations(s => {
+				s.set(
+					"tasks",
+					s.get("tasks").filter(task => task.get("taskId") !== deleteTaskId),
+				);
+				s.deleteIn(["logs", deleteTaskId]);
+				s.deleteIn(["taskInfos", deleteTaskId]);
+			});
+		case GET_TASK_LOG_SUCCESS:
+			const logTaskId = safeGet(action, "meta", "taskId");
+			if (action.payload?.length > 0) {
+				return state.setIn(
+					["logs", logTaskId],
+					Immutable.fromJS(action.payload.sort((a, b) => compareObjectProperty(a, b, "executionTime"))),
+				);
+			} else {
+				return state.deleteIn(["logs", logTaskId]);
+			}
+		case CLEAR_TASK_LOG:
+			const taskId = safeGet(action, "meta", "taskId");
+			return state.deleteIn(["logs", taskId]);
+		default:
+			return state;
+	}
+};
+
+export default tasks;