refactor: clean up unnecessary changes

openedx · Feb 3, 2025 · 4204364 · 4204364
1 parent 29364e3
commit 4204364
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 19 deletions.
diff --git a/env.config.js b/env.config.js
@@ -5,4 +5,4 @@ const config = {
   JS_FILE_VAR: 'JS_FILE_VAR_VALUE_FOR_EXAMPLE_APP',
 };
 
-module.exports = config;
+export default config;
diff --git a/example/index.jsx b/example/index.jsx
@@ -10,11 +10,10 @@ import { APP_INIT_ERROR, APP_READY, initialize } from '@edx/frontend-platform';
 import { subscribe } from '@edx/frontend-platform/pubSub';
 import { Routes, Route } from 'react-router-dom';
 
+import './index.scss';
 import ExamplePage from './ExamplePage';
 import AuthenticatedPage from './AuthenticatedPage';
 
-import './index.scss';
-
 subscribe(APP_READY, () => {
   ReactDOM.render(
     <AppProvider>

diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
     "lint": "fedx-scripts eslint --ext .js --ext .jsx .",
     "i18n_extract": "fedx-scripts formatjs extract",
     "snapshot": "fedx-scripts jest --updateSnapshot",
-    "start": "fedx-scripts webpack-dev-server --progress --host apps.local.openedx.io",
+    "start": "fedx-scripts webpack-dev-server --progress",
     "test": "fedx-scripts jest --coverage",
     "test:watch": "npm run test -- --watch"
   },

diff --git a/src/react/hooks/paragon/useParagonThemeCore.js b/src/react/hooks/paragon/useParagonThemeCore.js
@@ -77,9 +77,9 @@ const useParagonThemeCore = ({
             return;
           }
           const paragonThemeAccessor = isBrandOverride ? 'brand' : 'paragon';
-          const themeUrls = PARAGON_THEME?.[paragonThemeAccessor]?.themeUrls ?? {};
-          if (themeUrls.core) {
-            const coreThemeFallbackUrl = fallbackThemeUrl(themeUrls.core.fileName);
+          const core = PARAGON_THEME?.[paragonThemeAccessor]?.themeUrls?.core ?? {};
+          if (core) {
+            const coreThemeFallbackUrl = fallbackThemeUrl(core.fileName);
             logInfo(`Falling back to locally installed core theme CSS: ${coreThemeFallbackUrl}`);
             coreThemeLink = createCoreThemeLink(coreThemeFallbackUrl, { isFallbackThemeUrl: true, isBrandOverride });
             const otherExistingLinks = getExistingCoreThemeLinks(isBrandOverride);

diff --git a/src/react/hooks/paragon/useParagonThemeUrls.js b/src/react/hooks/paragon/useParagonThemeUrls.js
@@ -18,6 +18,8 @@ const useParagonThemeUrls = (config) => useMemo(() => {
   const defaultThemeVariants = paragonThemeUrls.defaults;
 
   // Local versions of @openedx/paragon and @edx/brand
+  // these are only used when passed into handleVersionSubstitution
+  // which does not attempt substitution using falsy value
   const localParagonVersion = PARAGON_THEME?.paragon?.version;
   const localBrandVersion = PARAGON_THEME?.brand?.version;
 

diff --git a/src/react/hooks/paragon/useParagonThemeVariants.js b/src/react/hooks/paragon/useParagonThemeVariants.js
@@ -27,16 +27,16 @@ const useParagonThemeVariants = ({
   const [isBrandThemeVariantLoaded, setIsBrandThemeVariantLoaded] = useState(false);
 
   useEffect(() => {
-    const someFn = (colorSchemeQuery) => {
+    const changeColorShceme = (colorSchemeQuery) => {
       onDarkModeSystemPreferenceChange(colorSchemeQuery.matches);
     };
     const colorSchemeQuery = window.matchMedia?.('(prefers-color-scheme: dark)');
     if (colorSchemeQuery) {
-      colorSchemeQuery.addEventListener('change', someFn);
+      colorSchemeQuery.addEventListener('change', changeColorShceme);
     }
     return () => {
       if (colorSchemeQuery) {
-        colorSchemeQuery.removeEventListener('change', someFn);
+        colorSchemeQuery.removeEventListener('change', changeColorShceme);
       }
     };
   }, [onDarkModeSystemPreferenceChange]);
@@ -49,7 +49,7 @@ const useParagonThemeVariants = ({
         document.querySelector('html').removeAttribute(htmlDataThemeVariantAttr);
       };
     }
-    return () => {}; // no-op
+    return () => {}; // Cleanup: no action needed when theme variant is not set
   }, [themeVariants, currentThemeVariant]);
 
   useEffect(() => {
@@ -127,9 +127,9 @@ const useParagonThemeVariants = ({
             return;
           }
           const paragonThemeAccessor = isBrandOverride ? 'brand' : 'paragon';
-          const themeUrls = PARAGON_THEME?.[paragonThemeAccessor]?.themeUrls ?? {};
-          if (themeUrls.variants && themeUrls.variants[themeVariant]) {
-            const themeVariantFallbackUrl = fallbackThemeUrl(themeUrls.variants[themeVariant].fileName);
+          const variants = PARAGON_THEME?.[paragonThemeAccessor]?.themeUrls?.variants ?? {};
+          if (variants[themeVariant]) {
+            const themeVariantFallbackUrl = fallbackThemeUrl(variants[themeVariant].fileName);
             logInfo(`Falling back to locally installed theme variant (${themeVariant}) CSS: ${themeVariantFallbackUrl}`);
             themeVariantLink = createThemeVariantLink(themeVariantFallbackUrl, {
               isFallbackThemeUrl: true,

diff --git a/webpack.dev.config.js b/webpack.dev.config.js
@@ -14,9 +14,4 @@ module.exports = createConfig('webpack-dev', {
       '@edx/frontend-platform': path.resolve(__dirname, 'src'),
     },
   },
-  devServer: {
-    static: {
-      directory: path.resolve(__dirname, 'example/dist'),
-    },
-  },
 });