Add ICS client support based on event host (#3)

* add GSI for host field

* fix dynamo table def

* build ical support

* fix IAM role for using an index

* fix IAM, add tests

* add ical parsing tests

* add unit tests

* remove unneeded imports

* fix calendar name

* fix name part 3

Author: devksingh4

cloudformation/iam.yml

@@ -61,6 +61,7 @@ Resources:
                 - dynamodb:*
               Effect: Allow
               Resource:
+                - !Sub arn:aws:dynamodb:${AWS::Region}:${AWS::AccountId}:table/infra-events-api-records/*
                 - !Sub arn:aws:dynamodb:${AWS::Region}:${AWS::AccountId}:table/infra-events-api-records
         PolicyName: lambda-dynamo
 Outputs:

cloudformation/main.yml

@@ -117,9 +117,18 @@ Resources:
       AttributeDefinitions:
         - AttributeName: id
           AttributeType: S
+        - AttributeName: host
+          AttributeType: S
       KeySchema:
         - AttributeName: id
           KeyType: HASH
+      GlobalSecondaryIndexes:
+      - IndexName: HostIndex
+        KeySchema:
+        - AttributeName: host
+          KeyType: HASH
+        Projection:
+          ProjectionType: ALL
 
   AppApiGateway:
     Type: AWS::Serverless::Api

package.json

@@ -41,6 +41,7 @@
     "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.4",
     "lint-staged": "^15.2.8",
+    "node-ical": "^0.18.0",
     "prettier": "^3.3.3",
     "request": "^2.88.2",
     "supertest": "^7.0.0",
@@ -56,10 +57,13 @@
     "@fastify/auth": "^4.6.1",
     "@fastify/aws-lambda": "^4.1.0",
     "@fastify/cors": "^9.0.1",
+    "@touch4it/ical-timezones": "^1.9.0",
     "fastify": "^4.28.1",
     "fastify-plugin": "^4.5.1",
+    "ical-generator": "^7.2.0",
     "jsonwebtoken": "^9.0.2",
     "jwks-rsa": "^3.1.0",
+    "moment": "^2.30.1",
     "moment-timezone": "^0.5.45",
     "zod": "^3.23.8",
     "zod-to-json-schema": "^3.23.2",

src/index.ts

@@ -12,6 +12,7 @@ import cors from "@fastify/cors";
 import fastifyZodValidationPlugin from "./plugins/validate.js";
 import { environmentConfig } from "./config.js";
 import organizationsPlugin from "./routes/organizations.js";
+import icalPlugin from "./routes/ics.js";
 
 const now = () => Date.now();
 
@@ -66,6 +67,7 @@ async function init() {
       api.register(protectedRoute, { prefix: "/protected" });
       api.register(eventsPlugin, { prefix: "/events" });
       api.register(organizationsPlugin, { prefix: "/organizations" });
+      api.register(icalPlugin, { prefix: "/ical" });
     },
     { prefix: "/api/v1" },
   );

src/orgs.ts

@@ -23,4 +23,4 @@ export const CommitteeList = [
   "Social Committee",
   "Mentorship Committee",
 ] as const;
-export const OrganizationList = ["ACM", ...SIGList, ...CommitteeList] as const;
+export const OrganizationList = ["ACM", ...SIGList, ...CommitteeList];

src/routes/events.ts

@@ -18,6 +18,7 @@ import moment from "moment-timezone";
 // POST
 
 const repeatOptions = ["weekly", "biweekly"] as const;
+export type EventRepeatOptions = (typeof repeatOptions)[number];
 
 const baseSchema = z.object({
   title: z.string().min(1),
@@ -26,7 +27,7 @@ const baseSchema = z.object({
   end: z.optional(z.string()),
   location: z.string(),
   locationLink: z.optional(z.string().url()),
-  host: z.enum(OrganizationList),
+  host: z.enum(OrganizationList as [string, ...string[]]),
   featured: z.boolean().default(false),
   paidEventId: z.optional(z.string().min(1)),
 });

src/routes/ics.ts

@@ -0,0 +1,141 @@
+import { FastifyPluginAsync } from "fastify";
+import {
+  DynamoDBClient,
+  QueryCommand,
+  QueryCommandInput,
+  ScanCommand,
+} from "@aws-sdk/client-dynamodb";
+import { genericConfig } from "../config.js";
+import { unmarshall } from "@aws-sdk/util-dynamodb";
+import { NotFoundError, ValidationError } from "../errors/index.js";
+import ical, {
+  ICalCalendarMethod,
+  ICalEventJSONRepeatingData,
+  ICalEventRepeatingFreq,
+} from "ical-generator";
+import moment from "moment";
+import { getVtimezoneComponent } from "@touch4it/ical-timezones";
+import { OrganizationList } from "../orgs.js";
+import { EventRepeatOptions } from "./events.js";
+
+const dynamoClient = new DynamoDBClient({
+  region: genericConfig.AwsRegion,
+});
+
+const repeatingIcalMap: Record<EventRepeatOptions, ICalEventJSONRepeatingData> =
+  {
+    weekly: { freq: ICalEventRepeatingFreq.WEEKLY },
+    biweekly: { freq: ICalEventRepeatingFreq.WEEKLY, interval: 2 },
+  };
+
+function generateHostName(host: string) {
+  if (host == "ACM" || !host) {
+    return "ACM@UIUC";
+  }
+  if (host.includes("ACM")) {
+    return host;
+  }
+  return `ACM@UIUC ${host}`;
+}
+
+const icalPlugin: FastifyPluginAsync = async (fastify, _options) => {
+  fastify.get("/:host?", async (request, reply) => {
+    const host = (request.params as Record<string, string>).host;
+    let queryParams: QueryCommandInput = {
+      TableName: genericConfig.DynamoTableName,
+    };
+    let response;
+    if (host) {
+      if (!OrganizationList.includes(host)) {
+        throw new ValidationError({
+          message: `Invalid host parameter "${host}" in path.`,
+        });
+      }
+      queryParams = {
+        ...queryParams,
+      };
+      response = await dynamoClient.send(
+        new QueryCommand({
+          ...queryParams,
+          ExpressionAttributeValues: {
+            ":host": {
+              S: host,
+            },
+          },
+          KeyConditionExpression: "host = :host",
+          IndexName: "HostIndex",
+        }),
+      );
+    } else {
+      response = await dynamoClient.send(new ScanCommand(queryParams));
+    }
+    const dynamoItems = response.Items
+      ? response.Items.map((x) => unmarshall(x))
+      : null;
+    if (!dynamoItems) {
+      throw new NotFoundError({
+        endpointName: host ? `/api/v1/ical/${host}` : "/api/v1/ical",
+      });
+    }
+    // generate friendly calendar name
+    let calendarName =
+      host && host.includes("ACM")
+        ? `${host} Events`
+        : `ACM@UIUC - ${host} Events`;
+    if (host == "ACM") {
+      calendarName = "ACM@UIUC - Major Events";
+    }
+    if (!host) {
+      calendarName = "ACM@UIUC - All Events";
+    }
+    const calendar = ical({ name: calendarName });
+    calendar.timezone({
+      name: "America/Chicago",
+      generator: getVtimezoneComponent,
+    });
+    calendar.method(ICalCalendarMethod.PUBLISH);
+    for (const rawEvent of dynamoItems) {
+      let event = calendar.createEvent({
+        start: moment.tz(rawEvent.start, "America/Chicago"),
+        end: rawEvent.end
+          ? moment.tz(rawEvent.end, "America/Chicago")
+          : moment.tz(rawEvent.start, "America/Chicago"),
+        summary: rawEvent.title,
+        description: rawEvent.locationLink
+          ? `Host: ${rawEvent.host}\nGoogle Maps Link: ${rawEvent.locationLink}\n\n` +
+            rawEvent.description
+          : `Host: ${rawEvent.host}\n\n` + rawEvent.description,
+        timezone: "America/Chicago",
+        organizer: generateHostName(host),
+        id: rawEvent.id,
+      });
+
+      if (rawEvent.repeats) {
+        if (rawEvent.repeatEnds) {
+          event = event.repeating({
+            ...repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
+            until: moment.tz(rawEvent.repeatEnds, "America/Chicago"),
+          });
+        } else {
+          event.repeating(
+            repeatingIcalMap[rawEvent.repeats as EventRepeatOptions],
+          );
+        }
+      }
+      if (rawEvent.location) {
+        event = event.location({
+          title: rawEvent.location,
+        });
+      }
+    }
+
+    reply
+      .headers({
+        "Content-Type": "text/calendar; charset=utf-8",
+        "Content-Disposition": 'attachment; filename="calendar.ics"',
+      })
+      .send(calendar.toString());
+  });
+};
+
+export default icalPlugin;

tests/live/ical.test.ts

@@ -0,0 +1,30 @@
+import { expect, test } from "vitest";
+import { InternalServerError } from "../../src/errors/index.js";
+import { describe } from "node:test";
+import { OrganizationList } from "../../src/orgs.js";
+import ical from "node-ical";
+
+const appKey = process.env.APPLICATION_KEY;
+if (!appKey) {
+  throw new InternalServerError({ message: "No application key found" });
+}
+
+const baseEndpoint = `https://${appKey}.aws.qa.acmuiuc.org`;
+test("getting all events", async () => {
+  const response = await fetch(`${baseEndpoint}/api/v1/ical`);
+  expect(response.status).toBe(200);
+});
+
+describe("Getting specific calendars", async () => {
+  for (const org of OrganizationList) {
+    test(`Get ${org} calendar`, async () => {
+      const response = await fetch(`${baseEndpoint}/api/v1/ical/${org}`);
+      expect(response.status).toBe(200);
+      expect(response.headers.get("Content-Disposition")).toEqual(
+        'attachment; filename="calendar.ics"',
+      );
+      const calendar = ical.sync.parseICS(await response.text());
+      expect(calendar["vcalendar"]["type"]).toEqual("VCALENDAR");
+    });
+  }
+});

tests/unit/data/acmWideCalendar.ics

@@ -0,0 +1,89 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//sebbo.net//ical-generator//EN
+METHOD:PUBLISH
+NAME:ACM@UIUC - All Events
+X-WR-CALNAME:ACM@UIUC - All Events
+BEGIN:VTIMEZONE
+TZID:America/Chicago
+TZURL:http://tzurl.org/zoneinfo-outlook/America/Chicago
+X-LIC-LOCATION:America/Chicago
+BEGIN:DAYLIGHT
+TZOFFSETFROM:-0600
+TZOFFSETTO:-0500
+TZNAME:CDT
+DTSTART:19700308T020000
+RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU
+END:DAYLIGHT
+BEGIN:STANDARD
+TZOFFSETFROM:-0500
+TZOFFSETTO:-0600
+TZNAME:CST
+DTSTART:19701101T020000
+RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU
+END:STANDARD
+END:VTIMEZONE
+TIMEZONE-ID:America/Chicago
+X-WR-TIMEZONE:America/Chicago
+BEGIN:VEVENT
+UID:3138bead-b2c5-4bfe-bce4-4b478658cb78
+SEQUENCE:0
+DTSTAMP:20240822T155148
+DTSTART;TZID=America/Chicago:20240825T120000
+DTEND;TZID=America/Chicago:20240825T160000
+SUMMARY:Quad Day
+LOCATION:Main Quad
+DESCRIPTION:Host: ACM\nGoogle Maps Link: https://maps.app.goo.gl/2ZRYibtE7
+ Yem5TrP6\n\nJoin us on Quad Day to learn more about ACM and CS at Illinois
+ !
+ORGANIZER;CN="ACM@UIUC":mailto:ACM@UIUC
+END:VEVENT
+BEGIN:VEVENT
+UID:5bc69f3b-e958-4c80-b041-ddeae0385db8
+SEQUENCE:0
+DTSTAMP:20240822T155148
+DTSTART;TZID=America/Chicago:20240725T180000
+DTEND;TZID=America/Chicago:20240725T190000
+RRULE:FREQ=WEEKLY;UNTIL=20240905T190000
+SUMMARY:Infra Meeting
+LOCATION:ACM Middle Room
+DESCRIPTION:Host: Infrastructure Committee\n\nTest event.
+ORGANIZER;CN="ACM@UIUC":mailto:ACM@UIUC
+END:VEVENT
+BEGIN:VEVENT
+UID:4d38608d-90bf-4a58-8701-3f1b659a53db
+SEQUENCE:0
+DTSTAMP:20240822T155148
+DTSTART;TZID=America/Chicago:20240925T180000
+DTEND;TZID=America/Chicago:20240925T190000
+SUMMARY:Testing Paid and Featured Event
+LOCATION:ACM Middle Room
+DESCRIPTION:Host: Social Committee\n\nTest paid featured event.
+ORGANIZER;CN="ACM@UIUC":mailto:ACM@UIUC
+END:VEVENT
+BEGIN:VEVENT
+UID:accd7fe0-50ac-427b-8041-a2b3ddcd328e
+SEQUENCE:0
+DTSTAMP:20240822T155148
+DTSTART;TZID=America/Chicago:20240725T180000
+DTEND;TZID=America/Chicago:20240725T190000
+SUMMARY:Event in the past.
+LOCATION:ACM Middle Room
+DESCRIPTION:Host: Infrastructure Committee\n\nTest event in the past.
+ORGANIZER;CN="ACM@UIUC":mailto:ACM@UIUC
+END:VEVENT
+BEGIN:VEVENT
+UID:78be8f2b-3d1d-4481-90b6-85bfd84d38b4
+SEQUENCE:0
+DTSTAMP:20240822T155148
+DTSTART;TZID=America/Chicago:20240830T170000
+DTEND;TZID=America/Chicago:20240830T170000
+RRULE:FREQ=WEEKLY
+SUMMARY:Weekly Happy Hour
+LOCATION:Legends
+DESCRIPTION:Host: ACM\nGoogle Maps Link: https://goo.gl/maps/CXESXd3otbGZN
+ qFP7\n\nMeet and chat with your peers and fellow ACM members\, with food o
+ n us!
+ORGANIZER;CN="ACM@UIUC":mailto:ACM@UIUC
+END:VEVENT
+END:VCALENDAR

tests/unit/eventPost.test.ts

@@ -144,6 +144,7 @@ test("Happy path: Adding a non-repeating, featured, paid event", async () => {
       featured: true,
       host: "Social Committee",
       location: "Illini Union",
+      locationLink: "https://maps.app.goo.gl/rUBhjze5mWuTSUJK9",
       start: "2024-09-25T18:00:00",
       title: "Fall Semiformal",
       paidEventId: "sp24_semiformal",