crypto: use globalThis.crypto over require('crypto').webcrypto

[panva]

Updates tests and some remaining documentation to use globalThis.crypto instead of require('crypto').webcrypto.

@aduh95 it would be great if we could make this into a lint rule but unfortunately the existing options I tried to do this with fall short:

• no-restricted-modules cannot restrict an exported property from the crypto module.
• no-restricted-properties does not catch use of const { webcrypto } = require('crypto').

[nodejs-github-bot]

Review requested:

• @nodejs/crypto

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/48406/

[aduh95]

I disagree with the changes in the test, we want to keep the test as is to ensure there's no regressions. The doc-changes LGTM.

[panva]

I disagree with the changes in the test, we want to keep the test as is to ensure there's no regressions. The doc-changes LGTM.

What test change do you disagree with?

[aduh95]

What test change do you disagree with?

Changing the tests to test globalThis.crypto instead of require('node:crypto').webcrypto.

[panva]

What test change do you disagree with?

Changing the tests to test globalThis.crypto instead of require('node:crypto').webcrypto.

We have other existing tests that ensure the two are equal. So I don't see why these changes would be a cause for concern.

[aduh95]

We have other existing tests that ensure the two are equal.

That seems like another reason not to make this change. Unless we decide to deprecate require('node:crypto').webcrypto, there's no reason to remove it from our tests IMO.

[panva]

I'm unforunately not following your argumentation @aduh95.

I don't see the need for having to have a deprecation on it to recognize the global is the likely way of accessing a Web API, it is the way we already have in most doc examples, and it should therefore be the one tested.

[aduh95]

I guess we would have to agree to disagree, and wait to see if someone else wants to chime in. If someone else thinks we should merge it, I'm ready to dismiss my review.

Count me as -.5 on this because:

• We usually don't accept PRs that are doing "stylistic changes" without a lint rule, and arguably accessing the API one way or another is a question of personal preference and qualify as a "stylistic change" IMO.
• Even if there were a lint rule added with this PR, I would still be against it (but wouldn't block it), IMO both ways are "valid", and there's little value in enforcing one over the other.

and it should therefore be the one tested.

I disagree, the fact that one API is used less often than another doesn't mean it deserves less test coverage (but anyway it's a bit off-topic, since both APIs are equivalent in this case).

[anonrig]

I agree with @aduh95 regarding the usage of require('node:crypto').webcrypto instead of globalThis.crypto internally.

I'm in favor of blocking this because, if we are going to use globalThis.crypto instead of require('node:crypto').webcrypto we need a lint rule to protect this change in the upcoming pull requests.

[panva]

if we are going to use globalThis.crypto instead of require('node:crypto').webcrypto we need a lint rule to protect this change in the upcoming pull requests.

And I've requested assistance with such in the very description of this PR myself.

[anonrig]

And I've requested assistance with such in the very description of this PR myself.

I totally missed that part, my bad!

[anonrig]

I see. I found the corresponding bug report for this: eslint/eslint#16412

[panva]

I've added a working, albeit rudimentary, lint rule.

[aduh95]

lib/.eslintrc.yaml

Not while it's defined using no-restricted-syntax. When no-restricted-properties is fixed and used, sure.

lib/ should never use the global (which is user-mutable) but instead require the internal module. There's already a lint rule for that:

node/lib/.eslintrc.yaml

Lines 150 to 155 in 587367d

	- name: crypto
	message: Use `const { crypto } = require('internal/crypto/webcrypto');` instead of the global.
	- name: Crypto
	message: Use `const { Crypto } = require('internal/crypto/webcrypto');` instead of the global.
	- name: CryptoKey
	message: Use `const { CryptoKey } = require('internal/crypto/webcrypto');` instead of the global.

Still -1 on this, I don't think this lint rule is a great addition, but won't block it.

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/48435/

[nodejs-github-bot]

Landed in 7ad069c