|
1 | 1 | // Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license. |
2 | 2 |
|
3 | | -import { describe, it, expect, vi } from 'vitest'; |
| 3 | +import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; |
4 | 4 | import { ObjectQL } from '@objectstack/objectql'; |
5 | 5 | import { |
6 | 6 | CONNECTOR_CREDENTIAL_SOURCE_SERVICE, |
@@ -393,6 +393,137 @@ describe('[ADR-0015 D7] a plugin driver adopted from its driver.<name> service i |
393 | 393 | }); |
394 | 394 | }); |
395 | 395 |
|
| 396 | +/** |
| 397 | + * A lender double whose declaration can be repaired, with `onLent`, as the |
| 398 | + * automation service's source has it: a borrow of a declared, enabled |
| 399 | + * instance is granted and announced to the subscribers. |
| 400 | + */ |
| 401 | +function repairableLender(disabled: Set<string>) { |
| 402 | + const listeners = new Set<(connector: string) => void>(); |
| 403 | + const source: IConnectorCredentialSource = { |
| 404 | + async borrow(connector) { |
| 405 | + if (disabled.has(connector)) { |
| 406 | + throw connectorCredentialRefusal( |
| 407 | + `connector instance '${connector}' (named by this datasource's external.connector) is disabled (enabled: false).`, |
| 408 | + 'VALIDATION_ERROR', |
| 409 | + 422, |
| 410 | + ); |
| 411 | + } |
| 412 | + for (const listener of listeners) listener(connector); |
| 413 | + const fixed: BorrowedConnectorCredential = { auth: { type: 'bearer', token: 'static-key' } }; |
| 414 | + return { connector, get: async () => fixed, refresh: async () => fixed }; |
| 415 | + }, |
| 416 | + onLent(listener) { |
| 417 | + listeners.add(listener); |
| 418 | + return () => void listeners.delete(listener); |
| 419 | + }, |
| 420 | + }; |
| 421 | + return { source, listeners }; |
| 422 | +} |
| 423 | + |
| 424 | +describe('[ADR-0015 D7] an adopted plugin driver\'s failed-credentials verdict clears on the next granted borrow', () => { |
| 425 | + const ENV = 'OS_ALLOW_DRIVER_CONNECT_FAILURE'; |
| 426 | + let saved: string | undefined; |
| 427 | + beforeEach(() => { saved = process.env[ENV]; delete process.env[ENV]; }); |
| 428 | + afterEach(() => { |
| 429 | + if (saved === undefined) delete process.env[ENV]; |
| 430 | + else process.env[ENV] = saved; |
| 431 | + }); |
| 432 | + |
| 433 | + it('retracts the verdict and the unavailable mark once the repaired instance lends — and only for that instance', async () => { |
| 434 | + const disabled = new Set(['sap_s4']); |
| 435 | + const { source } = repairableLender(disabled); |
| 436 | + const { ql, connection } = await adoptedPluginDriver(source); |
| 437 | + const result = await connection.connect(sapOrders, { context: { origin: 'code', trigger: 'declared-auto' } }); |
| 438 | + expect(result.status).toBe('failed-credentials'); |
| 439 | + expect(ql.listUnavailableDatasources()).toEqual([expect.objectContaining({ name: 'sap_orders' })]); |
| 440 | + |
| 441 | + // A grant for another instance proves nothing about this one. |
| 442 | + await source.borrow('salesforce_crm'); |
| 443 | + expect(connection.getConnectionState('sap_orders')).toMatchObject({ status: 'failed-credentials', availability: 'failed' }); |
| 444 | + expect(ql.listUnavailableDatasources()).toHaveLength(1); |
| 445 | + |
| 446 | + // The instance is repaired, and the driver's next request borrows it. |
| 447 | + disabled.delete('sap_s4'); |
| 448 | + await source.borrow('sap_s4'); |
| 449 | + expect(connection.getConnectionState('sap_orders')).toMatchObject({ status: 'already-registered', availability: 'available' }); |
| 450 | + expect(connection.getConnectionState('sap_orders')?.reason).toBeUndefined(); |
| 451 | + expect(ql.listUnavailableDatasources()).toEqual([]); |
| 452 | + expect(ql.getDriverByName('sap_orders')).toBeDefined(); |
| 453 | + }); |
| 454 | + |
| 455 | + it('subscribes once per lender, however many datasources wait on it', async () => { |
| 456 | + const { source, listeners } = repairableLender(new Set(['sap_s4'])); |
| 457 | + const { svc, engine } = service({ supports: () => false, create: vi.fn() } as unknown as IDatasourceDriverFactory, source); |
| 458 | + for (const name of ['sap_orders', 'sap_invoices']) { |
| 459 | + engine.drivers.set(name, { name } as IDataDriver); |
| 460 | + await svc.connect({ ...sapOrders, name }, { context: { origin: 'code', trigger: 'declared-auto' } }); |
| 461 | + } |
| 462 | + expect(listeners.size).toBe(1); |
| 463 | + await svc.disconnectAll(); |
| 464 | + expect(listeners.size).toBe(0); |
| 465 | + }); |
| 466 | + |
| 467 | + it('leaves a verdict standing that a disconnect or a later connect replaced', async () => { |
| 468 | + const disabled = new Set(['sap_s4']); |
| 469 | + const { source } = repairableLender(disabled); |
| 470 | + const { svc, engine } = service({ supports: () => false, create: vi.fn() } as unknown as IDatasourceDriverFactory, source); |
| 471 | + engine.drivers.set('sap_orders', { name: 'sap_orders' } as IDataDriver); |
| 472 | + await svc.connect(sapOrders, { context: { origin: 'code', trigger: 'declared-auto' } }); |
| 473 | + await svc.disconnect('sap_orders'); |
| 474 | + disabled.delete('sap_s4'); |
| 475 | + await source.borrow('sap_s4'); |
| 476 | + // Nothing resurrected for a datasource that was removed. |
| 477 | + expect(svc.getConnectionState('sap_orders')).toBeUndefined(); |
| 478 | + }); |
| 479 | + |
| 480 | + it('leaves the verdict when the driver was evicted since, rather than reporting a driver that is gone', async () => { |
| 481 | + const disabled = new Set(['sap_s4']); |
| 482 | + const { source } = repairableLender(disabled); |
| 483 | + const { svc, engine } = service({ supports: () => false, create: vi.fn() } as unknown as IDatasourceDriverFactory, source); |
| 484 | + engine.drivers.set('sap_orders', { name: 'sap_orders' } as IDataDriver); |
| 485 | + await svc.connect(sapOrders, { context: { origin: 'code', trigger: 'declared-auto' } }); |
| 486 | + engine.drivers.delete('sap_orders'); |
| 487 | + disabled.delete('sap_s4'); |
| 488 | + await source.borrow('sap_s4'); |
| 489 | + expect(svc.getConnectionState('sap_orders')?.status).toBe('failed-credentials'); |
| 490 | + }); |
| 491 | + |
| 492 | + it('says in the degraded-boot banner that the next granted borrow clears it, and a restart where nothing can', async () => { |
| 493 | + process.env[ENV] = '1'; |
| 494 | + const banners = async (source: IConnectorCredentialSource) => { |
| 495 | + const warnings: string[] = []; |
| 496 | + const engine = fakeEngine(); |
| 497 | + engine.drivers.set('sap_orders', { name: 'sap_orders' } as IDataDriver); |
| 498 | + const svc = new DatasourceConnectionService({ |
| 499 | + factory: () => ({ supports: () => false, create: vi.fn() }) as unknown as IDatasourceDriverFactory, |
| 500 | + engine: () => engine, |
| 501 | + connectorCredentials: () => source, |
| 502 | + logger: { info() {}, debug() {}, error() {}, warn: (m: string) => void warnings.push(m) } as never, |
| 503 | + }); |
| 504 | + const realWrite = process.stderr.write; |
| 505 | + (process.stderr as { write: unknown }).write = () => true; |
| 506 | + try { |
| 507 | + const result = await svc.connect(sapOrders, { objects: ['sap_order'], context: { origin: 'code', trigger: 'declared-auto' } }); |
| 508 | + expect(result.status).toBe('failed-credentials'); |
| 509 | + } finally { |
| 510 | + (process.stderr as { write: unknown }).write = realWrite; |
| 511 | + } |
| 512 | + return warnings.join('\n'); |
| 513 | + }; |
| 514 | + |
| 515 | + const retractable = await banners(repairableLender(new Set(['sap_s4'])).source); |
| 516 | + expect(retractable).toContain('DEGRADED BOOT'); |
| 517 | + expect(retractable).toContain("the first borrow granted for 'sap_s4' clears this verdict"); |
| 518 | + expect(retractable).not.toContain('server is restarted'); |
| 519 | + |
| 520 | + // A lender without onLent: nothing can retract the verdict, and the banner keeps the restart. |
| 521 | + const { onLent: _omitted, ...withoutOnLent } = repairableLender(new Set(['sap_s4'])).source; |
| 522 | + const standing = await banners(withoutOnLent); |
| 523 | + expect(standing).toContain('until it is reachable AND the server is restarted'); |
| 524 | + }); |
| 525 | +}); |
| 526 | + |
396 | 527 | describe('[ADR-0015 D7] borrowConnectorCredential', () => { |
397 | 528 | it('never throws: a source that throws a non-Error comes back as a reason', async () => { |
398 | 529 | const source = { borrow: async () => { throw 'boom'; } } as unknown as IConnectorCredentialSource; |
|
0 commit comments