@pipedream/google_calendar 0.3.3 → 0.3.4

package/sources/new-calendar/new-calendar.mjs

@@ -0,0 +1,68 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-new-calendar",
+  name: "New Calendar",
+  description: "Emit an event when a calendar is created.",
+  version: "0.1.1",
+  type: "source",
+  props: {
+    db: "$.service.db",
+    googleCalendar,
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: 15 * 60,
+      },
+    },
+  },
+  hooks: {
+    async activate() {
+      // get list of calendars
+      const { items: calendars = [] } = await this.googleCalendar.listCalendars();
+      this.emitNewCalendars(calendars);
+      const calendarIds = calendars.map((item) => item.id);
+      this.setCalendarIds(calendarIds);
+    },
+    deactivate() {
+      this.setCalendarIds([]);
+    },
+  },
+  methods: {
+    setCalendarIds(calendarIds) {
+      this.db.set("calendarIds", calendarIds);
+    },
+    getCalendarIds() {
+      return this.db.get("calendarIds") || [];
+    },
+    generateMeta(calendar) {
+      const {
+        summary,
+        id,
+      } = calendar;
+      return {
+        summary,
+        id,
+        ts: Date.now(),
+      };
+    },
+    emitNewCalendars(calendars) {
+      const previousCalendarIds = this.getCalendarIds();
+
+      for (const calendar of calendars) {
+        if (!previousCalendarIds.includes(calendar.id)) {
+          const meta = this.generateMeta(calendar);
+          this.$emit(calendar, meta);
+        }
+      }
+    },
+  },
+  async run() {
+    const { items: calendars = [] } = await this.googleCalendar.listCalendars();
+
+    this.emitNewCalendars(calendars);
+
+    const calendarIds = calendars.map((item) => item.id);
+    this.setCalendarIds(calendarIds);
+  },
+};

package/sources/new-event/new-event.mjs

@@ -0,0 +1,27 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "google_calendar-new-event",
+  name: "New Event",
+  description: "Emits when an event is created",
+  version: "0.1.1",
+  type: "source",
+  dedupe: "unique", // Dedupe events based on the Google Calendar event ID
+  methods: {
+    ...common.methods,
+    getConfig({ past }) {
+      const updatedMin = past.toISOString();
+      return {
+        calendarId: this.calendarId,
+        updatedMin,
+        singleEvents: true,
+        orderBy: "startTime",
+      };
+    },
+    isRelevant(event, { past }) {
+      const created = new Date(event.created);
+      return created > past && event.status !== "cancelled";
+    },
+  },
+};

package/sources/new-event-search/new-event-search.mjs

@@ -0,0 +1,38 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "google_calendar-new-event-search",
+  name: "Event Search",
+  description: "Emit when an event is created that matches a search",
+  version: "0.1.1",
+  type: "source",
+  dedupe: "unique", // Dedupe events based on the Google Calendar event ID
+  props: {
+    ...common.props,
+    q: {
+      propDefinition: [
+        common.props.googleCalendar,
+        "q",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getConfig({ past }) {
+      const updatedMin = past.toISOString();
+      return {
+        calendarId: this.calendarId,
+        updatedMin,
+        q: this.q,
+        singleEvents: true,
+        orderBy: "startTime",
+      };
+    },
+    isRelevant(event, { past }) {
+      const created = new Date(event.created);
+      // created in last 5 mins and not cancelled
+      return created > past && event.status !== "cancelled";
+    },
+  },
+};

package/sources/new-or-updated-event/new-or-updated-event.mjs

@@ -0,0 +1,39 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "google_calendar-new-or-updated-event",
+  name: "New or Updated Event",
+  description: "Emits when an event is created or updated (except when it's cancelled)",
+  version: "0.1.1",
+  type: "source",
+  dedupe: "unique", // Dedupe events based on the Google Calendar event ID
+  methods: {
+    ...common.methods,
+    getConfig({ past }) {
+      const updatedMin = past.toISOString();
+      return {
+        calendarId: this.calendarId,
+        updatedMin,
+        singleEvents: true,
+        orderBy: "startTime",
+      };
+    },
+    isRelevant(event) {
+      return event.status !== "cancelled";
+    },
+    generateMeta(event) {
+      const {
+        id,
+        summary,
+        updated: tsString,
+      } = event;
+      const ts = Date.parse(tsString);
+      return {
+        id: `${id}-${ts}`,
+        summary,
+        ts,
+      };
+    },
+  },
+};

package/sources/new-or-updated-event-instant/new-or-updated-event-instant.mjs

@@ -0,0 +1,289 @@
+import { v4 as uuid } from "uuid";
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-new-or-updated-event-instant",
+  type: "source",
+  name: "New or Updated Event (Instant)",
+  description: "Emit new calendar events when an event is created or updated (does not emit cancelled events)",
+  version: "0.1.4",
+  dedupe: "unique",
+  props: {
+    googleCalendar,
+    db: "$.service.db",
+    calendarIds: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+      type: "string[]",
+      label: "Calendars",
+      description: "Select one or more calendars to watch",
+    },
+    newOnly: {
+      label: "New events only?",
+      type: "boolean",
+      description: "Emit new events only, and not updates to existing events",
+      optional: true,
+      default: false,
+    },
+    http: "$.interface.http",
+    timer: {
+      label: "Push notification renewal schedule",
+      description: "The Google Calendar 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",
+      static: {
+        intervalSeconds: 60 * 60 * 23,
+      },
+    },
+  },
+  hooks: {
+    async deploy() {
+      const events = [];
+      const params = {
+        maxResults: 25,
+        orderBy: "updated",
+      };
+      for (const calendarId of this.calendarIds) {
+        params.calendarId = calendarId;
+        const { items } = await this.googleCalendar.listEvents(params);
+        events.push(...items);
+      }
+      events.sort((a, b) => (Date.parse(a.updated) > Date.parse(b.updated))
+        ? 1
+        : -1);
+      for (const event of events.slice(-25)) {
+        const meta = this.generateMeta(event);
+        this.$emit(event, meta);
+      }
+    },
+    async activate() {
+      await this.makeWatchRequest();
+    },
+    async deactivate() {
+      await this.stopWatchRequest();
+    },
+  },
+  methods: {
+    setNextSyncToken(calendarId, nextSyncToken) {
+      this.db.set(`${calendarId}.nextSyncToken`, nextSyncToken);
+    },
+    getNextSyncToken(calendarId) {
+      return this.db.get(`${calendarId}.nextSyncToken`);
+    },
+    setChannelId(calendarId, channelId) {
+      this.db.set(`${calendarId}.channelId`, channelId);
+    },
+    getChannelId(calendarId) {
+      return this.db.get(`${calendarId}.channelId`);
+    },
+    setResourceId(calendarId, resourceId) {
+      this.db.set(`${calendarId}.resourceId`, resourceId);
+    },
+    getResourceId(calendarId) {
+      return this.db.get(`${calendarId}.resourceId`);
+    },
+    setExpiration(calendarId, expiration) {
+      this.db.set(`${calendarId}.expiration`, expiration);
+    },
+    getExpiration(calendarId) {
+      return this.db.get(`${calendarId}.expiration`);
+    },
+    /**
+     * A utility method to compute whether the provided event is newly created
+     * or not. Since the Google Calendar API does not provide a specific way to
+     * determine this, this method estimates the result based on the `created`
+     * and `updated` timestamps: if they are more than 2 seconds apart, then we
+     * assume that the event is not new.
+     *
+     * @param {Object} event - The calendar event being processed
+     * @returns {Boolean} True if the input event is a newly created event, or
+     * false otherwise
+     */
+    _isNewEvent(event) {
+      const {
+        created,
+        updated,
+      } = event;
+      const createdTimestampMilliseconds = Date.parse(created);
+      const updatedTimestampMilliseconds = Date.parse(updated);
+      const diffMilliseconds = Math.abs(
+        updatedTimestampMilliseconds - createdTimestampMilliseconds,
+      );
+      const maxDiffMilliseconds = 2000;
+      return diffMilliseconds <= maxDiffMilliseconds;
+    },
+    /**
+     * A utility method to compute whether the provided event is relevant to the
+     * event source (and as a consequence must be processed) or not.
+     *
+     * @param {Object} event - The calendar event being processed
+     * @returns {Boolean} True if the input event must be processed, or false
+     * otherwise (i.e. if the event must be skipped)
+     */
+    isEventRelevant(event) {
+      return !this.newOnly || this._isNewEvent(event);
+    },
+    generateMeta(event) {
+      const {
+        id,
+        summary,
+        updated: tsString,
+      } = event;
+      const ts = Date.parse(tsString);
+      return {
+        id: `${id}-${ts}`,
+        summary,
+        ts,
+      };
+    },
+    async makeWatchRequest() {
+      // Make watch request for this HTTP endpoint
+      for (const calendarId of this.calendarIds) {
+        const watchResp =
+          await this.googleCalendar.watchEvents({
+            calendarId,
+            requestBody: {
+              id: uuid(),
+              type: "web_hook",
+              address: this.http.endpoint,
+            },
+          });
+
+        // Initial full sync. Get next sync token
+        const nextSyncToken = await this.googleCalendar.fullSync(calendarId);
+
+        this.setNextSyncToken(calendarId, nextSyncToken);
+        this.setChannelId(calendarId, watchResp.id);
+        this.setResourceId(calendarId, watchResp.resourceId);
+        this.setExpiration(calendarId, watchResp.expiration);
+      }
+    },
+    async stopWatchRequest() {
+      for (const calendarId of this.calendarIds) {
+        const id = this.getChannelId(calendarId);
+        const resourceId = this.getResourceId(calendarId);
+        if (id && resourceId) {
+          const { status } =
+            await this.googleCalendar.stopChannel({
+              returnOnlyData: false,
+              requestBody: {
+                id,
+                resourceId,
+              },
+            });
+          if (status === 204) {
+            console.log("webhook deactivated");
+            this.setNextSyncToken(calendarId, null);
+            this.setChannelId(calendarId, null);
+            this.setResourceId(calendarId, null);
+            this.setExpiration(calendarId, null);
+          } else {
+            console.log("There was a problem deactivating the webhook");
+          }
+        }
+      }
+    },
+    getSoonestExpirationDate() {
+      let min;
+      for (const calendarId of this.calendarIds) {
+        const expiration = parseInt(this.db.get(`${calendarId}.expiration`));
+        if (!min || expiration < min) {
+          min = expiration;
+        }
+      }
+      return new Date(min);
+    },
+    getChannelIds() {
+      const channelIds = [];
+      for (const calendarId of this.calendarIds) {
+        const channelId = this.db.get(`${calendarId}.channelId`);
+        channelIds.push(channelId);
+      }
+      return channelIds;
+    },
+  },
+  async run(event) {
+    // refresh watch
+    if (event.interval_seconds) {
+      // get time
+      const now = new Date();
+      const intervalMs = event.interval_seconds * 1000;
+      // get expiration
+      const expireDate = this.getSoonestExpirationDate();
+
+      // if now + interval > expiration, refresh watch
+      if (now.getTime() + intervalMs > expireDate.getTime()) {
+        await this.stopWatchRequest();
+        await this.makeWatchRequest();
+      }
+    } else {
+      // Verify channel ID
+      const channelIds = this.getChannelIds();
+      const incomingChannelId = event?.headers?.["x-goog-channel-id"];
+      if (!channelIds.includes(incomingChannelId)) {
+        console.log(
+          `Unexpected channel ID ${incomingChannelId}. This likely means there are multiple, older subscriptions active.`,
+        );
+        return;
+      }
+
+      // Check that resource state === exists
+      const state = event?.headers?.["x-goog-resource-state"];
+      switch (state) {
+      case "exists":
+        // there's something to emit, so keep going
+        break;
+      case "not_exists":
+        console.log("Resource does not exist. Exiting.");
+        return;
+      case "sync":
+        console.log("New channel created");
+        return;
+      default:
+        console.log(`Unknown state: ${state}`);
+        return;
+      }
+    }
+
+    // Fetch and emit events
+    for (const calendarId of this.calendarIds) {
+      const syncToken = this.getNextSyncToken(calendarId);
+      let nextSyncToken = null;
+      let nextPageToken = null;
+      while (!nextSyncToken) {
+        const {
+          data: syncData = {},
+          status: syncStatus,
+        } = await this.googleCalendar.listEvents({
+          returnOnlyData: false,
+          calendarId,
+          syncToken,
+          pageToken: nextPageToken,
+        });
+        if (syncStatus === 410) {
+          console.log("Sync token invalid, resyncing");
+          nextSyncToken = await this.googleCalendar.fullSync(this.calendarId);
+          break;
+        }
+        nextPageToken = syncData.nextPageToken;
+        nextSyncToken = syncData.nextSyncToken;
+
+        const { items: events = [] } = syncData;
+        events
+          .filter(this.isEventRelevant, this)
+          .forEach((event) => {
+            const { status } = event;
+            if (status === "cancelled") {
+              console.log("Event cancelled. Exiting.");
+              return;
+            }
+            const meta = this.generateMeta(event);
+            this.$emit(event, meta);
+          });
+      }
+
+      this.setNextSyncToken(calendarId, nextSyncToken);
+    }
+  },
+};

package/google_calendar.app.js

@@ -1,154 +0,0 @@
-const { google } = require("googleapis")
-const get = require("lodash.get")
-
-module.exports = {
-  type: "app",
-  app: "google_calendar",
-  propDefinitions: {
-    calendarId: {
-      description: "Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.",
-      type: "string"
-    },
-    iCalUID : {
-      description: "Specifies event ID in the iCalendar format to be included in the response. Optional.",
-      optional: true,
-      type: "string"
-    },
-    maxAttendees: {
-      description: "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.",
-      optional: true,
-      type: "integer"
-    },
-    maxResults: {
-      description: "Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.",
-      optional: true,
-      type: "integer"
-    },
-    orderBy: {
-      description: "The order of the events returned in the result. Optional. The default is an unspecified, stable order.",
-      optional: true,
-      type: "string",
-      options() {
-        return [{label: "startTime", value: "startTime"}, {label: "updated", value: "updated"}]
-      },
-//      async options: ["startTime", "updated"],
-      default: "startTime"
-    },
-    pageToken: {
-      description: "Token specifying which result page to return. Optional.",
-      optional: true,
-      type: "string"
-    },
-    privateExtendedProperty: {
-      description: "Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.",
-      optional: true,
-      type: "string"
-    },
-    q: {
-      description: "Free text search terms to find events that match these terms in any field, except for extended properties. Optional.",
-      optional: true,
-      type: "string"
-    },
-    sharedExtendedProperty: {
-      description: "Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.",
-      optional: true,
-      type: "string"
-    },
-    showDeleted: {
-      description: "Whether to include deleted events (with status equals \"cancelled\") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.",
-      optional: true,
-      type: "boolean"
-    },
-    showHiddenInvitations: {
-      description: "Whether to include hidden invitations in the result. Optional. The default is False.",
-      optional: true,
-      type: "boolean"
-    },
-    singleEvents: {
-      description: "Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.",
-      optional: true,
-      type: "boolean"
-    },
-    syncToken: {
-      description: "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False.",
-      optional: true,
-      type: "string"
-    },
-    timeMax: {
-      description: "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.",
-      optional: true,
-      type: "string"
-    },
-    timeMin: {
-      description: "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
-      optional: true,
-      type: "string"
-    },
-    timeZone: {
-      description: "Time zone used in the response. Optional. The default is the time zone of the calendar.",
-      optional: true,
-      type: "string"
-    },
-    updatedMin: { description: "Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.",
-      optional: true,
-      type: "string"
-    }
-  },
-  methods: {
-    _tokens() {
-      const access_token = get(this, "$auth.oauth_access_token")
-      const refresh_token = get(this, "$auth.oauth_refresh_token")
-      return {
-        access_token,
-        refresh_token,
-      }
-    },
-    // returns a calendar object you can do whatever you want with
-    calendar() {
-      const auth = new google.auth.OAuth2()
-      auth.setCredentials(this._tokens())
-      const calendar = google.calendar({version: "v3", auth})
-      return calendar
-    },
-    async calendarList() {
-      const calendar = this.calendar()
-      const resp = await calendar.calendarList.list()
-      return resp
-    },
-    async list(config) {
-      const calendar = this.calendar()
-      const resp = await calendar.events.list(config)
-      return resp
-    },
-    // for config key value pairs - https://developers.google.com/calendar/v3/reference/events/list
-    // deprecated
-    async getEvents(config) {
-      return await this.list(config)
-    },
-    async watch(config) {
-      const calendar = this.calendar()
-      const resp = await calendar.events.watch(config)
-      return resp
-    },
-    async stop(config) {
-      const calendar = this.calendar()
-      const resp = await calendar.channels.stop(config)
-      return resp
-    },
-    async fullSync(calendarId) {
-      let nextSyncToken = null
-      let nextPageToken = null
-      while(!nextSyncToken) {
-        const listConfig = {
-          calendarId,
-          pageToken: nextPageToken
-        }
-        const syncResp = await this.list(listConfig)
-        nextPageToken = get(syncResp, "data.nextPageToken")
-        nextSyncToken = get(syncResp, "data.nextSyncToken")
-      }
-      return nextSyncToken
-    }
-  }
-}
-

package/sources/event-cancelled/event-cancelled.js

@@ -1,65 +0,0 @@
-const _ = require("lodash");
-const googleCalendar = require("../../google_calendar.app.js");
-
-module.exports = {
-  key: "google_calendar-event-cancelled",
-  name: "Event Cancelled",
-  description: "Emits when an event is cancelled or deleted",
-  version: "0.0.1",
-  dedupe: "unique", // Dedupe events based on the Google Calendar event ID
-  props: {
-    googleCalendar,
-    calendarId: {
-      type: "string",
-      async options() {
-        const calListResp = await this.googleCalendar.calendarList();
-        const calendars = _.get(calListResp, "data.items");
-        if (calendars) {
-          const calendarIds = calendars.map((item) => {
-            return { value: item.id, label: item.summary };
-          });
-          return calendarIds;
-        }
-        return [];
-      },
-    },
-    timer: {
-      type: "$.interface.timer",
-      default: {
-        intervalSeconds: 5 * 60,
-      },
-    },
-  },
-  async run(event) {
-    const intervalMs = 1000 * (event.interval_seconds || 300); // fall through to default for manual testing
-    const now = new Date();
-
-    const updatedMin = new Date(now.getTime() - intervalMs).toISOString();
-
-    const config = {
-      calendarId: this.calendarId,
-      updatedMin,
-      showDeleted: true,
-      singleEvents: true,
-      orderBy: "startTime",
-    };
-    const resp = await this.googleCalendar.getEvents(config);
-
-    const events = _.get(resp.data, "items");
-    if (Array.isArray(events)) {
-      for (const event of events) {
-        // only emit if status is cancelled
-        if (event.status === "cancelled") {
-          const { summary, id } = event;
-          this.$emit(event, {
-            summary,
-            id,
-            ts: +new Date(event.start.dateTime),
-          });
-        }
-      }
-    } else {
-      console.log("nothing to emit");
-    }
-  },
-};