|
| 1 | +// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +/** |
| 4 | + * A kernel whose teardown times out exits the process only if it OWNS the |
| 5 | + * process (#22335, ruling B): `gracefulShutdown` true — the default, the kernel |
| 6 | + * installed the signal listeners itself — keeps the hard `exit(1)` (pinned in |
| 7 | + * kernel.test.ts, the #5274 timeout pin). `gracefulShutdown` false means the |
| 8 | + * host owns the process: the kernel logs the timeout, marks itself `stopped`, |
| 9 | + * and `shutdown()` returns to the host, which decides whether the process ends. |
| 10 | + * |
| 11 | + * Before this, the timeout branch called `process.exit(1)` without reading the |
| 12 | + * option, so a host running several `false` kernels in one process (one per |
| 13 | + * environment) lost every one of them when one teardown hung. |
| 14 | + * |
| 15 | + * `process.exit` is stubbed in every test here: the behaviour under test is |
| 16 | + * whether the kernel ends the process, and a real `exit(1)` would end the |
| 17 | + * vitest worker with it. |
| 18 | + */ |
| 19 | + |
| 20 | +import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'; |
| 21 | +import { ObjectKernel } from './kernel'; |
| 22 | +import type { Plugin } from './types'; |
| 23 | + |
| 24 | +type ExitSpy = { mock: { calls: unknown[][] }; mockRestore: () => void }; |
| 25 | +type LogMethod = (message: string, ...rest: unknown[]) => void; |
| 26 | + |
| 27 | +const SHUTDOWN_TIMEOUT_MS = 20; |
| 28 | + |
| 29 | +describe('ObjectKernel shutdown timeout under gracefulShutdown: false', () => { |
| 30 | + let exitSpy: ExitSpy; |
| 31 | + |
| 32 | + beforeEach(() => { |
| 33 | + exitSpy = vi.spyOn(process, 'exit').mockImplementation((() => undefined) as never) as unknown as ExitSpy; |
| 34 | + }); |
| 35 | + |
| 36 | + afterEach(() => { |
| 37 | + exitSpy.mockRestore(); |
| 38 | + }); |
| 39 | + |
| 40 | + const hostOwnedKernel = () => |
| 41 | + new ObjectKernel({ |
| 42 | + logger: { level: 'silent' }, |
| 43 | + gracefulShutdown: false, |
| 44 | + skipSystemValidation: true, |
| 45 | + shutdownTimeout: SHUTDOWN_TIMEOUT_MS, |
| 46 | + }); |
| 47 | + |
| 48 | + const spyOnError = (kernel: ObjectKernel) => |
| 49 | + vi.spyOn((kernel as unknown as { logger: { error: LogMethod } }).logger, 'error'); |
| 50 | + |
| 51 | + /** A plugin whose `kernel:shutdown` subscriber holds teardown open until released. */ |
| 52 | + const hungTeardown = (reached: string[]) => { |
| 53 | + let release!: () => void; |
| 54 | + const gate = new Promise<void>((resolve) => { release = resolve; }); |
| 55 | + const plugin: Plugin = { |
| 56 | + name: 'hung-teardown', |
| 57 | + version: '1.0.0', |
| 58 | + init: async (ctx) => { |
| 59 | + ctx.hook('kernel:shutdown', async () => { |
| 60 | + await gate; |
| 61 | + reached.push('teardown-resumed'); |
| 62 | + }); |
| 63 | + }, |
| 64 | + destroy: async () => { reached.push('destroy'); }, |
| 65 | + }; |
| 66 | + return { plugin, release: () => release() }; |
| 67 | + }; |
| 68 | + |
| 69 | + it('logs the timeout at error, ends stopped, resolves and does NOT exit the process', async () => { |
| 70 | + const reached: string[] = []; |
| 71 | + const { plugin, release } = hungTeardown(reached); |
| 72 | + const kernel = hostOwnedKernel(); |
| 73 | + const errorSpy = spyOnError(kernel); |
| 74 | + await kernel.use(plugin); |
| 75 | + await kernel.bootstrap(); |
| 76 | + |
| 77 | + try { |
| 78 | + await expect(kernel.shutdown()).resolves.toBeUndefined(); |
| 79 | + |
| 80 | + expect(exitSpy.mock.calls).toEqual([]); |
| 81 | + expect(kernel.getState()).toBe('stopped'); |
| 82 | + const timeoutLines = errorSpy.mock.calls.filter((c) => String(c[0]).startsWith('Shutdown timed out')); |
| 83 | + expect(timeoutLines).toHaveLength(1); |
| 84 | + expect(timeoutLines[0][1]).toBeInstanceOf(Error); |
| 85 | + // The `true` line says an exit is being forced; under `false` none is. |
| 86 | + expect(errorSpy.mock.calls.map((c) => String(c[0]))).not.toContain('Shutdown timed out — forcing exit'); |
| 87 | + // The teardown was abandoned, not finished. |
| 88 | + expect(reached).toEqual([]); |
| 89 | + } finally { |
| 90 | + release(); |
| 91 | + } |
| 92 | + |
| 93 | + // The hung teardown keeps running in the background. When it finishes, |
| 94 | + // the kernel does not act on it: still `stopped`, still no exit, and a |
| 95 | + // second `shutdown()` is the already-stopped no-op. |
| 96 | + await vi.waitFor(() => expect(reached).toEqual(['teardown-resumed', 'destroy'])); |
| 97 | + expect(kernel.getState()).toBe('stopped'); |
| 98 | + await expect(kernel.shutdown()).resolves.toBeUndefined(); |
| 99 | + expect(exitSpy.mock.calls).toEqual([]); |
| 100 | + errorSpy.mockRestore(); |
| 101 | + }); |
| 102 | + |
| 103 | + it('two host-owned kernels in one process: stopping the hung one leaves the other running and the process alive', async () => { |
| 104 | + const reached: string[] = []; |
| 105 | + const { plugin, release } = hungTeardown(reached); |
| 106 | + const hung = hostOwnedKernel(); |
| 107 | + const sibling = hostOwnedKernel(); |
| 108 | + await hung.use(plugin); |
| 109 | + await hung.bootstrap(); |
| 110 | + await sibling.bootstrap(); |
| 111 | + |
| 112 | + try { |
| 113 | + await hung.shutdown(); |
| 114 | + |
| 115 | + expect(hung.getState()).toBe('stopped'); |
| 116 | + expect(sibling.getState()).toBe('running'); |
| 117 | + expect(exitSpy.mock.calls).toEqual([]); |
| 118 | + |
| 119 | + // The sibling is untouched: the host can still stop it normally. |
| 120 | + await sibling.shutdown(); |
| 121 | + expect(sibling.getState()).toBe('stopped'); |
| 122 | + expect(exitSpy.mock.calls).toEqual([]); |
| 123 | + } finally { |
| 124 | + release(); |
| 125 | + } |
| 126 | + }); |
| 127 | + |
| 128 | + // Control: a teardown that FAILS rather than hangs never exited the process |
| 129 | + // under `false`, before this change or after it. Both shapes: a throwing |
| 130 | + // `destroy()` (isolated inside the teardown) and an error escaping the |
| 131 | + // teardown altogether (the non-timeout branch of `shutdown()`'s catch). |
| 132 | + it.each([ |
| 133 | + ['a throwing destroy()', (kernel: ObjectKernel) => |
| 134 | + kernel.use({ |
| 135 | + name: 'throwing-destroy', |
| 136 | + version: '1.0.0', |
| 137 | + init: async () => {}, |
| 138 | + destroy: async () => { throw new Error('destroy boom'); }, |
| 139 | + })], |
| 140 | + ['an error escaping the teardown', async (kernel: ObjectKernel) => { |
| 141 | + vi.spyOn(kernel as unknown as { performShutdown: () => Promise<void> }, 'performShutdown') |
| 142 | + .mockRejectedValue(new Error('teardown boom')); |
| 143 | + }], |
| 144 | + ] as const)('control: %s does not exit the process and is not reported as a timeout', async (_label, arrange) => { |
| 145 | + const kernel = hostOwnedKernel(); |
| 146 | + const errorSpy = spyOnError(kernel); |
| 147 | + await arrange(kernel); |
| 148 | + await kernel.bootstrap(); |
| 149 | + |
| 150 | + await expect(kernel.shutdown()).resolves.toBeUndefined(); |
| 151 | + |
| 152 | + expect(exitSpy.mock.calls).toEqual([]); |
| 153 | + expect(kernel.getState()).toBe('stopped'); |
| 154 | + expect(errorSpy.mock.calls.some((c) => String(c[0]).startsWith('Shutdown timed out'))).toBe(false); |
| 155 | + errorSpy.mockRestore(); |
| 156 | + }); |
| 157 | +}); |
0 commit comments