feat: add recipient roles #716

thehanimo · 2023-12-03T00:32:38Z

Fixes #705

coderabbitai · 2023-12-03T00:32:43Z

Important

Auto Review Skipped

Auto reviews are limited to the following labels: coderabbit. Please add one of these labels to enable auto reviews.

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.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
- Generate unit-tests for this file.
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 tests 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 generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

vercel · 2023-12-03T00:32:44Z

@thehanimo is attempting to deploy a commit to the Documenso Team Team on Vercel.

A member of the Team first needs to authorize it.

Mythie · 2023-12-03T00:33:06Z

Hey there, it looks like you haven't accepted our contributor license agreement yet. In order for us to accept your pull request we ask that you please fill out the CLA:

https://documen.so/cla

Mythie · 2023-12-03T00:38:55Z

I'll have to review this one when I'm back at a computer since it's a bit hard to follow. I understand there's a bit of nuance to this issue so I'll try and get back to you asap

Mythie · 2023-12-03T00:41:20Z

apps/web/src/app/(dashboard)/documents/data-table-action-button.tsx

@@ -72,6 +73,8 @@ export const DataTableActionButton = ({ row }: DataTableActionButtonProps) => {
    window.URL.revokeObjectURL(link.href);
  };

+  if (recipient?.role === RecipientRole.CC && isComplete === false) return <div></div>;


This one sticks out to me as a question but until I run it locally I'm unsure what the question is. Just seems odd to return nothing here.

This is just assuming that the CC'er shouldn't be able to view the document until it has been completed.

apps/web/src/app/(dashboard)/documents/data-table-action-dropdown.tsx

packages/lib/server-only/document/complete-document-with-token.ts

packages/ui/primitives/document-flow/add-signers.types.ts

apps/web/src/app/(dashboard)/documents/data-table-action-button.tsx

packages/lib/server-only/document/seal-document.ts

Mythie

Noting that we shouldn't be able to add fields for Viewers and Copy'ers

Mythie

Noting that the CC'er received an invitation to sign the document but they should only receive an email once the document has been completed.

Mythie · 2023-12-03T11:27:19Z

round 2

apps/web/src/app/(dashboard)/documents/[id]/edit-document.tsx

Mythie

Change since last review, now doing the whole PR once more incase I've missed anything before running the UI

apps/web/src/app/(signing)/sign/[token]/sign-dialog.tsx

packages/lib/server-only/document/complete-document-with-token.ts

packages/lib/server-only/document/resend-document.tsx

packages/lib/server-only/document/send-document.tsx

Mythie · 2023-12-03T11:46:24Z

While it's nice to see the roles it feels little cramped right now, the font weight also steals attention from the recipient email which likely isn't a good thing. Consider muting the role label and making it more subtle.

Mythie · 2023-12-03T11:49:10Z

Email sending is working as expected although I think we should update the templates to reflect the new roles! A viewer will never sign the document 😄

Likewise when adding fields it'd be nice to know what role a specific recipient has when I select them.

thehanimo · 2023-12-03T12:11:16Z

While it's nice to see the roles it feels little cramped right now, the font weight also steals attention from the recipient email which likely isn't a good thing. Consider muting the role label and making it more subtle.

Do you think a normal font weight would do? What if we went smaller than text-xs? Or maybe make it a pill/label?

Mythie · 2023-12-03T13:16:00Z

Noting that Eric dropped out but had a really cool thing for recipient selection in #717. He was kind enough to grant permission to use any code you deem useful there as well 😄

Mythie · 2023-12-03T13:16:38Z

While it's nice to see the roles it feels little cramped right now, the font weight also steals attention from the recipient email which likely isn't a good thing. Consider muting the role label and making it more subtle.

Do you think a normal font weight would do? What if we went smaller than text-xs? Or maybe make it a pill/label?

I'd consider text-xs with a normal font weight. I'd probably also use our text-muted-forground class

Mythie · 2023-12-03T13:17:20Z

Noting that this will be the winner, just working through minor items now.

thehanimo · 2023-12-03T13:49:02Z

Noting that Eric dropped out but had a really cool thing for recipient selection in #717. He was kind enough to grant permission to use any code you deem useful there as well 😄

That is unfortunate :/
What are you referring to when you say recipient selection?

I'd consider text-xs with a normal font weight. I'd probably also use our text-muted-forground class

It was text-muted-foreground all along. I changed it to text-muted-forground/50. Looks better to me!

packages/trpc/server/recipient-router/schema.ts

packages/ui/primitives/document-flow/add-fields.tsx

packages/lib/server-only/document/find-documents.ts

- Updated styling - Updated email templates to render correct roles - Extracted logic to render role verbs and actions

gitguardian · 2024-02-01T07:43:52Z

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
-		Generic Password	`a63f560`	.github/workflows/e2e-tests.yml	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secret safely. Learn here the best practices.
Revoke and rotate this secret.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

feat: add recipient roles

f4b1508

Mythie requested changes Dec 3, 2023

View reviewed changes

fix: update waiting logic and add roles to popover

81b12cb

surajgjadhav reviewed Dec 3, 2023

View reviewed changes

packages/ui/primitives/document-flow/add-signers.types.ts Outdated Show resolved Hide resolved

Mythie reviewed Dec 3, 2023

View reviewed changes

apps/web/src/app/(dashboard)/documents/data-table-action-button.tsx Outdated Show resolved Hide resolved

Mythie reviewed Dec 3, 2023

View reviewed changes

packages/lib/server-only/document/seal-document.ts Outdated Show resolved Hide resolved

Mythie reviewed Dec 3, 2023

View reviewed changes

thehanimo added 6 commits December 3, 2023 00:44

fix: change role to nativeEnum in schema

f75e054

fix: disable fields for viewers and cc'ers

37fb5d9

fix: suppress email invite to cc'ers

a545b05

fix: set status to signed by default for cc'ers

782c5ae

fix: simplify completed document query

094be3c

fix: add mark as viewed for viewers

4ea9360

thehanimo requested a review from Mythie December 3, 2023 06:55

ephraimduncan added the osshack label Dec 3, 2023

Mythie reviewed Dec 3, 2023

View reviewed changes

apps/web/src/app/(dashboard)/documents/[id]/edit-document.tsx Outdated Show resolved Hide resolved

Mythie reviewed Dec 3, 2023

View reviewed changes

apps/web/src/app/(signing)/sign/[token]/sign-dialog.tsx Outdated Show resolved Hide resolved

packages/lib/server-only/document/complete-document-with-token.ts Outdated Show resolved Hide resolved

packages/lib/server-only/document/resend-document.tsx Outdated Show resolved Hide resolved

Mythie reviewed Dec 3, 2023

View reviewed changes

packages/lib/server-only/document/send-document.tsx Show resolved Hide resolved

thehanimo added 3 commits December 3, 2023 07:19

refactor: lint code

af8bbc8

fix: change label/messages for approvers

b4b886e

fix: mute roles in popover

e71df20

thehanimo added 3 commits December 3, 2023 07:33

fix: change action verb in email based on role

22eb06d

feat: add role icons in select

6b8ddf4

feat: hide incomplete docs from cc'er

eef72de

thehanimo requested a review from Mythie December 3, 2023 13:03

Merge branch 'main' into add-recipient-roles

a63f560

github-actions bot added apps: web Issues related to the webapp 🚨 migrations 🚨 apps: marketing Issues related to website or marketing app labels Dec 27, 2023

Mythie added 4 commits December 27, 2023 14:25

chore: make it build again

f2d1249

chore: styling updates

42ae6d3

Merge branch 'main' into add-recipient-roles

95e4f6f

fix: final styling updates

e2f0273

Mythie requested a review from dguyen January 9, 2024 06:24

dguyen reviewed Jan 11, 2024

View reviewed changes

packages/trpc/server/recipient-router/schema.ts Outdated Show resolved Hide resolved

packages/ui/primitives/document-flow/add-fields.tsx Outdated Show resolved Hide resolved

packages/lib/server-only/document/find-documents.ts Outdated Show resolved Hide resolved

dguyen added 2 commits January 31, 2024 17:05

Merge branch 'main' into add-recipient-roles

53e47e1

fix: update invite templates to display roles

6632064

- Updated styling - Updated email templates to render correct roles - Extracted logic to render role verbs and actions

dguyen previously approved these changes Feb 1, 2024

View reviewed changes

Mythie previously approved these changes Feb 1, 2024

View reviewed changes

Merge branch 'main' into add-recipient-roles

45604c6

dguyen dismissed stale reviews from Mythie and themself via 45604c6 February 1, 2024 23:42

dguyen merged commit 7ece6ef into documenso:main Feb 1, 2024
5 of 11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add recipient roles #716

feat: add recipient roles #716

thehanimo commented Dec 3, 2023

coderabbitai bot commented Dec 3, 2023 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

vercel bot commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie Dec 3, 2023

thehanimo Dec 3, 2023

Mythie left a comment

Mythie left a comment

Mythie commented Dec 3, 2023

Mythie left a comment

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

thehanimo commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

thehanimo commented Dec 3, 2023 •

edited

gitguardian bot commented Feb 1, 2024 •

edited

feat: add recipient roles #716

feat: add recipient roles #716

Conversation

thehanimo commented Dec 3, 2023

coderabbitai bot commented Dec 3, 2023 • edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

vercel bot commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie Dec 3, 2023

Choose a reason for hiding this comment

thehanimo Dec 3, 2023

Choose a reason for hiding this comment

Mythie left a comment

Choose a reason for hiding this comment

Mythie left a comment

Choose a reason for hiding this comment

Mythie commented Dec 3, 2023

Mythie left a comment

Choose a reason for hiding this comment

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

thehanimo commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

Mythie commented Dec 3, 2023

thehanimo commented Dec 3, 2023 • edited

gitguardian bot commented Feb 1, 2024 • edited

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

coderabbitai bot commented Dec 3, 2023 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

thehanimo commented Dec 3, 2023 •

edited

gitguardian bot commented Feb 1, 2024 •

edited