feat(narratives): add config contract, static assets and lockfile - #439
Merged
juliawu merged 2 commits intoAug 14, 2026
Merged
Conversation
ddebasmita-lab
requested review from
beets,
juliawu and
nick-nlb
as code owners
August 6, 2026 19:52
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces configuration schemas, examples, and documentation for customizing Data Commons instances, including support for branding, metrics, and agent settings. It also updates the useBranding hook and its tests to support the new logo configuration key alongside its legacy alias. The review feedback suggests tightening the regex validation for fiscal_year_start in the agent configuration schema and adding a test case to cover the public-bucket fetching path in the branding hook tests.
Makes the narratives app deployable from a clean clone. Three related gaps:
- `package-lock.json` was never committed, so `npm ci` — used by the image
build — failed outright. All 25 dependencies float on `^` ranges, so pinning
the tree is what makes a clone reproduce the tested build.
- `public/` was missing entirely while four code paths referenced it:
`/send.svg` (view_initial, data_agent), `/loader.png` (block_reasoning) and
`/logo.png` (header, as a fallback). Those requests 404'd.
- `config/` documents the per-instance contract — the branding and agent
schemas plus fillable examples — which the agent and UI read from the
instance's config bucket at runtime. Instance-specific values stay out of the
repo: copy the `.example.json` files and edit them.
Also fixes the branding logo, which never loaded from config. The schema
publishes `logo`, but the UI read only `logo_url`, so `logoUrl` stayed empty and
the header always took the bundled fallback. `mapRawToBranding` now reads `logo`
and keeps `logo_url` as a legacy alias, matching how the same file already
accepts legacy aliases for colors, fonts and `suggestion_chips`. Covered by
tests that fail without the fix.
Overriding the logo stays optional: no logo ships in the config example, so a
fresh instance renders the bundled `public/logo.png`. An instance that wants its
own adds a `logo` key and uploads the image to its config bucket, which
`config/README.md` documents.
The branding schema previously declared eight keys with no consumer anywhere in
the UI — `favicon`, `logo_alt`, `extra_css`, `footer`, `splash_assets`,
`instance_id`, `domain_hint` and `analytics`. They are omitted here rather than
carried over, so every key in the schema is one the UI actually reads.
`template_vars` is kept but now says plainly that placeholder rendering is not
implemented; the previous wording claimed the agent already substituted
`{{instance.*}}`, which it does not.
ddebasmita-lab
force-pushed
the
narratives-config-assets
branch
from
August 6, 2026 19:56
67b1632 to
bef8ea0
Compare
juliawu
reviewed
Aug 10, 2026
juliawu
left a comment
juliawu
left a comment
There was a problem hiding this comment.
Thank you for the cleanup! Just a few comments. I also think the gemini review comments are worth looking at.
There was a problem hiding this comment.
Can be changed later, but @miss-o-soup should we have a different "default" logo in the main repo?
…tests
Review follow-ups on the config contract:
- API keys are no longer part of the config contract at all. `gemini.api_keys`,
`demo_api_keys` and the legacy scalar `api_key` are removed from the schema and
the example. `gemini` is `additionalProperties: false`, so adding them back is
a validation error — which is the point: the file stays safe to commit and to
serve from a config bucket, and a key cannot leak by being pasted into it.
A deployed instance resolves keys from Secret Manager via
`GEMINI_API_KEYS_SECRET` / `GEMINI_DEMO_API_KEYS_SECRET`.
The agent keeps reading `gemini.api_keys` from a local, uncommitted
`config.json` so local development still works, but that path now logs a
warning naming the environment variable to set. Previously it succeeded
silently, so a deployment reading keys from config looked healthy.
`get_api_keys`'s docstring also claimed the scalar `gemini.api_key` was
"rejected outright" when the code accepted it; it now describes what the code
does.
- `template_vars.fiscal_year_start` had pattern `^[0-9]{2}-[0-9]{2}$`, which
accepted `99-99` and `00-00`. Now bounds the month to 01-12 and the day to
01-31.
- Two tests cover the public-bucket path, which had none: `/agent/brand`
returning only `brand_config_url` and the browser fetching
`<bucket>/branding.json` itself, plus the 404 case falling back to defaults.
- The header's logo alt text hardcoded one instance's name as its fallback.
It now uses the configured instance name, or a neutral string when unset.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Makes the narratives app deployable from a clean clone. Three related gaps:
package-lock.jsonwas never committed, sonpm ci— used by the image build — failed outright. All 25 dependencies float on^ranges, so pinning the tree is what makes a clone reproduce the tested build.public/was missing entirely while four code paths referenced it:/send.svg(view_initial, data_agent),/loader.png(block_reasoning) and/logo.png(header, as a fallback). Those requests 404'd.config/documents the per-instance contract — the branding and agent schemas plus fillable examples — which the agent and UI read from the instance's config bucket at runtime. Instance-specific values stay out of the repo: copy the.example.jsonfiles and edit them.template_varsis kept but now says plainly that placeholder rendering is not implemented; the previous wording claimed the agent already substituted{{instance.*}}, which it does not.