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

release-23.2: ui: add static images to asset build step #122704

Merged
merged 1 commit into from
Jun 3, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Apr 19, 2024

Backport 1/1 commits from #121380 on behalf of @dhartunian.

/cc @cockroachdb/release


During the genassets build + embed step, we were taking just the output of the db-console-ccl or db-console-oss step which is just a build.js file. This commit adds references to the image assets we want bundled as well. This includes favicon.ico and everything in ./ assets relative to the db-console build directory.

We disable content hashing in webpack in order to keep the filenames static, which bazel requires. The impact should be minimal as we rarely change these images so if they're cached forever, it's fine.

This change restores the favicon to the CRDB build and the nice image that shows up in the background of the email signup bar.

The size of the final zipped bundle only differs by around 1MB and is already 10MB in size.

Fixes: #117876
Epic: None

Release note (ui change): the favicon now renders properly for DB Console along with other image files.


Release justification: low-risk high impact change to ui

@blathers-crl blathers-crl bot requested a review from a team April 19, 2024 18:22
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.2-121380 branch from 867ee12 to e418e73 Compare April 19, 2024 18:22
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Apr 19, 2024
Copy link
Author

blathers-crl bot commented Apr 19, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL and one additional
    TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Apr 19, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

During the `genassets` build + embed step, we were taking just the
output of the `db-console-ccl` or `db-console-oss` step which is just
a build.js file. This commit adds references to the image assets we
want bundled as well. This includes favicon.ico and everything in `./
assets` relative to the db-console build directory.

We disable content hashing in webpack in order to keep the filenames
static, which bazel requires. The impact should be minimal as we
rarely change these images so if they're cached forever, it's fine.

This change restores the favicon to the CRDB build and the nice image
that shows up in the background of the email signup bar.

The size of the final zipped bundle only differs by around 1MB and is
already 10MB in size.

Fixes: #117876
Epic: None

Release note (ui change): the favicon now renders properly for DB
Console along with other image files.
@dhartunian dhartunian force-pushed the blathers/backport-release-23.2-121380 branch from e418e73 to 5cb2446 Compare May 30, 2024 18:53
@dhartunian
Copy link
Collaborator

Tested local build:

Screenshot 2024-05-30 at 18 07 05

@dhartunian dhartunian merged commit c479fe4 into release-23.2 Jun 3, 2024
5 of 6 checks passed
@dhartunian dhartunian deleted the blathers/backport-release-23.2-121380 branch June 3, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants