Allow feature flags to use `sessionStorage` and ignore `ff_` query params #2121

dhruvkb · 2023-05-17T07:43:31Z

Description

This PR is a PoC for #2118 that demonstrates feature flags that can be backed by session-storage. It also allows feature flags to ignore ff_ query params when reading from them can open the possibility for malicious activity.

Testing Instructions

Session storage

Check out the PR and run the dev server.
Visit /preferences.
Flip the fetch_sensitive flag to on.
Navigate around the site and come back to /preferences.
See that the flag is still on.
Close the tab and open a new one.
Visit /preferences.
See that the flag is off now.

No `ff_` query

Check out the PR and run the dev server.
Visit /preferences. Ensure sensitive_content and fetch_sensitive are both off.
Visit /preferences?ff_sensitive_content=on. See that the switch is flipped on.
Visit /preferences?ff_fetch_sensitive=on. See that the switch is still off.

Checklist

My pull request has a descriptive title (not a vague title likeUpdate 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.
I ran the DAG documentation generator (if applicable).

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.

github-actions · 2023-05-17T07:51:03Z

Size Change: +794 B (0%)

Total Size: 834 kB

Filename	Size	Change
`./frontend/.nuxt/dist/client/app.js`	127 kB	+286 B (0%)
`./frontend/.nuxt/dist/client/app.modern.js`	118 kB	+264 B (0%)
`./frontend/.nuxt/dist/client/vendors/app.js`	64.6 kB	+13 B (0%)
`./frontend/.nuxt/dist/client/vendors/app.modern.js`	63.9 kB	+216 B (0%)

ℹ️ View Unchanged

Filename	Size	Change
`./frontend/.nuxt/dist/client/233.js`	272 B	0 B
`./frontend/.nuxt/dist/client/233.modern.js`	277 B	0 B
`./frontend/.nuxt/dist/client/234.js`	1.85 kB	0 B
`./frontend/.nuxt/dist/client/commons/app.js`	90.4 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/commons/app.modern.js`	78.5 kB	+4 B (0%)
`./frontend/.nuxt/dist/client/components/loading-icon.js`	766 B	0 B
`./frontend/.nuxt/dist/client/components/loading-icon.modern.js`	769 B	0 B
`./frontend/.nuxt/dist/client/components/table-sort-icon.js`	514 B	0 B
`./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js`	519 B	0 B
`./frontend/.nuxt/dist/client/components/v-all-results-grid.js`	5.75 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js`	5.62 kB	0 B
`./frontend/.nuxt/dist/client/components/v-audio-cell.js`	392 B	0 B
`./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js`	396 B	0 B
`./frontend/.nuxt/dist/client/components/v-audio-details.js`	2.35 kB	0 B
`./frontend/.nuxt/dist/client/components/v-audio-details.modern.js`	1.77 kB	0 B
`./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js`	1.01 kB	0 B
`./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js`	1.02 kB	0 B
`./frontend/.nuxt/dist/client/components/v-audio-track.js`	5.26 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-audio-track.modern.js`	5.21 kB	0 B
`./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js`	636 B	0 B
`./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js`	642 B	0 B
`./frontend/.nuxt/dist/client/components/v-bone.js`	688 B	0 B
`./frontend/.nuxt/dist/client/components/v-bone.modern.js`	692 B	0 B
`./frontend/.nuxt/dist/client/components/v-box-layout.js`	1.28 kB	0 B
`./frontend/.nuxt/dist/client/components/v-box-layout.modern.js`	1.27 kB	0 B
`./frontend/.nuxt/dist/client/components/v-content-link.js`	1.04 kB	0 B
`./frontend/.nuxt/dist/client/components/v-content-link.modern.js`	1.04 kB	0 B
`./frontend/.nuxt/dist/client/components/v-content-page.js`	524 B	0 B
`./frontend/.nuxt/dist/client/components/v-content-page.modern.js`	528 B	0 B
`./frontend/.nuxt/dist/client/components/v-content-report-button.js`	493 B	0 B
`./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js`	497 B	0 B
`./frontend/.nuxt/dist/client/components/v-content-report-form.js`	3.86 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js`	3.69 kB	0 B
`./frontend/.nuxt/dist/client/components/v-content-report-popover.js`	914 B	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js`	4.15 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-copy-button.js`	4 kB	0 B
`./frontend/.nuxt/dist/client/components/v-copy-button.modern.js`	4 kB	0 B
`./frontend/.nuxt/dist/client/components/v-copy-license.js`	2.09 kB	0 B
`./frontend/.nuxt/dist/client/components/v-copy-license.modern.js`	2.06 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-dmca-notice.js`	791 B	0 B
`./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js`	799 B	0 B
`./frontend/.nuxt/dist/client/components/v-error-image.js`	2.6 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-error-image.modern.js`	2.57 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-error-section.js`	372 B	0 B
`./frontend/.nuxt/dist/client/components/v-error-section.modern.js`	375 B	0 B
`./frontend/.nuxt/dist/client/components/v-external-search-form.js`	1.88 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js`	1.87 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-external-source-list.js`	893 B	0 B
`./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js`	897 B	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-full-layout.js`	1.56 kB	0 B
`./frontend/.nuxt/dist/client/components/v-full-layout.modern.js`	1.55 kB	0 B
`./frontend/.nuxt/dist/client/components/v-grid-skeleton.js`	1.61 kB	0 B
`./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js`	1.62 kB	0 B
`./frontend/.nuxt/dist/client/components/v-home-gallery.js`	4.92 kB	0 B
`./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js`	4.9 kB	0 B
`./frontend/.nuxt/dist/client/components/v-homepage-content.js`	1.77 kB	0 B
`./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js`	1.74 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-carousel.js`	4.74 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js`	4.7 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-cell.js`	1.68 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-cell.modern.js`	1.67 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-details.js`	1.96 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-image-details.modern.js`	1.41 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-grid.js`	3.91 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-image-grid.modern.js`	3.79 kB	0 B
`./frontend/.nuxt/dist/client/components/v-license-tab-panel.js`	641 B	0 B
`./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js`	649 B	0 B
`./frontend/.nuxt/dist/client/components/v-load-more.js`	846 B	+2 B (0%)
`./frontend/.nuxt/dist/client/components/v-load-more.modern.js`	740 B	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-media-license.js`	828 B	0 B
`./frontend/.nuxt/dist/client/components/v-media-license.modern.js`	836 B	0 B
`./frontend/.nuxt/dist/client/components/v-media-reuse.js`	2.69 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js`	2.65 kB	0 B
`./frontend/.nuxt/dist/client/components/v-media-tag.js`	416 B	0 B
`./frontend/.nuxt/dist/client/components/v-media-tag.modern.js`	421 B	0 B
`./frontend/.nuxt/dist/client/components/v-modal.js`	1.01 kB	0 B
`./frontend/.nuxt/dist/client/components/v-modal.modern.js`	995 B	0 B
`./frontend/.nuxt/dist/client/components/v-no-results.js`	814 B	0 B
`./frontend/.nuxt/dist/client/components/v-no-results.modern.js`	816 B	0 B
`./frontend/.nuxt/dist/client/components/v-radio.js`	1.54 kB	0 B
`./frontend/.nuxt/dist/client/components/v-radio.modern.js`	1.5 kB	0 B
`./frontend/.nuxt/dist/client/components/v-related-audio.js`	1.29 kB	0 B
`./frontend/.nuxt/dist/client/components/v-related-audio.modern.js`	1.29 kB	0 B
`./frontend/.nuxt/dist/client/components/v-related-images.js`	1.1 kB	0 B
`./frontend/.nuxt/dist/client/components/v-related-images.modern.js`	1.1 kB	0 B
`./frontend/.nuxt/dist/client/components/v-report-desc-form.js`	977 B	0 B
`./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js`	979 B	0 B
`./frontend/.nuxt/dist/client/components/v-row-layout.js`	1.68 kB	0 B
`./frontend/.nuxt/dist/client/components/v-row-layout.modern.js`	1.68 kB	0 B
`./frontend/.nuxt/dist/client/components/v-scroll-button.js`	824 B	0 B
`./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js`	829 B	0 B
`./frontend/.nuxt/dist/client/components/v-search-grid.js`	6.55 kB	0 B
`./frontend/.nuxt/dist/client/components/v-search-grid.modern.js`	6.47 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-search-results-title.js`	618 B	0 B
`./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js`	622 B	0 B
`./frontend/.nuxt/dist/client/components/v-server-timeout.js`	299 B	0 B
`./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js`	303 B	0 B
`./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js`	1.01 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js`	912 B	0 B
`./frontend/.nuxt/dist/client/components/v-snackbar.js`	1.16 kB	0 B
`./frontend/.nuxt/dist/client/components/v-snackbar.modern.js`	1.17 kB	0 B
`./frontend/.nuxt/dist/client/components/v-sources-table.js`	15.2 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-sources-table.modern.js`	15.2 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-warning-suppressor.js`	306 B	0 B
`./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js`	311 B	0 B
`./frontend/.nuxt/dist/client/pages/about.js`	1.39 kB	0 B
`./frontend/.nuxt/dist/client/pages/about.modern.js`	1.4 kB	0 B
`./frontend/.nuxt/dist/client/pages/audio/_id/index.js`	6.52 kB	0 B
`./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js`	5.9 kB	0 B
`./frontend/.nuxt/dist/client/pages/external-sources.js`	1.55 kB	0 B
`./frontend/.nuxt/dist/client/pages/external-sources.modern.js`	1.56 kB	0 B
`./frontend/.nuxt/dist/client/pages/feedback.js`	1.34 kB	0 B
`./frontend/.nuxt/dist/client/pages/feedback.modern.js`	1.34 kB	0 B
`./frontend/.nuxt/dist/client/pages/image/_id/index.js`	7.46 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js`	6.77 kB	0 B
`./frontend/.nuxt/dist/client/pages/image/_id/report.js`	2.23 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js`	5.21 kB	0 B
`./frontend/.nuxt/dist/client/pages/index.js`	7.03 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/index.modern.js`	6.96 kB	0 B
`./frontend/.nuxt/dist/client/pages/preferences.js`	1.3 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/preferences.modern.js`	1.3 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/privacy.js`	1.23 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/privacy.modern.js`	1.24 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/pages/search-help.js`	1.59 kB	0 B
`./frontend/.nuxt/dist/client/pages/search-help.modern.js`	1.58 kB	0 B
`./frontend/.nuxt/dist/client/pages/search.js`	2.2 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/search.modern.js`	2.04 kB	0 B
`./frontend/.nuxt/dist/client/pages/search/audio.js`	3.69 kB	0 B
`./frontend/.nuxt/dist/client/pages/search/audio.modern.js`	3.58 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/search/image.js`	545 B	0 B
`./frontend/.nuxt/dist/client/pages/search/image.modern.js`	550 B	0 B
`./frontend/.nuxt/dist/client/pages/search/index.js`	443 B	0 B
`./frontend/.nuxt/dist/client/pages/search/index.modern.js`	446 B	0 B
`./frontend/.nuxt/dist/client/pages/search/model-3d.js`	243 B	0 B
`./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js`	246 B	0 B
`./frontend/.nuxt/dist/client/pages/search/search-page.types.js`	266 B	0 B
`./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js`	271 B	0 B
`./frontend/.nuxt/dist/client/pages/search/video.js`	240 B	0 B
`./frontend/.nuxt/dist/client/pages/search/video.modern.js`	243 B	0 B
`./frontend/.nuxt/dist/client/pages/sources.js`	1.51 kB	0 B
`./frontend/.nuxt/dist/client/pages/sources.modern.js`	1.51 kB	0 B
`./frontend/.nuxt/dist/client/runtime.js`	2.69 kB	0 B
`./frontend/.nuxt/dist/client/runtime.modern.js`	2.69 kB	0 B

_{compressed-size-action}

github-actions · 2023-05-17T07:53:49Z

Full-stack documentation: https://docs.openverse.org/_preview/2121

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.

zackkrida

This is working great with all the flags that have a storage key set in feature-flags.json. With fake_sensitive, there's some really weird behavior where it seems the key is being saved to session storage and cookie storage!

dhruvkb · 2023-05-18T07:11:17Z

@zackkrida I believe you've misread and gotten fake_sensitive (the pre-existing feature flag that marks 50% of results as mature, stored in the cookie) confused with fetch_sensitive (the new preference for loading sensitive results that appears in the search sidebar, stored in sessionStorage).

I'm happy to update the names to be more distinct if you have any ideas.

zackkrida

Sorry for the time-wasting fake/fetch nonsense 😭 this is working perfectly!

AetherUnbound

I went through all the testing steps and it performed as expected! And the code generally makes sense to me too 😄

…_improv

dhruvkb added 6 commits May 17, 2023 10:39

Add session storage support to feature flags

c43319e

Allow feature flags to refuse ff_ query params

00deacb

Initialise session-based feature-flags on client load

53d39f4

Add feature flags for sensitive results fetching and blurring

7569cc8

Update tests

fc90c88

Document new feature flag features

5651163

dhruvkb requested review from a team as code owners May 17, 2023 07:43

dhruvkb requested review from krysal, sarayourfriend and AetherUnbound May 17, 2023 07:43

dhruvkb mentioned this pull request May 17, 2023

Implementation plan: Blurring sensitive content in the frontend #2118

Merged

8 tasks

zackkrida requested changes May 17, 2023

View reviewed changes

dhruvkb added a commit that referenced this pull request May 18, 2023

Update the flag name to match #2121

e1ed200

zackkrida self-requested a review May 18, 2023 13:15

zackkrida approved these changes May 18, 2023

View reviewed changes

AetherUnbound approved these changes May 19, 2023

View reviewed changes

Merge branch 'main' of https://github.com/WordPress/openverse into ff…

8be7510

…_improv

dhruvkb merged commit 937baed into main May 19, 2023

dhruvkb deleted the ff_improv branch May 19, 2023 07:29

dhruvkb mentioned this pull request Aug 29, 2023

Enabling fetching sensitive results when the UI switch is toggled #2880

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow feature flags to use `sessionStorage` and ignore `ff_` query params #2121

Allow feature flags to use `sessionStorage` and ignore `ff_` query params #2121

dhruvkb commented May 17, 2023

github-actions bot commented May 17, 2023 •

edited

Loading

github-actions bot commented May 17, 2023

zackkrida left a comment

dhruvkb commented May 18, 2023 •

edited

Loading

zackkrida left a comment

AetherUnbound left a comment

Allow feature flags to use sessionStorage and ignore ff_ query params #2121

Allow feature flags to use sessionStorage and ignore ff_ query params #2121

Conversation

dhruvkb commented May 17, 2023

Description

Testing Instructions

Session storage

No ff_ query

Checklist

Developer Certificate of Origin

github-actions bot commented May 17, 2023 • edited Loading

github-actions bot commented May 17, 2023

zackkrida left a comment

Choose a reason for hiding this comment

dhruvkb commented May 18, 2023 • edited Loading

zackkrida left a comment

Choose a reason for hiding this comment

AetherUnbound left a comment

Choose a reason for hiding this comment

Allow feature flags to use `sessionStorage` and ignore `ff_` query params #2121

Allow feature flags to use `sessionStorage` and ignore `ff_` query params #2121

No `ff_` query

github-actions bot commented May 17, 2023 •

edited

Loading

dhruvkb commented May 18, 2023 •

edited

Loading