Merge pull request #60 from OpenAF/codex/add-http-browser-api-job

Document HTTP Browser API and remove unused `options` arg

Author: nmaguiar

.package.yaml

@@ -71,9 +71,9 @@ files:
 - oJobs.yaml
 filesHash:
   LICENSE: 92170cdc034b2ff819323ff670d3b7266c8bffcd
-  README.md: 37d4f8c68b50da5c8e10d123045690d89379a432
+  README.md: fc1de27ad943a8563e974a3edf9c1a5aec60ec6d
   oJobBasics.yaml: a084f112233ea3faa11eb9bcc16871c721d05f5b
-  oJobBrowse.yaml: 75eb7f2ba1e6dc8cb51fb40ef9318f5a1f7280d5
+  oJobBrowse.yaml: ccb66c97c3ff64c894ae7710ddac73b862d9db5d
   oJobCh.yaml: 4290a3d5dc035a6d7b6659aeb0e370d0bb55be58
   oJobDebug.yaml: bfb5debec954e3b524ae4ce103d6ea8e780448e9
   oJobDirector.yaml: ec87282023bd8ed30170d330e17ddf6fbb1e3618

README.md

@@ -1094,6 +1094,21 @@ Pagination:
 - `renderList` will render pager controls when the list metadata includes `pageInfo` with `page`, `pageSize`, and `total`.
 - If `pageInfo` is not present, it falls back to query parameters `page` and `pageSize`.
 
+### HTTP Browser API
+
+HTTP API to access `getList`/`getObj` for any `HTTP Browse generic` instance.
+
+| Argument | Type | Mandatory | Description |
+|----------|------|-----------|-------------|
+| port | Number | No | The port where the server was made available (defaults to 8091) |
+| uri | String | No | The URI where the HTTP Browser API will be available (defaults to "/api/browse") |
+| browseUri | String | No | The HTTP Browse generic URI to target (can be overridden by request param `browseUri`) |
+
+Query parameters:
+- `action`: `list` (default) or `obj`.
+- `path`: Optional relative path appended to the target browse URI.
+- `raw`: When `true`, streams the object response if possible.
+
 ### HTTP Browser
 
 HTTP browser service based on existing types (e.g., ow.server.httpd.browse.files).

oJobBrowse.yaml

@@ -181,7 +181,7 @@ jobs:
         if (isDef(lst.pageInfo.pageSize)) _pageSize = Number(lst.pageInfo.pageSize)
       } else {
         if (isDef(request.params.page)) _page = Number(request.params.page)
-        if (isDef(request.params.pageSize)) _pageSize = Number(request.params.pageSize)
+        //if (isDef(request.params.pageSize)) _pageSize = Number(request.params.pageSize)
       }
       if (!isNumber(_page) || _page <= 0) _page = 1
       if (!isNumber(_pageSize) || _pageSize < 0) _pageSize = 0
@@ -423,3 +423,67 @@ jobs:
     _options.parentPath = args.path
     _options.port       = args.port
     global.__GBHTTPD[String(args.port) + args.uri] = _options
+
+# --------------------------
+- name : HTTP Browser API
+  deps :
+  - HTTP Start Server
+  to   : HTTP Service
+  typeArgs:
+    noLog: false
+    shortcut:
+      name  : httpdBrowserAPI
+      keyArg: port
+      args  :
+        uri      : uri
+        browseUri: browseUri
+  help :
+   text   : Provides a HTTP API to access getList/getObj for any HTTP Browse generic implementation.
+   expects:
+   - name: port
+     desc: (Number) The port where the server was made available (default is 8091)
+   - name: uri
+     desc: (String) The URI where the HTTP Browser API will be available.
+   - name: browseUri
+     desc: (String) The HTTP Browse generic URI to target (can be overridden by request param browseUri)
+  check:
+    in:
+      port     : toNumber.isNumber.default(8091)
+      uri      : isString.default("/api/browse")
+      browseUri: isString.default(__)
+  args :
+    execURI: | #js
+      try {
+        var targetUri = args.browseUri
+        if (isUnDef(targetUri) || targetUri === "") targetUri = request.params.browseUri
+        if (isUnDef(targetUri) || targetUri === "") targetUri = request.params.uri
+        if (isUnDef(targetUri) || targetUri === "") {
+          return { data: "Missing browseUri", mimetype: "text/plain", status: 400, header: {} }
+        }
+
+        var _options = global.__GBHTTPD[String(port) + targetUri]
+        if (isUnDef(_options)) {
+          return { data: "Unknown browseUri", mimetype: "text/plain", status: 404, header: {} }
+        }
+
+        var targetPath = _$(request.params.path).isString().default("")
+        var _req = merge({}, request)
+        _req.uri = targetUri + (targetPath.length > 0 ? "/" + targetPath.replace(/^\/+/, "") : "")
+
+        var action = _$(request.params.action).isString().default("list")
+        if (action == "obj") {
+          var _obj = _options._fns.getObj(_req, _options)
+          if (request.params.raw == "true") {
+            if (isDef(_obj.stream)) return server.replyStream(_obj.stream, ow.server.httpd.getMimeType(targetPath))
+            if (isDef(_obj.file)) return server.replyStream(io.readFileStream(_obj.file), ow.server.httpd.getMimeType(targetPath))
+            if (isDef(_obj.data)) return server.replyOK(_obj.data, ow.server.httpd.getMimeType(targetPath))
+          }
+          return ow.server.httpd.replyJSMap(server, _obj)
+        }
+
+        var _lst = _options._fns.getList(_req, _options)
+        return ow.server.httpd.replyJSMap(server, _lst)
+      } catch(e) {
+        logErr(`Error: ${e.message}`)
+        return { data: "Internal error", mimetype: "text/plain", status: 500, header: {} }
+      }