ProxySettings.port ignored

[drizzd]

• Package Name: @azure/core-rest-pipeline
• Package Version: 1.15.0
• Operating system: Ubuntu
• nodejs
  • version: 18
• browser
  • name/version:
• typescript
  • version: 5.4.2
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://docs.microsoft.com

Describe the bug
In commit ba2f5e6 the ProxyPolicy was refactored between 1.14.0 and 1.15.0. In 1.14.0, ProxySettings.port is added to HttpsProxyAgentOptions. Since 1.15.0, only the ProxySettings.host is used. ProxySettings.port is not used.

To Reproduce
Steps to reproduce the behavior:

Run the following code with @azure/core-rest-pipeline version 1.15.0 or later.

import { PipelineRequest, createDefaultHttpClient } from '@azure/core-rest-pipeline';
import { CommonClientOptions } from '@azure/core-client';
import { DefaultAzureCredential } from '@azure/identity';
import { ContainerRegistryManagementClient } from '@azure/arm-containerregistry';

async function main() {
    const httpClient = createDefaultHttpClient();
    const clientOptions: CommonClientOptions = {
        proxyOptions: {
            host: 'http://proxy.example.com',
            port: 8080,
        },
        httpClient: {
            sendRequest: async (request: PipelineRequest) => {
                console.log('request', request);
                return httpClient.sendRequest(request);
            }
        }
    };
    const credential = new DefaultAzureCredential(
        clientOptions,
    );
    const subscriptionId = "00000000-0000-0000-0000-000000000000";
    const client = new ContainerRegistryManagementClient(
        credential,
        subscriptionId,
        clientOptions,
    );
    console.log('list registries...');
    for await (const registry of client.registries.list()) {
        console.log(`registry: ${JSON.stringify(registry)}`);
    }
}

main();

The request object will be logged, indicating that the HttpsProxyAgent does not have port 8080 configured:

[...]
  agent: HttpsProxyAgent {
    [...]
    proxy: URL {
      href: 'http://proxy.example.com/',
      origin: 'http://proxy.example.com',
      protocol: 'http:',
      username: '',
      password: '',
      host: 'proxy.example.com',
      hostname: 'proxy.example.com',
      port: '',
      pathname: '/',
      search: '',
      searchParams: URLSearchParams {},
      hash: ''
    },
    proxyHeaders: {
      'content-type': 'application/x-www-form-urlencoded;charset=utf-8'
    },
    connectOpts: {
      ALPNProtocols: [Array],
      host: 'proxy.example.com',
      port: 80
    },
[...]

Expected behavior
HttpsProxyAgent has port 8080 configured:

[...]
  agent: HttpsProxyAgent {
    [...]
    proxy: {
      hostname: 'proxy.example.com',
      port: 8080,
      protocol: 'http:',
      headers: [Object],
      host: 'proxy.example.com'
    },
[...]

[xirzec]

@drizzd Thanks for the report! I have a PR out to address this and will work on getting it released soon.

[xirzec]

@drizzd this fix should be live now, please give it a try and let me know if you're still having issues.

[drizzd]

This works for me as of @azure/[email protected]. Thanks!