|
1 | 1 | // Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license. |
2 | 2 |
|
3 | | -import { describe, it, expect, vi, beforeEach } from 'vitest'; |
| 3 | +import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; |
4 | 4 | import { DatabaseLoader, type DatabaseLoaderOptions } from './database-loader'; |
5 | 5 | import type { IDataDriver } from '@objectstack/spec/contracts'; |
6 | 6 | import { MetadataManager } from '../metadata-manager'; |
@@ -433,6 +433,214 @@ describe('DatabaseLoader', () => { |
433 | 433 | }); |
434 | 434 | }); |
435 | 435 |
|
| 436 | +// ---------- DDL failure is loud, and only "already exists" is silent ---------- |
| 437 | + |
| 438 | +/** |
| 439 | + * #4728 (rule: #4632, accident: #4420). |
| 440 | + * |
| 441 | + * `ensureSchema()` used to `catch {}` every DDL failure and set |
| 442 | + * `schemaReady = true` regardless — a total durability failure was byte-for-byte |
| 443 | + * indistinguishable from success, with no log line at all. The comment excused |
| 444 | + * *all* failure reasons with the most benign one ("e.g. table already exists"). |
| 445 | + * |
| 446 | + * Both directions are pinned here on purpose: proving the real failure is loud |
| 447 | + * is not enough, because "always log error" would pass that alone while making |
| 448 | + * the benign case unreadable noise. The point is that the two are DISTINGUISHED. |
| 449 | + */ |
| 450 | +describe('DatabaseLoader schema-sync failure reporting (#4728)', () => { |
| 451 | + let errorSpy: ReturnType<typeof vi.spyOn>; |
| 452 | + let infoSpy: ReturnType<typeof vi.spyOn>; |
| 453 | + |
| 454 | + /** A real DDL failure: the table does NOT exist afterwards. */ |
| 455 | + const permissionDenied = () => |
| 456 | + Object.assign(new Error('permission denied for schema public'), { code: '42501' }); |
| 457 | + |
| 458 | + /** The one benign reason: the table IS already provisioned. */ |
| 459 | + const alreadyExists = () => |
| 460 | + Object.assign(new Error('table sys_metadata already exists'), { code: 'SQLITE_ERROR' }); |
| 461 | + |
| 462 | + beforeEach(() => { |
| 463 | + errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {}); |
| 464 | + infoSpy = vi.spyOn(console, 'info').mockImplementation(() => {}); |
| 465 | + }); |
| 466 | + |
| 467 | + afterEach(() => { |
| 468 | + errorSpy.mockRestore(); |
| 469 | + infoSpy.mockRestore(); |
| 470 | + }); |
| 471 | + |
| 472 | + describe('a REAL DDL failure', () => { |
| 473 | + it('reports at error, naming the consequence and the fix', async () => { |
| 474 | + const driver = createMockDriver(); |
| 475 | + driver.syncSchema = vi.fn().mockRejectedValue(permissionDenied()); |
| 476 | + const loader = new DatabaseLoader({ driver }); |
| 477 | + |
| 478 | + await loader.list('object'); |
| 479 | + |
| 480 | + expect(errorSpy).toHaveBeenCalledTimes(1); |
| 481 | + const [message, cause] = errorSpy.mock.calls[0] as [string, unknown]; |
| 482 | + // consequence |
| 483 | + expect(message).toContain('sys_metadata'); |
| 484 | + expect(message).toContain('FAILED'); |
| 485 | + expect(message).toContain('NOT created'); |
| 486 | + // the system keeps looking healthy — that is the whole point of the level |
| 487 | + expect(message).toMatch(/reporting healthy/i); |
| 488 | + // fix |
| 489 | + expect(message).toMatch(/fix it and restart/i); |
| 490 | + // and the underlying driver error is carried, not discarded |
| 491 | + expect((cause as Error).message).toBe('permission denied for schema public'); |
| 492 | + }); |
| 493 | + |
| 494 | + it('does NOT mark the schema ready — the next operation retries the DDL', async () => { |
| 495 | + const driver = createMockDriver(); |
| 496 | + driver.syncSchema = vi.fn().mockRejectedValue(permissionDenied()); |
| 497 | + const loader = new DatabaseLoader({ driver }); |
| 498 | + |
| 499 | + await loader.list('object'); |
| 500 | + await loader.list('view'); |
| 501 | + await loader.exists('object', 'account'); |
| 502 | + |
| 503 | + // Before #4728 this was 1: the failure set `schemaReady = true` and every |
| 504 | + // later write proceeded against a table that was never created. |
| 505 | + expect(driver.syncSchema).toHaveBeenCalledTimes(3); |
| 506 | + }); |
| 507 | + |
| 508 | + it('says it once, not once per operation', async () => { |
| 509 | + const driver = createMockDriver(); |
| 510 | + driver.syncSchema = vi.fn().mockRejectedValue(permissionDenied()); |
| 511 | + const loader = new DatabaseLoader({ driver }); |
| 512 | + |
| 513 | + await loader.list('object'); |
| 514 | + await loader.list('view'); |
| 515 | + await loader.list('flow'); |
| 516 | + |
| 517 | + expect(errorSpy).toHaveBeenCalledTimes(1); |
| 518 | + }); |
| 519 | + |
| 520 | + it('recovers silently-loudly: a transient failure that heals reports the recovery', async () => { |
| 521 | + const driver = createMockDriver(); |
| 522 | + driver.syncSchema = vi |
| 523 | + .fn() |
| 524 | + .mockRejectedValueOnce( |
| 525 | + Object.assign(new Error('connect ECONNREFUSED 127.0.0.1:5432'), { |
| 526 | + code: 'ECONNREFUSED', |
| 527 | + }), |
| 528 | + ) |
| 529 | + .mockResolvedValue(undefined); |
| 530 | + const loader = new DatabaseLoader({ driver }); |
| 531 | + |
| 532 | + await loader.list('object'); // datasource still connecting → loud |
| 533 | + await loader.list('view'); // retried → succeeds |
| 534 | + |
| 535 | + expect(errorSpy).toHaveBeenCalledTimes(1); |
| 536 | + expect(infoSpy).toHaveBeenCalledTimes(1); |
| 537 | + expect((infoSpy.mock.calls[0] as [string])[0]).toMatch(/succeeded on retry/i); |
| 538 | + |
| 539 | + // Ready now, so a third operation does not re-run the DDL. |
| 540 | + await loader.list('flow'); |
| 541 | + expect(driver.syncSchema).toHaveBeenCalledTimes(2); |
| 542 | + }); |
| 543 | + }); |
| 544 | + |
| 545 | + describe('the benign "already exists" failure', () => { |
| 546 | + it('is silent — no error, no info', async () => { |
| 547 | + const driver = createMockDriver(); |
| 548 | + driver.syncSchema = vi.fn().mockRejectedValue(alreadyExists()); |
| 549 | + const loader = new DatabaseLoader({ driver }); |
| 550 | + |
| 551 | + await loader.list('object'); |
| 552 | + |
| 553 | + expect(errorSpy).not.toHaveBeenCalled(); |
| 554 | + expect(infoSpy).not.toHaveBeenCalled(); |
| 555 | + }); |
| 556 | + |
| 557 | + it('marks the schema ready — the table is provisioned, so no retry', async () => { |
| 558 | + const driver = createMockDriver(); |
| 559 | + driver.syncSchema = vi.fn().mockRejectedValue(alreadyExists()); |
| 560 | + const loader = new DatabaseLoader({ driver }); |
| 561 | + |
| 562 | + await loader.list('object'); |
| 563 | + await loader.list('view'); |
| 564 | + |
| 565 | + expect(driver.syncSchema).toHaveBeenCalledTimes(1); |
| 566 | + }); |
| 567 | + |
| 568 | + it('still runs the post-sync migrations (the table exists, so they apply)', async () => { |
| 569 | + const driver = createMockDriver(); |
| 570 | + driver.syncSchema = vi.fn().mockRejectedValue(alreadyExists()); |
| 571 | + const raw = vi.fn().mockResolvedValue(undefined); |
| 572 | + (driver as unknown as { raw: unknown }).raw = raw; |
| 573 | + const loader = new DatabaseLoader({ driver }); |
| 574 | + |
| 575 | + await loader.list('object'); |
| 576 | + |
| 577 | + expect(raw).toHaveBeenCalled(); |
| 578 | + expect(raw.mock.calls.some(([sql]) => String(sql).includes('idx_sys_metadata_overlay_active'))).toBe( |
| 579 | + true, |
| 580 | + ); |
| 581 | + }); |
| 582 | + }); |
| 583 | + |
| 584 | + it('DISTINGUISHES the two: same call site, opposite verdicts', async () => { |
| 585 | + const benignDriver = createMockDriver(); |
| 586 | + benignDriver.syncSchema = vi.fn().mockRejectedValue(alreadyExists()); |
| 587 | + const realDriver = createMockDriver(); |
| 588 | + realDriver.syncSchema = vi.fn().mockRejectedValue(permissionDenied()); |
| 589 | + |
| 590 | + await new DatabaseLoader({ driver: benignDriver }).list('object'); |
| 591 | + const afterBenign = errorSpy.mock.calls.length; |
| 592 | + |
| 593 | + await new DatabaseLoader({ driver: realDriver }).list('object'); |
| 594 | + const afterReal = errorSpy.mock.calls.length; |
| 595 | + |
| 596 | + expect(afterBenign).toBe(0); |
| 597 | + expect(afterReal).toBe(1); |
| 598 | + }); |
| 599 | + |
| 600 | + describe('the history table follows the same rule', () => { |
| 601 | + /** sys_metadata syncs fine; only the history table's DDL fails. */ |
| 602 | + function driverWithFailingHistoryDdl(error: unknown): IDataDriver { |
| 603 | + const driver = createMockDriver(); |
| 604 | + driver.syncSchema = vi.fn().mockImplementation((table: string) => { |
| 605 | + if (table === 'sys_metadata_history') return Promise.reject(error); |
| 606 | + return Promise.resolve(undefined); |
| 607 | + }); |
| 608 | + return driver; |
| 609 | + } |
| 610 | + |
| 611 | + it('reports a real failure at error, naming the lost audit trail and the fix', async () => { |
| 612 | + const driver = driverWithFailingHistoryDdl(permissionDenied()); |
| 613 | + const loader = new DatabaseLoader({ driver }); |
| 614 | + |
| 615 | + await loader.save('object', 'account', { name: 'account' }); |
| 616 | + |
| 617 | + expect(errorSpy).toHaveBeenCalledTimes(1); |
| 618 | + const message = (errorSpy.mock.calls[0] as [string])[0]; |
| 619 | + expect(message).toContain('sys_metadata_history'); |
| 620 | + expect(message).toMatch(/will NOT be persisted/); |
| 621 | + expect(message).toMatch(/restart/i); |
| 622 | + }); |
| 623 | + |
| 624 | + it('is silent on "already exists" and stops retrying', async () => { |
| 625 | + const driver = driverWithFailingHistoryDdl( |
| 626 | + Object.assign(new Error("Table 'sys_metadata_history' already exists"), { |
| 627 | + code: 'ER_TABLE_EXISTS_ERROR', |
| 628 | + }), |
| 629 | + ); |
| 630 | + const loader = new DatabaseLoader({ driver }); |
| 631 | + |
| 632 | + await loader.save('object', 'account', { name: 'account' }); |
| 633 | + await loader.save('object', 'contact', { name: 'contact' }); |
| 634 | + |
| 635 | + expect(errorSpy).not.toHaveBeenCalled(); |
| 636 | + const historySyncs = (driver.syncSchema as ReturnType<typeof vi.fn>).mock.calls.filter( |
| 637 | + ([table]) => table === 'sys_metadata_history', |
| 638 | + ); |
| 639 | + expect(historySyncs).toHaveLength(1); |
| 640 | + }); |
| 641 | + }); |
| 642 | +}); |
| 643 | + |
436 | 644 | // ---------- DatabaseLoader read-through cache ---------- |
437 | 645 |
|
438 | 646 | describe('DatabaseLoader read-through cache', () => { |
|
0 commit comments