Skip to content

feat: add course info settings sidebar [FC-0123]#2955

Merged
ChrisChV merged 4 commits intoopenedx:masterfrom
open-craft:rpenido/fal-4336/settings-sidebar
Mar 31, 2026
Merged

feat: add course info settings sidebar [FC-0123]#2955
ChrisChV merged 4 commits intoopenedx:masterfrom
open-craft:rpenido/fal-4336/settings-sidebar

Conversation

@rpenido
Copy link
Copy Markdown
Contributor

@rpenido rpenido commented Mar 23, 2026

Description

This PR adds the Settings tab to the course info sidebar, which shows links to some course settings pages.

image

Supporting information

Testing instructions

  • Open a course and check the Settings tab on the info sidebar

Other information

WIP

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • [x Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

Private ref: FAL-4336

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 23, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Mar 23, 2026

Thanks for the pull request, @rpenido!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @rpenido!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 23, 2026

Codecov Report

❌ Patch coverage is 97.77778% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 95.56%. Comparing base (ba533a2) to head (33c16af).
⚠️ Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
...outline-sidebar/info-sidebar/CourseInfoSidebar.tsx 96.87% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2955   +/-   ##
=======================================
  Coverage   95.56%   95.56%           
=======================================
  Files        1350     1349    -1     
  Lines       31128    31154   +26     
  Branches     7038     7063   +25     
=======================================
+ Hits        29747    29772   +25     
- Misses       1319     1320    +1     
  Partials       62       62           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment on lines +68 to +75
const {
grading,
courseTeam,
advancedSettings,
scheduleAndDetails,
groupConfigurations,
} = otherLinkURLParams;
const waffleFlags = useWaffleFlags(courseId);
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @bradenmacdonald! Do we still have the "Legacy" pages of Studio, or should we clean up these references when we find them?

Asking before writing unnecessary tests here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rpenido I'm not sure - I asked here: openedx/openedx-platform#36275 (comment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(copying in my answer from the other PR) - legacy libraries needs to work until May 1st, and the legacy unit editor needs to continue working until we resolve one blocker (hopefully before verawood). All other legacy_studio waffles are OK to delete 🪓

Comment on lines -32 to -42

/**
* Get course settings.
* @param {string} courseId
* @returns {Promise<Object>}
*/
export async function getCourseSettings(courseId) {
const { data } = await getAuthenticatedHttpClient()
.get(getCourseSettingsApiUrl(courseId));
return camelCaseObject(data);
}
Copy link
Copy Markdown
Contributor Author

@rpenido rpenido Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to @src/data to remove duplicated code

Comment on lines -11 to -17
export const useCourseSettings = (courseId: string) => (
useQuery({
queryKey: ['courseSettings', courseId],
queryFn: () => getCourseSettings(courseId),
})
);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to @src/data to remove duplicated code

Comment on lines -35 to -46

/**
* Get course settings.
* @param {string} courseId
* @returns {Promise<Object>}
*/
export async function getCourseSettings(courseId) {
const { data } = await getAuthenticatedHttpClient().get(
`${getCourseSettingsApiUrl(courseId)}`,
);
return camelCaseObject(data);
}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to @src/data to remove duplicated code

@rpenido rpenido force-pushed the rpenido/fal-4336/settings-sidebar branch 5 times, most recently from ff33a43 to e77c8be Compare March 25, 2026 12:49
@rpenido rpenido changed the title feat: add course info settings sidebar feat: add course info settings sidebar [FC-0123] Mar 25, 2026
@rpenido rpenido marked this pull request as ready for review March 25, 2026 15:01
@rpenido rpenido force-pushed the rpenido/fal-4336/settings-sidebar branch 3 times, most recently from 1dc8063 to 85e1cb2 Compare March 26, 2026 23:51
@rpenido rpenido requested a review from navinkarkera March 27, 2026 11:50
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Mar 27, 2026
@mphilbrick211 mphilbrick211 moved this from Ready for Review to In Eng Review in Contributions Mar 27, 2026
Copy link
Copy Markdown
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rpenido Looks good. Thanks!

Comment thread src/data/api.ts Outdated

/**
* Get course settings.
* TODO: create type for the return value
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: Pending TODO

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here: ad3ee04

@rpenido rpenido force-pushed the rpenido/fal-4336/settings-sidebar branch from 85e1cb2 to 51707ed Compare March 30, 2026 17:30
Comment thread aspects.env.config.jsx Outdated
Comment thread src/data/api.ts Outdated
@rpenido rpenido force-pushed the rpenido/fal-4336/settings-sidebar branch from ad3ee04 to e101922 Compare March 31, 2026 12:04
Copy link
Copy Markdown
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks! 👍

@ChrisChV ChrisChV merged commit 4db8fca into openedx:master Mar 31, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Mar 31, 2026
@ChrisChV ChrisChV deleted the rpenido/fal-4336/settings-sidebar branch March 31, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

7 participants