[2/3] build: include built-in XBlock JS directly rather than copying it

[kdmccormick]

Part of a series of PRs:

• Stop dynamically generating XModule JS #32481

The previous one is:

• [1/3] refactor: remove XModule JS from Django Pipeline #32530

The next one is:

• [3/3] build: commit builtinblocks Webpack config and stub out xmodule_assets  #32685

To review this PR, look at just the latest commit (the one matching the PR title).

Description and supporting info

As part of the static asset build, JS modules for most built-in XBlocks were unnecessarily copied from the original locations (under xmodule/js and common/static/js) to a git-ignored location (under common/static/xmodule), and then included into the Webpack builld via common/static/xmodule/webpack.xmodule.config.js.

With this commit, we stop copying the JS modules. Instead, we have common/static/xmodule/webpack.xmodule.config.js just reference the original source under xmodule/js and common/static/js.

This lets us us radically simplify the xmodule/static_content.py build script. It also sets the stage for the next change, in which we will check webpack.xmodule.config.js into the repository, and delete xmodule/static_content.py entirely.

common/static/xmodule/webpack.xmodule.config.js before:

module.exports = {
    "entry": {
        "AboutBlockDisplay": [
            "./common/static/xmodule/modules/js/000-b82f6c436159f6bc7ca2513e29e82503.js",
            "./common/static/xmodule/modules/js/001-3ed86006526f75d6c844739193a84c11.js",
            "./common/static/xmodule/modules/js/002-3918b2d4f383c04fed8227cc9f523d6e.js",
            "./common/static/xmodule/modules/js/003-b3206f2283964743c4772b9d72c67d64.js",
            "./common/static/xmodule/modules/js/004-274b8109ca3426c2a6fde9ec2c56e969.js",
            "./common/static/xmodule/modules/js/005-26caba6f71877f63a7dd4f6796109bf6.js"
        ],
        "AboutBlockEditor": [
            "./common/static/xmodule/descriptors/js/000-b82f6c436159f6bc7ca2513e29e82503.js",
            "./common/static/xmodule/descriptors/js/001-19c4723cecaa5a5a46b8566b3544e732.js"
        ],
        // etc
    }
};

common/static/xmodule/webpack.xmodule.config.js after:

module.exports = {
    "entry": {
        "AboutBlockDisplay": [
            "./xmodule/js/src/xmodule.js",
            "./xmodule/js/src/html/display.js",
            "./xmodule/js/src/javascript_loader.js",
            "./xmodule/js/src/collapsible.js",
            "./xmodule/js/src/html/imageModal.js",
            "./xmodule/js/common_static/js/vendor/draggabilly.js"
        ],
        "AboutBlockEditor": [
            "./xmodule/js/src/xmodule.js",
            "./xmodule/js/src/html/edit.js"
        ],
        // etc
    }
};

Testing

I recommend building assets with this branch and smoke-testing the built-in XBlocks.

You can build assets and start the platform with Tutor Nightly:

tutor local stop
tutor config save --set EDX_PLATFORM_REPOSITORY=https://github.com/kdmccormick/edx-platform
tutor config save --set EDX_PLATFORM_VERSION=kdmccormick/xmodule-js-no-copy
tutor images build openedx
tutor local start -d

or do it standalone (I haven't tried this):

paver update_assets
./manage.py lms runserver
./manage.py cms runserver

Go into the demo course and try out a few built-in XBlocks. Affected XBlocks include:

• Sequentials aka subsections
• any Text aka HTML
• static tabs
• Video
• any Problem
• Annotatable
• Conditional
• Randomized Content aka library_content_block
• Poll (old)
• LTI (old)
• WordCloud

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

[edx-pipeline-bot]

2U Release Notice: This PR has been deployed to the edX production environment.