chore: added explicit json response parsing to catch an error

readme.md

@@ -12,7 +12,6 @@ This Source is capable of syncing the following Streams:
 * [Organization](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L7098)
 * [Teams](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L10249)
 * [User](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L11949)
-* [Milestone](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L4205)
 * [Project](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L7667)
 * [Integration Resource](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L2297)
 * [Attachment](https://github.com/linear/linear/blob/master/packages/sdk/src/schema.graphql#L144)

resources/schemas/project.json

@@ -52,9 +52,6 @@
     "organizationId": {
       "type": "string"
     },
-    "milestoneId": {
-      "type": ["null", "string"]
-    },
     "lastProjectUpdatePromptAt": {
       "type": ["null", "string"]
     },

src/client/LinearClient.ts

@@ -1,4 +1,5 @@
 import axios from "axios";
+import { AirbyteLogger } from "faros-airbyte-cdk/lib";
 import {
   Attachment,
   AuditEntry,
@@ -8,7 +9,6 @@ import {
   IssueHistory,
   IssueLabel,
   IssueRelation,
-  Milestone,
   Organization,
   Project,
   ProjectLink,
@@ -40,7 +40,6 @@ export type EntityType =
   | "teamkey"
   | "teammembership"
   | "user"
-  | "milestone"
   | "project"
   | "projectupdate"
   | "projectlink"
@@ -57,7 +56,10 @@ export type EntityType =
  * Thin client on top of the rest export api to fetch different resources.
  */
 export class LinearClient {
-  public constructor(private readonly config: Config) {}
+  public constructor(
+    private readonly config: Config,
+    private readonly logger: AirbyteLogger
+  ) {}
 
   /**
    * @returns List of all issues in organization.
@@ -94,13 +96,6 @@ export class LinearClient {
     return await this.fetchEntities<TeamMembership>("teammembership");
   }
 
-  /**
-   * @returns List of all milestones in organization.
-   */
-  public async milestones(): Promise<Milestone[]> {
-    return await this.fetchEntities<Milestone>("milestone");
-  }
-
   /**
    * @returns List of all projects in organization.
    */
@@ -209,6 +204,18 @@ export class LinearClient {
       method: "GET",
       baseURL: LINEAR_API_BASE_URL,
       url: entityType,
+      transformResponse: (data) => {
+        try {
+          return JSON.parse(data);
+        } catch (error) {
+          this.logger.error(
+            `Failed to parse data as JSON.
+            Data:${data},
+            Error: ${JSON.stringify(error, null, 2)}`
+          );
+          throw error;
+        }
+      },
       headers: {
         Authorization: this.config.apiKey,
       },

src/client/types.ts

@@ -160,16 +160,6 @@ export interface IssueLabel {
   creatorId?: null | string;
 }
 
-export interface Milestone {
-  id?: string;
-  createdAt?: string;
-  updatedAt?: string;
-  archivedAt?: null | string;
-  name?: string;
-  organizationId?: string;
-  sortOrder?: number;
-}
-
 export interface Project {
   id?: string;
   createdAt?: string;
@@ -186,7 +176,6 @@ export interface Project {
   leadId?: null | string;
   memberIds?: string[];
   organizationId?: string;
-  milestoneId?: string;
   lastProjectUpdatePromptAt?: null | string;
   startDate?: string;
   targetDate?: string;

src/index.ts

@@ -20,7 +20,6 @@ import { Document } from "./streams/document";
 import { IssueHistory } from "./streams/issueHistory";
 import { IssueLabel } from "./streams/issueLabel";
 import { IssueRelation } from "./streams/issueRelation";
-import { Milestone } from "./streams/milestone";
 import { Organization } from "./streams/organization";
 import { Project } from "./streams/project";
 import { ProjectLink } from "./streams/projectLink";
@@ -49,7 +48,7 @@ class LinearSource extends AirbyteSourceBase {
   public async checkConnection(
     config: AirbyteConfig
   ): Promise<[boolean, VError]> {
-    const client = new LinearClient({ apiKey: config.apiKey });
+    const client = new LinearClient({ apiKey: config.apiKey }, this.logger);
     try {
       await client.checkConnection();
       return [true, null];
@@ -59,15 +58,14 @@ class LinearSource extends AirbyteSourceBase {
   }
 
   public streams(config: AirbyteConfig): AirbyteStreamBase[] {
-    const client = new LinearClient({ apiKey: config.apiKey });
+    const client = new LinearClient({ apiKey: config.apiKey }, this.logger);
     return [
       new Issue(this.logger, client),
       new Organization(this.logger, client),
       new Team(this.logger, client),
       new TeamKey(this.logger, client),
       new TeamMembership(this.logger, client),
       new User(this.logger, client),
-      new Milestone(this.logger, client),
       new Project(this.logger, client),
       new ProjectUpdate(this.logger, client),
       new ProjectLink(this.logger, client),

test_files/full_configured_catalog.json

@@ -136,23 +136,6 @@
       "sync_mode": "full_refresh",
       "destination_sync_mode": "overwrite"
     },
-    {
-      "stream": {
-        "name": "milestone",
-        "json_schema": {},
-        "supported_sync_modes": [
-          "full_refresh"
-        ],
-        "source_defined_cursor": true,
-        "source_defined_primary_key": [
-          [
-            "id"
-          ]
-        ]
-      },
-      "sync_mode": "full_refresh",
-      "destination_sync_mode": "overwrite"
-    },
     {
       "stream": {
         "name": "project",