Evenfire is an intelligence layer platform for running LLM agents that take real actions, on your infrastructure
TypeScript
fix(entity-changes): resolve r2-b1 producer fixture gap
Josué03efb9b6b510
diff --git a/control-ui/components/__tests__/GfsBrowser.test.tsx b/control-ui/components/__tests__/GfsBrowser.test.tsxindex 814e87ba7..adec73792 100644--- a/control-ui/components/__tests__/GfsBrowser.test.tsx+++ b/control-ui/components/__tests__/GfsBrowser.test.tsx@@ -1,5 +1,6 @@import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'import { act, fireEvent, render, screen, waitFor, within } from '@testing-library/react'+import { EventEmitter } from 'node:events'import { normalizeGfsResourceName } from '@clerum/gfs-interaction-policy'import { GFS_FILE_UPLOAD_PROTOCOL_MAX_BYTES } from '@constants/gfsFileUpload'import { GFS_IMAGE_PREVIEW_MAX_BYTES } from '@constants/gfsImagePreview'@@ -23,6 +24,10 @@ import {normalizeUploadProductMaxBytes,uploadGfsFile,} from '@lib/gfsFileUpload'+import {+ closeActiveEntityChangeStreams,+ streamEntityChanges,+} from '../../../control-api/src/routes/entityChangeStream.js'import { GfsBrowser } from '../GfsBrowser'import { ToastProvider } from '../Toast'@@ -62,6 +67,30 @@ vi.mock('@lib/gfsFileUpload', async importOriginal => ({})),}))+const controlApiProducer = vi.hoisted(() => ({+ isEntityChangeCursor: vi.fn(),+ readEntityChangeCheckpoint: vi.fn(),+ subscribeEntityChangeFeedWake: vi.fn(),+}))+const controlApiProducerConfig = vi.hoisted(() => ({+ entityChangeStreamHeartbeatMs: 20_000,+ entityChangeStreamMaxLifetimeMs: 600_000,+ entityChangeStreamPollMs: 250,+}))+const controlApiProducerMetrics = vi.hoisted(() => ({+ entityChangeStreamConnectionsActive: { inc: vi.fn(), dec: vi.fn() },+ entityChangeStreamDisconnectsTotal: { inc: vi.fn(), dec: vi.fn() },+ entityChangeStreamFramesSentTotal: { inc: vi.fn(), dec: vi.fn() },+ entityChangeStreamResyncRequiredTotal: { inc: vi.fn(), dec: vi.fn() },+}))++vi.mock('../../../control-api/src/config.js', () => ({ config: controlApiProducerConfig }))+vi.mock('../../../control-api/src/services/entityChangeService.js', () => controlApiProducer)+vi.mock('../../../control-api/src/observability/logger.js', () => ({+ rootLogger: { child: () => ({ info: vi.fn(), warn: vi.fn(), error: vi.fn() }) },+}))+vi.mock('../../../control-api/src/observability/metrics.js', () => controlApiProducerMetrics)+const mockApiGet = apiGet as unknown as ReturnType<typeof vi.fn>const mockApiSend = apiSend as unknown as ReturnType<typeof vi.fn>const mockGetAdminUsers = vi.mocked(getAdminUsers)@@ -78,6 +107,71 @@ const mockCreateGfsUploadJob = createGfsUploadJob as unknown as ReturnType<typeoconst mockCreateObjectUrl = vi.fn((_blob: Blob) => 'blob:gfs-image-preview')const mockRevokeObjectUrl = vi.fn()+class ControlApiProducerRequest extends EventEmitter {+ query: Record<string, unknown> = {}+ setTimeout = vi.fn()+}++class ControlApiProducerResponse extends EventEmitter {+ statusCode = 200+ headersSent = false+ destroyed = false+ writableEnded = false+ writableLength = 0+ frames: string[] = []+ status(code: number): this {+ this.statusCode = code+ return this+ }+ setHeader(): this {+ return this+ }+ flushHeaders(): void {+ this.headersSent = true+ }+ write(frame: string): boolean {+ this.frames.push(frame)+ return true+ }+ end(): void {+ this.writableEnded = true+ this.emit('close')+ }+ json(): this {+ return this+ }+}++async function controlApiProducerFrame(+ scopes: Array<'gfs' | 'authorization'> = ['gfs']+): Promise<string> {+ const cursor = 'd119f895-1ef8-4e73-8f08-f9754919682a'+ controlApiProducer.readEntityChangeCheckpoint.mockResolvedValue({+ resyncRequired: false,+ cursor,+ scopes,+ })+ const req = new ControlApiProducerRequest()+ const res = new ControlApiProducerResponse()+ streamEntityChanges(+ req as unknown as Parameters<typeof streamEntityChanges>[0],+ res as unknown as Parameters<typeof streamEntityChanges>[1],+ null,+ async () => true,+ 'operator'+ )+ await vi.waitFor(() => expect(res.frames.length).toBeGreaterThan(0))+ closeActiveEntityChangeStreams()+ await vi.waitFor(() => expect(res.writableEnded).toBe(true))+ const frame = res.frames+ .map(value => value.trim())+ .find(value => {+ return (JSON.parse(value) as { type?: string }).type === 'scope.invalidated'+ })+ if (!frame) throw new Error('Control API producer did not emit a scope invalidation')+ return frame+}+function renderBrowser() {return render(<ToastProvider>@@ -128,6 +222,11 @@ function child(name: string, kind: string, n: number) {describe('GfsBrowser', () => {beforeEach(() => {+ controlApiProducer.isEntityChangeCursor.mockImplementation((value: string) =>+ /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(value)+ )+ controlApiProducer.readEntityChangeCheckpoint.mockReset()+ controlApiProducer.subscribeEntityChangeFeedWake.mockReset().mockReturnValue(vi.fn())mockApiGet.mockReset()mockApiSend.mockReset()mockGetAdminUsers.mockReset()@@ -214,6 +313,7 @@ describe('GfsBrowser', () => {})afterEach(() => {+ closeActiveEntityChangeStreams()vi.unstubAllGlobals()})@@ -454,12 +554,7 @@ describe('GfsBrowser', () => {)mockApiSend.mockImplementationOnce(async () => {created = true- const frame = JSON.stringify({- schemaVersion: 1,- type: 'scope.invalidated',- cursor: 'd119f895-1ef8-4e73-8f08-f9754919682a',- scopes: ['gfs'],- })+ const frame = await controlApiProducerFrame()const encoded = new TextEncoder().encode(`${frame}\n`)for (const controller of streamControllers) controller.enqueue(encoded)return { ok: true }@@ -495,6 +590,83 @@ describe('GfsBrowser', () => {expect(JSON.stringify(mockApiSend.mock.calls)).toContain('remote-folder')})+ it('recovers the current list and open preview after one transient invalidation refetch failure', async () => {+ const streamControllers: ReadableStreamDefaultController<Uint8Array>[] = []+ let remoteChanged = false+ let treeFailureUsed = false+ let previewFailureUsed = false+ mockApiGet.mockResolvedValueOnce({+ items: [child('avatar.PNG', 'file', 12)],+ nextCursor: null,+ })+ mockGfsFetchFileBlob.mockResolvedValue(new Blob(['image bytes']))+ vi.stubGlobal(+ 'fetch',+ vi.fn(async (_input: RequestInfo | URL, init?: RequestInit) => {+ const body = new ReadableStream<Uint8Array>({+ start(controller) {+ streamControllers.push(controller)+ init?.signal?.addEventListener('abort', () => controller.close(), { once: true })+ },+ })+ return new Response(body, {+ status: 200,+ headers: { 'content-type': 'application/x-ndjson' },+ })+ })+ )++ renderBrowser()+ await waitFor(() => expect(streamControllers).toHaveLength(1))+ fireEvent.click(await screen.findByRole('button', { name: 'avatar.PNG' }))+ const originalDialog = await screen.findByRole('dialog', { name: 'avatar.PNG' })+ await within(originalDialog).findByRole('img', { name: 'Preview of avatar.PNG' })++ remoteChanged = true+ mockApiGet.mockImplementation(async (path: string, query?: Record<string, string>) => {+ if (path === '/api/v1/gfs/tree') {+ if (!treeFailureUsed) {+ treeFailureUsed = true+ throw Object.assign(new Error('503 Service Unavailable'), { status: 503 })+ }+ return {+ items: [child('avatar.PNG', 'file', 12), child('remote-folder', 'directory', 99)],+ nextCursor: null,+ }+ }+ if (path === '/api/v1/gfs/resolve' && query?.uri === 'gfs://main/r12') {+ if (!previewFailureUsed) {+ previewFailureUsed = true+ throw Object.assign(new Error('503 Service Unavailable'), { status: 503 })+ }+ return {+ kind: 'file',+ resourceId: 'id-12',+ rid: 'r12',+ name: 'avatar.PNG',+ bytes: 4,+ version: 2,+ }+ }+ return { items: [], nextCursor: null }+ })+ const producerFrame = await controlApiProducerFrame()+ await act(async () => {+ streamControllers[0]!.enqueue(new TextEncoder().encode(`${producerFrame}\n`))+ })++ const unavailableDialog = await screen.findByRole('dialog', { name: 'File unavailable' })+ expect(within(unavailableDialog).queryByRole('img')).toBeNull()+ await screen.findByText('remote-folder')+ const recoveredDialog = await screen.findByRole('dialog', { name: 'avatar.PNG' })+ expect(+ await within(recoveredDialog).findByRole('img', { name: 'Preview of avatar.PNG' })+ ).toBeTruthy()+ expect(treeFailureUsed).toBe(true)+ expect(previewFailureUsed).toBe(true)+ expect(mockApiGet).toHaveBeenCalledWith('/api/v1/gfs/resolve', { uri: 'gfs://main/r12' })+ })+it('rebuilds the open directory breadcrumbs after a remote move', async () => {const rootId = 'root-id'const streamControllers: ReadableStreamDefaultController<Uint8Array>[] = []@@ -566,12 +738,7 @@ describe('GfsBrowser', () => {fireEvent.click(await screen.findByRole('button', { name: 'old-folder' }))await screen.findByText('No resources are visible in this folder.')- const frame = JSON.stringify({- schemaVersion: 1,- type: 'scope.invalidated',- cursor: 'd119f895-1ef8-4e73-8f08-f9754919682a',- scopes: ['gfs'],- })+ const frame = await controlApiProducerFrame()await act(async () => {streamControllers[0].enqueue(new TextEncoder().encode(`${frame}\n`))})@@ -635,12 +802,7 @@ describe('GfsBrowser', () => {await within(dialog).findByLabelText(`Video preview of ${fileName}`)}- const frame = JSON.stringify({- schemaVersion: 1,- type: 'scope.invalidated',- cursor: 'd119f895-1ef8-4e73-8f08-f9754919682a',- scopes: ['authorization'],- })+ const frame = await controlApiProducerFrame(['authorization'])await act(async () => {streamControllers[0]!.enqueue(new TextEncoder().encode(`${frame}\n`))})diff --git a/control-ui/package-lock.json b/control-ui/package-lock.jsonindex d7ae0683f..3e36f6fe6 100644--- a/control-ui/package-lock.json+++ b/control-ui/package-lock.json@@ -1,12 +1,12 @@{"name": "clerum-control-ui",- "version": "0.1.610",+ "version": "0.1.611","lockfileVersion": 3,"requires": true,"packages": {"": {"name": "clerum-control-ui",- "version": "0.1.610",+ "version": "0.1.611","dependencies": {"@clerum/display-field": "file:../packages/display-field","@clerum/frontend-components": "file:../packages/frontend-components",diff --git a/control-ui/package.json b/control-ui/package.jsonindex 71611322d..10127ee47 100644--- a/control-ui/package.json+++ b/control-ui/package.json@@ -1,6 +1,6 @@{"name": "clerum-control-ui",- "version": "0.1.610",+ "version": "0.1.611","private": true,"scripts": {"dev": "NEXT_IGNORE_INCORRECT_LOCKFILE=1 next dev",diff --git a/external-rest-api/package-lock.json b/external-rest-api/package-lock.jsonindex 81c281065..c47638178 100644--- a/external-rest-api/package-lock.json+++ b/external-rest-api/package-lock.json@@ -1,12 +1,12 @@{"name": "clerum-external-rest-api",- "version": "0.1.85",+ "version": "0.1.86","lockfileVersion": 3,"requires": true,"packages": {"": {"name": "clerum-external-rest-api",- "version": "0.1.85",+ "version": "0.1.86","dependencies": {"cors": "^2.8.5","express": "^4.21.2",diff --git a/external-rest-api/package.json b/external-rest-api/package.jsonindex ce716823a..01619c163 100644--- a/external-rest-api/package.json+++ b/external-rest-api/package.json@@ -1,6 +1,6 @@{"name": "clerum-external-rest-api",- "version": "0.1.85",+ "version": "0.1.86","description": "External REST API for profile, team management, and RPC token brokerage","main": "dist/main.js","engines": {diff --git a/external-rest-api/src/releaseManifest.ts b/external-rest-api/src/releaseManifest.tsindex 9aa61a7a8..014df50c4 100644--- a/external-rest-api/src/releaseManifest.ts+++ b/external-rest-api/src/releaseManifest.ts@@ -8,7 +8,7 @@ export type ReleaseManifest = {export const releaseManifest: ReleaseManifest = {releaseId: 'v0.9.0',- externalRestApiVersion: '0.1.85',+ externalRestApiVersion: '0.1.86',rpcProxyVersion: '0.1.89',desktopVersion: '0.9.0',minimumDesktopVersion: '0.1.252',diff --git a/external-rest-api/test/entityChanges.producerContract.test.ts b/external-rest-api/test/entityChanges.producerContract.test.tsnew file mode 100644index 000000000..53fc500cd--- /dev/null+++ b/external-rest-api/test/entityChanges.producerContract.test.ts@@ -0,0 +1,185 @@+import { beforeEach, describe, expect, it, vi } from 'vitest'+import type { Request, Response } from 'express'+import express from 'express'+import { EventEmitter } from 'node:events'+import request from 'supertest'+import {+ closeActiveEntityChangeStreams,+ streamEntityChanges,+} from '../../control-api/src/routes/entityChangeStream.js'+import { parseEntityChangeFrame } from '../../control-ui/lib/entityChangeStream.js'+import { AuthClient } from '../../desktop-app/src/authClient.js'+import { createEntityChangesRouter } from '../src/routes/entityChanges.js'++const producerMocks = vi.hoisted(() => ({+ isEntityChangeCursor: vi.fn(),+ readEntityChangeCheckpoint: vi.fn(),+ subscribeEntityChangeFeedWake: vi.fn(),+}))+const producerConfig = vi.hoisted(() => ({+ entityChangeStreamHeartbeatMs: 20_000,+ entityChangeStreamMaxLifetimeMs: 600_000,+ entityChangeStreamPollMs: 250,+}))+const producerMetrics = vi.hoisted(() => ({+ entityChangeStreamConnectionsActive: { inc: vi.fn(), dec: vi.fn() },+ entityChangeStreamDisconnectsTotal: { inc: vi.fn(), dec: vi.fn() },+ entityChangeStreamFramesSentTotal: { inc: vi.fn(), dec: vi.fn() },+ entityChangeStreamResyncRequiredTotal: { inc: vi.fn(), dec: vi.fn() },+}))+const externalAuth = vi.hoisted(() => ({ verifyToken: vi.fn() }))+const externalControlApi = vi.hoisted(() => ({+ controlApiStreamRequest: vi.fn(),+ ControlApiError: class ControlApiError extends Error {+ status: number+ body: unknown+ headers: Record<string, string>+ constructor(message: string, status: number, body: unknown, headers = {}) {+ super(message)+ this.status = status+ this.body = body+ this.headers = headers+ }+ },+}))++vi.mock('../../control-api/src/config.js', () => ({ config: producerConfig }))+vi.mock('../../control-api/src/services/entityChangeService.js', () => producerMocks)+vi.mock('../../control-api/src/observability/logger.js', () => ({+ rootLogger: { child: () => ({ info: vi.fn(), warn: vi.fn(), error: vi.fn() }) },+}))+vi.mock('../../control-api/src/observability/metrics.js', () => producerMetrics)+vi.mock('../src/authToken.js', () => externalAuth)+vi.mock('../src/controlApiClient.js', () => externalControlApi)+vi.mock('../../desktop-app/src/config.js', () => ({+ config: { externalRestApiBaseUrl: 'http://rest', requestTimeoutMs: 60_000 },+}))++const CURSOR = 'd119f895-1ef8-4e73-8f08-f9754919682a'++class ProducerRequest extends EventEmitter {+ query: Record<string, unknown> = {}+ setTimeout = vi.fn()+}++class ProducerResponse extends EventEmitter {+ statusCode = 200+ headersSent = false+ destroyed = false+ writableEnded = false+ writableLength = 0+ frames: string[] = []+ status(code: number): this {+ this.statusCode = code+ return this+ }+ setHeader(): this {+ return this+ }+ flushHeaders(): void {+ this.headersSent = true+ }+ write(frame: string): boolean {+ this.frames.push(frame)+ return true+ }+ end(): void {+ this.writableEnded = true+ this.emit('close')+ }+ json(): this {+ return this+ }+}++async function captureControlApiProducerFrame(): Promise<string> {+ producerMocks.readEntityChangeCheckpoint.mockResolvedValue({+ resyncRequired: false,+ cursor: CURSOR,+ scopes: ['gfs'],+ })+ const req = new ProducerRequest()+ const res = new ProducerResponse()+ streamEntityChanges(+ req as unknown as Request,+ res as unknown as Response,+ null,+ async () => true,+ 'user'+ )+ await vi.waitFor(() => expect(res.frames.length).toBeGreaterThan(0))+ closeActiveEntityChangeStreams()+ await vi.waitFor(() => expect(res.writableEnded).toBe(true))+ const frame = res.frames+ .map(value => value.trim())+ .find(value => {+ return (JSON.parse(value) as { type?: string }).type === 'scope.invalidated'+ })+ if (!frame) throw new Error('Control API producer did not emit a scope invalidation')+ return frame+}++describe('Control API entity-change producer contract', () => {+ beforeEach(() => {+ producerMocks.isEntityChangeCursor.mockImplementation((value: string) =>+ /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(value)+ )+ producerMocks.readEntityChangeCheckpoint.mockReset()+ producerMocks.subscribeEntityChangeFeedWake.mockReset().mockReturnValue(vi.fn())+ externalAuth.verifyToken.mockReset().mockReturnValue({+ userId: 'user-1',+ email: '[email protected]',+ teamId: 'team-1',+ role: 'member',+ exp: 9_999_999_999,+ })+ externalControlApi.controlApiStreamRequest.mockReset()+ vi.unstubAllGlobals()+ })++ it('emits one Control API frame that survives proxy framing and both client parsers', async () => {+ const producerFrame = await captureControlApiProducerFrame()+ const encoder = new TextEncoder()+ externalControlApi.controlApiStreamRequest.mockResolvedValueOnce(+ new Response(+ new ReadableStream<Uint8Array>({+ start(controller) {+ controller.enqueue(encoder.encode(`${producerFrame}\n`))+ controller.close()+ },+ }),+ {+ status: 200,+ headers: { 'content-type': 'application/x-ndjson; charset=utf-8' },+ }+ )+ )++ const proxied = await request(express().use(createEntityChangesRouter()))+ .get('/entity-changes/stream')+ .set('authorization', 'Bearer session-token')+ .expect(200)+ expect(proxied.text.trim()).toBe(producerFrame)++ vi.stubGlobal(+ 'fetch',+ vi.fn().mockResolvedValue(+ new Response(`${proxied.text}`, {+ status: 200,+ headers: { 'content-type': 'application/x-ndjson; charset=utf-8' },+ })+ )+ )+ const desktopEvents: Array<Record<string, unknown>> = []+ await new AuthClient().openEntityChangeStream(+ 'session-token',+ null,+ event => desktopEvents.push(event as unknown as Record<string, unknown>),+ new AbortController().signal+ )+ expect(desktopEvents[1]).toEqual(JSON.parse(producerFrame))++ expect(parseEntityChangeFrame(producerFrame)).toEqual(JSON.parse(producerFrame))+ expect(JSON.stringify(desktopEvents)).not.toContain('file-contents')+ })+})