fix(chatopenai): honor proxy URL

Author: luochen211

packages/components/nodes/chatmodels/ChatOpenAI/ChatOpenAI.test.ts

@@ -0,0 +1,78 @@
+jest.mock('@langchain/openai', () => ({
+    ChatOpenAI: jest.fn(),
+    ChatOpenAIFields: {}
+}))
+
+jest.mock('undici', () => ({
+    ProxyAgent: jest.fn().mockImplementation((url) => ({ proxyUrl: url }))
+}))
+
+jest.mock('../../../src/utils', () => ({
+    getBaseClasses: jest.fn().mockReturnValue(['BaseChatModel']),
+    getCredentialData: jest.fn(),
+    getCredentialParam: jest.fn(),
+    isReasoningModelOpenAI: jest.fn().mockReturnValue(false)
+}))
+
+jest.mock('../../../src/modelLoader', () => ({
+    MODEL_TYPE: { CHAT: 'chat' },
+    getModels: jest.fn()
+}))
+
+jest.mock('./FlowiseChatOpenAI', () => ({
+    ChatOpenAI: jest.fn().mockImplementation((id, fields) => ({
+        id,
+        fields,
+        setMultiModalOption: jest.fn()
+    }))
+}))
+
+import { ProxyAgent } from 'undici'
+import { getCredentialData, getCredentialParam } from '../../../src/utils'
+
+const { ChatOpenAI } = require('./FlowiseChatOpenAI')
+const { nodeClass: ChatOpenAINode } = require('./ChatOpenAI')
+
+describe('ChatOpenAI node', () => {
+    beforeEach(() => {
+        jest.clearAllMocks()
+    })
+
+    it('passes proxyUrl to the OpenAI client fetch dispatcher', async () => {
+        ;(getCredentialData as jest.Mock).mockResolvedValue({ openAIApiKey: 'sk-test' })
+        ;(getCredentialParam as jest.Mock).mockImplementation((key, credentialData) => credentialData[key])
+
+        const node = new ChatOpenAINode()
+        await node.init(
+            {
+                id: 'chatOpenAI_0',
+                credential: 'cred-1',
+                inputs: {
+                    modelName: 'gpt-4o-mini',
+                    temperature: '0.2',
+                    proxyUrl: 'http://corporate-proxy.example.com:3128',
+                    baseOptions: {
+                        'OpenAI-Beta': 'assistants=v2'
+                    }
+                }
+            },
+            '',
+            {}
+        )
+
+        expect(ProxyAgent).toHaveBeenCalledWith('http://corporate-proxy.example.com:3128')
+        expect(ChatOpenAI).toHaveBeenCalledWith(
+            'chatOpenAI_0',
+            expect.objectContaining({
+                configuration: {
+                    defaultHeaders: {
+                        'OpenAI-Beta': 'assistants=v2'
+                    },
+                    fetchOptions: {
+                        dispatcher: { proxyUrl: 'http://corporate-proxy.example.com:3128' }
+                    }
+                }
+            })
+        )
+    })
+})

packages/components/nodes/chatmodels/ChatOpenAI/ChatOpenAI.ts

@@ -5,6 +5,7 @@ import { getBaseClasses, getCredentialData, getCredentialParam, isReasoningModel
 import { ChatOpenAI } from './FlowiseChatOpenAI'
 import { getModels, MODEL_TYPE } from '../../../src/modelLoader'
 import { OpenAI as OpenAIClient } from 'openai'
+import { ProxyAgent } from 'undici'
 
 class ChatOpenAI_ChatModels implements INode {
     label: string
@@ -200,6 +201,14 @@ class ChatOpenAI_ChatModels implements INode {
                 description: 'Override the default base URL for the API, e.g., "https://api.example.com/v2/',
                 additionalParams: true
             },
+            {
+                label: 'Proxy Url',
+                name: 'proxyUrl',
+                type: 'string',
+                optional: true,
+                description: 'Proxy URL to use for OpenAI API requests, e.g., "http://proxy.example.com:3128"',
+                additionalParams: true
+            },
             {
                 label: 'Base Options',
                 name: 'baseOptions',
@@ -230,6 +239,7 @@ class ChatOpenAI_ChatModels implements INode {
         const streaming = nodeData.inputs?.streaming as boolean
         const strictToolCalling = nodeData.inputs?.strictToolCalling as boolean
         const basePath = nodeData.inputs?.basepath as string
+        const proxyUrl = nodeData.inputs?.proxyUrl as string
         const baseOptions = nodeData.inputs?.baseOptions
         const reasoningEffort = nodeData.inputs?.reasoningEffort as OpenAIClient.ReasoningEffort | null
         const reasoningSummary = nodeData.inputs?.reasoningSummary as 'auto' | 'concise' | 'detailed' | null
@@ -286,10 +296,17 @@ class ChatOpenAI_ChatModels implements INode {
             }
         }
 
-        if (basePath || parsedBaseOptions) {
+        if (basePath || parsedBaseOptions || proxyUrl) {
             obj.configuration = {
                 baseURL: basePath,
-                defaultHeaders: parsedBaseOptions
+                defaultHeaders: parsedBaseOptions,
+                ...(proxyUrl
+                    ? {
+                          fetchOptions: {
+                              dispatcher: new ProxyAgent(proxyUrl)
+                          }
+                      }
+                    : {})
             }
         }
 

packages/components/package.json

@@ -179,6 +179,7 @@
         "srt-parser-2": "^1.2.3",
         "supergateway": "3.0.1",
         "typeorm": "^0.3.6",
+        "undici": "6.23.0",
         "uuid": "^10.0.0",
         "vm2": "3.11.2",
         "weaviate-client": "3.12.0",