Merge branch 'develop' into refactor/AddToCollectionSketchList

Author: raclim

client/modules/IDE/components/About.jsx

@@ -28,7 +28,7 @@ function About(props) {
         />
         <div className="about__content-column">
           <p className="about__version-info">
-            Web Editor: <span>v{packageData?.version}</span>
+            {t('About.WebEditor')}: <span>v{packageData?.version}</span>
           </p>
           <p className="about__version-info">
             p5.js: <span>v{p5version}</span>
@@ -44,7 +44,7 @@ function About(props) {
               aria-hidden="true"
               focusable="false"
             />
-            Home
+            {t('About.Home')}
           </a>
         </p>
         <p className="about__content-column-list">
@@ -86,7 +86,7 @@ function About(props) {
               aria-hidden="true"
               focusable="false"
             />
-            Twitter
+            {t('About.Twitter')}
           </a>
         </p>
         <p className="about__content-column-list">
@@ -100,7 +100,7 @@ function About(props) {
               aria-hidden="true"
               focusable="false"
             />
-            Instagram
+            {t('About.Instagram')}
           </a>
         </p>
       </div>
@@ -159,7 +159,7 @@ function About(props) {
               aria-hidden="true"
               focusable="false"
             />
-            Discord
+            {t('About.Discord')}
           </a>
         </p>
         <p className="about__content-column-list">

server/controllers/collection.controller/collectionForUserExists.js

@@ -1,30 +1,17 @@
 import Collection from '../../models/collection';
 import User from '../../models/user';
 
-export default function collectionForUserExists(
-  username,
-  collectionId,
-  callback
-) {
-  function sendFailure() {
-    callback(false);
-  }
-
-  function sendSuccess(collection) {
-    callback(collection != null);
-  }
-
-  function findUser() {
-    return User.findByUsername(username);
-  }
-
-  function findCollection(owner) {
-    if (owner == null) {
-      throw new Error('User not found');
-    }
-
-    return Collection.findOne({ _id: collectionId, owner });
-  }
-
-  return findUser().then(findCollection).then(sendSuccess).catch(sendFailure);
+/**
+ * @param {string} username
+ * @param {string} collectionId
+ * @return {Promise<boolean>}
+ */
+export default async function collectionForUserExists(username, collectionId) {
+  const user = await User.findByUsername(username);
+  if (!user) return false;
+  const collection = await Collection.findOne({
+    _id: collectionId,
+    owner: user
+  }).exec();
+  return collection != null;
 }

server/controllers/project.controller.js

@@ -169,29 +169,28 @@ export function getProjects(req, res) {
   }
 }
 
-export function projectExists(projectId, callback) {
-  Project.findById(projectId, (err, project) =>
-    project ? callback(true) : callback(false)
-  );
+/**
+ * @param {string} projectId
+ * @return {Promise<boolean>}
+ */
+export async function projectExists(projectId) {
+  const project = await Project.findById(projectId);
+  return project != null;
 }
 
-export function projectForUserExists(username, projectId, callback) {
-  User.findByUsername(username, (err, user) => {
-    if (!user) {
-      callback(false);
-      return;
-    }
-    Project.findOne(
-      { user: user._id, $or: [{ _id: projectId }, { slug: projectId }] },
-      (innerErr, project) => {
-        if (!project) {
-          callback(false);
-          return;
-        }
-        callback(true);
-      }
-    );
+/**
+ * @param {string} username
+ * @param {string} projectId
+ * @return {Promise<boolean>}
+ */
+export async function projectForUserExists(username, projectId) {
+  const user = await User.findByUsername(username);
+  if (!user) return false;
+  const project = await Project.findOne({
+    user: user._id,
+    $or: [{ _id: projectId }, { slug: projectId }]
   });
+  return project != null;
 }
 
 function bundleExternalLibs(project) {
@@ -215,48 +214,27 @@ function bundleExternalLibs(project) {
   });
 }
 
-function addFileToZip(file, files, zip, path = '') {
-  return new Promise((resolve, reject) => {
-    if (file.fileType === 'folder') {
-      const newPath = file.name === 'root' ? path : `${path}${file.name}/`;
-      const numChildFiles = file.children.filter((f) => f.fileType !== 'folder')
-        .length;
-      let childrenAdded = 0;
-      if (numChildFiles === 0) {
-        zip.folder(file.name);
-        resolve();
-      }
-      file.children.forEach(async (fileId) => {
+async function addFileToZip(file, files, zip) {
+  if (file.fileType === 'folder') {
+    const folderZip = file.name === 'root' ? zip : zip.folder(file.name);
+    await Promise.all(
+      file.children.map((fileId) => {
         const childFile = files.find((f) => f.id === fileId);
-
-        try {
-          await addFileToZip(childFile, files, zip, newPath);
-          childrenAdded += 1;
-
-          if (childrenAdded === numChildFiles) {
-            resolve();
-          }
-        } catch (err) {
-          reject(err);
-        }
+        return addFileToZip(childFile, files, folderZip);
+      })
+    );
+  } else if (file.url) {
+    try {
+      const res = await axios.get(file.url, {
+        responseType: 'arraybuffer'
       });
-    } else if (file.url) {
-      axios
-        .get(file.url, {
-          responseType: 'arraybuffer'
-        })
-        .then(({ data }) => {
-          zip.file(`${path}${file.name}`, data);
-          resolve();
-        })
-        .catch((err) => {
-          reject(err);
-        });
-    } else {
-      zip.file(`${path}${file.name}`, file.content);
-      resolve();
+      zip.file(file.name, res.data);
+    } catch (e) {
+      zip.file(file.name, new ArrayBuffer(0));
     }
-  });
+  } else {
+    zip.file(file.name, file.content);
+  }
 }
 
 async function buildZip(project, req, res) {

server/controllers/project.controller/__test__/getProjectsForUser.test.js

@@ -23,16 +23,18 @@ describe('project.controller', () => {
   });
 
   describe('getProjectsForUser()', () => {
-    it('returns empty array user not supplied as parameter', (done) => {
+    it('returns validation error if username not provided', (done) => {
       const request = new Request();
       request.setParams({});
       const response = new Response();
 
       const promise = getProjectsForUser(request, response);
 
       function expectations() {
-        expect(response.status).toHaveBeenCalledWith(200);
-        expect(response.json).toHaveBeenCalledWith([]);
+        expect(response.status).toHaveBeenCalledWith(422);
+        expect(response.json).toHaveBeenCalledWith({
+          message: 'Username not provided'
+        });
 
         done();
       }
@@ -47,7 +49,7 @@ describe('project.controller', () => {
 
       UserMock.expects('findOne')
         .withArgs({ username: 'abc123' })
-        .yields(null, null);
+        .resolves(null);
 
       const promise = getProjectsForUser(request, response);
 
@@ -70,15 +72,15 @@ describe('project.controller', () => {
 
       UserMock.expects('findOne')
         .withArgs({ username: 'abc123' })
-        .yields(new Error(), null);
+        .rejects(new Error());
 
       const promise = getProjectsForUser(request, response);
 
       function expectations() {
-        expect(response.status).toHaveBeenCalledWith(500);
         expect(response.json).toHaveBeenCalledWith({
           message: 'Error fetching projects'
         });
+        expect(response.status).toHaveBeenCalledWith(500);
 
         done();
       }
@@ -88,7 +90,7 @@ describe('project.controller', () => {
   });
 
   describe('apiGetProjectsForUser()', () => {
-    it('returns validation error if user id not provided', (done) => {
+    it('returns validation error if username not provided', (done) => {
       const request = new Request();
       request.setParams({});
       const response = new Response();
@@ -114,7 +116,7 @@ describe('project.controller', () => {
 
       UserMock.expects('findOne')
         .withArgs({ username: 'abc123' })
-        .yields(null, null);
+        .resolves(null);
 
       const promise = apiGetProjectsForUser(request, response);
 
@@ -137,7 +139,7 @@ describe('project.controller', () => {
 
       UserMock.expects('findOne')
         .withArgs({ username: 'abc123' })
-        .yields(new Error(), null);
+        .rejects(new Error());
 
       const promise = apiGetProjectsForUser(request, response);
 

server/controllers/project.controller/getProjectsForUser.js

@@ -1,76 +1,47 @@
 import Project from '../../models/project';
 import User from '../../models/user';
 import { toApi as toApiProjectObject } from '../../domain-objects/Project';
-import createApplicationErrorClass from '../../utils/createApplicationErrorClass';
 
-const UserNotFoundError = createApplicationErrorClass('UserNotFoundError');
-
-function getProjectsForUserName(username) {
-  return new Promise((resolve, reject) => {
-    User.findByUsername(username, (err, user) => {
-      if (err) {
-        reject(err);
-        return;
-      }
-
-      if (!user) {
-        reject(new UserNotFoundError());
-        return;
-      }
-
-      Project.find({ user: user._id })
-        .sort('-createdAt')
-        .select('name files id createdAt updatedAt')
-        .exec((innerErr, projects) => {
-          if (innerErr) {
-            reject(innerErr);
-            return;
-          }
-
-          resolve(projects);
-        });
-    });
-  });
-}
-
-export default function getProjectsForUser(req, res) {
-  if (req.params.username) {
-    return getProjectsForUserName(req.params.username)
-      .then((projects) => res.json(projects))
-      .catch((err) => {
-        if (err instanceof UserNotFoundError) {
-          res
-            .status(404)
-            .json({ message: 'User with that username does not exist.' });
-        } else {
-          res.status(500).json({ message: 'Error fetching projects' });
-        }
-      });
+/**
+ * Fetches projects for the username in the request.
+ * Handles errors.
+ * Returns a success response based on the provided `mapProjectsToResponse` function.
+ */
+const createCoreHandler = (mapProjectsToResponse) => async (req, res) => {
+  try {
+    const { username } = req.params;
+    if (!username) {
+      res.status(422).json({ message: 'Username not provided' });
+      return;
+    }
+    const user = await User.findByUsername(username);
+    if (!user) {
+      res
+        .status(404)
+        .json({ message: 'User with that username does not exist.' });
+      return;
+    }
+    const projects = await Project.find({ user: user._id })
+      .sort('-createdAt')
+      .select('name files id createdAt updatedAt')
+      .exec();
+    const response = mapProjectsToResponse(projects);
+    res.json(response);
+  } catch (e) {
+    res.status(500).json({ message: 'Error fetching projects' });
   }
-
-  // could just move this to client side
-  res.status(200).json([]);
-  return Promise.resolve();
-}
-
-export function apiGetProjectsForUser(req, res) {
-  if (req.params.username) {
-    return getProjectsForUserName(req.params.username)
-      .then((projects) => {
-        const asApiObjects = projects.map((p) => toApiProjectObject(p));
-        res.json({ sketches: asApiObjects });
-      })
-      .catch((err) => {
-        if (err instanceof UserNotFoundError) {
-          res
-            .status(404)
-            .json({ message: 'User with that username does not exist.' });
-        } else {
-          res.status(500).json({ message: 'Error fetching projects' });
-        }
-      });
-  }
-
-  res.status(422).json({ message: 'Username not provided' });
-  return Promise.resolve();
-}
+};
+
+/**
+ * Main handler returns an array of project objects.
+ */
+const getProjectsForUser = createCoreHandler((projects) => projects);
+export default getProjectsForUser;
+
+/**
+ * Handler for the public API returns an object with property `sketches`.
+ * The array of sketches contains the `id` and `name` only.
+ */
+export const apiGetProjectsForUser = createCoreHandler((projects) => ({
+  sketches: projects.map((p) => toApiProjectObject(p))
+}));