Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CS - Add frontend support for new job which takes only a quarter as its parameter #52

Merged
merged 6 commits into from Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 57 additions & 0 deletions frontend/src/main/components/Jobs/UpdateCoursesByQuarterJobForm.js
@@ -0,0 +1,57 @@
import { useState } from "react";
import { Form, Button, Container, Row, Col } from "react-bootstrap";

import { quarterRange } from "main/utils/quarterUtilities";

import { useSystemInfo } from "main/utils/systemInfo";
import SingleQuarterDropdown from "../Quarters/SingleQuarterDropdown";

const UpdateCoursesByQuarterJobForm = ({ callback }) => {

const { data: systemInfo } = useSystemInfo();

// Stryker disable OptionalChaining
const startQtr = systemInfo?.startQtrYYYYQ || "20211";
const endQtr = systemInfo?.endQtrYYYYQ || "20214";
// Stryker enable OptionalChaining

const quarters = quarterRange(startQtr, endQtr);

// Stryker disable all : not sure how to test/mock local storage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be followed by
// Stryker enable all
after the line of code that does local storage.

const localQuarter = localStorage.getItem("BasicSearch.Quarter");

const [quarter, setQuarter] = useState(localQuarter || quarters[0].yyyyq);

const handleSubmit = (event) => {
event.preventDefault();
console.log("UpdateCoursesJobForm: quarter", quarter);
callback({quarter});
};

// Stryker disable all : Stryker is testing by changing the padding to 0. But this is simply a visual optimization as it makes it look better
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above... it's ok to invoke this for the part of the code that needs Stryker disabled... but you need to confine this to the smallest possible scope.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In #57 I suggest what this might look like.

return (
<Form onSubmit={handleSubmit}>
<Container>
<Row>
<Col md="auto">
<SingleQuarterDropdown
quarters={quarters}
quarter={quarter}
setQuarter={setQuarter}
controlId={"BasicSearch.Quarter"}
/>
</Col>
</Row>
<Row style={{ paddingTop: 10, paddingBottom: 10 }}>
<Col md="auto">
<Button variant="primary" type="submit" data-testid="updateCoursesByQuarter">
Update Courses
</Button>
</Col>
</Row>
</Container>
</Form>
);
};

export default UpdateCoursesByQuarterJobForm;
2 changes: 1 addition & 1 deletion frontend/src/main/components/Jobs/UpdateCoursesJobForm.js
Expand Up @@ -65,7 +65,7 @@ const UpdateCoursesJobForm = ({ callback }) => {
</Row>
<Row style={{ paddingTop: 10, paddingBottom: 10 }}>
<Col md="auto">
<Button variant="primary" type="submit">
<Button variant="primary" type="submit" data-testid="updateCourses">
Update Courses
</Button>
</Col>
Expand Down
20 changes: 20 additions & 0 deletions frontend/src/main/pages/AdminJobsPage.js
Expand Up @@ -8,6 +8,7 @@ import JobComingSoon from "main/components/Jobs/JobComingSoon";

import { useBackendMutation } from "main/utils/useBackend";
import UpdateCoursesJobForm from "main/components/Jobs/UpdateCoursesJobForm";
import UpdateCoursesByQuarterJobForm from "main/components/Jobs/UpdateCoursesByQuarterJobForm";

const AdminJobsPage = () => {

Expand Down Expand Up @@ -40,19 +41,34 @@ const AdminJobsPage = () => {
method: "POST"
});

const objectToAxiosParamsUpdateCoursesByQuarterJob = (data) => ({
url: `/api/jobs/launch/updateQuarterCourses?quarterYYYYQ=${data.quarter}`,
method: "POST"
});

// Stryker disable all
const updateCoursesJobMutation = useBackendMutation(
objectToAxiosParamsUpdateCoursesJob,
{},
["/api/jobs/all"]
);
const updateCoursesByQuarterJobMutation = useBackendMutation(
objectToAxiosParamsUpdateCoursesByQuarterJob,
{},
["/api/jobs/all"]
);
// Stryker enable all

const submitUpdateCoursesJob = async (data) => {
console.log("submitUpdateCoursesJob, data=", data);
updateCoursesJobMutation.mutate(data);
}

const submitUpdateCoursesByQuarterJob = async (data) => {
console.log("submitCoursesByQuarterJob, data=", data);
updateCoursesByQuarterJobMutation.mutate(data);
}

// Stryker disable all
const { data: jobs, error: _error, status: _status } =
useBackend(
Expand All @@ -75,6 +91,10 @@ const AdminJobsPage = () => {
name: "Update Courses Database",
form: <UpdateCoursesJobForm callback={submitUpdateCoursesJob} />
},
{
name: "Update Courses Database by quarter",
form: <UpdateCoursesByQuarterJobForm callback={submitUpdateCoursesByQuarterJob} />
},
{
name: "Update Grade Info",
form: <JobComingSoon />
Expand Down
@@ -0,0 +1,31 @@
import React from "react";

import UpdateCoursesByQuarterJobForm from "main/components/Jobs/UpdateCoursesByQuarterJobForm";
import { systemInfoFixtures } from "fixtures/systemInfoFixtures";

export default {
title: "components/Jobs/UpdateCoursesByQuarterJobForm",
component: UpdateCoursesByQuarterJobForm,
parameters: {
mockData: [
{
url: '/api/systemInfo',
method: 'GET',
status: 200,
response: systemInfoFixtures.showingBoth
},
],
},
};

const Template = (args) => {
return <UpdateCoursesByQuarterJobForm {...args} />;
};

export const Default = Template.bind({});

Default.args = {
callback: (data) => {
console.log("Submit was clicked, data=", data);
}
};
@@ -0,0 +1,61 @@
import { render, screen } from "@testing-library/react";
import { BrowserRouter as Router } from "react-router-dom";
import UpdateCoursesByQuarterJobForm from "main/components/Jobs/UpdateCoursesByQuarterJobForm";
import { QueryClient, QueryClientProvider } from "react-query";

import axios from "axios";
import AxiosMockAdapter from "axios-mock-adapter";


const mockedNavigate = jest.fn();

jest.mock('react-router-dom', () => ({
...jest.requireActual('react-router-dom'),
useNavigate: () => mockedNavigate
}));

const queryClient = new QueryClient();

describe("UpdateCoursesByQuarterJobForm tests", () => {

const axiosMock = new AxiosMockAdapter(axios);

it("renders correctly", async () => {
render(
<QueryClientProvider client={queryClient}>
<Router >
<UpdateCoursesByQuarterJobForm />
</Router>
</QueryClientProvider>
);

expect(screen.getByText(/Update Courses/)).toBeInTheDocument();
});

test("renders without crashing when fallback values are used", async () => {

axiosMock
.onGet("/api/systemInfo")
.reply(200, {
"springH2ConsoleEnabled": false,
"showSwaggerUILink": false,
"startQtrYYYYQ": null, // use fallback value
"endQtrYYYYQ": null // use fallback value
});

render(
<QueryClientProvider client={queryClient}>
<Router >
<UpdateCoursesByQuarterJobForm />
</Router >
</QueryClientProvider>
);

// Make sure the first and last options
expect(await screen.findByTestId(/BasicSearch.Quarter-option-0/)).toHaveValue("20211")
expect(await screen.findByTestId(/BasicSearch.Quarter-option-3/)).toHaveValue("20214")

});


});
36 changes: 35 additions & 1 deletion frontend/src/tests/pages/AdminJobsPage.test.js
Expand Up @@ -99,7 +99,7 @@ describe("AdminJobsPage tests", () => {

expect(await screen.findByTestId("TestJobForm-fail")).toBeInTheDocument();

const submitButton = screen.getByText("Update Courses");
const submitButton = screen.getByTestId("updateCourses");

const expectedKey = "BasicSearch.Subject-option-ANTH";
await waitFor(() => expect(screen.getByTestId(expectedKey).toBeInTheDocument));
Expand All @@ -120,4 +120,38 @@ describe("AdminJobsPage tests", () => {
});


test("user can submit the update course data by quarter job", async () => {
render(
<QueryClientProvider client={queryClient}>
<MemoryRouter>
<AdminJobsPage />
</MemoryRouter>
</QueryClientProvider>
);

expect(await screen.findByText("Update Courses Database by quarter")).toBeInTheDocument();

const updateCoursesButton = screen.getByText("Update Courses Database by quarter");
expect(updateCoursesButton).toBeInTheDocument();
updateCoursesButton.click();

expect(await screen.findByTestId("TestJobForm-fail")).toBeInTheDocument();

const submitButton = screen.getByTestId("updateCoursesByQuarter");

const expectedKey = "BasicSearch.Subject-option-ANTH";
await waitFor(() => expect(screen.getByTestId(expectedKey).toBeInTheDocument));

const selectQuarter = screen.getByLabelText("Quarter");
userEvent.selectOptions(selectQuarter, "20211");
expect(submitButton).toBeInTheDocument();

submitButton.click();

await waitFor(() => expect(axiosMock.history.post.length).toBe(1));

expect(axiosMock.history.post[0].url).toBe("/api/jobs/launch/updateQuarterCourses?quarterYYYYQ=20211");
});


});