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

Deprecated extractSignature as it was never public-ready. #208

Closed
wants to merge 1 commit into from

Conversation

vbuch
Copy link
Owner

@vbuch vbuch commented Nov 22, 2023

Copied it in internal-utils to be used in tests. Will remove from utils in a next major release (#206)

@dhensby
Copy link
Collaborator

dhensby commented Nov 22, 2023

Is it worth making use of util.deprecate() to properly mark the function as deprecated?

Copied it in internal-utils to be used in tests. Will remove from `utils` in a next major release (#206)
@vbuch vbuch force-pushed the feature/deprecate-extractSignature branch from 5ba4f4f to a2efb6f Compare November 23, 2023 07:57
@coveralls
Copy link

Coverage Status

coverage: 99.585% (+0.001%) from 99.584%
when pulling a2efb6f on feature/deprecate-extractSignature
into 5855e24 on develop.

@vbuch
Copy link
Owner Author

vbuch commented Nov 23, 2023

Is it worth making use of util.deprecate() to properly mark the function as deprecated?

@dhensby , ✅

@dhensby
Copy link
Collaborator

dhensby commented Nov 23, 2023

I'm going through the upgrade process/refactor of my project that uses pdfsign and I've just noticed that I'm using extractSignature as a helper in our tests - essentially just to assert that there is indeed a signature in the PDF we've created. This is especially helpful when writing a custom signer and you want to assert that a signature was indeed added.

Is there a better way to do that?

@vbuch
Copy link
Owner Author

vbuch commented Nov 23, 2023

The best I can think of would be to use an external library that deals with signature verification and exports such a utility. This one used to be part of node-signpdf some 5 years ago and is the only one I know. Finding such a library would actualy render our own extractSignature useless.

@vbuch
Copy link
Owner Author

vbuch commented Nov 24, 2023

With the above in mind I'm closing this. I understand that the util may come handy to some. What I will do instead is create an adequate wording around it that clearly states this is not public-ready code.

@vbuch vbuch closed this Nov 24, 2023
@vbuch vbuch deleted the feature/deprecate-extractSignature branch November 24, 2023 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants