Merge pull request #37 from DevoteamNL/feat/plugin-user-restriction

Restricted the selectable user plugins

src/common/types/user.ts

@@ -1,8 +1,11 @@
+import { PluginDisplayNameT } from '../../plugin/plugin.constants';
+
 export class User {
   id: number;
   providerId: string;
   username: string;
   name?: string;
+  plugins?: PluginDisplayNameT[];
   created_at: Date;
   updated_at: Date;
 }

src/plugin/plugin.constants.ts

@@ -0,0 +1,6 @@
+export enum PluginDisplayName {
+  JOAN = 'Joan',
+  CVS = 'CVs',
+}
+
+export type PluginDisplayNameT = keyof typeof PluginDisplayName;

src/plugin/plugin.controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, UseGuards } from '@nestjs/common';
+import { Controller, Get, Request, UseGuards } from '@nestjs/common';
 import { GoogleTokenGuard } from 'src/auth/guards/google-token.guard';
 import { PluginService } from './plugin.service';
 
@@ -8,7 +8,10 @@ export class PluginController {
   constructor(private readonly pluginService: PluginService) {}
 
   @Get()
-  listPlugins() {
-    return this.pluginService.availablePlugins;
+  listPlugins(@Request() req) {
+    const { plugins = [] } = req.user;
+    return this.pluginService.availablePlugins.filter((plugin) => {
+      return plugins.length > 0 && plugins.includes(plugin.displayName);
+    });
   }
 }

src/plugin/plugins/cv.plugin.ts

@@ -1,12 +1,11 @@
-import axios, { AxiosInstance } from 'axios';
-import moment from 'moment-timezone';
 import { ConfigService } from '../types';
 import { Definition } from '../definition.decorator';
 import { Plugin } from '../plugin.decorator';
 import { Logger } from '@nestjs/common';
 import { CognitiveSearchService } from '../../cognitive-search/cognitive-search.service';
+import { PluginDisplayName } from '../plugin.constants';
 
-@Plugin({ displayName: 'CVs' })
+@Plugin({ displayName: PluginDisplayName.CVS })
 export class CVsPlugin {
   private readonly logger = new Logger(CVsPlugin.name);
 

src/plugin/plugins/joan.plugin.ts

@@ -4,6 +4,7 @@ import { ConfigService } from '../types';
 import { Definition } from '../definition.decorator';
 import { Plugin } from '../plugin.decorator';
 import { Logger } from '@nestjs/common';
+import { PluginDisplayName } from '../plugin.constants';
 
 interface Desk {
   id: string;
@@ -19,7 +20,7 @@ interface ParkingSpotOptions {
   timeslot?: string;
 }
 
-@Plugin({ displayName: 'Joan' })
+@Plugin({ displayName: PluginDisplayName.JOAN })
 export class JoanPlugin {
   private axiosInstance: AxiosInstance;
   private token: string | null = null;

src/users/dto/create-user.dto.ts

@@ -1,8 +1,11 @@
+import { PluginDisplayNameT } from '../../plugin/plugin.constants';
+
 export class CreateUserDto {
   providerId: string;
   username: string;
   google_token: string;
   refresh_token: string;
   name?: string;
   is_active?: boolean;
+  plugins?: PluginDisplayNameT[];
 }

src/users/entities/user.entity.ts

@@ -8,6 +8,7 @@ import {
 import { IsEmail } from 'class-validator';
 import { Thread } from '../../thread/entities/thread.entity';
 import { Feedback } from '../../message/feedback/entities/feedback.entity';
+import { PluginDisplayNameT } from '../../plugin/plugin.constants';
 
 @Entity()
 @Unique('UQ_USERNAME_PROVIDER', ['username', 'providerId'])
@@ -46,6 +47,14 @@ export class User {
   @Column({ type: 'timestamp', default: () => 'CURRENT_TIMESTAMP' })
   createdAt: Date;
 
+  // Whitelist of the plugins' names the user is permitted to access
+  @Column({
+    type: 'varchar',
+    array: true,
+    nullable: true,
+  })
+  plugins: PluginDisplayNameT[];
+
   constructor(
     providerId: string,
     username: string,
@@ -59,13 +68,14 @@ export class User {
   }
 
   toJSON(): UserDTO {
-    const { id, username, providerId } = this;
-    return { id, username, providerId };
+    const { id, username, providerId, plugins } = this;
+    return { id, username, providerId, plugins };
   }
 }
 
 interface UserDTO {
   id: number;
   username: string;
   providerId: string;
+  plugins: PluginDisplayNameT[];
 }