[ACTION] Google Sheets - Provide polling options as an alternative to current webhook based ones

Author: jcortes

components/google_sheets/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/google_sheets",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Pipedream Google_sheets Components",
   "main": "google_sheets.app.mjs",
   "keywords": [

components/google_sheets/sources/common/new-comment.mjs

@@ -0,0 +1,36 @@
+export default {
+  methods: {
+    _getLastTs() {
+      return this.db.get("lastTs");
+    },
+    _setLastTs(lastTs) {
+      this.db.set("lastTs", lastTs);
+    },
+    generateMeta(comment) {
+      return {
+        id: comment.id,
+        summary: `New Comment: ${comment.content}`,
+        ts: Date.parse(comment.createdTime),
+      };
+    },
+    getSheetId() {
+      return this.sheetID.toString();
+    },
+    async processSpreadsheet() {
+      const comments = [];
+      const lastTs = this._getLastTs();
+      const results = this.googleSheets.listComments(this.sheetID, lastTs);
+      for await (const comment of results) {
+        comments.push(comment);
+      }
+      if (!comments.length) {
+        return;
+      }
+      this._setLastTs(comments[0].createdTime);
+      comments.reverse().forEach((comment) => {
+        const meta = this.generateMeta(comment);
+        this.$emit(comment, meta);
+      });
+    },
+  },
+};

components/google_sheets/sources/new-comment-polling/new-comment-polling.mjs

@@ -0,0 +1,48 @@
+import googleSheets from "../../google_sheets.app.mjs";
+import common from "../common/new-comment.mjs";
+import base from "../common/http-based/base.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  key: "google_sheets-new-comment-polling",
+  name: "New Comment",
+  description: "Emit new event each time a comment is added to a spreadsheet.",
+  version: "0.0.1",
+  dedupe: "unique",
+  type: "source",
+  props: {
+    googleSheets,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      static: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    watchedDrive: {
+      propDefinition: [
+        googleSheets,
+        "watchedDrive",
+      ],
+      description: "Defaults to My Drive. To select a [Shared Drive](https://support.google.com/a/users/answer/9310351) instead, select it from this list.",
+    },
+    sheetID: {
+      propDefinition: [
+        googleSheets,
+        "sheetID",
+        (c) => ({
+          driveId: googleSheets.methods.getDriveId(c.watchedDrive),
+        }),
+      ],
+    },
+    ...common.props,
+  },
+  methods: {
+    ...base.methods,
+    ...common.methods,
+  },
+  async run() {
+    return this.processSpreadsheet();
+  },
+};

components/google_sheets/sources/new-comment-polling/test-event.mjs

@@ -0,0 +1,21 @@
+export default {
+  "id": "AAABM3vICvg",
+  "kind": "drive#comment",
+  "createdTime": "2024-05-08T21:32:04.823Z",
+  "modifiedTime": "2024-05-08T21:32:04.823Z",
+  "anchor": "{\"type\":\"workbook-range\",\"uid\":0,\"range\":\"1600938329\"}",
+  "replies": [],
+  "author": {
+    "displayName": "Test User",
+    "kind": "drive#user",
+    "me": true,
+    "photoLink": "//lh3.googleusercontent.com/a/ACg8ocKv3FxHiUdLT981ghC9w01W50yqe5fi2XWOSA4TgnZf8pCxmg=s50-c-k-no"
+  },
+  "deleted": false,
+  "htmlContent": "comment",
+  "content": "comment",
+  "quotedFileContent": {
+    "mimeType": "text/html",
+    "value": "1"
+  }
+}

components/google_sheets/sources/new-updates-polling/new-updates-polling.mjs

@@ -0,0 +1,54 @@
+import googleSheets from "../../google_sheets.app.mjs";
+import common from "../common/new-updates.mjs";
+import base from "../common/http-based/base.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  key: "google_sheets-new-updates-polling",
+  name: "New Updates",
+  description: "Emit new event each time a row or cell is updated in a spreadsheet.",
+  version: "0.0.1",
+  dedupe: "unique",
+  type: "source",
+  props: {
+    googleSheets,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      static: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    watchedDrive: {
+      propDefinition: [
+        googleSheets,
+        "watchedDrive",
+      ],
+      description: "Defaults to My Drive. To select a [Shared Drive](https://support.google.com/a/users/answer/9310351) instead, select it from this list.",
+    },
+    sheetID: {
+      propDefinition: [
+        googleSheets,
+        "sheetID",
+        (c) => ({
+          driveId: googleSheets.methods.getDriveId(c.watchedDrive),
+        }),
+      ],
+    },
+    ...common.props,
+  },
+  methods: {
+    ...base.methods,
+    ...common.methods,
+  },
+  hooks: {
+    async deploy() {
+      await this.takeSheetSnapshot();
+    },
+  },
+  async run() {
+    const spreadsheet = await this.googleSheets.getSpreadsheet(this.sheetID);
+    return this.processSpreadsheet(spreadsheet);
+  },
+};

components/google_sheets/sources/new-updates-polling/test-event.mjs

@@ -0,0 +1,71 @@
+export default {
+  "worksheet": {
+    "properties": {
+      "sheetId": 358595775,
+      "title": "Test",
+      "index": 0,
+      "sheetType": "GRID",
+      "gridProperties": {
+        "rowCount": 1029,
+        "columnCount": 50
+      }
+    }
+  },
+  "currentValues": {
+    "values": [
+      [
+        "1",
+        "Leo 1 Updated"
+      ],
+      [
+        "2",
+        "Leo 2"
+      ],
+      [
+        "3",
+        "Leo 3"
+      ],
+      [
+        "4",
+        "Updated"
+      ],
+      [
+        "5",
+        "Updated 0857"
+      ],
+      [
+        "6",
+        "Update 0858"
+      ]
+    ],
+    "range": "Test!A1:AX1029",
+    "majorDimension": "ROWS"
+  },
+  "changes": [
+    {
+      "cell": "B:4",
+      "previous_value": "",
+      "new_value": "Updated"
+    },
+    {
+      "cell": "A:5",
+      "previous_value": "",
+      "new_value": "5"
+    },
+    {
+      "cell": "B:5",
+      "previous_value": "",
+      "new_value": "Updated 0857"
+    },
+    {
+      "cell": "A:6",
+      "previous_value": "",
+      "new_value": "6"
+    },
+    {
+      "cell": "B:6",
+      "previous_value": "",
+      "new_value": "Update 0858"
+    }
+  ]
+}