REST API Error Handling Improvements & Import of dtnma-tools SQL concurrency fix (#322)

* Updated REST APIs to return correct error codes, and updated dtnma-tools to bring in fixes for SQL concurrency causing reliability issues.

* Add REFDA startup to allow ipn-scheme managers all access

* Updating all deps references.

* Force CI build to run with no-cache

* Revert "Force CI build to run with no-cache"

This reverts commit b19e333.

* Address SonarQube documentation warning.

* Use HTTP status code enums consistently.

* Fixed an additional error return.

---------

Co-authored-by: Brian Sipos <brian.sipos@jhuapl.edu>
Co-authored-by: Madeline Farina <Madeline.Farina@extcloud.jhuapl.edu>

Author: 3 people

anms-core/anms/routes/network_manager.py

@@ -21,7 +21,7 @@
 # the prime contract 80NM0018D0004 between the Caltech and NASA under
 # subcontract 1658085.
 #
-from fastapi import APIRouter, status
+from fastapi import APIRouter, status, HTTPException
 import requests
 from pydantic import BaseModel
 
@@ -51,7 +51,7 @@ async def nm_get_version():
     try:
         request = requests.get(url=url)
     except Exception:
-        return {}
+        raise HTTPException(status_code=status.HTTP_504_GATEWAY_TIMEOUT, detail="ConnectTimeout")
     return request.json()
 
 
@@ -63,7 +63,7 @@ def nm_get_agents():
     try:
         request = requests.get(url=url)
     except Exception:
-        return -1
+        raise HTTPException(status_code=status.HTTP_504_GATEWAY_TIMEOUT, detail="ConnectTimeout")
     return request.json()
 
 
@@ -90,20 +90,20 @@ def do_nm_put_hex_eid(eid: str, ari: str):
     url = nm_url + "/agents/eid/{}/send?form=hex".format(_prepare_url(eid))
     logger.info('post to nm manager %s  with eid %s and data %s' % (url, eid, ari))
 
-    try:        
+    try:
         request = requests.post(url=url,
                                 data=ari,
                                 headers={'Content-Type': 'text/plain'},
                                 timeout=(2.0, 8.0) # 2s for manager to connect, 8s for it to respond
                                 )
     except requests.exceptions.ConnectTimeout:
-        return status.HTTP_504_GATEWAY_TIMEOUT
+        raise HTTPException(status_code=status.HTTP_504_GATEWAY_TIMEOUT, detail="ConnectTimeout")
     except requests.exceptions.ReadTimeout:
-        return status.HTTP_504_GATEWAY_TIMEOUT
+        raise HTTPException(status_code=status.HTTP_504_GATEWAY_TIMEOUT, detail="ReadTimeout")
     except requests.exceptions.Timeout:
-        return status.HTTP_504_GATEWAY_TIMEOUT
+        raise HTTPException(status_code=status.HTTP_504_GATEWAY_TIMEOUT, detail="Timeout")
     except Exception:
-        return status.HTTP_500_INTERNAL_SERVER_ERROR
+        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR)
     return request.status_code
 
 

anms-core/anms/routes/transcoder.py

@@ -22,8 +22,7 @@
 import time
 import asyncio
 
-from fastapi import APIRouter, Depends
-from fastapi import status
+from fastapi import APIRouter, Depends, status, HTTPException
 from fastapi_pagination import Page, Params
 from fastapi_pagination.ext.async_sqlalchemy import paginate
 
@@ -144,7 +143,7 @@ async def transcoder_put_await_str(input_ari: str):
 def transcoder_incoming_str(input_ari: str):
     return _transcoder_put_str(input_ari)
 
-def _transcoder_put_str(input_ari: str):
+def transcoder_put_str(input_ari: str):
     input_ari = input_ari.strip()
     transcoder_log_id = None
     send_to_transcode = False
@@ -171,7 +170,11 @@ def _transcoder_put_str(input_ari: str):
 
 
 # PUT 	/ui/incoming_send/str 	Body is str ARI to send to transcoder
-@router.put("/ui/incoming_send/str", status_code=status.HTTP_200_OK)
+@router.put("/ui/incoming_send/str", status_code=status.HTTP_200_OK,
+            responses={
+                status.HTTP_500_INTERNAL_SERVER_ERROR: {"description" : "Error response from NM"},
+                status.HTTP_504_GATEWAY_TIMEOUT: {"description" : "Manager response timed out"}
+                       })
 async def transcoder_send_ari_str(eid: str, ari: str):
     try:
         # Perform translation (API wrapper)
@@ -188,18 +191,24 @@ async def transcoder_send_ari_str(eid: str, ari: str):
             if info.parsed_as != "pending":
                 break
             if retries <= 0:
-                return { "idinfo" : idinfo, "info" : info, "status" : 504 }
+                raise HTTPException(status_code=status.HTTP_504_GATEWAY_TIMEOUT,
+                                    detail={ "idinfo" : idinfo, "info" : info, "status" : "transcoder timeout" })
+
             retries -= 1
 
         if info.parsed_as == "ERROR":
-            return { "idinfo" : idinfo, "info" : info, "status" : 500 }
+            raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+                                detail={ "idinfo" : idinfo, "info" : info, "status" : 500 })
 
         # Publish
         state = do_nm_put_hex_eid( eid, info.cbor )
-
         return { "idinfo" : idinfo, "info" : info, "status" : state }
+    except HTTPException as e:
+        e.detail = { "idinfo" : idinfo, "info" : info, "status" : e.status_code }
+        raise e
     except Exception as e:
         logger.exception(e)
-        return status.HTTP_500_INTERNAL_SERVER_ERROR
+        raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR)
+
 
 

deps/dtnma-adms

@@ -175,6 +175,7 @@ RUN systemctl enable ion bpecho@4 refda-ion && \
     mkdir -p /var/run/ion
 
 # Runtime config for this container
+COPY deps/dtnma-tools/integration-test-ion/startup.uri /etc/refda/startup.uri
 COPY deps/test-ion-configs/agent-2.rc /etc/ion/node-2.rc
 COPY deps/test-ion-configs/agent-3.rc /etc/ion/node-3.rc