@pipedream/linear_app 0.5.6 → 0.5.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/linear_app",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "description": "Pipedream Linear_app Components",
   "main": "linear_app.app.mjs",
   "keywords": [

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.6",
+  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,7 +1,7 @@
 import linearApp from "../../linear_app.app.mjs";
 import constants from "../../common/constants.mjs";
 import utils from "../../common/utils.mjs";
-import { ConfigurationError } from "@pipedream/platform";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
 
 export default {
   props: {
@@ -21,18 +21,28 @@ export default {
         "projectId",
       ],
     },
-    http: "$.interface.http",
     db: "$.service.db",
   },
   async additionalProps() {
     const props = {};
-    if (!(await this.isAdmin())) {
-      props.alert = {
-        type: "alert",
-        alertType: "error",
-        content: "You must have an admin role to create or manage webhooks. See the Linear [documentation](https://linear.app/docs/api-and-webhooks#webhooks) for details.",
+    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: {
@@ -54,6 +64,9 @@ export default {
     useGraphQl() {
       return true;
     },
+    getResource() {
+      throw new Error("getResource is not implemented");
+    },
     getResourceTypes() {
       throw new Error("getResourceTypes is not implemented");
     },
@@ -85,15 +98,7 @@ export default {
       });
       return data?.user?.admin;
     },
-  },
-  hooks: {
-    async deploy() {
-      if (!(await this.isAdmin())) {
-        throw new ConfigurationError("You must have an admin role to create or manage webhooks. See the Linear [documentation](https://linear.app/docs/api-and-webhooks#webhooks) for details.");
-      }
-
-      // Retrieve historical events
-      console.log("Retrieving historical events...");
+    async emitPolledResources() {
       const stream = this.linearApp.paginateResources({
         resourcesFn: this.getResourcesFn(),
         resourcesFnArgs: this.getResourcesFnArgs(),
@@ -107,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.6",
+  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.6",
+  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.6",
+  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));
+        });
+    },
   },
 };