richie-education 3.4.1-dev13 → 3.4.1-dev14

package/js/api/lms/index.spec.ts

@@ -1,7 +1,14 @@
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import { handle } from 'utils/errors/handle';
+import { location } from 'utils/indirection/window';
 import LMSHandler from '.';
 
+jest.mock('utils/indirection/window', () => ({
+  location: {
+    pathname: '/courses/a-test-course/',
+    assign: jest.fn(),
+  },
+}));
 jest.mock('utils/context', () => ({
   __esModule: true,
   default: mockRichieContextFactory({
@@ -16,6 +23,12 @@ jest.mock('utils/context', () => ({
         endpoint: 'https://edx.endpoint/api',
         course_regexp: '.*edx.org/.*',
       },
+      {
+        backend: 'openedx-hawthorn',
+        endpoint: 'https://nau.endpoint/api',
+        course_regexp: '.*nau.org/.*',
+        next_url: 'richie-nau',
+      },
     ],
   }).one(),
 }));
@@ -24,6 +37,10 @@ const mockHandle: jest.Mock<typeof handle> = handle as any;
 jest.mock('utils/errors/handle');
 
 describe('API LMS', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
   it('returns OpenEdX API if url that match edx selector is provided', () => {
     const api = LMSHandler('https://edx.org/courses/a-test-course');
     expect(api).toBeDefined();
@@ -42,4 +59,20 @@ describe('API LMS', () => {
       new Error('No LMS Backend found for https://unknown.org/course/a-test-course.'),
     );
   });
+
+  it('uses default "richie" next prefix for openedx-hawthorn without next_url configured', () => {
+    const api = LMSHandler('https://edx.org/courses/a-test-course');
+    api.user.login();
+    expect(location.assign).toHaveBeenCalledWith(
+      `https://edx.endpoint/api/login?next=richie${location.pathname}`,
+    );
+  });
+
+  it('uses configured next_url prefix for openedx-hawthorn with next_url set', () => {
+    const api = LMSHandler('https://nau.org/courses/a-test-course');
+    api.user.login();
+    expect(location.assign).toHaveBeenCalledWith(
+      `https://nau.endpoint/api/login?next=richie-nau${location.pathname}`,
+    );
+  });
 });

package/js/api/lms/index.ts

@@ -15,7 +15,7 @@ const LmsAPIHandler = (url: string): APILms => {
     case APIBackend.OPENEDX_DOGWOOD:
       return OpenEdxDogwoodApiInterface(api);
     case APIBackend.OPENEDX_HAWTHORN:
-      return OpenEdxHawthornApiInterface(api);
+      return OpenEdxHawthornApiInterface(api, { routes: {}, nextURL: api.next_url });
   }
 
   const error = new Error(`No LMS Backend found for ${url}.`);

package/js/api/lms/openedx-hawthorn.spec.ts

@@ -3,10 +3,17 @@ import { faker } from '@faker-js/faker';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import { handle } from 'utils/errors/handle';
 import { HttpError, HttpStatusCode } from 'utils/errors/HttpError';
+import { location } from 'utils/indirection/window';
 import context from 'utils/context';
 import API from './openedx-hawthorn';
 
 jest.mock('utils/errors/handle');
+jest.mock('utils/indirection/window', () => ({
+  location: {
+    pathname: '/courses/a-test-course/',
+    assign: jest.fn(),
+  },
+}));
 jest.mock('utils/context', () => ({
   __esModule: true,
   default: mockRichieContextFactory({
@@ -45,6 +52,48 @@ describe('OpenEdX Hawthorn API', () => {
     });
   });
 
+  describe('user', () => {
+    beforeEach(() => {
+      jest.clearAllMocks();
+    });
+
+    describe('login', () => {
+      it('redirects to login with default "richie" next prefix when nextURL is not set', () => {
+        const api = API(LMSConf);
+        api.user.login();
+        expect(location.assign).toHaveBeenCalledWith(
+          `${EDX_ENDPOINT}/login?next=richie${location.pathname}`,
+        );
+      });
+
+      it('redirects to login with custom next prefix when nextURL option is provided', () => {
+        const api = API(LMSConf, { routes: {}, nextURL: 'richie-nau' });
+        api.user.login();
+        expect(location.assign).toHaveBeenCalledWith(
+          `${EDX_ENDPOINT}/login?next=richie-nau${location.pathname}`,
+        );
+      });
+    });
+
+    describe('register', () => {
+      it('redirects to register with default "richie" next prefix when nextURL is not set', () => {
+        const api = API(LMSConf);
+        api.user.register();
+        expect(location.assign).toHaveBeenCalledWith(
+          `${EDX_ENDPOINT}/register?next=richie${location.pathname}`,
+        );
+      });
+
+      it('redirects to register with custom next prefix when nextURL option is provided', () => {
+        const api = API(LMSConf, { routes: {}, nextURL: 'richie-ap' });
+        api.user.register();
+        expect(location.assign).toHaveBeenCalledWith(
+          `${EDX_ENDPOINT}/register?next=richie-ap${location.pathname}`,
+        );
+      });
+    });
+  });
+
   describe('enrollment', () => {
     beforeEach(() => {
       courseId = faker.string.uuid();

package/js/api/lms/openedx-hawthorn.ts

@@ -20,6 +20,8 @@ import { HttpError, HttpStatusCode } from 'utils/errors/HttpError';
  */
 
 const API = (APIConf: AuthenticationBackend | LMSBackend, options?: APIOptions): APILms => {
+  const nextURL = options?.nextURL ?? 'richie';
+
   const extractCourseIdFromUrl = (url: string): Maybe<Nullable<string>> => {
     const matches = url.match((APIConf as LMSBackend).course_regexp);
     return matches && matches[1] ? matches[1] : null;
@@ -61,8 +63,9 @@ const API = (APIConf: AuthenticationBackend | LMSBackend, options?: APIOptions):
         / ! \ Prefix next param with richie.
         In this way, OpenEdX Nginx conf knows that we want to go back to richie app after login/redirect
       */
-      login: () => location.assign(`${ROUTES.user.login}?next=richie${location.pathname}`),
-      register: () => location.assign(`${ROUTES.user.register}?next=richie${location.pathname}`),
+      login: () => location.assign(`${ROUTES.user.login}?next=${nextURL}${location.pathname}`),
+      register: () =>
+        location.assign(`${ROUTES.user.register}?next=${nextURL}${location.pathname}`),
       logout: async () => {
         await fetch(ROUTES.user.logout, {
           mode: 'no-cors',

package/js/types/api.ts

@@ -63,6 +63,7 @@ export interface APIRoute {
 
 export interface APIOptions {
   routes: APIRoute;
+  nextURL?: string;
 }
 
 export enum APIBackend {

package/js/types/commonDataProps.ts

@@ -9,6 +9,7 @@ export interface LMSBackend {
   backend: string;
   course_regexp: RegExp | string;
   endpoint: string;
+  next_url?: string;
 }
 
 export interface AuthenticationBackend {
@@ -26,6 +27,7 @@ export interface AuthenticationBackend {
     username: string;
     email: string;
   };
+  next_url?: string;
 }
 
 enum FEATURES {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "richie-education",
-  "version": "3.4.1-dev13",
+  "version": "3.4.1-dev14",
   "description": "A CMS to build learning portals for Open Education",
   "main": "sandbox/manage.py",
   "scripts": {