|
| 1 | +/* |
| 2 | + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one |
| 3 | + * or more contributor license agreements. Licensed under the "Elastic License |
| 4 | + * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side |
| 5 | + * Public License v 1"; you may not use this file except in compliance with, at |
| 6 | + * your election, the "Elastic License 2.0", the "GNU Affero General Public |
| 7 | + * License v3.0 only", or the "Server Side Public License, v 1". |
| 8 | + */ |
| 9 | + |
| 10 | +import { Logger } from '@kbn/logging'; |
| 11 | +import { observableIntoEventSourceStream } from './observable_into_event_source_stream'; |
| 12 | +import { PassThrough } from 'node:stream'; |
| 13 | +import { Subject } from 'rxjs'; |
| 14 | +import { ServerSentEvent, ServerSentEventType } from '@kbn/sse-utils/src/events'; |
| 15 | +import { |
| 16 | + ServerSentEventErrorCode, |
| 17 | + createSSEInternalError, |
| 18 | + createSSERequestError, |
| 19 | +} from '@kbn/sse-utils/src/errors'; |
| 20 | + |
| 21 | +describe('observableIntoEventSourceStream', () => { |
| 22 | + let logger: jest.Mocked<Logger>; |
| 23 | + |
| 24 | + let controller: AbortController; |
| 25 | + |
| 26 | + let stream: PassThrough; |
| 27 | + let source$: Subject<ServerSentEvent>; |
| 28 | + |
| 29 | + let data: string[]; |
| 30 | + |
| 31 | + beforeEach(() => { |
| 32 | + jest.useFakeTimers(); |
| 33 | + logger = { |
| 34 | + debug: jest.fn(), |
| 35 | + error: jest.fn(), |
| 36 | + } as unknown as jest.Mocked<Logger>; |
| 37 | + |
| 38 | + controller = new AbortController(); |
| 39 | + source$ = new Subject(); |
| 40 | + data = []; |
| 41 | + |
| 42 | + stream = observableIntoEventSourceStream(source$, { logger, signal: controller.signal }); |
| 43 | + stream.on('data', (chunk) => { |
| 44 | + data.push(chunk.toString()); |
| 45 | + }); |
| 46 | + }); |
| 47 | + |
| 48 | + afterEach(() => { |
| 49 | + jest.clearAllTimers(); |
| 50 | + }); |
| 51 | + |
| 52 | + it('writes events into the stream in SSE format', () => { |
| 53 | + source$.next({ type: ServerSentEventType.data, data: { foo: 'bar' } }); |
| 54 | + source$.complete(); |
| 55 | + |
| 56 | + jest.runAllTimers(); |
| 57 | + |
| 58 | + expect(data).toEqual(['event: data\ndata: {"data":{"foo":"bar"}}\n\n']); |
| 59 | + }); |
| 60 | + |
| 61 | + it('handles SSE errors', () => { |
| 62 | + const sseError = createSSEInternalError('Invalid input'); |
| 63 | + |
| 64 | + source$.error(sseError); |
| 65 | + |
| 66 | + jest.runAllTimers(); |
| 67 | + |
| 68 | + expect(logger.error).toHaveBeenCalledWith(sseError); |
| 69 | + expect(logger.debug).toHaveBeenCalled(); |
| 70 | + const debugFn = logger.debug.mock.calls[0][0] as () => string; |
| 71 | + const loggedError = JSON.parse(debugFn()); |
| 72 | + expect(loggedError).toEqual({ |
| 73 | + type: 'error', |
| 74 | + error: { |
| 75 | + code: ServerSentEventErrorCode.internalError, |
| 76 | + message: 'Invalid input', |
| 77 | + meta: {}, |
| 78 | + }, |
| 79 | + }); |
| 80 | + |
| 81 | + expect(data).toEqual([ |
| 82 | + `event: error\ndata: ${JSON.stringify({ |
| 83 | + error: { |
| 84 | + code: ServerSentEventErrorCode.internalError, |
| 85 | + message: 'Invalid input', |
| 86 | + meta: {}, |
| 87 | + }, |
| 88 | + })}\n\n`, |
| 89 | + ]); |
| 90 | + }); |
| 91 | + |
| 92 | + it('handles SSE errors with metadata', () => { |
| 93 | + const sseError = createSSERequestError('Invalid request', 400); |
| 94 | + |
| 95 | + source$.error(sseError); |
| 96 | + |
| 97 | + jest.runAllTimers(); |
| 98 | + |
| 99 | + expect(logger.error).toHaveBeenCalledWith(sseError); |
| 100 | + expect(logger.debug).toHaveBeenCalled(); |
| 101 | + const debugFn = logger.debug.mock.calls[0][0] as () => string; |
| 102 | + const loggedError = JSON.parse(debugFn()); |
| 103 | + expect(loggedError).toEqual({ |
| 104 | + type: 'error', |
| 105 | + error: { |
| 106 | + code: ServerSentEventErrorCode.requestError, |
| 107 | + message: 'Invalid request', |
| 108 | + meta: { |
| 109 | + status: 400, |
| 110 | + }, |
| 111 | + }, |
| 112 | + }); |
| 113 | + |
| 114 | + expect(data).toEqual([ |
| 115 | + `event: error\ndata: ${JSON.stringify({ |
| 116 | + error: { |
| 117 | + code: ServerSentEventErrorCode.requestError, |
| 118 | + message: 'Invalid request', |
| 119 | + meta: { |
| 120 | + status: 400, |
| 121 | + }, |
| 122 | + }, |
| 123 | + })}\n\n`, |
| 124 | + ]); |
| 125 | + }); |
| 126 | + |
| 127 | + it('handles non-SSE errors', () => { |
| 128 | + const error = new Error('Non-SSE Error'); |
| 129 | + |
| 130 | + source$.error(error); |
| 131 | + |
| 132 | + jest.runAllTimers(); |
| 133 | + |
| 134 | + expect(logger.error).toHaveBeenCalledWith(error); |
| 135 | + expect(data).toEqual([ |
| 136 | + `event: error\ndata: ${JSON.stringify({ |
| 137 | + error: { |
| 138 | + code: ServerSentEventErrorCode.internalError, |
| 139 | + message: 'Non-SSE Error', |
| 140 | + }, |
| 141 | + })}\n\n`, |
| 142 | + ]); |
| 143 | + }); |
| 144 | + |
| 145 | + it('should send keep-alive comments every 10 seconds', () => { |
| 146 | + jest.advanceTimersByTime(10000); |
| 147 | + expect(data).toContain(': keep-alive'); |
| 148 | + |
| 149 | + jest.advanceTimersByTime(10000); |
| 150 | + expect(data.filter((d) => d === ': keep-alive')).toHaveLength(2); |
| 151 | + }); |
| 152 | + |
| 153 | + describe('without fake timers', () => { |
| 154 | + beforeEach(() => { |
| 155 | + jest.useFakeTimers({ doNotFake: ['nextTick'] }); |
| 156 | + }); |
| 157 | + |
| 158 | + it('should end the stream when the observable completes', async () => { |
| 159 | + jest.useFakeTimers({ doNotFake: ['nextTick'] }); |
| 160 | + |
| 161 | + const endSpy = jest.fn(); |
| 162 | + stream.on('end', endSpy); |
| 163 | + |
| 164 | + source$.complete(); |
| 165 | + |
| 166 | + await new Promise((resolve) => process.nextTick(resolve)); |
| 167 | + |
| 168 | + expect(endSpy).toHaveBeenCalled(); |
| 169 | + }); |
| 170 | + |
| 171 | + it('should end stream when signal is aborted', async () => { |
| 172 | + const endSpy = jest.fn(); |
| 173 | + stream.on('end', endSpy); |
| 174 | + |
| 175 | + // Emit some data |
| 176 | + source$.next({ type: ServerSentEventType.data, data: { initial: 'data' } }); |
| 177 | + |
| 178 | + // Abort the signal |
| 179 | + controller.abort(); |
| 180 | + |
| 181 | + // Emit more data after abort |
| 182 | + source$.next({ type: ServerSentEventType.data, data: { after: 'abort' } }); |
| 183 | + |
| 184 | + await new Promise((resolve) => process.nextTick(resolve)); |
| 185 | + |
| 186 | + expect(endSpy).toHaveBeenCalled(); |
| 187 | + |
| 188 | + // Data after abort should not be received |
| 189 | + expect(data).toEqual([ |
| 190 | + `event: data\ndata: ${JSON.stringify({ data: { initial: 'data' } })}\n\n`, |
| 191 | + ]); |
| 192 | + }); |
| 193 | + |
| 194 | + afterEach(() => { |
| 195 | + jest.useFakeTimers(); |
| 196 | + }); |
| 197 | + }); |
| 198 | +}); |
0 commit comments