Merge pull request #58 from Marvell-Consulting/SW-159

SW-159: Translation export & import

package.json

@@ -60,6 +60,7 @@
   "dependencies": {
     "connect-redis": "^7.1.1",
     "cookie-parser": "^1.4.6",
+    "csv-parse": "^5.6.0",
     "date-fns": "^4.1.0",
     "dotenv": "^16.4.5",
     "ejs": "^3.1.10",

src/controllers/publish.ts

@@ -1,9 +1,12 @@
+import { Readable } from 'node:stream';
+
 import { NextFunction, Request, Response } from 'express';
 import { snakeCase, sortBy, uniqBy } from 'lodash';
 import { FieldValidationError, matchedData } from 'express-validator';
 import { nanoid } from 'nanoid';
 import { v4 as uuid } from 'uuid';
 import { isBefore, isValid, parseISO } from 'date-fns';
+import { parse } from 'csv-parse';
 
 import {
     collectionValidator,
@@ -60,6 +63,8 @@ import { DimensionPatchDto } from '../dtos/dimension-patch-dto';
 import { ApiException } from '../exceptions/api.exception';
 import { DimensionInfoDTO } from '../dtos/dimension-info';
 import { YearType } from '../enums/year-type';
+import { addEditLinks } from '../utils/add-edit-links';
+import { TranslationDTO } from '../dtos/translations';
 
 export const start = (req: Request, res: Response, next: NextFunction) => {
     res.render('publish/start');
@@ -1523,3 +1528,71 @@ export const provideOrganisation = async (req: Request, res: Response, next: Nex
 
     res.render('publish/organisation', { values, organisations, teams, errors });
 };
+
+export const exportTranslations = async (req: Request, res: Response, next: NextFunction) => {
+    try {
+        const dataset = res.locals.dataset;
+
+        if (req.query.format === 'csv') {
+            const fileName = `translations-${dataset.id}.csv`;
+            res.setHeader('Content-Type', 'text/csv');
+            res.setHeader('Content-Disposition', `attachment; filename=${fileName}`);
+            const translationStream = await req.swapi.getTranslationExport(dataset.id);
+            Readable.from(translationStream).pipe(res);
+            return;
+        }
+
+        let translations = await req.swapi.getTranslationPreview(dataset.id);
+        translations = addEditLinks(translations, dataset.id, req);
+        res.render('publish/translations/export', { translations });
+    } catch (err) {
+        next(new UnknownException());
+    }
+};
+
+const parseUploadedTranslations = async (fileBuffer: Buffer): Promise<TranslationDTO[]> => {
+    const translations: TranslationDTO[] = [];
+
+    const csvParser: AsyncIterable<TranslationDTO> = Readable.from(fileBuffer).pipe(
+        parse({ bom: true, columns: true })
+    );
+
+    for await (const row of csvParser) {
+        translations.push(row);
+    }
+
+    return translations;
+};
+
+export const importTranslations = async (req: Request, res: Response, next: NextFunction) => {
+    const dataset = res.locals.dataset;
+    let errors: ViewError[] = [];
+    let preview = false;
+    let translations: TranslationDTO[] = [];
+
+    try {
+        if (req.query.confirm === 'true') {
+            await req.swapi.updateTranslations(dataset.id);
+            res.redirect(req.buildUrl(`/publish/${dataset.id}/tasklist`, req.language));
+            return;
+        }
+
+        if (req.method === 'POST') {
+            if (!req.file) {
+                errors = [{ field: 'csv', message: { key: 'translations.import.form.file.error.missing' } }];
+                throw new Error();
+            }
+
+            const fileData = new Blob([req.file.buffer], { type: req.file.mimetype });
+            await req.swapi.uploadTranslationImport(dataset.id, fileData);
+
+            preview = true;
+            translations = await parseUploadedTranslations(req.file.buffer);
+        }
+    } catch (err) {
+        res.status(400);
+        errors.push({ field: 'csv', message: { key: 'translations.import.form.file.error.invalid' } });
+    }
+
+    res.render('publish/translations/import', { preview, translations, errors });
+};

src/dtos/translations.ts

@@ -0,0 +1,8 @@
+export class TranslationDTO {
+    type: string;
+    key: string;
+    id?: string;
+    english?: string;
+    cymraeg?: string;
+    edit_link?: string;
+}

src/enums/task-status.ts

@@ -1,5 +1,8 @@
 export enum TaskStatus {
+    CannotStart = 'cannot_start',
+    Available = 'available',
     NotStarted = 'not_started',
+    Incomplete = 'incomplete',
     Completed = 'completed',
     NotImplemented = 'not_implemented'
 }