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

PROD-1880 update data use and data subject columns to use friendly names #4774

Conversation

lucanovera
Copy link
Contributor

@lucanovera lucanovera commented Apr 3, 2024

Description Of Changes

Display user friendly names for data use, categories and subjects in Data Map Report.

Code Changes

  • Add new useFidesLang hook with helper functions to display the user friendly names
  • Implement new hook in data reporting table
  • Added unit tests to test each helper function from the hook

Screenshots

Screen Shot 2024-04-03 at 11 29 51
Screen Shot 2024-04-03 at 11 30 06

Steps to Confirm

  • Navigate to Data Map > Reporting (Fides Plus Beta feature)
  • Check that user friendly names are displayed for Data Use, Categories and Subjects
  • Data use/category should display in bold if it's a top-level (eg. System Data )
  • Data use/category that have parents should display the top-level parent name in bold, colon, and then the name (eg. System Data: Authentication Data )

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Issue Requirements are Met
  • Update CHANGELOG.md

Copy link

vercel bot commented Apr 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
fides-plus-nightly ⬜️ Ignored (Inspect) Visit Preview Apr 5, 2024 1:05pm

…Data-Use-and-Data-Subject-Columns-to-use-friendly-names
Copy link

cypress bot commented Apr 3, 2024

Passing run #7061 ↗︎

0 4 0 0 Flakiness 0

Details:

Merge 28b4eeb into 18fd8b7...
Project: fides Commit: af0c128c4b ℹ️
Status: Passed Duration: 00:33 💡
Started: Apr 4, 2024 2:37 PM Ended: Apr 4, 2024 2:37 PM

Review all test suite changes for PR #4774 ↗︎

Copy link
Contributor Author

@lucanovera lucanovera left a comment

Choose a reason for hiding this comment

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

Leaving here some comments about the code.


import useFidesLang from "./useFidesLang";

describe("Fides Language Helper Hook", () => {
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 unit tests testing the new 3 helper function in the hook. I wanted to do unit tests since this hook will probably get re-used across the ui to display the user-friendly names.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice work on this, thank you!

@lucanovera lucanovera requested review from jpople and NevilleS April 3, 2024 14:52
@lucanovera lucanovera changed the title Prod 1880 update data use and data subject columns to use friendly names PROD-1880 update data use and data subject columns to use friendly names Apr 3, 2024
Copy link
Contributor

@jpople jpople left a comment

Choose a reason for hiding this comment

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

Great work on this! There are a lot of places in the UI that can be cleaned up to use the new hook for fetching display names, we do this kinda all over the place. I don't think it's worth doing as part of this ticket, but it's a good thing to keep in mind for future code cleanup. (Pointing it out here also for myself!)


import useFidesLang from "./useFidesLang";

describe("Fides Language Helper Hook", () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice work on this, thank you!

Lucano Vera added 2 commits April 5, 2024 10:04
…se-friendly-names' of github.com:ethyca/fides into PROD-1880-Update-Data-Use-and-Data-Subject-Columns-to-use-friendly-names
@lucanovera lucanovera merged commit 665b454 into main Apr 5, 2024
12 checks passed
@lucanovera lucanovera deleted the PROD-1880-Update-Data-Use-and-Data-Subject-Columns-to-use-friendly-names branch April 5, 2024 13:13
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.

2 participants