fix: undo operation on signature pad

[plxity]

fixes: #864

[vercel]

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

A member of the Team first needs to authorize it.

[github-actions]

Thank you for following the naming conventions for pull request titles! 💚🚀

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

[plxity]

@Mythie @dguyen Please review the changes.

[adithyaakrishna]

LGTM 🌮

[plxity]

@Mythie Bumping this up 😅

[catalinpit]

I'm on the main branch, and the undo functionality works properly. Am I missing something?

sign.mp4

[plxity]

@catalinpit Please watch the video I have attached and the steps to reproduce.

[catalinpit]

@catalinpit Please watch the video I have attached and the steps to reproduce.

Yeah, I've seen those. I thought it happens in all scenarios, but the issue actually occurs when you already have a signature and try to update it.

Thanks for the heads up! Will test the changes and review the PR.

[catalinpit]

Ok, I just tested it. It works fine on the profile page, but for some reason doesn't work when signing a document. I attached a video.

Does it work for you?

sign-doc.mp4

[plxity]

Yup, it seems to be working for me. Can you restart server or clear browser cache and try again?

[catalinpit]

Yup, it seems to be working for me. Can you restart server or clear browser cache and try again?

I restarted the server, cleared browser cache, and even ran npm run reset:hard, and it still doesn't work unfortunately...

[plxity]

@catalinpit My bad, I have fixed it. In useEffect deps value, there is no need to add defaultValue. Because we want that effect to only run once when the component loads, I've fixed it and have tested the changes at all the places. Please review it again.

[catalinpit]

Another thing I observed is that when you undo the first change to an already existing signature, the signature is not updated. See the video to better understand what I mean.

save-signature.mp4

I tried calling the onChange function after clearing the canvas to update the signature URL and it seems to work.

if ($el.current) {
      const ctx = $el.current.getContext('2d');
      const { width, height } = $el.current;
      ctx?.clearRect(0, 0, width, height);
      if (typeof defaultValue === 'string' && defaultImageRef.current) {
        ctx?.putImageData(defaultImageRef.current, 0, 0);
      }
      newLines.forEach((line) => {
        const pathData = new Path2D(getSvgPathFromStroke(getStroke(line, perfectFreehandOptions)));
        ctx?.fill(pathData);
      });

      /*
         here
      */
      onChange?.($el.current.toDataURL());
    }

Please double check and see if it works and/or if there is a better way of doing it.

Here's how it works with the new addition.

works.mp4

[plxity]

@catalinpit Thanks for pointing out. This makes sense, I've added an onChange handler. This is a good method to work with it :)

[plxity]

@catalinpit Let me know if the changes are fine :)

[catalinpit]

thanks for the work!

[Mythie]

Great work 😄