[packaging-common] Add ability to pass request timeouts to node-api and typed-rest-client (#398)

* Add ability to pass request timeouts to packaging-common

* Fix null dereferencing

---------

Co-authored-by: v-levockina <undefined>

Author: aleksandrlevochkin

common-npm-packages/packaging-common/locationUtilities.ts

@@ -4,6 +4,7 @@ import * as interfaces from 'azure-devops-node-api/interfaces/common/VSSInterfac
 import * as tl from 'azure-pipelines-task-lib/task';
 import { IRequestOptions } from 'azure-devops-node-api/interfaces/common/VsoBaseInterfaces';
 import * as provenance from "./provenance";
+import { RequestOptions } from './universal/RequestUtilities';
 
 tl.setResourcePath(path.join(__dirname, 'module.json'), true);
 
@@ -29,13 +30,17 @@ export interface PackagingLocation {
 }
 
 // Getting service urls from resource areas api
-export async function getServiceUriFromAreaId(serviceUri: string, accessToken: string, areaId: string): Promise<string> {
+export async function getServiceUriFromAreaId(
+    serviceUri: string, 
+    accessToken: string, 
+    areaId: string,
+    webApiOptions?: RequestOptions): Promise<string> {
     const serverType = tl.getVariable('System.ServerType');
     if (!serverType || serverType.toLowerCase() !== 'hosted') {
         return serviceUri;
     }
 
-    const webApi = getWebApiWithProxy(serviceUri, accessToken);
+    const webApi = getWebApiWithProxy(serviceUri, accessToken, webApiOptions);
     const locationApi = await webApi.getLocationsApi();
 
     tl.debug(`Getting URI for area ID ${areaId} from ${serviceUri}`);
@@ -70,7 +75,7 @@ export async function getBlobstoreUriFromBaseServiceUri(serviceUri: string, acce
  *  The second URI, if existent, will be Packaging's default access point
  *  The remaining URI's will be alternate Packaging's access points
  */
-export async function getPackagingUris(protocolType: ProtocolType): Promise<PackagingLocation> {
+export async function getPackagingUris(protocolType: ProtocolType, webApiOptions?: RequestOptions): Promise<PackagingLocation> {
     tl.debug('Getting Packaging service access points');
     const collectionUrl = tl.getVariable('System.TeamFoundationCollectionUri');
 
@@ -90,7 +95,7 @@ export async function getPackagingUris(protocolType: ProtocolType): Promise<Pack
     const serviceUri = await getServiceUriFromAreaId(collectionUrl, accessToken, areaId);
     tl.debug(`Found serviceUri: ${serviceUri}`);
 
-    const webApi = getWebApiWithProxy(serviceUri);
+    const webApi = getWebApiWithProxy(serviceUri, accessToken, webApiOptions);
     const locationApi = await webApi.getLocationsApi();
 
     tl.debug('Acquiring Packaging endpoints...');
@@ -140,7 +145,7 @@ function getAreaIdForProtocol(protocolType: ProtocolType): string {
     }
 }
 
-export function getWebApiWithProxy(serviceUri: string, accessToken?: string): vsts.WebApi {
+export function getWebApiWithProxy(serviceUri: string, accessToken?: string, webApiOptions?: RequestOptions): vsts.WebApi {
     if (!accessToken) {
         accessToken = getSystemAccessToken();
     }
@@ -149,7 +154,9 @@ export function getWebApiWithProxy(serviceUri: string, accessToken?: string): vs
     const options: IRequestOptions = {
         proxy: tl.getHttpProxyConfiguration(serviceUri),
         allowRetries: true,
-        maxRetries: 5
+        maxRetries: 5,
+        socketTimeout: webApiOptions && webApiOptions.socketTimeout,
+        globalAgentOptions: webApiOptions && webApiOptions.globalAgentOptions
     };
     const webApi = new vsts.WebApi(serviceUri, credentialHandler, options);
     tl.debug(`Created webApi client for ${serviceUri}; options: ${JSON.stringify(options)}`);
@@ -210,7 +217,8 @@ export async function getFeedRegistryUrl(
     feedId: string,
     project: string,
     accessToken?: string,
-    useSession?: boolean): Promise<string> {
+    useSession?: boolean,
+    webApiOptions?: RequestOptions): Promise<string> {
     let loc : RegistryLocation;
     switch (registryType) {
         case RegistryType.npm:
@@ -253,7 +261,7 @@ export async function getFeedRegistryUrl(
 
     tl.debug("Getting registry url from " + packagingUrl);
 
-    const vssConnection = getWebApiWithProxy(packagingUrl, accessToken);
+    const vssConnection = getWebApiWithProxy(packagingUrl, accessToken, webApiOptions);
 
     let sessionId = feedId;
     if (useSession) {

common-npm-packages/packaging-common/npm/npmregistry.ts

@@ -7,6 +7,7 @@ import { IHeaders, IRequestOptions } from 'typed-rest-client/Interfaces';
 import { NormalizeRegistry } from './npmrcparser';
 import * as util from '../util';
 import * as locationUtil from '../locationUtilities';
+import { RequestOptions } from '../universal/RequestUtilities';
 
 export interface INpmRegistry {
     url: string;
@@ -26,7 +27,7 @@ export class NpmRegistry implements INpmRegistry {
     }
 
     /** Return NpmRegistry with masked auth from Service Endpoint. */
-    public static async FromServiceEndpoint(endpointId: string, authOnly?: boolean): Promise<NpmRegistry> {
+    public static async FromServiceEndpoint(endpointId: string, authOnly?: boolean, requestOptions?: RequestOptions): Promise<NpmRegistry> {
         const lineEnd = os.EOL;
         let endpointAuth: tl.EndpointAuthorization;
         let url: string;
@@ -48,7 +49,7 @@ export class NpmRegistry implements INpmRegistry {
 
             // To the reader, this could be optimized here but it is broken out for readability
             if (endpointAuth.scheme === 'Token') {
-                isVstsTokenAuth = await NpmRegistry.isEndpointInternal(url);
+                isVstsTokenAuth = await NpmRegistry.isEndpointInternal(url, requestOptions);
             }
             nerfed = util.toNerfDart(url);
         } catch (exception) {
@@ -93,20 +94,27 @@ export class NpmRegistry implements INpmRegistry {
 
     // make a request to the endpoint uri, and take a look at the response header to
     // determine whether this is our service, or an external service.
-    private static async isEndpointInternal(endpointUri: string): Promise<boolean> {
-        let requestOptions: IRequestOptions;
+    private static async isEndpointInternal(endpointUri: string, requestOptions?: RequestOptions): Promise<boolean> {
+        let options: IRequestOptions;
         try {
             const proxy = tl.getHttpProxyConfiguration();
-            requestOptions = proxy ? { proxy } : {};
+            options = proxy ? { 
+                proxy,
+                socketTimeout: requestOptions && requestOptions.socketTimeout,
+                globalAgentOptions: requestOptions && requestOptions.globalAgentOptions
+            } : {};
         } catch (error) {
             tl.debug('unable to determine proxy configuration: ' + error);
-            requestOptions = {};
+            options = { 
+                socketTimeout: requestOptions && requestOptions.socketTimeout,
+                globalAgentOptions: requestOptions && requestOptions.globalAgentOptions
+            };
         }
 
         const headers: IHeaders = {};
         headers['X-TFS-FedAuthRedirect'] = 'Suppress';
 
-        const endpointClient = new HttpClient(tl.getVariable('AZURE_HTTP_USER_AGENT'), null, requestOptions);
+        const endpointClient = new HttpClient(tl.getVariable('AZURE_HTTP_USER_AGENT'), null, options);
         try {
             const resp = await endpointClient.get(endpointUri, headers);
 

common-npm-packages/packaging-common/nuget/NuGetToolGetter.ts

@@ -9,6 +9,7 @@ import * as os from "os";
 import {VersionInfo} from "../pe-parser/VersionResource";
 import * as peParser from "../pe-parser";
 import { getVersionFallback } from './ProductVersionHelper';
+import { RequestOptions } from '../universal/RequestUtilities';
 
 interface INuGetTools {
     nugetexe: INuGetVersionInfo[]
@@ -38,7 +39,11 @@ export const DEFAULT_NUGET_VERSION: string = '4.9.6';
 export const DEFAULT_NUGET_PATH_SUFFIX: string = 'NuGet/4.9.6/';
 export const NUGET_EXE_TOOL_PATH_ENV_VAR: string = 'NuGetExeToolPath';
 
-export async function getNuGet(versionSpec: string, checkLatest?: boolean, addNuGetToPath?: boolean): Promise<string> {
+export async function getNuGet(
+    versionSpec: string, 
+    checkLatest?: boolean, 
+    addNuGetToPath?: boolean,
+    requestOptions?: RequestOptions): Promise<string> {
     if (toolLib.isExplicitVersion(versionSpec)) {
         // Check latest doesn't make sense when explicit version
         checkLatest = false;
@@ -64,7 +69,7 @@ export async function getNuGet(versionSpec: string, checkLatest?: boolean, addNu
         console.log(taskLib.loc("Info_ResolvedToolFromCache", version));
     }
     else {
-        let versionInfo: INuGetVersionInfo = await getLatestMatchVersionInfo(versionSpec);
+        let versionInfo: INuGetVersionInfo = await getLatestMatchVersionInfo(versionSpec, requestOptions);
 
         // There is a local version which matches the spec yet we found one on dist.nuget.org
         // which is different, so we're about to change the version which was used
@@ -234,12 +239,14 @@ function GetRestClientOptions(): restm.IRequestOptions
     return options;
 }
 
-async function getLatestMatchVersionInfo(versionSpec: string): Promise<INuGetVersionInfo> {
+async function getLatestMatchVersionInfo(versionSpec: string, requestOptions?: RequestOptions): Promise<INuGetVersionInfo> {
     taskLib.debug('Querying versions list');
 
     let versionsUrl = 'https://dist.nuget.org/tools.json';
     let proxyRequestOptions = {
-        proxy: taskLib.getHttpProxyConfiguration(versionsUrl)
+        proxy: taskLib.getHttpProxyConfiguration(versionsUrl),
+        socketTimeout: requestOptions && requestOptions.socketTimeout,
+        globalAgentOptions: requestOptions && requestOptions.globalAgentOptions
     };
     let rest: restm.RestClient = new restm.RestClient('vsts-tasks/NuGetToolInstaller', undefined, undefined, proxyRequestOptions);