Advance version & update changelog

Author: ybnd

docs/changelog.md

@@ -1,7 +1,39 @@
 # changelog
 
 * **`0.4.3` API overhaul**
-  * Test the frontend as well
+  * Add frontend tests
+    * And also some general clean-up and fixes in the process
+  * Deprecate caching contexts and related functionality
+    * We’re assuming that caching will never be performed *in advance* of an analysis. Instead, we rely on caching during an analysis to speed up any subsequent analyses.
+  * Separate internal routing from general Flask routing
+    * API routes are organised based on `Dispatcher` 
+    * `Dispatcher` instances map addresses to `Endpoint` instances
+    * Nested `Dispatcher` include the addresses of any child `Dispatcher` instances in their own address space
+    * The top-level `Dispatcher` has a flat address space of all endpoints, which it uses to resolve requests
+    * The Flask server delegates requests to this top-level `Dispatcher` for addresses starting with `/api/` 
+  * Expose `Endpoint` instances with own `expose()` method instead of global function
+  * Deprecate `RootInstance`
+    * Implementation should not care about routing
+    * *Note: this means that methods of `BackendInstance` subclass instances nested in `VideoAnalyzer` can no longer be exposed at `Endpoint` instances. Only methods of objects associated with `Dispatcher` instances can be exposed.*
+  * More sensible API structure
+    * Global top-level API at `api`
+    * Group related functionality
+      * `api`: general stuff
+      * `api.fs`: dealing with files and directories
+      * `api.cache`: dealing with the cache
+      * `api.db`: dealing with the database
+      * `api.va`: dealing with analyzers
+      * `api.va.<id>`: dealing with a specific analyzer
+  * Open analyzers are handled by new `Dispatcher` instances
+    * Analyzer methods should be exposed with the placeholder `Dispatcher` at `api.va.__id__`
+      * By themselves, methods exposed in this way can’t be invoked since they don’t have an instance yet
+    * New analyzers are opened from `main._VideoAnalyzerManager` and given an `id`
+      * Use shorter `id` strings for URL readability
+      * Associate newly instantiated `VideoAnalyzer` with a new `Dispatcher` instance at `api.va.<id>`
+      * This `Dispatcher`, binds methods exposed in `api.va.__id__` to the `VideoAnalyzer` instance
+      * *Now* these methods can be invoked when requested by `/api/va/<id>/<endpoint>`
+    * Included in top-level address space at launch to reduce address resolution overhead
+  * Mirror API structure in frontend `api.js`
 * **`0.4.2`  CLI overhaul**
   * Subcommands to divide up the functionality of the library. 
     * Implemented to make accessing backend schemas easier when testing the frontend; instead of starting the whole server, run `sf.py dump <path>`. The server is now a subcommand, `serve`. 

shapeflow/__init__.py

@@ -25,7 +25,7 @@
 import diskcache
 
 # Library version
-__version__: str = '0.4.2'
+__version__: str = '0.4.3'
 
 # Get root directory
 _user_dir = pathlib.Path.home()
@@ -395,4 +395,4 @@ def get_cache(s: Settings = settings, retry: bool = False) -> diskcache.Cache:
             get_cache(settings, retry=True)
         else:
             log.error(f"could not open cache on retry")
-            raise e
+            raise e

ui/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "shapeflow-ui",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "",
   "author": "ybnd <ybnd@tuta.io>",
   "private": true,