fix: version in release workflow is wrong for marketplace (#232)

Author: Asaf Agami

.github/workflows/build-project.yml

@@ -6,15 +6,34 @@ on:
       solution-file-path:
         required: true
         type: string
+    outputs:
+      version:
+        description: 'next Git tag in semver format'
+        value: ${{ jobs.build.outputs.version }}
 jobs:
   build:
     runs-on: windows-2022
     defaults:
       run:
         working-directory: ${{ github.workspace }}
     environment: snyk-msbuild-envs
+    outputs:
+      version: ${{ steps.vsix_version.outputs.next-tag }}
     steps:
     - uses: actions/checkout@v2
+    - name: Calculate next semantic version Git tag (vsix version)
+      id: vsix_version
+      uses: ./.github/actions/next-git-tag
+    - name: Set VSIX version for 2015-2019
+      uses: cezarypiatek/VsixVersionAction@1.0
+      with:
+        version: ${{ steps.vsix_version.outputs.next-tag }}
+        vsix-manifest-file: .\Snyk.VisualStudio.Extension\source.extension.vsixmanifest
+    - name: Set VSIX version for 2022
+      uses: cezarypiatek/VsixVersionAction@1.0
+      with:
+        version: ${{ steps.vsix_version.outputs.next-tag }}
+        vsix-manifest-file: .\Snyk.VisualStudio.Extension.2022\source.extension.vsixmanifest
     - name: Check if secrets exist
       env: 
         Secret: ${{ secrets.SNYK_CODE_API_ENDPOINT_URL }}

.github/workflows/release.yml

@@ -41,7 +41,7 @@ jobs:
     - name: Tests
       run: vstest.console.exe **\*.Tests.dll /TestCaseFilter:"FullyQualifiedName!=Xunit.Instances.VisualStudio&integration!=true" #exclude integration tests and the psuedo-tests that launch a VS instance
   release:
-    needs: run-integration-tests
+    needs: [build-project, run-integration-tests]
     runs-on: windows-2022
     defaults:
       run:
@@ -59,28 +59,12 @@ jobs:
       with:
         name: build-artifacts
 
-    - name: Calculate next semantic version Git tag (vsix version)
-      id: vsix_version
-      uses: ./.github/actions/next-git-tag
-
-    - name: Set VSIX version for 2015-2019
-      uses: cezarypiatek/VsixVersionAction@1.0
-      with:
-        version: ${{ steps.vsix_version.outputs.next-tag }}
-        vsix-manifest-file: .\Snyk.VisualStudio.Extension\source.extension.vsixmanifest
-
-    - name: Set VSIX version for 2022
-      uses: cezarypiatek/VsixVersionAction@1.0
-      with:
-        version: ${{ steps.vsix_version.outputs.next-tag }}
-        vsix-manifest-file: .\Snyk.VisualStudio.Extension.2022\source.extension.vsixmanifest
-
     - name: Set up Git actions user
       uses: fregante/setup-git-user@v1
 
     - name: Create and push Git tag release
       run: |
-        git tag ${{ steps.vsix_version.outputs.next-tag }}
+        git tag ${{ needs.build-project.outputs.version }}
         git push origin main
         git push origin main --tags
 
@@ -90,8 +74,8 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        tag_name: ${{ steps.vsix_version.outputs.next-tag }}
-        release_name: Release ${{ steps.vsix_version.outputs.next-tag }}
+        tag_name: ${{ needs.build-project.outputs.version }}
+        release_name: Release ${{ needs.build-project.outputs.version }}
         draft: false
         prerelease: false
 
@@ -102,7 +86,7 @@ jobs:
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: .\Snyk.VisualStudio.Extension\bin\Release\Snyk.VisualStudio.Extension.vsix
-        asset_name: Snyk_Vulnerability_Scanner-${{ steps.vsix_version.outputs.next-tag }}.vsix
+        asset_name: Snyk_Vulnerability_Scanner-${{ needs.build-project.outputs.version }}.vsix
         asset_content_type: application/zip
 
     - name: Upload GitHub Release 2022 Asset
@@ -112,7 +96,7 @@ jobs:
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: .\Snyk.VisualStudio.Extension.2022\bin\Release\Snyk.VisualStudio.Extension.vsix
-        asset_name: Snyk_Vulnerability_Scanner-${{ steps.vsix_version.outputs.next-tag }}-2022.vsix
+        asset_name: Snyk_Vulnerability_Scanner-${{ needs.build-project.outputs.version }}-2022.vsix
         asset_content_type: application/zip
 
     - name: Publish 2015-2019 extension to Marketplace

Snyk.Code.Library/Service/SnykCodeService.cs

@@ -82,13 +82,9 @@ public string GetSnykCodeErrorMessage(Exception sourceException)
                 Logger.Error(sourceException, "Failed to obtain Snyk Code error message");
                 Logger.Error(e, string.Empty);
 
-                if (false == sourceException.Message.IsNullOrEmpty())
-                {
-                    return sourceException.Message;
-                }
-                else {
-                    return $"Error: {sourceException.ToString()}";
-                }
+                return !sourceException.Message.IsNullOrEmpty()
+                    ? sourceException.Message
+                    : $"Error {sourceException}";
             }
         }
 

Snyk.Common/CollectionExtensions.cs

@@ -9,10 +9,10 @@
     public static class CollectionExtensions
     {
         /// <summary>
-        /// Check is collection is empty (items count is 0).
+        /// Check is collection is empty (items count is 0) or null.
         /// </summary>
         /// <param name="collection">Source collection for check.</param>
         /// <returns>True if collection is empty.</returns>
-        public static bool IsNullOrEmpty<T>(this IEnumerable<T> collection) => collection == null || collection.Count() == 0;
+        public static bool IsNullOrEmpty<T>(this IEnumerable<T> collection) => collection == null || !collection.Any();
     }
 }

Snyk.Common/StringExtensions.cs

@@ -50,5 +50,7 @@ public static string ReplaceFirst(this string source, string oldValue, string ne
 
             return source.Substring(0, index) + newValue + source.Substring(index + oldValue.Length);
         }
+
+        public static bool IsNullOrEmpty(this string target) => string.IsNullOrEmpty(target);
     }
 }

Snyk.VisualStudio.Extension.Shared/UI/Notifications/NotificationService.cs

@@ -1,12 +1,14 @@
 namespace Snyk.VisualStudio.Extension.Shared.UI.Notifications
 {
+    using Snyk.Common;
     using Snyk.VisualStudio.Extension.Shared.Service;
 
     /// <summary>
     /// Snyk VS notification service.
     /// </summary>
     public class NotificationService
     {
+        private const int MaxErrorLength = 300;
         private VsInfoBarService infoBarService;
 
         private NotificationService(ISnykServiceProvider serviceProvider) => this.infoBarService = new VsInfoBarService(serviceProvider);
@@ -22,6 +24,18 @@ public class NotificationService
         /// Show error info bar with provided message.
         /// </summary>
         /// <param name="message">Message to show.</param>
-        public void ShowErrorInfoBar(string message) => this.infoBarService.ShowErrorInfoBar(message);
+        public void ShowErrorInfoBar(string message)
+        {
+            if (message.IsNullOrEmpty()) // Calling ShowErrorInfoBar with empty message will cause exception.
+            {
+                message = "Unknown error";
+            }
+            else if (message.Length > MaxErrorLength)
+            {
+                message = message.Substring(0, MaxErrorLength) + "...";
+            }
+
+            this.infoBarService.ShowErrorInfoBar(message);
+        }
     }
 }