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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade bramble to 0.1.29 #36710

Closed
wants to merge 9 commits into from
Closed

Upgrade bramble to 0.1.29 #36710

wants to merge 9 commits into from

Conversation

maddiedierker
Copy link
Contributor

@maddiedierker maddiedierker commented Sep 11, 2020

What's in this PR

As of writing this, the changes in this PR are available on this adhoc.

  • commit - Removes the @code-dot-org/bramble NPM package as a dependency. Now, we will only publish bramble to S3.
  • commit - Implements the new fileRefresh method from bramble (added in this commit). This is necessary when uploading a new image because images are managed outside of bramble, so we need to tell bramble to refresh the file tree UI after an image file is added to the tree.
  • commit - Define the bramble URL on the server and pass it to the client, so we only need to change the URL in one place (either when updating the version, or using "devmode" to connect to your local bramble server).

Follow-up Work

  • Revoke versions after 0.1.26 from @code-dot-org/bramble in NPM. Before removing this dependency, I attempted to upgrade it and mistakes were made 馃槄 I still have to decide how we'll deprecate or remove it from NPM's registry.
  • Write documentation for 1) publishing a new version of bramble, and 2) enabling/using "devmode" for bramble in code studio.

Links

Testing story

There are existing UI/eyes tests to make sure bramble loads when a user visits weblab. UI tests are still working as expected, and eyes tests will definitely need to be resolved.

Reviewer Checklist:

  • Tests provide adequate coverage
  • 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

@@ -345,6 +345,10 @@ function uploadAllFilesFromBramble(callback) {
});
}

function fileRefresh(callback) {
brambleProxy_.fileRefresh(callback);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

added fileRefresh to the bramble API in this commit

@maddiedierker maddiedierker requested a review from a team September 11, 2020 23:08
@maddiedierker maddiedierker changed the title Upgrade bramble Upgrade bramble to 0.1.29 Sep 11, 2020
@maddiedierker
Copy link
Contributor Author

closing this as i've broken this same work into two PRs -- #38374 and #38384

@maddiedierker maddiedierker deleted the upgrade-bramble branch April 28, 2021 15:02
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

1 participant