fix: use SITE_NAME env var for index.html title (#178 )

We currently have a hard-coded “edX” string in Gradebook’s index.html file. This replaces that string with the value of the SITE_NAME environment variable, which is set at build time from .env.development for dev, and from the build process at production build-time.
fix: typo preventing display of assignment name (#169 )
2021-05-04 13:41:36 -04:00 · 2021-03-23 10:08:06 -04:00 · 2021-02-02 16:12:12 -05:00 · 2021-02-02 15:46:57 -05:00 · 2021-01-25 17:20:21 -05:00 · 2021-01-21 14:31:07 -05:00
15 changed files with 121 additions and 58 deletions
--- a/.env
+++ b/.env
@@ -13,7 +13,7 @@ ACCESS_TOKEN_COOKIE_NAME=null,
 CSRF_COOKIE_NAME='csrftoken',
 NEW_RELIC_APP_ID=null,
 NEW_RELIC_LICENSE_KEY=null,
-SITE_NAME=null,
+SITE_NAME='',
 MARKETING_SITE_BASE_URL=null,
 SUPPORT_URL=null,
 CONTACT_URL=null,
@@ -31,3 +31,5 @@ ENTERPRISE_MARKETING_URL=null,
 ENTERPRISE_MARKETING_UTM_SOURCE=null,
 ENTERPRISE_MARKETING_UTM_CAMPAIGN=null,
 ENTERPRISE_MARKETING_FOOTER_UTM_MEDIUM=null,
+
+BULK_MANAGEMENT_SPECIAL_ACCESS_COURSE_IDS=null,
--- a/.env.development
+++ b/.env.development
@@ -13,7 +13,7 @@ CSRF_TOKEN_API_PATH='/csrf/api/v1/token'
 REFRESH_ACCESS_TOKEN_ENDPOINT='http://localhost:18000/login_refresh'
 ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload'
 USER_INFO_COOKIE_NAME='edx-user-info'
-SITE_NAME='edX'
+SITE_NAME=localhost

 DATA_API_BASE_URL='http://localhost:8000'
 // LMS_CLIENT_ID should match the lms DOT client application id your LMS containe
@@ -38,3 +38,5 @@ ENTERPRISE_MARKETING_URL='http://example.com'
 ENTERPRISE_MARKETING_UTM_SOURCE='example.com'
 ENTERPRISE_MARKETING_UTM_CAMPAIGN='example.com Referral'
 ENTERPRISE_MARKETING_FOOTER_UTM_MEDIUM='Footer'
+
+BULK_MANAGEMENT_SPECIAL_ACCESS_COURSE_IDS=null
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -0,0 +1,6 @@
+# Code owners for frontend-app-gradebook, editable gradebook micro-frontend (MFE)
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, they will
+# be requested for review when someone opens a pull request.
+*       @edx/masters-devs-gta
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -0,0 +1,28 @@
+**TL;DR -** [ A short summary of what this PR does and why ]
+
+JIRA: [JIRA-XXXX](https://openedx.atlassian.net/browse/JIRA-XXXX)
+
+**What changed?**
+
+- [ More in depth breakdown of changes ]
+- [ Peripheral things that got changed ]
+- [ etc... ]
+
+**Developer Checklist**
+- [ ] Test suites passing
+- [ ] Received code-owner approving review
+- [ ] Bumped version number [package.json](../package.json)
+
+**Testing Instructions**
+
+[ How should a reviewer test this PR? ]
+
+**Reviewer Checklist**
+
+Collectively, these should be completed by reviewers of this PR:
+
+- [ ] I've done a visual code review
+- [ ] I've tested the new functionality
+
+
+FYI: @edx/masters-devs-gta
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,5 @@
 .DS_Store
 .eslintcache
-.idea
 node_modules
 npm-debug.log
 coverage
@@ -14,3 +13,7 @@ dist/
 *~
 *.swo
 *.swp
+
+### Development environments ###
+.idea
+.vscode
--- a/README.md
+++ b/README.md
@@ -1,16 +1,24 @@
-[![Build Status](https://api.travis-ci.org/edx/frontend-app-gradebook.svg?branch=master)](https://travis-ci.org/edx/frontend-app-gradebook) [![Coveralls](https://img.shields.io/coveralls/edx/frontend-app-gradebook.svg?branch=master)](https://coveralls.io/github/edx/frontend-app-gradebook)
+[![Build Status](https://api.travis-ci.com/edx/frontend-app-gradebook.svg?branch=master)](https://travis-ci.com/edx/frontend-app-gradebook) [![Coveralls](https://img.shields.io/coveralls/edx/frontend-app-gradebook.svg?branch=master)](https://coveralls.io/github/edx/frontend-app-gradebook)
 [![npm_version](https://img.shields.io/npm/v/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook)
 [![npm_downloads](https://img.shields.io/npm/dt/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook)
 [![license](https://img.shields.io/npm/l/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

-# gradebook
+# Gradebook

-Please tag **@edx/educator-neem** on any PRs or issues.
+Gradebook allows course staff to view, filter, and override subsection grades for a course. Additionally for Masters courses, Gradebook enables bulk management of subsection grades.

-## Introduction
+Jump to:

-The front-end of our editable Gradebook feature.
+- [Should I use Gradebook in my course?](#should-i-use-gradebook-in-my-course)
+- [Quickstart](#quickstart)
+
+For existing documentation see:
+
+- Basic Usage: [Review Learner Grades (read-the-docs)](https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/student_progress/course_grades.html#review-learner-grades-on-the-instructor-dashboard)
+- Bulk Grade Management: [Override Learner Subsection Scores in Bulk (read-the-docs)](https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/student_progress/course_grades.html#review-learner-grades-on-the-instructor-dashboard)
+
+## Should I use Gradebook in my course?

 ### What does this offer over the legacy gradebook?

@@ -44,7 +52,9 @@ depending on their needs. Instructors that expect to review grades infrequently
 to the problem in question will have a worse UX than the legacy gradebook provides. Instructors that rely on the graphs
 generated by the current gradebook might find the lack of autogenerated graphs to be frustrating.

-## Installation
+## Quickstart
+
+### Installation

 To install gradebook into your project:
 ```
@@ -64,7 +74,7 @@ Note that starting the container executes the `npm run start` script which will
 ## Configuring for local use in edx-platform

 Assuming you've got the UI running at `http://localhost:1994`, you can configure the LMS in edx-platform
-to point to your local gradebook from the instructor dashboard by putting this settings in `lms/env/private.py`:
+to point to your local gradebook from the instructor dashboard by putting this setting in `lms/env/private.py`:
 ```
 WRITABLE_GRADEBOOK_URL = 'http://localhost:1994'
 ```
@@ -76,10 +86,11 @@ check the ``enabled`` and ``enabled for all courses`` boxes.

 2. Waffle > Switches.  Add the ``grades.assume_zero_grade_if_absent`` switch and make it active.

-3. Waffle_utils > Waffle flag course overrides.  You want to activate this flag for any course
-in which you'd like to enable the gradebook.  Add a course override flag using a course id and the flag name
-``grades.writable_gradebook``.  Make sure to check the ``enabled`` box.  Alternatively, you could add this as a
-regular waffle flag to enable the gradebook for all courses.
+3. Waffle_utils > Waffle flag course overrides.  Activate waffle flags for courses where you want to enable Gradebook functionality:
+    - Enable Gradebook by adding the ``grades.writable_gradebook`` add checking the ``enabled`` box.
+    - Enable Bulk Grade Management by adding the ``grades.bulk_management`` flag and checking the ``enabled`` box.
+
+    Alternatively, you could add these as regular waffle flags to enable the functionality for all courses.

 **NOTE:** IF the above flags are not configured correctly, the gradebook may appear to work, but will return bogus
 numbers for grades. If your gradebook isn't accepting your changes, or the changes aren't resulting in sane, 
--- a/openedx.yaml
+++ b/openedx.yaml
@@ -1,13 +1,9 @@
 # This file describes this Open edX repo, as described in OEP-2:
 # http://open-edx-proposals.readthedocs.io/en/latest/oeps/oep-0002.html#specification

-nick: grbk
 tags:
  - frontend-app
  - masters
 oeps:
  oep-2: true    # Repository metadata
 openedx-release: {ref: master}
-owner:
-  type: team
-  team: edx/masters-devs-gta
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
 {
  "name": "@edx/frontend-app-gradebook",
-  "version": "1.4.14",
+  "version": "1.4.18",
  "lockfileVersion": 1,
  "requires": true,
  "dependencies": {
@@ -1701,12 +1701,12 @@
      }
    },
    "@edx/frontend-platform": {
-      "version": "1.8.0",
-      "resolved": "https://registry.npmjs.org/@edx/frontend-platform/-/frontend-platform-1.8.0.tgz",
-      "integrity": "sha512-R4LGBKaSBWC9xxG3eTN78zw5CkBes4xQgazt78ApgenxzIoun+y0tdWyc/8PpjbKmyj0nACpsfARyeQy4rnGKA==",
+      "version": "1.8.1",
+      "resolved": "https://registry.npmjs.org/@edx/frontend-platform/-/frontend-platform-1.8.1.tgz",
+      "integrity": "sha512-oHLSamyIDuCtdS7eDzLcYs4zsAOGf4uuywnnIKg1CnlEHzUrXnfmcajbNM3Wre5jJocGH+1qACuaGLELO+3sAQ==",
      "requires": {
        "@cospired/i18n-iso-languages": "2.1.2",
-        "axios": "0.18.1",
+        "axios": "0.21.1",
        "axios-cache-adapter": "^2.5.0",
        "form-urlencoded": "4.1.4",
        "glob": "7.1.6",
@@ -1725,13 +1725,17 @@
      },
      "dependencies": {
        "axios": {
-          "version": "0.18.1",
-          "resolved": "https://registry.npmjs.org/axios/-/axios-0.18.1.tgz",
-          "integrity": "sha512-0BfJq4NSfQXd+SkFdrvFbG7addhYSBA2mQwISr46pD6E5iqkWg02RAs8vyTT/j0RTnoYmeXauBuSv1qKwR179g==",
+          "version": "0.21.1",
+          "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
+          "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
          "requires": {
-            "follow-redirects": "1.5.10",
-            "is-buffer": "^2.0.2"
+            "follow-redirects": "^1.10.0"
          }
+        },
+        "follow-redirects": {
+          "version": "1.13.1",
+          "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.1.tgz",
+          "integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg=="
        }
      }
    },
@@ -4779,12 +4783,20 @@
      "integrity": "sha512-zg7Hz2k5lI8kb7U32998pRRFin7zJlkfezGJjUc2heaD4Pw2wObakCDVzkKztTm/Ln7eiVvYsjqak0Ed4LkMDA=="
    },
    "axios": {
-      "version": "0.19.2",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-0.19.2.tgz",
-      "integrity": "sha512-fjgm5MvRHLhx+osE2xoekY70AhARk3a6hkN+3Io1jc00jtquGvxYlKlsFUhmUET0V5te6CcZI7lcv2Ym61mjHA==",
+      "version": "0.21.1",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
+      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
      "dev": true,
      "requires": {
-        "follow-redirects": "1.5.10"
+        "follow-redirects": "^1.10.0"
+      },
+      "dependencies": {
+        "follow-redirects": {
+          "version": "1.13.1",
+          "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.1.tgz",
+          "integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg==",
+          "dev": true
+        }
      }
    },
    "axios-cache-adapter": {
@@ -8044,6 +8056,7 @@
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
      "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+      "dev": true,
      "requires": {
        "ms": "2.0.0"
      }
@@ -10431,6 +10444,7 @@
      "version": "1.5.10",
      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.10.tgz",
      "integrity": "sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==",
+      "dev": true,
      "requires": {
        "debug": "=3.1.0"
      }
@@ -12271,11 +12285,6 @@
      "integrity": "sha512-TqZuVwa/sppcrhUCAYkGBk7w0yxfQQnxq28fjkO53tnK9FQXmdwz2JS5+GjsWQ6RByES1K40nI+yDic5c9/aAQ==",
      "dev": true
    },
-    "is-buffer": {
-      "version": "2.0.5",
-      "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-2.0.5.tgz",
-      "integrity": "sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ=="
-    },
    "is-callable": {
      "version": "1.2.0",
      "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.0.tgz",
@@ -15002,7 +15011,7 @@
      "dependencies": {
        "query-string": {
          "version": "2.4.2",
-          "resolved": "http://registry.npmjs.org/query-string/-/query-string-2.4.2.tgz",
+          "resolved": "https://registry.npmjs.org/query-string/-/query-string-2.4.2.tgz",
          "integrity": "sha1-fbBmZCCAS6qSrp8miWKFWnYUPfs=",
          "requires": {
            "strict-uri-encode": "^1.0.0"
@@ -15622,7 +15631,8 @@
    "ms": {
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
-      "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+      "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=",
+      "dev": true
    },
    "multicast-dns": {
      "version": "6.2.3",
@@ -20138,7 +20148,7 @@
        },
        "got": {
          "version": "6.7.1",
-          "resolved": "http://registry.npmjs.org/got/-/got-6.7.1.tgz",
+          "resolved": "https://registry.npmjs.org/got/-/got-6.7.1.tgz",
          "integrity": "sha1-JAzQV4WpoY5WHcG0S0HHY+8ejbA=",
          "dev": true,
          "requires": {
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@edx/frontend-app-gradebook",
-  "version": "1.4.16",
+  "version": "1.4.19",
  "description": "edx editable gradebook-ui to manipulate grade overrides on subsections",
  "repository": {
    "type": "git",
@@ -28,7 +28,7 @@
  "dependencies": {
    "@edx/brand": "npm:@edx/brand-edx.org@^1.3.2",
    "@edx/frontend-component-footer": "10.1.1",
-    "@edx/frontend-platform": "^1.8.0",
+    "@edx/frontend-platform": "1.8.1",
    "@edx/paragon": "12.4.1",
    "@fortawesome/fontawesome-svg-core": "^1.2.25",
    "@fortawesome/free-brands-svg-icons": "^5.11.2",
@@ -60,7 +60,7 @@
  },
  "devDependencies": {
    "@edx/frontend-build": "5.5.2",
-    "axios": "0.19.2",
+    "axios": "0.21.1",
    "axios-mock-adapter": "^1.17.0",
    "codecov": "^3.6.1",
    "enzyme": "^3.10.0",
--- a/public/index.html
+++ b/public/index.html
@@ -1,9 +1,9 @@
 <!doctype html>
 <html lang="en-us">
  <head>
-      <title>Gradebook | edX</title>
+      <title>Gradebook | <%= process.env.SITE_NAME %></title>
      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width, initial-scale=1.0">  
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
      <link rel="shortcut icon" href="<%=htmlWebpackPlugin.options.FAVICON_URL%>" type="image/x-icon" />
  </head>
  <body>
--- a/src/components/Gradebook/Assignments.jsx
+++ b/src/components/Gradebook/Assignments.jsx
@@ -78,9 +78,6 @@ export class Assignments extends React.Component {
      <Collapsible title="Assignments" defaultOpen className="filter-group mb-3">
        <div>
          <div className="student-filters">
-            <span className="label">
-              Assignment Types:
-            </span>
            <InputSelect
              label="Assignment Types"
              name="assignment-types"
@@ -92,9 +89,6 @@ export class Assignments extends React.Component {
            />
          </div>
          <div className="student-filters">
-            <span className="label">
-              Assignment:
-            </span>
            <InputSelect
              label="Assignment"
              name="assignment"
@@ -105,7 +99,6 @@ export class Assignments extends React.Component {
              disabled={this.props.assignmentFilterOptions.length === 0}
            />
          </div>
-          <p>Grade Range (0% - 100%)</p>
          <form className="grade-filter-inputs" onSubmit={this.handleSubmitAssignmentGrade}>
            <div className="percent-group">
              <InputText
--- a/src/components/Gradebook/gradebook.scss
+++ b/src/components/Gradebook/gradebook.scss
@@ -31,13 +31,9 @@
 }

 .student-filters{
-    display: flex;
    .label{
        padding-top: 30px;
    }
-    .form-group{
-        margin-left: 10px;
-    }
 }
 .grade-history-header{
    float: left;
--- a/src/components/Gradebook/index.jsx
+++ b/src/components/Gradebook/index.jsx
@@ -252,7 +252,7 @@ export default class Gradebook extends React.Component {
  safeSetState = this.createLimitedSetter(
    'adjustedGradePossible',
    'adjustedGradeValue',
-    'assignmnentName',
+    'assignmentName',
    'modalOpen',
    'reasonForChange',
    'todaysDate',
--- a/src/containers/GradebookPage/index.jsx
+++ b/src/containers/GradebookPage/index.jsx
@@ -28,6 +28,7 @@ import {
  formatMaxCourseGrade,
 } from '../../data/selectors/grades';
 import { selectableAssignmentLabels } from '../../data/selectors/filters';
+import { hasSpecialBulkManagementAccess } from '../../data/selectors/special';
 import { getCohortNameById } from '../../data/selectors/cohorts';
 import { fetchAssignmentTypes } from '../../data/actions/assignmentTypes';
 import { getRoles } from '../../data/actions/roles';
@@ -97,7 +98,10 @@ const mapStateToProps = (state, ownProps) => (
    selectedCohort: state.filters.cohort,
    selectedAssignmentType: state.filters.assignmentType,
    selectedAssignment: (state.filters.assignment || {}).label,
-    showBulkManagement: stateHasMastersTrack(state) && state.config.bulkManagementAvailable,
+    showBulkManagement: (
+      hasSpecialBulkManagementAccess(ownProps.match.params.courseId)
+      || (stateHasMastersTrack(state) && state.config.bulkManagementAvailable)
+    ),
    showSpinner: shouldShowSpinner(state),
    showSuccess: state.grades.showSuccess,
    totalUsersCount: state.grades.totalUsersCount,
--- a/src/data/selectors/special.js
+++ b/src/data/selectors/special.js
@@ -0,0 +1,12 @@
+// Certain course runs may be expressly allowed to view the
+// bulk management tools, bypassing the other checks.
+// Note that this does not affect whether or not the backend
+// LMS API will permit usage of the tool.
+
+const hasSpecialBulkManagementAccess = courseId => {
+  const specialIdList = process.env.BULK_MANAGEMENT_SPECIAL_ACCESS_COURSE_IDS || '';
+  return specialIdList.split(',').includes(courseId);
+};
+
+export { hasSpecialBulkManagementAccess };
+export default hasSpecialBulkManagementAccess;
Author	SHA1	Message	Date
David Joy	4688355748	fix: use SITE_NAME env var for index.html title (#178 ) We currently have a hard-coded “edX” string in Gradebook’s index.html file. This replaces that string with the value of the SITE_NAME environment variable, which is set at build time from .env.development for dev, and from the build process at production build-time.	2021-05-04 13:41:36 -04:00
Jansen Kantor	1c26aa1d71	fix: typo preventing display of assignment name (#169 ) * fix: typo preventing display of assignment name * bump version	2021-03-23 10:08:06 -04:00
Michael Roytman	582b6cb1c5	Merge pull request #166 from edx/mroytman/update-openedx-yaml-file update openedx.yaml to use current best practices	2021-02-02 16:12:12 -05:00
Michael Roytman	bc04f6d86f	update openedx.yaml to use current best practices	2021-02-02 15:46:57 -05:00
Kyle McCormick	84f1efefb3	Allow special access to bulk management tools (#165 ) Access is configured on a per-course-run basis via the new setting: `BULK_MANAGEMENT_SPECIAL_ACCESS_COURSE_IDS` TNL-7901	2021-01-25 17:20:21 -05:00
Nathan Sprenkle	e9f01ea3a3	Remove duplicate labels from assignments filter (#164 ) * Remove duplicate labels from assignments filter * Bump to v1.4.18	2021-01-21 14:31:07 -05:00
Nathan Sprenkle	100fbc08bf	Update README and add PR template (#160 ) * Update README.md * Add CODEOWNERS * Add PR template * Add VS Code .gitignore	2021-01-14 14:27:16 -05:00
Matthew Carter	500364dc99	Merge pull request #161 from muselesscreator/update_axios update axios and frontend-platform	2021-01-06 14:19:39 -05:00
Ben Warzeski	609c0a8d3a	update axios and frontend-platform	2021-01-05 15:31:34 -05:00
Jawayria	5f81624342	Merge pull request #147 from Jawayria/update-badge Updated the build status badge to point to travis-ci.com	2020-12-17 12:44:30 +05:00
Jawayria	d1ca314565	Updated the build status badge to point to travis-ci.com	2020-11-18 21:31:44 +05:00