-
-
Notifications
You must be signed in to change notification settings - Fork 780
Expand file tree
/
Copy pathApiException.cs
More file actions
259 lines (236 loc) · 9.79 KB
/
ApiException.cs
File metadata and controls
259 lines (236 loc) · 9.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
using System.Diagnostics.CodeAnalysis;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
namespace Refit
{
/// <summary>
/// Represents an error that occured while sending an API request.
/// </summary>
[Serializable]
#pragma warning disable CA1032 // Implement standard exception constructors
public class ApiException : Exception
#pragma warning restore CA1032 // Implement standard exception constructors
{
/// <summary>
/// HTTP response status code.
/// </summary>
public HttpStatusCode StatusCode { get; }
/// <summary>
/// The reason phrase which typically is sent by the server together with the status code.
/// </summary>
public string? ReasonPhrase { get; }
/// <summary>
/// HTTP response headers.
/// </summary>
public HttpResponseHeaders Headers { get; }
/// <summary>
/// The HTTP method used to send the request.
/// </summary>
public HttpMethod HttpMethod { get; }
/// <summary>
/// The <see cref="System.Uri"/> used to send the HTTP request.
/// </summary>
public Uri? Uri => RequestMessage.RequestUri;
/// <summary>
/// The HTTP Request message used to send the request.
/// </summary>
public HttpRequestMessage RequestMessage { get; }
/// <summary>
/// HTTP response content headers as defined in RFC 2616.
/// </summary>
public HttpContentHeaders? ContentHeaders { get; private set; }
/// <summary>
/// HTTP Response content as string.
/// </summary>
public string? Content { get; private set; }
/// <summary>
/// Does the response have content?
/// </summary>
#if NET6_0_OR_GREATER
[MemberNotNullWhen(true, nameof(Content))]
#endif
public bool HasContent => !string.IsNullOrWhiteSpace(Content);
/// <summary>
/// Refit settings used to send the request.
/// </summary>
public RefitSettings RefitSettings { get; }
/// <summary>
/// Initializes a new instance of the <see cref="ApiException"/> class.
/// </summary>
/// <param name="message">The message.</param>
/// <param name="httpMethod">The HTTP method.</param>
/// <param name="content">The content.</param>
/// <param name="statusCode">The status code.</param>
/// <param name="reasonPhrase">The reason phrase.</param>
/// <param name="headers">The headers.</param>
/// <param name="refitSettings">The refit settings.</param>
/// <param name="innerException">The inner exception.</param>
protected ApiException(
HttpRequestMessage message,
HttpMethod httpMethod,
string? content,
HttpStatusCode statusCode,
string? reasonPhrase,
HttpResponseHeaders headers,
RefitSettings refitSettings,
Exception? innerException = null
)
: this(
CreateMessage(statusCode, reasonPhrase),
message,
httpMethod,
content,
statusCode,
reasonPhrase,
headers,
refitSettings,
innerException
) { }
/// <summary>
/// Initializes a new instance of the <see cref="ApiException"/> class.
/// </summary>
/// <param name="exceptionMessage">The exception message.</param>
/// <param name="message">The message.</param>
/// <param name="httpMethod">The HTTP method.</param>
/// <param name="content">The content.</param>
/// <param name="statusCode">The status code.</param>
/// <param name="reasonPhrase">The reason phrase.</param>
/// <param name="headers">The headers.</param>
/// <param name="refitSettings">The refit settings.</param>
/// <param name="innerException">The inner exception.</param>
protected ApiException(
string exceptionMessage,
HttpRequestMessage message,
HttpMethod httpMethod,
string? content,
HttpStatusCode statusCode,
string? reasonPhrase,
HttpResponseHeaders headers,
RefitSettings refitSettings,
Exception? innerException = null
)
: base(exceptionMessage, innerException)
{
RequestMessage = message;
HttpMethod = httpMethod;
StatusCode = statusCode;
ReasonPhrase = reasonPhrase;
Headers = headers;
RefitSettings = refitSettings;
Content = content;
}
/// <summary>
/// Get the deserialized response content as nullable <typeparamref name="T"/>.
/// </summary>
/// <typeparam name="T">Type to deserialize the content to</typeparam>
/// <returns>The response content deserialized as <typeparamref name="T"/></returns>
public async Task<T?> GetContentAsAsync<T>() =>
HasContent
? await RefitSettings
.ContentSerializer.FromHttpContentAsync<T>(new StringContent(Content!))
.ConfigureAwait(false)
: default;
/// <summary>
/// Create an instance of <see cref="ApiException"/>.
/// </summary>
/// <param name="message">The HTTP Request message used to send the request.</param>
/// <param name="httpMethod">The HTTP method used to send the request.</param>
/// <param name="response">The HTTP Response message.</param>
/// <param name="refitSettings">Refit settings used to sent the request.</param>
/// <param name="innerException">Add an inner exception to the <see cref="ApiException"/>.</param>
/// <returns>A newly created <see cref="ApiException"/>.</returns>
#pragma warning disable VSTHRD200 // Use "Async" suffix for async methods
public static Task<ApiException> Create(
HttpRequestMessage message,
HttpMethod httpMethod,
HttpResponseMessage response,
RefitSettings refitSettings,
Exception? innerException = null
)
#pragma warning restore VSTHRD200 // Use "Async" suffix for async methods
{
if (response?.IsSuccessStatusCode == true)
{
throw new ArgumentException("Response is successful, cannot create an ApiException.", nameof(response));
}
var exceptionMessage = CreateMessage(response!.StatusCode, response.ReasonPhrase);
return Create(
exceptionMessage,
message,
httpMethod,
response,
refitSettings,
innerException
);
}
/// <summary>
/// Create an instance of <see cref="ApiException"/> with a custom exception message.
/// </summary>
/// <param name="exceptionMessage">A custom exception message.</param>
/// <param name="message">The HTTP Request message used to send the request.</param>
/// <param name="httpMethod">The HTTP method used to send the request.</param>
/// <param name="response">The HTTP Response message.</param>
/// <param name="refitSettings">Refit settings used to sent the request.</param>
/// <param name="innerException">Add an inner exception to the <see cref="ApiException"/>.</param>
/// <returns>A newly created <see cref="ApiException"/>.</returns>
#pragma warning disable VSTHRD200 // Use "Async" suffix for async methods
public static async Task<ApiException> Create(
string exceptionMessage,
HttpRequestMessage message,
HttpMethod httpMethod,
HttpResponseMessage response,
RefitSettings refitSettings,
Exception? innerException = null
)
#pragma warning restore VSTHRD200 // Use "Async" suffix for async methods
{
if (response == null)
{
throw new ArgumentNullException(nameof(response));
}
var exception = new ApiException(
exceptionMessage,
message,
httpMethod,
null,
response.StatusCode,
response.ReasonPhrase,
response.Headers,
refitSettings,
innerException
);
if (response.Content == null)
{
return exception;
}
#pragma warning disable CA1031 // Do not catch general exception types
try
{
exception.ContentHeaders = response.Content.Headers;
var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
exception.Content = content;
if (
response
.Content.Headers?.ContentType
?.MediaType
?.Equals("application/problem+json") ?? false
)
{
exception = ValidationApiException.Create(exception);
}
response.Content.Dispose();
}
catch
{
// NB: We're already handling an exception at this point,
// so we want to make sure we don't throw another one
// that hides the real error.
}
#pragma warning restore CA1031 // Do not catch general exception types
return exception;
}
static string CreateMessage(HttpStatusCode statusCode, string? reasonPhrase) =>
$"Response status code does not indicate success: {(int)statusCode} ({reasonPhrase}).";
}
}