@pipedream/google_drive 0.3.2 → 0.4.1

package/google_drive.app.js

@@ -1,212 +0,0 @@
-const axios = require("axios");
-const { google } = require("googleapis");
-
-const GOOGLE_DRIVE_UPDATE_TYPES = [
-  "add",
-  "sync",
-  "remove",
-  "update",
-  "trash",
-  "untrash",
-  "change",
-];
-
-module.exports = {
-  type: "app",
-  app: "google_drive",
-  propDefinitions: {
-    watchedDrive: {
-      type: "string",
-      label: "Drive",
-      description: "The drive you want to watch for changes",
-      async options({ page, prevContext }) {
-        const { nextPageToken } = prevContext;
-        return await this.listDrives(nextPageToken);
-      },
-    },
-    updateTypes: {
-      type: "string[]",
-      label: "Types of updates",
-      description:
-        "The types of updates you want to watch for on these files. [See Google's docs](https://developers.google.com/drive/api/v3/push#understanding-drive-api-notification-events).",
-      // https://developers.google.com/drive/api/v3/push#understanding-drive-api-notification-events
-      default: GOOGLE_DRIVE_UPDATE_TYPES,
-      options: GOOGLE_DRIVE_UPDATE_TYPES,
-    },
-    watchForPropertiesChanges: {
-      type: "boolean",
-      label: "Watch for changes to file properties",
-      description:
-        "Watch for changes to [file properties](https://developers.google.com/drive/api/v3/properties) in addition to changes to content. **Defaults to `false`, watching for only changes to content**.",
-      optional: true,
-      default: false,
-    },
-  },
-  methods: {
-    // Returns a drive object authenticated with the user's access token
-    drive() {
-      const auth = new google.auth.OAuth2();
-      auth.setCredentials({ access_token: this.$auth.oauth_access_token });
-      return google.drive({ version: "v3", auth });
-    },
-    // Google's push notifications provide a URL to the resource that changed,
-    // which we can use to fetch the file's metadata. So we use axios here
-    // (vs. the Node client) to get that.
-    async getFileMetadata(url) {
-      return (
-        await axios({
-          method: "GET",
-          headers: {
-            Authorization: `Bearer ${this.$auth.oauth_access_token}`,
-          },
-          url,
-        })
-      ).data;
-    },
-    async getChanges(pageToken, driveId) {
-      const drive = this.drive();
-      // As with many of the methods for Google Drive, we must
-      // pass a request of a different shape when we're requesting
-      // changes for My Drive (null driveId) vs. a shared drive
-      let changeRequest;
-      if (driveId) {
-        changeRequest = {
-          driveId,
-          pageToken,
-          includeItemsFromAllDrives: true,
-          supportsAllDrives: true,
-        };
-      } else {
-        changeRequest = {
-          pageToken,
-        };
-      }
-      const { changes, newStartPageToken } = (
-        await drive.changes.list(changeRequest)
-      ).data;
-
-      // Some changes do not include an associated file object. Return only those that do
-      const changedFiles = changes
-        .map((change) => change.file)
-        .filter((f) => typeof f === "object");
-
-      return {
-        changedFiles,
-        newStartPageToken,
-      };
-    },
-    async getPageToken() {
-      const drive = this.drive();
-      return (await drive.changes.getStartPageToken({})).data.startPageToken;
-    },
-    async listDrives(pageToken) {
-      const drive = this.drive();
-      const resp = await drive.drives.list({ pageToken });
-      const { drives, nextPageToken } = resp.data;
-      // "My Drive" isn't returned from the list of drives,
-      // so we add it to the list and assign it a static
-      // ID that we can refer to when we need.
-      const options = [{ label: "My Drive", value: "myDrive" }];
-      for (const d of drives) {
-        options.push({ label: d.name, value: d.id });
-      }
-      return {
-        options,
-        context: { nextPageToken },
-      };
-    },
-    async listFiles(opts) {
-      const drive = this.drive();
-      // Listing files in My Drive and a shared drive requires
-      // mutually-exclusive options, so we accept an object of
-      // opts from the caller and pass them to the list method.
-      const resp = await drive.files.list(opts);
-      const { files, nextPageToken } = resp.data;
-      const options = files.map((file) => {
-        return { label: file.name, value: file.id };
-      });
-      return {
-        options,
-        context: { nextPageToken },
-      };
-    },
-    _makeWatchRequestBody(id, address) {
-      return {
-        id, // the component-specific channel ID, a UUID
-        type: "web_hook",
-        address, // the component-specific HTTP endpoint
-      };
-    },
-    async watchDrive(id, address, pageToken, driveId) {
-      const drive = this.drive();
-      const requestBody = this._makeWatchRequestBody(id, address);
-
-      // Google expects an entirely different object to be passed
-      // when you make a watch request for My Drive vs. a shared drive
-      // "My Drive" doesn't have a driveId, so if this method is called
-      // without a driveId, we make a watch request for My Drive
-      let watchRequest;
-      if (driveId) {
-        watchRequest = {
-          driveId,
-          pageToken,
-          requestBody,
-          includeItemsFromAllDrives: true,
-          supportsAllDrives: true,
-        };
-      } else {
-        watchRequest = {
-          pageToken,
-          requestBody,
-        };
-      }
-      // When watching for changes to an entire account, we must pass a pageToken,
-      // which points to the moment in time we want to start watching for changes:
-      // https://developers.google.com/drive/api/v3/manage-changes
-      const { expiration, resourceId } = (
-        await drive.changes.watch(watchRequest)
-      ).data;
-      console.log(`Watch request for drive successful, expiry: ${expiration}`);
-      return {
-        expiration: parseInt(expiration),
-        resourceId,
-      };
-    },
-    async watchFile(id, address, fileId) {
-      const drive = this.drive();
-      const requestBody = this._makeWatchRequestBody(id, address);
-      const { expiration, resourceId } = (
-        await drive.files.watch({
-          fileId,
-          requestBody,
-          supportsAllDrives: true,
-        })
-      ).data;
-      console.log(
-        `Watch request for file ${fileId} successful, expiry: ${expiration}`
-      );
-      return {
-        expiration: parseInt(expiration),
-        resourceId,
-      };
-    },
-    async stopNotifications(id, resourceId) {
-      // id = channelID
-      // See https://github.com/googleapis/google-api-nodejs-client/issues/627
-      const drive = this.drive();
-
-      // If for some reason the channel doesn't exist, this throws an error
-      // It's OK for this to fail in those cases, since we'll renew the channel
-      // immediately after trying to stop it if we still want notifications,
-      // so we squash the error, log it, and move on.
-      try {
-        await drive.channels.stop({ resource: { id, resourceId } });
-        console.log(`Stopped push notifications on channel ${id}`);
-      } catch (err) {
-        console.error(
-          `Failed to stop channel ${id} for resource ${resourceId}: ${err}`
-        );
-      }
-    },
-  },
-};

package/sources/changes-to-specific-files/changes-to-specific-files.js

@@ -1,226 +0,0 @@
-// This source processes changes to specific files in a user's Google Drive,
-// implementing strategy enumerated in the Push Notifications API docs:
-// https://developers.google.com/drive/api/v3/push .
-//
-// This source has two interfaces:
-//
-// 1) The HTTP requests tied to changes in the user's Google Drive
-// 2) A timer that runs on regular intervals, renewing the notification channel as needed
-
-const { uuid } = require("uuidv4");
-const includes = require("lodash.includes");
-const googleDrive = require("../../google_drive.app.js");
-
-module.exports = {
-  key: "google_drive-changes-to-specific-files",
-  name: "Changes to Specific Files",
-  description:
-    "Watches for changes to specific files, emitting an event any time a change is made to one of those files",
-  version: "0.0.6",
-  // Dedupe events based on the "x-goog-message-number" header for the target channel:
-  // https://developers.google.com/drive/api/v3/push#making-watch-requests
-  dedupe: "unique",
-  props: {
-    googleDrive,
-    db: "$.service.db",
-    http: "$.interface.http",
-    drive: { propDefinition: [googleDrive, "watchedDrive"] },
-    files: {
-      type: "string[]",
-      label: "Files",
-      description: "The files you want to watch for changes.",
-      optional: true,
-      async options({ page, prevContext }) {
-        const { nextPageToken } = prevContext;
-        if (!this.drive) return [];
-        if (this.drive === "myDrive") {
-          return await this.googleDrive.listFiles({ pageToken: nextPageToken });
-        }
-
-        return await this.googleDrive.listFiles({
-          pageToken: nextPageToken,
-          corpora: "drive",
-          driveId: this.drive,
-          includeItemsFromAllDrives: true,
-          supportsAllDrives: true,
-        });
-      },
-    },
-    updateTypes: { propDefinition: [googleDrive, "updateTypes"] },
-    watchForPropertiesChanges: {
-      propDefinition: [googleDrive, "watchForPropertiesChanges"],
-    },
-    timer: {
-      label: "Push notification renewal schedule",
-      description:
-        "The Google Drive API requires occasional renewal of push notification subscriptions. **This runs in the background, so you should not need to modify this schedule**.",
-      type: "$.interface.timer",
-      default: {
-        intervalSeconds: 60 * 60 * 24,
-      },
-    },
-  },
-  hooks: {
-    async activate() {
-      // Called when a componenent is created or updated. Handles all the logic
-      // for starting and stopping watch notifications tied to the desired files.
-
-      // You can pass the same channel ID in watch requests for multiple files, so
-      // our channel ID is fixed for this component to simplify the state we have to
-      // keep track of.
-      const channelID = this.db.get("channelID") || uuid();
-
-      // Subscriptions are keyed on Google's resourceID, "an opaque value that
-      // identifies the watched resource". This value is included in request
-      // headers, allowing us to look up the watched resource.
-      let subscriptions = this.db.get("subscriptions") || {};
-
-      for (const fileID of this.files) {
-        const { expiration, resourceId } = await this.googleDrive.watchFile(
-          channelID,
-          this.http.endpoint,
-          fileID
-        );
-        // The fileID must be kept with the subscription metadata so we can
-        // renew the watch request for this specific file when it expires.
-        subscriptions[resourceId] = { expiration, fileID };
-      }
-
-      // Save metadata on the subscription so we can stop / renew later
-      this.db.set("subscriptions", subscriptions);
-      this.db.set("channelID", channelID);
-    },
-    async deactivate() {
-      const channelID = this.db.get("channelID");
-      if (!channelID) {
-        console.log(
-          "Channel not found, cannot stop notifications for non-existent channel"
-        );
-        return;
-      }
-
-      const subscriptions = this.db.get("subscriptions") || {};
-      for (const resourceId of Object.keys(subscriptions)) {
-        await this.googleDrive.stopNotifications(channelID, resourceId);
-      }
-
-      // Reset DB state
-      this.db.set("subscriptions", {});
-      this.db.set("channelID", null);
-    },
-  },
-  async run(event) {
-    // This function is polymorphic: it can be triggered as a cron job, to make sure we renew
-    // watch requests for specific files, or via HTTP request (the change payloads from Google)
-
-    let subscriptions = this.db.get("subscriptions") || {};
-    const channelID = this.db.get("channelID");
-
-    // Component was invoked by timer
-    if (event.interval_seconds) {
-      for (const [currentResourceId, metadata] of Object.entries(
-        subscriptions
-      )) {
-        const { fileID } = metadata;
-        // If the subscription for this resource will expire before the next run,
-        // stop the existing subscription and renew
-        if (metadata.expiration < +new Date() + event.interval_seconds * 1000) {
-          console.log(
-            `Notifications for resource ${currentResourceId} are expiring at ${metadata.expiration}. Renewing`
-          );
-          await this.googleDrive.stopNotifications(
-            channelID,
-            currentResourceId
-          );
-          const { expiration, resourceId } = await this.googleDrive.watchFile(
-            channelID,
-            this.http.endpoint,
-            fileID
-          );
-          subscriptions[resourceId] = { expiration, fileID };
-        }
-      }
-
-      this.db.set("subscriptions", subscriptions);
-      return;
-    }
-
-    const { headers } = event;
-
-    if (headers["x-goog-resource-state"] === "sync") {
-      console.log("Sync notification, exiting early");
-      return;
-    }
-
-    if (
-      !headers["x-goog-resource-state"] ||
-      !headers["x-goog-resource-id"] ||
-      !headers["x-goog-resource-uri"] ||
-      !headers["x-goog-message-number"]
-    ) {
-      console.log("Request missing necessary headers: ", headers);
-      return;
-    }
-
-    const incomingChannelID = headers["x-goog-channel-id"];
-    if (incomingChannelID !== channelID) {
-      console.log(
-        `Channel ID of ${incomingChannelID} not equal to deployed component channel of ${channelID}`
-      );
-    }
-
-    if (!(headers["x-goog-resource-id"] in subscriptions)) {
-      console.log(
-        `Resource ID of ${resourceId} not currently being tracked. Exiting`
-      );
-      return;
-    }
-
-    if (!includes(this.updateTypes, headers["x-goog-resource-state"])) {
-      console.log(
-        `Update type ${headers["x-goog-resource-state"]} not in list of updates to watch: `,
-        this.updateTypes
-      );
-      return;
-    }
-
-    // We observed false positives where a single change to a document would trigger two changes:
-    // one to "properties" and another to "content,properties". But changes to properties
-    // alone are legitimate, most users just won't want this source to emit in those cases.
-    // If x-goog-changed is _only_ set to "properties", only move on if the user set the prop
-    if (
-      !this.watchForPropertiesChanges &&
-      headers["x-goog-changed"] === "properties"
-    ) {
-      console.log(
-        "Change to properties only, which this component is set to ignore. Exiting"
-      );
-      return;
-    }
-
-    const file = await this.googleDrive.getFileMetadata(
-      headers["x-goog-resource-uri"]
-    );
-
-    if (!file || !Object.keys(file).length) {
-      console.log("No file metadata returned, nothing to emit");
-      return;
-    }
-
-    const eventToEmit = {
-      file,
-      change: {
-        state: headers["x-goog-resource-state"],
-        resourceURI: headers["x-goog-resource-uri"],
-        changed: headers["x-goog-changed"], // "Additional details about the changes. Possible values: content, parents, children, permissions"
-      },
-    };
-
-    this.$emit(eventToEmit, {
-      summary: `${headers["x-goog-resource-state"].toUpperCase()} - ${
-        file.name || "Untitled"
-      }`,
-      id: headers["x-goog-message-number"],
-    });
-  },
-};

package/sources/new-or-modified-files/new-or-modified-files.js

@@ -1,213 +0,0 @@
-// This source processes changes to any files in a user's Google Drive,
-// implementing strategy enumerated in the Push Notifications API docs:
-// https://developers.google.com/drive/api/v3/push and here:
-// https://developers.google.com/drive/api/v3/manage-changes
-//
-// This source has two interfaces:
-//
-// 1) The HTTP requests tied to changes in the user's Google Drive
-// 2) A timer that runs on regular intervals, renewing the notification channel as needed
-
-const { uuid } = require("uuidv4");
-const includes = require("lodash.includes");
-const googleDrive = require("../../google_drive.app.js");
-
-module.exports = {
-  key: "google_drive-new-or-modified-files",
-  name: "New or Modified Files",
-  description:
-    "Emits a new event any time any file in your linked Google Drive is added, modified, or deleted",
-  version: "0.0.6",
-  // Dedupe events based on the "x-goog-message-number" header for the target channel:
-  // https://developers.google.com/drive/api/v3/push#making-watch-requests
-  dedupe: "unique",
-  props: {
-    googleDrive,
-    db: "$.service.db",
-    http: "$.interface.http",
-    drive: { propDefinition: [googleDrive, "watchedDrive"] },
-    updateTypes: { propDefinition: [googleDrive, "updateTypes"] },
-    watchForPropertiesChanges: {
-      propDefinition: [googleDrive, "watchForPropertiesChanges"],
-    },
-    timer: {
-      label: "Push notification renewal schedule",
-      description:
-        "The Google Drive API requires occasional renewal of push notification subscriptions. **This runs in the background, so you should not need to modify this schedule**.",
-      type: "$.interface.timer",
-      default: {
-        intervalSeconds: 60 * 60 * 24,
-      },
-    },
-  },
-  hooks: {
-    async activate() {
-      // Called when a component is created or updated. Handles all the logic
-      // for starting and stopping watch notifications tied to the desired files.
-
-      const channelID = this.db.get("channelID") || uuid();
-
-      const startPageToken = await this.googleDrive.getPageToken();
-      const { expiration, resourceId } = await this.googleDrive.watchDrive(
-        channelID,
-        this.http.endpoint,
-        startPageToken,
-        this.drive === "myDrive" ? null : this.drive
-      );
-      // We use and increment the pageToken as new changes arrive, in run()
-      this.db.set("pageToken", startPageToken);
-
-      // Save metadata on the subscription so we can stop / renew later
-      // Subscriptions are tied to Google's resourceID, "an opaque value that
-      // identifies the watched resource". This value is included in request headers
-      this.db.set("subscription", { resourceId, expiration });
-      this.db.set("channelID", channelID);
-    },
-    async deactivate() {
-      const channelID = this.db.get("channelID");
-      const { resourceId } = this.db.get("subscription");
-
-      // Reset DB state before anything else
-      this.db.set("subscription", null);
-      this.db.set("channelID", null);
-      this.db.set("pageToken", null);
-
-      if (!channelID) {
-        console.log(
-          "Channel not found, cannot stop notifications for non-existent channel"
-        );
-        return;
-      }
-
-      if (!resourceId) {
-        console.log(
-          "No resource ID found, cannot stop notifications for non-existent resource"
-        );
-        return;
-      }
-
-      await this.googleDrive.stopNotifications(channelID, resourceId);
-    },
-  },
-  async run(event) {
-    // This function is polymorphic: it can be triggered as a cron job, to make sure we renew
-    // watch requests for specific files, or via HTTP request (the change payloads from Google)
-
-    let subscription = this.db.get("subscription");
-    const channelID = this.db.get("channelID");
-    const pageToken = this.db.get("pageToken");
-
-    // Component was invoked by timer
-    if (event.interval_seconds) {
-      if (!subscription || !subscription.resourceId) {
-        return;
-      }
-      console.log(
-        `Checking for resubscription on resource ${subscription.resourceId}`
-      );
-      // If the subscription for this resource will expire before the next run,
-      // stop the existing subscription and renew. Expiration is in ms.
-      if (
-        subscription.expiration <
-        +new Date() + event.interval_seconds * 1000
-      ) {
-        console.log(
-          `Notifications for resource ${subscription.resourceId} are expiring at ${subscription.expiration}. Renewing`
-        );
-        await this.googleDrive.stopNotifications(
-          channelID,
-          subscription.resourceId
-        );
-        const { expiration, resourceId } = await this.googleDrive.watchDrive(
-          channelID,
-          this.http.endpoint,
-          pageToken,
-          this.drive === "myDrive" ? null : this.drive
-        );
-        this.db.set("subscription", { expiration, resourceId });
-      }
-      return;
-    }
-
-    const { headers } = event;
-
-    if (headers["x-goog-resource-state"] === "sync") {
-      console.log("Sync notification, exiting early");
-      return;
-    }
-
-    if (
-      !headers["x-goog-resource-state"] ||
-      !headers["x-goog-resource-id"] ||
-      !headers["x-goog-resource-uri"] ||
-      !headers["x-goog-message-number"]
-    ) {
-      console.log("Request missing necessary headers: ", headers);
-      return;
-    }
-
-    const incomingChannelID = headers["x-goog-channel-id"];
-    if (incomingChannelID !== channelID) {
-      console.log(
-        `Channel ID of ${incomingChannelID} not equal to deployed component channel of ${channelID}`
-      );
-      return;
-    }
-
-    if (headers["x-goog-resource-id"] !== subscription.resourceId) {
-      console.log(
-        `Resource ID of ${resourceId} not currently being tracked. Exiting`
-      );
-      return;
-    }
-
-    if (!includes(this.updateTypes, headers["x-goog-resource-state"])) {
-      console.log(
-        `Update type ${headers["x-goog-resource-state"]} not in list of updates to watch: `,
-        this.updateTypes
-      );
-      return;
-    }
-
-    // We observed false positives where a single change to a document would trigger two changes:
-    // one to "properties" and another to "content,properties". But changes to properties
-    // alone are legitimate, most users just won't want this source to emit in those cases.
-    // If x-goog-changed is _only_ set to "properties", only move on if the user set the prop
-    if (
-      !this.watchForPropertiesChanges &&
-      headers["x-goog-changed"] === "properties"
-    ) {
-      console.log(
-        "Change to properties only, which this component is set to ignore. Exiting"
-      );
-      return;
-    }
-
-    const {
-      changedFiles,
-      newStartPageToken,
-    } = await this.googleDrive.getChanges(
-      pageToken,
-      this.drive === "myDrive" ? null : this.drive
-    );
-
-    this.db.set("pageToken", newStartPageToken);
-
-    for (const file of changedFiles) {
-      console.log(file);
-      const eventToEmit = {
-        file,
-        change: {
-          state: headers["x-goog-resource-state"],
-          resourceURI: headers["x-goog-resource-uri"],
-          changed: headers["x-goog-changed"], // "Additional details about the changes. Possible values: content, parents, children, permissions"
-        },
-      };
-
-      this.$emit(eventToEmit, {
-        summary: file.name,
-        id: headers["x-goog-message-number"],
-      });
-    }
-  },
-};