Skip to content

Commit

Permalink
chore: add tsg link in error messages (#43597)
Browse files Browse the repository at this point in the history 
* chore: add tsg link in error messages

* pr feedback

* add missing error parser
  • Loading branch information
@jorgerangel-msft
jorgerangel-msft committed May 10, 2024
1 parent 87239dd commit c4418cd
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 21 deletions.
36 changes: 15 additions & 21 deletions sdk/appconfiguration/Azure.Data.AppConfiguration/src/ConfigurationClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,8 @@ public virtual async Task<Response<ConfigurationSetting>> AddConfigurationSettin
case 200:
case 201:
return await CreateResponseAsync(response, cancellationToken).ConfigureAwait(false);
case 412:
throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser());
default:
throw new RequestFailedException(response);
throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser());
}
}
catch (Exception e)
Expand Down Expand Up @@ -239,10 +237,8 @@ public virtual Response<ConfigurationSetting> AddConfigurationSetting(Configurat
case 200:
case 201:
return CreateResponse(response);
case 412:
throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser());
default:
throw new RequestFailedException(response);
throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser());
}
}
catch (Exception e)
Expand Down Expand Up @@ -309,10 +305,9 @@ public virtual async Task<Response<ConfigurationSetting>> SetConfigurationSettin
return response.Status switch
{
200 => await CreateResponseAsync(response, cancellationToken).ConfigureAwait(false),
409 => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),

// Throws on 412 if resource was modified.
_ => throw new RequestFailedException(response),
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),
};
}
catch (Exception e)
Expand Down Expand Up @@ -352,10 +347,9 @@ public virtual Response<ConfigurationSetting> SetConfigurationSetting(Configurat
return response.Status switch
{
200 => CreateResponse(response),
409 => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),

// Throws on 412 if resource was modified.
_ => throw new RequestFailedException(response),
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),
};
}
catch (Exception e)
Expand Down Expand Up @@ -441,10 +435,9 @@ private async Task<Response> DeleteConfigurationSettingAsync(string key, string
{
200 => response,
204 => response,
409 => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),

// Throws on 412 if resource was modified.
_ => throw new RequestFailedException(response)
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),
};
}
catch (Exception e)
Expand All @@ -470,10 +463,9 @@ private Response DeleteConfigurationSetting(string key, string label, MatchCondi
{
200 => response,
204 => response,
409 => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),

// Throws on 412 if resource was modified.
_ => throw new RequestFailedException(response)
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),
};
}
catch (Exception e)
Expand Down Expand Up @@ -596,7 +588,7 @@ internal virtual async Task<Response<ConfigurationSetting>> GetConfigurationSett
{
200 => await CreateResponseAsync(response, cancellationToken).ConfigureAwait(false),
304 => CreateResourceModifiedResponse(response),
_ => throw new RequestFailedException(response),
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser())
};
}
catch (Exception e)
Expand Down Expand Up @@ -633,7 +625,7 @@ internal virtual Response<ConfigurationSetting> GetConfigurationSetting(string k
{
200 => CreateResponse(response),
304 => CreateResourceModifiedResponse(response),
_ => throw new RequestFailedException(response),
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser())
};
}
catch (Exception e)
Expand Down Expand Up @@ -1386,7 +1378,7 @@ private async ValueTask<Response<ConfigurationSetting>> SetReadOnlyAsync(string
200 => async
? await CreateResponseAsync(response, cancellationToken).ConfigureAwait(false)
: CreateResponse(response),
_ => throw new RequestFailedException(response)
_ => throw new RequestFailedException(response, null, new ConfigurationRequestFailedDetailsParser()),
};
}
catch (Exception e)
Expand Down Expand Up @@ -1469,22 +1461,24 @@ private static RequestContext CreateRequestContext(ErrorOptions errorOptions, Ca

private class ConfigurationRequestFailedDetailsParser : RequestFailedDetailsParser
{
private const string TroubleshootingMessage =
"For troubleshooting information, see https://aka.ms/azsdk/net/appconfiguration/troubleshoot.";
public override bool TryParse(Response response, out ResponseError error, out IDictionary<string, string> data)
{
switch (response.Status)
{
case 409:
error = new ResponseError(null, "The setting is read only");
error = new ResponseError(null, $"The setting is read only. {TroubleshootingMessage}");
data = null;
return true;
case 412:
error = new ResponseError(null, "Setting was already present.");
error = new ResponseError(null, $"Setting was already present. {TroubleshootingMessage}");
data = null;
return true;
default:
error = null;
error = new ResponseError(null, TroubleshootingMessage);
data = null;
return false;
return true;
}
}
}
Expand Down
22 changes: 22 additions & 0 deletions sdk/appconfiguration/Azure.Data.AppConfiguration/tests/ConfigurationMockTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public class ConfigurationMockTests : ClientTestBase
private static readonly string s_credential = "b1d9b31";
private static readonly string s_secret = "aabbccdd";
private static readonly string s_connectionString = $"Endpoint={s_endpoint};Id={s_credential};Secret={s_secret}";
private static readonly string s_troubleshootingLink = "https://aka.ms/azsdk/net/appconfiguration/troubleshoot";
private static readonly string s_version = new ConfigurationClientOptions().Version;

private static readonly ConfigurationSetting s_testSetting = new ConfigurationSetting("test_key", "test_value")
Expand Down Expand Up @@ -108,6 +109,27 @@ public void GetNotFound()
Assert.AreEqual(404, exception.Status);
}

// This test validates that the client throws an exception with the expected error message when it receives a
// non-success status code from the service.
[TestCase((int)HttpStatusCode.Unauthorized)]
[TestCase(403)]
[TestCase((int)HttpStatusCode.NotFound)]
public void GetUnsucessfulResponse(int statusCode)
{
var response = new MockResponse(statusCode);
var mockTransport = new MockTransport(response);
ConfigurationClient service = CreateTestService(mockTransport);

RequestFailedException exception = Assert.ThrowsAsync<RequestFailedException>(async () =>
{
await service.GetConfigurationSettingAsync(key: s_testSetting.Key);
});

Assert.AreEqual(statusCode, exception.Status);

Assert.True(exception?.Message.Contains(s_troubleshootingLink));
}

[Test]
public async Task GetIfChangedModified()
{
Expand Down

0 comments on commit c4418cd

Please sign in to comment.