Skip to content

feat(web-forms#517): add variable for Google Maps API key - #2326

Merged
latin-panda merged 3 commits into
nextfrom
add-google-maps-settings-wf
Nov 18, 2026
Merged

latin-panda merged 3 commits into
nextfrom
add-google-maps-settings-wf

Conversation

@latin-panda

@latin-panda latin-panda commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Branch off and target next, not master. The master is stable and used in production (exception: documentation/infrastructure-only changes).

Closes getodk/web-forms#517

WF PR: getodk/central-frontend#1993

What has been done to verify that this works as intended?

  • Updated the nginx test to verify that /client-config.json includes googleMapsKey.
  • Ran Central locally with GOOGLE_MAPS_KEY set and unset. With the key, Web Forms map questions show the Google layer picker. Without it, they fall back to OpenStreetMap.

Why is this the best possible solution? Were any other approaches considered?

The frontend already reads /client-config.json for sentryDsn, so adding one field is the smallest change. Passing the key through the backend or the form definition was considered by the team, and we decided to go with the smallest solution for now, since it's not form data, and the backend does not need it.

How does this change impact users? Describe intentional behavior changes from code updates. What are the regression risks?

The variable is optional and defaults to empty, so existing deployments keep OpenStreetMap.

Is this change user-facing or otherwise noteworthy to users? If so, please add an entry for it in CHANGELOG.md.

I added the entry to the CHANGELOG.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

Yes, WIP here: getodk/docs#2128

@latin-panda
latin-panda marked this pull request as ready for review November 13, 2026 22:01
@latin-panda

Copy link
Copy Markdown
Contributor Author

@matthew-white, could you please review this PR when you get a chance?
It's the follow-up to getodk/central-frontend#1993, which Gareth will review next week.

@matthew-white matthew-white left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, the approach makes sense to me!

@latin-panda
latin-panda merged commit 9d5b7c8 into next Nov 18, 2026
14 checks passed
@latin-panda
latin-panda deleted the add-google-maps-settings-wf branch November 18, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants