♻️(settings) remove JS_SELECTOR_REGEXP

As it has been done in backend, we only use the course regexp to both select the lms api and extract the course id. So `JS_SELECTOR_REGEXP` is deprecated.
openfun · Jan 11, 2021 · 2ce9dfa · 2ce9dfa
1 parent bb0d8aa
commit 2ce9dfa
Show file tree

Hide file tree

Showing 12 changed files with 7 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unrealeased]
 
+### Fixed
+
+- Deprecate `JS_SELECTOR_REGEXP`
+
 ## [2.0.0] - 2021-01-11
 
 ### Changed

diff --git a/docs/lms-connection.md b/docs/lms-connection.md
@@ -23,7 +23,6 @@ RICHIE_LMS_BACKENDS=[
         "BACKEND": "richie.apps.courses.lms.edx.EdXLMSBackend",
         "COURSE_REGEX": r"^.*/courses/(?P<course_id>.*)/course/?$",
         "JS_BACKEND": "openedx-hawthorn",
-        "JS_SELECTOR_REGEX": r".*lms-example2.org.*",
         "JS_COURSE_REGEX": r"^.*/course/(?<course_id>[0-9]*)$",
     },
 ]

diff --git a/sandbox/settings.py b/sandbox/settings.py
@@ -290,9 +290,6 @@ class Base(StyleguideMixin, DRFMixin, RichieCoursesConfigurationMixin, Configura
                 environ_name="EDX_JS_COURSE_REGEX",
                 environ_prefix=None,
             ),
-            "JS_SELECTOR_REGEX": values.Value(
-                r".*", environ_name="EDX_JS_SELECTOR_REGEX", environ_prefix=None
-            ),
         }
     ]
     RICHIE_COURSE_RUN_SYNC_SECRETS = values.ListValue([])
@@ -582,7 +579,6 @@ class Test(Base):
             "COURSE_REGEX": r"^.*/courses/(?P<course_id>.*)/course/?$",
             "JS_BACKEND": "base",
             "JS_COURSE_REGEX": r"^.*/courses/(?<course_id>.*)/course/?$",
-            "JS_SELECTOR_REGEX": r".*",
         }
     ]
 

diff --git a/src/frontend/js/components/CourseRunEnrollment/index.spec.tsx b/src/frontend/js/components/CourseRunEnrollment/index.spec.tsx
@@ -25,7 +25,6 @@ describe('<CourseRunEnrollment />', () => {
           backend: ApiBackend.OPENEDX_HAWTHORN,
           course_regexp: '(?<course_id>.*)',
           endpoint,
-          selector_regexp: '.*',
         },
       ],
     })

diff --git a/src/frontend/js/types/commonDataProps.ts b/src/frontend/js/types/commonDataProps.ts
@@ -6,7 +6,6 @@ import { Nullable } from 'utils/types';
  */
 export interface LMSBackend {
   backend: string;
-  selector_regexp: RegExp | string;
   course_regexp: RegExp | string;
   endpoint: string;
 }

diff --git a/src/frontend/js/utils/api/lms/base.spec.ts b/src/frontend/js/utils/api/lms/base.spec.ts
@@ -8,7 +8,6 @@ describe('Base API', () => {
         backend: ApiBackend.BASE,
         course_regexp: '(?<course_id>.*)',
         endpoint: 'https://demo.endpoint/api',
-        selector_regexp: '.*',
       },
     ],
   }).generate();

diff --git a/src/frontend/js/utils/api/lms/index.spec.ts b/src/frontend/js/utils/api/lms/index.spec.ts
@@ -7,12 +7,12 @@ describe('API LMS', () => {
         {
           backend: ApiBackend.BASE,
           endpoint: 'https://demo.endpoint/api',
-          selector_regexp: /.*base.org\/.*/,
+          course_regexp: /.*base.org\/.*/,
         },
         {
           backend: ApiBackend.OPENEDX_HAWTHORN,
           endpoint: 'https://edx.endpoint/api',
-          selector_regexp: /.*edx.org\/.*/,
+          course_regexp: /.*edx.org\/.*/,
         },
       ],
       environment: 'test',

diff --git a/src/frontend/js/utils/api/lms/index.ts b/src/frontend/js/utils/api/lms/index.ts
@@ -11,7 +11,7 @@ if (!context) throw new Error('No context frontend context available');
 const LMS_BACKENDS = context.lms_backends;
 
 const selectAPIWithUrl = (url: string) => {
-  const API = LMS_BACKENDS.find((lms) => new RegExp(lms.selector_regexp).test(url));
+  const API = LMS_BACKENDS.find((lms) => new RegExp(lms.course_regexp).test(url));
   return API;
 };
 

diff --git a/src/frontend/js/utils/api/lms/openedx-hawthorn.spec.ts b/src/frontend/js/utils/api/lms/openedx-hawthorn.spec.ts
@@ -14,7 +14,6 @@ describe('OpenEdX Hawthorn API', () => {
         backend: ApiBackend.OPENEDX_HAWTHORN,
         course_regexp: 'course_id=(?<course_id>.*$)',
         endpoint: EDX_ENDPOINT,
-        selector_regexp: '.*',
       },
     ],
   }).generate();

diff --git a/src/frontend/js/utils/test/factories.ts b/src/frontend/js/utils/test/factories.ts
@@ -44,7 +44,6 @@ export const ContextFactory = (context: Partial<CommonDataProps['context']> = {}
     lms_backends: [
       {
         backend: ApiBackend.BASE,
-        selector_regexp: '.*',
         course_regexp: '.*',
         endpoint: 'https://endpoint.test',
       },

diff --git a/src/richie/apps/core/context_processors.py b/src/richie/apps/core/context_processors.py
@@ -78,7 +78,6 @@ def site_metas(request):
                 "endpoint": lms["BASE_URL"],
                 "backend": lms["JS_BACKEND"],
                 "course_regexp": lms["JS_COURSE_REGEX"],
-                "selector_regexp": lms["JS_SELECTOR_REGEX"],
             }
             for lms in getattr(settings, "RICHIE_LMS_BACKENDS", [])
         ]

diff --git a/tests/apps/courses/test_templates_course_detail.py b/tests/apps/courses/test_templates_course_detail.py
@@ -471,7 +471,6 @@ def test_templates_course_detail_runs_ongoing_open(self):
                 "JS_BACKEND": "openedx-hawthorn",
                 "COURSE_REGEX": r".*",
                 "JS_COURSE_REGEX": r"^.*/courses/(?<course_id>.*)/course/?$",
-                "JS_SELECTOR_REGEX": r".*",
                 "BASE_URL": "http://edx:8073",
                 "API_TOKEN": "fakesecret",
             }
@@ -546,7 +545,6 @@ def test_templates_course_detail_runs_future_open(self):
                 "JS_BACKEND": "openedx-hawthorn",
                 "COURSE_REGEX": r".*",
                 "JS_COURSE_REGEX": r"^.*/courses/(?<course_id>.*)/course/?$",
-                "JS_SELECTOR_REGEX": r".*",
                 "BASE_URL": "http://edx:8073",
                 "API_TOKEN": "fakesecret",
             }