Add homepage with diagnostics

Author: j6k4m8

bossphorus/__init__.py

@@ -18,23 +18,24 @@
 
 import io
 import json
-
+import os
 from typing import List
 
 import blosc
-from flask import Flask, request, Response, jsonify, make_response
+from flask import Flask, request, Response, jsonify, make_response, render_template
 import numpy as np
 
 from . import storagemanager
 from . import version
 
 __version__ = version.__version__
 
+
 def create_app(mgr: storagemanager.StorageManager = None):
     """
     Create a Bossphorus server app.
     """
-    app = Flask(__name__)
+    app = Flask(__name__, os.path.realpath(__file__))
     if mgr:
         manager = mgr
     else:
@@ -57,7 +58,8 @@ def upload_cutout_xyz(collection, experiment, channel, resolution, x_range, y_ra
         zs = [int(i) for i in z_range.split(":")]
         data = data.reshape(xs[1] - xs[0], ys[1] - ys[0], zs[1] - zs[0])
         data = data.transpose()
-        manager.setdata(data, collection, experiment, channel, resolution, zs, ys, xs)
+        manager.setdata(data, collection, experiment,
+                        channel, resolution, zs, ys, xs)
         return make_response("", 201)
 
     @app.route(
@@ -74,7 +76,8 @@ def upload_cutout_json(collection, experiment, channel, resolution, x_range, y_r
             ys = [int(i) for i in y_range.split(":")]
             zs = [int(i) for i in z_range.split(":")]
             data = data.reshape(xs[1] - xs[0], ys[1] - ys[0], zs[1] - zs[0])
-            manager.setdata(data, collection, experiment, channel, resolution, xs, ys, zs)
+            manager.setdata(data, collection, experiment,
+                            channel, resolution, xs, ys, zs)
         return ""
 
     @app.route(
@@ -112,7 +115,7 @@ def get_experiment(collection, experiment):
         return jsonify({
             "name": experiment,
             "collection": collection,
-            "coord_frame": "NoneSpecified", # TODO
+            "coord_frame": "NoneSpecified",  # TODO
             "description": "",
             "type": "image",
             "base_resolution": 0,
@@ -153,7 +156,8 @@ def get_cutout_xyz(collection, experiment, channel, resolution, x_range, y_range
         ys = [int(i) for i in y_range.split(":")]
         zs = [int(i) for i in z_range.split(":")]
         try:
-            data = manager.getdata(collection, experiment, channel, resolution, xs, ys, zs)
+            data = manager.getdata(
+                collection, experiment, channel, resolution, xs, ys, zs)
             data = np.ascontiguousarray(np.transpose(data))
             response = make_response(blosc.compress(data, typesize=16))
             return response
@@ -165,8 +169,12 @@ def get_cutout_xyz(collection, experiment, channel, resolution, x_range, y_range
             )
 
     @app.route("/")
-    def hello():
-        """Root route."""
-        return __version__
+    def home():
+        return render_template("home.html", **{
+            "version": __version__,
+            "cache_stack":
+                [*manager.get_stack_names()]
+
+        })
 
     return app

bossphorus/storagemanager/StorageManager.py

@@ -49,3 +49,7 @@ def setdata(
             xs: Tuple[int, int], ys: Tuple[int, int], zs: Tuple[int, int]
     ):
         ...
+
+    @abstractmethod
+    def get_stack_names(self):
+        ...

bossphorus/storagemanager/_FilesystemStorageManager.py

@@ -13,14 +13,15 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
-from typing import Tuple
+from typing import Tuple, List
 
 import os
 import numpy as np
 
 from .StorageManager import StorageManager
 from .utils import file_compute, blockfile_indices
 
+
 class FilesystemStorageManager(StorageManager):
     """
     File System management for volumetric data.
@@ -39,6 +40,7 @@ def __init__(
             storage_path: Where to store the data tree
             block_size: How much data should go in each file
         """
+        self.name = "FilesystemStorageManager"
         self.is_terminal = is_terminal
         self.storage_path = storage_path
         self.block_size = block_size
@@ -123,9 +125,9 @@ def getdata(self, col: str, exp: str, chan: str, res: int,
                     i[2][0]:i[2][1],
                 ]
             payload[
-                (f[0] + i[0][0]) - xs[0] : (f[0] + i[0][1]) - xs[0],
-                (f[1] + i[1][0]) - ys[0] : (f[1] + i[1][1]) - ys[0],
-                (f[2] + i[2][0]) - zs[0] : (f[2] + i[2][1]) - zs[0],
+                (f[0] + i[0][0]) - xs[0]: (f[0] + i[0][1]) - xs[0],
+                (f[1] + i[1][0]) - ys[0]: (f[1] + i[1][1]) - ys[0],
+                (f[2] + i[2][0]) - zs[0]: (f[2] + i[2][1]) - zs[0],
             ] = data_partial
 
         return payload
@@ -178,3 +180,6 @@ def retrieve(self, col: str, exp: str, chan: str, res: int,
             (b[2], b[2] + self.block_size[2]),
         )
         return np.load(fname)
+
+    def get_stack_names(self) -> List[str]:
+        return [self.name, *["<END>" if self.is_terminal else "dest"]]

bossphorus/templates/home.html

@@ -0,0 +1,75 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <link href="https://fonts.googleapis.com/css?family=Roboto&display=swap" rel="stylesheet">
+    <style>
+        body,
+        html {
+            font-family: 'Roboto', sans-serif;
+            max-width: 70em;
+            margin: auto;
+        }
+
+        table {
+            width: 100%;
+        }
+
+        table tr:nth-child(2n),
+        thead {
+            background: rgba(10, 10, 40, 0.05);
+        }
+
+        tr:hover {
+            background: rgba(100, 100, 150, 0.1) !important;
+        }
+
+        blockquote {
+            background: rgba(10, 20, 10, 0.05);
+            padding: 1em;
+        }
+    </style>
+    <title>bossphorus {{ version }}</title>
+</head>
+
+<body>
+    <center>
+        <h1>bossphorus server is running.</h1>
+        <h6>bossphorus version {{ version }}</h6>
+    </center>
+
+    <blockquote>
+        <table>
+            <thead>
+                <tr>
+                    <th>Key</th>
+                    <th>Value</th>
+                    <th>Notes</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td>Version</td>
+                    <td>{{ version }}</td>
+                    <td></td>
+                </tr>
+                <tr>
+                    <td rowspan="{{(cache_stack | length) + 1 }}">Cache Stack</td>
+                    <td><code>API Layer</code></td>
+                    <td></td>
+                </tr>
+                {% for layer in cache_stack %}
+                <tr>
+                    <td><code>{{ layer }}</code></td>
+                    <td></td>
+                </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    </blockquote>
+</body>
+
+</html>

local_debug_run.py

@@ -17,4 +17,4 @@
 from bossphorus import create_app
 
 app = create_app()
-app.run(host="0.0.0.0", port=5000, debug=True)
+app.run(host="0.0.0.0", port=5050, debug=True)