feat(http-classes-with-new): add codemod for node:http classes instantiation with new keyword (#179)

Co-authored-by: Augustin Mauroy <[email protected]>
Co-authored-by: Bruno Rodrigues <[email protected]>
Co-authored-by: Jacob Smith <[email protected]>

Author: 4 people

package-lock.json

@@ -0,0 +1,33 @@
+# `http.request` DEP0195
+
+This recipe provides a guide for migrating from the deprecated `http.request` and its synchronous and promise-based counterparts to the new `http.request` method in Node.js.
+
+See [DEP0195](https://nodejs.org/api/deprecations.html#DEP0195).
+
+## Examples
+
+**Before:**
+
+```js
+// import { IncomingMessage, ClientRequest } from "node:http";
+// const http = require("node:http");
+
+const message = http.OutgoingMessage();
+const response = http.ServerResponse(socket);
+
+const incoming = IncomingMessage(socket);
+const request = ClientRequest(options);
+```
+
+**After:**
+
+```js
+// import { IncomingMessage, ClientRequest } from "node:http";
+// const http = require("node:http");
+
+const message = new http.OutgoingMessage();
+const response = new http.ServerResponse(socket);
+
+const incoming = new IncomingMessage(socket);
+const request = new ClientRequest(options);
+```

recipes/http-classes-with-new/README.md

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: "@nodejs/http-classes-with-new"
+version: 1.0.0
+description: "Handle DEDEP0195: Instantiating node:http classes without new"
+author: Usman S.
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/http-classes-with-new/codemod.yaml

@@ -0,0 +1,24 @@
+{
+  "name": "@nodejs/http-classes-with-new",
+  "version": "1.0.0",
+  "description": "Handle DEP0195: Instantiating node:http classes without new.",
+  "type": "module",
+  "scripts": {
+    "test": "npx codemod jssg test -l typescript ./src/workflow.ts ./"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nodejs/userland-migrations.git",
+    "directory": "recipes/http-classes-with-new",
+    "bugs": "https://github.com/nodejs/userland-migrations/issues"
+  },
+  "author": "Usman S.",
+  "license": "MIT",
+  "homepage": "https://github.com/nodejs/userland-migrations/blob/main/recipes/http-classes-with-new/README.md",
+  "devDependencies": {
+    "@codemod.com/jssg-types": "^1.0.3"
+  },
+  "dependencies": {
+    "@nodejs/codemod-utils": "*"
+  }
+}

recipes/http-classes-with-new/package.json

@@ -0,0 +1,71 @@
+import { getNodeImportStatements } from '@nodejs/codemod-utils/ast-grep/import-statement';
+import { getNodeRequireCalls } from '@nodejs/codemod-utils/ast-grep/require-call';
+import { resolveBindingPath } from '@nodejs/codemod-utils/ast-grep/resolve-binding-path';
+import type { SgRoot, Edit, SgNode } from '@codemod.com/jssg-types/main';
+
+/**
+ * Classes of the http module
+ */
+const CLASS_NAMES = [
+	'Agent',
+	'ClientRequest',
+	'IncomingMessage',
+	'OutgoingMessage',
+	'Server',
+	'ServerResponse',
+];
+
+/**
+ * Transform function that converts deprecated node:http classes to use the `new` keyword
+ *
+ * Handles:
+ * 1. `http.Agent()` → `new http.Agent()`
+ * 2. `http.ClientRequest()` → `new http.ClientRequest()`
+ * 3. `http.IncomingMessage()` → `new http.IncomingMessage()`
+ * 4. `http.OutgoingMessage()` → `new http.OutgoingMessage()`
+ * 5. `http.Server()` → `new http.Server()`
+ * 6. `http.ServerResponse() → `new http.ServerResponse()`
+ */
+export default function transform(root: SgRoot): string | null {
+	const rootNode = root.root();
+	const edits: Edit[] = [];
+
+	const importNodes = getNodeImportStatements(root, 'http');
+	const requireNodes = getNodeRequireCalls(root, 'http');
+	const allStatementNodes = [...importNodes, ...requireNodes];
+	const classes = new Set<string>(getHttpClassBasePaths(allStatementNodes));
+
+	for (const cls of classes) {
+		const classesWithoutNew = rootNode.findAll({
+			rule: {
+				not: { follows: { pattern: 'new' } },
+				pattern: `${cls}($$$ARGS)`,
+			},
+		});
+
+		for (const clsWithoutNew of classesWithoutNew) {
+			edits.push(clsWithoutNew.replace(`new ${clsWithoutNew.text()}`));
+		}
+	}
+
+	if (edits.length === 0) return null;
+
+	return rootNode.commitEdits(edits);
+}
+
+/**
+ * Get the base path of the http classes
+ *
+ * @param statements - The import & require statements to search for the http classes
+ * @returns The base path of the http classes
+ */
+function* getHttpClassBasePaths(statements: SgNode[]) {
+	for (const cls of CLASS_NAMES) {
+		for (const stmt of statements) {
+			const resolvedPath = resolveBindingPath(stmt, `$.${cls}`);
+			if (resolvedPath) {
+				yield resolvedPath;
+			}
+		}
+	}
+}

recipes/http-classes-with-new/src/workflow.ts

@@ -0,0 +1,8 @@
+const http = require("node:http");
+
+const agent = new http.Agent();
+const request = new http.ClientRequest(options);
+const incoming = new http.IncomingMessage(socket);
+const message = new http.OutgoingMessage();
+const server = new http.Server();
+const response = new http.ServerResponse(socket);

recipes/http-classes-with-new/tests/expected/file-1.js

@@ -0,0 +1,15 @@
+import {
+	Agent,
+	ClientRequest,
+	IncomingMessage,
+	OutgoingMessage,
+	Server,
+	ServerResponse,
+} from "node:http";
+
+const agent = new Agent();
+const request = new ClientRequest(options);
+const incoming = new IncomingMessage(socket);
+const message = new OutgoingMessage();
+const server = new Server();
+const response = new ServerResponse(socket);

recipes/http-classes-with-new/tests/expected/file-2.js

@@ -0,0 +1,8 @@
+const http = require("node:http");
+
+const agent = http.Agent();
+const request = http.ClientRequest(options);
+const incoming = http.IncomingMessage(socket);
+const message = http.OutgoingMessage();
+const server = http.Server();
+const response = http.ServerResponse(socket);

recipes/http-classes-with-new/tests/input/file-1.js

@@ -0,0 +1,15 @@
+import {
+	Agent,
+	ClientRequest,
+	IncomingMessage,
+	OutgoingMessage,
+	Server,
+	ServerResponse,
+} from "node:http";
+
+const agent = Agent();
+const request = ClientRequest(options);
+const incoming = IncomingMessage(socket);
+const message = OutgoingMessage();
+const server = Server();
+const response = ServerResponse(socket);

recipes/http-classes-with-new/tests/input/file-2.js

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "allowImportingTsExtensions": true,
+    "allowJs": true,
+    "alwaysStrict": true,
+    "baseUrl": "./",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "lib": ["ESNext", "DOM"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noImplicitThis": true,
+    "removeComments": true,
+    "strict": true,
+    "stripInternal": true,
+    "target": "esnext"
+  },
+  "include": ["./"],
+  "exclude": [
+    "tests/**"
+  ]
+}