@devrev/airsync-sdk 2.0.0-beta.2 → 2.0.0-beta.4

package/dist/multithreading/adapters/extraction-adapter.js

@@ -0,0 +1,323 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractionAdapter = void 0;
+const attachments_streaming_pool_1 = require("../../attachments-streaming/attachments-streaming-pool");
+const constants_1 = require("../../common/constants");
+const logger_1 = require("../../logger/logger");
+const repo_1 = require("../../repo/repo");
+const extraction_1 = require("../../types/extraction");
+const base_adapter_1 = require("./base-adapter");
+/**
+ * ExtractionAdapter is the adapter passed to extraction tasks. It exposes the
+ * extraction surface (repos, artifacts, attachment streaming) and uploads
+ * pending repos and updates the extraction boundaries before emitting.
+ *
+ * @public
+ */
+class ExtractionAdapter extends base_adapter_1.BaseAdapter {
+    constructor(params) {
+        super(params);
+        this.repos = [];
+        this.currentEventDataLength = 0;
+        this._artifacts = [];
+    }
+    /**
+     * Returns whether the given item type should be extracted.
+     * Defaults to true if the scope is empty or the item type is not listed.
+     */
+    shouldExtract(itemType) {
+        const scope = this.extractionScope;
+        if (Object.keys(scope).length === 0)
+            return true;
+        if (!(itemType in scope))
+            return true;
+        return scope[itemType].extract;
+    }
+    initializeRepos(repos) {
+        this.repos = repos.map((repo) => {
+            const shouldNormalize = repo.itemType !== constants_1.AirSyncDefaultItemTypes.EXTERNAL_DOMAIN_METADATA &&
+                repo.itemType !== constants_1.SSOR_ATTACHMENT;
+            return new repo_1.Repo(Object.assign(Object.assign({ event: this.event, itemType: repo.itemType }, (shouldNormalize && { normalize: repo.normalize })), { onUpload: (artifact) => {
+                    var _a;
+                    // We need to store artifacts ids in state for later use when streaming attachments
+                    if (repo.itemType === constants_1.AirSyncDefaultItemTypes.ATTACHMENTS) {
+                        (_a = this.sdkState.toDevRev) === null || _a === void 0 ? void 0 : _a.attachmentsMetadata.artifactIds.push(artifact.id);
+                    }
+                    // Calculate size of the entire artifact object that goes in the SQS message
+                    this.currentEventDataLength += Buffer.byteLength(JSON.stringify(artifact), 'utf8');
+                    if (this.currentEventDataLength > constants_1.EVENT_SIZE_THRESHOLD_BYTES &&
+                        !this.isTimeout) {
+                        this.isTimeout = true;
+                    }
+                }, options: Object.assign(Object.assign({}, this.options), repo.overridenOptions) }));
+        });
+    }
+    getRepo(itemType) {
+        return (0, logger_1.runWithSdkLogContext)(() => {
+            const repo = this.repos.find((repo) => repo.itemType === itemType);
+            if (!repo) {
+                console.error(`Repo for item type ${itemType} not found.`);
+                return;
+            }
+            return repo;
+        });
+    }
+    get artifacts() {
+        return this._artifacts;
+    }
+    set artifacts(artifacts) {
+        this._artifacts = this._artifacts
+            .concat(artifacts)
+            .filter((value, index, self) => self.indexOf(value) === index);
+    }
+    async beforeEmit(newEventType) {
+        // Upload all repos before emitting the event
+        console.log(`Uploading all repos before emitting event with event type: ${newEventType}.`);
+        await this.uploadAllRepos();
+        // When the full extraction cycle completes, commit the extraction window
+        // boundaries so subsequent incremental syncs can resume from them.
+        if (newEventType === extraction_1.ExtractorEventType.AttachmentExtractionDone) {
+            const sdkState = this.sdkState;
+            // Clear pending extraction boundaries now that the cycle is complete
+            sdkState.pendingWorkersOldest = '';
+            sdkState.pendingWorkersNewest = '';
+            // Update workersOldest and workersNewest boundaries from resolved extraction timestamps.
+            // Expand boundaries: workersOldest gets the earliest timestamp, workersNewest gets the latest.
+            const extractionStart = this.event.payload.event_context.extract_from;
+            const extractionEnd = this.event.payload.event_context.extract_to;
+            if (extractionStart &&
+                (!sdkState.workersOldest || extractionStart < sdkState.workersOldest)) {
+                console.log(`Updating workersOldest from '${sdkState.workersOldest}' to '${extractionStart}'.`);
+                sdkState.workersOldest = extractionStart;
+            }
+            if (extractionEnd &&
+                (!sdkState.workersNewest || extractionEnd > sdkState.workersNewest)) {
+                console.log(`Updating workersNewest from '${sdkState.workersNewest}' to '${extractionEnd}'.`);
+                sdkState.workersNewest = extractionEnd;
+            }
+        }
+    }
+    buildEmitPayload(newEventType) {
+        const isExtractionEvent = Object.values(extraction_1.ExtractorEventType).includes(newEventType);
+        return isExtractionEvent ? { artifacts: this.artifacts } : {};
+    }
+    afterEmit() {
+        this.artifacts = [];
+    }
+    async uploadAllRepos() {
+        for (const repo of this.repos) {
+            const error = await repo.upload();
+            this.artifacts.push(...repo.uploadedArtifacts);
+            if (error) {
+                throw error;
+            }
+        }
+    }
+    async processAttachment(attachment, stream) {
+        return (0, logger_1.runWithSdkLogContext)(async () => {
+            var _a, _b, _c;
+            const { httpStream, delay, error } = await (0, logger_1.runWithUserLogContext)(async () => stream({
+                item: attachment,
+                event: this.event,
+            }));
+            if (error) {
+                return { error };
+            }
+            else if (delay) {
+                return { delay };
+            }
+            if (httpStream) {
+                const fileType = attachment.content_type ||
+                    ((_a = httpStream.headers['content-type']) === null || _a === void 0 ? void 0 : _a.toString()) ||
+                    'application/octet-stream';
+                const contentLength = (_b = httpStream.headers['content-length']) === null || _b === void 0 ? void 0 : _b.toString();
+                const fileSize = contentLength ? parseInt(contentLength) : undefined;
+                // Get upload URL
+                const { error: artifactUrlError, response: artifactUrlResponse } = await this.uploader.getArtifactUploadUrl(attachment.file_name, fileType, fileSize);
+                if (artifactUrlError) {
+                    this.destroyHttpStream(httpStream);
+                    return {
+                        error: {
+                            message: `Error while preparing artifact for attachment ID ${attachment.id}. Skipping attachment. ${(0, logger_1.serializeError)(artifactUrlError)}`,
+                            fileSize: fileSize,
+                        },
+                    };
+                }
+                // Stream attachment
+                const { error: uploadedArtifactError } = await this.uploader.streamArtifact(artifactUrlResponse, httpStream);
+                if (uploadedArtifactError) {
+                    this.destroyHttpStream(httpStream);
+                    return {
+                        error: {
+                            message: `Error while streaming to artifact for attachment ID ${attachment.id}. Skipping attachment. ` +
+                                (0, logger_1.serializeError)(uploadedArtifactError),
+                            fileSize: fileSize,
+                        },
+                    };
+                }
+                // Confirm attachment upload
+                const { error: confirmArtifactUploadError } = await this.uploader.confirmArtifactUpload(artifactUrlResponse.artifact_id);
+                if (confirmArtifactUploadError) {
+                    return {
+                        error: {
+                            message: `Error while confirming upload for attachment ID ${attachment.id}. ` +
+                                (0, logger_1.serializeError)(confirmArtifactUploadError),
+                            fileSize: fileSize,
+                        },
+                    };
+                }
+                const ssorAttachment = {
+                    id: {
+                        devrev: artifactUrlResponse.artifact_id,
+                        external: attachment.id,
+                    },
+                    parent_id: {
+                        external: attachment.parent_id,
+                    },
+                };
+                if (attachment.author_id) {
+                    ssorAttachment.actor_id = {
+                        external: attachment.author_id,
+                    };
+                }
+                // This will set inline flag in ssor_attachment only if it is explicity
+                // set in the attachment object.
+                if (attachment.inline === true) {
+                    ssorAttachment.inline = true;
+                }
+                else if (attachment.inline === false) {
+                    ssorAttachment.inline = false;
+                }
+                await ((_c = this.getRepo('ssor_attachment')) === null || _c === void 0 ? void 0 : _c.push([ssorAttachment]));
+                return;
+            }
+            return {
+                error: {
+                    message: `Error while opening attachment stream. Skipping attachment.`,
+                },
+            };
+        });
+    }
+    /**
+     * Destroys a stream to prevent memory leaks.
+     * @param httpStream - The axios response stream to destroy
+     */
+    destroyHttpStream(httpStream) {
+        try {
+            if (httpStream && httpStream.data) {
+                if (typeof httpStream.data.destroy === 'function') {
+                    httpStream.data.destroy();
+                }
+                else if (typeof httpStream.data.close === 'function') {
+                    httpStream.data.close();
+                }
+            }
+        }
+        catch (error) {
+            console.warn('Error while destroying HTTP stream:', error);
+        }
+    }
+    /**
+     * Streams the attachments to the DevRev platform.
+     * The attachments are streamed to the platform and the artifact information is returned.
+     * @param params - The parameters to stream the attachments
+     * @returns The response object containing the ssorAttachment artifact information
+     * or error information if there was an error
+     */
+    async streamAttachments({ stream, processors, batchSize = 1, // By default, we want to stream one attachment at a time
+     }) {
+        return (0, logger_1.runWithSdkLogContext)(async () => {
+            var _a, _b;
+            if (batchSize <= 0) {
+                console.warn(`The specified batch size (${batchSize}) is invalid. Using 1 instead.`);
+                batchSize = 1;
+            }
+            if (batchSize > 50) {
+                console.warn(`The specified batch size (${batchSize}) is too large. Using 50 instead.`);
+                batchSize = 50;
+            }
+            const repos = [
+                {
+                    itemType: 'ssor_attachment',
+                },
+            ];
+            this.initializeRepos(repos);
+            const attachmentsMetadata = (_a = this.sdkState.toDevRev) === null || _a === void 0 ? void 0 : _a.attachmentsMetadata;
+            // If there are no attachments metadata artifact IDs in state, finish here
+            if (!((_b = attachmentsMetadata === null || attachmentsMetadata === void 0 ? void 0 : attachmentsMetadata.artifactIds) === null || _b === void 0 ? void 0 : _b.length)) {
+                console.log(`No attachments metadata artifact IDs found in state.`);
+                return { status: 'success' };
+            }
+            else {
+                console.log(`Found ${attachmentsMetadata.artifactIds.length} attachments metadata artifact IDs in state.`);
+            }
+            // Loop through the attachments metadata artifact IDs
+            while (attachmentsMetadata.artifactIds.length > 0) {
+                const attachmentsMetadataArtifactId = attachmentsMetadata.artifactIds[0];
+                console.log(`Started processing attachments for attachments metadata artifact ID: ${attachmentsMetadataArtifactId}.`);
+                const { attachments, error } = await this.uploader.getAttachmentsFromArtifactId({
+                    artifact: attachmentsMetadataArtifactId,
+                });
+                if (error) {
+                    console.error(`Failed to get attachments for artifact ID: ${attachmentsMetadataArtifactId}.`);
+                    return { status: 'error', error };
+                }
+                if (!attachments || attachments.length === 0) {
+                    console.warn(`No attachments found for artifact ID: ${attachmentsMetadataArtifactId}.`);
+                    // Remove empty artifact and reset lastProcessed
+                    attachmentsMetadata.artifactIds.shift();
+                    attachmentsMetadata.lastProcessed = 0;
+                    continue;
+                }
+                console.log(`Found ${attachments.length} attachments for artifact ID: ${attachmentsMetadataArtifactId}.`);
+                let response;
+                if (processors) {
+                    console.log(`Using custom processors for attachments.`);
+                    const reducer = processors.reducer;
+                    const iterator = processors.iterator;
+                    const reducedAttachments = (0, logger_1.runWithUserLogContext)(() => reducer({
+                        attachments,
+                        adapter: this,
+                        batchSize,
+                    }));
+                    response = await (0, logger_1.runWithUserLogContext)(async () => {
+                        return await iterator({
+                            reducedAttachments,
+                            adapter: this,
+                            stream,
+                        });
+                    });
+                }
+                else {
+                    console.log(`Using attachments streaming pool for attachments streaming.`);
+                    const attachmentsPool = new attachments_streaming_pool_1.AttachmentsStreamingPool({
+                        adapter: this,
+                        attachments,
+                        batchSize,
+                        stream,
+                    });
+                    response = await attachmentsPool.streamAll();
+                }
+                if (response === null || response === void 0 ? void 0 : response.error) {
+                    return { status: 'error', error: response.error };
+                }
+                if (response === null || response === void 0 ? void 0 : response.delay) {
+                    return { status: 'delay', delaySeconds: response.delay };
+                }
+                // On timeout, return progress to allow continuation in a fresh invocation.
+                if (this.isTimeout) {
+                    console.log(`Timeout detected after processing attachments for artifact ID: ${attachmentsMetadataArtifactId}. Returning progress to allow continuation.`);
+                    return { status: 'progress' };
+                }
+                console.log(`Finished processing all attachments for artifact ID: ${attachmentsMetadataArtifactId}.`);
+                attachmentsMetadata.artifactIds.shift();
+                attachmentsMetadata.lastProcessed = 0;
+                if (attachmentsMetadata.lastProcessedAttachmentsIdsList) {
+                    attachmentsMetadata.lastProcessedAttachmentsIdsList.length = 0;
+                }
+            }
+            return { status: 'success' };
+        });
+    }
+}
+exports.ExtractionAdapter = ExtractionAdapter;

package/dist/multithreading/adapters/loading-adapter.d.ts

@@ -0,0 +1,44 @@
+import { Mappers } from '../../mappers/mappers';
+import { BaseState } from '../../state/state';
+import { AirSyncEvent, EventData, ExtractorEventType } from '../../types/extraction';
+import { ExternalSystemAttachment, ExternalSystemItem, ExternalSystemLoadingFunction, FileToLoad, ItemTypesToLoadParams, ItemTypeToLoad, LoaderEventType, LoaderReport, LoadItemResponse } from '../../types/loading';
+import { TaskResult, WorkerAdapterOptions } from '../../types/workers';
+import { BaseAdapter } from './base-adapter';
+/**
+ * LoadingAdapter is the adapter passed to loading tasks. It exposes the loading
+ * surface (item/attachment loading, mappers, loader reports).
+ *
+ * @public
+ */
+export declare class LoadingAdapter<ConnectorState> extends BaseAdapter<ConnectorState> {
+    private loaderReports;
+    private _processedFiles;
+    private _mappers;
+    constructor(params: {
+        event: AirSyncEvent;
+        adapterState: BaseState<ConnectorState>;
+        options?: WorkerAdapterOptions;
+    });
+    get reports(): LoaderReport[];
+    get processedFiles(): string[];
+    get mappers(): Mappers;
+    protected beforeEmit(): Promise<void>;
+    protected buildEmitPayload(newEventType: ExtractorEventType | LoaderEventType): EventData;
+    protected afterEmit(): void;
+    loadItemTypes({ itemTypesToLoad, }: ItemTypesToLoadParams): Promise<TaskResult>;
+    getLoaderBatches({ supportedItemTypes, }: {
+        supportedItemTypes: string[];
+    }): Promise<FileToLoad[]>;
+    loadAttachments({ create, }: {
+        create: ExternalSystemLoadingFunction<ExternalSystemAttachment>;
+    }): Promise<TaskResult>;
+    loadItem({ item, itemTypeToLoad, }: {
+        item: ExternalSystemItem;
+        itemTypeToLoad: ItemTypeToLoad;
+    }): Promise<LoadItemResponse>;
+    loadAttachment({ item, create, }: {
+        item: ExternalSystemAttachment;
+        create: ExternalSystemLoadingFunction<ExternalSystemAttachment>;
+    }): Promise<LoadItemResponse>;
+}
+//# sourceMappingURL=loading-adapter.d.ts.map

package/dist/multithreading/adapters/loading-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loading-adapter.d.ts","sourceRoot":"","sources":["../../../src/multithreading/adapters/loading-adapter.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EACL,YAAY,EACZ,SAAS,EAET,kBAAkB,EACnB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,wBAAwB,EACxB,kBAAkB,EAClB,6BAA6B,EAC7B,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,gBAAgB,EAEjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAM7C;;;;;GAKG;AACH,qBAAa,cAAc,CACzB,cAAc,CACd,SAAQ,WAAW,CAAC,cAAc,CAAC;IACnC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,eAAe,CAAW;IAClC,OAAO,CAAC,QAAQ,CAAU;gBAEd,MAAM,EAAE;QAClB,KAAK,EAAE,YAAY,CAAC;QACpB,YAAY,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;QACxC,OAAO,CAAC,EAAE,oBAAoB,CAAC;KAChC;IAUD,IAAI,OAAO,IAAI,YAAY,EAAE,CAE5B;IAED,IAAI,cAAc,IAAI,MAAM,EAAE,CAE7B;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;cAEe,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3C,SAAS,CAAC,gBAAgB,CACxB,YAAY,EAAE,kBAAkB,GAAG,eAAe,GACjD,SAAS;IAYZ,SAAS,CAAC,SAAS,IAAI,IAAI;IAIrB,aAAa,CAAC,EAClB,eAAe,GAChB,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;IAsHxC,gBAAgB,CAAC,EACrB,kBAAkB,GACnB,EAAE;QACD,kBAAkB,EAAE,MAAM,EAAE,CAAC;KAC9B;IA4BK,eAAe,CAAC,EACpB,MAAM,GACP,EAAE;QACD,MAAM,EAAE,6BAA6B,CAAC,wBAAwB,CAAC,CAAC;KACjE,GAAG,OAAO,CAAC,UAAU,CAAC;IA4FjB,QAAQ,CAAC,EACb,IAAI,EACJ,cAAc,GACf,EAAE;QACD,IAAI,EAAE,kBAAkB,CAAC;QACzB,cAAc,EAAE,cAAc,CAAC;KAChC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAsMvB,cAAc,CAAC,EACnB,IAAI,EACJ,MAAM,GACP,EAAE;QACD,IAAI,EAAE,wBAAwB,CAAC;QAC/B,MAAM,EAAE,6BAA6B,CAAC,wBAAwB,CAAC,CAAC;KACjE,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAsD9B"}

package/dist/multithreading/{worker-adapter/worker-adapter.helpers.d.ts → adapters/loading-adapter.helpers.d.ts}

@@ -19,4 +19,4 @@ export declare function addReportToLoaderReport({ loaderReports, report, }: {
     loaderReports: LoaderReport[];
     report: LoaderReport;
 }): LoaderReport[];
-//# sourceMappingURL=worker-adapter.helpers.d.ts.map
+//# sourceMappingURL=loading-adapter.helpers.d.ts.map

package/dist/multithreading/adapters/loading-adapter.helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loading-adapter.helpers.d.ts","sourceRoot":"","sources":["../../../src/multithreading/adapters/loading-adapter.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,YAAY,EACZ,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAE7B;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,EAC7B,kBAAkB,EAClB,SAAS,GACV,EAAE;IACD,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,SAAS,EAAE,eAAe,EAAE,CAAC;CAC9B,GAAG,UAAU,EAAE,CA8Bf;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,aAAa,EACb,MAAM,GACP,EAAE;IACD,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,MAAM,EAAE,YAAY,CAAC;CACtB,GAAG,YAAY,EAAE,CA4BjB"}