feat(dts-plugin): add IPV6 property to DTS Plugin

.changeset/odd-toys-sin.md

@@ -0,0 +1,6 @@
+---
+'@module-federation/dts-plugin': minor
+'@module-federation/sdk': minor
+---
+
+Added ipv6 property to DTS consume types options

packages/dts-plugin/src/core/configurations/hostPlugin.test.ts

@@ -3,6 +3,7 @@ import path from 'path';
 
 import { retrieveHostConfig } from './hostPlugin';
 import { retrieveTypesArchiveDestinationPath } from '../lib/archiveHandler';
+import { moduleFederationPlugin } from '@module-federation/sdk/.';
 
 describe('hostPlugin', () => {
   const moduleFederationConfig = {
@@ -41,6 +42,8 @@ describe('hostPlugin', () => {
           abortOnError: true,
           consumeAPITypes: false,
           runtimePkgs: [],
+          ipVersion:
+            'ipv4' as moduleFederationPlugin.DtsHostOptions['ipVersion'],
         });
 
         expect(mapRemotesToDownload).toStrictEqual({
@@ -66,6 +69,8 @@ describe('hostPlugin', () => {
           abortOnError: true,
           consumeAPITypes: false,
           runtimePkgs: [],
+          ipVersion:
+            'ipv4' as moduleFederationPlugin.DtsHostOptions['ipVersion'],
         };
 
         const { hostOptions, mapRemotesToDownload } =

packages/dts-plugin/src/core/configurations/hostPlugin.ts

@@ -18,6 +18,7 @@ const defaultOptions = {
   abortOnError: true,
   consumeAPITypes: false,
   runtimePkgs: [],
+  ipVersion: 'ipv4',
 } satisfies Partial<HostOptions>;
 
 const buildZipUrl = (hostOptions: Required<HostOptions>, url: string) => {

packages/dts-plugin/src/core/lib/DTSManager.ts

@@ -28,8 +28,14 @@ import {
   HOST_API_TYPES_FILE_NAME,
 } from '../constant';
 import { fileLog, logger } from '../../server';
-import { axiosGet, cloneDeepOptions, isDebugMode } from './utils';
+import {
+  axiosGet,
+  cloneDeepOptions,
+  isDebugMode,
+  getIpFamilyFromConfig,
+} from './utils';
 import { UpdateMode } from '../../server/constant';
+import { ModuleFederationPluginOptions } from '@module-federation/sdk/dist/src/types/plugins/ModuleFederationPlugin';
 
 export const MODULE_DTS_MANAGER_IDENTIFIER = 'MF DTS Manager';
 
@@ -180,8 +186,13 @@ class DTSManager {
       if (!remoteInfo.url.includes(MANIFEST_EXT)) {
         return remoteInfo as Required<RemoteInfo>;
       }
+
       const url = remoteInfo.url;
-      const res = await axiosGet(url);
+      const res = await axiosGet(url, {
+        family: getIpFamilyFromConfig(
+          this.options.host?.moduleFederationConfig,
+        ),
+      });
       const manifestJson = res.data as unknown as Manifest;
       if (!manifestJson.metaData.types.zip) {
         throw new Error(`Can not get ${remoteInfo.name}'s types archive url!`);
@@ -254,7 +265,11 @@ class DTSManager {
     }
     try {
       const url = apiTypeUrl;
-      const res = await axiosGet(url);
+      const res = await axiosGet(url, {
+        family: getIpFamilyFromConfig(
+          this.options.host?.moduleFederationConfig,
+        ),
+      });
       let apiTypeFile = res.data as string;
       apiTypeFile = apiTypeFile.replaceAll(
         REMOTE_ALIAS_IDENTIFIER,

packages/dts-plugin/src/core/lib/archiveHandler.ts

@@ -6,7 +6,7 @@ import { HostOptions } from '../interfaces/HostOptions';
 import { RemoteOptions } from '../interfaces/RemoteOptions';
 import { retrieveMfTypesPath } from './typeScriptCompiler';
 import { fileLog } from '../../server';
-import { axiosGet } from './utils';
+import { axiosGet, getIpFamilyFromConfig } from './utils';
 import { TsConfigJson } from '../interfaces/TsConfigJson';
 
 export const retrieveTypesZipPath = (
@@ -62,6 +62,7 @@ export const downloadTypesArchive = (hostOptions: Required<HostOptions>) => {
         const url = fileToDownload;
         const response = await axiosGet(url, {
           responseType: 'arraybuffer',
+          family: getIpFamilyFromConfig(hostOptions.moduleFederationConfig),
         }).catch(downloadErrorLogger(destinationFolder, url));
 
         try {

packages/dts-plugin/src/core/lib/utils.spec.ts

@@ -17,3 +17,13 @@ it('axiosGet should use agents with family set to 4', async () => {
 
   httpSpy.mockRestore();
 });
+
+it('axiosGet should use agents with family set to 6', async () => {
+  const httpSpy = vi.spyOn(http, 'Agent');
+
+  await axiosGet('http://localhost', { family: 6 });
+
+  expect(httpSpy).toHaveBeenCalledWith({ family: 6 });
+
+  httpSpy.mockRestore();
+});

packages/dts-plugin/src/core/lib/utils.ts

@@ -132,8 +132,28 @@ export function cloneDeepOptions(options: DTSManagerOptions) {
   });
 }
 
+/**
+ * Extracts IP version from Module Federation plugin configuration
+ * Defaults to 'ipv4' if not specified
+ */
+export function getIpFamilyFromConfig(
+  config: moduleFederationPlugin.ModuleFederationPluginOptions,
+): AxiosRequestConfig['family'] {
+  if (!config) return 4;
+
+  const { dts } = config;
+  if (dts && typeof dts === 'object' && dts !== null) {
+    const { consumeTypes } = dts;
+    if (typeof consumeTypes === 'object' && consumeTypes !== null) {
+      return consumeTypes.ipVersion === 'ipv6' ? 6 : 4;
+    }
+  }
+
+  return 4;
+}
+
 export async function axiosGet(url: string, config?: AxiosRequestConfig) {
-  const httpAgent = new http.Agent({ family: 4 });
-  const httpsAgent = new https.Agent({ family: 4 });
+  const httpAgent = new http.Agent({ family: config?.family ?? 4 });
+  const httpsAgent = new https.Agent({ family: config?.family ?? 4 });
   return axios.get(url, { httpAgent, httpsAgent, ...config });
 }

packages/sdk/src/types/plugins/ModuleFederationPlugin.ts

@@ -144,6 +144,7 @@ export interface DtsHostOptions {
   maxRetries?: number;
   consumeAPITypes?: boolean;
   runtimePkgs?: string[];
+  ipVersion?: 'ipv4' | 'ipv6';
 }
 
 export interface DtsRemoteOptions {