From 64ce45af913acb1cb4f36c383f0cdea91f39b50f Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 1 Apr 2024 07:21:03 +0000 Subject: [PATCH 1/3] chore(deps): update dependency @openedx/paragon to v22.2.1 --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index aa3b133b3..456c863a4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -26,7 +26,7 @@ "@edx/frontend-platform": "7.1.3", "@edx/reactifex": "^2.1.1", "@openedx/frontend-build": "13.1.0", - "@openedx/paragon": "22.1.1", + "@openedx/paragon": "22.2.1", "@testing-library/dom": "9.3.4", "@testing-library/jest-dom": "5.17.0", "@testing-library/react": "10.4.9", @@ -5443,9 +5443,9 @@ } }, "node_modules/@openedx/paragon": { - "version": "22.1.1", - "resolved": "https://registry.npmjs.org/@openedx/paragon/-/paragon-22.1.1.tgz", - "integrity": "sha512-XPRuV9zn7BeCIYfU5kE2XZ4YevjA0wfS/fuydB8Ta/aNY1dw9fQ7CjHOIfkZqDic4Jygusj/uhE/1WYJD8kvyw==", + "version": "22.2.1", + "resolved": "https://registry.npmjs.org/@openedx/paragon/-/paragon-22.2.1.tgz", + "integrity": "sha512-Dd7PzvHwNnUokqbFkuOpugJZ9dHaUBOcYwqAA2aMoN7tgi4xEZWsfDFyP1+se2UPuR7NvNGammEesLAwGQ0Ylw==", "dev": true, "workspaces": [ "example", diff --git a/package.json b/package.json index 745d77024..2848e54b7 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "@edx/frontend-platform": "7.1.3", "@edx/reactifex": "^2.1.1", "@openedx/frontend-build": "13.1.0", - "@openedx/paragon": "22.1.1", + "@openedx/paragon": "22.2.1", "@testing-library/dom": "9.3.4", "@testing-library/jest-dom": "5.17.0", "@testing-library/react": "10.4.9", From 622529c04c8e750149009e7045ad4e68b25af952 Mon Sep 17 00:00:00 2001 From: arora-r Date: Mon, 1 Apr 2024 12:53:54 -0400 Subject: [PATCH 2/3] feat: add a new environment variable to control where the header logo links to --- .env.development | 1 + README.rst | 1 + src/Header.jsx | 3 ++- src/Header.test.jsx | 4 ++++ src/learning-header/LearningHeader.jsx | 2 +- src/setupTest.js | 2 ++ src/studio-header/StudioHeader.jsx | 2 ++ src/studio-header/StudioHeader.test.jsx | 1 + 8 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.env.development b/.env.development index 9c59d0b86..ec20aa0d2 100644 --- a/.env.development +++ b/.env.development @@ -17,6 +17,7 @@ SEGMENT_KEY=null SITE_NAME=Open edX USER_INFO_COOKIE_NAME=edx-user-info LOGO_URL=https://edx-cdn.org/v3/default/logo.svg +LOGO_DESTINATION=http://localhost:18000/dashboard 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 diff --git a/README.rst b/README.rst index ab9e4db72..e0d12c353 100644 --- a/README.rst +++ b/README.rst @@ -45,6 +45,7 @@ Environment Variables * ``SITE_NAME`` - The user-facing name of the site, used as `alt` text on the logo in the header. Defaults to "localhost" in development. * ``LOGO_URL`` - The URL of the site's logo. This logo is displayed in the header. +* ``LOGO_DESTINATION`` - The URL of where the site's logo should point to. * ``ORDER_HISTORY_URL`` - The URL of the order history page. * ``ACCOUNT_PROFILE_URL`` - The URL of the account profile page. * ``ACCOUNT_SETTINGS_URL`` - The URL of the account settings page. diff --git a/src/Header.jsx b/src/Header.jsx index c0db257c7..7502e06d6 100644 --- a/src/Header.jsx +++ b/src/Header.jsx @@ -21,6 +21,7 @@ ensureConfig([ 'LOGIN_URL', 'SITE_NAME', 'LOGO_URL', + 'LOGO_DESTINATION', 'ORDER_HISTORY_URL', ], 'Header component'); @@ -91,7 +92,7 @@ const Header = ({ intl }) => { const props = { logo: config.LOGO_URL, logoAltText: config.SITE_NAME, - logoDestination: `${config.LMS_BASE_URL}/dashboard`, + logoDestination: config.LOGO_DESTINATION || `${config.LMS_BASE_URL}/dashboard`, loggedIn: authenticatedUser !== null, username: authenticatedUser !== null ? authenticatedUser.username : null, avatar: authenticatedUser !== null ? authenticatedUser.avatar : null, diff --git a/src/Header.test.jsx b/src/Header.test.jsx index 51fef2089..51691cd06 100644 --- a/src/Header.test.jsx +++ b/src/Header.test.jsx @@ -29,6 +29,7 @@ describe('
', () => { LOGIN_URL: process.env.LOGIN_URL, LOGOUT_URL: process.env.LOGOUT_URL, LOGO_URL: process.env.LOGO_URL, + LOGO_DESTINATION: process.env.LOGO_DESTINATION, }, }; const component = ; @@ -52,6 +53,7 @@ describe('
', () => { LOGIN_URL: process.env.LOGIN_URL, LOGOUT_URL: process.env.LOGOUT_URL, LOGO_URL: process.env.LOGO_URL, + LOGO_DESTINATION: process.env.LOGO_DESTINATION, }, }; const component = ; @@ -70,6 +72,7 @@ describe('
', () => { LOGIN_URL: process.env.LOGIN_URL, LOGOUT_URL: process.env.LOGOUT_URL, LOGO_URL: process.env.LOGO_URL, + LOGO_DESTINATION: process.env.LOGO_DESTINATION, }, }; const component = ; @@ -93,6 +96,7 @@ describe('
', () => { LOGIN_URL: process.env.LOGIN_URL, LOGOUT_URL: process.env.LOGOUT_URL, LOGO_URL: process.env.LOGO_URL, + LOGO_DESTINATION: process.env.LOGO_DESTINATION, }, }; const component = ; diff --git a/src/learning-header/LearningHeader.jsx b/src/learning-header/LearningHeader.jsx index 373001d19..9a3d74e41 100644 --- a/src/learning-header/LearningHeader.jsx +++ b/src/learning-header/LearningHeader.jsx @@ -33,7 +33,7 @@ const LearningHeader = ({ const headerLogo = ( diff --git a/src/setupTest.js b/src/setupTest.js index 95e0e5866..d64c28d37 100644 --- a/src/setupTest.js +++ b/src/setupTest.js @@ -35,6 +35,7 @@ process.env.SEGMENT_KEY = 'segment_whoa'; process.env.SITE_NAME = 'edX'; process.env.USER_INFO_COOKIE_NAME = 'edx-user-info'; process.env.LOGO_URL = 'https://edx-cdn.org/v3/default/logo.svg'; +process.env.LOGO_DESTINATION = `${process.env.LMS_BASE_URL}/dashboard`, process.env.LOGO_TRADEMARK_URL = 'https://edx-cdn.org/v3/default/logo-trademark.svg'; process.env.LOGO_WHITE_URL = 'https://edx-cdn.org/v3/default/logo-white.svg'; process.env.FAVICON_URL = 'https://edx-cdn.org/v3/default/favicon.ico'; @@ -65,6 +66,7 @@ export function initializeMockApp() { ACCESS_TOKEN_COOKIE_NAME: process.env.ACCESS_TOKEN_COOKIE_NAME || null, CSRF_TOKEN_API_PATH: process.env.CSRF_TOKEN_API_PATH || null, LOGO_URL: process.env.LOGO_URL || null, + LOGO_DESTINATION: process.env.LOGO_DESTINATION || `${config.LMS_BASE_URL}/dashboard`, SITE_NAME: process.env.SITE_NAME || null, authenticatedUser: { diff --git a/src/studio-header/StudioHeader.jsx b/src/studio-header/StudioHeader.jsx index 3f267e031..934fb4f2f 100644 --- a/src/studio-header/StudioHeader.jsx +++ b/src/studio-header/StudioHeader.jsx @@ -13,6 +13,7 @@ ensureConfig([ 'LOGOUT_URL', 'LOGIN_URL', 'LOGO_URL', + 'LOGO_DESTINATION', ], 'Studio Header component'); const StudioHeader = ({ @@ -21,6 +22,7 @@ const StudioHeader = ({ const { authenticatedUser, config } = useContext(AppContext); const props = { logo: config.LOGO_URL, + logoDestination: config.LOGO_DESTINATION, logoAltText: `Studio ${config.SITE_NAME}`, number, org, diff --git a/src/studio-header/StudioHeader.test.jsx b/src/studio-header/StudioHeader.test.jsx index 8ebda05cd..de8ea8d1b 100644 --- a/src/studio-header/StudioHeader.test.jsx +++ b/src/studio-header/StudioHeader.test.jsx @@ -31,6 +31,7 @@ const RootWrapper = ({ config: { LOGOUT_URL: process.env.LOGOUT_URL, LOGO_URL: process.env.LOGO_URL, + LOGO_DESTINATION: process.env.LOGO_DESTINATION, SITE_NAME: process.env.SITE_NAME, STUDIO_BASE_URL: process.env.STUDIO_BASE_URL, LOGIN_URL: process.env.LOGIN_URL, From a02c750ddd45b2ffb3126376395fda7ce66e59cd Mon Sep 17 00:00:00 2001 From: arora-r Date: Thu, 4 Apr 2024 13:17:02 -0400 Subject: [PATCH 3/3] fix: bad copy and pastes and run npm install to update the package-lock.json --- package-lock.json | 6 ------ src/setupTest.js | 4 ++-- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 456c863a4..6f127c562 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,6 @@ "@fortawesome/free-regular-svg-icons": "6.5.1", "@fortawesome/free-solid-svg-icons": "6.5.1", "@fortawesome/react-fontawesome": "^0.2.0", - "@openedx/brand-openedx": "^1.2.3", "axios-mock-adapter": "1.22.0", "babel-polyfill": "6.26.0", "react-responsive": "8.2.0", @@ -4233,11 +4232,6 @@ "node": ">= 8" } }, - "node_modules/@openedx/brand-openedx": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/@openedx/brand-openedx/-/brand-openedx-1.2.3.tgz", - "integrity": "sha512-Dn9CtpC8fovh++Xi4NF5NJoeR9yU2yXZnV9IujxIyGd/dn0Phq5t6dzJVfupwq09mpDnzJv7egA8Znz/3ljO+w==" - }, "node_modules/@openedx/frontend-build": { "version": "13.1.0", "resolved": "https://registry.npmjs.org/@openedx/frontend-build/-/frontend-build-13.1.0.tgz", diff --git a/src/setupTest.js b/src/setupTest.js index d64c28d37..967fff1b7 100644 --- a/src/setupTest.js +++ b/src/setupTest.js @@ -35,7 +35,7 @@ process.env.SEGMENT_KEY = 'segment_whoa'; process.env.SITE_NAME = 'edX'; process.env.USER_INFO_COOKIE_NAME = 'edx-user-info'; process.env.LOGO_URL = 'https://edx-cdn.org/v3/default/logo.svg'; -process.env.LOGO_DESTINATION = `${process.env.LMS_BASE_URL}/dashboard`, +process.env.LOGO_DESTINATION = `${process.env.LMS_BASE_URL}/dashboard`; process.env.LOGO_TRADEMARK_URL = 'https://edx-cdn.org/v3/default/logo-trademark.svg'; process.env.LOGO_WHITE_URL = 'https://edx-cdn.org/v3/default/logo-white.svg'; process.env.FAVICON_URL = 'https://edx-cdn.org/v3/default/favicon.ico'; @@ -66,7 +66,7 @@ export function initializeMockApp() { ACCESS_TOKEN_COOKIE_NAME: process.env.ACCESS_TOKEN_COOKIE_NAME || null, CSRF_TOKEN_API_PATH: process.env.CSRF_TOKEN_API_PATH || null, LOGO_URL: process.env.LOGO_URL || null, - LOGO_DESTINATION: process.env.LOGO_DESTINATION || `${config.LMS_BASE_URL}/dashboard`, + LOGO_DESTINATION: process.env.LOGO_DESTINATION || `${process.env.LMS_BASE_URL}/dashboard`, SITE_NAME: process.env.SITE_NAME || null, authenticatedUser: {