Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Make isNewHeaderEnabled a computed so that it's updated #1892

Merged
merged 2 commits into from
Oct 14, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 7, 2022

Fixes

Fixes #1891 by @obulat

Description

This PR makes isNewHeaderEnabled a computed so that it's updated when you check the new_header checkbox on the Preferences page.

Testing Instructions

Go to the Preferences page (http://localhost:8443/preferences) and check the new_header flag. You should see the header updated immediately (it should now have internal links).
You can also try the staging to see that the header there is not updated until you reload the page.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested a review from a team as a code owner October 7, 2022 13:43
@obulat obulat requested review from zackkrida and dhruvkb October 7, 2022 13:43
@github-actions
Copy link

github-actions bot commented Oct 7, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1892
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1892/tailwind

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@openverse-bot openverse-bot added 💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Oct 7, 2022
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

You'll need to add .value to its usages in the <script> section. I can't review those parts as they haven't changed.

@github-actions
Copy link

github-actions bot commented Oct 7, 2022

Size Change: -1.43 kB (0%)

Total Size: 814 kB

Filename Size Change
./.nuxt/dist/client/229.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/229.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/230.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 131 kB -665 B (-1%)
./.nuxt/dist/client/app.modern.js 123 kB -655 B (-1%)
./.nuxt/dist/client/pages/image/_id.js 5.26 kB -50 B (-1%)
./.nuxt/dist/client/runtime.js 2.66 kB -29 B (-1%)
./.nuxt/dist/client/runtime.modern.js 2.66 kB -29 B (-1%)
./.nuxt/dist/client/223.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/223.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/224.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 88.2 kB 0 B
./.nuxt/dist/client/commons/app.modern.js 77 kB 0 B
./.nuxt/dist/client/components/loading-icon.js 745 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 750 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 2.75 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.72 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.02 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.91 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 357 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 361 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.82 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.11 kB 0 B
./.nuxt/dist/client/components/v-audio-track.modern.js 5.06 kB 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 570 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 573 B 0 B
./.nuxt/dist/client/components/v-bone.js 685 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 690 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-content-link.js 1.11 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 467 B 0 B
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 779 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 784 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 4.43 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.24 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.98 kB 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 3.98 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 999 B 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 1 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.47 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.45 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 748 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 752 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./.nuxt/dist/client/components/v-external-search-form.js 3.11 kB 0 B
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.08 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.js 2.57 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.6 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell.js 1.43 kB 0 B
./.nuxt/dist/client/components/v-image-cell.modern.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-details.js 1.44 kB 0 B
./.nuxt/dist/client/components/v-image-details.modern.js 1.44 kB 0 B
./.nuxt/dist/client/components/v-image-grid.js 2.53 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB 0 B
./.nuxt/dist/client/components/v-license-tab-panel.js 522 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 526 B 0 B
./.nuxt/dist/client/components/v-load-more.js 788 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-media-license.js 799 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 805 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.63 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-media-tag.js 430 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-no-results.js 2.77 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.74 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.09 kB 0 B
./.nuxt/dist/client/components/v-related-images.modern.js 2.97 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 966 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.7 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 813 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.46 kB 0 B
./.nuxt/dist/client/components/v-search-grid.modern.js 5.41 kB 0 B
./.nuxt/dist/client/components/v-search-results-title.js 657 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 652 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 793 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.modern.js 769 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B -1 B (0%)
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 996 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 895 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 890 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 893 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.18 kB 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-sources-table.js 15.3 kB 0 B
./.nuxt/dist/client/components/v-sources-table.modern.js 15.3 kB 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B 0 B
./.nuxt/dist/client/pages/about.js 1.06 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.07 kB +1 B (0%)
./.nuxt/dist/client/pages/audio/_id.js 4.93 kB -3 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.76 kB 0 B
./.nuxt/dist/client/pages/external-sources.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.24 kB 0 B
./.nuxt/dist/client/pages/feedback.modern.js 1.24 kB 0 B
./.nuxt/dist/client/pages/image/_id.modern.js 7.24 kB -1 B (0%)
./.nuxt/dist/client/pages/index.js 5.05 kB 0 B
./.nuxt/dist/client/pages/index.modern.js 4.91 kB -2 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.54 kB +1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB -1 B (0%)
./.nuxt/dist/client/pages/search.js 2.75 kB -2 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.59 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.js 1.19 kB 0 B
./.nuxt/dist/client/pages/search/audio.modern.js 1.19 kB 0 B
./.nuxt/dist/client/pages/search/image.js 2.79 kB 0 B
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB +1 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.97 kB 0 B
./.nuxt/dist/client/pages/search/index.modern.js 2.93 kB +2 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 247 B +1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B +1 B (0%)
./.nuxt/dist/client/pages/search/video.js 239 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 244 B 0 B
./.nuxt/dist/client/pages/sources.js 1.44 kB -2 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB 0 B
./.nuxt/dist/client/vendors/app.js 57.2 kB 0 B
./.nuxt/dist/client/vendors/app.modern.js 56.3 kB 0 B

compressed-size-action

@zackkrida zackkrida requested a review from dhruvkb October 7, 2022 14:49
@zackkrida
Copy link
Member

@dhruvkb and @obulat do you think it would be more robust long-term to make the isOn method of the feature flag store return a computed value?

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

@obulat LGTM!

@zackkrida it could make sense to make the isOn be a computed property, but wouldn't components using it still need to put the value inside a computed call?

@dhruvkb
Copy link
Member

dhruvkb commented Oct 7, 2022

I just realised that this might break the "feature" that flags toggled using ff_ query params remain the same for the entire session.

@obulat
Copy link
Contributor Author

obulat commented Oct 7, 2022

I just realised that this might break the "feature" that flags toggled using ff_ query params remain the same for the entire session.

Which change might break the query param feature, @dhruvkb ? The one in this PR, or Zack's suggestion about returning a computed from isOn?

@dhruvkb
Copy link
Member

dhruvkb commented Oct 7, 2022

The one in this PR.

@obulat
Copy link
Contributor Author

obulat commented Oct 8, 2022

I just realised that this might break the "feature" that flags toggled using ff_ query params remain the same for the entire session.

What should the behavior be when you open the preferences and uncheck the checkbox that was previously set using a query param? 🤔
I can see two options here:

  • if a flag is set using a query param, it is set to a special state so that it becomes not switchable using the query param. The feature's Preferences page checkbox is set to 'disabled'.
  • the query param is NOT guaranteed to be used if the user uses the UI in the Preferences page to change it. So, you can go to the /preferences?ff_new_header=off and check the 'new_header' feature to set the flag to be On.

My personal preference would be the second option, but maybe it's because I can only see this used in the current situation, and not for the future feature flag. We wanted the query parameter for a flag feature to be able to show the feature to the stakeholders (e.g. on staging) without having them set up the app locally. It should be possible to revert the flag state using the UI in such a case.

I wonder if we should add the feature flags to the routing: if the flag is set, the query is always shown in the URL. This way, it will always be synced with the cookie state, and you would be able to update the flag value both on the preferences page, and by changing the query param.

@openverse-bot
Copy link
Contributor

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@zackkrida
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was updated 2 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

👍

@obulat obulat merged commit ef801f8 into main Oct 14, 2022
@obulat obulat deleted the fix/new_header_flag branch October 14, 2022 05:32
github-actions bot pushed a commit that referenced this pull request Oct 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Layout not updated because the new_header flag status is set once
4 participants