feat: "Upload codelist" functionality in component config #13763

Konrad-Simso · 2024-10-10T13:17:52Z

Description

Added upload button in for uploading code lists in the component config,
and added a POST route to the backend.

I made the decission to accept trailing commas in uploaded files, as the JsonSerializer takes care of them if specified to do so.

Related Issue(s)

"Upload codelist" functionality in component config #13677

Verification

Your code builds clean without any errors or warnings
Manual testing done (required)
Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

… in AltinnAppGitRepository.

Added tests for Utils file.

… with current logic

Move variable in tests

codecov · 2024-10-10T13:20:23Z

Codecov Report

Attention: Patch coverage is 95.31250% with 3 lines in your changes missing coverage. Please review.

Project coverage is 95.29%. Comparing base (5c1e97e) to head (a853e5f).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...ditModal/EditOptions/EditCodeList/EditCodeList.tsx	91.42%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #13763      +/-   ##
==========================================
- Coverage   95.30%   95.29%   -0.01%     
==========================================
  Files        1652     1653       +1     
  Lines       21980    22024      +44     
  Branches     2585     2589       +4     
==========================================
+ Hits        20947    20988      +41     
- Misses        787      790       +3     
  Partials      246      246

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…s function.

TomasEng

Dette er en veldig god start. Jeg har noen kommentarer som først og fremst gjelder generelle kodeprinsipper. Her er hovedpunktene:

Se på navngivning (jeg har noen forslag)
Funksjonalitet som ikke er avhengig av hooks trenger heller ikke å være definert i hooks
Del opp funskjonene slik at de ikke gjør flere ting på én gang
Fjern oppskriften for opplasting av kodeliste i Gitea - denne trenger vi ikke nå som det kan gjøres direkte i Studio

@standeren, kan du ta en kikk på backendkoden?

...packages/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/EditCodeList.tsx

...es/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/useValidateFileName.ts

...ges/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/EditCodeList.test.tsx

...packages/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/EditCodeList.tsx

...-editor/src/components/config/editModal/EditOptions/EditCodeList/useValidateFileName.test.ts

…act hook into EditCodeList.tsx

- add try catch logic in backend to return correct response to frontend. - Edit validation logic in frontend for valid file name. - Select uploaded file on success

- try catch all exceptions and return error message. - Validation for options after being deserialized. - Rename in queriesMock.ts.

backend/src/Designer/Controllers/OptionsController.cs

backend/src/Designer/Services/Implementation/OptionsService.cs

- Reformat foreach and if into where statement.

TomasEng

Dette ble mye bedre nå som vi har refaktorert filopplastingskomponenten. Jeg tenker at vi fortsatt bør jobbe litt med valideringensfunksjonaliteten. Jeg tror også at det er på høy tid å dele opp EditCodeList i mindre komponenter, for den har mange forskjellige betingelser den må håndtere.

frontend/packages/ux-editor/src/hooks/mutations/useAddOptionMutation.test.ts

...packages/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/EditCodeList.tsx

...itor/src/components/config/editModal/EditOptions/EditCodeList/Utils/validateFileNameUtils.ts

frontend/language/src/nb.json

...packages/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/EditCodeList.tsx

- Refactor EditCodeList.tsx - Edit Language - Rename useAddOptionMutation.test.ts -> useAddOptionListMutation.test.ts

File cannot be falsy as `StudioFileUploader.tsx` has a check before running onSubmit.

…tion

TomasEng

Nå begynner dette å bli veldig bra! EditCodeList ble mye ryddigere nå. Har bare noen siste små forslag.

...packages/ux-editor/src/components/config/editModal/EditOptions/EditCodeList/EditCodeList.tsx

backend/src/Designer/Services/Implementation/OptionsService.cs

frontend/language/src/nb.json

TomasEng

Utmerket arbeid!

- Added a more specific error message when upload fails.

ErlingHauan

Pent! 😄
Testet OK

Konrad-Simso added 11 commits October 8, 2024 12:35

Fix link in codelist config.

4b20b88

Upload button added.

89a22f2

Edit language and fix typing.

f627d58

Fix linting, rename variable and allow trailing commas, it gets fixed…

ce088e4

… in AltinnAppGitRepository.

Rename useValidateFileName.ts to validateFileNameUtils.ts

9cc37a3

Added tests for Utils file.

Add test for useAddOptionMutation.ts

9a23d27

Add tests for EditCodeList.tsx and remove a toast as it's not correct…

e199eaf

… with current logic

Edit tests and remove unused imports

73e8b3b

Rename hook to use react-hook rules.

627433d

Move variable in tests

Edit filename again

1b5bb7a

Render hook correctly in test file.

da0bb76

Konrad-Simso added the team/studio-domain1 label Oct 10, 2024

Konrad-Simso linked an issue Oct 10, 2024 that may be closed by this pull request

"Upload codelist" functionality in component config #13677

Closed

2 tasks

Konrad-Simso added 3 commits October 10, 2024 17:29

Fix whitespaces in backend for linting.

d9542a1

Fixing spacing

ac92608

Move file out of Utils folder, since it's a React hook and not a util…

f230629

…s function.

TomasEng requested changes Oct 11, 2024

View reviewed changes

Konrad-Simso added 4 commits October 11, 2024 13:35

Endringer fra review.

efd12b8

Refactor useValidateFileName into smaller utils functions and move re…

541efa4

…act hook into EditCodeList.tsx

- Rename function in validateFileNameUtils.ts

1fb11bf

- add try catch logic in backend to return correct response to frontend. - Edit validation logic in frontend for valid file name. - Select uploaded file on success

- Add check for when FormField should be visible.

bbc4c79

- try catch all exceptions and return error message. - Validation for options after being deserialized. - Rename in queriesMock.ts.

github-advanced-security bot found potential problems Oct 11, 2024

View reviewed changes

backend/src/Designer/Controllers/OptionsController.cs Fixed Show fixed Hide fixed

backend/src/Designer/Services/Implementation/OptionsService.cs Fixed Show fixed Hide fixed

Konrad-Simso added 2 commits October 11, 2024 22:19

Remove unused import.

b24128c

- Less generic catch.

6819cfa

- Reformat foreach and if into where statement.

Konrad-Simso added 2 commits October 15, 2024 09:59

Edit test and replace forEach with for of loops for iterator object.

2395cec

Remove unused parameter, extract filename from File

ae5ccbf

TomasEng requested changes Oct 15, 2024

View reviewed changes

Konrad-Simso and others added 9 commits October 15, 2024 15:48

Changes from 2nd review:

06087e3

- Refactor EditCodeList.tsx - Edit Language - Rename useAddOptionMutation.test.ts -> useAddOptionListMutation.test.ts

fixed typing of props, and changed an error message.

8640803

Simplify file uploader component

fd06550

Update file name

9a603ca

Update reference to updated file name

2b5218a

Edit import statement

6f2b3a0

Updated FileUploaderWithValidation.tsx

1f7ae0a

File cannot be falsy as `StudioFileUploader.tsx` has a check before running onSubmit.

Merge branch 'simplify-file-uploader' into feature/codelist-configura…

9182ce8

…tion

Refactoring

55609b0

github-actions bot added the area/data-modeling Area: Related to data models - e.g. create, edit, use data models. label Oct 16, 2024

Konrad-Simso and others added 2 commits October 16, 2024 16:13

Update tests

a594d40

Merge branch 'main' into feature/codelist-configuration

7ae920d

TomasEng requested changes Oct 17, 2024

View reviewed changes

Konrad-Simso added 3 commits October 17, 2024 08:37

Updates from 3rd review

1a05b9e

Update nb.json and edit texts for tests.

388d011

Update test

34cbb40

TomasEng approved these changes Oct 17, 2024

View reviewed changes

ErlingHauan temporarily deployed to dev October 22, 2024 08:21 — with GitHub Actions Inactive

ErlingHauan temporarily deployed to dev October 22, 2024 08:25 — with GitHub Actions Inactive

Updates from testing:

c0fa350

- Added a more specific error message when upload fails.

ErlingHauan approved these changes Oct 22, 2024

View reviewed changes

ErlingHauan and others added 2 commits October 22, 2024 13:45

Merge branch 'main' into feature/codelist-configuration

4aa4506

Fix type error

a853e5f

ErlingHauan merged commit 4333644 into main Oct 22, 2024
16 checks passed

ErlingHauan deleted the feature/codelist-configuration branch October 22, 2024 12:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: "Upload codelist" functionality in component config #13763

feat: "Upload codelist" functionality in component config #13763

Konrad-Simso commented Oct 10, 2024

codecov bot commented Oct 10, 2024 •

edited

Loading

TomasEng left a comment

TomasEng left a comment

TomasEng left a comment

TomasEng left a comment

ErlingHauan left a comment

feat: "Upload codelist" functionality in component config #13763

feat: "Upload codelist" functionality in component config #13763

Conversation

Konrad-Simso commented Oct 10, 2024

Description

Related Issue(s)

Verification

Documentation

codecov bot commented Oct 10, 2024 • edited Loading

Codecov Report

TomasEng left a comment

Choose a reason for hiding this comment

TomasEng left a comment

Choose a reason for hiding this comment

TomasEng left a comment

Choose a reason for hiding this comment

TomasEng left a comment

Choose a reason for hiding this comment

ErlingHauan left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 10, 2024 •

edited

Loading