@rebasepro/server-postgresql 0.1.2 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/LICENSE +22 -6
  2. package/dist/common/src/data/query_builder.d.ts +51 -0
  3. package/dist/common/src/index.d.ts +1 -0
  4. package/dist/common/src/util/entities.d.ts +2 -2
  5. package/dist/common/src/util/relations.d.ts +1 -1
  6. package/dist/index.es.js +1435 -738
  7. package/dist/index.es.js.map +1 -1
  8. package/dist/index.umd.js +1433 -736
  9. package/dist/index.umd.js.map +1 -1
  10. package/dist/server-postgresql/src/PostgresAdapter.d.ts +6 -0
  11. package/dist/server-postgresql/src/PostgresBackendDriver.d.ts +2 -1
  12. package/dist/server-postgresql/src/PostgresBootstrapper.d.ts +0 -5
  13. package/dist/server-postgresql/src/auth/ensure-tables.d.ts +2 -1
  14. package/dist/server-postgresql/src/auth/services.d.ts +37 -15
  15. package/dist/server-postgresql/src/index.d.ts +1 -0
  16. package/dist/server-postgresql/src/schema/auth-schema.d.ts +43 -856
  17. package/dist/server-postgresql/src/schema/default-collections.d.ts +2 -0
  18. package/dist/server-postgresql/src/schema/doctor.d.ts +10 -1
  19. package/dist/server-postgresql/src/schema/introspect-db-logic.d.ts +1 -0
  20. package/dist/server-postgresql/src/services/entity-helpers.d.ts +1 -1
  21. package/dist/server-postgresql/src/services/realtimeService.d.ts +12 -0
  22. package/dist/server-postgresql/src/websocket.d.ts +2 -1
  23. package/dist/types/src/controllers/auth.d.ts +9 -8
  24. package/dist/types/src/controllers/client.d.ts +3 -0
  25. package/dist/types/src/controllers/data.d.ts +21 -0
  26. package/dist/types/src/types/auth_adapter.d.ts +356 -0
  27. package/dist/types/src/types/collections.d.ts +67 -2
  28. package/dist/types/src/types/database_adapter.d.ts +94 -0
  29. package/dist/types/src/types/entity_actions.d.ts +7 -1
  30. package/dist/types/src/types/entity_callbacks.d.ts +1 -1
  31. package/dist/types/src/types/entity_views.d.ts +36 -1
  32. package/dist/types/src/types/index.d.ts +2 -0
  33. package/dist/types/src/types/plugins.d.ts +1 -1
  34. package/dist/types/src/types/properties.d.ts +24 -5
  35. package/dist/types/src/types/property_config.d.ts +6 -2
  36. package/dist/types/src/types/relations.d.ts +1 -1
  37. package/dist/types/src/types/translations.d.ts +8 -0
  38. package/dist/types/src/users/user.d.ts +5 -0
  39. package/package.json +22 -15
  40. package/src/PostgresAdapter.ts +59 -0
  41. package/src/PostgresBackendDriver.ts +66 -13
  42. package/src/PostgresBootstrapper.ts +35 -15
  43. package/src/auth/ensure-tables.ts +82 -189
  44. package/src/auth/services.ts +421 -170
  45. package/src/cli.ts +49 -13
  46. package/src/data-transformer.ts +78 -8
  47. package/src/history/HistoryService.ts +25 -2
  48. package/src/index.ts +1 -0
  49. package/src/schema/auth-schema.ts +130 -98
  50. package/src/schema/default-collections.ts +69 -0
  51. package/src/schema/doctor-cli.ts +5 -1
  52. package/src/schema/doctor.ts +166 -48
  53. package/src/schema/generate-drizzle-schema-logic.ts +74 -27
  54. package/src/schema/generate-drizzle-schema.ts +13 -3
  55. package/src/schema/introspect-db-inference.ts +5 -5
  56. package/src/schema/introspect-db-logic.ts +9 -2
  57. package/src/schema/introspect-db.ts +14 -3
  58. package/src/services/EntityFetchService.ts +5 -5
  59. package/src/services/RelationService.ts +2 -2
  60. package/src/services/entity-helpers.ts +1 -1
  61. package/src/services/realtimeService.ts +145 -136
  62. package/src/utils/drizzle-conditions.ts +16 -2
  63. package/src/websocket.ts +113 -37
  64. package/test/auth-services.test.ts +163 -74
  65. package/test/data-transformer-hardening.test.ts +57 -0
  66. package/test/data-transformer.test.ts +43 -0
  67. package/test/generate-drizzle-schema.test.ts +7 -5
  68. package/test/introspect-db-utils.test.ts +4 -1
  69. package/test/postgresDataDriver.test.ts +147 -1
  70. package/test/realtimeService.test.ts +7 -7
  71. package/test/websocket.test.ts +139 -0
@@ -35,7 +35,12 @@ describe("PostgresBackendDriver", () => {
35
35
 
36
36
  beforeEach(() => {
37
37
  jest.clearAllMocks();
38
- delegate = new PostgresBackendDriver(mockDb, mockRealtimeService);
38
+ const mockRegistry = {
39
+ getCollectionByPath: jest.fn().mockReturnValue({ slug: "test_coll", properties: {} }),
40
+ getCollections: jest.fn().mockReturnValue([]),
41
+ getTable: jest.fn().mockReturnValue({})
42
+ } as any;
43
+ delegate = new PostgresBackendDriver(mockDb, mockRealtimeService, mockRegistry);
39
44
  });
40
45
 
41
46
  it("should initialize correctly", () => {
@@ -644,5 +649,146 @@ status: "new" });
644
649
  expect(mockRealtimeService.notifyEntityUpdate).toHaveBeenNthCalledWith(2, "call-2", "2", {}, undefined);
645
650
  });
646
651
  });
652
+
653
+ describe("PostgresBackendDriver Admin operations", () => {
654
+ it("fetchAvailableRoles should query roles filtered by current user membership", async () => {
655
+ const executeSqlSpy = jest.spyOn(delegate, "executeSql").mockResolvedValueOnce([
656
+ { rolname: "demo" },
657
+ { rolname: "cloudsqlsuperuser" }
658
+ ]);
659
+
660
+ const result = await delegate.fetchAvailableRoles();
661
+
662
+ expect(executeSqlSpy).toHaveBeenCalledWith(
663
+ "SELECT rolname FROM pg_roles WHERE pg_has_role(current_user, rolname, 'member') ORDER BY rolname;"
664
+ );
665
+ expect(result).toEqual(["demo", "cloudsqlsuperuser"]);
666
+ executeSqlSpy.mockRestore();
667
+ });
668
+ });
669
+
670
+ describe("storageSource in Callbacks", () => {
671
+ it("should inject storageSource: client.storage into contextForCallback in fetchCollection", async () => {
672
+ const mockStorage = { key: "mockStorage" };
673
+ delegate.client = {
674
+ storage: mockStorage
675
+ } as any;
676
+
677
+ const afterReadSpy = jest.fn().mockImplementation(async ({ entity }) => entity);
678
+ const mockCollectionWithCallback = {
679
+ slug: "test_coll",
680
+ callbacks: {
681
+ afterRead: afterReadSpy
682
+ }
683
+ } as any;
684
+
685
+ jest.spyOn(delegate.entityService, "fetchCollection").mockResolvedValueOnce([
686
+ { id: "e1", path: "test_coll", values: {} } as any
687
+ ]);
688
+
689
+ await delegate.fetchCollection({
690
+ path: "test_coll",
691
+ collection: mockCollectionWithCallback
692
+ });
693
+
694
+ expect(afterReadSpy).toHaveBeenCalled();
695
+ const callArgs = afterReadSpy.mock.calls[0][0];
696
+ expect(callArgs.context).toBeDefined();
697
+ expect(callArgs.context.storageSource).toBe(mockStorage);
698
+ });
699
+
700
+ it("should inject storageSource in fetchEntity", async () => {
701
+ const mockStorage = { key: "mockStorage" };
702
+ delegate.client = {
703
+ storage: mockStorage
704
+ } as any;
705
+
706
+ const afterReadSpy = jest.fn().mockImplementation(async ({ entity }) => entity);
707
+ const mockCollectionWithCallback = {
708
+ slug: "test_coll",
709
+ callbacks: {
710
+ afterRead: afterReadSpy
711
+ }
712
+ } as any;
713
+
714
+ jest.spyOn(delegate.entityService, "fetchEntity").mockResolvedValueOnce(
715
+ { id: "e1", path: "test_coll", values: {} } as any
716
+ );
717
+
718
+ await delegate.fetchEntity({
719
+ path: "test_coll",
720
+ entityId: "e1",
721
+ collection: mockCollectionWithCallback
722
+ });
723
+
724
+ expect(afterReadSpy).toHaveBeenCalled();
725
+ const callArgs = afterReadSpy.mock.calls[0][0];
726
+ expect(callArgs.context.storageSource).toBe(mockStorage);
727
+ });
728
+
729
+ it("should inject storageSource in saveEntity beforeSave and afterSave", async () => {
730
+ const mockStorage = { key: "mockStorage" };
731
+ delegate.client = {
732
+ storage: mockStorage
733
+ } as any;
734
+
735
+ const beforeSaveSpy = jest.fn().mockImplementation(async ({ values }) => values);
736
+ const afterSaveSpy = jest.fn();
737
+ const mockCollectionWithCallback = {
738
+ slug: "test_coll",
739
+ callbacks: {
740
+ beforeSave: beforeSaveSpy,
741
+ afterSave: afterSaveSpy
742
+ }
743
+ } as any;
744
+
745
+ jest.spyOn(delegate.entityService, "fetchEntity").mockResolvedValue(undefined);
746
+ jest.spyOn(delegate.entityService, "saveEntity").mockResolvedValueOnce(
747
+ { id: "e1", path: "test_coll", values: { name: "test" } } as any
748
+ );
749
+
750
+ await delegate.saveEntity({
751
+ path: "test_coll",
752
+ entityId: "e1",
753
+ values: { name: "test" },
754
+ collection: mockCollectionWithCallback,
755
+ status: "existing"
756
+ });
757
+
758
+ expect(beforeSaveSpy).toHaveBeenCalled();
759
+ expect(beforeSaveSpy.mock.calls[0][0].context.storageSource).toBe(mockStorage);
760
+ expect(afterSaveSpy).toHaveBeenCalled();
761
+ expect(afterSaveSpy.mock.calls[0][0].context.storageSource).toBe(mockStorage);
762
+ });
763
+
764
+ it("should inject storageSource in deleteEntity beforeDelete and afterDelete", async () => {
765
+ const mockStorage = { key: "mockStorage" };
766
+ delegate.client = {
767
+ storage: mockStorage
768
+ } as any;
769
+
770
+ const beforeDeleteSpy = jest.fn().mockImplementation(async () => true);
771
+ const afterDeleteSpy = jest.fn();
772
+ const mockCollectionWithCallback = {
773
+ slug: "test_coll",
774
+ callbacks: {
775
+ beforeDelete: beforeDeleteSpy,
776
+ afterDelete: afterDeleteSpy
777
+ }
778
+ } as any;
779
+
780
+ jest.spyOn(delegate.entityService, "deleteEntity").mockResolvedValueOnce();
781
+
782
+ await delegate.deleteEntity({
783
+ entity: { id: "e1", path: "test_coll", values: {} } as any,
784
+ collection: mockCollectionWithCallback
785
+ });
786
+
787
+ expect(beforeDeleteSpy).toHaveBeenCalled();
788
+ expect(beforeDeleteSpy.mock.calls[0][0].context.storageSource).toBe(mockStorage);
789
+ expect(afterDeleteSpy).toHaveBeenCalled();
790
+ expect(afterDeleteSpy.mock.calls[0][0].context.storageSource).toBe(mockStorage);
791
+ });
792
+ });
647
793
  });
648
794
 
@@ -3,12 +3,13 @@ import { NodePgDatabase } from "drizzle-orm/node-postgres";
3
3
  import { PostgresCollectionRegistry } from "../src/collections/PostgresCollectionRegistry";
4
4
  import { EntityCollection } from "@rebasepro/types";
5
5
 
6
+ const mockFetchCollection = jest.fn().mockResolvedValue([{ id: 1, path: "posts", values: { title: "Refetched Title" } }]);
7
+ const mockFetchEntity = jest.fn().mockResolvedValue({ id: 1, path: "posts", values: { title: "Refetched Entity Title" } });
8
+
6
9
  jest.mock("../src/services/entityService", () => ({
7
10
  EntityService: jest.fn().mockImplementation(() => ({
8
- fetchCollection: jest.fn().mockResolvedValue([{ id: 1,
9
- _rebase_invalidated: false }]),
10
- fetchEntity: jest.fn().mockResolvedValue({ id: 1,
11
- _rebase_invalidated: false }),
11
+ fetchCollection: mockFetchCollection,
12
+ fetchEntity: mockFetchEntity,
12
13
  searchEntities: jest.fn().mockResolvedValue([])
13
14
  }))
14
15
  }));
@@ -134,7 +135,7 @@ values: { _rebase_invalidated: true } } as any;
134
135
  await Promise.resolve();
135
136
 
136
137
  // It should fetch the collection with auth
137
- expect(mockDriver.fetchCollection).toHaveBeenCalled();
138
+ expect(mockFetchCollection).toHaveBeenCalled();
138
139
 
139
140
  // It should send the refetched data
140
141
  expect(ws.send).toHaveBeenCalled();
@@ -207,8 +208,7 @@ values: { _rebase_invalidated: true } } as any;
207
208
  await Promise.resolve();
208
209
 
209
210
  // It should fetch the single entity
210
- expect(mockDriver.fetchEntity).toHaveBeenCalledWith(expect.objectContaining({ path: "posts",
211
- entityId: "1" }));
211
+ expect(mockFetchEntity).toHaveBeenCalledWith("posts", "1", undefined);
212
212
 
213
213
  // It should send entity update
214
214
  expect(ws.send).toHaveBeenCalled();
@@ -0,0 +1,139 @@
1
+ import { describe, it, expect, jest, beforeEach } from "@jest/globals";
2
+ import { WebSocket, WebSocketServer } from "ws";
3
+ import { Server } from "http";
4
+
5
+ let mockWssInstance: any = null;
6
+
7
+ jest.mock("ws", () => {
8
+ return {
9
+ WebSocketServer: jest.fn().mockImplementation(() => {
10
+ const instance = {
11
+ on: jest.fn()
12
+ };
13
+ mockWssInstance = instance;
14
+ return instance;
15
+ }),
16
+ WebSocket: jest.fn()
17
+ };
18
+ });
19
+
20
+ jest.mock("@rebasepro/server-core", () => {
21
+ return {
22
+ extractUserFromToken: jest.fn().mockReturnValue({
23
+ userId: "admin-user",
24
+ roles: ["admin"]
25
+ })
26
+ };
27
+ });
28
+
29
+ import { createPostgresWebSocket } from "../src/websocket";
30
+ import { RealtimeService } from "../src/services/realtimeService";
31
+ import { PostgresBackendDriver } from "../src/PostgresBackendDriver";
32
+
33
+ describe("WebSocket Server SQL error handling", () => {
34
+ let mockServer: Server;
35
+ let mockRealtimeService: RealtimeService;
36
+ let mockDriver: PostgresBackendDriver;
37
+
38
+ beforeEach(() => {
39
+ jest.clearAllMocks();
40
+ mockWssInstance = null;
41
+
42
+ mockServer = {} as Server;
43
+ mockRealtimeService = {
44
+ addClient: jest.fn(),
45
+ registerDataDriverSubscription: jest.fn()
46
+ } as unknown as RealtimeService;
47
+
48
+ // Mock PostgresBackendDriver admin capabilities
49
+ mockDriver = {
50
+ key: "postgres",
51
+ initialised: true,
52
+ admin: {
53
+ executeSql: jest.fn()
54
+ }
55
+ } as unknown as PostgresBackendDriver;
56
+
57
+ // Trigger the wss initialization with requireAuth: true
58
+ createPostgresWebSocket(mockServer, mockRealtimeService, mockDriver, { requireAuth: true });
59
+ });
60
+
61
+ it("should handle EXECUTE_SQL errors cleanly and return ERROR message without throwing", async () => {
62
+ expect(mockWssInstance).toBeDefined();
63
+ expect(mockWssInstance.on).toHaveBeenCalledWith("connection", expect.any(Function));
64
+
65
+ const connectionCallback = mockWssInstance.on.mock.calls.find(
66
+ (call: any[]) => call[0] === "connection"
67
+ )[1];
68
+
69
+ // Simulate client connection
70
+ const mockWs = {
71
+ on: jest.fn(),
72
+ send: jest.fn()
73
+ } as unknown as any;
74
+
75
+ connectionCallback(mockWs);
76
+
77
+ // Retrieve the message callback
78
+ expect(mockWs.on).toHaveBeenCalledWith("message", expect.any(Function));
79
+ const messageCallback = mockWs.on.mock.calls.find(
80
+ (call: any[]) => call[0] === "message"
81
+ )[1];
82
+
83
+ // 1. Authenticate first as an admin
84
+ await messageCallback(
85
+ Buffer.from(
86
+ JSON.stringify({
87
+ type: "AUTHENTICATE",
88
+ requestId: "auth-req",
89
+ payload: {
90
+ token: "mock-admin-token"
91
+ }
92
+ })
93
+ )
94
+ );
95
+
96
+ expect(mockWs.send).toHaveBeenCalled();
97
+ const authResponse = JSON.parse(mockWs.send.mock.calls[0][0]);
98
+ expect(authResponse.type).toBe("AUTH_SUCCESS");
99
+
100
+ // Clear mock send calls before executing SQL
101
+ mockWs.send.mockClear();
102
+
103
+ // Mock executeSql to throw a permission denied error
104
+ (mockDriver.admin.executeSql as jest.Mock).mockRejectedValueOnce(
105
+ new Error("permission denied for table orders")
106
+ );
107
+
108
+ // 2. Simulate receiving EXECUTE_SQL message
109
+ await messageCallback(
110
+ Buffer.from(
111
+ JSON.stringify({
112
+ type: "EXECUTE_SQL",
113
+ requestId: "req-1",
114
+ payload: {
115
+ sql: "SELECT * FROM orders",
116
+ options: { role: "demo" }
117
+ }
118
+ })
119
+ )
120
+ );
121
+
122
+ // Verify executeSql was called
123
+ expect(mockDriver.admin.executeSql).toHaveBeenCalledWith("SELECT * FROM orders", { role: "demo" });
124
+
125
+ // Verify the client received a clean ERROR payload rather than crashing the socket
126
+ expect(mockWs.send).toHaveBeenCalled();
127
+ const sentMessage = JSON.parse(mockWs.send.mock.calls[0][0]);
128
+ expect(sentMessage).toEqual({
129
+ type: "ERROR",
130
+ requestId: "req-1",
131
+ payload: {
132
+ error: {
133
+ message: "permission denied for table orders",
134
+ code: "SQL_ERROR"
135
+ }
136
+ }
137
+ });
138
+ });
139
+ });