Skip to content

crypto: docs-only deprecate crypto.fips, replace - #18335

Closed
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:crypto-replace-crypto.fips
Closed

crypto: docs-only deprecate crypto.fips, replace#18335
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:crypto-replace-crypto.fips

Conversation

@jasnell

Copy link
Copy Markdown
Member

Docs-only deprecate the getter/setter crypto.fips and replace with crypto.setFips() and crypto.getFips()

This is specifically in preparation for ESM module support
Refs: #18131

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

crypto

@jasnelljasnell added crypto Issues and PRs related to the crypto subsystem. semver-major PRs that contain breaking changes and should be released in the next major version. labels Jan 24, 2018
@nodejs-github-botnodejs-github-bot added the crypto Issues and PRs related to the crypto subsystem. label Jan 24, 2018
@jasnell
jasnell requested a review from a teamJanuary 24, 2018 00:35
Comment threaddoc/api/deprecations.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I prefer more direct wording:

The [`crypto.fips`][] property is deprecated. Please use
`crypto.setFips()` and `crypto.getFips()`.

@jasnelljasnell added this to the 10.0.0 milestone Jan 24, 2018
Comment threaddoc/api/crypto.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Typo sentence?

Comment threaddoc/api/deprecations.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

#crypto_crypto.fips -> #crypto_crypto_fips?

Comment threaddoc/api/crypto.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No need for the parentheses.

@mcollinamcollina left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@jasnell

jasnell commented Jan 24, 2018 via email

Copy link
Copy Markdown
MemberAuthor

@jasnell

Copy link
Copy Markdown
MemberAuthor

Ping @nodejs/tsc ... I'd like to treat this docs-only deprecation as semver-minor. Any objections?

@jasnell

Copy link
Copy Markdown
MemberAuthor

@maclover7maclover7 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 26, 2018
@ChALkeR

ChALkeR commented Jan 28, 2018

Copy link
Copy Markdown
Member

+1 for semver-minor for doc-only here.

Perhaps there should also be a pendingDeprecation-guarded runtime warning?

Upd: opened #18417.

@jasnell

Copy link
Copy Markdown
MemberAuthor

@ChALkeR ... let's add the --pending-deprecation warning after #18417 lands. This shouldn't have to wait for that tho.

@ChALkeR

Copy link
Copy Markdown
Member

@jasnell#18417 is an issue, #18433 landed already.

@jasnell
jasnellforce-pushed the crypto-replace-crypto.fips branch from 54bd37a to 877e1c9CompareFebruary 1, 2018 01:48
@jasnell

Copy link
Copy Markdown
MemberAuthor

oh! I missed that... think I mentally mixed #18433 and #18417 and completely missed that it had landed already :-)

Comment threaddoc/api/deprecations.md Outdated

@ChALkeRChALkeRFeb 1, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Merge conflict (here and below)

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Ugh. Forgot to save

@BridgeARBridgeAR added semver-minor PRs that contain new features and should be released in the next minor version. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. semver-major PRs that contain breaking changes and should be released in the next major version. labels Feb 1, 2018
@BridgeAR

Copy link
Copy Markdown
Member

I changed it to semver-minor as there was enough time to speak up against it and there was only a voice pro.

@mhdawsonmhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@jasnell
jasnellforce-pushed the crypto-replace-crypto.fips branch from d488810 to 900bf45CompareFebruary 1, 2018 15:25
@jasnell

Copy link
Copy Markdown
MemberAuthor

Note: I will land this after I get #18492 landed.

@BridgeARBridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 1, 2018
Docs-only deprecate the getter/setter crypto.fips and replace
with crypto.setFips() and crypto.getFips()
This is specifically in preparation for ESM module support
Refs: nodejs#18131
@jasnell
jasnellforce-pushed the crypto-replace-crypto.fips branch from 900bf45 to 1dece49CompareFebruary 1, 2018 16:18
@jasnell

Copy link
Copy Markdown
MemberAuthor

jasnell added a commit that referenced this pull request Feb 2, 2018
Docs-only deprecate the getter/setter crypto.fips and replace
with crypto.setFips() and crypto.getFips()
This is specifically in preparation for ESM module support
PR-URL: #18335
Refs: #18131
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@jasnell

Copy link
Copy Markdown
MemberAuthor

Landed in 6e7992e

@jasnelljasnell closed this Feb 2, 2018
@addaleaxaddaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 4, 2018
@MylesBorins

Copy link
Copy Markdown
Contributor

This does not land cleanly on v9.x

This is because other deprecations have landed on master that have been given codes. If we are going to land this as semver minor would someone be willing to backport and assign an appropriate code to make sure we don't double dip

BridgeAR pushed a commit to BridgeAR/node that referenced this pull request May 1, 2018
Docs-only deprecate the getter/setter crypto.fips and replace
with crypto.setFips() and crypto.getFips()
This is specifically in preparation for ESM module support
PR-URL: nodejs#18335
Refs: nodejs#18131
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
Docs-only deprecate the getter/setter crypto.fips and replace
with crypto.setFips() and crypto.getFips()
This is specifically in preparation for ESM module support
PR-URL: nodejs#18335
Refs: nodejs#18131
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cryptoIssues and PRs related to the crypto subsystem.semver-minorPRs that contain new features and should be released in the next minor version.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

13 participants

@jasnell@ChALkeR@BridgeAR@MylesBorins@mcollina@guybedford@Trott@addaleax@cjihrig@maclover7@mhdawson@vsemozhetbyt@nodejs-github-bot