feat(cli): create command to generate CSV with course participants (#399)

Author: KonradSzwarc

.gitignore

@@ -55,6 +55,7 @@ out
 # Generated
 packages/ui/src/svg
 packages/ui/src/icons
+packages/cli/output
 .cache-loader
 
 # Database

packages/cli/package.json

@@ -13,8 +13,12 @@
     "csv-parse": "4.16.3",
     "dotenv": "10.0.0",
     "generate-password": "1.6.1",
+    "json2csv": "5.0.6",
     "puppeteer": "10.4.0",
     "reflect-metadata": "0.1.13",
     "winston": "3.3.3"
+  },
+  "devDependencies": {
+    "@types/json2csv": "5.0.3"
   }
 }

packages/cli/src/commands/generate-checklists.ts

@@ -53,9 +53,14 @@ export const generateChecklists = (program: Command) => {
         logger.debug('Iterating through fetched participants');
 
         for (const participant of participants) {
-          const checklist = await generateProcessStChecklist(participant.name);
-
-          await updateUserById(participant.id, { checklist });
+          if (!participant.checklist) {
+            const name = `${participant.firstName} ${participant.lastName}`;
+            const checklist = await generateProcessStChecklist(name);
+
+            await updateUserById(participant.id, { checklist });
+          } else {
+            logger.debug('Participant already has a checklist', participant);
+          }
         }
 
         logger.debug('Iteration through fetched participants finished');

packages/cli/src/commands/generate-welcome-csv.ts

@@ -0,0 +1,32 @@
+import { Command } from 'commander';
+
+import { parseToCsv } from '../shared/csv';
+import { getUsersByRole } from '../shared/db';
+import { createWelcomeCsv } from '../shared/files';
+import { createLogger } from '../shared/logger';
+import { userRoles, WelcomeCsvRow } from '../shared/models';
+import { transformToMatchClass } from '../shared/object';
+
+const logger = createLogger('generate-welcome-csv');
+
+export const generateWelcomeCsv = (program: Command) => {
+  program
+    .command('generate-welcome-csv')
+    .description('Generates CSV file with names, emails and checklist URLs for all participants in the database')
+    .action(async () => {
+      try {
+        const participants = await getUsersByRole(userRoles.participant);
+        const welcomeCsvRows = await Promise.all(participants.map(transformToMatchClass(WelcomeCsvRow)));
+
+        logger.debug('Parsing welcome CSV objects to CSV format', welcomeCsvRows);
+
+        const csv = parseToCsv(welcomeCsvRows);
+
+        logger.debug('Creating welcome CSVfile', csv);
+
+        await createWelcomeCsv(csv);
+      } catch (ex) {
+        logger.error(ex);
+      }
+    });
+};

packages/cli/src/commands/register-participants.ts

@@ -1,8 +1,10 @@
 import { Argument, Command } from 'commander';
+import { generate as generatePassword } from 'generate-password';
 
 import { getCsvContent } from '../shared/csv';
-import { insertUsers, register } from '../shared/db';
+import { getUsersByRole, insertUsers, register } from '../shared/db';
 import { validateEnv } from '../shared/env';
+import { createPasswordsList } from '../shared/files';
 import { createLogger } from '../shared/logger';
 import { ParticipantCsvRow, RegisterDTO, User, userRoles } from '../shared/models';
 import { transformToMatchClass } from '../shared/object';
@@ -15,34 +17,47 @@ export const registerParticipants = (program: Command) => {
     .description('Creates accounts for CodersCamp participants listed in the CSV file')
     .addArgument(new Argument('<csv-path>', 'Path to the CSV file'))
     .action(async (csvPath: string) => {
+      const participants: User[] = [];
+      const passwords = createPasswordsList();
+
       try {
         await validateEnv();
 
         const rows = await getCsvContent(csvPath);
         const participantsRows = await Promise.all(rows.map(transformToMatchClass(ParticipantCsvRow)));
-
-        const participants: User[] = [];
+        const currentParticipants = await getUsersByRole(userRoles.participant);
+        const currentParticipantsEmails = currentParticipants.map(({ email }) => email);
 
         logger.debug('Iterating through parsed rows');
 
         for (const { email, firstName, lastName } of participantsRows) {
-          const registerDto = await transformToMatchClass(RegisterDTO)({ email });
-          const userId = await register(registerDto);
-          const participant = await transformToMatchClass(User)({
-            ...registerDto,
-            id: userId,
-            name: `${firstName} ${lastName}`,
-            role: userRoles.participant,
-          });
-
-          participants.push(participant);
+          if (!currentParticipantsEmails.includes(email)) {
+            const password = generatePassword({ length: 16, numbers: true, symbols: true });
+            const registerDto = await transformToMatchClass(RegisterDTO)({ email, password });
+            const userId = await register(registerDto);
+            const participant = await transformToMatchClass(User)({
+              ...registerDto,
+              id: userId,
+              firstName,
+              lastName,
+              role: userRoles.participant,
+            });
+
+            participants.push(participant);
+            passwords.add({ email, password });
+          } else {
+            logger.debug(`Participant with email ${email} already exists in the database`);
+          }
         }
 
         logger.debug('Iteration through parsed rows finished');
 
         await insertUsers(participants);
       } catch (ex) {
         logger.error(ex);
+        logger.info('Already registered participants', participants);
+      } finally {
+        await passwords.save();
       }
     });
 };

packages/cli/src/index.ts

@@ -3,6 +3,7 @@ import 'reflect-metadata';
 import { Command } from 'commander';
 
 import { generateChecklists } from './commands/generate-checklists';
+import { generateWelcomeCsv } from './commands/generate-welcome-csv';
 import { registerParticipants } from './commands/register-participants';
 
 const program = new Command();
@@ -11,5 +12,6 @@ program.version('0.0.0');
 
 registerParticipants(program);
 generateChecklists(program);
+generateWelcomeCsv(program);
 
 program.parse();

packages/cli/src/shared/csv.ts

@@ -1,8 +1,10 @@
-import parse from 'csv-parse/lib/sync';
+import parseFromCsv from 'csv-parse/lib/sync';
 import { readFile } from 'fs/promises';
 
 import { createLogger } from './logger';
 
+export { parse as parseToCsv } from 'json2csv';
+
 const logger = createLogger('CSV Utils');
 
 export const getCsvContent = async (csvPath: string) => {
@@ -12,7 +14,7 @@ export const getCsvContent = async (csvPath: string) => {
 
   logger.debug('parsing content of the CSV file');
 
-  const parsedContent: Record<string, unknown>[] = parse(content, { columns: true });
+  const parsedContent: Record<string, unknown>[] = parseFromCsv(content, { columns: true });
 
   logger.debug('CSV file content parsed successfully');
 

packages/cli/src/shared/db.ts

@@ -1,5 +1,4 @@
 import { createClient } from '@supabase/supabase-js';
-import { generate } from 'generate-password';
 
 import { env } from './env';
 import { createLogger } from './logger';
@@ -14,10 +13,7 @@ const supabase = createClient(env.SUPABASE_URL, env.SUPABASE_ANON_KEY);
 export const register = async (registerDto: RegisterDTO): Promise<User['id']> => {
   logger.debug(`Registering user with email ${registerDto.email}`);
 
-  const { user, error } = await supabase.auth.signUp({
-    email: registerDto.email,
-    password: generate({ length: 16, numbers: true, symbols: true }),
-  });
+  const { user, error } = await supabase.auth.signUp(registerDto);
 
   if (!user) {
     throw error ?? new Error(`Unknown error ocurred when signing up user with email ${registerDto.email}`);

packages/cli/src/shared/env.ts

@@ -1,5 +1,5 @@
 import { Expose, plainToClass } from 'class-transformer';
-import { IsInt, IsNotEmpty, IsString, validateOrReject } from 'class-validator';
+import { IsNotEmpty, IsString, validateOrReject } from 'class-validator';
 import dotenv from 'dotenv';
 
 import { createLogger } from './logger';
@@ -23,26 +23,6 @@ class EnvVariables {
   @IsString()
   @IsNotEmpty()
   PROCESS_ST_CHECKLIST_URL: string;
-
-  @Expose()
-  @IsInt()
-  // @IsNotEmpty()
-  NODEMAILER_PORT: number;
-
-  @Expose()
-  @IsString()
-  // @IsNotEmpty()
-  NODEMAILER_HOST: string;
-
-  @Expose()
-  @IsString()
-  // @IsNotEmpty()
-  NODEMAILER_USER: string;
-
-  @Expose()
-  @IsString()
-  // @IsNotEmpty()
-  NODEMAILER_PASSWORD: string;
 }
 
 export const env = plainToClass(EnvVariables, process.env, {

packages/cli/src/shared/files.ts

@@ -0,0 +1,43 @@
+import { existsSync } from 'fs';
+import { mkdir, writeFile } from 'fs/promises';
+
+import { createLogger } from './logger';
+
+const logger = createLogger('Files Utils');
+
+const createOutputDir = async () => {
+  if (!existsSync('output')) {
+    await mkdir('output');
+  }
+};
+
+export const createPasswordsList = () => {
+  const passwords: Record<string, string> = {};
+
+  const add = ({ email, password }: { email: string; password: string }) => {
+    logger.debug(`Adding password for email ${email}`);
+    passwords[email] = password;
+  };
+
+  const save = async () => {
+    await createOutputDir();
+
+    const path = 'output/passwords.json';
+
+    logger.debug(`Saving passwords object to ${path}`);
+    await writeFile(path, JSON.stringify(passwords), 'utf-8');
+    logger.debug('Passwords saved successfully');
+  };
+
+  return { add, save };
+};
+
+export const createWelcomeCsv = async (csv: string) => {
+  await createOutputDir();
+
+  const path = 'output/welcome.csv';
+
+  logger.debug(`Saving welcome CSV to ${path}`);
+  await writeFile(path, csv, 'utf-8');
+  logger.debug('Welcome CSV saved successfully');
+};

packages/cli/src/shared/models.ts

@@ -33,6 +33,11 @@ export class RegisterDTO {
   @IsEmail()
   @IsNotEmpty()
   email: string;
+
+  @Expose()
+  @IsString()
+  @IsNotEmpty()
+  password: string;
 }
 
 export class User {
@@ -49,7 +54,12 @@ export class User {
   @Expose()
   @IsString()
   @IsNotEmpty()
-  name: string;
+  firstName: string;
+
+  @Expose()
+  @IsString()
+  @IsNotEmpty()
+  lastName: string;
 
   @Expose()
   @IsUrl()
@@ -60,3 +70,20 @@ export class User {
   @IsIn(Object.values(userRoles))
   role: Role;
 }
+
+export class WelcomeCsvRow {
+  @Expose()
+  @IsString()
+  @IsNotEmpty()
+  firstName: string;
+
+  @Expose()
+  @IsEmail()
+  @IsNotEmpty()
+  email: string;
+
+  @Expose()
+  @IsUrl()
+  @IsNotEmpty()
+  checklist: string;
+}

packages/cli/src/shared/object.ts

@@ -1,15 +1,15 @@
 import { ClassConstructor, plainToClass } from 'class-transformer';
 import { validateOrReject } from 'class-validator';
 
-import type { AnyObject, UnknownObject } from '@coderscamp/shared/types';
+import type { AnyObject } from '@coderscamp/shared/types';
 
 import { createLogger } from './logger';
 
 const logger = createLogger('Object utils');
 
 export const transformToMatchClass =
   <ClassInstance extends AnyObject>(cls: ClassConstructor<ClassInstance>) =>
-  async <Obj extends UnknownObject | ClassInstance>(obj: Obj): Promise<ClassInstance> => {
+  async <Obj extends AnyObject | ClassInstance>(obj: Obj): Promise<ClassInstance> => {
     logger.debug(`Transforming object to match the ${cls.name} class`, obj);
 
     const result = plainToClass(cls, obj, { excludeExtraneousValues: true, enableImplicitConversion: true });

packages/cli/test.csv

@@ -0,0 +1,3 @@
+firstName,lastName,email
+John,Dow,[email protected]
+Edna,Edwards,[email protected]