@airtop/sdk 0.1.37-beta0 → 0.1.37-beta2

package/wrapper/AirtopSessions.js

@@ -152,23 +152,33 @@ class AirtopSessions extends Client_1.Sessions {
         });
     }
     /**
-     * Waits for a file to be downloaded in a session and reach 'available' status
+     * Waits for a file to be downloaded in a session and reach 'available' status.
+     * Defaults to looking back 5 seconds in the event stream for the file to be available.
+     * Use `lookbackSeconds` to control this behavior.
      *
-     * @param sessionId - The ID of the session to monitor
-     * @param requestOptions - Optional request configuration including timeout
-     * @returns Object containing file's id and downloadUrl, or null if timed out
+     * @param {string} sessionId - The ID of the session to monitor
+     * @param {Object} configuration - The optional configuration parameters for the function
+     * @param {number} [configuration.lookbackSeconds=5] - The number of seconds to look back for prior events. Default `5`. 0 means no lookback.
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @returns {Promise<{ id: string, downloadUrl: string } | null>} Object containing file's id and downloadUrl, or null if timed out
      */
-    waitForDownload(sessionId, requestOptions) {
+    waitForDownload(sessionId, configuration, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { lookbackSeconds = 5 } = configuration || {};
+            this.log(`waiting for file to be available on session: ${sessionId}`);
+            const startTime = new Date();
             const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 120;
             // Create a promise that resolves to null after the timeout
             const timeoutPromise = new Promise((resolve) => {
-                setTimeout(() => resolve(null), timeoutSeconds * 1000);
+                setTimeout(() => {
+                    this.log(`waiting for file timed out after ${timeoutSeconds} seconds`);
+                    resolve(null);
+                }, timeoutSeconds * 1000);
             });
             // Create a promise for the event processing
             const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
                 var _a, e_2, _b, _c;
-                const sessionEvents = yield this.events(sessionId, {}, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
+                const sessionEvents = yield this.events(sessionId, { all: lookbackSeconds >= 0 }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
                 try {
                     for (var _d = true, sessionEvents_2 = __asyncValues(sessionEvents), sessionEvents_2_1; sessionEvents_2_1 = yield sessionEvents_2.next(), _a = sessionEvents_2_1.done, !_a; _d = true) {
                         _c = sessionEvents_2_1.value;
@@ -176,8 +186,14 @@ class AirtopSessions extends Client_1.Sessions {
                         const event = _c;
                         const e = event;
                         if (e.event === 'file_status') {
-                            this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
                             if (e.status === 'available') {
+                                const eventTime = Date.parse(e.eventTime);
+                                this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
+                                const thresholdTime = startTime.getTime() - lookbackSeconds * 1000;
+                                if (eventTime < thresholdTime) {
+                                    this.log(`skipping file available event for ${e.fileId} because its timestamp is earlier than lookbackSeconds`);
+                                    continue;
+                                }
                                 return {
                                     id: e.fileId,
                                     downloadUrl: e.downloadUrl,
@@ -200,14 +216,20 @@ class AirtopSessions extends Client_1.Sessions {
         });
     }
     /**
-     * Waits for a file download to start in a session
+     * Waits for a file download to start in a session.
+     * Defaults to looking back 5 seconds in the event stream for the file to be available.
+     * Use `lookbackSeconds` to control this behavior.
      *
-     * @param sessionId - The ID of the session to monitor
-     * @param requestOptions - Optional request configuration including timeout
-     * @returns Object containing file's id and downloadUrl, or null if timed out
+     * @param {string} sessionId - The ID of the session to monitor
+     * @param {Object} configuration - The optional configuration parameters for the function
+     * @param {number} [configuration.lookbackSeconds=5] - The number of seconds to look back for prior events. Default `5`. 0 means no lookback.
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @returns {Promise<{ id: string, downloadUrl: string } | null>} Object containing file's id and downloadUrl, or null if timed out
      */
-    waitForDownloadStart(sessionId, requestOptions) {
+    waitForDownloadStart(sessionId, configuration, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { lookbackSeconds = 5 } = configuration || {};
+            const startTime = new Date();
             const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 60;
             // Create a promise that resolves to null after the timeout
             const timeoutPromise = new Promise((resolve) => {
@@ -216,7 +238,7 @@ class AirtopSessions extends Client_1.Sessions {
             // Create a promise for the event processing
             const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
                 var _a, e_3, _b, _c;
-                const sessionEvents = yield this.events(sessionId, {}, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
+                const sessionEvents = yield this.events(sessionId, { all: lookbackSeconds >= 0 }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
                 try {
                     for (var _d = true, sessionEvents_3 = __asyncValues(sessionEvents), sessionEvents_3_1; sessionEvents_3_1 = yield sessionEvents_3.next(), _a = sessionEvents_3_1.done, !_a; _d = true) {
                         _c = sessionEvents_3_1.value;
@@ -226,6 +248,12 @@ class AirtopSessions extends Client_1.Sessions {
                         if (e.event === 'file_status') {
                             this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
                             if (e.status === 'uploading') {
+                                const eventTime = Date.parse(e.eventTime);
+                                const thresholdTime = startTime.getTime() - lookbackSeconds * 1000;
+                                if (eventTime < thresholdTime) {
+                                    this.log(`skipping file uploading event for ${e.fileId} because its timestamp is earlier than lookbackSeconds`);
+                                    continue;
+                                }
                                 return {
                                     id: e.fileId,
                                     downloadUrl: e.downloadUrl,
@@ -250,16 +278,20 @@ class AirtopSessions extends Client_1.Sessions {
     /**
      * Downloads the next file from a session as soon as it starts to become available
      *
-     * @param sessionId - The ID of the session to download from
-     * @param destinationPath - The local path where the file should be saved
-     * @param onProgress - Optional callback to track download progress
-     * @param requestOptions - Optional request configuration including timeout
+     * @param {string} sessionId - The ID of the session to download from
+     * @param {string} destinationPath - The local path where the file should be saved
+     * @param {Object} configuration - The optional configuration parameters for the function
+     * @param {function} [configuration.onProgress] - Optional callback to track download progress
+     * @param {number} [configuration.lookbackSeconds=5] - Optional number of seconds to look back for prior events. Default `5`. 0 means no lookback.
+     * @param {number} [configuration.timeoutSeconds=120] - Optional timeout in seconds. Default `120`.
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
      * @throws Error if no file is available to download within the timeout period
      */
-    downloadNextFile(sessionId, destinationPath, onProgress, requestOptions) {
+    downloadNextFile(sessionId, destinationPath, configuration, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const nextFile = yield this.waitForDownload(sessionId, requestOptions);
+            const { onProgress = undefined, lookbackSeconds = 5, timeoutSeconds = 120 } = configuration || {};
+            const nextFile = yield this.waitForDownload(sessionId, { lookbackSeconds }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
             if (!nextFile) {
                 throw new Error('No file to download within timeout');
             }