Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Show published OLX in Library Content Picker [FC-0062] #1534

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Nov 27, 2024

Description

Fix #1354 (comment)

  • Which edX user roles will this change impact? "Course Author".

Supporting information

GitHub Issue: #1354 (comment)
Depends on: openedx/edx-platform#35932
Internal ticket: FAL-3976

Testing instructions

  • Create or use an existing library.
  • Create a new text component, edit the content, and publish the library.
  • Edit the content of your new component, but not publish the library.
  • Go to Details → Advanced details → OLX Source, and verify that you can see the draft OLX.
  • Go to a unit in a course.
  • Add a library component, select your library.
  • In the Library Component Picker go to Details → Advanced details → OLX Source and verify that you can see the published OLX.

@ChrisChV ChrisChV requested a review from a team as a code owner November 27, 2024 18:54
@openedx-webhooks
Copy link

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 27, 2024
@ChrisChV ChrisChV changed the title fix: Show published OLX in Library Content Picker fix: Show published OLX in Library Content Picker [FC-0062] Nov 27, 2024
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.91%. Comparing base (f86c609) to head (e4c83e9).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1534   +/-   ##
=======================================
  Coverage   92.91%   92.91%           
=======================================
  Files        1065     1065           
  Lines       20980    20981    +1     
  Branches     4468     4468           
=======================================
+ Hits        19494    19495    +1     
  Misses       1419     1419           
  Partials       67       67           

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

Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

I will re-review this after you consider my suggestions for the edx-platform PR.

@@ -418,8 +418,8 @@ export async function createCollection(libraryId: string, collectionData: Create
* Fetch the OLX for the given XBlock.
*/
// istanbul ignore next
export async function getXBlockOLX(usageKey: string): Promise<string> {
const { data } = await getAuthenticatedHttpClient().get(getXBlockOLXApiUrl(usageKey));
export async function getXBlockOLX(usageKey: string, version?: string): Promise<string> {
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of version?: string maybe we can use version?: VersionSpec ?

export type VersionSpec = 'published' | 'draft' | number;

@@ -350,10 +350,10 @@ export const useCreateLibraryCollection = (libraryId: string) => {
};

/** Get the OLX source of a library component */
export const useXBlockOLX = (usageKey: string) => (
export const useXBlockOLX = (usageKey: string, version?: string) => (
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of version?: string maybe we can use version?: VersionSpec ?

export type VersionSpec = 'published' | 'draft' | number;

render(usageKey, undefined, true);
const expandButton = await screen.findByRole('button', { name: /Advanced details/ });
fireEvent.click(expandButton);
// Because of syntax highlighting, the OLX will be borken up by many different tags so we need to search for
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Because of syntax highlighting, the OLX will be borken up by many different tags so we need to search for
// Because of syntax highlighting, the OLX will be broken up by many different tags so we need to search for

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
Status: Needs Triage
3 participants