Add Asana converters for Faros Destination (#116)

* asana begin

* identity file error

* add asana destination

* FAI-441 - Implement Phabricator check connection + streams (#105)

* Cache repostories in Phabricator streams (#106)

* Add Jenkins converters (#95)

* FAI-441 - Added revisions & users streams to Phabricator source + bump version (#113)

* FA-441 - Added projects stream to Phabricator + cleanup (#114)

* add tests; fix story creator; update task stream

* remove github comment

* don't create user on tasks and stories

* fix wroting records quantity

* add tags; save TMS TaskBords on Task

* use null to undefined values; rename interfaces

* Fix Jenkins converter's url (#115)

* update jenkins url; remove lodash

* not update job's url

Co-authored-by: Matthew Tovbin <tovbinm@users.noreply.github.com>

Author: Roma-Kyrnis

destinations/faros-destination/src/converters/asana/common.ts

@@ -0,0 +1,82 @@
+import {AirbyteRecord} from 'faros-airbyte-cdk/src/protocol';
+
+import {Converter, DestinationRecord} from '../converter';
+
+export interface AsanaProject {
+  gid: string;
+}
+
+export interface AsanaSection {
+  gid: string;
+  name: string;
+  project?: AsanaProject;
+}
+
+export interface AsanaUser {
+  gid: string;
+  name?: string;
+  email?: string;
+}
+
+interface TmsTaskType {
+  category: TmsTaskCategory;
+  detail: string;
+}
+
+enum TmsTaskCategory {
+  Bug = 'Bug',
+  Custom = 'Custom',
+  Story = 'Story',
+  Task = 'Task',
+}
+
+/** Common functions shares across Asana converters */
+export class AsanaCommon {
+  // Max length for free-form description text fields such as issue body
+  static readonly MAX_DESCRIPTION_LENGTH = 1000;
+
+  static toTmsTaskType(type: string): TmsTaskType {
+    const detail = type.toLowerCase();
+    switch (detail) {
+      case 'bug':
+        return {category: TmsTaskCategory.Bug, detail};
+      case 'story':
+        return {category: TmsTaskCategory.Story, detail};
+      case 'task':
+        return {category: TmsTaskCategory.Task, detail};
+      default:
+        return {category: TmsTaskCategory.Custom, detail};
+    }
+  }
+
+  static tms_User(user: AsanaUser, source: string): DestinationRecord {
+    return {
+      model: 'tms_User',
+      record: {
+        uid: user.gid,
+        name: user.name || null,
+        emailAddress: user.email || null,
+        source,
+      },
+    };
+  }
+
+  static tms_TaskBoard(section: AsanaSection, source: string): DestinationRecord {
+    return {
+      model: 'tms_TaskBoard',
+      record: {
+        uid: section.gid,
+        name: section.name,
+        source,
+      },
+    };
+  }
+}
+
+/** Asana converter base */
+export abstract class AsanaConverter extends Converter {
+  /** All Asana records should have id property */
+  id(record: AirbyteRecord): any {
+    return record?.record?.data?.gid;
+  }
+}

destinations/faros-destination/src/converters/asana/projects.ts

@@ -0,0 +1,34 @@
+import {AirbyteRecord} from 'faros-airbyte-cdk';
+import {Utils} from 'faros-feeds-sdk'
+
+import {DestinationModel, DestinationRecord, StreamContext} from '../converter';
+import {AsanaCommon, AsanaConverter} from './common';
+
+export class AsanaProjects extends AsanaConverter {
+  readonly destinationModels: ReadonlyArray<DestinationModel> = ['tms_Project'];
+
+  convert(
+    record: AirbyteRecord,
+    ctx: StreamContext
+  ): ReadonlyArray<DestinationRecord> {
+    const source = this.streamName.source;
+    const project = record.record.data;
+    
+    const tmsProject: DestinationRecord = {
+      model: 'tms_Project',
+      record: {
+        uid: project.gid, 
+        name: project.name,
+        description: project.notes?.substring(
+          0,
+          AsanaCommon.MAX_DESCRIPTION_LENGTH
+        ),
+        createdAt: Utils.toDate(project.created_at),
+        updatedAt: Utils.toDate(project.modified_at),
+        source,
+      }
+    }
+
+    return [tmsProject];
+  }
+}

destinations/faros-destination/src/converters/asana/sections.ts

@@ -0,0 +1,31 @@
+import {AirbyteRecord} from 'faros-airbyte-cdk';
+
+import {DestinationModel, DestinationRecord, StreamContext} from '../converter';
+import {AsanaCommon, AsanaConverter, AsanaSection} from './common';
+
+export class AsanaSections extends AsanaConverter {
+  readonly destinationModels: ReadonlyArray<DestinationModel> = [
+    'tms_TaskBoard',
+    'tms_TaskBoardProjectRelationship',
+  ];
+
+  convert(
+    record: AirbyteRecord,
+    ctx: StreamContext
+  ): ReadonlyArray<DestinationRecord> {
+    const res: DestinationRecord[] = [];
+    const source = this.streamName.source;
+    const section = record.record.data as AsanaSection;
+
+    res.push(AsanaCommon.tms_TaskBoard(section, source));
+    res.push({
+      model: 'tms_TaskBoardProjectRelationship',
+      record: {
+        board: {uid: section.gid, source},
+        project: section.project ? {uid: section.project.gid, source} : null,
+      },
+    });
+
+    return res;
+  }
+}

destinations/faros-destination/src/converters/asana/stories.ts

@@ -0,0 +1,39 @@
+import {AirbyteRecord} from 'faros-airbyte-cdk';
+import {Utils} from 'faros-feeds-sdk';
+
+import {DestinationModel, DestinationRecord, StreamContext} from '../converter';
+import {AsanaCommon, AsanaConverter} from './common';
+
+export class AsanaStories extends AsanaConverter {
+  readonly destinationModels: ReadonlyArray<DestinationModel> = [
+    'tms_Task',
+  ];
+
+  convert(
+    record: AirbyteRecord,
+    ctx: StreamContext
+  ): ReadonlyArray<DestinationRecord> {
+    const res: DestinationRecord[] = [];
+    const source = this.streamName.source;
+    const story = record.record.data;
+
+    res.push({
+      model: 'tms_Task',
+      record: {
+        uid: story.gid,
+        name: story.source || null,
+        description: story.text?.substring(
+          0,
+          AsanaCommon.MAX_DESCRIPTION_LENGTH
+        ),
+        type: AsanaCommon.toTmsTaskType(story.resource_type),
+        createdAt: Utils.toDate(story.created_at),
+        updatedAt: Utils.toDate(story.created_at),
+        creator: {uid: story.created_by.gid, source},
+        source,
+      },
+    });
+
+    return res;
+  }
+}

destinations/faros-destination/src/converters/asana/tags.ts

@@ -0,0 +1,24 @@
+import {AirbyteRecord} from 'faros-airbyte-cdk';
+
+import {DestinationModel, DestinationRecord, StreamContext} from '../converter';
+import {AsanaConverter} from './common';
+
+export class AsanaTags extends AsanaConverter {
+  readonly destinationModels: ReadonlyArray<DestinationModel> = ['tms_Label'];
+
+  convert(
+    record: AirbyteRecord,
+    ctx: StreamContext
+  ): ReadonlyArray<DestinationRecord> {
+    const tag = record.record.data;
+
+    return [
+      {
+        model: 'tms_Label',
+        record: {
+          name: tag.name,
+        },
+      },
+    ];
+  }
+}