Merge pull request #360 from ever-co/develop

Release

README.md

@@ -105,7 +105,7 @@ All other brand and product names are trademarks, registered trademarks or servi
 [![huntr](https://cdn.huntr.dev/huntr_security_badge_mono.svg)](https://huntr.dev)
 [![Circle CI](https://circleci.com/gh/ever-co/ever-traduora.svg?style=svg)](https://circleci.com/gh/ever-co/ever-traduora)
 [![codecov](https://codecov.io/gh/ever-co/ever-traduora/branch/master/graph/badge.svg)](https://codecov.io/gh/ever-co/ever-traduora)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8e0f1c13c3d94f18b1523b896d4500aa)](https://www.codacy.com/manual/Ever/ever-traduora?utm_source=github.com&utm_medium=referral&utm_content=ever-co/ever-traduora&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0d5e1c68dc1e44c79249241b4abb15b8)](https://www.codacy.com/gh/ever-co/ever-traduora/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ever-co/ever-traduora&utm_campaign=Badge_Grade)
 [![DeepScan grade](https://deepscan.io/api/teams/3293/projects/16761/branches/365112/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=3293&pid=16761&bid=365112)
 [![Known Vulnerabilities](https://snyk.io/test/github/ever-co/ever-traduora/badge.svg)](https://snyk.io/test/github/ever-co/ever-traduora)
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/ever-co/ever-traduora.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ever-co/ever-traduora/alerts/)

api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ever-traduora-api",
-  "version": "0.19.3",
+  "version": "0.19.4",
   "license": "AGPL-3.0-only",
   "homepage": "https://traduora.co",
   "repository": {
@@ -42,13 +42,14 @@
     "class-validator": "^0.13.1",
     "csv": "^5.5.3",
     "csv-stringify": "^6.0.5",
-    "ejs": "^3.1.6",
+    "ejs": "^3.1.7",
     "generate-password": "^1.6.1",
     "gettext-parser": "^4.0.4",
     "handlebars": "^4.7.7",
     "iconv-lite": "^0.6.3",
     "js-yaml": "^4.1.0",
-    "moment": "^2.29.1",
+    "lodash": "^4.17.21",
+    "moment": "^2.29.4",
     "morgan": "^1.10.0",
     "mysql": "^2.18.1",
     "node-native2ascii": "^0.2.0",
@@ -88,7 +89,7 @@
     "nodemon": "^2.0.7",
     "prettier": "^2.4.0",
     "rimraf": "^3.0.2",
-    "semver-regex": "^4.0.0",
+    "semver-regex": "^4.0.3",
     "supertest": "^6.2.2",
     "ts-jest": "^27.0.5",
     "ts-loader": "^9.2.5",

api/src/config.ts

@@ -47,7 +47,7 @@ export const config = {
   },
   db: {
     default: {
-      type: 'mysql',
+      type: env.TR_DB_TYPE || 'mysql',
       host: env.TR_DB_HOST || '127.0.0.1',
       port: parseInt(env.TR_DB_PORT, 10) || 3306,
       username: env.TR_DB_USER || 'root',

api/src/controllers/exports.controller.ts

@@ -22,6 +22,7 @@ import { phpExporter } from '../formatters/php';
 import { ApiOAuth2, ApiTags, ApiOperation, ApiProduces, ApiResponse } from '@nestjs/swagger';
 import { androidXmlExporter } from '../formatters/android-xml';
 import { resXExporter } from '../formatters/resx';
+import { merge } from 'lodash';
 
 @Controller('api/v1/projects/:projectId/exports')
 export class ExportsController {
@@ -73,15 +74,55 @@ export class ExportsController {
       .orderBy('term.value', 'ASC')
       .getMany();
 
+    let termsWithTranslationsMapped = termsWithTranslations.map(t => ({
+      term: t.value,
+      translation: t.translations.length === 1 ? t.translations[0].value : '',
+    }));
+
+    if (query.fallbackLocale) {
+      termsWithTranslationsMapped = termsWithTranslationsMapped.filter(t => t.translation !== '');
+    }
+
     const data: IntermediateTranslationFormat = {
       iso: query.locale,
-      translations: termsWithTranslations.map(t => ({
-        term: t.value,
-        translation: t.translations.length === 1 ? t.translations[0].value : '',
-      })),
+      translations: termsWithTranslationsMapped,
     };
 
-    const serialized = await this.dump(query.format, data);
+    let serialized = await this.dump(query.format, data);
+
+    if (query.fallbackLocale) {
+      const fallbackProjectLocale = await this.projectLocaleRepo.findOne({
+        where: {
+          project: membership.project,
+          locale: {
+            code: query.fallbackLocale,
+          },
+        },
+      });
+
+      if (fallbackProjectLocale) {
+        const fallbackTermsWithTranslations = await this.termRepo
+          .createQueryBuilder('term')
+          .leftJoinAndSelect('term.translations', 'translation', 'translation.projectLocaleId = :projectLocaleId', {
+            projectLocaleId: fallbackProjectLocale.id,
+          })
+          .where('term.projectId = :projectId', { projectId })
+          .orderBy('term.value', 'ASC')
+          .getMany();
+
+        const fallbackTermsWithTranslationsMapped = fallbackTermsWithTranslations.map(t => ({
+          term: t.value,
+          translation: t.translations.length === 1 ? t.translations[0].value : '',
+        }));
+
+        const dataWithFallback: IntermediateTranslationFormat = {
+          iso: query.locale,
+          translations: merge(fallbackTermsWithTranslationsMapped, data.translations),
+        };
+
+        serialized = await this.dump(query.format, dataWithFallback);
+      }
+    }
 
     res.status(HttpStatus.OK);
     res.contentType('application/octet-stream');

api/src/controllers/term.controller.ts

@@ -42,6 +42,7 @@ export default class TermController {
     const data = terms.map(t => ({
       id: t.id,
       value: t.value,
+      context: t.context,
       labels: t.labels,
       date: t.date,
     }));
@@ -65,6 +66,7 @@ export default class TermController {
 
     const term = this.termRepo.create({
       value: payload.value,
+      context: payload.context,
       project: membership.project,
     });
 
@@ -94,6 +96,7 @@ export default class TermController {
       data: {
         id: term.id,
         value: term.value,
+        context: term.context,
         labels: [],
         date: term.date,
       },
@@ -108,19 +111,21 @@ export default class TermController {
   @ApiResponse({ status: HttpStatus.UNAUTHORIZED, description: 'Unauthorized' })
   async update(@Req() req, @Param('projectId') projectId: string, @Param('termId') termId: string, @Body() payload: UpdateTermRequest) {
     const user = this.auth.getRequestUserOrClient(req);
+
     await this.auth.authorizeProjectAction(user, projectId, ProjectAction.EditTerm);
 
     // Ensure is project term
     await this.termRepo.findOneOrFail({ where: { id: termId, project: { id: projectId } } });
 
-    await this.termRepo.update({ id: termId }, { value: payload.value });
+    await this.termRepo.update({ id: termId }, { value: payload.value, context: payload.context });
 
     const term = await this.termRepo.findOneOrFail({ id: termId }, { relations: ['labels'] });
 
     return {
       data: {
         id: term.id,
         value: term.value,
+        context: term.context,
         labels: term.labels,
         date: term.date,
       },

api/src/domain/http.ts

@@ -153,6 +153,10 @@ export class ProjectTermDTO {
   id: string;
   @ApiProperty()
   value: string;
+  @ApiProperty({
+    nullable: true,
+  })
+  context: string | null;
   @ApiProperty()
   labels: ProjectLabelDTO[];
   @ApiProperty()
@@ -558,13 +562,23 @@ export class AddTermRequest {
   @Length(1, 255)
   @Validate(IsNotOnlyWhitespace)
   value: string;
+
+  @ApiPropertyOptional({ minLength: 0, maxLength: 1000 })
+  @IsOptional()
+  @Length(0, 1000)
+  context: string | undefined;
 }
 
 export class UpdateTermRequest {
   @ApiProperty({ minLength: 1, maxLength: 255 })
   @Length(1, 255)
   @Validate(IsNotOnlyWhitespace)
   value: string;
+
+  @ApiPropertyOptional({ minLength: 0, maxLength: 1000 })
+  @IsOptional()
+  @Length(0, 1000)
+  context: string | undefined;
 }
 
 export class AddLocaleRequest {
@@ -609,6 +623,11 @@ export class ExportQuery {
   @ApiProperty({ minLength: 2, maxLength: 16 })
   locale: string;
 
+  @Length(2, 16)
+  @ApiProperty({ minLength: 2, maxLength: 16 })
+  @IsOptional()
+  fallbackLocale: string;
+
   @IsEnum(ImportExportFormat)
   @ApiProperty({ enum: ImportExportFormat })
   format: ImportExportFormat;

api/src/entity/term.entity.ts

@@ -13,6 +13,11 @@ export class Term {
   @Column()
   value: string;
 
+  @Column({
+    nullable: true,
+  })
+  context: string | null;
+
   @ManyToOne(() => Project, { onDelete: 'CASCADE', nullable: false })
   @JoinColumn()
   project: Project;

api/src/migrations/1667573768424-add-term-context.ts

@@ -0,0 +1,11 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class addTermContext1667573768424 implements MigrationInterface {
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query('ALTER TABLE `term` ADD COLUMN `context` TEXT DEFAULT NULL AFTER `value`');
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query('ALTER TABLE `term` DROP COLUMN `context`');
+  }
+}

api/test/term.e2e-spec.ts

@@ -28,7 +28,23 @@ describe('TermController (e2e)', () => {
       })
       .expect(201)
       .expect(res => {
-        expect(res.body.data).toHaveExactProperties(['id', 'value', 'labels', 'date']);
+        expect(res.body.data).toHaveExactProperties(['id', 'value', 'context', 'labels', 'date']);
+        expect(res.body.data.labels).toEqual([]);
+      });
+  });
+
+  it('/api/v1/projects/:projectId/terms (POST) should create terms with context for project', async () => {
+    await request(app.getHttpServer())
+      .post(`/api/v1/projects/${testProject.id}/terms`)
+      .set('Authorization', `Bearer ${testingUser.accessToken}`)
+      .send({
+        value: 'term.one',
+        context: 'Context one',
+      })
+      .expect(201)
+      .expect(res => {
+        expect(res.body.data).toHaveExactProperties(['id', 'value', 'context', 'labels', 'date']);
+        expect(res.body.data.context).toEqual('Context one');
         expect(res.body.data.labels).toEqual([]);
       });
   });
@@ -48,7 +64,7 @@ describe('TermController (e2e)', () => {
       .expect(200)
       .expect(res => {
         expect(res.body.data).toHaveLength(1);
-        expect(res.body.data[0]).toHaveExactProperties(['id', 'value', 'labels', 'date']);
+        expect(res.body.data[0]).toHaveExactProperties(['id', 'value', 'context', 'labels', 'date']);
       });
   });
 
@@ -84,6 +100,7 @@ describe('TermController (e2e)', () => {
       .set('Authorization', `Bearer ${testingUser.accessToken}`)
       .send({
         value: 'term.one',
+        context: 'Context one',
       })
       .expect(201)
       .expect(res => {
@@ -95,12 +112,14 @@ describe('TermController (e2e)', () => {
       .set('Authorization', `Bearer ${testingUser.accessToken}`)
       .send({
         value: 'term.two',
+        context: 'Context two',
       })
       .expect(200)
       .expect(res => {
-        expect(res.body.data).toHaveExactProperties(['id', 'value', 'labels', 'date']);
+        expect(res.body.data).toHaveExactProperties(['id', 'value', 'context', 'labels', 'date']);
         expect(res.body.data.id).toEqual(termId);
         expect(res.body.data.value).toEqual('term.two');
+        expect(res.body.data.context).toEqual('Context two');
       });
   });
 
@@ -123,12 +142,14 @@ describe('TermController (e2e)', () => {
       .set('Authorization', `Bearer ${testingUser.accessToken}`)
       .send({
         value: 'term.two őúüöá 😀👍🍉你好',
+        context: 'Context őúüöá 😀👍🍉你好',
       })
       .expect(200)
       .expect(res => {
-        expect(res.body.data).toHaveExactProperties(['id', 'value', 'labels', 'date']);
+        expect(res.body.data).toHaveExactProperties(['id', 'value', 'context', 'labels', 'date']);
         expect(res.body.data.id).toEqual(termId);
         expect(res.body.data.value).toEqual('term.two őúüöá 😀👍🍉你好');
+        expect(res.body.data.context).toEqual('Context őúüöá 😀👍🍉你好');
       });
   });