Add Android rendering logic for PDF reports by andreia-ferreira · Pull Request #3774 · google/ground-android

andreia-ferreira · 2026-06-09T12:23:21Z

Towards #3715

This PR adds the specific Android implementations for rendering PDF files.

Main changes:

New helpers:
- PdfCursor to keep track of the current position within a page and its reserved spaces
- PdfPageController to keep track of page counts and their lifecycles
Android implementations of the previously introduced interfaces as well as platform specific helpers PdfWriter, PdfCanvas, PdfTextPaints and DocumentPdfCanvas in order to draw the layout

There are no functionality changes yet. The full flow will be implemented in a final follow up PR. For reference, the current layout will generate the following document structure:

@shobhitagarwal1612 PTAL?

codecov · 2026-06-09T13:24:15Z

Codecov Report

❌ Patch coverage is 75.52239% with 82 lines in your changes missing coverage. Please review.
✅ Project coverage is 66.97%. Comparing base (c167392) to head (25ffb1f).

Files with missing lines	Patch %	Lines
...undplatform/feature/pdf/AndroidPdfImageProvider.kt	52.77%	24 Missing and 10 partials ⚠️
...ndplatform/feature/pdf/AndroidPdfReportLauncher.kt	0.00%	19 Missing ⚠️
...g/groundplatform/feature/pdf/AndroidPdfRenderer.kt	0.00%	17 Missing ⚠️
...ndplatform/feature/pdf/render/DocumentPdfCanvas.kt	55.55%	6 Missing and 2 partials ⚠️
...org/groundplatform/feature/pdf/render/PdfWriter.kt	98.03%	1 Missing and 2 partials ⚠️
...ndplatform/feature/pdf/AndroidPdfOutputProvider.kt	88.88%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #3774      +/-   ##
============================================
+ Coverage     66.60%   66.97%   +0.37%     
- Complexity     1684     1771      +87     
============================================
  Files           392      402      +10     
  Lines         10145    10480     +335     
  Branches       1295     1333      +38     
============================================
+ Hits           6757     7019     +262     
- Misses         2711     2769      +58     
- Partials        677      692      +15

Files with missing lines	Coverage Δ
...org/groundplatform/feature/pdf/render/PdfCanvas.kt	`100.00% <100.00%> (ø)`
...groundplatform/feature/pdf/render/PdfTextPaints.kt	`100.00% <100.00%> (ø)`
...org/groundplatform/feature/pdf/render/PdfCursor.kt	`100.00% <100.00%> (ø)`
...ndplatform/feature/pdf/render/PdfPageController.kt	`100.00% <100.00%> (ø)`
...ndplatform/feature/pdf/AndroidPdfOutputProvider.kt	`88.88% <88.88%> (ø)`
...org/groundplatform/feature/pdf/render/PdfWriter.kt	`98.03% <98.03%> (ø)`
...ndplatform/feature/pdf/render/DocumentPdfCanvas.kt	`55.55% <55.55%> (ø)`
...g/groundplatform/feature/pdf/AndroidPdfRenderer.kt	`0.00% <0.00%> (ø)`
...ndplatform/feature/pdf/AndroidPdfReportLauncher.kt	`0.00% <0.00%> (ø)`
...undplatform/feature/pdf/AndroidPdfImageProvider.kt	`52.77% <52.77%> (ø)`

... and 4 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

shobhitagarwal1612

Could you please add screenshots to the description?

…nd PdfCanvas

andreia-ferreira · 2026-06-10T13:45:42Z

@shobhitagarwal1612 there is no UI entry point in this PR to show the direct output. But I've added a screenshot of how the doc will look like once the feature is completed in the next PR, hope it helps

…and QrCodeGenerator

shobhitagarwal1612

Thanks for sending the PR. I've left a few comments for you to review. On a high level, the PR looks reasonable but due to the large diff, it's hard to throughly review the code. Would you mind breaking it up into small 2-3 PRs?

shobhitagarwal1612 · 2026-06-10T14:58:27Z

+      writer(document, images, DocumentPdfCanvas(pdf), totalPages = totalPages)
+        .drawDocument(document)
+      File(outputPath).outputStream().use { pdf.writeTo(it) }


Since this is file operation, should it be wrapped in IO dispatchers block? Or will this be handled at the caller?

yes, it should! Updated this to run with a IO dispatcher

shobhitagarwal1612 · 2026-06-10T14:59:53Z

+    photoFilenames
+      .filter { it.isNotEmpty() }
+      .forEach { filename ->
+        loadPhotoBitmap(filename)?.let { bitmap ->
+          bitmapsToRelease += bitmap
+          images[PdfImageSet.ImageRef.Photo(filename)] = PdfImage(bitmap)
+        }
+      }


Can we use async / awaitAll to decode the images concurrently?

good call, implemented 👍

shobhitagarwal1612 · 2026-06-10T15:01:09Z

+  private val photoMaxWidthPx = pointsToRenderPixels(PdfConfig.TABLE_ANSWER_TEXT_WIDTH.toFloat())
+  private val photoMaxHeightPx = pointsToRenderPixels(PdfConfig.PHOTO_MAX_HEIGHT.toFloat())
+
+  override suspend fun load(qrContent: String?, photoFilenames: Set<String>): PdfImageSet {


Similar to previous question, are we planning to wrap the caller with io dispatcher? If not, should we do it here?

I've looked into it, but in this case I believe it's best to run on a Default dispatcher since most of the work here consists on CPU intensive things, with image decoding, scaling etc. And that dispatcher is provided by the call site, PdfExportService

andreia-ferreira · 2026-06-10T16:16:20Z

extracted 2 PRs out of this one:

This way, this PR becomes focused on the Android implementation of the interfaces needed to generate the PDF report. Since his depends on the PRs above, I'll mark this as draft for the time being

# Conflicts: # core/ui/src/commonMain/kotlin/org/groundplatform/ui/components/qrcode/GroundQrCode.kt # core/ui/src/commonMain/kotlin/org/groundplatform/ui/components/qrcode/QrCodeGenerator.kt # feature/pdf/src/commonMain/kotlin/org/groundplatform/feature/pdf/render/PdfConfig.kt

…ween rows

andreia-ferreira · 2026-06-11T16:25:41Z

updated this PR after merging the previous ones and applied the suggestions, ready for another review 👀

andreia-ferreira added 5 commits June 9, 2026 14:17

add common layout components to render

ee00650

update QrCodeGenerator to provide bitmap+logo for PDF documents

7b27c49

add android implementations for PDF platform interfaces

87d51a4

add unit tests for PdfCursor and PdfPageController

dcbca6f

extract common logic for the footer reserve and table building

5a163df

andreia-ferreira requested a deployment to e2e-approval June 9, 2026 12:23 — with GitHub Actions Waiting

andreia-ferreira changed the title ~~Andreia/3739/pdf report layout~~ Add components to render the PDF layout Jun 9, 2026

andreia-ferreira added 2 commits June 9, 2026 15:07

fix code formatting

90a1d81

improve test coverage

b4b1fa8

andreia-ferreira requested a deployment to e2e-approval June 9, 2026 13:07 — with GitHub Actions Waiting

andreia-ferreira added 2 commits June 9, 2026 16:27

add tests for PdfWriter pagination

3772ba2

add logging for AndroidPdfImageProvider

0eb9444

andreia-ferreira requested a deployment to e2e-approval June 9, 2026 15:21 — with GitHub Actions Waiting

add todo comment about iOS support for the implementations

d7bd17c

andreia-ferreira force-pushed the andreia/3739/pdf-report-layout branch from 0c304e7 to d7bd17c Compare June 9, 2026 15:26

andreia-ferreira temporarily deployed to e2e-approval June 9, 2026 15:26 — with GitHub Actions Inactive

simplify AndroidPdfImageProvider

4762a2a

andreia-ferreira temporarily deployed to e2e-approval June 9, 2026 16:40 — with GitHub Actions Inactive

andreia-ferreira requested a review from shobhitagarwal1612 June 10, 2026 09:02

Merge branch 'master' into andreia/3739/pdf-report-layout

5930d55

shobhitagarwal1612 requested a deployment to e2e-approval June 10, 2026 11:20 — with GitHub Actions Waiting

shobhitagarwal1612 reviewed Jun 10, 2026

View reviewed changes

add unit tests for PdfWriter; AndroidPdfOutputProvider; PdfImageSet a…

86bab5b

…nd PdfCanvas

andreia-ferreira requested a deployment to e2e-approval June 10, 2026 13:24 — with GitHub Actions Waiting

fix code style check

8d5137b

andreia-ferreira temporarily deployed to e2e-approval June 10, 2026 13:39 — with GitHub Actions Inactive

improve AndroidPdfImageProviderTest; add tests for DocumentPdfCanvas …

b7d18a6

…and QrCodeGenerator

andreia-ferreira temporarily deployed to e2e-approval June 10, 2026 14:47 — with GitHub Actions Inactive

shobhitagarwal1612 requested changes Jun 10, 2026

View reviewed changes

This was referenced Jun 10, 2026

Update QrCodeGenerator for PDF use #3781

Merged

Add common layout components for PDF #3782

Merged

andreia-ferreira changed the title ~~Add components to render the PDF layout~~ Add Android rendering logic for PDF reports Jun 10, 2026

andreia-ferreira marked this pull request as draft June 10, 2026 16:16

andreia-ferreira added 5 commits June 11, 2026 16:23

update AndroidPdfImageProvider#load to use async/awaitAll

a7d119e

simplify calculateInSampleSize

14fc959

apply suggestion to PdfWriter

2f7b3ba

add IO dispatcher to AndroidPdfRenderer file operation

d388ce7

andreia-ferreira requested a deployment to e2e-approval June 11, 2026 15:50 — with GitHub Actions Waiting

andreia-ferreira marked this pull request as ready for review June 11, 2026 15:51

update top border drawing logic for the table

8948a19

andreia-ferreira requested a deployment to e2e-approval June 11, 2026 16:04 — with GitHub Actions Waiting

add unit tests to assure PdfWriter only draws one internal border bet…

25ffb1f

…ween rows

andreia-ferreira requested a deployment to e2e-approval June 11, 2026 16:24 — with GitHub Actions Waiting

Conversation

andreia-ferreira commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

shobhitagarwal1612 left a comment

Choose a reason for hiding this comment

Uh oh!

andreia-ferreira commented Jun 10, 2026

Uh oh!

shobhitagarwal1612 left a comment

Choose a reason for hiding this comment

Uh oh!

shobhitagarwal1612 Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

andreia-ferreira Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

shobhitagarwal1612 Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

andreia-ferreira Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

shobhitagarwal1612 Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

andreia-ferreira Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andreia-ferreira commented Jun 10, 2026

Uh oh!

andreia-ferreira commented Jun 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andreia-ferreira commented Jun 9, 2026 •

edited

Loading

codecov Bot commented Jun 9, 2026 •

edited

Loading