refactor: move permissions to common module (freeCodeCamp#1190)

* refactor: move permissions to common module

* fix: include common files

* fix: experimental externalDir

* fix: copy common files into containers

* fix: import from new permission module

.gitignore

@@ -80,4 +80,6 @@ cypress-coverage/
 /server/prisma/generator/**/*.map
 /server/tests/**/*.map
 /server/reminders/**/*.map
+/common/**/*.js
+/common/**/*.map
 tsconfig.tsbuildinfo

client.Dockerfile

@@ -5,6 +5,7 @@ WORKDIR /usr/chapter/
 
 # Copying source files
 COPY client ./client
+COPY common ./common
 COPY package*.json ./
 
 # Installing dependencies

client/next.config.js

@@ -3,4 +3,7 @@ module.exports = {
     // TODO: the client and server need their own eslint configs
     ignoreDuringBuilds: true,
   },
+  experimental: {
+    externalDir: true,
+  },
 };

client/src/hooks/useCheckPermission.ts

@@ -1,6 +1,12 @@
 import { useAuth } from '../modules/auth/store';
+import {
+  InstancePermission,
+  ChapterPermission,
+} from '../../../common/permissions';
 
-export const useCheckPermission = (permission: string) => {
+export const useCheckPermission = (
+  permission: InstancePermission | ChapterPermission,
+) => {
   const { user } = useAuth();
 
   return user?.instance_role.instance_role_permissions.find(

client/src/modules/dashboard/Chapters/pages/ChaptersPage.tsx

@@ -7,6 +7,7 @@ import React from 'react';
 import { useCheckPermission } from '../../../../hooks/useCheckPermission';
 import { useChaptersQuery } from '../../../../generated/graphql';
 import { Layout } from '../../shared/components/Layout';
+import { Permission } from '../../../../../../common/permissions';
 
 export const ChaptersPage: NextPage = () => {
   const {
@@ -15,10 +16,9 @@ export const ChaptersPage: NextPage = () => {
     data: chapterData,
   } = useChaptersQuery();
 
-  // TODO: the permission names are stringly typed and should be refactored.
-  // This page, and the prisma factories, should both draw from a single source
-  // of truth (an enum, probably)
-  const hasPermissionToCreateChapter = useCheckPermission('chapter-create');
+  const hasPermissionToCreateChapter = useCheckPermission(
+    Permission.ChapterCreate,
+  );
 
   return (
     <Layout>

client/src/modules/dashboard/shared/components/Layout.tsx

@@ -2,6 +2,8 @@ import { HStack } from '@chakra-ui/layout';
 import { LinkButton } from 'chakra-next-link';
 import { useRouter } from 'next/router';
 import React from 'react';
+
+import { Permission } from '../../../../../../common/permissions';
 import { useCheckPermission } from 'hooks/useCheckPermission';
 
 const links = [
@@ -11,7 +13,7 @@ const links = [
   {
     text: 'Sponsors',
     link: '/dashboard/sponsors',
-    requiredPermission: 'sponsors-manage',
+    requiredPermission: Permission.SponsorsManage,
   },
   { text: 'Users', link: '/dashboard/users' },
 ];

client/tsconfig.json

@@ -33,6 +33,7 @@
   ],
   "include": [
     "**/*.ts",
-    "**/*.tsx"
+    "**/*.tsx",
+    "../common/**/*.ts",
   ]
 }

common/permissions.ts

@@ -0,0 +1,19 @@
+export enum ChapterPermission {
+  ChapterEdit = 'chapter-edit',
+  EventCreate = 'event-create',
+  EventEdit = 'event-edit',
+  Rsvp = 'rsvp',
+  RsvpDelete = 'rsvp-delete',
+  RsvpConfirm = 'rsvp-confirm',
+}
+
+export enum InstancePermission {
+  ChapterCreate = 'chapter-create',
+  ChangeInstanceRole = 'change-instance-role',
+  SponsorsManage = 'sponsors-manage',
+  ViewUsers = 'view-users',
+}
+
+// Ideally this would be a new enum, but TS does not (to my knowledge) support
+// that yet.
+export const Permission = { ...InstancePermission, ...ChapterPermission };

server.Dockerfile

@@ -4,7 +4,8 @@ ARG build
 WORKDIR /usr/chapter/
 
 # Bundle app source
-COPY ./server ./server
+COPY server ./server
+COPY common ./common
 COPY package*.json ./
 
 # Install app dependencies

server/prisma/generator/factories/chapterRoles.factory.ts

@@ -1,13 +1,5 @@
 import { prisma } from '../../../src/prisma';
-
-export enum ChapterPermission {
-  ChapterEdit = 'chapter-edit',
-  EventCreate = 'event-create',
-  EventEdit = 'event-edit',
-  Rsvp = 'rsvp',
-  RsvpDelete = 'rsvp-delete',
-  RsvpConfirm = 'rsvp-confirm',
-}
+import { ChapterPermission } from '../../../../common/permissions';
 
 const chapterPermissions = Object.values(ChapterPermission);
 

server/prisma/generator/factories/instanceRoles.factory.ts

@@ -1,17 +1,7 @@
 import { prisma } from '../../../src/prisma';
 
-import { ChapterPermission } from './chapterRoles.factory';
+import { Permission } from '../../../../common/permissions';
 
-enum InstancePermission {
-  ChapterCreate = 'chapter-create',
-  ChangeInstanceRole = 'change-instance-role',
-  SponsorsManage = 'sponsors-manage',
-  ViewUsers = 'view-users',
-}
-
-// Ideally this would be a new enum, but TS does not (to my knowledge) support
-// that yet.
-export const Permission = { ...InstancePermission, ...ChapterPermission };
 const allPermissions = Object.values(Permission);
 
 interface InstanceRole {

server/src/controllers/Chapter/resolver.ts

@@ -8,7 +8,7 @@ import {
   Ctx,
   Authorized,
 } from 'type-graphql';
-import { Permission } from '../../../prisma/generator/factories/instanceRoles.factory';
+import { Permission } from '../../../../common/permissions';
 
 import { GQLCtx } from '../../common-types/gql';
 import { Chapter, ChapterWithRelations } from '../../graphql-types';

server/src/controllers/Events/resolver.ts

@@ -20,7 +20,7 @@ import {
 import { isEqual, sub } from 'date-fns';
 import ical from 'ical-generator';
 
-import { Permission } from '../../../prisma/generator/factories/instanceRoles.factory';
+import { Permission } from '../../../../common/permissions';
 import { GQLCtx } from '../../common-types/gql';
 import {
   Event,

server/src/controllers/Sponsors/resolver.ts

@@ -1,7 +1,7 @@
 import { Prisma } from '@prisma/client';
 import { Arg, Authorized, Int, Mutation, Query, Resolver } from 'type-graphql';
 
-import { Permission } from '../../../prisma/generator/factories/instanceRoles.factory';
+import { Permission } from '../../../../common/permissions';
 import { Sponsor } from '../../graphql-types/Sponsor';
 import { prisma } from '../../prisma';
 import { CreateSponsorInputs, UpdateSponsorInputs } from './inputs';

server/src/controllers/Users/resolver.ts

@@ -3,7 +3,7 @@ import { Arg, Authorized, Int, Mutation, Query, Resolver } from 'type-graphql';
 import { prisma } from '../../prisma';
 
 import { UserWithInstanceRole } from '../../graphql-types';
-import { Permission } from '../../../prisma/generator/factories/instanceRoles.factory';
+import { Permission } from '../../../../common/permissions';
 
 @Resolver()
 export class UsersResolver {

server/tsconfig.json

@@ -25,6 +25,6 @@
     "typeRoots": ["src/common-types/index.d.ts", "../node_modules/@types"],
     "incremental": true
   },
-  "include": ["src/**/*", "prisma/**/*", "reminders/**/*", "tests/**/*"],
+  "include": ["src/**/*", "prisma/**/*", "reminders/**/*", "tests/**/*", "../common/**/*"],
   "exclude": ["node_modules"]
 }