[TM-2739] add pull push button translation forms #463
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| import { Test } from "@nestjs/testing"; | ||
| import { LocalizationFormService } from "./localization-form.service"; | ||
| import { | ||
| FormFactory, | ||
| FormQuestionFactory, | ||
| FormSectionFactory, | ||
| I18nItemFactory | ||
| } from "@terramatch-microservices/database/factories"; | ||
|
|
||
| describe("LocalizationFormService", () => { | ||
| let service: LocalizationFormService; | ||
|
|
||
| beforeEach(async () => { | ||
| const module = await Test.createTestingModule({ | ||
| providers: [LocalizationFormService] | ||
| }).compile(); | ||
|
|
||
| service = module.get<LocalizationFormService>(LocalizationFormService); | ||
| }); | ||
|
|
||
| afterEach(async () => { | ||
| jest.restoreAllMocks(); | ||
| }); | ||
|
|
||
| describe("getI18nIdsForForm", () => { | ||
| it("should return the I18n IDs for a form", async () => { | ||
| const i18nItem = await I18nItemFactory.create(); | ||
| const form = await FormFactory.create({ titleId: i18nItem.id }); | ||
| const formSection1 = await FormSectionFactory.create({ formId: form.uuid }); | ||
| const formSection2 = await FormSectionFactory.create({ formId: form.uuid }); | ||
| await FormQuestionFactory.create({ formSectionId: formSection1.id }); | ||
| await FormQuestionFactory.create({ formSectionId: formSection2.id }); | ||
| const i18nIds = await service.getI18nIdsForForm(form); | ||
| expect(i18nIds).toBeDefined(); | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| import { Injectable } from "@nestjs/common"; | ||
| import { | ||
| Form, | ||
| FormOptionList, | ||
| FormOptionListOption, | ||
| FormQuestion, | ||
| FormQuestionOption, | ||
| FormSection, | ||
| FormTableHeader, | ||
| FundingProgramme, | ||
| LocalizationKey | ||
| } from "@terramatch-microservices/database/entities"; | ||
| import { intersection } from "lodash"; | ||
| import { Model, Op } from "sequelize"; | ||
|
|
||
| type TranslationModelType = | ||
| | typeof Form | ||
| | typeof FormSection | ||
| | typeof FormQuestion | ||
| | typeof FormQuestionOption | ||
| | typeof FormTableHeader | ||
| | typeof FormOptionList | ||
| | typeof FundingProgramme | ||
| | typeof LocalizationKey | ||
| | typeof FormOptionListOption; | ||
|
|
||
| type TranslationParamsType = string | number; | ||
|
|
||
| @Injectable() | ||
| export class LocalizationFormService { | ||
|
Collaborator
There was a problem hiding this comment. Is there a good reason to make a whole new service instead of simply including these methods in the existing form service? |
||
| private extraFields: string[] = ["id", "optionsList"]; | ||
|
|
||
| private i18nIdsToBePushed: number[] = []; | ||
|
|
||
| private getI18nTranslationEntityFields(translationEntity: TranslationModelType) { | ||
| return translationEntity.I18N_FIELDS.map(field => `${field}Id`); | ||
| } | ||
|
|
||
| private async processTranslationEntity( | ||
| model: TranslationModelType, | ||
| property: string, | ||
| filterParams: TranslationParamsType | TranslationParamsType[] | ||
| ) { | ||
| const filterParamsArray = Array.isArray(filterParams) ? filterParams : [filterParams]; | ||
| const i18nFields = this.getI18nTranslationEntityFields(model); | ||
| // @ts-expect-error - entity is a model class | ||
|
Collaborator
There was a problem hiding this comment. Your TS errors will probably go away and the code will be cleaner (for one thing, the return type will be defined so the error you're hiding in getI18nIdsForForm should go away) if you make this method generic: |
||
| const entities = await model.findAll({ | ||
| where: { | ||
| [property]: { | ||
| [Op.in]: filterParamsArray | ||
| } | ||
| }, | ||
| // @ts-expect-error - model is a model class | ||
| attributes: intersection(Object.keys(model.getAttributes()), [...i18nFields, ...this.extraFields]) | ||
| }); | ||
|
|
||
| entities.forEach(entity => { | ||
| this.pushI18nIds(entity, i18nFields); | ||
| }); | ||
|
|
||
| return entities; | ||
| } | ||
|
|
||
| private pushI18nIds(entity: Model, i18nFields: string[]) { | ||
| Object.entries(entity.dataValues).forEach(([key, value]) => { | ||
| if (i18nFields.includes(key) && value != null) { | ||
| this.i18nIdsToBePushed.push(value as number); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| async getI18nIdsForForm(form: Form) { | ||
| this.pushI18nIds(form, this.getI18nTranslationEntityFields(Form)); | ||
| const formSections = await this.processTranslationEntity(FormSection, "formId", [form.uuid]); | ||
| const formQuestions = await this.processTranslationEntity( | ||
| FormQuestion, | ||
| "formSectionId", | ||
| formSections.map(section => section.id) | ||
| ); | ||
| await this.processTranslationEntity( | ||
| FormTableHeader, | ||
| "formQuestionId", | ||
| formQuestions.map(question => question.id) | ||
| ); | ||
| const optionsListParams = formQuestions | ||
| // @ts-expect-error - optionsList is a field of FormQuestion | ||
| .map(question => question.optionsList) | ||
| .filter(optionsList => optionsList != null) | ||
| .filter(optionsList => optionsList != "0"); | ||
| const formOptionsLists = await this.processTranslationEntity(FormOptionList, "key", optionsListParams); | ||
| await this.processTranslationEntity( | ||
| FormOptionListOption, | ||
| "formOptionListId", | ||
| formOptionsLists.map(list => list.id) | ||
| ); | ||
| return this.i18nIdsToBePushed; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you're making a REST creation endpoint, you're creating a resource. This reads like an action (you don't create a
translate, you create atranslation), so this should likely be":uuid/translation"