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

Remove @code-dot-org/bramble package, load bramble from S3 package #38374

Merged
merged 1 commit into from Jan 8, 2021

Conversation

maddiedierker
Copy link
Contributor

@maddiedierker maddiedierker commented Jan 5, 2021

This removes our @code-dot-org/bramble NPM package dependency. As far as I can tell, it was only used for loading require.min.js when loading WebLab:

%script{src: "/blockly/js/bramble/thirdparty/require.min.js", 'data-main': webpack_asset_path('js/brambleHost.js')}

However, we point to the S3 build when we instantiate Bramble:

url:
'//downloads.computinginthecore.org/bramble_0.1.26/index.html?disableExtensions=bramble-move-file',

This means WebLab actually uses the S3 build, not the NPM package, so I have removed the NPM package. I will need to do some follow-up work to indicate this in code-dot-org/bramble (there are currently no Code.org-specific instructions around how to publish/consume a new version of Bramble, so I've added them here).

These changes were previously part of #36710 (general "upgrade Bramble" PR), but I realized that this change can and should ship on its own to make sure there are no regressions prior to upgrading.

I also did some clean-up around "dev mode" because you had to comment/un-comment like 4 different things in different spots before. Now, if you set @dev_mode to true in WeblabHostController, everything will point to your local Bramble server.

Links

  • STAR-1261, which encapsulates shipping the Bramble upgrade.

Testing story

Relies on existing UI tests, which make sure that Bramble loads properly.

Reviewer Checklist:

  • Tests provide adequate coverage
  • Privacy and Security impacts have been assessed
  • Code is well-commented
  • New features are translatable or updates will not break translations
  • Relevant documentation has been added or updated
  • User impact is well-understood and desirable
  • Pull Request is labeled appropriately
  • Follow-up work items (including potential tech debt) are tracked and linked

@maddiedierker maddiedierker requested a review from a team January 5, 2021 00:57
@maddiedierker maddiedierker merged commit 2a086cd into staging Jan 8, 2021
@maddiedierker maddiedierker deleted the remove-bramble-npm branch January 8, 2021 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants