Skip to content

fix(analytics): default optional builder params to null #1893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bmc08gt merged 1 commit into from
Oct 30, 2026
Merged

fix(analytics): default optional builder params to null #1893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion build-logic/convention/src/main/kotlin/AnalyticsCatalogueConventionPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@ class AnalyticsCatalogueConventionPlugin : Plugin<Project> {

val catalogueFile = layout.projectDirectory.file("events.toml")
val pageFile = layout.projectDirectory.file("EVENTS.md")
tasks.register<WriteAnalyticsEventsPage>("writeAnalyticsEventsPage") {
val writePage = tasks.register<WriteAnalyticsEventsPage>("writeAnalyticsEventsPage") {
catalogue.set(catalogueFile)
page.set(pageFile)
}
tasks.register<CheckAnalyticsEventsPage>("checkAnalyticsEventsPage") {
// Both tasks touch EVENTS.md; without this, one invocation can check before it writes.
mustRunAfter(writePage)
catalogue.set(catalogueFile)
page.set(pageFile)
fixCommand.set("./gradlew ${path.substringBeforeLast(':')}:writeAnalyticsEventsPage")
Expand Down
5 changes: 4 additions & 1 deletion build-logic/convention/src/main/kotlin/com/getcode/buildlogic/analytics/KotlinEmitter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,10 @@ internal object KotlinEmitter {

private fun builder(builder: Builder) = buildString {
append(kdoc(listOfNotNull(builder.doc, builder.drift?.let { "DRIFT: $it" }), INDENT))
val params = builder.params.joinToString { "${it.name}: ${it.kotlinType}" }
val params = builder.params.joinToString { param ->
// Optional means "omit when absent", so callers shouldn't have to pass null to say so.
"${param.name}: ${param.kotlinType}" + if (param.nullable) " = null" else ""
}
val call = "event(${template(builder.event)})"
if (builder.properties.isEmpty()) {
appendLine("${INDENT}fun ${builder.name}($params): AnalyticsEvent = $call")
Expand Down
6 changes: 3 additions & 3 deletions ...gic/convention/src/test/kotlin/com/getcode/buildlogic/analytics/AnalyticsCatalogueTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ class AnalyticsCatalogueTest {
}

@Test
fun optionalPropertiesPassNullThroughSoTheBuilderOmitsThem() {
fun optionalPropertiesDefaultToNullAndPassItThroughSoTheBuilderOmitsThem() {
val source = generate(
"""
[lists.Kind.values]
Expand All @@ -110,7 +110,7 @@ class AnalyticsCatalogueTest {
""".trimIndent(),
).getValue("com/example/events/ThingEvents.kt")

assertContains(source, "fun thingHappened(kind: Kind?, error: String?, tier: Int?): AnalyticsEvent =")
assertContains(source, "fun thingHappened(kind: Kind? = null, error: String? = null, tier: Int? = null): AnalyticsEvent =")
assertContains(source, "text(\"Kind\", kind?.value)")
assertContains(source, "text(\"Error\", error)")
assertContains(source, "number(\"Tier\", tier?.toDouble())")
Expand Down Expand Up @@ -219,7 +219,7 @@ class AnalyticsCatalogueTest {
assertContains(
source,
"""
fun grabbed(grabTimeMillis: Long?, state: State, amount: Amount?, error: String?): AnalyticsEvent =
fun grabbed(grabTimeMillis: Long? = null, state: State, amount: Amount? = null, error: String? = null): AnalyticsEvent =
event("Grabbed") {
number("Grab Time", grabTimeMillis)
text("State", state.value)
Expand Down
Loading