feat!: Add JS-based configuration capabilities to Learner Record

.gitignore

@@ -5,6 +5,7 @@ node_modules
 npm-debug.log
 coverage
 module.config.js
+env.config.js
 
 dist/
 src/i18n/transifex_input.json

example.env.config.js

@@ -0,0 +1,48 @@
+/*
+Learner Record is now able to handle JS-based configuration!
+
+For the time being, the `.env.*` files are still made available when cloning down this repo or pulling from
+the master branch. To switch to using `env.config.js`:
+
+1. Make a copy of `example.env.config.js` and configure as needed.
+2. To ensure the port number is assigned to the one provided in your env.config,
+uncomment the lines in webpack.dev.config.js . This will eventually be resolved in https:/openedx/frontend-build/issues/513
+
+Note: having both .env and env.config.js files will follow a predictable order, in which non-empty values in the
+JS-based config will overwrite the .env environment variables.
+
+frontend-platform's getConfig loads configuration in the following sequence:
+- .env file config
+- optional handlers (commonly used to merge MFE-specific config in via additional process.env variables)
+- env.config.js file config
+- runtime config
+*/
+
+module.exports = {
+ NODE_ENV: 'development',
+ PORT: 1990,
+ ACCESS_TOKEN_COOKIE_NAME: 'edx-jwt-cookie-header-payload',
+ BASE_URL: 'http://localhost:1990',
+ CREDENTIALS_BASE_URL: 'http://localhost:18150',
+ CSRF_TOKEN_API_PATH: '/csrf/api/v1/token',
+ ECOMMERCE_BASE_URL: 'http://localhost:18130',
+ LANGUAGE_PREFERENCE_COOKIE_NAME: 'openedx-language-preference',
+ LMS_BASE_URL: 'http://localhost:18000',
+ LOGIN_URL: 'http://localhost:18000/login',
+ LOGOUT_URL: 'http://localhost:18000/logout',
+ LOGO_URL: 'https://edx-cdn.org/v3/default/logo.svg',
+ LOGO_TRADEMARK_URL: 'https://edx-cdn.org/v3/default/logo-trademark.svg',
+ LOGO_WHITE_URL: 'https://edx-cdn.org/v3/default/logo-white.svg',
+ FAVICON_URL: 'https://edx-cdn.org/v3/default/favicon.ico',
+ MARKETING_SITE_BASE_URL: 'http://localhost:18000',
+ ORDER_HISTORY_URL: 'http://localhost:1996/orders',
+ REFRESH_ACCESS_TOKEN_ENDPOINT: 'http://localhost:18000/login_refresh',
+ SEGMENT_KEY: '',
+ SITE_NAME: 'localhost',
+ USER_INFO_COOKIE_NAME: 'edx-user-info',
+ SUPPORT_URL_LEARNER_RECORDS: 'https://support.edx.org/hc/en-us/sections/360001216693-Learner-records',
+ APP_ID: '',
+ MFE_CONFIG_API_URL: '',
+ ENABLE_VERIFIABLE_CREDENTIALS: true,
+ SUPPORT_URL_VERIFIABLE_CREDENTIALS: '',
+};

jest.config.js

@@ -1,5 +1,19 @@
+const path = require('path');
+const fs = require('fs');
 const { createConfig } = require('@edx/frontend-build');
 
+/** in case there isn't an env.config.js in development or pushed into the master branch
+ we want to rely on a fallback config that exists in ./jest that provides an empty object.
+ This implementation was first done in frontend-build
+ https:/openedx/frontend-build/blob/master/config/jest/fallback.env.config.js
+*/
+let envConfigPath = path.resolve(__dirname, './jest/fallback.env.config.js');
+const appEnvConfigPath = path.resolve(process.cwd(), './env.config.js');
+
+if (fs.existsSync(appEnvConfigPath)) {
+ envConfigPath = appEnvConfigPath;
+}
+
 module.exports = createConfig('jest', {
  // setupFilesAfterEnv is used after the jest environment has been loaded. In general this is what you want. 
  // If you want to add config BEFORE jest loads, use setupFiles instead. 
@@ -10,4 +24,7 @@ module.exports = createConfig('jest', {
  'src/setupTest.js',
  'src/i18n',
  ],
+ moduleNameMapper: {
+ 'env.config': envConfigPath,
+ },
 });

jest/fallback.env.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+ // DO NOT PUT ANY CONFIGURATION IN THIS FILE.
+
+ // The existence of this file is a technical detail of the mechanism used to implement
+ // env.config.js files for jest.
+
+ // This file is used as a fallback to prevent build errors if an env.config.js file has not been
+ // defined in a consuming application. If we could inline an empty object instead of needing a
+ // file to reference, that'd be clearer, but doesn't seem to be an option.
+
+ // This is NOT an appropriate place to put actual configuration values for tests.
+};