Creating and updating lambda READMEs by robertandremitchell · Pull Request #540 · CDCgov/dibbs-text-to-code

robertandremitchell · 2026-05-11T13:02:35Z

Description

Just updating / initializing README for the lambdas.

Not sure if other modules like text-to-code, augmentation, and validation, etc. Happy to make a ticket for that work. I actually don't know if we've chatted about if/how we want readable docs for the lambdas given that we aren't currently pursuing API stuff. Figured the lambdas at least will still be helpful to have more granular.

Anyway, maybe food for thought for an eng sync and/or parking lot.

Related Issues

Closes #[Link any related issues or tasks from your project management system.]

Additional Notes

[Add any additional context or notes that reviewers should know about.]

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
I have reviewed my changes to ensure they are clear, concise, and well-documented.
I have updated the documentation, if applicable.
I have added or updated test cases to cover my changes, if applicable.
I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

The code follows best practices and conventions.
The changes implement the desired functionality or fix the reported issue.
The tests cover the new changes and pass successfully.
Any potential edge cases or error scenarios have been considered.

codecov-commenter · 2026-05-11T13:05:40Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.78%. Comparing base (c02179e) to head (5760988).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #540   +/-   ##
=======================================
  Coverage   95.78%   95.78%           
=======================================
  Files          46       46           
  Lines        2372     2372           
=======================================
  Hits         2272     2272           
  Misses        100      100

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

🚀 New features to boost your workflow:

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

nickclyde

Awesome, thanks for adding these Rob!!

nickclyde · 2026-05-12T17:26:23Z

+```text
+S3_BUCKET
+TTC_INPUT_PREFIX
+TTC_OUTPUT_PREFIX
+AUGMENTED_EICR_PREFIX
+AUGMENTATION_METADATA_PREFIX
+```


I think this env var list is missing AWS_REGION

nickclyde · 2026-05-12T17:26:23Z

+- Loading the original eICR XML from S3.
+- Parsing nonstandard code translations from TTC output.
+- Running eICR augmentation through the core augmentation package.
+- Managing a S3-derived persistence ID for the augmented document and set IDs.


I found "and set IDs" a little ambiguous on first read. I believe this is referring to the eICR setId/versionNumber header elements that EICRAugmenter rewrites deterministically from the persistence_id seed, but it could also be read as "the augmented document and the set IDs (plural)." Could we phrase it as something like "Seeding deterministic eICR document IDs (id, setId, versionNumber) from the persistence ID" so it's clearer what's being managed?

nickclyde · 2026-05-12T17:26:23Z

+
 ## Overview

 🚧 Under Construction 🚧


Now that this README has substantive content, should we remove the "Under Construction" banner? Same question for the lambda-handler README

nickclyde · 2026-05-12T17:26:23Z

+For example:
+
+```text
+TTCInput/2026/01/01/0026b704-f510-4494-8d21-11d27217d96e


Nit: TTCInput/ is the old prefix we had, the new defaults are TextToCodeSubmissionV2/, ValidationResponseV2/, TTCAugmentationMetadataV2/, etc.

nickclyde · 2026-05-12T17:26:23Z

+- `create_s3_client`
+- `get_file_content_from_s3`
+- `put_file`
+- `check_s3_object_exists`
+- `get_eventbridge_data_from_s3_event`
+- `get_persistence_id`


Nit: get_eventbridge_data_from_s3_event and get_persistence_id aren't really S3 helpers, they're EventBridge/key-parsing helpers that happen to be used alongside S3. Would it be worth renaming this section to something broader like "S3 and Event Helpers"?

nickclyde · 2026-05-12T17:26:23Z

+
+## Logging
+
+Every TTC invocation logs the record count at the start of processing.


Suggestion for a little more specificity: "Every TTC invocation logs the record count at the start. For each record, the Lambda logs the event bucket, triggering object key, and derived persistence ID as structured fields..."

JNygaard-Skylight · 2026-05-12T18:19:57Z

+Run the package tests with:
+
+```bash
+uv run pytest packages/index-lambda/tests


You can do this with the just command with just all unit packages/index-lambda/tests

Suggested change

uv run pytest packages/index-lambda/tests

just all unit packages/index-lambda/tests

JNygaard-Skylight · 2026-05-12T18:21:26Z

+Run the package tests with:
+
+```bash
+uv run pytest packages/lambda-handler/tests


Suggested change

uv run pytest packages/lambda-handler/tests

just test all packages/lambda-handler/tests

JNygaard-Skylight · 2026-05-12T18:21:55Z

+Run the package tests with:
+
+```bash
+uv run pytest packages/text-to-code-lambda/tests


Suggested change

uv run pytest packages/text-to-code-lambda/tests

just test all packages/text-to-code-lambda/tests

JNygaard-Skylight · 2026-05-12T18:22:46Z

@@ -1,19 +1,116 @@
 # DIBBs Index Initialization

-**General disclaimer** This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/cdc/#cdc_about_cio_mission-our-mission). GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.


Why remove the Markdown link?

JNygaard-Skylight · 2026-05-12T18:23:28Z

-# DIBBs Augmentation
+# DIBBs Augmentation Lambda

-**General disclaimer** This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/cdc/#cdc_about_cio_mission-our-mission). GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.


Does this disclaimer need to be in each package's readme?

JNygaard-Skylight · 2026-05-12T18:23:47Z

+Run the package tests with:
+
+```bash
+uv run pytest packages/augmentation-lambda/tests


Suggested change

uv run pytest packages/augmentation-lambda/tests

just test all packages/augmentation-lambda/tests

Creating and updating lambda READMEs

c6f1ada

robertandremitchell marked this pull request as ready for review May 11, 2026 13:08

robertandremitchell requested review from BradySkylight, JNygaard-Skylight, bamader and nickclyde as code owners May 11, 2026 13:08

Merge branch 'main' into rob/readme-initialization

b48b53d

nickclyde reviewed May 12, 2026

View reviewed changes

JNygaard-Skylight reviewed May 12, 2026

View reviewed changes

Merge branch 'main' into rob/readme-initialization

5760988


		## Logging

		Every TTC invocation logs the record count at the start of processing.

	uv run pytest packages/index-lambda/tests
	just all unit packages/index-lambda/tests

	uv run pytest packages/lambda-handler/tests
	just test all packages/lambda-handler/tests

	uv run pytest packages/text-to-code-lambda/tests
	just test all packages/text-to-code-lambda/tests

		@@ -1,19 +1,116 @@
		# DIBBs Index Initialization

		General disclaimer This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/cdc/#cdc_about_cio_mission-our-mission). GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.

	uv run pytest packages/augmentation-lambda/tests
	just test all packages/augmentation-lambda/tests

Conversation

robertandremitchell commented May 11, 2026

Description

Related Issues

Additional Notes

Checklist

Checklist for Reviewers

Uh oh!

codecov-commenter commented May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nickclyde left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JNygaard-Skylight May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented May 11, 2026 •

edited

Loading

JNygaard-Skylight May 12, 2026 •

edited

Loading