airbyte-faros-destination 0.1.53

package/lib/converters/phabricator/common.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhabricatorConverter = exports.PhabricatorCommon = void 0;
+const faros_feeds_sdk_1 = require("faros-feeds-sdk");
+const lodash_1 = require("lodash");
+const converter_1 = require("../converter");
+/** Common functions shares across Phabricator converters */
+class PhabricatorCommon {
+    static vcs_UserType(user) {
+        var _a, _b;
+        if ((0, lodash_1.toLower)(user.type) === 'user') {
+            const roles = Array.isArray((_a = user === null || user === void 0 ? void 0 : user.fields) === null || _a === void 0 ? void 0 : _a.roles)
+                ? (_b = user === null || user === void 0 ? void 0 : user.fields) === null || _b === void 0 ? void 0 : _b.roles
+                : [];
+            if (roles.includes('bot')) {
+                return { category: 'Bot', detail: 'bot' };
+            }
+            if (roles.includes('list')) {
+                return { category: 'Custom', detail: 'list' };
+            }
+            return { category: 'User', detail: 'user' };
+        }
+        return { category: 'Custom', detail: 'unknown' };
+    }
+    static vcs_PullRequestState(revisionStatus) {
+        const detail = (0, lodash_1.toLower)(revisionStatus === null || revisionStatus === void 0 ? void 0 : revisionStatus.value);
+        if (!detail)
+            return { category: 'Custom', detail: 'unknown' };
+        switch (detail) {
+            case 'abandoned':
+                return { category: 'Closed', detail };
+            case 'published':
+                return { category: 'Merged', detail };
+            case 'needs-review':
+            case 'needs-revision':
+            case 'changes-planned':
+            case 'accepted':
+            case 'draft':
+                return { category: 'Open', detail };
+            default:
+                return { category: 'Custom', detail };
+        }
+    }
+    static vcs_PullRequestReviewState(reviewStatus) {
+        const detail = (0, lodash_1.toLower)(reviewStatus);
+        if (!detail)
+            return { category: 'Custom', detail: 'unknown' };
+        switch (detail) {
+            case 'rejected':
+                return { category: 'ChangesRequested', detail };
+            case 'accepted':
+                return { category: 'Approved', detail };
+            default:
+                return { category: 'Custom', detail };
+        }
+    }
+    static parseCommitMessage(message) {
+        if (!message)
+            return undefined;
+        const parts = message.split('\n\n');
+        const revision = parts.find((p) => p.startsWith('Differential Revision:'));
+        const revisionIdStr = revision
+            ? revision.split('/D').reverse()[0].trim()
+            : undefined;
+        const revisionId = faros_feeds_sdk_1.Utils.parseIntegerWithDefault(revisionIdStr, -1);
+        return {
+            message: parts.length > 0 ? parts[0] : undefined,
+            revisionId: revisionId >= 0 ? revisionId : undefined,
+        };
+    }
+    static repositoryURIs(repository) {
+        var _a, _b;
+        const uris = (_b = (_a = repository === null || repository === void 0 ? void 0 : repository.attachments) === null || _a === void 0 ? void 0 : _a.uris) === null || _b === void 0 ? void 0 : _b.uris;
+        if (!uris || !Array.isArray(uris))
+            return [];
+        return uris;
+    }
+    static repositoryKey(repository, source) {
+        var _a;
+        const repoName = (_a = repository === null || repository === void 0 ? void 0 : repository.fields) === null || _a === void 0 ? void 0 : _a.shortName;
+        if (!repoName)
+            return undefined;
+        return {
+            name: (0, lodash_1.toLower)(repoName),
+            organization: PhabricatorCommon.orgKey(source),
+        };
+    }
+    static orgKey(source) {
+        // Since Phabricator does not have a concept of organization,
+        // we are simply using the source name instead
+        return { uid: source, source };
+    }
+}
+exports.PhabricatorCommon = PhabricatorCommon;
+/** Phabricator converter base */
+class PhabricatorConverter extends converter_1.Converter {
+    constructor() {
+        super(...arguments);
+        this.source = 'Phabricator';
+    }
+    /** Most of Phabricator records should have phid property */
+    id(record) {
+        var _a, _b;
+        return (_b = (_a = record === null || record === void 0 ? void 0 : record.record) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.phid;
+    }
+}
+exports.PhabricatorConverter = PhabricatorConverter;

package/lib/converters/phabricator/repositories.d.ts

@@ -0,0 +1,7 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { PhabricatorConverter } from './common';
+export declare class Repositories extends PhabricatorConverter {
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+}

package/lib/converters/phabricator/repositories.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Repositories = void 0;
+const faros_feeds_sdk_1 = require("faros-feeds-sdk");
+const common_1 = require("./common");
+class Repositories extends common_1.PhabricatorConverter {
+    constructor() {
+        super(...arguments);
+        this.destinationModels = [
+            'vcs_Repository',
+            'vcs_Organization',
+        ];
+    }
+    async convert(record, ctx) {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const source = this.streamName.source;
+        const repo = record.record.data;
+        const res = [];
+        const repository = common_1.PhabricatorCommon.repositoryKey(repo, source);
+        if (!repository)
+            return res;
+        const uris = common_1.PhabricatorCommon.repositoryURIs(repo);
+        // Since there is no separate stream of organizations, we are writing
+        // an organization with each repository.
+        res.push({
+            model: 'vcs_Organization',
+            record: {
+                uid: repository.organization.uid,
+                name: repository.organization.uid,
+                type: 'Organization',
+                source,
+            },
+        });
+        res.push({
+            model: 'vcs_Repository',
+            record: {
+                ...repository,
+                fullName: (_a = repo.fields) === null || _a === void 0 ? void 0 : _a.name,
+                private: true,
+                description: (_c = (_b = repo.fields) === null || _b === void 0 ? void 0 : _b.description) === null || _c === void 0 ? void 0 : _c.raw,
+                language: null,
+                size: null,
+                mainBranch: (_d = repo.fields) === null || _d === void 0 ? void 0 : _d.defaultBranch,
+                htmlUrl: uris.length > 0 ? (_f = (_e = uris[0].fields) === null || _e === void 0 ? void 0 : _e.uri) === null || _f === void 0 ? void 0 : _f.effective : null,
+                createdAt: ((_g = repo.fields) === null || _g === void 0 ? void 0 : _g.dateCreated)
+                    ? faros_feeds_sdk_1.Utils.toDate(repo.fields.dateCreated * 1000)
+                    : null,
+                updatedAt: ((_h = repo.fields) === null || _h === void 0 ? void 0 : _h.dateModified)
+                    ? faros_feeds_sdk_1.Utils.toDate(repo.fields.dateModified * 1000)
+                    : null,
+            },
+        });
+        return res;
+    }
+}
+exports.Repositories = Repositories;

package/lib/converters/phabricator/revisions.d.ts

@@ -0,0 +1,7 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { PhabricatorConverter } from './common';
+export declare class Revisions extends PhabricatorConverter {
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+}

package/lib/converters/phabricator/revisions.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Revisions = void 0;
+const faros_feeds_sdk_1 = require("faros-feeds-sdk");
+const common_1 = require("./common");
+class Revisions extends common_1.PhabricatorConverter {
+    constructor() {
+        super(...arguments);
+        this.destinationModels = [
+            'vcs_PullRequest',
+            'vcs_PullRequestReview',
+        ];
+    }
+    async convert(record, ctx) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        const source = this.streamName.source;
+        const revision = record.record.data;
+        const res = [];
+        const repository = common_1.PhabricatorCommon.repositoryKey(revision.repository, source);
+        if (!repository)
+            return res;
+        const state = common_1.PhabricatorCommon.vcs_PullRequestState((_a = revision.fields) === null || _a === void 0 ? void 0 : _a.status);
+        const createdAt = ((_b = revision.fields) === null || _b === void 0 ? void 0 : _b.dateCreated)
+            ? faros_feeds_sdk_1.Utils.toDate(((_c = revision.fields) === null || _c === void 0 ? void 0 : _c.dateCreated) * 1000)
+            : null;
+        const updatedAt = ((_d = revision.fields) === null || _d === void 0 ? void 0 : _d.dateModified)
+            ? faros_feeds_sdk_1.Utils.toDate(((_e = revision.fields) === null || _e === void 0 ? void 0 : _e.dateModified) * 1000)
+            : null;
+        // TODO: figure out how to get the actual mergedAt timestamp for each revision
+        const mergedAt = state.category === 'Merged' ? updatedAt : null;
+        const author = ((_f = revision.fields) === null || _f === void 0 ? void 0 : _f.authorPHID)
+            ? { uid: (_g = revision.fields) === null || _g === void 0 ? void 0 : _g.authorPHID, source }
+            : null;
+        res.push({
+            // We are explicitly passing __Upsert command here with at := 0,
+            // to allow updating PR merge commit from commits stream
+            // in the same revision
+            model: 'vcs_PullRequest__Upsert',
+            record: {
+                at: 0,
+                data: {
+                    number: revision.id,
+                    uid: revision.id.toString(),
+                    title: (_h = revision.fields) === null || _h === void 0 ? void 0 : _h.title,
+                    state,
+                    htmlUrl: (_j = revision.fields) === null || _j === void 0 ? void 0 : _j.uri,
+                    createdAt,
+                    updatedAt,
+                    mergedAt,
+                    author,
+                    repository,
+                    mergeCommit: null, // merge commit is set from commits stream
+                },
+            },
+        });
+        const reviewers = Array.isArray((_l = (_k = revision.attachments) === null || _k === void 0 ? void 0 : _k.reviewers) === null || _l === void 0 ? void 0 : _l.reviewers)
+            ? (_o = (_m = revision.attachments) === null || _m === void 0 ? void 0 : _m.reviewers) === null || _o === void 0 ? void 0 : _o.reviewers
+            : [];
+        const pullRequest = {
+            repository,
+            number: revision.id,
+            uid: revision.id.toString(),
+        };
+        let reviewId = 0;
+        for (const reviewer of reviewers) {
+            res.push({
+                model: 'vcs_PullRequestReview',
+                record: {
+                    number: reviewId,
+                    uid: reviewId.toString(),
+                    pullRequest,
+                    reviewer: { uid: reviewer.reviewerPHID, source },
+                    state: common_1.PhabricatorCommon.vcs_PullRequestReviewState(reviewer === null || reviewer === void 0 ? void 0 : reviewer.status),
+                    // TODO: figure out how to get the actual submittedAt timestamp for each revision
+                    submittedAt: updatedAt,
+                },
+            });
+            reviewId++;
+        }
+        return res;
+    }
+}
+exports.Revisions = Revisions;

package/lib/converters/phabricator/users.d.ts

@@ -0,0 +1,7 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { PhabricatorConverter } from './common';
+export declare class Users extends PhabricatorConverter {
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+}

package/lib/converters/phabricator/users.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = void 0;
+const common_1 = require("./common");
+class Users extends common_1.PhabricatorConverter {
+    constructor() {
+        super(...arguments);
+        this.destinationModels = [
+            'vcs_Membership',
+            'vcs_User',
+        ];
+    }
+    async convert(record, ctx) {
+        var _a, _b, _c, _d;
+        const source = this.streamName.source;
+        const user = record.record.data;
+        const res = [];
+        const uid = user.phid;
+        res.push({
+            model: 'vcs_User',
+            record: {
+                uid,
+                name: (_d = (_b = (_a = user.fields) === null || _a === void 0 ? void 0 : _a.username) !== null && _b !== void 0 ? _b : (_c = user.fields) === null || _c === void 0 ? void 0 : _c.realName) !== null && _d !== void 0 ? _d : null,
+                htmlUrl: null,
+                type: common_1.PhabricatorCommon.vcs_UserType(user),
+                source,
+            },
+        });
+        res.push({
+            model: 'vcs_Membership',
+            record: {
+                user: { uid, source },
+                organization: common_1.PhabricatorCommon.orgKey(source),
+            },
+        });
+        return res;
+    }
+}
+exports.Users = Users;

package/lib/converters/shortcut/common.d.ts

@@ -0,0 +1,16 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { Converter } from '../converter';
+import { Iteration, Story, StoryType, TaskType } from './models';
+export declare class ShortcutCommon {
+    static readonly MAX_DESCRIPTION_LENGTH = 1000;
+    static getEpicStatus(status: string): string;
+    static getSprintState(iteration: Iteration): string;
+    static getTaskType(storyType: StoryType): TaskType;
+    static getTaskStatus(story: Story): string;
+}
+/** Shortcut converter base */
+export declare abstract class ShortcutConverter extends Converter {
+    source: string;
+    /** Almost every Shortcut record have id property */
+    id(record: AirbyteRecord): any;
+}

package/lib/converters/shortcut/common.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShortcutConverter = exports.ShortcutCommon = void 0;
+const converter_1 = require("../converter");
+const models_1 = require("./models");
+class ShortcutCommon {
+    static getEpicStatus(status) {
+        switch (status) {
+            case 'done':
+                return models_1.EpicStatusCategory.Done;
+            case 'in progress':
+                return models_1.EpicStatusCategory.InProgress;
+            default:
+                return models_1.EpicStatusCategory.Todo;
+        }
+    }
+    static getSprintState(iteration) {
+        switch (iteration.status) {
+            case 'done':
+                return models_1.SprintState.Closed;
+            case 'started':
+                return models_1.SprintState.Active;
+            case 'unstarted':
+                return models_1.SprintState.Future;
+            default:
+                return models_1.SprintState.Default;
+        }
+    }
+    static getTaskType(storyType) {
+        const detail = storyType;
+        switch (storyType) {
+            case 'bug':
+                return { category: models_1.TaskCategory.Bug, detail };
+            case 'chore':
+            case 'feature':
+                return { category: models_1.TaskCategory.Story, detail };
+            default:
+                return { category: models_1.TaskCategory.Custom, detail };
+        }
+    }
+    static getTaskStatus(story) {
+        if (story.completed) {
+            return models_1.TaskStatusCategory.Done;
+        }
+        else if (story.started) {
+            return models_1.TaskStatusCategory.InProgress;
+        }
+        else {
+            return models_1.TaskStatusCategory.Todo;
+        }
+    }
+}
+exports.ShortcutCommon = ShortcutCommon;
+// Max length for free-form description text fields such as issue body
+ShortcutCommon.MAX_DESCRIPTION_LENGTH = 1000;
+/** Shortcut converter base */
+class ShortcutConverter extends converter_1.Converter {
+    constructor() {
+        super(...arguments);
+        this.source = 'Shortcut';
+    }
+    /** Almost every Shortcut record have id property */
+    id(record) {
+        var _a, _b;
+        return (_b = (_a = record === null || record === void 0 ? void 0 : record.record) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.id;
+    }
+}
+exports.ShortcutConverter = ShortcutConverter;

package/lib/converters/shortcut/epics.d.ts

@@ -0,0 +1,7 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { ShortcutConverter } from './common';
+export declare class Epics extends ShortcutConverter {
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+}

package/lib/converters/shortcut/epics.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Epics = void 0;
+const common_1 = require("./common");
+class Epics extends common_1.ShortcutConverter {
+    constructor() {
+        super(...arguments);
+        this.destinationModels = ['tms_Epic'];
+    }
+    async convert(record, ctx) {
+        const source = this.streamName.source;
+        const epic = record.record.data;
+        return [
+            {
+                model: 'tms_Epic',
+                record: {
+                    uid: String(epic.id),
+                    name: epic.name,
+                    description: epic.description,
+                    status: {
+                        category: common_1.ShortcutCommon.getEpicStatus(epic.state),
+                    },
+                    source,
+                },
+            },
+        ];
+    }
+}
+exports.Epics = Epics;

package/lib/converters/shortcut/iterations.d.ts

@@ -0,0 +1,7 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { ShortcutConverter } from './common';
+export declare class Iterations extends ShortcutConverter {
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+}

package/lib/converters/shortcut/iterations.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Iterations = void 0;
+const faros_feeds_sdk_1 = require("faros-feeds-sdk");
+const common_1 = require("./common");
+class Iterations extends common_1.ShortcutConverter {
+    constructor() {
+        super(...arguments);
+        this.destinationModels = ['tms_Sprint'];
+    }
+    async convert(record, ctx) {
+        const source = this.streamName.source;
+        const iteration = record.record.data;
+        return [
+            {
+                model: 'tms_Sprint',
+                record: {
+                    uid: String(iteration.id),
+                    name: iteration.name,
+                    state: common_1.ShortcutCommon.getSprintState(iteration),
+                    startedAt: faros_feeds_sdk_1.Utils.toDate(iteration.start_date),
+                    endedAt: faros_feeds_sdk_1.Utils.toDate(iteration.end_date),
+                    source,
+                },
+            },
+        ];
+    }
+}
+exports.Iterations = Iterations;

package/lib/converters/shortcut/members.d.ts

@@ -0,0 +1,7 @@
+import { AirbyteRecord } from 'faros-airbyte-cdk';
+import { DestinationModel, DestinationRecord, StreamContext } from '../converter';
+import { ShortcutConverter } from './common';
+export declare class Members extends ShortcutConverter {
+    readonly destinationModels: ReadonlyArray<DestinationModel>;
+    convert(record: AirbyteRecord, ctx: StreamContext): Promise<ReadonlyArray<DestinationRecord>>;
+}

package/lib/converters/shortcut/members.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Members = void 0;
+const common_1 = require("./common");
+class Members extends common_1.ShortcutConverter {
+    constructor() {
+        super(...arguments);
+        this.destinationModels = ['tms_User'];
+    }
+    async convert(record, ctx) {
+        const source = this.streamName.source;
+        const user = record.record.data;
+        return [
+            {
+                model: 'tms_User',
+                record: {
+                    uid: String(user.id),
+                    name: user.profile.name,
+                    emailAddress: user.profile.email_address,
+                    source,
+                },
+            },
+        ];
+    }
+}
+exports.Members = Members;