@pipedream/linear_app 0.5.5 → 0.5.7

package/README.md

@@ -1,8 +1,11 @@
 # Overview
 
-With the Linear API, you can manage your workflow, track issues, and automate
-your development process. Here are some examples of what you can build:
+Linear helps streamline software project management, bug tracking, and task coordination. By using the Linear (API key) API with Pipedream, you can automate routine tasks, sync issues across platforms, and trigger custom workflows. Think auto-assignment of tasks based on specific triggers or pushing updates to a Slack channel when an issue's status changes. These automations save time and ensure that your development team stays focused on coding rather than on administrative overhead.
 
-- A custom workflow management tool
-- A tool to track issues and feature requests
-- A development process automation tool
+# Example Use Cases
+
+- **Sync Issues with Google Sheets**: Use Pipedream to monitor new issues in Linear and automatically add them to a Google Sheets spreadsheet. This can help with reporting, auditing, and providing a high-level overview of tasks without needing to access Linear directly.
+
+- **Automate Task Assignment Based on Labels**: When a new issue is created in Linear with a specific label (e.g., "urgent"), you can set up a Pipedream workflow to automatically assign it to a designated team member or escalate it by creating a high-priority notification in your team's messaging app, like Slack or Microsoft Teams.
+
+- **Create GitHub Issues from Linear Tasks**: For development teams using both Linear and GitHub, a workflow can be set up to create a new GitHub issue whenever a Linear task reaches a certain stage or is tagged for development. This ensures that your code repository is always in sync with your project management tool.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/linear_app",
-  "version": "0.5.5",
+  "version": "0.5.7",
   "description": "Pipedream Linear_app Components",
   "main": "linear_app.app.mjs",
   "keywords": [
@@ -15,6 +15,6 @@
   },
   "dependencies": {
     "@linear/sdk": "^13.0.0",
-    "@pipedream/platform": "^1.3.0"
+    "@pipedream/platform": "^3.0.3"
   }
 }

package/sources/comment-created-instant/comment-created-instant.mjs

@@ -5,9 +5,9 @@ export default {
   ...common,
   key: "linear_app-comment-created-instant",
   name: "New Created Comment (Instant)",
-  description: "Emit new event when a new comment is created. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
+  description: "Emit new event when a new comment is created. [See the documentation](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.1.5",
+  version: "0.1.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
@@ -50,6 +50,11 @@ export default {
         },
       };
     },
+    getResource(comment) {
+      return this.linearApp.getComment({
+        commentId: comment.id,
+      });
+    },
     getMetadata(resource) {
       const {
         delivery,

package/sources/common/webhook.mjs

@@ -1,6 +1,7 @@
 import linearApp from "../../linear_app.app.mjs";
 import constants from "../../common/constants.mjs";
 import utils from "../../common/utils.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
 
 export default {
   props: {
@@ -12,6 +13,7 @@ export default {
         linearApp,
         "teamId",
       ],
+      reloadProps: true,
     },
     projectId: {
       propDefinition: [
@@ -19,9 +21,30 @@ export default {
         "projectId",
       ],
     },
-    http: "$.interface.http",
     db: "$.service.db",
   },
+  async additionalProps() {
+    const props = {};
+    let msg;
+    if (await this.isAdmin()) {
+      msg = "Admin role detected. Trigger will be set up as a webhook.";
+      props.http = "$.interface.http";
+    } else {
+      msg = "No admin role detected. Trigger will set up to use polling.";
+      props.timer = {
+        type: "$.interface.timer",
+        default: {
+          intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+        },
+      };
+    }
+    props.alert = {
+      type: "alert",
+      alertType: "info",
+      content: `${msg} See the Linear [documentation](https://linear.app/docs/api-and-webhooks#webhooks) for details.`,
+    };
+    return props;
+  },
   methods: {
     setWebhookId(teamId, id) {
       this.db.set(`webhook-${teamId}`, id);
@@ -41,6 +64,9 @@ export default {
     useGraphQl() {
       return true;
     },
+    getResource() {
+      throw new Error("getResource is not implemented");
+    },
     getResourceTypes() {
       throw new Error("getResourceTypes is not implemented");
     },
@@ -59,11 +85,20 @@ export default {
     getLoadedProjectId() {
       throw new Error("Get loaded project ID not implemented");
     },
-  },
-  hooks: {
-    async deploy() {
-      // Retrieve historical events
-      console.log("Retrieving historical events...");
+    async isAdmin() {
+      const { data } = await this.linearApp.makeAxiosRequest({
+        method: "POST",
+        data: {
+          "query": `{ 
+            user(id: "me") {
+              admin
+            }
+          }`,
+        },
+      });
+      return data?.user?.admin;
+    },
+    async emitPolledResources() {
       const stream = this.linearApp.paginateResources({
         resourcesFn: this.getResourcesFn(),
         resourcesFnArgs: this.getResourcesFnArgs(),
@@ -77,73 +112,89 @@ export default {
           this.$emit(resource, this.getMetadata(resource));
         });
     },
+  },
+  hooks: {
+    async deploy() {
+      // Retrieve historical events
+      console.log("Retrieving historical events...");
+      await this.emitPolledResources();
+    },
     async activate() {
-      const args = {
-        resourceTypes: this.getResourceTypes(),
-        url: this.http.endpoint,
-        label: this.getWebhookLabel(),
-      };
-      if (!this.teamIds && !this.teamId) {
-        args.allPublicTeams = true;
-        const { _webhook: webhook } = await this.linearApp.createWebhook(args);
-        this.setWebhookId("1", webhook.id);
-        return;
-      }
-      const teamIds = this.teamIds || [
-        this.teamId,
-      ];
-      for (const teamId of teamIds) {
-        const { _webhook: webhook } =
-          await this.linearApp.createWebhook({
-            teamId,
-            ...args,
-          });
-        this.setWebhookId(teamId, webhook.id);
+      if (await this.isAdmin()) {
+        const args = {
+          resourceTypes: this.getResourceTypes(),
+          url: this.http.endpoint,
+          label: this.getWebhookLabel(),
+        };
+        if (!this.teamIds && !this.teamId) {
+          args.allPublicTeams = true;
+          const { _webhook: webhook } = await this.linearApp.createWebhook(args);
+          this.setWebhookId("1", webhook.id);
+          return;
+        }
+        const teamIds = this.teamIds || [
+          this.teamId,
+        ];
+        for (const teamId of teamIds) {
+          const { _webhook: webhook } =
+            await this.linearApp.createWebhook({
+              teamId,
+              ...args,
+            });
+          this.setWebhookId(teamId, webhook.id);
+        }
       }
     },
     async deactivate() {
-      if (!this.teamIds && !this.teamId) {
-        const webhookId = this.getWebhookId("1");
-        if (webhookId) {
-          await this.linearApp.deleteWebhook(webhookId);
+      if (await this.isAdmin()) {
+        if (!this.teamIds && !this.teamId) {
+          const webhookId = this.getWebhookId("1");
+          if (webhookId) {
+            await this.linearApp.deleteWebhook(webhookId);
+          }
+          return;
         }
-        return;
-      }
-      const teamIds = this.teamIds || [
-        this.teamId,
-      ];
-      for (const teamId of teamIds) {
-        const webhookId = this.getWebhookId(teamId);
-        if (webhookId) {
-          await this.linearApp.deleteWebhook(webhookId);
+        const teamIds = this.teamIds || [
+          this.teamId,
+        ];
+        for (const teamId of teamIds) {
+          const webhookId = this.getWebhookId(teamId);
+          if (webhookId) {
+            await this.linearApp.deleteWebhook(webhookId);
+          }
         }
       }
     },
   },
   async run(event) {
-    const {
-      client_ip: clientIp,
-      body,
-      headers,
-    } = event;
+    if (!(await this.isAdmin())) {
+      await this.emitPolledResources();
+    } else {
+      const {
+        client_ip: clientIp,
+        body,
+        headers,
+      } = event;
 
-    const { [constants.LINEAR_DELIVERY_HEADER]: delivery } = headers;
+      const { [constants.LINEAR_DELIVERY_HEADER]: delivery } = headers;
 
-    const resource = {
-      ...body,
-      delivery,
-    };
+      const resource = {
+        ...body,
+        delivery,
+      };
 
-    if (!this.isWebhookValid(clientIp)) {
-      console.log("Webhook is not valid");
-      return;
-    }
+      if (!this.isWebhookValid(clientIp)) {
+        console.log("Webhook is not valid");
+        return;
+      }
 
-    if (!(await this.isFromProject(body)) || !this.isRelevant(body)) {
-      return;
-    }
+      if (!(await this.isFromProject(body)) || !this.isRelevant(body)) {
+        return;
+      }
 
-    const meta = this.getMetadata(resource);
-    this.$emit(body, meta);
+      const meta = this.getMetadata(resource);
+      const item = await this.getResource(body.data);
+      this.$emit(item, meta);
+    }
   },
 };

package/sources/issue-created-instant/issue-created-instant.mjs

@@ -5,9 +5,9 @@ export default {
   ...common,
   key: "linear_app-issue-created-instant",
   name: "New Created Issue (Instant)",
-  description: "Emit new event when a new issue is created. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
+  description: "Emit new event when a new issue is created. [See the documentation](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.3.5",
+  version: "0.3.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
@@ -42,6 +42,11 @@ export default {
     isRelevant(body) {
       return body?.action === "create";
     },
+    getResource(issue) {
+      return this.linearApp.getIssue({
+        issueId: issue.id,
+      });
+    },
     getMetadata(resource) {
       const {
         delivery,

package/sources/issue-updated-instant/issue-updated-instant.mjs

@@ -5,9 +5,9 @@ export default {
   ...common,
   key: "linear_app-issue-updated-instant",
   name: "New Updated Issue (Instant)",
-  description: "Emit new event when an issue is updated. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
+  description: "Emit new event when an issue is updated. [See the documentation](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.3.5",
+  version: "0.3.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
@@ -39,17 +39,22 @@ export default {
         },
       };
     },
+    getResource(issue) {
+      return this.linearApp.getIssue({
+        issueId: issue.id,
+      });
+    },
     getMetadata(resource) {
       const {
-        delivery,
         title,
         data,
         updatedAt,
       } = resource;
+      const ts = Date.parse(data?.updatedAt || updatedAt);
       return {
-        id: delivery || resource.id,
+        id: `${resource.id}-${ts}`,
         summary: `Issue Updated: ${data?.title || title}`,
-        ts: Date.parse(updatedAt),
+        ts,
       };
     },
   },

package/sources/new-issue-status-updated/new-issue-status-updated.mjs

@@ -1,18 +1,18 @@
 import common from "../common/webhook.mjs";
 import constants from "../../common/constants.mjs";
+import utils from "../../common/utils.mjs";
 
 export default {
   ...common,
   key: "linear_app-new-issue-status-updated",
   name: "New Issue Status Updated (Instant)",
-  description: "Emit new event when the status of an issue is updated. See the docs [here](https://developers.linear.app/docs/graphql/webhooks)",
+  description: "Emit new event when the status of an issue is updated. [See the documentation](https://developers.linear.app/docs/graphql/webhooks)",
   type: "source",
-  version: "0.1.5",
+  version: "0.1.7",
   dedupe: "unique",
   props: {
     linearApp: common.props.linearApp,
-    http: common.props.http,
-    db: common.props.db,
+    db: "$.service.db",
     teamId: {
       label: "Team ID",
       type: "string",
@@ -20,7 +20,7 @@ export default {
         common.props.linearApp,
         "teamId",
       ],
-      optional: true,
+      reloadProps: true,
     },
     projectId: {
       propDefinition: [
@@ -41,6 +41,12 @@ export default {
   },
   methods: {
     ...common.methods,
+    _getPreviousStatuses() {
+      return this.db.get("previousStatuses") || {};
+    },
+    _setPreviousStatuses(previousStatuses) {
+      this.db.set("previousStatuses", previousStatuses);
+    },
     getResourceTypes() {
       return [
         constants.RESOURCE_TYPE.ISSUE,
@@ -79,6 +85,11 @@ export default {
     isRelevant(body) {
       return body?.updatedFrom?.stateId && (!this.stateId || body.data.stateId === this.stateId);
     },
+    getResource(issue) {
+      return this.linearApp.getIssue({
+        issueId: issue.id,
+      });
+    },
     getMetadata(resource) {
       const {
         delivery,
@@ -86,11 +97,43 @@ export default {
         data,
         updatedAt,
       } = resource;
+      const ts = Date.parse(updatedAt);
       return {
-        id: delivery || resource.id,
+        id: delivery || `${resource.id}-${ts}`,
         summary: `Issue status updated: ${data?.title || title}`,
-        ts: Date.parse(updatedAt),
+        ts,
       };
     },
+    async emitPolledResources() {
+      const previousStatuses = this._getPreviousStatuses();
+      const newStatuses = {};
+
+      const stream = this.linearApp.paginateResources({
+        resourcesFn: this.getResourcesFn(),
+        resourcesFnArgs: this.getResourcesFnArgs(),
+        useGraphQl: this.useGraphQl(),
+        max: 1000,
+      });
+      const resources = await utils.streamIterator(stream);
+
+      const updatedResources = [];
+      for (const issue of resources) {
+        newStatuses[issue.id] = issue.state.id;
+        if (issue.createdAt === issue.updatedAt) {
+          continue;
+        }
+        if (previousStatuses[issue.id] !== issue.state.id) {
+          updatedResources.push(issue);
+        }
+      }
+
+      this._setPreviousStatuses(newStatuses);
+
+      updatedResources
+        .reverse()
+        .forEach((resource) => {
+          this.$emit(resource, this.getMetadata(resource));
+        });
+    },
   },
 };