velocious 1.0.558 → 1.0.559

package/src/background-jobs/web/controller.js

@@ -99,7 +99,11 @@ export default class VelociousBackgroundJobsWebController extends Controller {
    */
   async health() {
     await this._respond(async () => {
-      await this.render({json: {ok: true, service: "velocious-background-jobs"}})
+      await this.render({json: {
+        capabilities: {backgroundJobCountDeltas: 1},
+        ok: true,
+        service: "velocious-background-jobs"
+      }})
     })
   }
 
@@ -109,22 +113,15 @@ export default class VelociousBackgroundJobsWebController extends Controller {
    */
   async stats() {
     await this._respond(async () => {
-      const counts = await this._store().countsByStatus()
-      /**
-       * By status.
-       * @type {Record<string, number>} */
-      const byStatus = {}
-      let total = 0
-
-      for (const status of DASHBOARD_STATUSES) {
-        byStatus[status] = counts[status] || 0
-      }
+      const snapshot = await this._store().countSnapshot()
 
-      for (const value of Object.values(counts)) {
-        total += value
-      }
-
-      await this.render({json: {counts: byStatus, generatedAtMs: Date.now(), total}})
+      await this.render({json: {
+        capabilities: {backgroundJobCountDeltas: 1},
+        counts: snapshot.counts,
+        generatedAtMs: Date.now(),
+        revision: snapshot.revision,
+        total: snapshot.total
+      }})
     })
   }
 

package/src/background-jobs/web/counts-channel.js

@@ -0,0 +1,79 @@
+// @ts-check
+
+import {BACKGROUND_JOB_COUNTS_CHANNEL} from "../store.js"
+import VelociousWebsocketChannel from "../../http-server/websocket-channel.js"
+import {authorizeJobsRequest} from "./authorization.js"
+import {getJobsMount} from "./registry.js"
+import {normalizeMountPrefix} from "./path-matcher.js"
+
+/**
+ * Authorized dashboard count-delta channel. Clients subscribe with the mount
+ * path and their normal bearer token as `authenticationToken`.
+ */
+export default class BackgroundJobCountsChannel extends VelociousWebsocketChannel {
+  /**
+   * Authorizes the subscription.
+   * @returns {Promise<boolean>} Whether the mount's normal dashboard authorization allows the subscription.
+   */
+  async canSubscribe() {
+    if (typeof this.params.mountAt !== "string") return false
+
+    const mountAt = normalizeMountPrefix(this.params.mountAt)
+    const options = getJobsMount(this.session.configuration, mountAt)
+
+    if (!options || !this.session.upgradeRequest) return false
+
+    const token = typeof this.params.authenticationToken === "string"
+      ? this.params.authenticationToken
+      : null
+    const ability = await this.session.configuration.resolveAbility({
+      params: this.params,
+      request: this.session.upgradeRequest
+    })
+    const authorized = await authorizeJobsRequest({
+      ability,
+      configuration: this.session.configuration,
+      options,
+      request: this.session.upgradeRequest,
+      token
+    })
+
+    if (!authorized) return false
+
+    this.databaseIdentifier = options.databaseIdentifier
+      || this.session.configuration.getBackgroundJobsConfig().databaseIdentifier
+      || "default"
+
+    return true
+  }
+
+  /**
+   * Matches only events from the database selected by the authorized mount.
+   * @param {import("../../http-server/websocket-channel.js").WebsocketJsonValue} broadcastParams - Publisher scope.
+   * @returns {boolean} Whether this subscription should receive the event.
+   */
+  matches(broadcastParams) {
+    if (!broadcastParams || typeof broadcastParams !== "object" || Array.isArray(broadcastParams)) return false
+
+    return String(/** @type {Record<string, ?>} */ (broadcastParams).databaseIdentifier) === this.databaseIdentifier
+  }
+
+  /**
+   * Builds diagnostics.
+   * @returns {Record<string, string>} Non-sensitive diagnostics.
+   */
+  debugSnapshot() {
+    return {databaseIdentifier: this.databaseIdentifier}
+  }
+
+  /** @type {string} */
+  databaseIdentifier = ""
+
+  /**
+   * Registers the framework channel used by mounted jobs dashboards.
+   * @param {import("../../configuration.js").default} configuration - Configuration.
+   */
+  static register(configuration) {
+    configuration.registerWebsocketChannel(BACKGROUND_JOB_COUNTS_CHANNEL, this)
+  }
+}

package/src/background-jobs/web/index.js

@@ -1,6 +1,7 @@
 // @ts-check
 
 import VelociousBackgroundJobsWebController from "./controller.js"
+import BackgroundJobCountsChannel from "./counts-channel.js"
 import {matchJobsApiPath, normalizeMountPrefix} from "./path-matcher.js"
 import {registerJobsMount} from "./registry.js"
 
@@ -40,6 +41,7 @@ export default class VelociousBackgroundJobsApi {
     const prefix = normalizeMountPrefix(at)
 
     registerJobsMount(configuration, prefix, {accessTokens, allowedOrigins, authorize, databaseIdentifier, redactArgs})
+    BackgroundJobCountsChannel.register(configuration)
 
     configuration.addRouteResolverHook(({currentPath, request}) => {
       const match = matchJobsApiPath({method: request.httpMethod(), path: currentPath, prefix})

package/src/background-jobs/web/registry.js

@@ -3,7 +3,7 @@
 /**
  * JobsMountOptions type.
  * @typedef {object} JobsMountOptions
- * @property {(args: {request: import("../../http-server/client/request.js").default, ability: (import("../../authorization/ability.js").default | undefined), token: (string | null), configuration: import("../../configuration.js").default}) => (boolean | void | Promise<boolean | void>)} [authorize] - Authorization callback. Return true to allow the request.
+ * @property {(args: {request: import("../../http-server/client/request.js").default | import("../../http-server/client/websocket-request.js").default, ability: (import("../../authorization/ability.js").default | undefined), token: (string | null), configuration: import("../../configuration.js").default}) => (boolean | void | Promise<boolean | void>)} [authorize] - Authorization callback. Return true to allow the request.
  * @property {string[]} [accessTokens] - Bearer tokens accepted for cross-origin/native access.
  * @property {string[]} [allowedOrigins] - Origins allowed for cross-origin browser access.
  * @property {boolean} [redactArgs] - When true, job arguments are omitted from API responses.