Sync users only manually in dev env

app-nest/src/app.module.ts

@@ -3,6 +3,7 @@ import { TypeOrmModule } from "@nestjs/typeorm";
 import { BoltModule } from "./bolt/bolt.module";
 import configuration from "./config/configuration";
 import { inDevelopmentEnvironment } from "./config/utils";
+import { DevToolsModule } from "./dev-tools/dev-tools.module";
 import { EntitiesModule } from "./entities/entities.module";
 import { GuiModule } from "./gui/gui.module";
 import { SyncModule } from "./sync/sync.module";
@@ -27,6 +28,7 @@ import { SyncModule } from "./sync/sync.module";
     GuiModule,
     EntitiesModule,
     SyncModule,
+    DevToolsModule,
   ],
 })
 export class AppModule {}

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

@@ -0,0 +1,16 @@
+import { Controller } from "@nestjs/common";
+import BoltAction from "../bolt/decorators/bolt-action.decorator";
+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();
+    };
+  }
+}

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

@@ -0,0 +1,6 @@
+import { Module } from "@nestjs/common";
+import { SyncModule } from "../sync/sync.module";
+import { DevToolsController } from "./dev-tools.controller";
+
+@Module({ imports: [SyncModule], controllers: [DevToolsController] })
+export class DevToolsModule {}

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

@@ -14,9 +14,17 @@ const devTools = [
         text: {
           type: "plain_text",
           text: ":recycle:  Sync Users",
-          emoji: true,
         },
-        value: "sync_users",
+        action_id: "sync_users",
+      },
+    ],
+  },
+  {
+    type: "context",
+    elements: [
+      {
+        type: "plain_text",
+        text: "In development environment, users are not synchronized between local database and Slack on app start to avoid running into API rate limits due to hot-reloads. Sync users manually when necessary.",
       },
     ],
   },

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

@@ -7,5 +7,6 @@ import { UserSyncService } from "./user-sync.service";
 @Module({
   imports: [UserModule],
   providers: [SyncService, UserSyncService, UserService],
+  exports: [SyncService, UserSyncService],
 })
 export class SyncModule {}

app-nest/src/sync/sync.service.ts

@@ -1,11 +1,14 @@
 import { Injectable, OnApplicationBootstrap } from "@nestjs/common";
+import { inDevelopmentEnvironment } from "../config/utils";
 import { UserSyncService } from "./user-sync.service";
 
 @Injectable()
 export class SyncService implements OnApplicationBootstrap {
   constructor(private userSyncService: UserSyncService) {}
+
   async onApplicationBootstrap() {
-    console.log("app bootstrap");
-    await this.userSyncService.syncUsers();
+    if (!inDevelopmentEnvironment) {
+      await this.userSyncService.syncUsers();
+    }
   }
 }

app-nest/src/sync/user-sync.service.ts

@@ -13,7 +13,6 @@ export class UserSyncService {
   ) {}
 
   async syncUsers() {
-    // FIXME: This needs to be limited in dev env to protect against rate-limit errors. Add UI button to fire this manually.
     this.logger.log("Starting user data synchronization.");
     const data = await this.boltUserService.getUsers();