now handling known /solve uri better

eirannejad · eirannejad · commit 52addd9bced1 · 2022-08-25T11:30:59.000-07:00
diff --git a/src/ghhops-server-py/examples/app.py b/src/ghhops-server-py/examples/app.py
@@ -20,6 +20,12 @@ def update():
     return "Update example!"
 
 
+# /solve is a builtin method and can not be overrriden
+@app.route("/solve", methods=["GET", "POST"])
+def solve():
+    return "Oh oh! this should not happen!"
+
+
 @hops.component(
     "/binmult",
     inputs=[hs.HopsNumber("A"), hs.HopsNumber("B")],
diff --git a/src/ghhops-server-py/ghhops_server/base.py b/src/ghhops-server-py/ghhops_server/base.py
@@ -18,14 +18,28 @@
 class HopsBase:
     """Base class for all Hops middleware implementations"""
 
+    SOLVE_URI = "/solve"
+
+    ERROR_PAGE_405 = """<!doctype html>
+<html lang=en>
+<title>405 Method Not Allowed</title>
+<h1>Method Not Allowed</h1>
+<p>The method is not allowed for the requested URL.</p>"""
+
     def __init__(self, app):
         self.app = app
         # components dict store each components two times under
         # two keys get uri and solve uri, for faster lookups in query and solve
         # it is assumed that uri and solve uri and both unique to the component
         self._components: dict[str, HopsComponent] = {}
 
-    def contains(self, uri):
+    def handles(self, uri):
+        return uri == HopsBase.SOLVE_URI or uri in self._components
+
+    def is_solve_uri(self, uri):
+        return uri == HopsBase.SOLVE_URI
+
+    def is_comp_uri(self, uri):
         return uri in self._components
 
     def query(self, uri) -> Tuple[bool, str]:
@@ -53,7 +67,7 @@ def solve(self, uri, payload) -> Tuple[bool, str]:
             return False, self._return_with_err("Nothing to solve on root")
 
         # FIXME: remove support for legacy solve behaviour
-        elif uri == "/solve":
+        elif uri == HopsBase.SOLVE_URI:
             data = json.loads(payload)
             comp_uri = data["pointer"]
             if not comp_uri.startswith("/"):
@@ -84,6 +98,11 @@ def _return_with_err(self, err_msg, res_dict=None):
 
         return json.dumps(err_res, cls=_HopsEncoder)
 
+    def _return_method_not_allowed(self, environ, start_response):
+        response = self._prep_response(405, "Method Not Allowed")
+        response.data = HopsBase.ERROR_PAGE_405.encode(encoding="utf_8")
+        return response(environ, start_response)
+
     def _get_all_comps_data(self):
         # return json formatted string of all components metadata
         return json.dumps(list(self._components.values()), cls=_HopsEncoder)
diff --git a/src/ghhops-server-py/ghhops_server/middlewares/hopsflask.py b/src/ghhops-server-py/ghhops_server/middlewares/hopsflask.py
@@ -7,12 +7,6 @@
 class HopsFlask(base.HopsBase):
     """Hops Middleware for Flask"""
 
-    ERROR_PAGE_405 = """<!doctype html>
-    <html lang=en>
-    <title>405 Method Not Allowed</title>
-    <h1>Method Not Allowed</h1>
-    <p>The method is not allowed for the requested URL.</p>"""
-
     def __init__(self, flask_app):
         # keep a ref to original flask app
         super(HopsFlask, self).__init__(flask_app)
@@ -36,18 +30,36 @@ def __call__(self, environ, start_response):
         comp_uri = request.path
 
         # if uri is registered on the hops app
-        if self.contains(comp_uri):
+        if self.handles(comp_uri):
             if method == "GET":
-                # if component exists
+                # if calling GET /solve, respond 405
+                if self.is_solve_uri(comp_uri):
+                    return self._return_method_not_allowed(
+                        environ,
+                        start_response
+                        )
+
+                # if component exists, return component data
                 res, results = self.query(uri=comp_uri)
                 if res:
                     response = self._prep_response()
                     response.data = results
+
+                # otherwise return 404
                 else:
                     response = self._prep_response(404, "Unknown URI")
+
                 return response(environ, start_response)
 
             elif method == "POST":
+                # if POST on component uri, return 405
+                if self.is_comp_uri(comp_uri):
+                    return self._return_method_not_allowed(
+                        environ,
+                        start_response
+                        )
+
+                # otherwise try to solve with payload
                 data = request.data
                 res, results = self.solve(uri=comp_uri, payload=data)
                 if res:
@@ -56,12 +68,11 @@ def __call__(self, environ, start_response):
                 else:
                     response = self._prep_response(404, "Execution Error")
                     response.data = results.encode(encoding="utf_8")
+
                 return response(environ, start_response)
 
             # respond with 405 if method is not valid
-            response = self._prep_response(405, "Method Not Allowed")
-            response.data = HopsFlask.ERROR_PAGE_405.encode(encoding="utf_8")
-            return response(environ, start_response)
+            return self._return_method_not_allowed(environ, start_response)
 
         # otherwise ask wapped app to process the call
         return self.wsgi_app(environ, start_response)
