Logging and error handling for location utils

Tasks/Common/artifacts-common/connectionDataUtils.ts

@@ -79,7 +79,12 @@ async function getServiceUriFromAreaId(areaId: string, accessToken: string): Pro
         return serviceUriFromArea.locationUrl;
     } catch (error) {
         tl.debug(`Failed to obtain the service URI for area ID ${areaId}`);
-        tl.debug(JSON.stringify(error));
+        if (error instanceof Error) {
+            if (error.message) { tl.debug(error.message); }
+            if (error.stack) { tl.debug(error.stack); }
+        } else {
+            tl.debug(error);
+        }
         throw error;
     }
 }

Tasks/Common/artifacts-common/retryUtils.ts

@@ -11,7 +11,12 @@ export async function retryOnException<T>(action: () => Promise<T>, maxTries: nu
                 throw error;
             }
             tl.debug(`Attempt failed. Number of tries left: ${maxTries}`);
-            tl.debug(JSON.stringify(error));
+            if (error instanceof Error) {
+                if (error.message) { tl.debug(error.message); }
+                if (error.stack) { tl.debug(error.stack); }
+            } else {
+                tl.debug(error);
+            }
             await delay(retryIntervalInMilliseconds);
         }
     }

Tasks/Common/packaging-common/Strings/resources.resjson/en-US/resources.resjson

@@ -24,6 +24,6 @@
   "loc.messages.NGCommon_SpsNotFound": "Unable to find the '%s' [%s] area. There may be a problem with your Team Foundation Server installation.",
   "loc.messages.NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected.",
   "loc.messages.NGCommon_UnableToFindTool": "Unable to find tool %s",
-  "loc.messages.Warning_SessionCreationFailed": "Could not create provenance session: %s",
+  "loc.messages.Warning_SessionCreationFailed": "Could not create provenance session.",
   "loc.messages.Warning_UpdatingNuGetVersion": "Updating version of NuGet.exe to %s from %s. Behavior changes or breaking changes might occur as NuGet updates to a new version. If this is not desired, uncheck the 'Check for Latest Version' option in the task."
 }

Tasks/Common/packaging-common/locationUtilities.ts

@@ -4,6 +4,7 @@ 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 { logError, LogType } from './util';
 
 export enum ProtocolType {
     NuGet,
@@ -36,12 +37,10 @@ export async function getServiceUriFromAreaId(serviceUri: string, accessToken: s
     const locationApi = await webApi.getLocationsApi();
 
     tl.debug(`Getting URI for area ID ${areaId} from ${serviceUri}`);
-    try {
-        const serviceUriFromArea = await retryOnExceptionHelper(() => locationApi.getResourceArea(areaId), 3, 1000);
-        return serviceUriFromArea.locationUrl;
-    } catch (error) {
-        throw new Error(error);
-    }
+    const resourceArea = await retryOnExceptionHelper(() => locationApi.getResourceArea(areaId), 3, 1000);
+    tl.debug(`Found resource area with locationUrl: ${resourceArea && resourceArea.locationUrl}`);
+
+    return resourceArea.locationUrl;
 }
 
 export async function getNuGetUriFromBaseServiceUri(serviceUri: string, accesstoken: string): Promise<string> {
@@ -87,16 +86,15 @@ export async function getPackagingUris(protocolType: ProtocolType): Promise<Pack
     const areaId = getAreaIdForProtocol(protocolType);
 
     const serviceUri = await getServiceUriFromAreaId(collectionUrl, accessToken, areaId);
+    tl.debug(`Found serviceUri: ${serviceUri}`);
 
     const webApi = getWebApiWithProxy(serviceUri);
-
     const locationApi = await webApi.getLocationsApi();
 
-    tl.debug('Acquiring Packaging endpoints from ' + serviceUri);
-
+    tl.debug('Acquiring Packaging endpoints...');
     const connectionData = await retryOnExceptionHelper(() => locationApi.getConnectionData(interfaces.ConnectOptions.IncludeServices), 3, 1000);
-
     tl.debug('Successfully acquired the connection data');
+
     const defaultAccessPoint: string = connectionData.locationServiceData.accessMappings.find((mapping) =>
         mapping.moniker === connectionData.locationServiceData.defaultAccessMappingMoniker
     ).accessPoint;
@@ -147,7 +145,9 @@ export function getWebApiWithProxy(serviceUri: string, accessToken?: string): vs
         allowRetries: true,
         maxRetries: 5
     };
-    return new vsts.WebApi(serviceUri, credentialHandler, options);
+    const webApi = new vsts.WebApi(serviceUri, credentialHandler, options);
+    tl.debug(`Created webApi client for ${serviceUri}; options: ${JSON.stringify(options)}`);
+    return webApi;
 }
 
 // This function is to apply retries generically for any unreliable network calls
@@ -158,10 +158,10 @@ export async function retryOnExceptionHelper<T>(action: () => Promise<T>, maxTri
         } catch (error) {
             maxTries--;
             if (maxTries < 1) {
-                throw Error(error);
+                throw error;
             }
             tl.debug(`Network call failed. Number of retries left: ${maxTries}`);
-            tl.debug(JSON.stringify(error));
+            if (error) { logError(error, LogType.warning); }
             await delay(retryIntervalInMilliseconds);
         }
     }
@@ -178,8 +178,8 @@ interface RegistryLocation {
 };
 
 export async function getFeedRegistryUrl(
-    packagingUrl: string, 
-    registryType: RegistryType, 
+    packagingUrl: string,
+    registryType: RegistryType,
     feedId: string,
     project: string,
     accessToken?: string,

Tasks/Common/packaging-common/module.json

@@ -25,7 +25,7 @@
         "NGCommon_SpsNotFound": "Unable to find the '%s' [%s] area. There may be a problem with your Team Foundation Server installation.",
         "NGCommon_UnabletoDetectNuGetVersion": "Unknown NuGet version selected.",
         "NGCommon_UnableToFindTool": "Unable to find tool %s",
-        "Warning_SessionCreationFailed": "Could not create provenance session: %s",
+        "Warning_SessionCreationFailed": "Could not create provenance session.",
         "Warning_UpdatingNuGetVersion": "Updating version of NuGet.exe to %s from %s. Behavior changes or breaking changes might occur as NuGet updates to a new version. If this is not desired, uncheck the 'Check for Latest Version' option in the task."
     }
 }

Tasks/Common/packaging-common/provenance.ts

@@ -3,6 +3,7 @@ import * as tl from 'azure-pipelines-task-lib';
 import * as VsoBaseInterfaces from 'azure-devops-node-api/interfaces/common/VsoBaseInterfaces';
 import { ClientVersioningData } from 'azure-devops-node-api/VsoClient';
 import vstsClientBases = require('azure-devops-node-api/ClientApiBases');
+import { logError, LogType } from './util';
 
 import * as restclient from 'typed-rest-client/RestClient';
 
@@ -67,7 +68,8 @@ export class ProvenanceHelper {
                 const session = await prov.createSession(sessionRequest, protocol, project);
                 return session.sessionId;
             } catch (error) {
-                tl.warning(tl.loc("Warning_SessionCreationFailed", JSON.stringify(error)));
+                tl.warning(tl.loc("Warning_SessionCreationFailed"));
+                logError(error, LogType.warning);
             }
         }
         return feedId;

Tasks/Common/packaging-common/util.ts

@@ -82,8 +82,8 @@ export function getProjectAndFeedIdFromInputParam(inputParam: string): any {
 }
 
 export function getProjectAndFeedIdFromInput(feedProject: string): any {
-    var projectId = null;
-    var feedId = feedProject;
+    let projectId = null;
+    let feedId = feedProject;
     if(feedProject && feedProject.includes("/")) {
         const feedProjectParts = feedProject.split("/");
         projectId = feedProjectParts[0] || null;
@@ -95,3 +95,31 @@ export function getProjectAndFeedIdFromInput(feedProject: string): any {
         projectId: projectId
     }
 }
+
+export enum LogType {
+    debug,
+    warning,
+    error
+}
+
+function log(message: string, logType: LogType) {
+    if (logType === LogType.warning) {
+        tl.warning(message);
+    } else if (logType === LogType.error) {
+        tl.error(message);
+    } else {
+        tl.debug(message);
+    }
+}
+
+/**
+ * Logs the error instead of throwing.
+ */
+export function logError(error: any, logType: LogType = LogType.debug) {
+    if (error instanceof Error) {
+        if (error.message) { log(error.message, logType); }
+        if (error.stack) { log(error.stack, LogType.debug); } // Log stack always as debug
+    } else {
+        log(`Error: ${error}`, logType);
+    }
+}

Tasks/DotNetCoreCLIV2/pushcommand.ts

@@ -9,15 +9,15 @@ import { IExecOptions } from 'azure-pipelines-task-lib/toolrunner';
 import { NuGetConfigHelper2 } from 'packaging-common/nuget/NuGetConfigHelper2';
 import * as ngRunner from 'packaging-common/nuget/NuGetToolRunner2';
 import * as pkgLocationUtils from 'packaging-common/locationUtilities';
-import { getProjectAndFeedIdFromInputParam } from 'packaging-common/util';
+import { getProjectAndFeedIdFromInputParam, logError } from 'packaging-common/util';
 
 export async function run(): Promise<void> {
     let packagingLocation: pkgLocationUtils.PackagingLocation;
     try {
         packagingLocation = await pkgLocationUtils.getPackagingUris(pkgLocationUtils.ProtocolType.NuGet);
     } catch (error) {
         tl.debug('Unable to get packaging URIs, using default collection URI');
-        tl.debug(JSON.stringify(error));
+        logError(error);
         const collectionUrl = tl.getVariable('System.TeamFoundationCollectionUri');
         packagingLocation = {
             PackagingUris: [collectionUrl],

Tasks/DotNetCoreCLIV2/restorecommand.ts

@@ -9,15 +9,15 @@ import { IExecOptions } from 'azure-pipelines-task-lib/toolrunner';
 import * as nutil from 'packaging-common/nuget/Utility';
 import * as commandHelper from 'packaging-common/nuget/CommandHelper';
 import * as pkgLocationUtils from 'packaging-common/locationUtilities';
-import { getProjectAndFeedIdFromInputParam } from 'packaging-common/util';
+import { getProjectAndFeedIdFromInputParam, logError } from 'packaging-common/util';
 
 export async function run(): Promise<void> {
     let packagingLocation: pkgLocationUtils.PackagingLocation;
     try {
         packagingLocation = await pkgLocationUtils.getPackagingUris(pkgLocationUtils.ProtocolType.NuGet);
     } catch (error) {
         tl.debug('Unable to get packaging URIs, using default collection URI');
-        tl.debug(JSON.stringify(error));
+        logError(error);
         const collectionUrl = tl.getVariable('System.TeamFoundationCollectionUri');
         packagingLocation = {
             PackagingUris: [collectionUrl],

Tasks/DotNetCoreCLIV2/task.json

@@ -17,7 +17,7 @@
     "demands": [],
     "version": {
         "Major": 2,
-        "Minor": 164,
+        "Minor": 165,
         "Patch": 0
     },
     "minimumAgentVersion": "2.115.0",

Tasks/DotNetCoreCLIV2/task.loc.json

@@ -17,7 +17,7 @@
   "demands": [],
   "version": {
     "Major": 2,
-    "Minor": 164,
+    "Minor": 165,
     "Patch": 0
   },
   "minimumAgentVersion": "2.115.0",

Tasks/DownloadPackageV0/task.json

@@ -9,7 +9,7 @@
     "author": "ms-vscs-rm",
     "version": {
         "Major": 0,
-        "Minor": 164,
+        "Minor": 165,
         "Patch": 0
     },
     "demands": [],

Tasks/DownloadPackageV0/task.loc.json

@@ -9,8 +9,8 @@
   "author": "ms-vscs-rm",
   "version": {
     "Major": 0,
-    "Minor": 161,
-    "Patch": 1
+    "Minor": 165,
+    "Patch": 0
   },
   "demands": [],
   "minimumAgentVersion": "1.99.0",

Tasks/DownloadPackageV1/task.json

@@ -9,7 +9,7 @@
     "author": "ms-vscs-rm",
     "version": {
         "Major": 1,
-        "Minor": 164,
+        "Minor": 165,
         "Patch": 0
     },
     "demands": [],

Tasks/DownloadPackageV1/task.loc.json

@@ -9,8 +9,8 @@
   "author": "ms-vscs-rm",
   "version": {
     "Major": 1,
-    "Minor": 161,
-    "Patch": 2
+    "Minor": 165,
+    "Patch": 0
   },
   "demands": [],
   "releaseNotes": "ms-resource:loc.releaseNotes",
@@ -186,4 +186,4 @@
     "Info_Downloading": "ms-resource:loc.messages.Info_Downloading",
     "Info_UsingArtifactToolDownload": "ms-resource:loc.messages.Info_UsingArtifactToolDownload"
   }
-}
+}

Tasks/MavenAuthenticateV0/task.json

@@ -9,7 +9,7 @@
     "author": "Microsoft Corporation",
     "version": {
         "Major": 0,
-        "Minor": 164,
+        "Minor": 165,
         "Patch": 0
     },
     "runsOn": [

Tasks/MavenV2/mavenutil.ts

@@ -5,6 +5,7 @@ import fs = require('fs');
 import * as tl from 'azure-pipelines-task-lib/task';
 import * as tr from 'azure-pipelines-task-lib/toolrunner';
 import * as pkgLocationUtils from "packaging-common/locationUtilities";
+import { logError } from 'packaging-common/util';
 
 import * as url from "url";
 import * as xml2js from 'xml2js';
@@ -200,7 +201,7 @@ async function collectFeedRepositories(pomContents:string): Promise<any> {
         packagingLocation = await pkgLocationUtils.getPackagingUris(pkgLocationUtils.ProtocolType.Maven);
     } catch (error) {
         tl.debug("Unable to get packaging URIs, using default collection URI");
-        tl.debug(JSON.stringify(error));
+        logError(error);
         packagingLocation = {
             PackagingUris: [collectionUrl],
             DefaultPackagingUri: collectionUrl

Tasks/MavenV2/task.json

@@ -17,7 +17,7 @@
     "author": "Microsoft Corporation",
     "version": {
         "Major": 2,
-        "Minor": 164,
+        "Minor": 165,
         "Patch": 0
     },
     "releaseNotes": "Configuration of the SonarQube analysis was moved to the [SonarQube](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube) or [SonarCloud](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud) extensions, in task `Prepare Analysis Configuration`",

Tasks/MavenV2/task.loc.json

@@ -17,7 +17,7 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 2,
-    "Minor": 161,
+    "Minor": 165,
     "Patch": 0
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",