@checkstack/queue-common 0.0.4 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,157 @@
 # @checkstack/queue-common
 
+## 0.2.0
+
+### Minor Changes
+
+- 180be38: # Queue Lag Warning
+
+  Added a queue lag warning system that displays alerts when pending jobs exceed configurable thresholds.
+
+  ## Features
+
+  - **Backend Stats API**: New `getStats`, `getLagStatus`, and `updateLagThresholds` RPC endpoints
+  - **Signal-based Updates**: `QUEUE_LAG_CHANGED` signal for real-time frontend updates
+  - **Aggregated Stats**: `QueueManager.getAggregatedStats()` sums stats across all queues
+  - **Configurable Thresholds**: Warning (default 100) and Critical (default 500) thresholds stored in config
+  - **Dashboard Integration**: Queue lag alert displayed on main Dashboard (access-gated)
+  - **Queue Settings Page**: Lag alert and Performance Tuning guidance card with concurrency tips
+
+  ## UI Changes
+
+  - Queue lag alert banner appears on Dashboard and Queue Settings when pending jobs exceed thresholds
+  - New "Performance Tuning" card with concurrency settings guidance and bottleneck indicators
+
+- 7a23261: ## TanStack Query Integration
+
+  Migrated all frontend components to use `usePluginClient` hook with TanStack Query integration, replacing the legacy `forPlugin()` pattern.
+
+  ### New Features
+
+  - **`usePluginClient` hook**: Provides type-safe access to plugin APIs with `.useQuery()` and `.useMutation()` methods
+  - **Automatic request deduplication**: Multiple components requesting the same data share a single network request
+  - **Built-in caching**: Configurable stale time and cache duration per query
+  - **Loading/error states**: TanStack Query provides `isLoading`, `error`, `isRefetching` states automatically
+  - **Background refetching**: Stale data is automatically refreshed when components mount
+
+  ### Contract Changes
+
+  All RPC contracts now require `operationType: "query"` or `operationType: "mutation"` metadata:
+
+  ```typescript
+  const getItems = proc()
+    .meta({ operationType: "query", access: [access.read] })
+    .output(z.array(itemSchema))
+    .query();
+
+  const createItem = proc()
+    .meta({ operationType: "mutation", access: [access.manage] })
+    .input(createItemSchema)
+    .output(itemSchema)
+    .mutation();
+  ```
+
+  ### Migration
+
+  ```typescript
+  // Before (forPlugin pattern)
+  const api = useApi(myPluginApiRef);
+  const [items, setItems] = useState<Item[]>([]);
+  useEffect(() => {
+    api.getItems().then(setItems);
+  }, [api]);
+
+  // After (usePluginClient pattern)
+  const client = usePluginClient(MyPluginApi);
+  const { data: items, isLoading } = client.getItems.useQuery({});
+  ```
+
+  ### Bug Fixes
+
+  - Fixed `rpc.test.ts` test setup for middleware type inference
+  - Fixed `SearchDialog` to use `setQuery` instead of deprecated `search` method
+  - Fixed null→undefined warnings in notification and queue frontends
+
+### Patch Changes
+
+- Updated dependencies [7a23261]
+  - @checkstack/common@0.3.0
+  - @checkstack/signal-common@0.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+- 9faec1f: # Unified AccessRule Terminology Refactoring
+
+  This release completes a comprehensive terminology refactoring from "permission" to "accessRule" across the entire codebase, establishing a consistent and modern access control vocabulary.
+
+  ## Changes
+
+  ### Core Infrastructure (`@checkstack/common`)
+
+  - Introduced `AccessRule` interface as the primary access control type
+  - Added `accessPair()` helper for creating read/manage access rule pairs
+  - Added `access()` builder for individual access rules
+  - Replaced `Permission` type with `AccessRule` throughout
+
+  ### API Changes
+
+  - `env.registerPermissions()` → `env.registerAccessRules()`
+  - `meta.permissions` → `meta.access` in RPC contracts
+  - `usePermission()` → `useAccess()` in frontend hooks
+  - Route `permission:` field → `accessRule:` field
+
+  ### UI Changes
+
+  - "Roles & Permissions" tab → "Roles & Access Rules"
+  - "You don't have permission..." → "You don't have access..."
+  - All permission-related UI text updated
+
+  ### Documentation & Templates
+
+  - Updated 18 documentation files with AccessRule terminology
+  - Updated 7 scaffolding templates with `accessPair()` pattern
+  - All code examples use new AccessRule API
+
+  ## Migration Guide
+
+  ### Backend Plugins
+
+  ```diff
+  - import { permissionList } from "./permissions";
+  - env.registerPermissions(permissionList);
+  + import { accessRules } from "./access";
+  + env.registerAccessRules(accessRules);
+  ```
+
+  ### RPC Contracts
+
+  ```diff
+  - .meta({ userType: "user", permissions: [permissions.read.id] })
+  + .meta({ userType: "user", access: [access.read] })
+  ```
+
+  ### Frontend Hooks
+
+  ```diff
+  - const canRead = accessApi.usePermission(permissions.read.id);
+  + const canRead = accessApi.useAccess(access.read);
+  ```
+
+  ### Routes
+
+  ```diff
+  - permission: permissions.entityRead.id,
+  + accessRule: access.read,
+  ```
+
+### Patch Changes
+
+- Updated dependencies [9faec1f]
+- Updated dependencies [f533141]
+  - @checkstack/common@0.2.0
+
 ## 0.0.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/queue-common",
-  "version": "0.0.4",
+  "version": "0.2.0",
   "type": "module",
   "exports": {
     ".": {
@@ -14,6 +14,7 @@
   },
   "dependencies": {
     "@checkstack/common": "workspace:*",
+    "@checkstack/signal-common": "workspace:*",
     "@orpc/contract": "^1.13.2",
     "zod": "^4.0.0"
   },

package/src/access.ts

@@ -0,0 +1,22 @@
+import { accessPair } from "@checkstack/common";
+
+/**
+ * Access rules for the Queue plugin.
+ */
+export const queueAccess = {
+  /**
+   * Queue settings access.
+   */
+  settings: accessPair("queue", {
+    read: "Read Queue Settings",
+    manage: "Update Queue Settings",
+  }),
+};
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const queueAccessRules = [
+  queueAccess.settings.read,
+  queueAccess.settings.manage,
+];

package/src/index.ts

@@ -1,10 +1,6 @@
 export * from "./schemas";
-export * from "./permissions";
-export {
-  queueContract,
-  QueueApi,
-  type QueueContract,
-  type QueueMetadata,
-} from "./rpc-contract";
+export * from "./access";
+export { queueContract, QueueApi, type QueueContract } from "./rpc-contract";
 export * from "./plugin-metadata";
 export { queueRoutes } from "./routes";
+export * from "./signals";

package/src/rpc-contract.ts

@@ -1,38 +1,62 @@
-import { oc } from "@orpc/contract";
-import { createClientDefinition } from "@checkstack/common";
+import { createClientDefinition, proc } from "@checkstack/common";
 import { z } from "zod";
-import { permissions } from "./permissions";
+import { queueAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
 import {
   QueuePluginDtoSchema,
   QueueConfigurationDtoSchema,
   UpdateQueueConfigurationSchema,
+  QueueStatsDtoSchema,
+  QueueLagStatusSchema,
+  QueueLagThresholdsSchema,
 } from "./schemas";
 
-// Permission metadata type
-export interface QueueMetadata {
-  permissions?: string[];
-}
-
-// Base builder with metadata support
-const _base = oc.$meta<QueueMetadata>({});
-
-// Queue RPC Contract with permission metadata
+// Queue RPC Contract with access metadata
 export const queueContract = {
-  // Queue plugin queries - Read permission
-  getPlugins: _base
-    .meta({ permissions: [permissions.queueRead.id] })
-    .output(z.array(QueuePluginDtoSchema)),
+  // Queue plugin queries - Read access
+  getPlugins: proc({
+    operationType: "query",
+    userType: "authenticated",
+    access: [queueAccess.settings.read],
+  }).output(z.array(QueuePluginDtoSchema)),
 
-  getConfiguration: _base
-    .meta({ permissions: [permissions.queueRead.id] })
-    .output(QueueConfigurationDtoSchema),
+  getConfiguration: proc({
+    operationType: "query",
+    userType: "authenticated",
+    access: [queueAccess.settings.read],
+  }).output(QueueConfigurationDtoSchema),
 
-  // Queue configuration updates - Manage permission
-  updateConfiguration: _base
-    .meta({ permissions: [permissions.queueManage.id] })
+  // Queue configuration updates - Manage access
+  updateConfiguration: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [queueAccess.settings.manage],
+  })
     .input(UpdateQueueConfigurationSchema)
     .output(QueueConfigurationDtoSchema),
+
+  // Queue statistics - Read access
+  getStats: proc({
+    operationType: "query",
+    userType: "authenticated",
+    access: [queueAccess.settings.read],
+  }).output(QueueStatsDtoSchema),
+
+  // Queue lag status (includes thresholds) - Read access
+  getLagStatus: proc({
+    operationType: "query",
+    userType: "authenticated",
+    access: [queueAccess.settings.read],
+  }).output(QueueLagStatusSchema),
+
+  // Update lag thresholds - Manage access
+  updateLagThresholds: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [queueAccess.settings.manage],
+  })
+    .input(QueueLagThresholdsSchema)
+    .output(QueueLagThresholdsSchema),
 };
 
 // Export contract type

package/src/schemas.ts

@@ -36,3 +36,50 @@ export const UpdateQueueConfigurationSchema = z.object({
 export type UpdateQueueConfiguration = z.infer<
   typeof UpdateQueueConfigurationSchema
 >;
+
+/**
+ * Queue statistics DTO
+ */
+export const QueueStatsDtoSchema = z.object({
+  pending: z.number(),
+  processing: z.number(),
+  completed: z.number(),
+  failed: z.number(),
+});
+
+export type QueueStatsDto = z.infer<typeof QueueStatsDtoSchema>;
+
+/**
+ * Lag severity levels
+ */
+export const LagSeveritySchema = z.enum(["none", "warning", "critical"]);
+export type LagSeverity = z.infer<typeof LagSeveritySchema>;
+
+/**
+ * Queue lag thresholds configuration
+ */
+export const QueueLagThresholdsSchema = z.object({
+  warningThreshold: z
+    .number()
+    .min(1)
+    .default(100)
+    .describe("Pending job count to trigger warning"),
+  criticalThreshold: z
+    .number()
+    .min(1)
+    .default(500)
+    .describe("Pending job count to trigger critical alert"),
+});
+
+export type QueueLagThresholds = z.infer<typeof QueueLagThresholdsSchema>;
+
+/**
+ * Queue lag status response
+ */
+export const QueueLagStatusSchema = z.object({
+  pending: z.number(),
+  severity: LagSeveritySchema,
+  thresholds: QueueLagThresholdsSchema,
+});
+
+export type QueueLagStatus = z.infer<typeof QueueLagStatusSchema>;

package/src/signals.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import { createSignal } from "@checkstack/signal-common";
+import { LagSeveritySchema } from "./schemas";
+
+/**
+ * Signal broadcast when queue lag status changes.
+ * Frontend listens to update lag warning UI in real-time.
+ */
+export const QUEUE_LAG_CHANGED = createSignal(
+  "queue.lag.changed",
+  z.object({
+    pending: z.number(),
+    severity: LagSeveritySchema,
+  })
+);

package/src/permissions.ts

@@ -1,11 +0,0 @@
-import { createPermission } from "@checkstack/common";
-
-/**
- * Permissions for queue settings
- */
-export const permissions = {
-  queueRead: createPermission("queue", "read", "Read Queue Settings"),
-  queueManage: createPermission("queue", "manage", "Update Queue Settings"),
-};
-
-export const permissionList = Object.values(permissions);