-
-
Notifications
You must be signed in to change notification settings - Fork 26
feat(tls-create-secure-pair-deprecation): handle Node.js DEP0064 migration #266
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
base: main
Are you sure you want to change the base?
feat(tls-create-secure-pair-deprecation): handle Node.js DEP0064 migration #266
Conversation
| ### Case 1: Basic `createSecurePair` usage | ||
|
|
||
| **Before:** | ||
| ```js | ||
| const { createSecurePair } = require('node:tls'); | ||
|
|
||
| const pair = createSecurePair(credentials); | ||
| ``` | ||
|
|
||
| **After:** | ||
| ```js | ||
| const { TLSSocket } = require('node:tls'); | ||
|
|
||
| const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Case 2: Namespace import | ||
|
|
||
| **Before:** | ||
| ```js | ||
| const tls = require('node:tls'); | ||
|
|
||
| const pair = tls.createSecurePair(credentials); | ||
| ``` | ||
|
|
||
| **After:** | ||
| ```js | ||
| const tls = require('node:tls'); | ||
|
|
||
| const socket = new tls.TLSSocket(underlyingSocket, { secureContext: credentials }); | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Case 3: With server context | ||
|
|
||
| **Before:** | ||
| ```js | ||
| const { createSecurePair } = require('node:tls'); | ||
|
|
||
| const pair = createSecurePair(credentials, true, true, false); | ||
| ``` | ||
|
|
||
| **After:** | ||
| ```js | ||
| const { TLSSocket } = require('node:tls'); | ||
|
|
||
| const socket = new TLSSocket(underlyingSocket, { | ||
| secureContext: credentials, | ||
| isServer: true, | ||
| requestCert: true, | ||
| rejectUnauthorized: false | ||
| }); | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Case 4: ESM import | ||
|
|
||
| **Before:** | ||
| ```js | ||
| import { createSecurePair } from 'node:tls'; | ||
|
|
||
| const pair = createSecurePair(credentials); | ||
| ``` | ||
|
|
||
| **After:** | ||
| ```js | ||
| import { TLSSocket } from 'node:tls'; | ||
|
|
||
| const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Case 5: ESM namespace import | ||
|
|
||
| **Before:** | ||
| ```js | ||
| import * as tls from 'node:tls'; | ||
|
|
||
| const pair = tls.createSecurePair(credentials); | ||
| ``` | ||
|
|
||
| **After:** | ||
| ```js | ||
| import * as tls from 'node:tls'; | ||
|
|
||
| const socket = new tls.TLSSocket(underlyingSocket, { secureContext: credentials }); | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Case 6: Mixed usage with other TLS functions | ||
|
|
||
| **Before:** | ||
| ```js | ||
| const { createSecurePair, createServer } = require('node:tls'); | ||
|
|
||
| const pair = createSecurePair(credentials); | ||
| const server = createServer(options); | ||
| ``` | ||
|
|
||
| **After:** | ||
| ```js | ||
| const { TLSSocket, createServer } = require('node:tls'); | ||
|
|
||
| const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | ||
| const server = createServer(options); | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### Case 1: Basic `createSecurePair` usage | |
| **Before:** | |
| ```js | |
| const { createSecurePair } = require('node:tls'); | |
| const pair = createSecurePair(credentials); | |
| ``` | |
| **After:** | |
| ```js | |
| const { TLSSocket } = require('node:tls'); | |
| const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | |
| ``` | |
| --- | |
| ### Case 2: Namespace import | |
| **Before:** | |
| ```js | |
| const tls = require('node:tls'); | |
| const pair = tls.createSecurePair(credentials); | |
| ``` | |
| **After:** | |
| ```js | |
| const tls = require('node:tls'); | |
| const socket = new tls.TLSSocket(underlyingSocket, { secureContext: credentials }); | |
| ``` | |
| --- | |
| ### Case 3: With server context | |
| **Before:** | |
| ```js | |
| const { createSecurePair } = require('node:tls'); | |
| const pair = createSecurePair(credentials, true, true, false); | |
| ``` | |
| **After:** | |
| ```js | |
| const { TLSSocket } = require('node:tls'); | |
| const socket = new TLSSocket(underlyingSocket, { | |
| secureContext: credentials, | |
| isServer: true, | |
| requestCert: true, | |
| rejectUnauthorized: false | |
| }); | |
| ``` | |
| --- | |
| ### Case 4: ESM import | |
| **Before:** | |
| ```js | |
| import { createSecurePair } from 'node:tls'; | |
| const pair = createSecurePair(credentials); | |
| ``` | |
| **After:** | |
| ```js | |
| import { TLSSocket } from 'node:tls'; | |
| const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | |
| ``` | |
| --- | |
| ### Case 5: ESM namespace import | |
| **Before:** | |
| ```js | |
| import * as tls from 'node:tls'; | |
| const pair = tls.createSecurePair(credentials); | |
| ``` | |
| **After:** | |
| ```js | |
| import * as tls from 'node:tls'; | |
| const socket = new tls.TLSSocket(underlyingSocket, { secureContext: credentials }); | |
| ``` | |
| --- | |
| ### Case 6: Mixed usage with other TLS functions | |
| **Before:** | |
| ```js | |
| const { createSecurePair, createServer } = require('node:tls'); | |
| const pair = createSecurePair(credentials); | |
| const server = createServer(options); | |
| ``` | |
| **After:** | |
| ```js | |
| const { TLSSocket, createServer } = require('node:tls'); | |
| const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | |
| const server = createServer(options); | |
| ``` | |
| ```dif | |
| -import { createSecurePair } from 'node:tls'; | |
| - | |
| -const pair = createSecurePair(credentials); | |
| +import { TLSSocket } from 'node:tls'; | |
| + | |
| +// provide an underlying socket (e.g. a net.Socket or existing stream) | |
| +const socket = new TLSSocket(underlyingSocket, { secureContext: credentials }); | |
| ``` | |
| ``` | |
| we should start using diff |
|
Missing import test case
|
| ...getNodeImportStatements(root, 'node:tls'), | ||
| ...getNodeImportStatements(root, 'tls'), | ||
| ...getNodeRequireCalls(root, 'node:tls'), | ||
| ...getNodeRequireCalls(root, 'tls'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ...getNodeImportStatements(root, 'node:tls'), | |
| ...getNodeImportStatements(root, 'tls'), | |
| ...getNodeRequireCalls(root, 'node:tls'), | |
| ...getNodeRequireCalls(root, 'tls'), | |
| ...getNodeImportStatements(root, 'tls'), | |
| ...getNodeRequireCalls(root, 'tls'), |
Theses function handle the node: prefix 😁
| const src = /node:tls/.test(code) ? 'node:tls' : 'tls'; | ||
| const rebuilt = `const { ${kept.join(', ')} } = require('${src}');`; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| const src = /node:tls/.test(code) ? 'node:tls' : 'tls'; | |
| const rebuilt = `const { ${kept.join(', ')} } = require('${src}');`; | |
| const rebuilt = `const { ${kept.join(', ')} } = require('node:tls');`; |
we can enforce node:tls prefix
|
|
||
| for (const stmt of tlsStmts) { | ||
| const code = stmt.text(); | ||
| if (/\bimport\s+\*\s+as\s+\w+\s+from\s+['"](tls|node:tls)['"]/.test(code)) continue; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤯
This part use too much ReGex, you should use more AST than regex. Because AST is more safe dude to the predictability.
If you need to visualize/test astrology query you can use ast-grep playground
So an ast query look like that:
const statement = root.findAll({
rule: {
pattern: `${base}.propriety`,
not: {
inside: {
kind: "assignment_expression",
has: {
kind: "member_expression",
pattern: `${base}.fips`,
},
},
},
},
});There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get it, working on all these topics :)
👍
This pull request implements the codemod to replace deprecated
tls.createSecurePair()withTLSSocket, addressing DEP0064.tls.createSecurePair()depreciation #127Changes included:
createSecurePair(...)intonew TLSSocket(underlyingSocket, {...}), preservingtls.TLSSocketfor namespace usage.{ createSecurePair }with{ TLSSocket }in CJS/ESM (keeps namespace imports intact).pair→socketwhere applicable.This PR is part of the feature branch
feat/tls-createSecurePair-to-TLSSocket.