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

feat: Assignment and course grade fields validations (redwood.master) #396

Open
wants to merge 5 commits into
base: open-release/redwood.master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"extends": [
"config:base",
"schedule:weekly",
":automergeLinters",
":automergeMinor",
":automergeTesters",
":enableVulnerabilityAlerts",
":rebaseStalePrs",
":semanticCommits",
":updateNotScheduled"
],
"packageRules": [
{
"matchDepTypes": [
"devDependencies"
],
"matchUpdateTypes": [
"lockFileMaintenance",
"minor",
"patch",
"pin"
],
"automerge": true
},
{
"matchPackagePatterns": ["@edx", "@openedx"],
"matchUpdateTypes": ["minor", "patch"],
"automerge": true
}
],
"timezone": "America/New_York"
}
5 changes: 4 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -43,7 +43,10 @@ jobs:
run: npm run build

- name: Run Coverage
uses: codecov/codecov-action@v2
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true

- name: Send failure notification
if: ${{ failure() }}
13 changes: 13 additions & 0 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# This file records information about this repo. Its use is described in OEP-55:
# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: "frontend-app-gradebook"
description: "The frontend (MFE) for Open edX Gradebook"
annotations:
openedx.org/arch-interest-groups: ""
spec:
owner: user:farhaanbukhsh
type: 'website'
lifecycle: 'experimental'
Copy link
Member

Choose a reason for hiding this comment

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

This file is not related to the PR

Original file line number Diff line number Diff line change
@@ -55,7 +55,7 @@ exports[`AssignmentFilter component render without selected assignment snapshot
className="grade-filter-action"
>
<Button
disabled={true}
disabled={false}
name="assignmentGradeMinMax"
type="submit"
variant="outline-secondary"
Original file line number Diff line number Diff line change
@@ -7,6 +7,7 @@ const useAssignmentGradeFilterData = ({ updateQueryParams }) => {
const fetchGrades = thunkActions.grades.useFetchGrades();
const setFilter = actions.app.useSetLocalFilter();
const updateAssignmentLimits = actions.filters.useUpdateAssignmentLimits();
const isDisabled = !selectors.app.useAreAssignmentGradeFiltersValid() || !selectedAssignment;

const handleSubmit = () => {
updateAssignmentLimits(localAssignmentLimits);
@@ -27,6 +28,7 @@ const useAssignmentGradeFilterData = ({ updateQueryParams }) => {
assignmentGradeMin,
assignmentGradeMax,
selectedAssignment,
isDisabled,
handleSetMax,
handleSetMin,
handleSubmit,
Original file line number Diff line number Diff line change
@@ -4,7 +4,10 @@ import useAssignmentGradeFilterData from './hooks';

jest.mock('data/redux/hooks', () => ({
selectors: {
app: { useAssignmentGradeLimits: jest.fn() },
app: {
useAreAssignmentGradeFiltersValid: jest.fn(),
useAssignmentGradeLimits: jest.fn(),
},
filters: { useSelectedAssignmentLabel: jest.fn() },
},
actions: {
@@ -20,6 +23,7 @@ let out;

const assignmentGradeLimits = { assignmentGradeMax: 200, assignmentGradeMin: 3 };
const selectedAssignmentLabel = 'test-assignment-label';
const useAreAssignmentGradeFiltersValid = false;
selectors.app.useAssignmentGradeLimits.mockReturnValue(assignmentGradeLimits);
selectors.filters.useSelectedAssignmentLabel.mockReturnValue(selectedAssignmentLabel);

@@ -40,6 +44,7 @@ describe('useAssignmentFilterData hook', () => {
});
describe('behavior', () => {
it('initializes redux hooks', () => {
expect(selectors.app.useAreAssignmentGradeFiltersValid).toHaveBeenCalledWith();
expect(selectors.app.useAssignmentGradeLimits).toHaveBeenCalledWith();
expect(selectors.filters.useSelectedAssignmentLabel).toHaveBeenCalledWith();
expect(actions.app.useSetLocalFilter).toHaveBeenCalledWith();
@@ -77,5 +82,8 @@ describe('useAssignmentFilterData hook', () => {
expect(out.assignmentGradeMax).toEqual(assignmentGradeLimits.assignmentGradeMax);
expect(out.assignmentGradeMin).toEqual(assignmentGradeLimits.assignmentGradeMin);
});
it('passes isDisabled from hook', () => {
expect(out.isDisabled).toEqual(!useAreAssignmentGradeFiltersValid || !selectedAssignmentLabel);
});
});
});
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@ export const AssignmentGradeFilter = ({ updateQueryParams }) => {
assignmentGradeMin,
assignmentGradeMax,
selectedAssignment,
isDisabled,
handleSetMax,
handleSetMin,
handleSubmit,
@@ -39,7 +40,7 @@ export const AssignmentGradeFilter = ({ updateQueryParams }) => {
type="submit"
variant="outline-secondary"
name="assignmentGradeMinMax"
disabled={!selectedAssignment}
disabled={isDisabled}
onClick={handleSubmit}
>
{formatMessage(messages.apply)}
Original file line number Diff line number Diff line change
@@ -17,6 +17,7 @@ const hookData = {
selectedAssignment: 'test-assignment',
assignmentGradeMax: 300,
assignmentGradeMin: 23,
isDisabled: false,
};
useAssignmentGradeFilterData.mockReturnValue(hookData);

Original file line number Diff line number Diff line change
@@ -20,6 +20,6 @@ exports[`OverrideTable component render snapshot 1`] = `
},
]
}
itemCount={2}
itemCount={3}
/>
`;
20 changes: 11 additions & 9 deletions src/components/GradesView/EditModal/OverrideTable/index.jsx
Original file line number Diff line number Diff line change
@@ -20,18 +20,20 @@ export const OverrideTable = () => {

if (hide) { return null; }

const tableData = [
...data,
{
adjustedGrade: <AdjustedGradeInput />,
date: formatDateForDisplay(new Date()),
reason: <ReasonInput />,
},
];

return (
<DataTable
columns={columns}
data={[
...data,
{
adjustedGrade: <AdjustedGradeInput />,
date: formatDateForDisplay(new Date()),
reason: <ReasonInput />,
},
]}
itemCount={data.length}
data={tableData}
itemCount={tableData.length}
/>
);
};
Original file line number Diff line number Diff line change
@@ -16,5 +16,12 @@ exports[`StatusAlerts component render snapshot 1`] = `
>
hooks.grade-filter-text
</Alert>
<Alert
dismissible={false}
show="hooks.show-grade-filter"
variant="danger"
>
hooks.grade-filter-text
</Alert>
</Fragment>
`;
30 changes: 23 additions & 7 deletions src/components/GradesView/StatusAlerts/hooks.js
Original file line number Diff line number Diff line change
@@ -6,15 +6,27 @@ import messages from './messages';
export const useStatusAlertsData = () => {
const { formatMessage } = useIntl();

const limitValidity = selectors.app.useCourseGradeFilterValidity();
const courseLimitValidity = selectors.app.useCourseGradeFilterValidity();
const assignmentLimitValidity = selectors.app.useAssignmentGradeFilterValidity();

const showSuccessBanner = selectors.grades.useShowSuccess();
const handleCloseSuccessBanner = actions.grades.useCloseBanner();

const isCourseGradeFilterAlertOpen = !limitValidity.isMinValid || !limitValidity.isMaxValid;
const isCourseGradeFilterAlertOpen = !courseLimitValidity.isMinValid
|| !courseLimitValidity.isMaxValid || !courseLimitValidity.isMinLessMaxValid;
const isAssignmentGradeFilterAlertOpen = !assignmentLimitValidity.isMinValid
|| !assignmentLimitValidity.isMaxValid || !assignmentLimitValidity.isMinLessMaxValid;

const courseValidityMessages = {
min: courseLimitValidity.isMinValid ? '' : formatMessage(messages.minGradeInvalid),
max: courseLimitValidity.isMaxValid ? '' : formatMessage(messages.maxGradeInvalid),
minLessMax: courseLimitValidity.isMinLessMaxValid ? '' : formatMessage(messages.minLessMaxGradeInvalid),
};

const validityMessages = {
min: limitValidity.isMinValid ? '' : formatMessage(messages.minGradeInvalid),
max: limitValidity.isMaxValid ? '' : formatMessage(messages.maxGradeInvalid),
const assignmentValidityMessages = {
min: assignmentLimitValidity.isMinValid ? '' : formatMessage(messages.minAssignmentInvalid),
max: assignmentLimitValidity.isMaxValid ? '' : formatMessage(messages.maxAssignmentInvalid),
minLessMax: assignmentLimitValidity.isMinLessMaxValid ? '' : formatMessage(messages.minLessMaxAssignmentInvalid),
};

return {
@@ -23,9 +35,13 @@ export const useStatusAlertsData = () => {
show: showSuccessBanner,
text: formatMessage(messages.editSuccessAlert),
},
gradeFilter: {
courseGradeFilter: {
show: isCourseGradeFilterAlertOpen,
text: `${validityMessages.min}${validityMessages.max}`,
text: `${courseValidityMessages.min} ${courseValidityMessages.max} ${courseValidityMessages.minLessMax}`,
},
assignmentGradeFilter: {
show: isAssignmentGradeFilterAlertOpen,
text: `${assignmentValidityMessages.min} ${assignmentValidityMessages.max} ${assignmentValidityMessages.minLessMax}`,
},
};
};
78 changes: 67 additions & 11 deletions src/components/GradesView/StatusAlerts/hooks.test.js
Original file line number Diff line number Diff line change
@@ -11,16 +11,21 @@ jest.mock('data/redux/hooks', () => ({
grades: { useCloseBanner: jest.fn() },
},
selectors: {
app: { useCourseGradeFilterValidity: jest.fn() },
app: {
useCourseGradeFilterValidity: jest.fn(),
useAssignmentGradeFilterValidity: jest.fn(),
},
grades: { useShowSuccess: jest.fn() },
},
}));

const validity = {
isMinValid: true,
isMaxValid: true,
isMinLessMaxValid: true,
};
selectors.app.useCourseGradeFilterValidity.mockReturnValue(validity);
selectors.app.useAssignmentGradeFilterValidity.mockReturnValue(validity);
const showSuccess = 'test-show-success';
selectors.grades.useShowSuccess.mockReturnValue(showSuccess);
const closeBanner = jest.fn().mockName('hooks.closeBanner');
@@ -39,6 +44,7 @@ describe('useStatusAlertsData', () => {
it('initializes redux hooks', () => {
expect(actions.grades.useCloseBanner).toHaveBeenCalled();
expect(selectors.app.useCourseGradeFilterValidity).toHaveBeenCalled();
expect(selectors.app.useAssignmentGradeFilterValidity).toHaveBeenCalled();
expect(selectors.grades.useShowSuccess).toHaveBeenCalled();
});
});
@@ -53,55 +59,105 @@ describe('useStatusAlertsData', () => {
});
});
describe('gradeFilter', () => {
describe('both filters are valid', () => {
describe('all filters are valid', () => {
test('do not show', () => {
expect(out.gradeFilter.show).toEqual(false);
expect(out.courseGradeFilter.show).toEqual(false);
expect(out.assignmentGradeFilter.show).toEqual(false);
});
});
describe('min filter is invalid', () => {
beforeEach(() => {
selectors.app.useCourseGradeFilterValidity.mockReturnValue({
isMinValid: false,
isMaxValid: true,
isMinLessMaxValid: true,
});
selectors.app.useAssignmentGradeFilterValidity.mockReturnValue({
isMinValid: false,
isMaxValid: true,
isMinLessMaxValid: true,
});
out = useStatusAlertsData();
});
test('show grade filter banner', () => {
expect(out.gradeFilter.show).toEqual(true);
expect(out.courseGradeFilter.show).toEqual(true);
expect(out.assignmentGradeFilter.show).toEqual(true);
});
test('filter message', () => {
expect(out.gradeFilter.text).toEqual(formatMessage(messages.minGradeInvalid));
expect(out.courseGradeFilter.text).toEqual(`${formatMessage(messages.minGradeInvalid)} `);
expect(out.assignmentGradeFilter.text).toEqual(`${formatMessage(messages.minAssignmentInvalid)} `);
});
});
describe('max filter is invalid', () => {
beforeEach(() => {
selectors.app.useCourseGradeFilterValidity.mockReturnValue({
isMinValid: true,
isMaxValid: false,
isMinLessMaxValid: true,
});
selectors.app.useAssignmentGradeFilterValidity.mockReturnValue({
isMinValid: true,
isMaxValid: false,
isMinLessMaxValid: true,
});
out = useStatusAlertsData();
});
test('show grade filter banner', () => {
expect(out.gradeFilter.show).toEqual(true);
expect(out.courseGradeFilter.show).toEqual(true);
expect(out.assignmentGradeFilter.show).toEqual(true);
});
test('filter message', () => {
expect(out.gradeFilter.text).toEqual(formatMessage(messages.maxGradeInvalid));
expect(out.courseGradeFilter.text).toEqual(` ${formatMessage(messages.maxGradeInvalid)} `);
expect(out.assignmentGradeFilter.text).toEqual(` ${formatMessage(messages.maxAssignmentInvalid)} `);
});
});
describe('both filters are invalid', () => {
describe('minLessMax filter is invalid', () => {
beforeEach(() => {
selectors.app.useCourseGradeFilterValidity.mockReturnValue({
isMinValid: true,
isMaxValid: true,
isMinLessMaxValid: false,
});
selectors.app.useAssignmentGradeFilterValidity.mockReturnValue({
isMinValid: true,
isMaxValid: true,
isMinLessMaxValid: false,
});
out = useStatusAlertsData();
});
test('show grade filter banner', () => {
expect(out.courseGradeFilter.show).toEqual(true);
expect(out.assignmentGradeFilter.show).toEqual(true);
});
test('filter message', () => {
expect(out.courseGradeFilter.text).toEqual(` ${formatMessage(messages.minLessMaxGradeInvalid)}`);
expect(out.assignmentGradeFilter.text).toEqual(` ${formatMessage(messages.minLessMaxAssignmentInvalid)}`);
});
});
describe('all filters are invalid', () => {
beforeEach(() => {
selectors.app.useCourseGradeFilterValidity.mockReturnValue({
isMinValid: false,
isMaxValid: false,
isMinLessMaxValid: false,
});
selectors.app.useAssignmentGradeFilterValidity.mockReturnValue({
isMinValid: false,
isMaxValid: false,
isMinLessMaxValid: false,
});
out = useStatusAlertsData();
});
test('show grade filter banner', () => {
expect(out.gradeFilter.show).toEqual(true);
expect(out.courseGradeFilter.show).toEqual(true);
expect(out.assignmentGradeFilter.show).toEqual(true);
});
test('filter message', () => {
expect(out.gradeFilter.text).toEqual(
`${formatMessage(messages.minGradeInvalid)}${formatMessage(messages.maxGradeInvalid)}`,
expect(out.courseGradeFilter.text).toEqual(
`${formatMessage(messages.minGradeInvalid)} ${formatMessage(messages.maxGradeInvalid)} ${formatMessage(messages.minLessMaxGradeInvalid)}`,
);
expect(out.assignmentGradeFilter.text).toEqual(
`${formatMessage(messages.minAssignmentInvalid)} ${formatMessage(messages.maxAssignmentInvalid)} ${formatMessage(messages.minLessMaxAssignmentInvalid)}`,
);
});
});
Loading