lib: runtime deprecate calling Cipheriv(...) and Decipheriv(...) without new
#57268
+60
−71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cipher was removed from the public API a while ago but we were still
defining it and exporting `require('crypto').Cipher` as `undefined`.
Silly us.
jasnell
added
crypto
|
Review requested:
|
nodejs-github-bot
added
doc
jasnell
commented
Mar 2, 2025
anonrig
approved these changes
Mar 2, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #57268 +/- ##
==========================================
- Coverage 90.24% 90.24% -0.01%
==========================================
Files 630 630
Lines 184908 184883 -25
Branches 36181 36175 -6
==========================================
- Hits 166874 166848 -26
+ Misses 11061 11055 -6
- Partials 6973 6980 +7
|
aduh95
reviewed
Mar 2, 2025
Comment on lines
+3843
to
+3855
| ### DEP0190: Instantiating `node:crypto` `Cipheriv` and `Decipheriv` classes without `new` | ||
|
|
||
| <!-- YAML | ||
| changes: | ||
| - version: REPLACEME | ||
| pr-url: https://github.com/nodejs/node/pull/57268 | ||
| description: Runtime deprecation. | ||
| --> | ||
|
|
||
| Type: Runtime | ||
|
|
||
| Instantiating the [`Cipheriv`][] and [`Decipheriv`][] classes exported by the `node:crypto` | ||
| module is deprecated. |
There was a problem hiding this comment.
Can you do a first PR that doc-deprecates it, so that can be backported to existing release lines?
There was a problem hiding this comment.
I've been unable to find any examples anywhere of anyone actually calling these (at least in any open source code). I'm not sure there's an actual value in backporting a doc-only deprecation to older lines.
There was a problem hiding this comment.
It simplifies backporting of other deprecations, as it's otherwise likely we would get conflicts. I'm happy to open the doc-only PR myself if you prefer
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The first commit here is from #57266 which is expected to land first. This PR is about the second commit... deprecating calling
Cipheriv(...)andDecipheriv(...)without thenewkeyword. Technically we should probably also deprecate creating these directly even with thenewkeyword since we tell people to usecreateCipheriv(...)andcreateDecipheriv(...)to create these (both of which simply defer to callingnew ...but still).I did do a github code search trying to find any examples of folks calling these directly without the new keyword and there were zero hits suggesting that going straight to a runtime deprecation is quite safe.
/cc @nodejs/tsc