feat: add classrooms functionalities (get, add, edit, delete)

Author: pyphilia

public/app/config/channels.js

@@ -52,4 +52,11 @@ module.exports = {
   SET_USER_MODE_CHANNEL: 'user:mode:set',
   SET_SPACE_AS_FAVORITE_CHANNEL: 'user:set-space-favorite:set',
   SET_SPACE_AS_RECENT_CHANNEL: 'user:set-space-recent:set',
+  GET_CLASSROOMS_CHANNEL: 'teacher-board:classrooms:get',
+  ADD_CLASSROOM_CHANNEL: 'teacher-board:classroom:add',
+  DELETE_CLASSROOM_CHANNEL: 'teacher-board:classroom:delete',
+  SHOW_DELETE_CLASSROOM_PROMPT_CHANNEL: 'prompt:classroom:delete:show',
+  RESPOND_DELETE_CLASSROOM_PROMPT_CHANNEL: 'prompt:classroom:delete:respond',
+  EDIT_CLASSROOM_CHANNEL: 'teacher-board:classroom:edit',
+  GET_CLASSROOM_CHANNEL: 'teacher-board:classroom:get',
 };

public/app/config/errors.js

@@ -6,11 +6,13 @@ const ERROR_JSON_CORRUPTED = 'ERROR_JSON_CORRUPTED';
 const ERROR_SPACE_ALREADY_AVAILABLE = 'ERROR_SPACE_ALREADY_AVAILABLE';
 const ERROR_DOWNLOADING_FILE = 'ERROR_DOWNLOADING_FILE';
 const ERROR_GENERAL = 'ERROR_GENERAL';
+const ERROR_DUPLICATE_CLASSROOM_NAME = 'ERROR_DUPLICATE_CLASSROOM_NAME';
 
 module.exports = {
   ERROR_ZIP_CORRUPTED,
   ERROR_JSON_CORRUPTED,
   ERROR_SPACE_ALREADY_AVAILABLE,
   ERROR_DOWNLOADING_FILE,
   ERROR_GENERAL,
+  ERROR_DUPLICATE_CLASSROOM_NAME,
 };

public/app/config/messages.js

@@ -66,6 +66,22 @@ const ERROR_SETTING_SPACE_AS_RECENT =
 const ERROR_STUDENT_LOAD_OUT_OF_DATE_SPACE_MESSAGE =
   'The space contained in this file is out of date. Ask your teacher for more information.';
 const ERROR_STUDENT_FORBIDDEN_MESSAGE = 'Students cannot access this page';
+const ERROR_ADDING_CLASSROOM_MESSAGE =
+  'There was an error adding the classroom';
+const ERROR_DUPLICATE_CLASSROOM_NAME_MESSAGE =
+  'This classroom name already exists';
+const SUCCESS_ADDING_CLASSROOM_MESSAGE =
+  'The classroom was successfully created';
+const SUCCESS_DELETING_CLASSROOM_MESSAGE =
+  'The classroom was successfully deleted';
+const ERROR_DELETING_CLASSROOM_MESSAGE =
+  'There was an error deleting this classroom';
+const ERROR_EDITING_CLASSROOM_MESSAGE =
+  'There was an error editing this classroom';
+const SUCCESS_EDITING_CLASSROOM_MESSAGE =
+  'The classroom was successfully edited';
+const ERROR_GETTING_CLASSROOM_MESSAGE =
+  'There was an error getting the classroom';
 
 module.exports = {
   ERROR_GETTING_DEVELOPER_MODE,
@@ -116,4 +132,12 @@ module.exports = {
   ERROR_SETTING_SPACE_AS_RECENT,
   ERROR_STUDENT_LOAD_OUT_OF_DATE_SPACE_MESSAGE,
   ERROR_STUDENT_FORBIDDEN_MESSAGE,
+  ERROR_ADDING_CLASSROOM_MESSAGE,
+  ERROR_DUPLICATE_CLASSROOM_NAME_MESSAGE,
+  SUCCESS_ADDING_CLASSROOM_MESSAGE,
+  SUCCESS_DELETING_CLASSROOM_MESSAGE,
+  ERROR_DELETING_CLASSROOM_MESSAGE,
+  ERROR_EDITING_CLASSROOM_MESSAGE,
+  SUCCESS_EDITING_CLASSROOM_MESSAGE,
+  ERROR_GETTING_CLASSROOM_MESSAGE,
 };

public/app/db.js

@@ -12,6 +12,7 @@ const SPACES_COLLECTION = 'spaces';
 const ACTIONS_COLLECTION = 'actions';
 const USERS_COLLECTION = 'users';
 const APP_INSTANCE_RESOURCES_COLLECTION = 'appInstanceResources';
+const CLASSROOMS_COLLECTION = 'classrooms';
 
 // bootstrap database
 const ensureDatabaseExists = async (dbPath = DATABASE_PATH) => {
@@ -39,6 +40,7 @@ const bootstrapDatabase = (dbPath = DATABASE_PATH) => {
     user: { lang: DEFAULT_LANG },
     [ACTIONS_COLLECTION]: [],
     [APP_INSTANCE_RESOURCES_COLLECTION]: [],
+    [CLASSROOMS_COLLECTION]: [],
   }).write();
   return db;
 };
@@ -48,6 +50,7 @@ module.exports = {
   USERS_COLLECTION,
   APP_INSTANCE_RESOURCES_COLLECTION,
   ACTIONS_COLLECTION,
+  CLASSROOMS_COLLECTION,
   ensureDatabaseExists,
   bootstrapDatabase,
 };

public/app/listeners/addClassroom.js

@@ -0,0 +1,62 @@
+const ObjectId = require('bson-objectid');
+const { ADD_CLASSROOM_CHANNEL } = require('../config/channels');
+const {
+  ERROR_GENERAL,
+  ERROR_DUPLICATE_CLASSROOM_NAME,
+} = require('../config/errors');
+const {
+  CLASSROOMS_COLLECTION,
+  SPACES_COLLECTION,
+  APP_INSTANCE_RESOURCES_COLLECTION,
+  ACTIONS_COLLECTION,
+  USERS_COLLECTION,
+} = require('../db');
+const logger = require('../logger');
+
+const DEFAULT_CLASSROOM = {
+  [SPACES_COLLECTION]: [],
+  [APP_INSTANCE_RESOURCES_COLLECTION]: [],
+  [ACTIONS_COLLECTION]: [],
+  [USERS_COLLECTION]: [],
+};
+
+const addClassroom = (mainWindow, db) => async (event, { name, userId }) => {
+  logger.debug('adding a classroom');
+
+  try {
+    // check name does not already exists
+    const found = db
+      .get(CLASSROOMS_COLLECTION)
+      .find({ name })
+      .value();
+    if (found) {
+      mainWindow.webContents.send(
+        ADD_CLASSROOM_CHANNEL,
+        ERROR_DUPLICATE_CLASSROOM_NAME
+      );
+    }
+
+    // create new classroom
+    const id = ObjectId().str;
+    const now = new Date();
+    const newClassroom = {
+      ...DEFAULT_CLASSROOM,
+      id,
+      name,
+      createdAt: now,
+      lastUpdatedAt: now,
+      teacherId: userId,
+    };
+
+    db.get(CLASSROOMS_COLLECTION)
+      .push(newClassroom)
+      .write();
+
+    mainWindow.webContents.send(ADD_CLASSROOM_CHANNEL, newClassroom);
+  } catch (err) {
+    logger.error(err);
+    mainWindow.webContents.send(ADD_CLASSROOM_CHANNEL, ERROR_GENERAL);
+  }
+};
+
+module.exports = addClassroom;

public/app/listeners/deleteClassroom.js

@@ -0,0 +1,26 @@
+const { CLASSROOMS_COLLECTION } = require('../db');
+const { DELETE_CLASSROOM_CHANNEL } = require('../config/channels');
+const { ERROR_GENERAL } = require('../config/errors');
+const logger = require('../logger');
+
+const deleteClassroomAndResources = (db, id) => {
+  db.get(CLASSROOMS_COLLECTION)
+    .remove({ id })
+    .write();
+
+  // todo: remove containing spaces
+};
+
+const deleteClassroom = (mainWindow, db) => async (event, { id }) => {
+  logger.debug('deleting classroom');
+
+  try {
+    deleteClassroomAndResources(db, id);
+    mainWindow.webContents.send(DELETE_CLASSROOM_CHANNEL);
+  } catch (err) {
+    logger.error(err);
+    mainWindow.webContents.send(DELETE_CLASSROOM_CHANNEL, ERROR_GENERAL);
+  }
+};
+
+module.exports = deleteClassroom;

public/app/listeners/editClassroom.js

@@ -0,0 +1,29 @@
+const { EDIT_CLASSROOM_CHANNEL } = require('../config/channels');
+const { ERROR_GENERAL } = require('../config/errors');
+const { CLASSROOMS_COLLECTION } = require('../db');
+const logger = require('../logger');
+
+const editClassroom = (mainWindow, db) => async (event, { name, id }) => {
+  logger.debug('editing classroom');
+
+  try {
+    const classroom = db.get(CLASSROOMS_COLLECTION).find({ id });
+
+    // check classroom exists
+    const found = classroom.value();
+    if (!found) {
+      mainWindow.webContents.send(EDIT_CLASSROOM_CHANNEL, ERROR_GENERAL);
+    }
+
+    // update data
+    const now = new Date();
+    classroom.assign({ name, lastUpdatedAt: now }).write();
+
+    mainWindow.webContents.send(EDIT_CLASSROOM_CHANNEL);
+  } catch (err) {
+    logger.error(err);
+    mainWindow.webContents.send(EDIT_CLASSROOM_CHANNEL, ERROR_GENERAL);
+  }
+};
+
+module.exports = editClassroom;

public/app/listeners/getClassroom.js

@@ -0,0 +1,21 @@
+const { GET_CLASSROOM_CHANNEL } = require('../config/channels');
+const logger = require('../logger');
+const { CLASSROOMS_COLLECTION } = require('../db');
+
+const getClassroom = (mainWindow, db) => async (event, { id }) => {
+  try {
+    // todo: check teacher can access this classroom
+
+    // get classroom from local db
+    const classroom = db
+      .get(CLASSROOMS_COLLECTION)
+      .find({ id })
+      .value();
+    mainWindow.webContents.send(GET_CLASSROOM_CHANNEL, classroom);
+  } catch (err) {
+    logger.error(err);
+    mainWindow.webContents.send(GET_CLASSROOM_CHANNEL, null);
+  }
+};
+
+module.exports = getClassroom;

public/app/listeners/getClassrooms.js

@@ -0,0 +1,17 @@
+const { GET_CLASSROOMS_CHANNEL } = require('../config/channels');
+const logger = require('../logger');
+const { CLASSROOMS_COLLECTION } = require('../db');
+const { ERROR_GENERAL } = require('../config/errors');
+
+const getClassrooms = (mainWindow, db) => async () => {
+  try {
+    // get handle to spaces collection
+    const classrooms = db.get(CLASSROOMS_COLLECTION).value();
+    mainWindow.webContents.send(GET_CLASSROOMS_CHANNEL, classrooms);
+  } catch (e) {
+    logger.error(e);
+    mainWindow.webContents.send(GET_CLASSROOMS_CHANNEL, ERROR_GENERAL);
+  }
+};
+
+module.exports = getClassrooms;

public/app/listeners/index.js

@@ -35,6 +35,12 @@ const patchAppInstanceResource = require('./patchAppInstanceResource');
 const getAppInstance = require('./getAppInstance');
 const setSpaceAsFavorite = require('./setSpaceAsFavorite');
 const setSpaceAsRecent = require('./setSpaceAsRecent');
+const addClassroom = require('./addClassroom');
+const getClassrooms = require('./getClassrooms');
+const deleteClassroom = require('./deleteClassroom');
+const editClassroom = require('./editClassroom');
+const showDeleteClassroomPrompt = require('./showDeleteClassroomPrompt');
+const getClassroom = require('./getClassroom');
 
 module.exports = {
   loadSpace,
@@ -73,4 +79,10 @@ module.exports = {
   setUserMode,
   setSpaceAsFavorite,
   setSpaceAsRecent,
+  addClassroom,
+  deleteClassroom,
+  editClassroom,
+  getClassrooms,
+  getClassroom,
+  showDeleteClassroomPrompt,
 };

public/app/listeners/showDeleteClassroomPrompt.js

@@ -0,0 +1,27 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+const { dialog } = require('electron');
+const {
+  RESPOND_DELETE_CLASSROOM_PROMPT_CHANNEL,
+} = require('../config/channels');
+const logger = require('../logger');
+
+const showDeleteClassroomPrompt = mainWindow => () => {
+  logger.debug('showing delete classroom prompt');
+
+  const options = {
+    type: 'warning',
+    buttons: ['Cancel', 'Delete'],
+    defaultId: 0,
+    cancelId: 0,
+    message: 'Are you sure you want to delete this classroom?',
+  };
+
+  dialog.showMessageBox(mainWindow, options).then(({ response }) => {
+    mainWindow.webContents.send(
+      RESPOND_DELETE_CLASSROOM_PROMPT_CHANNEL,
+      response
+    );
+  });
+};
+
+module.exports = showDeleteClassroomPrompt;

public/electron.js

@@ -60,6 +60,12 @@ const {
   SET_SPACE_AS_RECENT_CHANNEL,
   EXTRACT_FILE_TO_LOAD_SPACE_CHANNEL,
   CLEAR_LOAD_SPACE_CHANNEL,
+  ADD_CLASSROOM_CHANNEL,
+  GET_CLASSROOMS_CHANNEL,
+  DELETE_CLASSROOM_CHANNEL,
+  SHOW_DELETE_CLASSROOM_PROMPT_CHANNEL,
+  EDIT_CLASSROOM_CHANNEL,
+  GET_CLASSROOM_CHANNEL,
 } = require('./app/config/channels');
 const env = require('./env.json');
 const {
@@ -98,6 +104,12 @@ const {
   setSpaceAsRecent,
   clearLoadSpace,
   extractFileToLoadSpace,
+  addClassroom,
+  getClassrooms,
+  deleteClassroom,
+  showDeleteClassroomPrompt,
+  editClassroom,
+  getClassroom,
 } = require('./app/listeners');
 const isMac = require('./app/utils/isMac');
 
@@ -477,6 +489,27 @@ app.on('ready', async () => {
   // called when getting an AppInstance
   ipcMain.on(GET_APP_INSTANCE_CHANNEL, getAppInstance(mainWindow, db));
 
+  // called when getting classrooms
+  ipcMain.on(GET_CLASSROOMS_CHANNEL, getClassrooms(mainWindow, db));
+
+  // called when getting a classroom
+  ipcMain.on(GET_CLASSROOM_CHANNEL, getClassroom(mainWindow, db));
+
+  // called when adding a classroom
+  ipcMain.on(ADD_CLASSROOM_CHANNEL, addClassroom(mainWindow, db));
+
+  // called when editing a classroom
+  ipcMain.on(EDIT_CLASSROOM_CHANNEL, editClassroom(mainWindow, db));
+
+  // prompt when deleting a classroom
+  ipcMain.on(
+    SHOW_DELETE_CLASSROOM_PROMPT_CHANNEL,
+    showDeleteClassroomPrompt(mainWindow, db)
+  );
+
+  // called when deleting a classroom
+  ipcMain.on(DELETE_CLASSROOM_CHANNEL, deleteClassroom(mainWindow, db));
+
   // called when getting the database
   ipcMain.on(GET_DATABASE_CHANNEL, async () => {
     try {