Changed all error codes from InvalidRequest to BadRequestData, except…

… for JSON Parse Error that is still an InvalidRequest
FIWARE · Aug 31, 2023 · b091107 · b091107
1 parent 0f6b273
commit b091107
Show file tree

Hide file tree

Showing 21 changed files with 199 additions and 39 deletions.
diff --git a/CHANGES_NEXT_RELEASE b/CHANGES_NEXT_RELEASE
@@ -2,3 +2,4 @@ Fixed issues:
   * #1419 - Fixed a bug in the cleanup of the "URL being downloaded list" - not being cleaned up in case of an error
   * #280  - Added extensive logging for downloading of contexts
   * #280  - Fixed two erroneous type values in the response payload body (EntityTypeInformation => EntityTypeInfo and EntityAttributeList => AttributeList)
+  * #280  - Changed all error codes from InvalidRequest to BadRequestData, except for JSON Parse Error that is still an InvalidRequest
diff --git a/src/lib/orionld/common/httpStatusCodeToOrionldErrorType.cpp b/src/lib/orionld/common/httpStatusCodeToOrionldErrorType.cpp
@@ -43,20 +43,20 @@ OrionldResponseErrorType httpStatusCodeToOrionldErrorType(int httpStatusCode)
   case 400: return OrionldBadRequestData;
   case 403: return OrionldOperationNotSupported;
   case 404: return OrionldResourceNotFound;
-  case 405: return OrionldInvalidRequest;
-  case 406: return OrionldInvalidRequest;
+  case 405: return OrionldBadRequestData;
+  case 406: return OrionldBadRequestData;
   case 409: return OrionldAlreadyExists;
-  case 411: return OrionldInvalidRequest;
-  case 413: return OrionldInvalidRequest;
-  case 415: return OrionldInvalidRequest;
+  case 411: return OrionldBadRequestData;
+  case 413: return OrionldBadRequestData;
+  case 415: return OrionldBadRequestData;
   case 422: return OrionldOperationNotSupported;
   case 470: return OrionldResourceNotFound;
   case 471: return OrionldBadRequestData;
   case 472: return OrionldBadRequestData;
   case 473: return OrionldBadRequestData;
   case 480: return OrionldBadRequestData;
   case 481: return OrionldBadRequestData;
-  case 482: return OrionldInvalidRequest;
+  case 482: return OrionldBadRequestData;
   case 500: return OrionldInternalError;
   case 501: return OrionldOperationNotSupported;
   case 503: return OrionldInternalError;

diff --git a/src/lib/orionld/mongoc/mongocEntitiesQuery.cpp b/src/lib/orionld/mongoc/mongocEntitiesQuery.cpp
@@ -600,7 +600,7 @@ static bool geoOverlapsFilter(bson_t* mongoFilterP, OrionldGeoInfo* geoInfoP)
 //
 static bool geoContainsFilter(bson_t* mongoFilterP, OrionldGeoInfo* geoInfoP)
 {
-  orionldError(OrionldInvalidRequest,  "Not Implemented", "georel 'contains' is not supported by mongodb and thus also not by Orion-LD", 501);
+  orionldError(OrionldOperationNotSupported,  "Not Implemented", "georel 'contains' is not supported by mongodb and thus also not by Orion-LD", 501);
   return false;
 }
 

diff --git a/src/lib/orionld/payloadCheck/pCheckGeorel.cpp b/src/lib/orionld/payloadCheck/pCheckGeorel.cpp
@@ -44,17 +44,17 @@ bool pCheckGeorel(KjNode* georelP, OrionldGeoInfo* geoInfoP)
 {
   if (georelP == NULL)
   {
-    orionldError(OrionldInvalidRequest, "Invalid Geo-Spatial Filter", "georel missing", 400);
+    orionldError(OrionldBadRequestData, "Invalid Geo-Spatial Filter", "georel missing", 400);
     return false;
   }
   else if (georelP->type != KjString)
   {
-    orionldError(OrionldInvalidRequest, "Invalid Geo-Spatial Filter", "georel must be a string", 400);
+    orionldError(OrionldBadRequestData, "Invalid Geo-Spatial Filter", "georel must be a string", 400);
     return false;
   }
   else if (georelP->value.s[0] == 0)
   {
-    orionldError(OrionldInvalidRequest, "Invalid Geo-Spatial Filter", "georel value is empty", 400);
+    orionldError(OrionldBadRequestData, "Invalid Geo-Spatial Filter", "georel value is empty", 400);
     return false;
   }
 

diff --git a/src/lib/orionld/payloadCheck/pCheckGeorelString.cpp b/src/lib/orionld/payloadCheck/pCheckGeorelString.cpp
@@ -63,15 +63,15 @@ bool pCheckGeorelString(const char* georel, OrionldGeoInfo* geoInfoP)
   {
     if (geoInfoP->geometry != GeoPoint)
     {
-      orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter", "Geometry must be 'Point' for georel 'near'", 400);
+      orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter", "Geometry must be 'Point' for georel 'near'", 400);
       return false;
     }
   }
   else if (strcmp(georel, "within") == 0)
   {
     if ((geoInfoP->geometry != GeoPolygon) && (geoInfoP->geometry != GeoMultiPolygon))
     {
-      orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter", "Geometry must be either 'Polygon' or 'MultiPolygon' for georel 'within'", 400);
+      orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter", "Geometry must be either 'Polygon' or 'MultiPolygon' for georel 'within'", 400);
       return false;
     }
     geoInfoP->georel = GeorelWithin;
@@ -105,7 +105,7 @@ bool pCheckGeorelString(const char* georel, OrionldGeoInfo* geoInfoP)
   }
   else
   {
-    orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter - invalid 'georel'", georel, 400);
+    orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter - invalid 'georel'", georel, 400);
     return false;
   }
 
@@ -126,7 +126,7 @@ bool pCheckGeorelString(const char* georel, OrionldGeoInfo* geoInfoP)
 
       if (strcmp(grel, "near") != 0)
       {
-        orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter", "invalid geo-relation for Point", 400);
+        orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter", "invalid geo-relation for Point", 400);
         return false;
       }
       geoInfoP->georel = GeorelNear;
@@ -138,7 +138,7 @@ bool pCheckGeorelString(const char* georel, OrionldGeoInfo* geoInfoP)
 
       if (distance == NULL)
       {
-        orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter", "no distance for georel 'near' for Point", 400);
+        orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter", "no distance for georel 'near' for Point", 400);
         return false;
       }
       *distance = 0;
@@ -151,7 +151,7 @@ bool pCheckGeorelString(const char* georel, OrionldGeoInfo* geoInfoP)
         max = false;
       else
       {
-        orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter", "no distance for georel 'near' for Point", 400);
+        orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter", "no distance for georel 'near' for Point", 400);
         return false;
       }
 
@@ -163,7 +163,7 @@ bool pCheckGeorelString(const char* georel, OrionldGeoInfo* geoInfoP)
       {
         if ((*distance < '0') || (*distance > '9'))
         {
-          orionldError(OrionldInvalidRequest,  "Invalid Geo-Spatial filter", "invalid number for distance for georel 'near' for Point", 400);
+          orionldError(OrionldBadRequestData,  "Invalid Geo-Spatial filter", "invalid number for distance for georel 'near' for Point", 400);
           return false;
         }
         ++distance;

diff --git a/src/lib/orionld/rest/orionldMhdConnectionTreat.cpp b/src/lib/orionld/rest/orionldMhdConnectionTreat.cpp
@@ -216,14 +216,14 @@ static bool payloadEmptyCheck(void)
   // No payload?
   if (orionldState.in.payload == NULL)
   {
-    orionldError(OrionldInvalidRequest, "payload missing", NULL, 400);
+    orionldError(OrionldBadRequestData, "payload missing", NULL, 400);
     return false;
   }
 
   // Empty payload?
   if (orionldState.in.payload[0] == 0)
   {
-    orionldError(OrionldInvalidRequest, "payload missing", NULL, 400);
+    orionldError(OrionldBadRequestData, "payload missing", NULL, 400);
     return false;
   }
 
@@ -262,7 +262,7 @@ static bool payloadParseAndExtractSpecialFields(bool* contextToBeCashedP)
   //
   if ((orionldState.requestTree->type != KjArray) && (orionldState.requestTree->type != KjObject))
   {
-    orionldError(OrionldInvalidRequest, "Invalid Payload", "The payload data must be either a JSON Array or a JSON Object", 400);
+    orionldError(OrionldBadRequestData, "Invalid Payload", "The payload data must be either a JSON Array or a JSON Object", 400);
     return false;
   }
 
@@ -271,7 +271,7 @@ static bool payloadParseAndExtractSpecialFields(bool* contextToBeCashedP)
   //
   if ((orionldState.requestTree->type == KjObject) && (orionldState.requestTree->value.firstChildP == NULL))
   {
-    orionldError(OrionldInvalidRequest, "Invalid Payload Body", "Empty Object", 400);
+    orionldError(OrionldBadRequestData, "Invalid Payload Body", "Empty Object", 400);
     return false;
   }
 
@@ -280,7 +280,7 @@ static bool payloadParseAndExtractSpecialFields(bool* contextToBeCashedP)
   //
   if ((orionldState.requestTree->type == KjArray) && (orionldState.requestTree->value.firstChildP == NULL))
   {
-    orionldError(OrionldInvalidRequest, "Invalid Payload Body", "Empty Array", 400);
+    orionldError(OrionldBadRequestData, "Invalid Payload Body", "Empty Array", 400);
     return false;
   }
 

diff --git a/...lTest/cases/0000_ngsild/ngsild_batch_upsert-options=replace_payload_error_validation.test b/...lTest/cases/0000_ngsild/ngsild_batch_upsert-options=replace_payload_error_validation.test
@@ -482,7 +482,7 @@ Date: REGEX(.*)
 {
     "detail": "Empty Array",
     "title": "Invalid Payload Body",
-    "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest"
+    "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData"
 }
 
 

diff --git a/test/functionalTest/cases/0000_ngsild/ngsild_batch_upsert-options=update_error_handling.test b/test/functionalTest/cases/0000_ngsild/ngsild_batch_upsert-options=update_error_handling.test
@@ -636,7 +636,7 @@ Date: REGEX(.*)
 {
     "detail": "Empty Array",
     "title": "Invalid Payload Body",
-    "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest"
+    "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData"
 }
 
 

diff --git a/...functionalTest/cases/0000_ngsild/ngsild_entity_post_operations_create_error_handling.test b/...functionalTest/cases/0000_ngsild/ngsild_entity_post_operations_create_error_handling.test
@@ -558,7 +558,7 @@ Content-Type: application/json
 Date: REGEX(.*)
 
 {
-  "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest",
+  "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
   "title": "Invalid Payload Body",
   "detail": "Empty Array"
 }

diff --git a/...functionalTest/cases/0000_ngsild/ngsild_entity_post_operations_update_error_handling.test b/...functionalTest/cases/0000_ngsild/ngsild_entity_post_operations_update_error_handling.test
@@ -591,7 +591,7 @@ Content-Type: application/json
 Date: REGEX(.*)
 
 {
-  "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest",
+  "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
   "title": "Invalid Payload Body",
   "detail": "Empty Array"
 }

diff --git a/test/functionalTest/cases/0000_ngsild/ngsild_issue_0029.test b/test/functionalTest/cases/0000_ngsild/ngsild_issue_0029.test
@@ -72,7 +72,7 @@ Content-Type: application/json
 Date: REGEX(.*)
 
 {
-  "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest",
+  "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
   "title": "Invalid Payload Body",
   "detail": "Empty Object"
 }
@@ -87,7 +87,7 @@ Content-Type: application/json
 Date: REGEX(.*)
 
 {
-  "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest",
+  "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
   "title": "payload missing",
   "detail": "no detail"
 }
@@ -102,7 +102,7 @@ Content-Type: application/json
 Date: REGEX(.*)
 
 {
-  "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest",
+  "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
   "title": "payload missing",
   "detail": "no detail"
 }
@@ -117,7 +117,7 @@ Content-Type: application/json
 Date: REGEX(.*)
 
 {
-  "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest",
+  "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
   "title": "Invalid Payload Body",
   "detail": "Empty Array"
 }

diff --git a/test/functionalTest/cases/0000_ngsild/ngsild_issue_0504.test b/test/functionalTest/cases/0000_ngsild/ngsild_issue_0504.test
@@ -51,7 +51,7 @@ Date: REGEX(.*)
 {
     "detail": "The payload data must be either a JSON Array or a JSON Object",
     "title": "Invalid Payload",
-    "type": "https://uri.etsi.org/ngsi-ld/errors/InvalidRequest"
+    "type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData"
 }