[ENH] Implemented upload data dictionary component

[rmanaem]

• Closes Upload data dictionary component ui #39
• Closes Re-uploading data dictionary and updating the store #41

Checklist

This section is for the PR reviewer

• PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
• PR has a label for the release changelog or skip-release (to be applied by maintainers only)
• PR links to GitHub issue with mention Closes #XXXX
• Tests pass
• Checks pass

For new features:

• Tests have been added

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Implements a data dictionary upload feature, allowing users to upload a JSON file to provide metadata descriptions for data table columns. The file uploader component is enhanced with disabled state and tooltip support. This pull request closes issues #39 and #41.

New Features:

• Introduces a data dictionary upload component to allow users to upload a JSON file containing metadata descriptions for the columns in the data table.
• Adds a tooltip to the file uploader to indicate when uploading is disabled and why.

Enhancements:

• Updates the file uploader component to support disabling the upload functionality and displaying a tooltip when disabled.
• Improves the visual appearance of the file uploader component, including changes to colors and cursor styles.

Build:

• Adds ramda and @microlink/react-json-view as project dependencies.

Chores:

• Adds mock data for data dictionary and updated columns for testing purposes.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces the ability to upload a data dictionary file to enhance column descriptions, and enhances the FileUploader component with a disabled state and tooltip. The data dictionary upload functionality allows users to provide a JSON file that maps column headers to descriptions, which are then used to update the column metadata in the application. The FileUploader component was updated to allow disabling the upload functionality and providing a tooltip explaining why it is disabled.

Sequence diagram for uploading a data dictionary file

sequenceDiagram
  participant User
  participant UploadCard
  participant FileUploader
  participant DataStore

  User->>UploadCard: Clicks to upload data dictionary
  UploadCard->>FileUploader: handleClickToUpload()
  FileUploader->>User: Selects a .json file
  User->>FileUploader: Chooses file
  FileUploader->>FileUploader: handleFileUpload(event)
  FileUploader->>UploadCard: onFileUpload(file)
  UploadCard->>DataStore: processDataDictionaryFile(file)
  DataStore->>DataStore: Reads file content
  DataStore->>DataStore: Parses JSON to DataDictionary
  DataStore->>DataStore: Updates columns with descriptions
  DataStore->>DataStore: setUploadedDataDictionaryFileName(fileName)
  DataStore->>DataStore: setDataDictionary(dataDictionary)
  DataStore-->>UploadCard: Resolves promise
  UploadCard-->>User: Updates UI with preview

Loading

Updated class diagram for FileUploader component

classDiagram
  class FileUploader {
    +displayText: string
    +handleClickToUpload: () => void
    +handleDrop: (event: React.DragEvent<HTMLDivElement>) => void
    +handleDragOver: (event: React.DragEvent<HTMLDivElement>) => void
    +handleFileUpload: (event: React.ChangeEvent<HTMLInputElement>) => void
    +fileInputRef: React.RefObject<HTMLInputElement>
    +allowedFileType: string
    +disabled?: boolean
    +tooltipContent?: string
  }
  note for FileUploader "Added 'disabled' and 'tooltipContent' properties"

Loading

Updated class diagram for DataStore

classDiagram
  class DataStore {
    +dataTable: DataTable
    +columns: Columns
    +uploadedDataDictionary: DataDictionary
    +uploadedDataTableFileName: string | null
    +uploadedDataDictionaryFileName: string | null
    +setDataTable: (data: DataTable) => void
    +initializeColumns: (data: Columns) => void
    +setDataDictionary: (data: DataDictionary) => void
    +setUploadedDataTableFileName: (fileName: string | null) => void
    +setUploadedDataDictionaryFileName: (fileName: string | null) => void
    +processDataTableFile: (file: File) => Promise<void>
    +processDataDictionaryFile: (file: File) => Promise<void>
  }
  note for DataStore "Added data dictionary related properties and methods"

Loading

File-Level Changes

Change	Details	Files
Added a disabled prop and tooltipContent prop to the FileUploader component to control its interactive state and provide contextual help.	Added disabled and tooltipContent props to the FileUploader component's props interface. Modified the component's logic to disable click, drag, and drop functionalities when disabled is true. Added a Tooltip component to display tooltipContent when the FileUploader is disabled. Updated the styling to reflect the disabled state, including cursor, border, and background color changes. Added default values for the disabled and tooltipContent props.	src/components/FileUploader.tsx
Implemented data dictionary upload and processing functionality.	Added uploadedDataDictionary and uploadedDataDictionaryFileName to the data store. Added setDataDictionary and setUploadedDataDictionaryFileName actions to the data store. Implemented processDataDictionaryFile to read and parse the data dictionary file, then update the column descriptions in the data store. Added a new UploadCard component for uploading the data dictionary. Added a new DataDictionaryPreview component to display the uploaded data dictionary. Added logic to disable the data dictionary file uploader if a data table hasn't been uploaded yet. Added mock data for data dictionary and updated columns. Added DataDictionary type definition.	src/stores/data.ts src/utils/mocks.ts src/utils/types.ts src/components/Upload.tsx src/components/UploadCard.tsx src/components/DataDictionaryPreview.tsx
Added component tests for the FileUploader and UploadCard components.	Added a test case to verify the disabled state of the FileUploader component. Added a test case to verify the rendering of the FileUploaderDisplayText prop in the UploadCard component.	cypress/component/UploadCard.cy.tsx cypress/component/FileUploader.cy.tsx

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#39	Implement the ability to upload a .json file.	✅
#39	Implement a preview of the uploaded file, with a collapsable option.	✅
#39	Implement a test for the new component.	✅
#41	Update the state with the content of the re-uploaded data dictionary file, specifically updating the 'column' object in the state.	✅
#41	Implement unit tests for the state actions related to data dictionary re-uploading.	❌	The PR does not include any unit tests.

Possibly linked issues

• Upload data dictionary component ui #39: The PR implements the UI component described in the issue, but also adds data handling logic and updates tests, mocks, and types.
• Upload data dictionary component ui #39: The PR implements the data dictionary upload component, which addresses part of the issue by enabling re-uploading.
• Upload data dictionary component ui #39: The PR implements the upload component, which is necessary for the data dictionary upload feature requested in the issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[netlify]

✅ Deploy Preview for staging-annotation ready!

Name	Link
🔨 Latest commit	b60a488
🔍 Latest deploy log	https://app.netlify.com/sites/staging-annotation/deploys/67be0855aa39a50008466da7
😎 Deploy Preview	https://deploy-preview-50--staging-annotation.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

Attention: Patch coverage is 81.60920% with 16 lines in your changes missing coverage. Please review.

Project coverage is 81.77%. Comparing base (d970022) to head (b60a488).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/components/CustomDataDictionaryPreview.tsx	73.07%	7 Missing ⚠️
src/stores/data.ts	80.00%	5 Missing ⚠️
src/components/Upload.tsx	76.92%	3 Missing ⚠️
src/components/DataDictionaryPreview.tsx	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #50      +/-   ##
==========================================
+ Coverage   81.11%   81.77%   +0.65%     
==========================================
  Files          18       20       +2     
  Lines         143      225      +82     
  Branches       23       46      +23     
==========================================
+ Hits          116      184      +68     
- Misses         27       41      +14     

Flag	Coverage Δ
tests	81.77% <81.60%> (+0.65%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[surchs]

Hey @rmanaem, thanks a lot for the PR! The UI looks really very nice, and the functionality is great. My comments are mainly about the structure of the components and readability. I think now is the best time to set the theme for keeping things clean and easy to understand, it'll only get more complex from here.

So I left comments in a couple of places where I currently find it tricky to follow the component. the main issue is, as they say, debugging is twice as hard as writing code - so if we barely get it while we write it / it's fresh, then we won't get it when it breaks....

Take a look

[surchs]

Thanks @rmanaem, this looks great!

🧑‍🍳