XBlock asset support for new libraries experience (WIP) #35557

ormsbee · 2024-09-27T22:53:17Z

A very hacky pass at getting Learning Core backed static assets to show up for libraries.

Things I need to look into:

Showing different versions of the content, since it's rendering on LMS and we're not using Studio vs. LMS to decide which version to get. (Would be nice to get any version.)
Current static-replace convention is to strip the leading static/ piece, but that might be useful.
To what extent do we really need AssetKeys in new libraries?
I had to comment out XBlockSerializer's scan-content-for-static-asset-references functionality, because it had some assumptions about course content. Will probably create an optional function pointer argument so that Learning Core can provide their own implementation for this.

This depends on:

Also, in order for this to work at all, I had to comment out:

https://github.com/openedx/frontend-app-authoring/blob/c80483c0533a10e46c59e9bd28e02a7650720a61/src/editors/sharedComponents/TinyMceWidget/hooks.js#L103-L116

That frontend code was auto-replacing static asset references with links that would show up in the WYSIWG editor (by casting them to asset keys), and then changing them back into the original static references when saving. Unfortunately, the code doesn't understand v2 libraries and generates broken keys.

…rences

bradenmacdonald · 2024-09-28T18:33:24Z

@ormsbee I don't think we need to be using the LMS to render the previews today. I think it would actually make more sense to change to use Studio. The Authoring MFE really shouldn't be using the LMS APIs at all. In fact, I'd even like to find a way for the "preview published version" functionality (that we don't have yet) to use some CMS URL.

…staged content

bradenmacdonald · 2024-09-28T18:43:18Z

openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py

+        TODO: Like get_block, we currently assume that we're using the Draft
+        version. This should be a runtime parameter.


You probably know this, but here in apps.py is where we can set runtime parameters like "studio should default to DRAFT" and "LMS should default to PUBLISHED".

It would be very cool if we could later override this default using a context manager when needed, but I don't know if that's a safe way to implement such an override.

Is it sufficient to do Draft vs. Published, or should we be able to do any stored version (for the sake of seeing what changed)? (I was assuming we'd eventually need the latter.)

Being able to see any stored version would be great, so I think we should do that. But more often I'll just want to specify "latest draft" or "latest published" so I hope we can have both options.

bradenmacdonald · 2024-09-29T01:32:53Z

My test instructions:

Get the code and restart tutor:

cd tutor
git fetch origin pull/1124/head:ormsbee_private_media
git checkout ormsbee_private_media
cd ..
cd openedx-learning
git fetch origin pull/234/head:ormsbee_asset_integration
git checkout ormsbee_asset_integration
cd ..
cd edx-platform
git fetch origin pull/35557/head:ormsbee_new_assets_hacky
git checkout ormsbee_new_assets_hacky
tutor dev stop
tutor config save
tutor dev start cms lms mfe

Check out this PR for the authoring MFE (git fetch origin pull/1346/head:olx_editor && git checkout olx_editor)

Go into a v2 library in the MFE and create a Text component. Use the OLX editor to give it some HTML like this:

<html display_name="Text with Image"><![CDATA[
  <p>Here is a picture:</p>
  <img alt="Picture" src="/static/example.jpg" />
]]></html>

Go to http://studio.local.openedx.io:8001/admin/oel_components/componentversion/ - the new HTML component version should be at the top of the list.
Find an image and put it into the openedx-learning folder. Call it example.jpg

Run this command to add the image to the ComponentVersion - substitute the correct ID of the library containing your component as well as the "Component" ID obtained from the ComponentVersion.

tutor dev exec cms python manage.py cms add_assets_to_component lib:OpenCraftX:ALPHA xblock.v1:html:103e1e17-a459-4a56-8919-06f0c69392a3 static/example.jpg:/mnt/openedx-learning/example.jpg

Refresh the view in the course authoring MFE:

It works!!

openedx/core/djangoapps/content_libraries/api.py

ormsbee · 2024-09-30T14:44:53Z

This PR now also relies on openedx/frontend-app-authoring#1349 (disables static asset substitution in the editor, and switches the preview embed window to point to Studio instead of LMS).

… nested directories

ormsbee · 2024-10-15T16:16:26Z

Closing in favor of smaller PRs:

Server-side Library asset support (asset view and api get/add/delete) #35639

ormsbee added 2 commits September 27, 2024 18:52

feat: very hacky first pass at getting static assets to show in v2 libs

c2e1d24

fix: prevent the 'static/' prefix from getting stripped in asset refe…

55e7efc

…rences

feat: get copy to take Learning Core static assets and put them into …

fd21124

…staged content

bradenmacdonald reviewed Sep 28, 2024

View reviewed changes

This was referenced Sep 29, 2024

feat: create volume for private LMS/CMS media assets overhangio/tutor#1124

Merged

Asset handling updates (config, admin) openedx/openedx-learning#234

Merged

bradenmacdonald reviewed Sep 29, 2024

View reviewed changes

openedx/core/djangoapps/content_libraries/api.py Show resolved Hide resolved

ormsbee added 2 commits September 28, 2024 23:55

feat: working paste between v2 libraries and from course -> v2 library

2da6e8a

temp: move the preview library XBlock rendering to happen via Studio

aef0bc8

temp: fix it so that paste happens in one version instead of making two

5f74348

ormsbee self-assigned this Oct 2, 2024

ormsbee mentioned this pull request Oct 2, 2024

Support static assets in the Learning Core runtime #34737

Closed

ormsbee added 2 commits October 2, 2024 16:28

feat: pasting from libraries into courses works now, and will created…

4013341

… nested directories

feat: add import_path and expanded_path to asset metadata JSON

cbe1792

ormsbee mentioned this pull request Oct 11, 2024

Server-side Library asset support (asset view and api get/add/delete) #35639

Merged

ormsbee closed this Oct 15, 2024

ormsbee mentioned this pull request Oct 16, 2024

Support static asset display in the Learning Core XBlock runtime #35659

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

XBlock asset support for new libraries experience (WIP) #35557

XBlock asset support for new libraries experience (WIP) #35557

ormsbee commented Sep 27, 2024 •

edited

Loading

bradenmacdonald commented Sep 28, 2024

bradenmacdonald Sep 28, 2024

ormsbee Sep 28, 2024 •

edited

Loading

bradenmacdonald Sep 28, 2024

bradenmacdonald commented Sep 29, 2024

ormsbee commented Sep 30, 2024

ormsbee commented Oct 15, 2024

		TODO: Like get_block, we currently assume that we're using the Draft
		version. This should be a runtime parameter.

XBlock asset support for new libraries experience (WIP) #35557

XBlock asset support for new libraries experience (WIP) #35557

Conversation

ormsbee commented Sep 27, 2024 • edited Loading

bradenmacdonald commented Sep 28, 2024

bradenmacdonald Sep 28, 2024

Choose a reason for hiding this comment

ormsbee Sep 28, 2024 • edited Loading

Choose a reason for hiding this comment

bradenmacdonald Sep 28, 2024

Choose a reason for hiding this comment

bradenmacdonald commented Sep 29, 2024

ormsbee commented Sep 30, 2024

ormsbee commented Oct 15, 2024

ormsbee commented Sep 27, 2024 •

edited

Loading

ormsbee Sep 28, 2024 •

edited

Loading