Skip to content

Refactor Document Access Feature (Client and ServerSide) #261

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

Merged
merged 32 commits into from
May 11, 2025

Conversation

parwatcodes
Copy link
Member

@parwatcodes parwatcodes commented Apr 5, 2025

This PR Fixes

This Pull Request will cover the refactor of document access feature:

  • Database tables and Directory naming convention changed as requested.
  • Integrated API calls using hooks
  • Store user required fields in visitorFields and dynamic display fields in the form
  • Support for any additional user meta data needed in a table field visitorMetaData
  • Integrate hook to upload document and invalidate query which removed explicit url reload to fetch latest documents once a upload is done
  • Add constraint to make sure link alias is unique as per a single user only. The below Query will support adding alias with more and one empty and null values but not any scalar values. We need to create a migration and run this query.
-- DropIndex
DROP INDEX "DocumentLink_createdByUserId_alias_key";

-- This allows multiple NULL aliases,
-- but enforces uniqueness on alias per createdByUserId if alias is not null
CREATE UNIQUE INDEX unique_alias_per_user
ON "DocumentLink"("createdByUserId", "alias")
WHERE alias IS NOT NULL AND alias <> '';

To look the UI Changes please go through this merged PR created by @SepidehShahbazi

Overhauling CreateLink modal and SendingAccordion, and adding React Query

Copy link

coderabbitai bot commented Apr 5, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@parwatcodes parwatcodes added Refactor Code Improvement Backend Backend Related Issue Frontend Frontend Related Issue 🔥Critical Must be addressed immediately; blocking core functionality or major bug labels Apr 5, 2025
@parwatcodes parwatcodes self-assigned this Apr 5, 2025
@parwatcodes parwatcodes requested review from mahid797 and SepidehShahbazi and removed request for mahid797 April 5, 2025 20:44
Copy link
Contributor

@SepidehShahbazi SepidehShahbazi 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!
I just wanted to mention that on the document page, we're encountering a server error (500) related to displaying documents in the table. As a result, we can't upload documents, and there's an error associated with that as well.
Also, since the name of the link has been changed to documentLink in the Schema file, it might be better to update the corresponding name like linkId in shared/models/linkModels.ts to match that for consistency in the future.

mahid797 added 2 commits May 6, 2025 07:23
### ✅ Changes Made

- Added a Prisma constraint to ensure each `alias` is unique **per
`documentId`**, using `@@unique([documentId, alias])`.
- In `SharingOptionsAccordion`, updated `Select` to store values by
`key` and display user-friendly `label` values (e.g., "Name" instead of
"name").
- Refactored `useCreateLink` to return `{ mutateAsync, isPending, error
}` for cleaner integration in components.
- Refactored `CreateLink.useFormSubmission` to properly handle mutation
state and fix loading state & error handling.
- Fixed a bug in `VisitorInfoModal` reported in **`Error.pdf` Bug
#*2***, where untouched required fields were not validated on first
submit.
- Added validation to block submission until all required fields are
filled.
- Integrated loading state to disable the Confirm button during
submission.

---

### 📝 Notes

- The validation in `VisitorInfoModal` is a temporary fix. A full
refactor using `Zod` is planned.
- Alias uniqueness is now scoped per document rather than globally.
Copy link
Collaborator

@mahid797 mahid797 left a comment

Choose a reason for hiding this comment

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

👍🏼

@mahid797 mahid797 merged commit 3b21de6 into dev May 11, 2025
2 checks passed
dev-datahall added a commit to dev-datahall/datahall-prod that referenced this pull request May 12, 2025
* Prod Deployment (bluewave-labs#250)

Update Master Branch with the latest Release

---------

Co-authored-by: Mahid Ahmad <[email protected]>
Co-authored-by: Sepideh Shahbazi <[email protected]>
Co-authored-by: Parwat Kunwar <[email protected]>

* Creating password form modal and improving profile form (bluewave-labs#253)

This closes bluewave-labs#251.

**Implemented:**

1. Provided Edit Mode for Profile form.
2. Added "Change password" button in the Profile form.
3. Removed profile and password tab section.
4. Removed Avatar Upload UI temporarily in the Profile form.
5. Created a new PasswordFormModal.tsx file and replaced it with
PasswordForm.tsx.
6. Ensured UI Consistency & Responsiveness.


**UI changes:**

**Profile form:**

<img width="709" alt="ProfileForm3"
src="https://github.com/user-attachments/assets/4e3e159b-67f7-457e-a4e8-bc5056abc794"
/>

<img width="698" alt="ProfileForm4"
src="https://github.com/user-attachments/assets/f716b98b-5cfd-4dc3-b824-08ac8b33fc81"
/>


**Password form modal:**

<img width="535" alt="PasswordFormModal2"
src="https://github.com/user-attachments/assets/ca56963b-30c5-4d76-85bb-3e9b147c7222"
/>



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Introduced an enhanced profile editing mode that lets users toggle
between view and edit states with dynamic controls, including dedicated
buttons for editing, saving, and canceling changes.
- Implemented a new password update modal that offers a streamlined,
validated password change experience when editing profile details.

- **Bug Fixes**
- Removed the previous password change form to eliminate confusion and
improve user navigation.

- **Refactor**
- Consolidated profile management by removing the previous inline
password change form and tabbed interface, resulting in a simplified,
unified user experience.
- Updated the profile page to utilize the new profile form component,
enhancing overall functionality.

- **Style**
- Enhanced button styling by updating font sizes and adding new
background properties in the theme.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Mahid Ahmad <[email protected]>

* Env Management (bluewave-labs#258)

Closes bluewave-labs#259 
- Improved environment management and added env badge
- Updated `.gitignore` and scripts

* Refactor Document Access Feature (Client and ServerSide) (bluewave-labs#261)

**This PR Fixes** 
- bluewave-labs#217
- bluewave-labs#221
- bluewave-labs#222
- bluewave-labs#223
- bluewave-labs#224 (Inline PDF and
Analytics will be done in another PR)

This Pull Request will cover the refactor of document access feature:

- Database tables and Directory naming convention changed as requested.
- Integrated API calls using hooks
- Store user required fields in visitorFields and dynamic display fields
in the form
- Support for any additional user meta data needed in a table field
`visitorMetaData`
- Integrate hook to upload document and invalidate query which removed
explicit url reload to fetch latest documents once a upload is done
- Add constraint to make sure link `alias` is unique as per a single
user only. The below Query will support adding alias with more and one
empty and null values but not any scalar values. We need to create a
migration and run this query.
```sql
-- DropIndex
DROP INDEX "DocumentLink_createdByUserId_alias_key";

-- This allows multiple NULL aliases,
-- but enforces uniqueness on alias per createdByUserId if alias is not null
CREATE UNIQUE INDEX unique_alias_per_user
ON "DocumentLink"("createdByUserId", "alias")
WHERE alias IS NOT NULL AND alias <> '';
```

**To look the UI Changes please go through this merged PR created by**
@SepidehShahbazi

[Overhauling CreateLink modal and SendingAccordion, and adding React
Query](bluewave-labs#260)

---------

Co-authored-by: Sepideh Shahbazi <[email protected]>
Co-authored-by: Mahid Ahmad <[email protected]>

* Remove deprecated authentication and document handling routes

* Fixed Build Errors

---------

Co-authored-by: Mahid Ahmad <[email protected]>
Co-authored-by: Sepideh Shahbazi <[email protected]>
Co-authored-by: Parwat Kunwar <[email protected]>
Co-authored-by: Sepideh Shahbazi <[email protected]>
dev-datahall added a commit to dev-datahall/datahall-prod that referenced this pull request May 19, 2025
* Prod Deployment (bluewave-labs#250)

Update Master Branch with the latest Release

---------

Co-authored-by: Mahid Ahmad <[email protected]>
Co-authored-by: Sepideh Shahbazi <[email protected]>
Co-authored-by: Parwat Kunwar <[email protected]>

* Creating password form modal and improving profile form (bluewave-labs#253)

This closes bluewave-labs#251.

**Implemented:**

1. Provided Edit Mode for Profile form.
2. Added "Change password" button in the Profile form.
3. Removed profile and password tab section.
4. Removed Avatar Upload UI temporarily in the Profile form.
5. Created a new PasswordFormModal.tsx file and replaced it with
PasswordForm.tsx.
6. Ensured UI Consistency & Responsiveness.


**UI changes:**

**Profile form:**

<img width="709" alt="ProfileForm3"
src="https://github.com/user-attachments/assets/4e3e159b-67f7-457e-a4e8-bc5056abc794"
/>

<img width="698" alt="ProfileForm4"
src="https://github.com/user-attachments/assets/f716b98b-5cfd-4dc3-b824-08ac8b33fc81"
/>


**Password form modal:**

<img width="535" alt="PasswordFormModal2"
src="https://github.com/user-attachments/assets/ca56963b-30c5-4d76-85bb-3e9b147c7222"
/>



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Introduced an enhanced profile editing mode that lets users toggle
between view and edit states with dynamic controls, including dedicated
buttons for editing, saving, and canceling changes.
- Implemented a new password update modal that offers a streamlined,
validated password change experience when editing profile details.

- **Bug Fixes**
- Removed the previous password change form to eliminate confusion and
improve user navigation.

- **Refactor**
- Consolidated profile management by removing the previous inline
password change form and tabbed interface, resulting in a simplified,
unified user experience.
- Updated the profile page to utilize the new profile form component,
enhancing overall functionality.

- **Style**
- Enhanced button styling by updating font sizes and adding new
background properties in the theme.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Mahid Ahmad <[email protected]>

* Env Management (bluewave-labs#258)

Closes bluewave-labs#259 
- Improved environment management and added env badge
- Updated `.gitignore` and scripts

* Refactor Document Access Feature (Client and ServerSide) (bluewave-labs#261)

**This PR Fixes** 
- bluewave-labs#217
- bluewave-labs#221
- bluewave-labs#222
- bluewave-labs#223
- bluewave-labs#224 (Inline PDF and
Analytics will be done in another PR)

This Pull Request will cover the refactor of document access feature:

- Database tables and Directory naming convention changed as requested.
- Integrated API calls using hooks
- Store user required fields in visitorFields and dynamic display fields
in the form
- Support for any additional user meta data needed in a table field
`visitorMetaData`
- Integrate hook to upload document and invalidate query which removed
explicit url reload to fetch latest documents once a upload is done
- Add constraint to make sure link `alias` is unique as per a single
user only. The below Query will support adding alias with more and one
empty and null values but not any scalar values. We need to create a
migration and run this query.
```sql
-- DropIndex
DROP INDEX "DocumentLink_createdByUserId_alias_key";

-- This allows multiple NULL aliases,
-- but enforces uniqueness on alias per createdByUserId if alias is not null
CREATE UNIQUE INDEX unique_alias_per_user
ON "DocumentLink"("createdByUserId", "alias")
WHERE alias IS NOT NULL AND alias <> '';
```

**To look the UI Changes please go through this merged PR created by**
@SepidehShahbazi

[Overhauling CreateLink modal and SendingAccordion, and adding React
Query](bluewave-labs#260)

---------

Co-authored-by: Sepideh Shahbazi <[email protected]>
Co-authored-by: Mahid Ahmad <[email protected]>

* Remove deprecated authentication and document handling routes

* Fixed Build Errors

* Fix document count retrieval in DocumentsPage component

---------

Co-authored-by: Mahid Ahmad <[email protected]>
Co-authored-by: Sepideh Shahbazi <[email protected]>
Co-authored-by: Parwat Kunwar <[email protected]>
Co-authored-by: Sepideh Shahbazi <[email protected]>
@mahid797 mahid797 deleted the refactor/document-access branch June 18, 2025 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backend Backend Related Issue 🔥Critical Must be addressed immediately; blocking core functionality or major bug Frontend Frontend Related Issue Refactor Code Improvement
Projects
None yet
3 participants