richie-education 2.25.0-b2.dev101 → 2.25.0-b2.dev103

package/js/api/lms/dummy.ts

@@ -42,7 +42,7 @@ export type DevDemoUser = keyof typeof JOANIE_DEV_DEMO_USER_JWT_TOKENS;
 
 export const RICHIE_DUMMY_IS_LOGGED_IN = 'RICHIE_DUMMY_IS_LOGGED_IN';
 
-function getUserInfo(username: DevDemoUser): Maybe<User> {
+function getUserInfo(username: DevDemoUser): User {
   const accessToken = JOANIE_DEV_DEMO_USER_JWT_TOKENS[username];
   const JWTPayload: JWTPayload = JSON.parse(base64Decode(accessToken.split('.')[1]));
 
@@ -78,7 +78,7 @@ const API = (APIConf: LMSBackend | AuthenticationBackend): APILms => {
         if (!localStorage.getItem(RICHIE_DUMMY_IS_LOGGED_IN)) {
           return null;
         }
-        return getUserInfo(CURRENT_JOANIE_DEV_DEMO_USER) || null;
+        return CURRENT_JOANIE_DEV_DEMO_USER ? getUserInfo(CURRENT_JOANIE_DEV_DEMO_USER) : null;
       },
       login: () => {
         localStorage.setItem(RICHIE_DUMMY_IS_LOGGED_IN, 'true');

package/js/settings/index.ts

@@ -0,0 +1,38 @@
+import { mergeWith } from 'lodash-es';
+import * as prodSettings from './settings.prod';
+import * as testSettings from './settings.test';
+
+let settingsOverride = {};
+if (process.env.NODE_ENV === 'development') {
+  try {
+    settingsOverride = require('./settings.local.ts');
+  } catch {
+    // no local settings found, do nothing
+  }
+} else if (process.env.NODE_ENV === 'test') {
+  settingsOverride = testSettings;
+}
+
+try {
+  settingsOverride = require('./settings.local.ts');
+} catch {
+  // no local settings found, do nothing
+}
+
+const settings = mergeWith({}, prodSettings, settingsOverride);
+
+export const {
+  API_LIST_DEFAULT_PARAMS,
+  EDX_CSRF_TOKEN_COOKIE_NAME,
+  RICHIE_USER_TOKEN,
+  RICHIE_LTI_ANONYMOUS_USER_ID_CACHE_KEY,
+  JOANIE_API_VERSION,
+  REACT_QUERY_SETTINGS,
+  PAYMENT_SETTINGS,
+  CONTRACT_SETTINGS,
+  CONTRACT_DOWNLOAD_SETTINGS,
+  PER_PAGE,
+  MOCK_SERVICE_WORKER_ENABLED,
+  DEBUG_UNION_RESOURCES_HOOK,
+  CURRENT_JOANIE_DEV_DEMO_USER,
+} = settings;

package/js/settings/settings.dev.dist.ts

@@ -0,0 +1,25 @@
+// This configuration file can be overridden with settings.dev.ts file.
+// `$ cp settings.local.dist.ts settings.local.ts`, then change what's needed
+// in local environment in settings.local.ts.
+import { DevDemoUser } from 'api/lms/dummy';
+
+// disable react query cache
+// export const REACT_QUERY_SETTINGS = {
+//   staleTimes: {
+//     session: 0,
+//     sessionItems: 0,
+//   },
+// };
+
+/**
+ * Available users:
+ *  * admin
+ *  * user0
+ *  * user1
+ *  * user2
+ *  * user3
+ *  * user4
+ *  * organization_owner
+ *  * student_user
+ */
+export const CURRENT_JOANIE_DEV_DEMO_USER: DevDemoUser = 'admin';

package/js/{settings.ts → settings/settings.prod.ts}

@@ -1,5 +1,3 @@
-import * as defaultDevSettings from './settings.dev.dist';
-
 export const API_LIST_DEFAULT_PARAMS = {
   limit: '21',
   offset: '0',
@@ -61,15 +59,5 @@ export const PER_PAGE = {
   useOrdersEnrollments: DEFAULT_PER_PAGE,
 };
 
-let devSettings;
-try {
-  devSettings = require('settings.dev.ts');
-} catch {
-  devSettings = defaultDevSettings;
-}
-
 export const MOCK_SERVICE_WORKER_ENABLED = false;
-
-export const DEBUG_UNION_RESOURCES_HOOK = process.env.NODE_ENV !== 'production' && false;
-
-export const { CURRENT_JOANIE_DEV_DEMO_USER } = devSettings;
+export const DEBUG_UNION_RESOURCES_HOOK = false;

package/js/settings/settings.test.ts

@@ -0,0 +1,16 @@
+// This confiuration file is used for testing.
+// Mostly usefull to test our test tools.
+import { DevDemoUser } from 'api/lms/dummy';
+
+/**
+ * Available users:
+ *  * admin
+ *  * user0
+ *  * user1
+ *  * user2
+ *  * user3
+ *  * user4
+ *  * organization_owner
+ *  * student_user
+ */
+export const CURRENT_JOANIE_DEV_DEMO_USER: DevDemoUser = 'admin';

package/js/utils/test/wrappers/JoanieAppWrapper.tsx

@@ -2,6 +2,7 @@ import { CunninghamProvider } from '@openfun/cunningham-react';
 import { PropsWithChildren } from 'react';
 import fetchMock from 'fetch-mock';
 import JoanieSessionProvider from 'contexts/SessionContext/JoanieSessionProvider';
+import { DashboardBreadcrumbsProvider } from 'widgets/Dashboard/contexts/DashboardBreadcrumbsContext';
 import { IntlWrapper } from './IntlWrapper';
 import { ReactQueryWrapper } from './ReactQueryWrapper';
 import { RouterWrapper } from './RouterWrapper';
@@ -26,14 +27,18 @@ export const JoanieSessionWrapper = ({ children }: PropsWithChildren) => {
 
 export const JoanieAppWrapper = ({
   children,
-  options,
-}: PropsWithChildren<{ options?: AppWrapperProps }>) => {
+  intlOptions,
+  queryOptions,
+  routerOptions,
+}: PropsWithChildren<AppWrapperProps>) => {
   return (
-    <IntlWrapper {...(options?.intlOptions || { locale: 'en' })}>
+    <IntlWrapper {...(intlOptions || { locale: 'en' })}>
       <CunninghamProvider>
-        <ReactQueryWrapper {...(options?.queryOptions || {})}>
+        <ReactQueryWrapper {...(queryOptions || {})}>
           <JoanieSessionWrapper>
-            <RouterWrapper {...options?.routerOptions}>{children}</RouterWrapper>
+            <DashboardBreadcrumbsProvider>
+              <RouterWrapper {...routerOptions}>{children}</RouterWrapper>
+            </DashboardBreadcrumbsProvider>
           </JoanieSessionWrapper>
         </ReactQueryWrapper>
       </CunninghamProvider>

package/package.json

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

package/js/settings.dev.dist.ts

@@ -1,3 +0,0 @@
-import { DevDemoUser } from 'api/lms/dummy';
-
-export const CURRENT_JOANIE_DEV_DEMO_USER: DevDemoUser = 'admin';