Skip to content

Commit 23efcf4

Browse files
caoccaocaoccao
committed
refactor: Rename some errors to be more specific
1 parent e07b6f7 commit 23efcf4

File tree

4 files changed

+29
-28
lines changed

4 files changed

+29
-28
lines changed

‎hivemq-edge/src/main/java/com/hivemq/api/errors/HttpErrorFactory.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ private HttpErrorFactory() {
4343
.type(type(InsufficientStorageError.class))
4444
.title(I18nHttpError.HTTP_ERROR_507_TITLE.get())
4545
.detail(reason == null ?
46-
I18nHttpError.HTTP_ERROR_507_DETAIL_DEFAULT.get() :
46+
I18nHttpError.HTTP_ERROR_507_DETAIL.get() :
4747
I18nHttpError.HTTP_ERROR_507_DETAIL_WITH_REASON.get(Map.of("reason", reason)))
4848
.status(HttpStatus.INSUFFICIENT_STORAGE_507)
4949
.build();
@@ -58,7 +58,7 @@ private HttpErrorFactory() {
5858
.type(type(InternalServerError.class))
5959
.title(I18nHttpError.HTTP_ERROR_500_TITLE.get())
6060
.detail(reason == null ?
61-
I18nHttpError.HTTP_ERROR_500_DETAIL_DEFAULT.get() :
61+
I18nHttpError.HTTP_ERROR_500_DETAIL.get() :
6262
I18nHttpError.HTTP_ERROR_500_DETAIL_WITH_REASON.get(Map.of("reason", reason)))
6363
.status(HttpStatus.INTERNAL_SERVER_ERROR_500)
6464
.build();
@@ -70,7 +70,7 @@ private HttpErrorFactory() {
7070
return InvalidQueryParameterError.builder()
7171
.type(type(InvalidQueryParameterError.class))
7272
.title(I18nHttpError.HTTP_ERROR_400_INVALID_QUERY_PARAMETER_TITLE.get())
73-
.detail(I18nHttpError.HTTP_ERROR_400_INVALID_QUERY_PARAMETER_DETAIL.get(Map.of(
73+
.detail(I18nHttpError.HTTP_ERROR_400_INVALID_QUERY_PARAMETER_DETAIL_WITH_PARAMETER_AND_REASON.get(Map.of(
7474
"parameter", parameter,
7575
"reason", reason)))
7676
.parameter(parameter)
@@ -83,7 +83,7 @@ private HttpErrorFactory() {
8383
return PreconditionFailedError.builder()
8484
.type(type(PreconditionFailedError.class))
8585
.title(I18nHttpError.HTTP_ERROR_412_TITLE.get())
86-
.detail(I18nHttpError.HTTP_ERROR_412_DETAIL.get(Map.of("reason", reason)))
86+
.detail(I18nHttpError.HTTP_ERROR_412_DETAIL_WITH_REASON.get(Map.of("reason", reason)))
8787
.status(HttpStatus.PRECONDITION_FAILED_412)
8888
.build();
8989
}
@@ -101,7 +101,7 @@ private HttpErrorFactory() {
101101
return RequestBodyParameterMissingError.builder()
102102
.type(type(RequestBodyParameterMissingError.class))
103103
.title(I18nHttpError.HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_TITLE.get())
104-
.detail(I18nHttpError.HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_DETAIL.get(Map.of("parameter", parameter)))
104+
.detail(I18nHttpError.HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_DETAIL_WITH_PARAMETER.get(Map.of("parameter", parameter)))
105105
.parameter(parameter)
106106
.status(HttpStatus.BAD_REQUEST_400)
107107
.build();
@@ -120,7 +120,7 @@ private HttpErrorFactory() {
120120
return UrlParameterMissingError.builder()
121121
.type(type(UrlParameterMissingError.class))
122122
.title(I18nHttpError.HTTP_ERROR_400_URL_PARAMETER_MISSING_TITLE.get())
123-
.detail(I18nHttpError.HTTP_ERROR_400_URL_PARAMETER_MISSING_DETAIL.get(Map.of("parameter", parameter)))
123+
.detail(I18nHttpError.HTTP_ERROR_400_URL_PARAMETER_MISSING_DETAIL_WITH_PARAMETER.get(Map.of("parameter", parameter)))
124124
.parameter(parameter)
125125
.status(HttpStatus.BAD_REQUEST_400)
126126
.build();

‎hivemq-edge/src/main/java/com/hivemq/common/i18n/I18nHttpError.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,22 @@
2121
import java.util.Map;
2222

2323
public enum I18nHttpError implements I18nError {
24-
HTTP_ERROR_400_INVALID_QUERY_PARAMETER_DETAIL,
24+
HTTP_ERROR_400_INVALID_QUERY_PARAMETER_DETAIL_WITH_PARAMETER_AND_REASON,
2525
HTTP_ERROR_400_INVALID_QUERY_PARAMETER_TITLE,
2626
HTTP_ERROR_400_REQUEST_BODY_MISSING_DETAIL,
2727
HTTP_ERROR_400_REQUEST_BODY_MISSING_TITLE,
28-
HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_DETAIL,
28+
HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_DETAIL_WITH_PARAMETER,
2929
HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_TITLE,
30-
HTTP_ERROR_400_URL_PARAMETER_MISSING_DETAIL,
30+
HTTP_ERROR_400_URL_PARAMETER_MISSING_DETAIL_WITH_PARAMETER,
3131
HTTP_ERROR_400_URL_PARAMETER_MISSING_TITLE,
32-
HTTP_ERROR_412_DETAIL,
32+
HTTP_ERROR_412_DETAIL_WITH_REASON,
3333
HTTP_ERROR_412_TITLE,
34-
HTTP_ERROR_500_DETAIL_DEFAULT,
34+
HTTP_ERROR_500_DETAIL,
3535
HTTP_ERROR_500_DETAIL_WITH_REASON,
3636
HTTP_ERROR_500_TITLE,
3737
HTTP_ERROR_503_DETAIL,
3838
HTTP_ERROR_503_TITLE,
39-
HTTP_ERROR_507_DETAIL_DEFAULT,
39+
HTTP_ERROR_507_DETAIL,
4040
HTTP_ERROR_507_DETAIL_WITH_REASON,
4141
HTTP_ERROR_507_TITLE,
4242
;

‎hivemq-edge/src/main/resources/templates/http-errors-en_US.properties‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
http.error.400.invalid.query.parameter.detail=Query parameter '${parameter}' is invalid: ${reason}
1+
http.error.400.invalid.query.parameter.detail.with.parameter.and.reason=Query parameter '${parameter}' is invalid: ${reason}
22
http.error.400.invalid.query.parameter.title=Query Parameter is Invalid
33
http.error.400.request.body.missing.detail=Required request body is missing.
44
http.error.400.request.body.missing.title=Required Request Body Missing
5-
http.error.400.request.body.parameter.missing.detail=Required request body parameter '${parameter}' is missing.
5+
http.error.400.request.body.parameter.missing.detail.with.parameter=Required request body parameter '${parameter}' is missing.
66
http.error.400.request.body.parameter.missing.title=Required Request Body Parameter Missing
7-
http.error.400.url.parameter.missing.detail=Required URL parameter '${parameter}' is missing.
7+
http.error.400.url.parameter.missing.detail.with.parameter=Required URL parameter '${parameter}' is missing.
88
http.error.400.url.parameter.missing.title=Required URL Parameter Missing
9-
http.error.412.detail=A precondition required for fulfilling the request was not fulfilled: ${reason}
9+
http.error.412.detail.with.reason=A precondition required for fulfilling the request was not fulfilled: ${reason}
1010
http.error.412.title=Precondition Failed
11-
http.error.500.detail.default=An unexpected error occurred, check the logs.
11+
http.error.500.detail=An unexpected error occurred, check the logs.
1212
http.error.500.detail.with.reason=An unexpected error occurred: ${reason}
1313
http.error.500.title=Internal Server Error
1414
http.error.503.detail=The endpoint is temporarily not available, please try again later.
1515
http.error.503.title=Endpoint Temporarily not Available
16-
http.error.507.detail.default=Insufficient Storage.
16+
http.error.507.detail=Insufficient Storage.
1717
http.error.507.detail.with.reason=Insufficient Storage: ${reason}
1818
http.error.507.title=Insufficient Storage

‎hivemq-edge/src/test/java/com/hivemq/common/i18n/I18nHttpErrorTest.java‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ public void whenLocaleIsEnUS_thenErrorCountShouldMatch() throws IOException {
6969
public void whenLocaleIsEnUS_thenHttpError400ShouldWork() {
7070
assertThat(I18nHttpError.HTTP_ERROR_400_INVALID_QUERY_PARAMETER_TITLE.get()).isEqualTo(
7171
"Query Parameter is Invalid");
72-
assertThat(I18nHttpError.HTTP_ERROR_400_INVALID_QUERY_PARAMETER_DETAIL.get(Map.of("parameter",
72+
assertThat(I18nHttpError.HTTP_ERROR_400_INVALID_QUERY_PARAMETER_DETAIL_WITH_PARAMETER_AND_REASON.get(Map.of(
73+
"parameter",
7374
"p1",
7475
"reason",
7576
"test."))).isEqualTo("Query parameter 'p1' is invalid: test.");
@@ -79,26 +80,26 @@ public void whenLocaleIsEnUS_thenHttpError400ShouldWork() {
7980
"Required request body is missing.");
8081
assertThat(I18nHttpError.HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_TITLE.get()).isEqualTo(
8182
"Required Request Body Parameter Missing");
82-
assertThat(I18nHttpError.HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_DETAIL.get(Map.of("parameter",
83+
assertThat(I18nHttpError.HTTP_ERROR_400_REQUEST_BODY_PARAMETER_MISSING_DETAIL_WITH_PARAMETER.get(Map.of(
84+
"parameter",
8385
"p1"))).isEqualTo("Required request body parameter 'p1' is missing.");
8486
assertThat(I18nHttpError.HTTP_ERROR_400_URL_PARAMETER_MISSING_TITLE.get()).isEqualTo(
8587
"Required URL Parameter Missing");
86-
assertThat(I18nHttpError.HTTP_ERROR_400_URL_PARAMETER_MISSING_DETAIL.get(Map.of("parameter", "p1"))).isEqualTo(
87-
"Required URL parameter 'p1' is missing.");
88+
assertThat(I18nHttpError.HTTP_ERROR_400_URL_PARAMETER_MISSING_DETAIL_WITH_PARAMETER.get(Map.of("parameter",
89+
"p1"))).isEqualTo("Required URL parameter 'p1' is missing.");
8890
}
8991

9092
@Test
9193
public void whenLocaleIsEnUS_thenHttpError412ShouldWork() {
9294
assertThat(I18nHttpError.HTTP_ERROR_412_TITLE.get()).isEqualTo("Precondition Failed");
93-
assertThat(I18nHttpError.HTTP_ERROR_412_DETAIL.get(Map.of("reason", "test."))).isEqualTo(
95+
assertThat(I18nHttpError.HTTP_ERROR_412_DETAIL_WITH_REASON.get(Map.of("reason", "test."))).isEqualTo(
9496
"A precondition required for fulfilling the request was not fulfilled: test.");
9597
}
9698

9799
@Test
98100
public void whenLocaleIsEnUS_thenHttpError500ShouldWork() {
99101
assertThat(I18nHttpError.HTTP_ERROR_500_TITLE.get()).isEqualTo("Internal Server Error");
100-
assertThat(I18nHttpError.HTTP_ERROR_500_DETAIL_DEFAULT.get()).isEqualTo(
101-
"An unexpected error occurred, check the logs.");
102+
assertThat(I18nHttpError.HTTP_ERROR_500_DETAIL.get()).isEqualTo("An unexpected error occurred, check the logs.");
102103
assertThat(I18nHttpError.HTTP_ERROR_500_DETAIL_WITH_REASON.get(Map.of("reason", "test."))).isEqualTo(
103104
"An unexpected error occurred: test.");
104105
}
@@ -113,7 +114,7 @@ public void whenLocaleIsEnUS_thenHttpError503ShouldWork() {
113114
@Test
114115
public void whenLocaleIsEnUS_thenHttpError507ShouldWork() {
115116
assertThat(I18nHttpError.HTTP_ERROR_507_TITLE.get()).isEqualTo("Insufficient Storage");
116-
assertThat(I18nHttpError.HTTP_ERROR_507_DETAIL_DEFAULT.get()).isEqualTo("Insufficient Storage.");
117+
assertThat(I18nHttpError.HTTP_ERROR_507_DETAIL.get()).isEqualTo("Insufficient Storage.");
117118
assertThat(I18nHttpError.HTTP_ERROR_507_DETAIL_WITH_REASON.get(Map.of("reason", "test."))).isEqualTo(
118119
"Insufficient Storage: test.");
119120
}
@@ -123,8 +124,8 @@ public void whenLocaleIsEnGB_thenHttpError500ShouldFail() {
123124
I18nLocaleContext.setLocale(Locale.UK);
124125
assertThat(I18nHttpError.HTTP_ERROR_500_TITLE.get()).isEqualTo(
125126
"Error: Template http.error.500.title for en_GB could not be loaded.");
126-
assertThat(I18nHttpError.HTTP_ERROR_500_DETAIL_DEFAULT.get()).isEqualTo(
127-
"Error: Template http.error.500.detail.default for en_GB could not be loaded.");
127+
assertThat(I18nHttpError.HTTP_ERROR_500_DETAIL.get()).isEqualTo(
128+
"Error: Template http.error.500.detail for en_GB could not be loaded.");
128129
assertThat(I18nHttpError.HTTP_ERROR_500_DETAIL_WITH_REASON.get(Map.of("reason", "test."))).isEqualTo(
129130
"Error: Template http.error.500.detail.with.reason for en_GB could not be loaded.");
130131
}

0 commit comments

Comments
 (0)