Refactor PDF config properties in QuestionnaireConfig #3498

FikriMilano · 2024-09-13T01:29:57Z

IMPORTANT: Where possible all PRs must be linked to a Github issue

Fixes

PDF generation can process multiple QRs #3489
Check if Questionnaire has it's pair of QR in the HtmlPopulator class #3490
Refactor pdf config from initially using QuestionnaireConfig to it's new PdfConfig class

Engineer Checklist

I have written Unit tests for any new feature(s) and edge cases for bug fixes
I have added any strings visible on UI components to the strings.xml file
I have updated the CHANGELOG.md file for any notable changes to the codebase
I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the project's style guide
I have built and run the FHIRCore app to verify my change fixes the issue and/or does not break the app
I have checked that this PR does NOT introduce breaking changes that require an update to Content and/or Configs? If it does add a sample here or a link to exactly what changes need to be made to the content.

Migration guide from QuestionnaireConfig to PdfConfig for PDF generation purpose.
From:

{
  "trigger": "ON_CLICK",
  "workflow": "LAUNCH_QUESTIONNAIRE",
  "questionnaire": {
    "id": "q1,
    "title": "Form Title at the top,
    "type": "EDIT",
    "saveButtonText": "Save",
    "taskId": "t123",
    "resourceType": "Patient",
    "resourceIdentifier": "p1234",
    "htmlBinaryId": "Binary/b1234"
    "htmlBinaryTitle": "Depression Report"
  }
}

To:

{
  "trigger": "ON_CLICK",
  "workflow": "LAUNCH_PDF_GENERATION",
  "pdfConfig": {
    "pdfTitle": "Depression Report",
    "pdfTitleSuffix": "James",
    "pdfStructureReference": "Binary/b1234",
    "subjectReference": "Patient/p1234",
    "questionnaireReferences": [
      "Questionnaire/q1",
      "Questionnaire/q2",
      "Questionnaire/q3",
      "Questionnaire/q4"
    ]
  }
}

Code Reviewer Checklist

I have verified Unit tests have been written for any new feature(s) and edge cases
I have verified any strings visible on UI components are in the strings.xml file
I have verifed the CHANGELOG.md file has any notable changes to the codebase
I have verified the solution has been implemented in a configurable and generic way for reuseable components
I have built and run the FHIRCore app to verify the change fixes the issue and/or does not break the app

Initially using QuestionnaireConfig for simplicity.

codecov · 2024-09-13T01:45:59Z

Codecov Report

Attention: Patch coverage is 48.64865% with 38 lines in your changes missing coverage. Please review.

Project coverage is 27.2%. Comparing base (a5c2fec) to head (b457f24).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...ister/fhircore/quest/ui/pdf/PdfLauncherFragment.kt	0.0%	18 Missing ⚠️
...egister/fhircore/engine/configuration/PdfConfig.kt	0.0%	14 Missing ⚠️
...fhircore/quest/util/extensions/ConfigExtensions.kt	0.0%	3 Missing ⚠️
...smartregister/fhircore/engine/pdf/HtmlPopulator.kt	94.4%	0 Missing and 2 partials ⚠️
...ster/fhircore/quest/ui/pdf/PdfLauncherViewModel.kt	50.0%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##              main   #3498   +/-   ##
=======================================
  Coverage     27.2%   27.2%           
- Complexity     752     756    +4     
=======================================
  Files          277     278    +1     
  Lines        14185   14219   +34     
  Branches      2573    2581    +8     
=======================================
+ Hits          3859    3880   +21     
- Misses        9788    9801   +13     
  Partials       538     538

Flag	Coverage Δ
engine	`63.8% <68.6%> (-0.1%)`	⬇️
geowidget	`15.4% <ø> (ø)`
quest	`5.6% <4.3%> (+<0.1%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ircore/engine/configuration/QuestionnaireConfig.kt	`79.1% <ø> (+1.1%)`	⬆️
...ister/fhircore/engine/domain/model/ActionConfig.kt	`79.5% <100.0%> (+0.4%)`	⬆️
...ster/fhircore/quest/ui/pdf/PdfLauncherViewModel.kt	`15.3% <50.0%> (+1.0%)`	⬆️
...smartregister/fhircore/engine/pdf/HtmlPopulator.kt	`87.8% <94.4%> (+1.2%)`	⬆️
...fhircore/quest/util/extensions/ConfigExtensions.kt	`0.0% <0.0%> (ø)`
...egister/fhircore/engine/configuration/PdfConfig.kt	`0.0% <0.0%> (ø)`
...ister/fhircore/quest/ui/pdf/PdfLauncherFragment.kt	`3.1% <0.0%> (-0.3%)`	⬇️

android/engine/src/main/java/org/smartregister/fhircore/engine/pdf/HtmlPopulator.kt

android/engine/src/main/java/org/smartregister/fhircore/engine/configuration/PdfConfig.kt

.../engine/src/main/java/org/smartregister/fhircore/engine/configuration/QuestionnaireConfig.kt

android/engine/src/main/java/org/smartregister/fhircore/engine/pdf/HtmlPopulator.kt

android/quest/src/main/java/org/smartregister/fhircore/quest/ui/pdf/PdfLauncherFragment.kt

android/quest/src/test/java/org/smartregister/fhircore/quest/ui/pdf/PdfLauncherFragmentTest.kt

ellykits · 2024-09-13T09:45:13Z

@FikriMilano Can you share a sample content for the pdfStructureReference Binary resource? Remember to update the docs with these new code changes.

…-and-refactor-pdf-config

FikriMilano · 2024-09-17T10:21:37Z

@ellykits see this file docs/engineering/app/configuring/pdf-generation.mdx

FikriMilano · 2024-09-17T10:22:01Z

https://docs.opensrp.io/engineering/app/configuring/pdf-generation

* Add date service to rules engine facts map (#3519) * Add summary mode (#3500) Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> * Refactor PDF config properties in QuestionnaireConfig (#3498) * Refactor to use PdfConfig Initially using QuestionnaireConfig for simplicity. * Process multi QRs in HtmlPopulator * Add new tag to check if Questionnaire has been submitted * Remove subjectType since subjectReference is used * Fix test and spotless * Address review * spotless * Cleanup * spotless * Fix test --------- Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> * Fix error validation highlighting not working when submit button is clicked bug (#3525) * Change progress bar color to blue (#3428) * update in-progress color on the map view. (#3529) Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Add medication sort custom search param (#3534) * Add medication sort custom search param * Run spotlessApply * Fix failing time based test * Pld docs adjustment (#3540) * sync typo * correct heading title * update header definition for p2p * upgrade packages * Update Geowidget to only show the Set Location dialog if no Locations to sync by have been selected (#3526) * Don't show no results dialogue on map when locations selected on multiselect. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Fix failing tests. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> --------- Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Add Exit Dialog (#3487) * Add exit dialog * Fix a typo * Show Dialog only when Map or Register is visible * PR feedback changes * Fix failing check * Remove incorrect test * Refactor dialog condition logic --------- Co-authored-by: Benjamin Mwalimu <dubdabasoduba@gmail.com> * Refactor working with bitmap images Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * Add the EUSM Burundi flavour and Rename the existing EUSM flavour (#3548) * - Add the EUSM Burundi flavour - Rename the exisiting EUSM flavour * - Update the app naming * - update the flavour naming * Configure submit anyway button (#3535) * Update the Burundi EUSM flavor (#3553) * - Add the EUSM Burundi flavour - Rename the exisiting EUSM flavour * - Update the app naming * - update the flavour naming * - Update the flavor naming - Update the documentation * - Update the flavors section of the documentation to clarify on the naming convention * Bum p up data capture version (#3547) * Map search bug fixes (#3516) * - Updating the infinite scroll paging - Updating the behaviour after clearing search bar on the maps * - spotless apply * - Fix breaking tests on geo widget module * - Fix tests * - Run spotless * - Import `LazyPagingItems` * - Adding tests * - Update the APK naming * Ignore test to be refactored later Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * - Run spotless * Update kujaku version. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> --------- Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> Co-authored-by: Lentumunai Mark <90028422+Lentumunai-Mark@users.noreply.github.com> Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> Co-authored-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Fix loading related resources Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> --------- Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> Co-authored-by: Rkareko <47570855+Rkareko@users.noreply.github.com> Co-authored-by: FikriMilano <fikrimilano1@gmail.com> Co-authored-by: Lentumunai Mark <90028422+Lentumunai-Mark@users.noreply.github.com> Co-authored-by: Peter Lubell-Doughtie <peter@ona.io> Co-authored-by: Hamza Ahmed Khan <70560433+hamza-vd@users.noreply.github.com> Co-authored-by: Benjamin Mwalimu <dubdabasoduba@gmail.com> Co-authored-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke>

* Include listRepositoryResourceDataMap to nested list widgets Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * Fix loading related resources data for List widget Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * Refactor loading bitmap images (#3546) * Add date service to rules engine facts map (#3519) * Add summary mode (#3500) Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> * Refactor PDF config properties in QuestionnaireConfig (#3498) * Refactor to use PdfConfig Initially using QuestionnaireConfig for simplicity. * Process multi QRs in HtmlPopulator * Add new tag to check if Questionnaire has been submitted * Remove subjectType since subjectReference is used * Fix test and spotless * Address review * spotless * Cleanup * spotless * Fix test --------- Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> * Fix error validation highlighting not working when submit button is clicked bug (#3525) * Change progress bar color to blue (#3428) * update in-progress color on the map view. (#3529) Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Add medication sort custom search param (#3534) * Add medication sort custom search param * Run spotlessApply * Fix failing time based test * Pld docs adjustment (#3540) * sync typo * correct heading title * update header definition for p2p * upgrade packages * Update Geowidget to only show the Set Location dialog if no Locations to sync by have been selected (#3526) * Don't show no results dialogue on map when locations selected on multiselect. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Fix failing tests. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> --------- Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Add Exit Dialog (#3487) * Add exit dialog * Fix a typo * Show Dialog only when Map or Register is visible * PR feedback changes * Fix failing check * Remove incorrect test * Refactor dialog condition logic --------- Co-authored-by: Benjamin Mwalimu <dubdabasoduba@gmail.com> * Refactor working with bitmap images Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * Add the EUSM Burundi flavour and Rename the existing EUSM flavour (#3548) * - Add the EUSM Burundi flavour - Rename the exisiting EUSM flavour * - Update the app naming * - update the flavour naming * Configure submit anyway button (#3535) * Update the Burundi EUSM flavor (#3553) * - Add the EUSM Burundi flavour - Rename the exisiting EUSM flavour * - Update the app naming * - update the flavour naming * - Update the flavor naming - Update the documentation * - Update the flavors section of the documentation to clarify on the naming convention * Bum p up data capture version (#3547) * Map search bug fixes (#3516) * - Updating the infinite scroll paging - Updating the behaviour after clearing search bar on the maps * - spotless apply * - Fix breaking tests on geo widget module * - Fix tests * - Run spotless * - Import `LazyPagingItems` * - Adding tests * - Update the APK naming * Ignore test to be refactored later Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * - Run spotless * Update kujaku version. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> --------- Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> Co-authored-by: Lentumunai Mark <90028422+Lentumunai-Mark@users.noreply.github.com> Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> Co-authored-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Fix loading related resources Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> --------- Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> Co-authored-by: Rkareko <47570855+Rkareko@users.noreply.github.com> Co-authored-by: FikriMilano <fikrimilano1@gmail.com> Co-authored-by: Lentumunai Mark <90028422+Lentumunai-Mark@users.noreply.github.com> Co-authored-by: Peter Lubell-Doughtie <peter@ona.io> Co-authored-by: Hamza Ahmed Khan <70560433+hamza-vd@users.noreply.github.com> Co-authored-by: Benjamin Mwalimu <dubdabasoduba@gmail.com> Co-authored-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Fix failing UI tests Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> * Interpolate conditionalFhirPathExpressions in listResource (#3538) To pass in evaluated rule variables Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> Co-authored-by: Elly Kitoto <junkmailstoelly@gmail.com> * Fix apply stack tint. Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Apply opacity on view properties. (#3564) Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> * Fix duplication of List view item Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> --------- Signed-off-by: Elly Kitoto <junkmailstoelly@gmail.com> Signed-off-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> Co-authored-by: Rkareko <47570855+Rkareko@users.noreply.github.com> Co-authored-by: FikriMilano <fikrimilano1@gmail.com> Co-authored-by: Lentumunai Mark <90028422+Lentumunai-Mark@users.noreply.github.com> Co-authored-by: Peter Lubell-Doughtie <peter@ona.io> Co-authored-by: Hamza Ahmed Khan <70560433+hamza-vd@users.noreply.github.com> Co-authored-by: Benjamin Mwalimu <dubdabasoduba@gmail.com> Co-authored-by: Lentumunai-Mark <lentumunai.mark@students.jkuat.ac.ke> Co-authored-by: L≡ZRS <12814349+LZRS@users.noreply.github.com>

FikriMilano added 3 commits September 13, 2024 08:23

Refactor to use PdfConfig

9c094f7

Initially using QuestionnaireConfig for simplicity.

Process multi QRs in HtmlPopulator

eaa586a

Add new tag to check if Questionnaire has been submitted

dd42646

FikriMilano requested a review from ellykits September 13, 2024 01:29

FikriMilano self-assigned this Sep 13, 2024

Remove subjectType since subjectReference is used

1bea440

Fix test and spotless

c9ae8fb

FikriMilano force-pushed the 3489-and-3490-and-refactor-pdf-config branch from 1d85407 to c9ae8fb Compare September 13, 2024 02:55

FikriMilano enabled auto-merge September 13, 2024 03:40

ellykits requested changes Sep 13, 2024

View reviewed changes

FikriMilano added 2 commits September 17, 2024 17:16

Address review

bf8f581

spotless

c5aab3a

FikriMilano force-pushed the 3489-and-3490-and-refactor-pdf-config branch from f454707 to c5aab3a Compare September 17, 2024 10:20

Merge branch 'main' of github.com:opensrp/fhircore into 3489-and-3490…

28b04d4

…-and-refactor-pdf-config

Merge branch 'main' into 3489-and-3490-and-refactor-pdf-config

27fe6b7

ellykits changed the title ~~3489 and 3490 and refactor pdf config~~ Refactor PDF config properties in QuestionnaireConfig Sep 19, 2024

ellykits previously approved these changes Sep 19, 2024

View reviewed changes

FikriMilano added 3 commits September 26, 2024 09:00

Merge branch 'main' into 3489-and-3490-and-refactor-pdf-config

8fcf156

Cleanup

bbea8c7

spotless

98fa24e

FikriMilano dismissed ellykits’s stale review via 98fa24e September 26, 2024 02:30

FikriMilano added 2 commits September 26, 2024 15:39

Fix test

215e6e2

Merge branch 'main' into 3489-and-3490-and-refactor-pdf-config

b457f24

ellykits approved these changes Sep 27, 2024

View reviewed changes

FikriMilano added this pull request to the merge queue Sep 27, 2024

ellykits removed this pull request from the merge queue due to a manual request Sep 27, 2024

ellykits merged commit ebd0355 into main Sep 27, 2024
4 of 5 checks passed

ellykits deleted the 3489-and-3490-and-refactor-pdf-config branch September 27, 2024 06:20

FikriMilano mentioned this pull request Oct 20, 2024

PDF generation can process multiple QRs #3489

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor PDF config properties in QuestionnaireConfig #3498

Refactor PDF config properties in QuestionnaireConfig #3498

FikriMilano commented Sep 13, 2024 •

edited

Loading

codecov bot commented Sep 13, 2024 •

edited

Loading

ellykits commented Sep 13, 2024

FikriMilano commented Sep 17, 2024

FikriMilano commented Sep 17, 2024

Refactor PDF config properties in QuestionnaireConfig #3498

Refactor PDF config properties in QuestionnaireConfig #3498

Conversation

FikriMilano commented Sep 13, 2024 • edited Loading

codecov bot commented Sep 13, 2024 • edited Loading

Codecov Report

ellykits commented Sep 13, 2024

FikriMilano commented Sep 17, 2024

FikriMilano commented Sep 17, 2024

FikriMilano commented Sep 13, 2024 •

edited

Loading

codecov bot commented Sep 13, 2024 •

edited

Loading