add unsuported api

Author: AugustinMauroy

recipes/axios-to-whatwg-fetch/src/workflow.ts

@@ -65,6 +65,25 @@ const warnWithLocation = (
 	console.warn(`[Codemod] ${message} (at ${location})`);
 };
 
+const UNSUPPORTED_CONFIG_OPTIONS = [
+	'transformRequest',
+	'transformResponse',
+	'paramsSerializer',
+	'withCredentials',
+	'timeout',
+	'httpAgent',
+	'httpsAgent',
+	'validateStatus',
+	'maxRedirects',
+	'socketPath',
+	'decompress',
+	'maxContentLength',
+	'maxBodyLength',
+	'beforeRedirect',
+	'cancelToken',
+	'signal',
+];
+
 const getObjectPropertyValue = (
 	objectNode: SgNode<Js>,
 	propertyName: string,
@@ -84,6 +103,23 @@ const getObjectPropertyValue = (
 	return pair?.field('value');
 };
 
+const hasUnsupportedOptions = (
+	configNode: SgNode<Js> | undefined,
+): { unsupported: boolean; optionName?: string } => {
+	if (!configNode || configNode.kind() !== 'object') {
+		return { unsupported: false };
+	}
+
+	for (const optionName of UNSUPPORTED_CONFIG_OPTIONS) {
+		const option = getObjectPropertyValue(configNode, optionName);
+		if (option) {
+			return { unsupported: true, optionName };
+		}
+	}
+
+	return { unsupported: false };
+};
+
 const getBodyExpression = (
 	bodyNode: SgNode<Js>,
 	payloadKind: NonNullable<CreateOptionsType['payloadKind']>,
@@ -357,6 +393,68 @@ const createOptions = ({
 	return `{${EOL}${optionParts.join(`,${EOL}`)}${EOL}}`;
 };
 
+/**
+ * Checks if any axios calls in the file use unsupported configuration options.
+ * If found, logs a warning and returns true to indicate the file should be skipped.
+ */
+const checkForUnsupportedOptions = (
+	rootNode: SgNode<Js>,
+	bindsToReplace: BindingToReplace[],
+	root: SgRoot<Js>,
+): boolean => {
+	for (const bind of bindsToReplace) {
+		const matches = rootNode.findAll({
+			rule: bind.rule,
+		});
+
+		for (const match of matches) {
+			const argsAndCommaas = match.getMultipleMatches('ARG');
+			const args = argsAndCommaas.filter((arg) => arg.text() !== ',');
+
+			// Check axios.request() - first arg should be config object
+			if (bind.binding.endsWith('.request')) {
+				const config = args[0];
+				const unsupported = hasUnsupportedOptions(config);
+				if (unsupported.unsupported) {
+					warnWithLocation(
+						{ root, match },
+						`Unsupported axios configuration option '${unsupported.optionName}' detected in axios.request. Skipping migration to preserve functionality.`,
+						config,
+					);
+					return true;
+				}
+			} else {
+				// For other methods (get, post, put, patch, delete, head, options)
+				// Determine option index based on method
+				let optionIndex = 1;
+				if (
+					bind.binding.endsWith('.post') ||
+					bind.binding.endsWith('.put') ||
+					bind.binding.endsWith('.patch') ||
+					bind.binding.endsWith('.postForm') ||
+					bind.binding.endsWith('.putForm') ||
+					bind.binding.endsWith('.patchForm')
+				) {
+					optionIndex = 2;
+				}
+
+				const config = args[optionIndex];
+				const unsupported = hasUnsupportedOptions(config);
+				if (unsupported.unsupported) {
+					const methodName = bind.binding.split('.').pop();
+					warnWithLocation(
+						{ root, match },
+						`Unsupported axios configuration option '${unsupported.optionName}' detected in axios.${methodName}. Skipping migration to preserve functionality.`,
+						config,
+					);
+					return true;
+				}
+			}
+		}
+	}
+	return false;
+};
+
 /**
  * Transforms the AST root by replacing axios bindings with Fetch API calls.
  *
@@ -390,6 +488,11 @@ export default function transform(root: SgRoot<Js>): string | null {
 		}
 	}
 
+	// Check for unsupported options before making any changes
+	if (checkForUnsupportedOptions(rootNode, bindsToReplace, root)) {
+		return null;
+	}
+
 	for (const bind of bindsToReplace) {
 		const matches = rootNode.findAll({
 			rule: bind.rule,

recipes/axios-to-whatwg-fetch/tests/expected/mixed-migratable-unmigratable.js

@@ -0,0 +1,11 @@
+import axios from 'axios';
+
+// This should be migratable
+const todos = await axios.get('https://api.example.com/todos');
+
+// But this one has unsupported transformRequest, so entire file should be skipped
+const data = await axios.post('https://api.example.com/data', { foo: 'bar' }, {
+    transformRequest: [(data) => JSON.stringify(data)],
+});
+
+console.log(todos, data);

recipes/axios-to-whatwg-fetch/tests/expected/mixed-with-axios-request.js

@@ -0,0 +1,14 @@
+import axios from 'axios';
+
+const response = await axios.get('https://api.example.com/items', {
+    headers: { 'Authorization': 'Bearer token' },
+});
+
+const created = await axios.request({
+    url: 'https://api.example.com/create',
+    method: 'POST',
+    data: { item: 'test' },
+    validateStatus: (status) => status < 500,
+});
+
+console.log(response, created);

recipes/axios-to-whatwg-fetch/tests/expected/multiple-migratable-with-unsupported.js

@@ -0,0 +1,12 @@
+import axios from 'axios';
+
+// These are all migratable
+const users = await axios.get('https://api.example.com/users');
+const posts = await axios.get('https://api.example.com/posts');
+
+// But this has unsupported timeout, so entire file is skipped
+const special = await axios.post('https://api.example.com/special', { data: 'test' }, {
+    timeout: 5000,
+});
+
+console.log(users, posts, special);

recipes/axios-to-whatwg-fetch/tests/expected/unsupported-axios-request-config.js

@@ -0,0 +1,9 @@
+import axios from 'axios';
+
+const response = await axios.request({
+    url: 'https://api.example.com/data',
+    method: 'POST',
+    data: { foo: 'bar' },
+    transformRequest: [(data) => data],
+    transformResponse: [(data) => data],
+});

recipes/axios-to-whatwg-fetch/tests/expected/unsupported-params-serializer.js

@@ -0,0 +1,8 @@
+import axios from 'axios';
+
+const response = await axios.get('https://api.example.com/data', {
+    params: { foo: 'bar' },
+    paramsSerializer: (params) => {
+        return Object.entries(params).map(([k, v]) => `${k}=${v}`).join('&');
+    },
+});

recipes/axios-to-whatwg-fetch/tests/expected/unsupported-transform-request.js

@@ -0,0 +1,7 @@
+import axios from 'axios';
+
+const response = await axios.post('https://api.example.com/data', { foo: 'bar' }, {
+    transformRequest: [(data) => {
+        return JSON.stringify(data);
+    }],
+});

recipes/axios-to-whatwg-fetch/tests/expected/unsupported-transform-response.js

@@ -0,0 +1,7 @@
+import axios from 'axios';
+
+const response = await axios.get('https://api.example.com/data', {
+    transformResponse: [(data) => {
+        return { transformed: data };
+    }],
+});

recipes/axios-to-whatwg-fetch/tests/input/mixed-migratable-unmigratable.js

@@ -0,0 +1,11 @@
+import axios from 'axios';
+
+// This should be migratable
+const todos = await axios.get('https://api.example.com/todos');
+
+// But this one has unsupported transformRequest, so entire file should be skipped
+const data = await axios.post('https://api.example.com/data', { foo: 'bar' }, {
+	transformRequest: [(data) => JSON.stringify(data)],
+});
+
+console.log(todos, data);

recipes/axios-to-whatwg-fetch/tests/input/mixed-with-axios-request.js

@@ -0,0 +1,14 @@
+import axios from 'axios';
+
+const response = await axios.get('https://api.example.com/items', {
+	headers: { 'Authorization': 'Bearer token' },
+});
+
+const created = await axios.request({
+	url: 'https://api.example.com/create',
+	method: 'POST',
+	data: { item: 'test' },
+	validateStatus: (status) => status < 500,
+});
+
+console.log(response, created);