feat: Trello board JSON import (#352)

Closes #27, closes #105

client/src/api/boards.js

@@ -1,4 +1,5 @@
 import socket from './socket';
+import http from './http';
 import { transformCard } from './cards';
 import { transformAttachment } from './attachments';
 
@@ -7,6 +8,9 @@ import { transformAttachment } from './attachments';
 const createBoard = (projectId, data, headers) =>
   socket.post(`/projects/${projectId}/boards`, data, headers);
 
+const createBoardWithImport = (projectId, data, requestId, headers) =>
+  http.post(`/projects/${projectId}/boards?requestId=${requestId}`, data, headers);
+
 const getBoard = (id, headers) =>
   socket.get(`/boards/${id}`, undefined, headers).then((body) => ({
     ...body,
@@ -23,6 +27,7 @@ const deleteBoard = (id, headers) => socket.delete(`/boards/${id}`, undefined, h
 
 export default {
   createBoard,
+  createBoardWithImport,
   getBoard,
   updateBoard,
   deleteBoard,

client/src/components/Boards/AddPopup.jsx

@@ -1,70 +0,0 @@
-import React, { useCallback, useEffect, useRef } from 'react';
-import PropTypes from 'prop-types';
-import { useTranslation } from 'react-i18next';
-import { Button, Form } from 'semantic-ui-react';
-import { withPopup } from '../../lib/popup';
-import { Input, Popup } from '../../lib/custom-ui';
-
-import { useForm } from '../../hooks';
-
-import styles from './AddPopup.module.scss';
-
-const AddStep = React.memo(({ onCreate, onClose }) => {
-  const [t] = useTranslation();
-
-  const [data, handleFieldChange] = useForm({
-    name: '',
-  });
-
-  const nameField = useRef(null);
-
-  const handleSubmit = useCallback(() => {
-    const cleanData = {
-      ...data,
-      type: 'kanban',
-      name: data.name.trim(),
-    };
-
-    if (!cleanData.name) {
-      nameField.current.select();
-      return;
-    }
-
-    onCreate(cleanData);
-    onClose();
-  }, [onCreate, onClose, data]);
-
-  useEffect(() => {
-    nameField.current.focus();
-  }, []);
-
-  return (
-    <>
-      <Popup.Header>
-        {t('common.createBoard', {
-          context: 'title',
-        })}
-      </Popup.Header>
-      <Popup.Content>
-        <Form onSubmit={handleSubmit}>
-          <Input
-            fluid
-            ref={nameField}
-            name="name"
-            value={data.name}
-            className={styles.field}
-            onChange={handleFieldChange}
-          />
-          <Button positive content={t('action.createBoard')} />
-        </Form>
-      </Popup.Content>
-    </>
-  );
-});
-
-AddStep.propTypes = {
-  onCreate: PropTypes.func.isRequired,
-  onClose: PropTypes.func.isRequired,
-};
-
-export default withPopup(AddStep);

client/src/components/Boards/AddPopup.module.scss

@@ -1,5 +0,0 @@
-:global(#app) {
-  .field {
-    margin-bottom: 8px;
-  }
-}

client/src/components/Boards/AddPopup/AddPopup.jsx

@@ -0,0 +1,116 @@
+import React, { useCallback, useEffect, useRef } from 'react';
+import PropTypes from 'prop-types';
+import { useTranslation } from 'react-i18next';
+import { Button, Form, Icon } from 'semantic-ui-react';
+import { useDidUpdate, useToggle } from '../../../lib/hooks';
+import { withPopup } from '../../../lib/popup';
+import { Input, Popup } from '../../../lib/custom-ui';
+
+import { useForm, useSteps } from '../../../hooks';
+import ImportStep from './ImportStep';
+
+import styles from './AddPopup.module.scss';
+
+const StepTypes = {
+  IMPORT: 'IMPORT',
+};
+
+const AddStep = React.memo(({ onCreate, onClose }) => {
+  const [t] = useTranslation();
+
+  const [data, handleFieldChange, setData] = useForm({
+    name: '',
+    import: null,
+  });
+
+  const [step, openStep, handleBack] = useSteps();
+  const [focusNameFieldState, focusNameField] = useToggle();
+
+  const nameField = useRef(null);
+
+  const handleImportSelect = useCallback(
+    (nextImport) => {
+      setData((prevData) => ({
+        ...prevData,
+        import: nextImport,
+      }));
+    },
+    [setData],
+  );
+
+  const handleImportBack = useCallback(() => {
+    handleBack();
+    focusNameField();
+  }, [handleBack, focusNameField]);
+
+  const handleSubmit = useCallback(() => {
+    const cleanData = {
+      ...data,
+      type: 'kanban',
+      name: data.name.trim(),
+    };
+
+    if (!cleanData.name) {
+      nameField.current.select();
+      return;
+    }
+
+    onCreate(cleanData);
+    onClose();
+  }, [onClose, data, onCreate]);
+
+  const handleImportClick = useCallback(() => {
+    openStep(StepTypes.IMPORT);
+  }, [openStep]);
+
+  useEffect(() => {
+    nameField.current.focus();
+  }, []);
+
+  useDidUpdate(() => {
+    nameField.current.focus();
+  }, [focusNameFieldState]);
+
+  if (step && step.type === StepTypes.IMPORT) {
+    return <ImportStep onSelect={handleImportSelect} onBack={handleImportBack} />;
+  }
+
+  return (
+    <>
+      <Popup.Header>
+        {t('common.createBoard', {
+          context: 'title',
+        })}
+      </Popup.Header>
+      <Popup.Content>
+        <Form onSubmit={handleSubmit}>
+          <Input
+            fluid
+            ref={nameField}
+            name="name"
+            value={data.name}
+            className={styles.field}
+            onChange={handleFieldChange}
+          />
+          <div className={styles.controls}>
+            <Button positive content={t('action.createBoard')} className={styles.createButton} />
+            <Button type="button" className={styles.importButton} onClick={handleImportClick}>
+              <Icon
+                name={data.import ? data.import.type : 'arrow down'}
+                className={styles.importButtonIcon}
+              />
+              {data.import ? data.import.file.name : t('action.import')}
+            </Button>
+          </div>
+        </Form>
+      </Popup.Content>
+    </>
+  );
+});
+
+AddStep.propTypes = {
+  onCreate: PropTypes.func.isRequired,
+  onClose: PropTypes.func.isRequired,
+};
+
+export default withPopup(AddStep);

client/src/components/Boards/AddPopup/AddPopup.module.scss

@@ -0,0 +1,42 @@
+:global(#app) {
+  .controls {
+    display: flex;
+    max-width: 280px;
+
+    @media only screen and (max-width: 767px) {
+      max-width: 226px;
+    }
+  }
+
+  .createButton {
+    white-space: nowrap;
+  }
+
+  .field {
+    margin-bottom: 8px;
+  }
+
+  .importButton {
+    background: transparent;
+    box-shadow: none;
+    color: #6b808c;
+    font-weight: normal;
+    margin-left: auto;
+    margin-right: 0;
+    overflow: hidden;
+    text-align: left;
+    text-decoration: underline;
+    text-overflow: ellipsis;
+    transition: none;
+    white-space: nowrap;
+
+    &:hover {
+      background: rgba(9, 30, 66, 0.08);
+      color: #092d42;
+    }
+  }
+
+  .importButtonIcon {
+    text-decoration: none;
+  }
+}

client/src/components/Boards/AddPopup/ImportStep.jsx

@@ -0,0 +1,51 @@
+import React, { useCallback } from 'react';
+import PropTypes from 'prop-types';
+import { useTranslation } from 'react-i18next';
+import { Button } from 'semantic-ui-react';
+import { FilePicker, Popup } from '../../../lib/custom-ui';
+
+import styles from './ImportStep.module.scss';
+
+const ImportStep = React.memo(({ onSelect, onBack }) => {
+  const [t] = useTranslation();
+
+  const handleFileSelect = useCallback(
+    (type, file) => {
+      onSelect({
+        type,
+        file,
+      });
+
+      onBack();
+    },
+    [onSelect, onBack],
+  );
+
+  return (
+    <>
+      <Popup.Header onBack={onBack}>
+        {t('common.importBoard', {
+          context: 'title',
+        })}
+      </Popup.Header>
+      <Popup.Content>
+        <FilePicker onSelect={(file) => handleFileSelect('trello', file)} accept=".json">
+          <Button
+            fluid
+            type="button"
+            icon="trello"
+            content={t('common.fromTrello')}
+            className={styles.button}
+          />
+        </FilePicker>
+      </Popup.Content>
+    </>
+  );
+});
+
+ImportStep.propTypes = {
+  onSelect: PropTypes.func.isRequired,
+  onBack: PropTypes.func.isRequired,
+};
+
+export default ImportStep;

client/src/components/Boards/AddPopup/ImportStep.module.scss

@@ -0,0 +1,17 @@
+:global(#app) {
+  .button {
+    background: transparent;
+    box-shadow: none;
+    color: #6b808c;
+    font-weight: normal;
+    margin-top: 8px;
+    padding: 6px 11px;
+    text-align: left;
+    transition: none;
+
+    &:hover {
+      background: rgba(9, 30, 66, 0.08);
+      color: #092d42;
+    }
+  }
+}

client/src/components/Boards/AddPopup/index.js

@@ -0,0 +1,3 @@
+import AddPopup from './AddPopup';
+
+export default AddPopup;

client/src/entry-actions/boards.js

@@ -7,10 +7,11 @@ const createBoardInCurrentProject = (data) => ({
   },
 });
 
-const handleBoardCreate = (board) => ({
+const handleBoardCreate = (board, requestId) => ({
   type: EntryActionTypes.BOARD_CREATE_HANDLE,
   payload: {
     board,
+    requestId,
   },
 });
 

client/src/locales/en/core.js

@@ -92,8 +92,10 @@ export default {
       filterByLabels_title: 'Filter By Labels',
       filterByMembers_title: 'Filter By Members',
       fromComputer_title: 'From Computer',
+      fromTrello: 'From Trello',
       general: 'General',
       hours: 'Hours',
+      importBoard_title: 'Import Board',
       invalidCurrentPassword: 'Invalid current password',
       labels: 'Labels',
       language: 'Language',
@@ -201,6 +203,7 @@ export default {
       editTitle_title: 'Edit Title',
       editUsername_title: 'Edit Username',
       hideDetails: 'Hide details',
+      import: 'Import',
       leaveBoard: 'Leave board',
       leaveProject: 'Leave project',
       logOut_title: 'Log Out',

client/src/models/Board.js

@@ -125,11 +125,7 @@ export default class extends Model {
         break;
       case ActionTypes.BOARD_CREATE__SUCCESS:
         Board.withId(payload.localId).delete();
-
+        Board.upsert(payload.board);
-        Board.upsert({
-          ...payload.board,
-          isFetching: false,
-        });
 
         break;
       case ActionTypes.BOARD_FETCH__SUCCESS:

client/src/sagas/core/services/boards.js

@@ -7,7 +7,7 @@ import actions from '../../../actions';
 import api from '../../../api';
 import { createLocalId } from '../../../utils/local-id';
 
-export function* createBoard(projectId, data) {
+export function* createBoard(projectId, { import: boardImport, ...data }) {
   const nextData = {
     ...data,
     position: yield select(selectors.selectNextBoardPosition, projectId),
@@ -30,7 +30,19 @@ export function* createBoard(projectId, data) {
     ({
       item: board,
       included: { boardMemberships },
-    } = yield call(request, api.createBoard, projectId, nextData));
+    } = yield boardImport
+      ? call(
+          request,
+          api.createBoardWithImport,
+          projectId,
+          {
+            ...nextData,
+            importType: boardImport.type,
+            importFile: boardImport.file,
+          },
+          localId,
+        )
+      : call(request, api.createBoard, projectId, nextData));
   } catch (error) {
     yield put(actions.createBoard.failure(localId, error));
     return;
@@ -46,8 +58,12 @@ export function* createBoardInCurrentProject(data) {
   yield call(createBoard, projectId, data);
 }
 
-export function* handleBoardCreate(board) {
+export function* handleBoardCreate(board, requestId) {
-  yield put(actions.handleBoardCreate(board));
+  const isExists = yield select(selectors.selectIsBoardWithIdExists, requestId);
+
+  if (!isExists) {
+    yield put(actions.handleBoardCreate(board));
+  }
 }
 
 export function* fetchBoard(id) {

client/src/sagas/core/watchers/boards.js

@@ -8,8 +8,8 @@ export default function* boardsWatchers() {
     takeEvery(EntryActionTypes.BOARD_IN_CURRENT_PROJECT_CREATE, ({ payload: { data } }) =>
       services.createBoardInCurrentProject(data),
     ),
-    takeEvery(EntryActionTypes.BOARD_CREATE_HANDLE, ({ payload: { board } }) =>
+    takeEvery(EntryActionTypes.BOARD_CREATE_HANDLE, ({ payload: { board, requestId } }) =>
-      services.handleBoardCreate(board),
+      services.handleBoardCreate(board, requestId),
     ),
     takeEvery(EntryActionTypes.BOARD_FETCH, ({ payload: { id } }) => services.fetchBoard(id)),
     takeEvery(EntryActionTypes.BOARD_UPDATE, ({ payload: { id, data } }) =>

client/src/sagas/core/watchers/socket.js

@@ -48,8 +48,8 @@ const createSocketEventsChannel = () =>
       emit(entryActions.handleProjectManagerDelete(item));
     };
 
-    const handleBoardCreate = ({ item }) => {
+    const handleBoardCreate = ({ item, requestId }) => {
-      emit(entryActions.handleBoardCreate(item));
+      emit(entryActions.handleBoardCreate(item, requestId));
     };
 
     const handleBoardUpdate = ({ item }) => {

client/src/selectors/boards.js

@@ -172,6 +172,12 @@ export const selectCurrentUserMembershipForCurrentBoard = createSelector(
   },
 );
 
+export const selectIsBoardWithIdExists = createSelector(
+  orm,
+  (_, id) => id,
+  ({ Board }, id) => Board.idExists(id),
+);
+
 export default {
   makeSelectBoardById,
   selectBoardById,
@@ -182,4 +188,5 @@ export default {
   selectFilterUsersForCurrentBoard,
   selectFilterLabelsForCurrentBoard,
   selectCurrentUserMembershipForCurrentBoard,
+  selectIsBoardWithIdExists,
 };

server/api/controllers/boards/create.js

@@ -1,7 +1,16 @@
+const util = require('util');
+const { v4: uuid } = require('uuid');
+
 const Errors = {
   PROJECT_NOT_FOUND: {
     projectNotFound: 'Project not found',
   },
+  NO_IMPORT_FILE_WAS_UPLOADED: {
+    noImportFileWasUploaded: 'No import file was uploaded',
+  },
+  INVALID_IMPORT_FILE: {
+    invalidImportFile: 'Invalid import file',
+  },
 };
 
 module.exports = {
@@ -24,12 +33,26 @@ module.exports = {
       type: 'string',
       required: true,
     },
+    importType: {
+      type: 'string',
+      isIn: Object.values(Board.ImportTypes),
+    },
+    requestId: {
+      type: 'string',
+      isNotEmptyString: true,
+    },
   },
 
   exits: {
     projectNotFound: {
       responseType: 'notFound',
     },
+    noImportFileWasUploaded: {
+      responseType: 'unprocessableEntity',
+    },
+    uploadError: {
+      responseType: 'unprocessableEntity',
+    },
   },
 
   async fn(inputs) {
@@ -49,10 +72,42 @@ module.exports = {
 
     const values = _.pick(inputs, ['type', 'position', 'name']);
 
+    let boardImport;
+    if (inputs.importType && Object.values(Board.ImportTypes).includes(inputs.importType)) {
+      const upload = util.promisify((options, callback) =>
+        this.req.file('importFile').upload(options, (error, files) => callback(error, files)),
+      );
+
+      let files;
+      try {
+        files = await upload({
+          saveAs: uuid(),
+          maxBytes: null,
+        });
+      } catch (error) {
+        return exits.uploadError(error.message); // TODO: add error
+      }
+
+      if (files.length === 0) {
+        throw Errors.NO_IMPORT_FILE_WAS_UPLOADED;
+      }
+
+      const file = _.last(files);
+
+      if (inputs.importType === Board.ImportTypes.TRELLO) {
+        boardImport = {
+          type: inputs.importType,
+          board: await sails.helpers.boards.processUploadedTrelloImportFile(file),
+        };
+      }
+    }
+
     const { board, boardMembership } = await sails.helpers.boards.createOne(
       values,
+      boardImport,
       currentUser,
       project,
+      inputs.requestId,
       this.req,
     );
 

server/api/helpers/boards/create-one.js

@@ -5,6 +5,13 @@ module.exports = {
       custom: (value) => _.isPlainObject(value) && _.isFinite(value.position),
       required: true,
     },
+    import: {
+      type: 'json',
+      custom: (value) =>
+        value.type &&
+        Object.values(Board.ImportTypes).includes(value.type) &&
+        _.isPlainObject(value.board),
+    },
     user: {
       type: 'ref',
       required: true,
@@ -13,6 +20,10 @@ module.exports = {
       type: 'ref',
       required: true,
     },
+    requestId: {
+      type: 'string',
+      isNotEmptyString: true,
+    },
     request: {
       type: 'ref',
     },
@@ -54,6 +65,10 @@ module.exports = {
       projectId: inputs.project.id,
     }).fetch();
 
+    if (inputs.import && inputs.import.type === Board.ImportTypes.TRELLO) {
+      await sails.helpers.boards.importFromTrello(inputs.user, board, inputs.import.board);
+    }
+
     const boardMembership = await BoardMembership.create({
       boardId: board.id,
       userId: inputs.user.id,
@@ -66,6 +81,7 @@ module.exports = {
         'boardCreate',
         {
           item: board,
+          requestId: inputs.requestId,
         },
         inputs.request,
       );

server/api/helpers/boards/import-from-trello.js

@@ -0,0 +1,152 @@
+module.exports = {
+  inputs: {
+    user: {
+      type: 'ref',
+      required: true,
+    },
+    board: {
+      type: 'ref',
+      required: true,
+    },
+    trelloBoard: {
+      type: 'json',
+      required: true,
+    },
+  },
+
+  async fn(inputs) {
+    const trelloToPlankaLabels = {};
+
+    const getTrelloLists = () => inputs.trelloBoard.lists.filter((list) => !list.closed);
+
+    const getUsedTrelloLabels = () => {
+      const result = {};
+      inputs.trelloBoard.cards
+        .map((card) => card.labels)
+        .flat()
+        .forEach((label) => {
+          result[label.id] = label;
+        });
+
+      return Object.values(result);
+    };
+
+    const getTrelloCardsOfList = (listId) =>
+      inputs.trelloBoard.cards.filter((card) => card.idList === listId && !card.closed);
+
+    const getAllTrelloCheckItemsOfCard = (cardId) =>
+      inputs.trelloBoard.checklists
+        .filter((checklist) => checklist.idCard === cardId)
+        .map((checklist) => checklist.checkItems)
+        .flat();
+
+    const getTrelloCommentsOfCard = (cardId) =>
+      inputs.trelloBoard.actions.filter(
+        (action) =>
+          action.type === 'commentCard' &&
+          action.data &&
+          action.data.card &&
+          action.data.card.id === cardId,
+      );
+
+    const getPlankaLabelColor = (trelloLabelColor) =>
+      Label.COLORS.find((color) => color.indexOf(trelloLabelColor) !== -1) || 'desert-sand';
+
+    const importCardLabels = async (plankaCard, trelloCard) => {
+      return Promise.all(
+        trelloCard.labels.map(async (trelloLabel) => {
+          return CardLabel.create({
+            cardId: plankaCard.id,
+            labelId: trelloToPlankaLabels[trelloLabel.id].id,
+          });
+        }),
+      );
+    };
+
+    const importTasks = async (plankaCard, trelloCard) => {
+      // TODO find workaround for tasks/checklist mismapping, see issue trello2planka#5
+      return Promise.all(
+        getAllTrelloCheckItemsOfCard(trelloCard.id).map(async (trelloCheckItem) => {
+          return Task.create({
+            cardId: plankaCard.id,
+            position: trelloCheckItem.pos,
+            name: trelloCheckItem.name,
+            isCompleted: trelloCheckItem.state === 'complete',
+          }).fetch();
+        }),
+      );
+    };
+
+    const importComments = async (plankaCard, trelloCard) => {
+      const trelloComments = getTrelloCommentsOfCard(trelloCard.id);
+      trelloComments.sort((a, b) => new Date(a.date).getTime() - new Date(b.date).getTime());
+
+      return Promise.all(
+        trelloComments.map(async (trelloComment) => {
+          return Action.create({
+            cardId: plankaCard.id,
+            userId: inputs.user.id,
+            type: 'commentCard',
+            data: {
+              text:
+                `${trelloComment.data.text}\n\n---\n*Note: imported comment, originally posted by ` +
+                `\n${trelloComment.memberCreator.fullName} (${trelloComment.memberCreator.username}) on ${trelloComment.date}*`,
+            },
+          }).fetch();
+        }),
+      );
+    };
+
+    const importCards = async (plankaList, trelloList) => {
+      return Promise.all(
+        getTrelloCardsOfList(trelloList.id).map(async (trelloCard) => {
+          const plankaCard = await Card.create({
+            boardId: inputs.board.id,
+            listId: plankaList.id,
+            creatorUserId: inputs.user.id,
+            position: trelloCard.pos,
+            name: trelloCard.name,
+            description: trelloCard.desc || null,
+          }).fetch();
+
+          await importCardLabels(plankaCard, trelloCard);
+          await importTasks(plankaCard, trelloCard);
+          await importComments(plankaCard, trelloCard);
+
+          return plankaCard;
+        }),
+      );
+    };
+
+    const importLabels = async () => {
+      return Promise.all(
+        getUsedTrelloLabels().map(async (trelloLabel) => {
+          const plankaLabel = await Label.create({
+            boardId: inputs.board.id,
+            name: trelloLabel.name || null,
+            color: getPlankaLabelColor(trelloLabel.color),
+          }).fetch();
+
+          trelloToPlankaLabels[trelloLabel.id] = plankaLabel;
+        }),
+      );
+    };
+
+    const importLists = async () => {
+      return Promise.all(
+        getTrelloLists().map(async (trelloList) => {
+          const plankaList = await List.create({
+            boardId: inputs.board.id,
+            name: trelloList.name,
+            position: trelloList.pos,
+          }).fetch();
+
+          return importCards(plankaList, trelloList);
+        }),
+      );
+    };
+
+    await importLabels();
+    await importLists();
+  },
+};

server/api/helpers/boards/process-uploaded-trello-import-file.js

@@ -0,0 +1,38 @@
+const fs = require('fs').promises;
+const rimraf = require('rimraf');
+
+module.exports = {
+  inputs: {
+    file: {
+      type: 'json',
+      required: true,
+    },
+  },
+
+  exits: {
+    invalidFile: {},
+  },
+
+  async fn(inputs) {
+    const content = await fs.readFile(inputs.file.fd);
+    const trelloBoard = JSON.parse(content);
+
+    if (
+      !trelloBoard ||
+      !_.isArray(trelloBoard.lists) ||
+      !_.isArray(trelloBoard.cards) ||
+      !_.isArray(trelloBoard.checklists) ||
+      !_.isArray(trelloBoard.actions)
+    ) {
+      throw 'invalidFile';
+    }
+
+    try {
+      rimraf.sync(inputs.file.fd);
+    } catch (error) {
+      console.warn(error.stack); // eslint-disable-line no-console
+    }
+
+    return trelloBoard;
+  },
+};

server/api/models/Board.js

@@ -10,8 +10,13 @@ const Types = {
   COLLECTION: 'collection',
 };
 
+const ImportTypes = {
+  TRELLO: 'trello',
+};
+
 module.exports = {
   Types,
+  ImportTypes,
 
   attributes: {
     //  ╔═╗╦═╗╦╔╦╗╦╔╦╗╦╦  ╦╔═╗╔═╗