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

Add feature flag for fake marking results as sensitive #862

Merged
merged 4 commits into from
Mar 10, 2023
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Mar 8, 2023

Fixes

Fixes #854 by @zackkrida

Description

This PR adds a feature flag fake_sensitive to mark roughly half the results as mature. It uses a random (but deterministic) approach which allows results to be marked mature consistently and across Pinia stores and browsing sessions.

This PR makes no UI changes. It is limited in scope to just adding the feature flag and setting up its behaviour. UI changes are already necessitated by #791 so this PR does not put in effort that's destined to be repeated.

Testing Instructions

  1. Check out the PR and run the dev server.
  2. Enable the flag 'fake_sensitive' from /preferences.
  3. Search for somethine.
    • You will see the console logs printing Fake mature <uuid4> for ~50% of results.
    • This list should remain the same no matter how many times you refresh the page.
  4. Pick any ID out of this list and see the single result page for that ID.
    • You should get the Fake mature <uuid4> log again because it also works on the single media store.

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.

@openverse-bot openverse-bot added this to In progress in Openverse PRs Mar 8, 2023
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Mar 8, 2023
@github-actions
Copy link

github-actions bot commented Mar 8, 2023

Full-stack documentation: Ready

https://WordPress.github.io/openverse/_preview/862

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.

@WordPress WordPress deleted a comment from github-actions bot Mar 8, 2023
@dhruvkb dhruvkb marked this pull request as ready for review March 8, 2023 03:25
@dhruvkb dhruvkb requested a review from a team as a code owner March 8, 2023 03:25
@dhruvkb dhruvkb requested review from zackkrida and obulat March 8, 2023 03:25
@openverse-bot openverse-bot moved this from In progress to Needs review in Openverse PRs Mar 8, 2023
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.

This approach works perfectly. Awesome. Do you think it's worth creating a little utility function for the mature detection so the logic doesn't need to be updated in two places? Something like:

const fakeMature = (item) => {
  if (prng(hash(item.id))() < 0.5) return
  item.mature = true
  log("Fake mature", item.id)
}

I don't think it's necessary but something to consider.

I also tried this with some blurring, which was a fun way to test:

CleanShot 2023-03-08 at 08 31 45

@dhruvkb
Copy link
Member Author

dhruvkb commented Mar 8, 2023

Good point, I'll extract it to a separate utility 👍. Update: done in b57157d.

@dhruvkb dhruvkb mentioned this pull request Mar 8, 2023
7 tasks
@dhruvkb dhruvkb added the 🧱 stack: frontend Related to the Nuxt frontend label Mar 9, 2023
@@ -44,6 +44,8 @@ export interface Media {

tags: Tag[]
fields_matched?: string[]

mature: boolean
Copy link
Contributor

Choose a reason for hiding this comment

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

Wow, I didn't know we didn't have this in the type! Great catch! Is it always available, or should we mark it as optional?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's always available.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Really nice! I have a question about mature type inline, but don't want to block the PR.

Openverse PRs automation moved this from Needs review to Reviewer approved Mar 10, 2023
@dhruvkb dhruvkb merged commit 74da3d8 into main Mar 10, 2023
Openverse PRs automation moved this from Reviewer approved to Merged! Mar 10, 2023
@dhruvkb dhruvkb deleted the fake_sensitive branch March 10, 2023 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

Add non-production feature flag for marking half of results as sensitive
4 participants