Improve parsing of AWS errors (#253)

* Improve parsing of AWS errors

* Fix github runner issue

* Broaden DownloadFile() status code handling

* Add assert to missing file test

* Small test format fix

* PubNub SDK v7.3.13.0 release.

---------

Co-authored-by: PubNub Release Bot <[email protected]>

Author: jakub-grzesiowski

.github/workflows/release/build-packages.ps1

@@ -24,7 +24,7 @@ dotnet pack -o "$RELEASES_PATH\PCL" -c Release
 # Build UWP package.
 echo "Build UWP package"
 cd "$githubWorkspace\src\Api\PubnubApiUWP"
-dotnet restore
+dotnet restore /p:BuildWithNetFrameworkHostedCompiler=true
 msbuild PubnubApiUWP.csproj /t:Pack /p:Configuration=Release /p:PackageOutputPath="$RELEASES_PATH\UWP" /v:n
 
 echo "Copy built packages"

.github/workflows/run-tests.yml

@@ -77,7 +77,7 @@ jobs:
         with:
           dotnet-version: 6.0.x
       - name: Restore dependencies
-        run: dotnet restore
+        run: dotnet restore /p:BuildWithNetFrameworkHostedCompiler=true
       - name: Build Projects
         run: |
           cd ./UnitTests/AcceptanceTests 

.pubnub.yml

@@ -1,8 +1,13 @@
 name: c-sharp
-version: "7.3.12"
+version: "7.3.13"
 schema: 1
 scm: github.com/pubnub/c-sharp
 changelog:
+  - date: 2025-06-06
+    version: v7.3.13
+    changes:
+      - type: bug
+        text: "Improved parsing of file download errors to be properly set in operation status ErrorData."
   - date: 2025-05-28
     version: v7.3.12
     changes:
@@ -909,7 +914,7 @@ features:
     - QUERY-PARAM
 supported-platforms:
   -
-    version: Pubnub 'C#' 7.3.12
+    version: Pubnub 'C#' 7.3.13
     platforms:
       - Windows 10 and up
       - Windows Server 2008 and up
@@ -920,7 +925,7 @@ supported-platforms:
       - .Net Framework 4.6.1+
       - .Net Framework 6.0
   -
-    version: PubnubPCL 'C#' 7.3.12
+    version: PubnubPCL 'C#' 7.3.13
     platforms:
       - Xamarin.Android
       - Xamarin.iOS
@@ -940,7 +945,7 @@ supported-platforms:
       - .Net Core
       - .Net 6.0
   -
-    version: PubnubUWP 'C#' 7.3.12
+    version: PubnubUWP 'C#' 7.3.13
     platforms:
       - Windows Phone 10
       - Universal Windows Apps
@@ -964,7 +969,7 @@ sdks:
             distribution-type: source
             distribution-repository: GitHub
             package-name: Pubnub
-            location: https://github.com/pubnub/c-sharp/releases/tag/v7.3.12.0
+            location: https://github.com/pubnub/c-sharp/releases/tag/v7.3.13.0
             requires:
               -
                 name: ".Net"
@@ -1247,7 +1252,7 @@ sdks:
             distribution-type: source
             distribution-repository: GitHub
             package-name: PubNubPCL
-            location: https://github.com/pubnub/c-sharp/releases/tag/v7.3.12.0
+            location: https://github.com/pubnub/c-sharp/releases/tag/v7.3.13.0
             requires:
               -
                 name: ".Net Core"
@@ -1606,7 +1611,7 @@ sdks:
             distribution-type: source
             distribution-repository: GitHub
             package-name: PubnubUWP
-            location: https://github.com/pubnub/c-sharp/releases/tag/v7.3.12.0
+            location: https://github.com/pubnub/c-sharp/releases/tag/v7.3.13.0
             requires:
               -
                 name: "Universal Windows Platform Development"

CHANGELOG

@@ -1,3 +1,7 @@
+v7.3.13 - June 06 2025
+-----------------------------
+- Fixed: improved parsing of file download errors to be properly set in operation status ErrorData.
+
 v7.3.12 - May 28 2025
 -----------------------------
 - Added: added new integration tests to better cover all SDK endpoints.

src/Api/PubnubApi/EndPoint/Files/DownloadFileOperation.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Globalization;
 using System.Threading.Tasks;
+using System.Xml.Linq;
 using PubnubApi.Security.Crypto;
 using PubnubApi.Security.Crypto.Cryptors;
 
@@ -91,83 +93,11 @@ internal void Retry()
 
         private void ProcessFileDownloadRequest(PNCallback<PNDownloadFileResult> callback)
         {
-            RequestState<PNDownloadFileResult> requestState = new RequestState<PNDownloadFileResult>
-            {
-                ResponseType = PNOperationType.PNDownloadFileOperation,
-                PubnubCallback = callback,
-                Reconnect = false,
-                EndPointOperation = this
-            };
-
-            var requestParameter = CreateRequestParameter();
-            var transportRequest = PubnubInstance.transportMiddleware.PreapareTransportRequest(
-                requestParameter: requestParameter, operationType: PNOperationType.PNDownloadFileOperation);
-            PubnubInstance.transportMiddleware.Send(transportRequest: transportRequest).ContinueWith(t =>
+            var processTask = ProcessFileDownloadRequest();
+            processTask.ContinueWith((t) =>
             {
-                var transportResponse = t.Result;
-                if (transportResponse.Error == null)
-                {
-                    var fileContentBytes = transportResponse.Content;
-                    if (fileContentBytes != null)
-                    {
-                        requestState.GotJsonResponse = true;
-                        byte[] outputBytes;
-                        if (string.IsNullOrEmpty(currentFileCipherKey) && string.IsNullOrEmpty(config.CipherKey) &&
-                            config.CryptoModule == null)
-                        {
-                            outputBytes = fileContentBytes;
-                        }
-                        else
-                        {
-                            CryptoModule currentCryptoModule = !string.IsNullOrEmpty(currentFileCipherKey)
-                                ? new CryptoModule(new LegacyCryptor(currentFileCipherKey, true, config.Logger), null)
-                                : (config.CryptoModule ??=
-                                    new CryptoModule(new LegacyCryptor(config.CipherKey, true), null));
-                            try
-                            {
-                                outputBytes = currentCryptoModule.Decrypt(fileContentBytes);
-                                logger?.Debug($"Stream length (after Decrypt)= {fileContentBytes.Length}");
-                            }
-                            catch (Exception ex)
-                            {
-                                logger?.Error(
-                                    $" Error while decrypting file content.File might be not encrypted, returning as it is. exception: {ex}");
-                                outputBytes = fileContentBytes;
-                            }
-                        }
-
-                        PNDownloadFileResult result = new PNDownloadFileResult
-                        {
-                            FileBytes = outputBytes,
-                            FileName = currentFileName
-                        };
-                        PNStatus status = new StatusBuilder(config, jsonLibrary).CreateStatusResponse(
-                            requestState.ResponseType, PNStatusCategory.PNAcknowledgmentCategory, requestState, 200,
-                            null);
-                        callback.OnResponse(result, status);
-                        logger?.Info($"{GetType().Name} request finished with status code {status?.StatusCode}");
-                    }
-                    else
-                    {
-                        PNStatus errorStatus = GetStatusIfError(requestState, null);
-
-                        callback.OnResponse(default, errorStatus);
-                        logger?.Info(
-                            $"{GetType().Name} request finished with status code {requestState.Response?.StatusCode}");
-                    }
-                }
-                else
-                {
-                    int statusCode = PNStatusCodeHelper.GetHttpStatusCode(transportResponse.Error.Message);
-                    PNStatusCategory category =
-                        PNStatusCategoryHelper.GetPNStatusCategory(statusCode, transportResponse.Error.Message);
-                    PNStatus status = new StatusBuilder(config, jsonLibrary).CreateStatusResponse(
-                        PNOperationType.PNDownloadFileOperation, category, requestState, statusCode,
-                        new PNException(transportResponse.Error.Message, transportResponse.Error));
-                    requestState.PubnubCallback.OnResponse(default, status);
-                    logger?.Info(
-                        $"{GetType().Name} request finished with status code {requestState.Response?.StatusCode}");
-                }
+                var result = t.Result;
+                callback.OnResponse(result.Result, result.Status);
             });
         }
 
@@ -198,17 +128,18 @@ private async Task<PNResult<PNDownloadFileResult>> ProcessFileDownloadRequest()
             }
 
             logger?.Debug($"{GetType().Name} parameter validated.");
+            var requestParameter = CreateRequestParameter();
+            var transportRequest = PubnubInstance.transportMiddleware.PreapareTransportRequest(
+                requestParameter: requestParameter, operationType: PNOperationType.PNDownloadFileOperation);
+            var transportResponse = await PubnubInstance.transportMiddleware.Send(transportRequest: transportRequest)
+                .ConfigureAwait(false);
             RequestState<PNDownloadFileResult> requestState = new RequestState<PNDownloadFileResult>
             {
                 ResponseType = PNOperationType.PNDownloadFileOperation,
+                Response = transportResponse,
                 Reconnect = false,
                 EndPointOperation = this
             };
-            var requestParameter = CreateRequestParameter();
-            var transportRequest = PubnubInstance.transportMiddleware.PreapareTransportRequest(
-                requestParameter: requestParameter, operationType: PNOperationType.PNDownloadFileOperation);
-            var transportResponse = await PubnubInstance.transportMiddleware.Send(transportRequest: transportRequest)
-                .ConfigureAwait(false);
             if (transportResponse.Error == null)
             {
                 var fileContentBytes = transportResponse.Content;
@@ -241,17 +172,27 @@ private async Task<PNResult<PNDownloadFileResult>> ProcessFileDownloadRequest()
                                 { Error = true, ErrorData = new PNErrorData("Decryption error", ex) };
                         }
                     }
-
-                    PNStatus status = new StatusBuilder(config, jsonLibrary).CreateStatusResponse(
-                        requestState.ResponseType, PNStatusCategory.PNAcknowledgmentCategory, requestState,
-                        transportResponse.StatusCode, null);
-                    PNDownloadFileResult result = new PNDownloadFileResult
+                    
+                    //Parsing for AWS errors (httpClient doesn't throw an exception but returns a 4xx status code with error in body)
+                    if (transportResponse.StatusCode is >= 400 and < 500)
                     {
-                        FileBytes = outputBytes,
-                        FileName = currentFileName
-                    };
-                    returnValue.Result = result;
-                    returnValue.Status = status;
+                        var stringResult = System.Text.Encoding.UTF8.GetString(outputBytes);
+                        PNStatus errorStatus = GetStatusIfError(requestState, stringResult);
+                        returnValue.Status = errorStatus;
+                    }
+                    else
+                    {
+                        PNStatus status = new StatusBuilder(config, jsonLibrary).CreateStatusResponse(
+                            requestState.ResponseType, PNStatusCategory.PNAcknowledgmentCategory, requestState,
+                            transportResponse.StatusCode, null);
+                        PNDownloadFileResult result = new PNDownloadFileResult
+                        {
+                            FileBytes = outputBytes,
+                            FileName = currentFileName
+                        };
+                        returnValue.Result = result;
+                        returnValue.Status = status;
+                    }
                 }
                 else
                 {

src/Api/PubnubApi/Properties/AssemblyInfo.cs

@@ -11,8 +11,8 @@
 [assembly: AssemblyProduct("Pubnub C# SDK")]
 [assembly: AssemblyCopyright("Copyright ©  2021")]
 [assembly: AssemblyTrademark("")]
-[assembly: AssemblyVersion("7.3.12.0")]
-[assembly: AssemblyFileVersion("7.3.12.0")]
+[assembly: AssemblyVersion("7.3.13.0")]
+[assembly: AssemblyFileVersion("7.3.13.0")]
 // Setting ComVisible to false makes the types in this assembly not visible
 // to COM components.  If you need to access a type in this assembly from
 // COM, set the ComVisible attribute to true on that type.

src/Api/PubnubApi/PubnubApi.csproj

@@ -14,16 +14,15 @@
 
   <PropertyGroup>
     <PackageId>Pubnub</PackageId>
-    <PackageVersion>7.3.12.0</PackageVersion>
+    <PackageVersion>7.3.13.0</PackageVersion>
     <Title>PubNub C# .NET - Web Data Push API</Title>
     <Authors>Pandu Masabathula</Authors>
     <Owners>PubNub</Owners>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
     <PackageIconUrl>http://pubnub.s3.amazonaws.com/2011/powered-by-pubnub/pubnub-icon-600x600.png</PackageIconUrl>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <RepositoryUrl>https://github.com/pubnub/c-sharp/</RepositoryUrl>
-    <PackageReleaseNotes>Fixed an issue when upon receiving a message with published with a custom type the CustomMessageType  would be null upon receiving.
-Added new integration tests to better cover all SDK endpoints.</PackageReleaseNotes>
+    <PackageReleaseNotes>Improved parsing of file download errors to be properly set in operation status ErrorData.</PackageReleaseNotes>
     <PackageTags>Web Data Push Real-time Notifications ESB Message Broadcasting Distributed Computing</PackageTags>
     <!--<Summary>PubNub is a Massively Scalable Web Push Service for Web and Mobile Games.  This is a cloud-based service for broadcasting messages to thousands of web and mobile clients simultaneously</Summary>-->
     <Description>PubNub is a Massively Scalable Web Push Service for Web and Mobile Games.  This is a cloud-based service for broadcasting messages to thousands of web and mobile clients simultaneously</Description>

src/Api/PubnubApi/PubnubCoreBase.cs

@@ -13,6 +13,8 @@
 using PubnubApi.Security.Crypto;
 using PubnubApi.Security.Crypto.Cryptors;
 using System.Collections.Concurrent;
+using System.Xml.Linq;
+
 #endregion
 
 namespace PubnubApi
@@ -1069,11 +1071,31 @@ protected PNStatus GetStatusIfError<T>(RequestState<T> asyncRequestState, string
             {
                 if (pubnubConfig.TryGetValue(PubnubInstance.InstanceId, out currentConfig))
                 {
-                    string message = ExtractValue(jsonString, "<Message>", "</Message>");
-                    string proposedSize = ExtractValue(jsonString, "<ProposedSize>", "</ProposedSize>");
-                    var errorMessage = string.IsNullOrEmpty((message)) ? jsonString : $"File upload failed: {message}";
-                    errorMessage+= string.IsNullOrEmpty(proposedSize)?"":$", maximum allowed size is {proposedSize}";
-                    status = new StatusBuilder(currentConfig, jsonLib).CreateStatusResponse<T>(type, PNStatusCategory.PNUnknownCategory, asyncRequestState, Constants.HttpRequestEntityTooLargeStatusCode, new PNException(errorMessage));
+                    var parsedXml = XDocument.Parse(jsonString);
+                    var errorElement = parsedXml.Root;
+                    var errorMessage = string.Empty;
+                    if (errorElement?.Name == "Error")
+                    {
+                        var code = errorElement.Element("Code");
+                        if (code != null)
+                        {
+                            errorMessage += $"Code: {code.Value} ";
+                        }
+                        var message = errorElement.Element("Message");
+                        if (message != null)
+                        {
+                            errorMessage += $"Message: {message.Value} ";
+                        }
+                        var proposedSize = errorElement.Element("ProposedSize");
+                        if (proposedSize != null)
+                        {
+                            errorMessage += $"Maximum allowed size is: {proposedSize.Value} ";
+                        }
+                    }
+                    errorMessage = string.IsNullOrEmpty((errorMessage)) ? jsonString : errorMessage;
+                    //TODO: might not always be applicable
+                    var statusCode = asyncRequestState?.Response?.StatusCode ?? Constants.HttpRequestEntityTooLargeStatusCode;
+                    status = new StatusBuilder(currentConfig, jsonLib).CreateStatusResponse<T>(type, PNStatusCategory.PNUnknownCategory, asyncRequestState, statusCode, new PNException(errorMessage));
                 }
             }
 

src/Api/PubnubApiPCL/PubnubApiPCL.csproj

@@ -14,16 +14,15 @@
 
   <PropertyGroup>
     <PackageId>PubnubPCL</PackageId>
-    <PackageVersion>7.3.12.0</PackageVersion>
+    <PackageVersion>7.3.13.0</PackageVersion>
     <Title>PubNub C# .NET - Web Data Push API</Title>
     <Authors>Pandu Masabathula</Authors>
     <Owners>PubNub</Owners>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
     <PackageIconUrl>http://pubnub.s3.amazonaws.com/2011/powered-by-pubnub/pubnub-icon-600x600.png</PackageIconUrl>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <RepositoryUrl>https://github.com/pubnub/c-sharp/</RepositoryUrl>
-    <PackageReleaseNotes>Fixed an issue when upon receiving a message with published with a custom type the CustomMessageType  would be null upon receiving.
-Added new integration tests to better cover all SDK endpoints.</PackageReleaseNotes>
+    <PackageReleaseNotes>Improved parsing of file download errors to be properly set in operation status ErrorData.</PackageReleaseNotes>
     <PackageTags>Web Data Push Real-time Notifications ESB Message Broadcasting Distributed Computing</PackageTags>
     <!--<Summary>PubNub is a Massively Scalable Web Push Service for Web and Mobile Games.  This is a cloud-based service for broadcasting messages to thousands of web and mobile clients simultaneously</Summary>-->
     <Description>PubNub is a Massively Scalable Web Push Service for Web and Mobile Games.  This is a cloud-based service for broadcasting messages to thousands of web and mobile clients simultaneously</Description>

src/Api/PubnubApiUWP/PubnubApiUWP.csproj

@@ -16,16 +16,15 @@
 
   <PropertyGroup>
     <PackageId>PubnubUWP</PackageId>
-    <PackageVersion>7.3.12.0</PackageVersion>
+    <PackageVersion>7.3.13.0</PackageVersion>
     <Title>PubNub C# .NET - Web Data Push API</Title>
     <Authors>Pandu Masabathula</Authors>
     <Owners>PubNub</Owners>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
     <PackageIconUrl>http://pubnub.s3.amazonaws.com/2011/powered-by-pubnub/pubnub-icon-600x600.png</PackageIconUrl>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <RepositoryUrl>https://github.com/pubnub/c-sharp/</RepositoryUrl>
-    <PackageReleaseNotes>Fixed an issue when upon receiving a message with published with a custom type the CustomMessageType  would be null upon receiving.
-Added new integration tests to better cover all SDK endpoints.</PackageReleaseNotes>
+    <PackageReleaseNotes>Improved parsing of file download errors to be properly set in operation status ErrorData.</PackageReleaseNotes>
     <PackageTags>Web Data Push Real-time Notifications ESB Message Broadcasting Distributed Computing</PackageTags>
     <!--<Summary>PubNub is a Massively Scalable Web Push Service for Web and Mobile Games.  This is a cloud-based service for broadcasting messages to thousands of web and mobile clients simultaneously</Summary>-->
     <Description>PubNub is a Massively Scalable Web Push Service for Web and Mobile Games.  This is a cloud-based service for broadcasting messages to thousands of web and mobile clients simultaneously</Description>