Refactor Bolt event handlers to not be HOC's

app-nest/package.json

@@ -33,8 +33,11 @@
     "@nestjs/config": "^3.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/swagger": "^7.1.8",
     "@nestjs/typeorm": "^10.0.0",
     "@slack/bolt": "^3.13.2",
+    "dayjs": "^1.11.9",
+    "lodash": "^4.17.21",
     "pg": "^8.11.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",
@@ -48,6 +51,7 @@
     "@nestjs/testing": "^10.0.0",
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.2",
+    "@types/lodash": "^4.14.196",
     "@types/node": "^20.3.1",
     "@types/supertest": "^2.0.12",
     "@typescript-eslint/eslint-plugin": "^5.59.11",
@@ -81,4 +85,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}

app-nest/src/bolt/bolt-register.service.ts

@@ -58,9 +58,10 @@ export class BoltRegisterService {
     const cref = this.moduleRef.get(discoveredMethod.parentClass.injectType, {
       strict: false,
     });
-    // N.B.: Take care where you call the discovered handler method. This is an easy
-    // place to bind it into a wrong context. Ask me how I know.
-    return cref[discoveredMethod.methodName]();
+
+    return cref[discoveredMethod.methodName].bind(
+      discoveredMethod.parentClass.instance,
+    );
   }
 
   /**

app-nest/src/bolt/enums/bolt-actions.enum.ts

@@ -0,0 +1,10 @@
+enum BoltActions {
+  SYNC_USERS = "sync_users",
+  SET_OFFICE_PRESENCE = "set_office_presence",
+  SET_REMOTE_PRESENCE = "set_remote_presence",
+  SELECT_OFFICE_FOR_DATE = "select_office_for_date",
+  DAY_LIST_ITEM_OVERFLOW = "day_list_item_overflow",
+  SET_VISIBLE_OFFICE = "set_visible_office",
+}
+
+export default BoltActions;

app-nest/src/bolt/enums/bolt-events.enum.ts

@@ -0,0 +1,6 @@
+enum BoltEvents {
+  APP_HOME_OPENED = "app_home_opened",
+  USER_PROFILE_CHANGED = "user_profile_changed",
+}
+
+export default BoltEvents;

app-nest/src/bolt/types/bolt-action-types.ts

@@ -0,0 +1,9 @@
+import {
+  AllMiddlewareArgs,
+  SlackAction,
+  SlackActionMiddlewareArgs,
+} from "@slack/bolt";
+import { StringIndexed } from "@slack/bolt/dist/types/helpers";
+
+export type BoltActionArgs = SlackActionMiddlewareArgs<SlackAction> &
+  AllMiddlewareArgs<StringIndexed>;

app-nest/src/bolt/types/bolt-event-types.ts

@@ -0,0 +1,17 @@
+import {
+  AllMiddlewareArgs,
+  AppHomeOpenedEvent,
+  SlackEventMiddlewareArgs,
+  UserProfileChangedEvent,
+} from "@slack/bolt";
+import { StringIndexed } from "@slack/bolt/dist/types/helpers";
+
+export type AppHomeOpenedArgs = SlackEventMiddlewareArgs<
+  AppHomeOpenedEvent["type"]
+> &
+  AllMiddlewareArgs<StringIndexed>;
+
+export type UserProfileChangedArgs = SlackEventMiddlewareArgs<
+  UserProfileChangedEvent["type"]
+> &
+  AllMiddlewareArgs<StringIndexed>;

app-nest/src/dev-tools/dev-tools.controller.ts

@@ -1,16 +1,16 @@
 import { Controller } from "@nestjs/common";
 import BoltAction from "../bolt/decorators/bolt-action.decorator";
+import BoltActions from "../bolt/enums/bolt-actions.enum";
+import { BoltActionArgs } from "../bolt/types/bolt-action-types";
 import { UserSyncService } from "../sync/user-sync.service";
 
 @Controller()
 export class DevToolsController {
   constructor(private userSyncService: UserSyncService) {}
 
-  @BoltAction("sync_users")
-  syncUsers() {
-    return async ({ ack }) => {
-      await ack();
-      await this.userSyncService.syncUsers();
-    };
+  @BoltAction(BoltActions.SYNC_USERS)
+  async syncUsers({ ack }: BoltActionArgs) {
+    await ack();
+    await this.userSyncService.syncUsers();
   }
 }

app-nest/src/entities/entities.module.ts

@@ -1,7 +1,10 @@
 import { Module } from "@nestjs/common";
+import { OfficeModule } from "./office/office.module";
+import { PresenceModule } from "./presence/presence.module";
+import { UserSettingsModule } from "./user-settings/user-settings.module";
 import { UserModule } from "./user/user.module";
 
 @Module({
-  imports: [UserModule],
+  imports: [UserModule, PresenceModule, OfficeModule, UserSettingsModule],
 })
 export class EntitiesModule {}

app-nest/src/entities/office/office.entity.ts

@@ -0,0 +1,12 @@
+import { Column, Entity, PrimaryGeneratedColumn, Repository } from "typeorm";
+
+@Entity()
+export class Office {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  name: string;
+}
+
+export type OfficeRepository = Repository<Office>;

app-nest/src/entities/office/office.module.ts

@@ -0,0 +1,11 @@
+import { Module } from "@nestjs/common";
+import { TypeOrmModule } from "@nestjs/typeorm";
+import { Office } from "./office.entity";
+import { OfficeService } from "./office.service";
+
+@Module({
+  imports: [TypeOrmModule.forFeature([Office])],
+  providers: [OfficeService],
+  exports: [TypeOrmModule, OfficeService],
+})
+export class OfficeModule {}

app-nest/src/entities/office/office.service.ts

@@ -0,0 +1,14 @@
+import { Injectable } from "@nestjs/common";
+import { InjectRepository } from "@nestjs/typeorm";
+import { Office, OfficeRepository } from "./office.entity";
+
+@Injectable()
+export class OfficeService {
+  constructor(
+    @InjectRepository(Office) private officeRepository: OfficeRepository,
+  ) {}
+
+  async findAll() {
+    return this.officeRepository.find();
+  }
+}

app-nest/src/entities/presence/dto/presence.dto.ts

@@ -0,0 +1,8 @@
+import { OmitType, PickType } from "@nestjs/swagger";
+import { Presence } from "../presence.entity";
+
+export class UpsertPresenceDto extends OmitType(Presence, ["office"]) {}
+
+export class SetOfficeDto extends PickType(Presence, ["userId", "date"]) {
+  officeId: number;
+}

app-nest/src/entities/presence/presence.controller.ts

@@ -0,0 +1,61 @@
+import { Controller, InternalServerErrorException } from "@nestjs/common";
+import dayjs from "dayjs";
+import BoltAction from "../../bolt/decorators/bolt-action.decorator";
+import BoltActions from "../../bolt/enums/bolt-actions.enum";
+import { BoltActionArgs } from "../../bolt/types/bolt-action-types";
+import { PresenceType } from "./presence.entity";
+import { PresenceService } from "./presence.service";
+
+@Controller()
+export class PresenceController {
+  constructor(private presenceService: PresenceService) {}
+
+  @BoltAction(BoltActions.SET_OFFICE_PRESENCE)
+  async setOfficePresence({ ack, body, payload }: BoltActionArgs) {
+    await ack();
+    const date = dayjs(payload["value"]).toDate();
+    await this.presenceService.upsert({
+      userId: body.user.id,
+      type: PresenceType.AT_OFFICE,
+      date,
+    });
+  }
+
+  @BoltAction(BoltActions.SET_REMOTE_PRESENCE)
+  async setRemotePresence({ ack, body, payload }: BoltActionArgs) {
+    await ack();
+    const date = dayjs(payload["value"]).toDate();
+    await this.presenceService.upsert({
+      userId: body.user.id,
+      type: PresenceType.REMOTE,
+      date,
+    });
+  }
+
+  @BoltAction(BoltActions.SELECT_OFFICE_FOR_DATE)
+  async selectOfficeForDate({ ack, body, payload }: BoltActionArgs) {
+    await ack();
+    const { value, date } = JSON.parse(payload["selected_option"].value);
+    await this.presenceService.setOffice({
+      userId: body.user.id,
+      date: dayjs(date).toDate(),
+      officeId: value,
+    });
+  }
+
+  // TODO: Should this be moved?
+  @BoltAction(BoltActions.DAY_LIST_ITEM_OVERFLOW)
+  async dayListItemOverflow({ ack, body, payload }: BoltActionArgs) {
+    await ack();
+    const { type, date } = JSON.parse(payload["selected_option"].value);
+
+    if (type !== "remove_presence") {
+      throw new InternalServerErrorException("Not implemented.");
+    }
+
+    await this.presenceService.remove({
+      userId: body.user.id,
+      date: dayjs(date).toDate(),
+    });
+  }
+}

app-nest/src/entities/presence/presence.entity.ts

@@ -0,0 +1,24 @@
+import { Column, Entity, ManyToOne, PrimaryColumn, Repository } from "typeorm";
+import { Office } from "../office/office.entity";
+
+export enum PresenceType {
+  AT_OFFICE = "at_office",
+  REMOTE = "remote",
+}
+
+@Entity()
+export class Presence {
+  @PrimaryColumn()
+  userId: string;
+
+  @PrimaryColumn({ type: "date" })
+  date: Date;
+
+  @Column({ type: "enum", enum: PresenceType, nullable: true })
+  type: PresenceType | null;
+
+  @ManyToOne(() => Office, { nullable: true })
+  office: Office;
+}
+
+export type PresenceRepository = Repository<Presence>;