@protontech/drive-sdk 0.0.13 → 0.1.0

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 (234) hide show
  1. package/dist/cache/index.d.ts +1 -0
  2. package/dist/cache/index.js +3 -1
  3. package/dist/cache/index.js.map +1 -1
  4. package/dist/cache/memoryCache.d.ts +1 -1
  5. package/dist/cache/nullCache.d.ts +14 -0
  6. package/dist/cache/nullCache.js +37 -0
  7. package/dist/cache/nullCache.js.map +1 -0
  8. package/dist/config.d.ts +16 -1
  9. package/dist/config.js +1 -1
  10. package/dist/config.js.map +1 -1
  11. package/dist/crypto/openPGPCrypto.js +2 -0
  12. package/dist/crypto/openPGPCrypto.js.map +1 -1
  13. package/dist/diagnostic/eventsGenerator.d.ts +14 -0
  14. package/dist/diagnostic/eventsGenerator.js +49 -0
  15. package/dist/diagnostic/eventsGenerator.js.map +1 -0
  16. package/dist/diagnostic/httpClient.d.ts +16 -0
  17. package/dist/diagnostic/httpClient.js +81 -0
  18. package/dist/diagnostic/httpClient.js.map +1 -0
  19. package/dist/diagnostic/index.d.ts +10 -0
  20. package/dist/diagnostic/index.js +35 -0
  21. package/dist/diagnostic/index.js.map +1 -0
  22. package/dist/diagnostic/integrityVerificationStream.d.ts +21 -0
  23. package/dist/diagnostic/integrityVerificationStream.js +56 -0
  24. package/dist/diagnostic/integrityVerificationStream.js.map +1 -0
  25. package/dist/diagnostic/interface.d.ts +102 -0
  26. package/dist/diagnostic/interface.js +3 -0
  27. package/dist/diagnostic/interface.js.map +1 -0
  28. package/dist/diagnostic/sdkDiagnostic.d.ts +22 -0
  29. package/dist/diagnostic/sdkDiagnostic.js +216 -0
  30. package/dist/diagnostic/sdkDiagnostic.js.map +1 -0
  31. package/dist/diagnostic/sdkDiagnosticFull.d.ts +18 -0
  32. package/dist/diagnostic/sdkDiagnosticFull.js +35 -0
  33. package/dist/diagnostic/sdkDiagnosticFull.js.map +1 -0
  34. package/dist/diagnostic/telemetry.d.ts +25 -0
  35. package/dist/diagnostic/telemetry.js +70 -0
  36. package/dist/diagnostic/telemetry.js.map +1 -0
  37. package/dist/diagnostic/zipGenerators.d.ts +9 -0
  38. package/dist/diagnostic/zipGenerators.js +64 -0
  39. package/dist/diagnostic/zipGenerators.js.map +1 -0
  40. package/dist/diagnostic/zipGenerators.test.js +144 -0
  41. package/dist/diagnostic/zipGenerators.test.js.map +1 -0
  42. package/dist/errors.d.ts +2 -1
  43. package/dist/errors.js +3 -1
  44. package/dist/errors.js.map +1 -1
  45. package/dist/interface/config.d.ts +26 -0
  46. package/dist/interface/config.js +3 -0
  47. package/dist/interface/config.js.map +1 -0
  48. package/dist/interface/download.d.ts +2 -2
  49. package/dist/interface/events.d.ts +60 -20
  50. package/dist/interface/events.js +11 -1
  51. package/dist/interface/events.js.map +1 -1
  52. package/dist/interface/httpClient.d.ts +0 -14
  53. package/dist/interface/index.d.ts +8 -4
  54. package/dist/interface/index.js +2 -1
  55. package/dist/interface/index.js.map +1 -1
  56. package/dist/interface/nodes.d.ts +9 -0
  57. package/dist/interface/nodes.js.map +1 -1
  58. package/dist/interface/sharing.d.ts +1 -0
  59. package/dist/interface/upload.d.ts +6 -0
  60. package/dist/internal/download/apiService.js +32 -31
  61. package/dist/internal/download/apiService.js.map +1 -1
  62. package/dist/internal/download/fileDownloader.d.ts +2 -2
  63. package/dist/internal/download/fileDownloader.js.map +1 -1
  64. package/dist/internal/events/apiService.d.ts +4 -6
  65. package/dist/internal/events/apiService.js +15 -22
  66. package/dist/internal/events/apiService.js.map +1 -1
  67. package/dist/internal/events/coreEventManager.d.ts +7 -10
  68. package/dist/internal/events/coreEventManager.js +19 -36
  69. package/dist/internal/events/coreEventManager.js.map +1 -1
  70. package/dist/internal/events/coreEventManager.test.js +87 -0
  71. package/dist/internal/events/coreEventManager.test.js.map +1 -0
  72. package/dist/internal/events/eventManager.d.ts +11 -36
  73. package/dist/internal/events/eventManager.js +59 -105
  74. package/dist/internal/events/eventManager.js.map +1 -1
  75. package/dist/internal/events/eventManager.test.js +167 -82
  76. package/dist/internal/events/eventManager.test.js.map +1 -1
  77. package/dist/internal/events/index.d.ts +13 -33
  78. package/dist/internal/events/index.js +56 -72
  79. package/dist/internal/events/index.js.map +1 -1
  80. package/dist/internal/events/interface.d.ts +59 -14
  81. package/dist/internal/events/interface.js +13 -3
  82. package/dist/internal/events/interface.js.map +1 -1
  83. package/dist/internal/events/volumeEventManager.d.ts +7 -17
  84. package/dist/internal/events/volumeEventManager.js +58 -45
  85. package/dist/internal/events/volumeEventManager.js.map +1 -1
  86. package/dist/internal/events/volumeEventManager.test.d.ts +1 -0
  87. package/dist/internal/events/volumeEventManager.test.js +203 -0
  88. package/dist/internal/events/volumeEventManager.test.js.map +1 -0
  89. package/dist/internal/nodes/cache.d.ts +10 -1
  90. package/dist/internal/nodes/cache.js +17 -0
  91. package/dist/internal/nodes/cache.js.map +1 -1
  92. package/dist/internal/nodes/cryptoService.d.ts +1 -1
  93. package/dist/internal/nodes/cryptoService.js.map +1 -1
  94. package/dist/internal/nodes/events.d.ts +7 -83
  95. package/dist/internal/nodes/events.js +43 -217
  96. package/dist/internal/nodes/events.js.map +1 -1
  97. package/dist/internal/nodes/events.test.js +27 -277
  98. package/dist/internal/nodes/events.test.js.map +1 -1
  99. package/dist/internal/nodes/index.d.ts +3 -4
  100. package/dist/internal/nodes/index.js +5 -5
  101. package/dist/internal/nodes/index.js.map +1 -1
  102. package/dist/internal/nodes/nodesAccess.d.ts +15 -0
  103. package/dist/internal/nodes/nodesAccess.js +37 -0
  104. package/dist/internal/nodes/nodesAccess.js.map +1 -1
  105. package/dist/internal/nodes/nodesAccess.test.js +131 -93
  106. package/dist/internal/nodes/nodesAccess.test.js.map +1 -1
  107. package/dist/internal/nodes/nodesManagement.d.ts +1 -3
  108. package/dist/internal/nodes/nodesManagement.js +12 -26
  109. package/dist/internal/nodes/nodesManagement.js.map +1 -1
  110. package/dist/internal/nodes/nodesManagement.test.js +35 -14
  111. package/dist/internal/nodes/nodesManagement.test.js.map +1 -1
  112. package/dist/internal/shares/cache.d.ts +2 -0
  113. package/dist/internal/shares/cache.js +2 -0
  114. package/dist/internal/shares/cache.js.map +1 -1
  115. package/dist/internal/shares/manager.d.ts +1 -0
  116. package/dist/internal/shares/manager.js +3 -0
  117. package/dist/internal/shares/manager.js.map +1 -1
  118. package/dist/internal/sharing/apiService.js +1 -0
  119. package/dist/internal/sharing/apiService.js.map +1 -1
  120. package/dist/internal/sharing/cryptoService.js +1 -0
  121. package/dist/internal/sharing/cryptoService.js.map +1 -1
  122. package/dist/internal/sharing/events.d.ts +23 -55
  123. package/dist/internal/sharing/events.js +46 -138
  124. package/dist/internal/sharing/events.js.map +1 -1
  125. package/dist/internal/sharing/events.test.js +77 -180
  126. package/dist/internal/sharing/events.test.js.map +1 -1
  127. package/dist/internal/sharing/index.d.ts +4 -5
  128. package/dist/internal/sharing/index.js +5 -5
  129. package/dist/internal/sharing/index.js.map +1 -1
  130. package/dist/internal/sharing/interface.d.ts +3 -0
  131. package/dist/internal/sharing/sharingManagement.d.ts +2 -3
  132. package/dist/internal/sharing/sharingManagement.js +7 -9
  133. package/dist/internal/sharing/sharingManagement.js.map +1 -1
  134. package/dist/internal/sharing/sharingManagement.test.js +9 -39
  135. package/dist/internal/sharing/sharingManagement.test.js.map +1 -1
  136. package/dist/internal/upload/apiService.d.ts +2 -3
  137. package/dist/internal/upload/apiService.js +7 -4
  138. package/dist/internal/upload/apiService.js.map +1 -1
  139. package/dist/internal/upload/index.d.ts +2 -2
  140. package/dist/internal/upload/index.js +3 -3
  141. package/dist/internal/upload/index.js.map +1 -1
  142. package/dist/internal/upload/interface.d.ts +2 -0
  143. package/dist/internal/upload/manager.d.ts +5 -5
  144. package/dist/internal/upload/manager.js +19 -50
  145. package/dist/internal/upload/manager.js.map +1 -1
  146. package/dist/internal/upload/manager.test.js +68 -44
  147. package/dist/internal/upload/manager.test.js.map +1 -1
  148. package/dist/internal/upload/streamUploader.js +1 -2
  149. package/dist/internal/upload/streamUploader.js.map +1 -1
  150. package/dist/internal/upload/streamUploader.test.js +1 -1
  151. package/dist/internal/upload/streamUploader.test.js.map +1 -1
  152. package/dist/protonDriveClient.d.ts +19 -162
  153. package/dist/protonDriveClient.js +26 -190
  154. package/dist/protonDriveClient.js.map +1 -1
  155. package/dist/protonDrivePhotosClient.js +3 -2
  156. package/dist/protonDrivePhotosClient.js.map +1 -1
  157. package/package.json +3 -3
  158. package/src/cache/index.ts +1 -0
  159. package/src/cache/memoryCache.ts +1 -1
  160. package/src/cache/nullCache.ts +38 -0
  161. package/src/config.ts +17 -2
  162. package/src/crypto/openPGPCrypto.ts +2 -0
  163. package/src/diagnostic/eventsGenerator.ts +48 -0
  164. package/src/diagnostic/httpClient.ts +80 -0
  165. package/src/diagnostic/index.ts +38 -0
  166. package/src/diagnostic/integrityVerificationStream.ts +56 -0
  167. package/src/diagnostic/interface.ts +158 -0
  168. package/src/diagnostic/sdkDiagnostic.ts +238 -0
  169. package/src/diagnostic/sdkDiagnosticFull.ts +40 -0
  170. package/src/diagnostic/telemetry.ts +71 -0
  171. package/src/diagnostic/zipGenerators.test.ts +177 -0
  172. package/src/diagnostic/zipGenerators.ts +70 -0
  173. package/src/errors.ts +4 -1
  174. package/src/interface/config.ts +28 -0
  175. package/src/interface/download.ts +2 -2
  176. package/src/interface/events.ts +66 -21
  177. package/src/interface/httpClient.ts +0 -16
  178. package/src/interface/index.ts +8 -4
  179. package/src/interface/nodes.ts +21 -12
  180. package/src/interface/sharing.ts +1 -0
  181. package/src/interface/upload.ts +6 -0
  182. package/src/internal/download/apiService.ts +11 -8
  183. package/src/internal/download/fileDownloader.ts +2 -2
  184. package/src/internal/events/apiService.ts +25 -28
  185. package/src/internal/events/coreEventManager.test.ts +101 -0
  186. package/src/internal/events/coreEventManager.ts +20 -45
  187. package/src/internal/events/eventManager.test.ts +201 -88
  188. package/src/internal/events/eventManager.ts +69 -115
  189. package/src/internal/events/index.ts +54 -84
  190. package/src/internal/events/interface.ts +70 -15
  191. package/src/internal/events/volumeEventManager.test.ts +243 -0
  192. package/src/internal/events/volumeEventManager.ts +55 -53
  193. package/src/internal/nodes/cache.ts +20 -2
  194. package/src/internal/nodes/cryptoService.ts +1 -1
  195. package/src/internal/nodes/events.test.ts +29 -335
  196. package/src/internal/nodes/events.ts +45 -253
  197. package/src/internal/nodes/index.ts +6 -8
  198. package/src/internal/nodes/interface.ts +2 -2
  199. package/src/internal/nodes/nodesAccess.test.ts +132 -91
  200. package/src/internal/nodes/nodesAccess.ts +40 -1
  201. package/src/internal/nodes/nodesManagement.test.ts +39 -15
  202. package/src/internal/nodes/nodesManagement.ts +12 -30
  203. package/src/internal/shares/cache.ts +4 -2
  204. package/src/internal/shares/manager.ts +9 -5
  205. package/src/internal/sharing/apiService.ts +1 -0
  206. package/src/internal/sharing/cache.ts +1 -1
  207. package/src/internal/sharing/cryptoService.ts +1 -0
  208. package/src/internal/sharing/events.test.ts +89 -195
  209. package/src/internal/sharing/events.ts +42 -156
  210. package/src/internal/sharing/index.ts +6 -9
  211. package/src/internal/sharing/interface.ts +6 -2
  212. package/src/internal/sharing/sharingManagement.test.ts +10 -40
  213. package/src/internal/sharing/sharingManagement.ts +7 -11
  214. package/src/internal/upload/apiService.ts +5 -6
  215. package/src/internal/upload/index.ts +5 -5
  216. package/src/internal/upload/interface.ts +2 -0
  217. package/src/internal/upload/manager.test.ts +75 -45
  218. package/src/internal/upload/manager.ts +24 -54
  219. package/src/internal/upload/streamUploader.test.ts +0 -1
  220. package/src/internal/upload/streamUploader.ts +0 -2
  221. package/src/protonDriveClient.ts +75 -244
  222. package/src/protonDrivePhotosClient.ts +4 -3
  223. package/dist/internal/events/cache.d.ts +0 -28
  224. package/dist/internal/events/cache.js +0 -67
  225. package/dist/internal/events/cache.js.map +0 -1
  226. package/dist/internal/events/cache.test.js +0 -43
  227. package/dist/internal/events/cache.test.js.map +0 -1
  228. package/dist/internal/nodes/index.test.js +0 -114
  229. package/dist/internal/nodes/index.test.js.map +0 -1
  230. package/src/internal/events/cache.test.ts +0 -47
  231. package/src/internal/events/cache.ts +0 -80
  232. package/src/internal/nodes/index.test.ts +0 -137
  233. /package/dist/{internal/events/cache.test.d.ts → diagnostic/zipGenerators.test.d.ts} +0 -0
  234. /package/dist/internal/{nodes/index.test.d.ts → events/coreEventManager.test.d.ts} +0 -0
@@ -1,31 +1,32 @@
1
- import { Logger } from "../../interface";
2
1
  import { DriveAPIService, drivePaths, corePaths } from "../apiService";
3
2
  import { makeNodeUid } from "../uids";
4
- import { DriveEvents, DriveEvent, DriveEventType } from "./interface";
3
+ import { DriveEventsListWithStatus, DriveEvent, DriveEventType, NodeEvent, NodeEventType } from "./interface";
5
4
 
6
5
  type GetCoreLatestEventResponse = corePaths['/core/{_version}/events/latest']['get']['responses']['200']['content']['application/json'];
7
6
  type GetCoreEventResponse = corePaths['/core/{_version}/events/{id}']['get']['responses']['200']['content']['application/json'];
8
7
 
9
8
  type GetVolumeLatestEventResponse = drivePaths['/drive/volumes/{volumeID}/events/latest']['get']['responses']['200']['content']['application/json'];
10
- type GetVokumeEventResponse = drivePaths['/drive/v2/volumes/{volumeID}/events/{eventID}']['get']['responses']['200']['content']['application/json'];
9
+ type GetVolumeEventResponse = drivePaths['/drive/v2/volumes/{volumeID}/events/{eventID}']['get']['responses']['200']['content']['application/json'];
11
10
 
12
- const VOLUME_EVENT_TYPE_MAP = {
11
+ interface VolumeEventTypeMap {
12
+ [key: number]: NodeEventType,
13
+ }
14
+ const VOLUME_EVENT_TYPE_MAP: VolumeEventTypeMap = {
13
15
  0: DriveEventType.NodeDeleted,
14
16
  1: DriveEventType.NodeCreated,
15
17
  2: DriveEventType.NodeUpdated,
16
- 3: DriveEventType.NodeUpdatedMetadata,
18
+ 3: DriveEventType.NodeUpdated,
17
19
  }
18
20
 
19
21
  /**
20
22
  * Provides API communication for fetching events.
21
- *
23
+ *
22
24
  * The service is responsible for transforming local objects to API payloads
23
25
  * and vice versa. It should not contain any business logic.
24
26
  */
25
27
  export class EventsAPIService {
26
- constructor(private apiService: DriveAPIService, private logger?: Logger) {
28
+ constructor(private apiService: DriveAPIService) {
27
29
  this.apiService = apiService;
28
- this.logger = logger;
29
30
  }
30
31
 
31
32
  async getCoreLatestEventId(): Promise<string> {
@@ -33,17 +34,19 @@ export class EventsAPIService {
33
34
  return result.EventID as string;
34
35
  }
35
36
 
36
- async getCoreEvents(eventId: string): Promise<DriveEvents> {
37
- // TODO: Switch to v6 endpoint: DriveShareRefresh doesnt seem to be part of it.
37
+ async getCoreEvents(eventId: string): Promise<DriveEventsListWithStatus> {
38
+ // TODO: Switch to v6 endpoint?
38
39
  const result = await this.apiService.get<GetCoreEventResponse>(`core/v5/events/${eventId}`);
39
- const events: DriveEvent[] = result.DriveShareRefresh?.Action === 2 ? [
40
- {
41
- type: DriveEventType.ShareWithMeUpdated,
42
- }
43
- ] : [];
40
+ // in core/v5/events, refresh is always all apps, value 255
41
+ const refresh = result.Refresh > 0;
42
+ const events: DriveEvent[] = (refresh || result.DriveShareRefresh?.Action === 2) ? [{
43
+ type: DriveEventType.SharedWithMeUpdated,
44
+ eventId: result.EventID,
45
+ treeEventScopeId: 'core',
46
+ }] : [];
44
47
 
45
48
  return {
46
- lastEventId: result.EventID,
49
+ latestEventId: result.EventID,
47
50
  more: result.More === 1,
48
51
  refresh: result.Refresh === 1,
49
52
  events,
@@ -55,31 +58,25 @@ export class EventsAPIService {
55
58
  return result.EventID;
56
59
  }
57
60
 
58
- async getVolumeEvents(volumeId: string, eventId: string, isOwnVolume = false): Promise<DriveEvents> {
59
- const result = await this.apiService.get<GetVokumeEventResponse>(`drive/v2/volumes/${volumeId}/events/${eventId}`);
61
+ async getVolumeEvents(volumeId: string, eventId: string): Promise<DriveEventsListWithStatus> {
62
+ const result = await this.apiService.get<GetVolumeEventResponse>(`drive/v2/volumes/${volumeId}/events/${eventId}`);
60
63
  return {
61
- lastEventId: result.EventID,
64
+ latestEventId: result.EventID,
62
65
  more: result.More,
63
66
  refresh: result.Refresh,
64
- events: result.Events.map((event): DriveEvent => {
67
+ events: result.Events.map((event): NodeEvent => {
65
68
  const type = VOLUME_EVENT_TYPE_MAP[event.EventType];
66
69
  const uids = {
67
70
  nodeUid: makeNodeUid(volumeId, event.Link.LinkID),
68
71
  parentNodeUid: makeNodeUid(volumeId, event.Link.ParentLinkID as string),
69
72
  }
70
- // VOLUME_EVENT_TYPE_MAP will never return this event type.
71
- // It is here to satisfy the type checker. It is safe to do.
72
- if (type === DriveEventType.ShareWithMeUpdated) {
73
- return {
74
- type,
75
- };
76
- }
77
73
  return {
78
74
  type,
79
75
  ...uids,
80
76
  isTrashed: event.Link.IsTrashed,
81
77
  isShared: event.Link.IsShared,
82
- isOwnVolume,
78
+ eventId: event.EventID,
79
+ treeEventScopeId: volumeId,
83
80
  };
84
81
  }),
85
82
  };
@@ -0,0 +1,101 @@
1
+ import { getMockLogger } from "../../tests/logger";
2
+ import { EventsAPIService } from "./apiService";
3
+ import { DriveEvent, DriveEventsListWithStatus, DriveEventType } from "./interface";
4
+ import { CoreEventManager } from "./coreEventManager";
5
+
6
+ describe("CoreEventManager", () => {
7
+ let mockApiService: jest.Mocked<EventsAPIService>;
8
+ let coreEventManager: CoreEventManager;
9
+ const mockLogger = getMockLogger();
10
+
11
+ beforeEach(() => {
12
+ // Reset mocks
13
+ jest.clearAllMocks();
14
+
15
+ mockApiService = {
16
+ getCoreLatestEventId: jest.fn(),
17
+ getCoreEvents: jest.fn(),
18
+ getVolumeLatestEventId: jest.fn(),
19
+ getVolumeEvents: jest.fn(),
20
+ } as unknown as jest.Mocked<EventsAPIService>;
21
+
22
+ coreEventManager = new CoreEventManager(mockLogger, mockApiService);
23
+ });
24
+
25
+ describe("getLatestEventId", () => {
26
+ it("should return the latest event ID from API service", async () => {
27
+ const expectedEventId = "event-123";
28
+ mockApiService.getCoreLatestEventId.mockResolvedValue(expectedEventId);
29
+
30
+ const result = await coreEventManager.getLatestEventId();
31
+
32
+ expect(result).toBe(expectedEventId);
33
+ expect(mockApiService.getCoreLatestEventId).toHaveBeenCalledTimes(1);
34
+ });
35
+
36
+ it("should handle API service errors", async () => {
37
+ const error = new Error("API error");
38
+ mockApiService.getCoreLatestEventId.mockRejectedValue(error);
39
+
40
+ await expect(coreEventManager.getLatestEventId()).rejects.toThrow("API error");
41
+ expect(mockApiService.getCoreLatestEventId).toHaveBeenCalledTimes(1);
42
+ });
43
+ });
44
+
45
+ describe("getEvents", () => {
46
+ const eventId = "event1";
47
+ const latestEventId = "event2";
48
+
49
+ it("should yield ShareWithMeUpdated event when refresh is true", async () => {
50
+ const mockEvents: DriveEventsListWithStatus = {
51
+ latestEventId,
52
+ more: false,
53
+ refresh: true,
54
+ events: [],
55
+ };
56
+ mockApiService.getCoreEvents.mockResolvedValue(mockEvents);
57
+
58
+ const events = [];
59
+ for await (const event of coreEventManager.getEvents(eventId)) {
60
+ events.push(event);
61
+ }
62
+
63
+ expect(events).toHaveLength(1);
64
+ expect(events[0]).toEqual({
65
+ type: DriveEventType.SharedWithMeUpdated,
66
+ treeEventScopeId: 'core',
67
+ eventId: latestEventId,
68
+ });
69
+ expect(mockApiService.getCoreEvents).toHaveBeenCalledWith(eventId);
70
+ });
71
+
72
+ it("should yield all events when there are actual events", async () => {
73
+ const mockEvent1: DriveEvent = {
74
+ type: DriveEventType.SharedWithMeUpdated,
75
+ eventId: "event-1",
76
+ treeEventScopeId: 'core',
77
+ };
78
+ const mockEvent2: DriveEvent = {
79
+ type: DriveEventType.SharedWithMeUpdated,
80
+ eventId: "event-2",
81
+ treeEventScopeId: 'core',
82
+ };
83
+ const mockEvents: DriveEventsListWithStatus = {
84
+ latestEventId,
85
+ more: false,
86
+ refresh: false,
87
+ events: [mockEvent1, mockEvent2],
88
+ };
89
+ mockApiService.getCoreEvents.mockResolvedValue(mockEvents);
90
+
91
+ const events = [];
92
+ for await (const event of coreEventManager.getEvents(eventId)) {
93
+ events.push(event);
94
+ }
95
+
96
+ expect(events).toHaveLength(2);
97
+ expect(events[0]).toEqual(mockEvent1);
98
+ expect(events[1]).toEqual(mockEvent2);
99
+ });
100
+ });
101
+ });
@@ -1,9 +1,7 @@
1
1
  import { Logger } from "../../interface";
2
2
  import { LoggerWithPrefix } from "../../telemetry";
3
3
  import { EventsAPIService } from "./apiService";
4
- import { EventsCache } from "./cache";
5
- import { DriveEvent, DriveEventType } from "./interface";
6
- import { EventManager } from "./eventManager";
4
+ import { DriveEvent, DriveEventType, EventManagerInterface } from "./interface";
7
5
 
8
6
  /**
9
7
  * Combines API and event manager to provide a service for listening to
@@ -11,59 +9,36 @@ import { EventManager } from "./eventManager";
11
9
  * At this moment, Drive listenes only to shares with me updates from core
12
10
  * events. Such even indicates that user was invited to the new share or
13
11
  * that user's membership was removed from existing one and lost access.
14
- *
12
+ *
15
13
  * The client might be already using own core events, thus this service
16
14
  * is here only in case the client is not connected to the Proton services
17
15
  * with own implementation.
18
16
  */
19
- export class CoreEventManager {
20
- private manager: EventManager<DriveEvent>;
21
-
22
- constructor(logger: Logger, private apiService: EventsAPIService, private cache: EventsCache) {
17
+ export class CoreEventManager implements EventManagerInterface<DriveEvent> {
18
+ constructor(private logger: Logger, private apiService: EventsAPIService) {
23
19
  this.apiService = apiService;
24
20
 
25
- this.manager = new EventManager(
26
- new LoggerWithPrefix(logger, `core`),
27
- () => this.getLastEventId(),
28
- (eventId) => this.apiService.getCoreEvents(eventId),
29
- (lastEventId) => this.cache.setLastEventId('core', {
30
- lastEventId,
31
- pollingIntervalInSeconds: this.manager.pollingIntervalInSeconds,
32
- isOwnVolume: false,
33
- }),
34
- );
21
+ this.logger = new LoggerWithPrefix(logger, `core`);
35
22
  }
36
23
 
37
- private async getLastEventId(): Promise<string> {
38
- const lastEventId = await this.cache.getLastEventId('core');
39
- if (lastEventId) {
40
- return lastEventId;
41
- }
42
- return this.apiService.getCoreLatestEventId();
24
+ async getLatestEventId(): Promise<string> {
25
+ return await this.apiService.getCoreLatestEventId();
43
26
  }
44
27
 
45
- async startSubscription(): Promise<void> {
46
- await this.manager.start();
47
- }
48
-
49
- async stopSubscription(): Promise<void> {
50
- await this.manager.stop();
28
+ async * getEvents(eventId: string): AsyncIterable<DriveEvent> {
29
+ const events = await this.apiService.getCoreEvents(eventId);
30
+ if (events.events.length === 0 && events.latestEventId !== eventId) {
31
+ yield {
32
+ type: DriveEventType.SharedWithMeUpdated,
33
+ treeEventScopeId: 'core',
34
+ eventId: events.latestEventId,
35
+ };
36
+ return;
37
+ }
38
+ yield* events.events;
51
39
  }
52
40
 
53
- addListener(callback: (events: DriveEvent[]) => Promise<void>): void {
54
- this.manager.addListener(async (events, fullRefresh) => {
55
- if (events) {
56
- await callback(events);
57
- }
58
- if (fullRefresh) {
59
- // Because only updates about shares that are shared with me
60
- // are listened to from core events, in the case of core full
61
- // refresh, we don't have to refresh anything more than this
62
- // one specific event.
63
- await callback([{
64
- type: DriveEventType.ShareWithMeUpdated,
65
- }]);
66
- }
67
- });
41
+ getLogger(): Logger {
42
+ return this.logger;
68
43
  }
69
44
  }
@@ -1,139 +1,252 @@
1
1
  import { getMockLogger } from "../../tests/logger";
2
- import { NotFoundAPIError } from "../apiService";
3
2
  import { EventManager } from "./eventManager";
3
+ import { DriveEvent, DriveEventType, EventSubscription, UnsubscribeFromEventsSourceError } from "./interface";
4
4
 
5
5
  jest.useFakeTimers();
6
6
 
7
+ const POLLING_INTERVAL = 1;
8
+
7
9
  describe("EventManager", () => {
8
- let manager: EventManager<string>;
9
-
10
- const getLastEventIdMock = jest.fn();
10
+ let manager: EventManager<DriveEvent>;
11
+
12
+ const getLatestEventIdMock = jest.fn();
11
13
  const getEventsMock = jest.fn();
12
- const updateLatestEventIdMock = jest.fn();
13
14
  const listenerMock = jest.fn();
15
+ const mockLogger = getMockLogger();
16
+ const subscriptions: EventSubscription[] = [];
14
17
 
15
18
  beforeEach(() => {
16
- jest.clearAllMocks();
17
-
18
- getLastEventIdMock.mockImplementation(() => Promise.resolve("eventId1"));
19
- getEventsMock.mockImplementation(() => Promise.resolve({
20
- lastEventId: "eventId2",
21
- more: false,
22
- refresh: false,
23
- events: ["event1", "event2"],
24
- }));
19
+ const mockEventManager = {
20
+ getLogger: () => mockLogger,
21
+ getLatestEventId: getLatestEventIdMock,
22
+ getEvents: getEventsMock,
23
+ };
25
24
 
26
25
  manager = new EventManager(
27
- getMockLogger(),
28
- getLastEventIdMock,
29
- getEventsMock,
30
- updateLatestEventIdMock,
26
+ mockEventManager as any,
27
+ POLLING_INTERVAL,
28
+ null,
31
29
  );
32
- manager.addListener(listenerMock);
30
+ const subscription = manager.addListener(listenerMock);
31
+ subscriptions.push(subscription);
33
32
  });
34
33
 
35
34
  afterEach(async () => {
36
35
  await manager.stop();
36
+ while (subscriptions.length > 0) {
37
+ const subscription = subscriptions.pop();
38
+ subscription?.dispose();
39
+ }
40
+ jest.clearAllMocks();
37
41
  });
38
42
 
39
- it("should get latest event ID on first run only", async () => {
40
- await manager.start();
41
- expect(getLastEventIdMock).toHaveBeenCalledTimes(1);
42
- expect(getEventsMock).toHaveBeenCalledTimes(0);
43
- expect(listenerMock).toHaveBeenCalledTimes(0);
44
- expect(updateLatestEventIdMock).toHaveBeenCalledTimes(1);
45
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId1');
46
- });
43
+ it("should start polling when started", async () => {
44
+ getLatestEventIdMock.mockResolvedValue('EventId1');
45
+
46
+ const mockEvents: DriveEvent[][] = [
47
+ [{
48
+ type: DriveEventType.FastForward,
49
+ treeEventScopeId: 'volume1',
50
+ eventId: 'EventId2',
51
+ }],
52
+ [{
53
+ type: DriveEventType.FastForward,
54
+ treeEventScopeId: 'volume1',
55
+ eventId: 'EventId3',
56
+ }],
57
+ ];
58
+
59
+ getEventsMock.mockImplementationOnce(async function* () {
60
+ yield* mockEvents[0];
61
+ }).mockImplementationOnce(async function* () {
62
+ yield* mockEvents[1];
63
+ }).mockImplementationOnce(async function* () {
64
+ });
47
65
 
48
- it("should notify about events in the next run", async () => {
49
- await manager.start();
50
- expect(getLastEventIdMock).toHaveBeenCalledTimes(1);
66
+ expect(getLatestEventIdMock).toHaveBeenCalledTimes(0);
51
67
  expect(getEventsMock).toHaveBeenCalledTimes(0);
52
- expect(listenerMock).toHaveBeenCalledTimes(0);
53
- expect(updateLatestEventIdMock).toHaveBeenCalledTimes(1);
54
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId1');
55
- updateLatestEventIdMock.mockClear();
68
+
69
+ expect(await manager.start()).toBeUndefined();
70
+
71
+ expect(getLatestEventIdMock).toHaveBeenCalledTimes(1);
72
+ expect(getEventsMock).toHaveBeenCalledWith('EventId1');
73
+
56
74
  await jest.runOnlyPendingTimersAsync();
57
- expect(getEventsMock).toHaveBeenCalledTimes(1);
58
- expect(listenerMock).toHaveBeenCalledTimes(1);
59
- expect(updateLatestEventIdMock).toHaveBeenCalledTimes(1);
60
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId2');
75
+ expect(getEventsMock).toHaveBeenCalledTimes(2);
76
+ expect(getEventsMock).toHaveBeenCalledWith('EventId2');
61
77
  });
62
78
 
63
- it("should continue with more events", async () => {
64
- getEventsMock.mockImplementation((lastEventId: string) => Promise.resolve({
65
- lastEventId: lastEventId === "eventId1" ? "eventId2" : "eventId3",
66
- more: lastEventId === "eventId1" ? true : false,
67
- refresh: false,
68
- events: lastEventId === "eventId1" ? ["event1", "event2"] : ["event3"],
69
- }));
79
+ it("should stop polling when stopped", async () => {
80
+ getLatestEventIdMock.mockResolvedValue('eventId1');
81
+ getEventsMock.mockImplementation(async function* () {
82
+ yield {
83
+ type: DriveEventType.FastForward,
84
+ treeEventScopeId: 'volume1',
85
+ eventId: 'eventId1',
86
+ };
87
+ });
88
+
70
89
  await manager.start();
71
90
  await jest.runOnlyPendingTimersAsync();
72
- expect(getEventsMock).toHaveBeenCalledTimes(2);
73
- expect(listenerMock).toHaveBeenCalledTimes(2);
74
- expect(listenerMock).toHaveBeenCalledWith(["event1", "event2"], false);
75
- expect(listenerMock).toHaveBeenCalledWith(["event3"], false);
76
- expect(updateLatestEventIdMock).toHaveBeenCalledTimes(3);
77
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId1');
78
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId2');
79
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId3');
91
+
92
+ const callsBeforeStop = getEventsMock.mock.calls.length;
93
+ await manager.stop();
94
+ await jest.runOnlyPendingTimersAsync();
95
+
96
+ // Should not have made additional calls after stopping
97
+ expect(getEventsMock).toHaveBeenCalledTimes(callsBeforeStop);
80
98
  });
81
99
 
82
- it("should refresh if event does not exist", async () => {
83
- getEventsMock.mockImplementation(() => Promise.reject(new NotFoundAPIError('Event not found', 2501)));
84
- await manager.start();
100
+ it("should notify all listeners when getting events", async () => {
101
+ getLatestEventIdMock.mockResolvedValue('eventId1');
102
+
103
+ const mockEvents: DriveEvent[] = [
104
+ {
105
+ type: DriveEventType.NodeCreated,
106
+ nodeUid: 'node1',
107
+ parentNodeUid: 'parent1',
108
+ isTrashed: false,
109
+ isShared: false,
110
+ treeEventScopeId: 'volume1',
111
+ eventId: 'eventId2',
112
+ },
113
+ ];
114
+
115
+ getEventsMock.mockImplementationOnce(async function* () {
116
+ yield* mockEvents;
117
+ }).mockImplementation(async function* () {
118
+ });
119
+
120
+ expect(await manager.start()).toBeUndefined();
85
121
  await jest.runOnlyPendingTimersAsync();
86
- expect(getLastEventIdMock).toHaveBeenCalledTimes(2);
87
122
  expect(listenerMock).toHaveBeenCalledTimes(1);
88
- expect(listenerMock).toHaveBeenCalledWith([], true);
89
- expect(updateLatestEventIdMock).toHaveBeenCalledTimes(1);
90
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId1');
123
+ expect(listenerMock).toHaveBeenNthCalledWith(1, mockEvents[0]);
91
124
  });
92
125
 
93
- it("should retry on error", async () => {
94
- let index = 0;
95
- getEventsMock.mockImplementation(() => {
96
- index++;
97
- if (index <= 3) {
98
- return Promise.reject(new Error("Error"));
126
+ it("should propagate unsubscription errors", async () => {
127
+ getLatestEventIdMock.mockImplementation(() => {
128
+ throw new UnsubscribeFromEventsSourceError("Not found");
129
+ });
130
+
131
+ await expect(manager.start()).rejects.toThrow(UnsubscribeFromEventsSourceError);
132
+
133
+ expect(getLatestEventIdMock).toHaveBeenCalledTimes(1);
134
+ expect(listenerMock).toHaveBeenCalledTimes(0);
135
+ expect(getEventsMock).toHaveBeenCalledTimes(0);
136
+ });
137
+
138
+ it("should continue processing multiple events", async () => {
139
+ getLatestEventIdMock.mockResolvedValue('eventId1');
140
+
141
+ const mockEvents: DriveEvent[] = [
142
+ {
143
+ type: DriveEventType.NodeCreated,
144
+ nodeUid: 'node1',
145
+ parentNodeUid: 'parent1',
146
+ isTrashed: false,
147
+ isShared: false,
148
+ treeEventScopeId: 'volume1',
149
+ eventId: 'eventId2',
150
+ },
151
+ {
152
+ type: DriveEventType.NodeCreated,
153
+ nodeUid: 'node2',
154
+ parentNodeUid: 'parent1',
155
+ isTrashed: false,
156
+ isShared: false,
157
+ treeEventScopeId: 'volume1',
158
+ eventId: 'eventId3',
99
159
  }
100
- return Promise.resolve({
101
- lastEventId: "eventId2",
102
- more: false,
103
- refresh: false,
104
- events: ["event1", "event2"],
105
- });
160
+ ];
161
+
162
+ getEventsMock.mockImplementationOnce(async function* () {
163
+ yield* mockEvents;
164
+ }).mockImplementation(async function* () {
165
+ // Empty generator for subsequent calls
106
166
  });
167
+
107
168
  await manager.start();
108
- updateLatestEventIdMock.mockClear();
169
+ await jest.runOnlyPendingTimersAsync();
109
170
 
110
- // First failure.
171
+ expect(listenerMock).toHaveBeenCalledTimes(2);
172
+ expect(listenerMock).toHaveBeenNthCalledWith(1, mockEvents[0]);
173
+ expect(listenerMock).toHaveBeenNthCalledWith(2, mockEvents[1]);
174
+
175
+ getEventsMock.mockImplementationOnce(async function* () {
176
+ yield* mockEvents;
177
+ })
111
178
  await jest.runOnlyPendingTimersAsync();
112
- expect(listenerMock).toHaveBeenCalledTimes(0);
113
- expect(manager.nextPollTimeout).toBe(30000);
179
+ expect(listenerMock).toHaveBeenCalledTimes(4);
180
+ expect(listenerMock).toHaveBeenNthCalledWith(1, mockEvents[0]);
181
+ expect(listenerMock).toHaveBeenNthCalledWith(2, mockEvents[1]);
182
+ });
183
+
184
+ it("should retry on error with exponential backoff", async () => {
185
+ getLatestEventIdMock.mockResolvedValue('eventId1');
186
+
187
+ let callCount = 0;
188
+ getEventsMock.mockImplementation(async function* () {
189
+ callCount++;
190
+ if (callCount <= 3) {
191
+ throw new Error("Network error");
192
+ }
193
+ yield {
194
+ type: DriveEventType.FastForward,
195
+ treeEventScopeId: 'volume1',
196
+ eventId: 'eventId3',
197
+ };
198
+ });
199
+
200
+ expect(manager['retryIndex']).toEqual(0);
201
+
202
+ expect(await manager.start()).toBeUndefined();
203
+ expect(getEventsMock).toHaveBeenCalledTimes(1);
204
+ expect(manager['retryIndex']).toEqual(1);
114
205
 
115
- // Second failure.
116
206
  await jest.runOnlyPendingTimersAsync();
117
- expect(listenerMock).toHaveBeenCalledTimes(0);
118
- expect(manager.nextPollTimeout).toBe(60000);
207
+ expect(getEventsMock).toHaveBeenCalledTimes(2);
208
+ expect(manager['retryIndex']).toEqual(2);
119
209
 
120
- // Third failure.
121
210
  await jest.runOnlyPendingTimersAsync();
211
+ expect(manager['retryIndex']).toEqual(3);
212
+
122
213
  expect(listenerMock).toHaveBeenCalledTimes(0);
123
- expect(manager.nextPollTimeout).toBe(90000);
124
214
 
125
- // And now it passes.
126
215
  await jest.runOnlyPendingTimersAsync();
127
216
  expect(listenerMock).toHaveBeenCalledTimes(1);
128
- expect(listenerMock).toHaveBeenCalledWith(["event1", "event2"], false);
129
- expect(updateLatestEventIdMock).toHaveBeenCalledTimes(1);
130
- expect(updateLatestEventIdMock).toHaveBeenCalledWith('eventId2');
217
+ // After success, retry index should reset
218
+ expect(manager['retryIndex']).toEqual(0);
131
219
  });
132
220
 
133
- it("should stop polling", async () => {
134
- await manager.start();
221
+ it("should stop polling when stopped immediately", async () => {
222
+ getLatestEventIdMock.mockResolvedValue('eventId1');
223
+ getEventsMock.mockImplementation(async function* () {
224
+ yield {
225
+ type: DriveEventType.FastForward,
226
+ treeEventScopeId: 'volume1',
227
+ eventId: 'eventId1',
228
+ };
229
+ });
230
+
231
+ expect(await manager.start()).toBeUndefined();
232
+ expect(getEventsMock).toHaveBeenCalledTimes(1);
135
233
  await manager.stop();
136
234
  await jest.runOnlyPendingTimersAsync();
137
- expect(getEventsMock).toHaveBeenCalledTimes(0);
235
+
236
+ // getEvents should have been called once during start, but not again after stop
237
+ expect(getEventsMock).toHaveBeenCalledTimes(1);
238
+ });
239
+
240
+ it("should handle empty event streams", async () => {
241
+ getLatestEventIdMock.mockResolvedValue('eventId1');
242
+
243
+ getEventsMock.mockImplementation(async function* () {
244
+ // Empty generator - no events
245
+ });
246
+
247
+ await manager.start();
248
+ await jest.runOnlyPendingTimersAsync();
249
+
250
+ expect(listenerMock).toHaveBeenCalledTimes(0);
138
251
  });
139
252
  });