Skip to content

Go: five wrapper timestamps could not represent absence (#620) - #658

Merged
jeremy merged 2 commits into
mainfrom
fix/620-go-optional-timestamps
Aug 4, 2026
Merged

Go: five wrapper timestamps could not represent absence (#620)#658
jeremy merged 2 commits into
mainfrom
fix/620-go-optional-timestamps

Conversation

@jeremy

@jeremy jeremy commented Aug 4, 2026

Copy link
Copy Markdown
Member

Closes #620. Breaking — five field types change from time.Time to *time.Time.

The defect

Struct Field File Was generated.*
TimelineEvent CreatedAt timeline.go time.Time *time.Time
WebhookDelivery CreatedAt webhooks.go time.Time *time.Time
QuestionReminder RemindAt checkins.go time.Time *time.Time
ClientApprovalResponse CreatedAt client_approvals.go time.Time *time.Time
ClientApprovalResponse UpdatedAt client_approvals.go time.Time *time.Time

An omitted timestamp decoded to the zero time and re-marshaled as a fabricated 0001-01-01T00:00:00Z — indistinguishable from a real value.

None carried ,omitempty, and it would not have helped. encoding/json's "empty" set has no entry for a struct, so ,omitempty on a value-typed time.Time is inert: the key is emitted on every re-marshal.

Same class as #562/#615, which fixed five and left these five. Shipping the release with five fixed and five broken under an identical failure mode is the thing this avoids.

I re-derived the list from source rather than trusting the issue table — the cross-reference yields exactly these 5, 0 unpaired. Controls hold: generated.Webhook.CreatedAt, generated.Question.CreatedAt and generated.ClientApproval.CreatedAt are genuinely required value types and are untouched.

Closing the class — the other half of the title

#620's title is "and no gate can see them". The evidence lives in the generated client, not the wrapper, so a guard must read both sides. Neither neighbouring gate can:

  • TestNoValueTypedOptionalTimestamps (Go: pointerize the five optional timestamps that could not represent absence #615) keys on ,omitempty and continues without it. All five were tagged bare json:"created_at" — invisible. Its own doc comment named this gap and deferred it; this closes it.
  • check-wrapper-drift has the (wrapper, generated) pairing but compares tag names only. Teaching it types would still miss WebhookDelivery — its header excludes the webhook-flavored shapes by design as a parallel representation, and WebhookDelivery.CreatedAt is one of the five. This is a limit the issue's suggested approach did not account for.

So TestNoWrapperTimestampNarrowerThanGenerated pairs by struct name + json key, which is blind to the converter tiers and covers all five. It fails loudly if the join matches nothing, so it cannot pass vacuously.

Scoped to timestamps deliberately: a nil-capability rule applied broadly reports ~345 intentionally flattened *string/*bool/*int fields. An absent string marshals away harmlessly; an absent time.Time marshals as a wrong value.

Red proof, against un-fixed source

Un-fixed files swapped in with git show origin/main:<path>, my tests kept:

--- FAIL: TestOptionalTimestampsOmitWhenAbsent/TimelineEvent
    TimelineEvent.created_at was absent on the wire but re-marshaled as "0001-01-01T00:00:00Z"
--- FAIL: TestOptionalTimestampsOmitWhenAbsent/WebhookDelivery
--- FAIL: TestOptionalTimestampsOmitWhenAbsent/QuestionReminder
--- FAIL: TestOptionalTimestampsOmitWhenAbsent/ClientApprovalResponse  (created_at + updated_at)

--- FAIL: TestNoWrapperTimestampNarrowerThanGenerated
    ClientApprovalResponse.CreatedAt ... is time.Time but generated.* is *time.Time
    ClientApprovalResponse.UpdatedAt ...
    QuestionReminder.RemindAt ...
    TimelineEvent.CreatedAt ...
    WebhookDelivery.CreatedAt ...
REAL_EXIT=1

All five fail both the behavioural test and the new guard — including WebhookDelivery, the one no gate could reach. The positive control (TestOptionalTimestampsRoundTripWhenPresent) keeps a real timestamp round-tripping byte-identically.

Verification

make go-check go-check-wrapper-drift go-check-optional-pointers, real exit written to a marker and grepped back:

ok  github.com/basecamp/basecamp-sdk/go/pkg/basecamp   9.083s
Wrapper drift check: 91 pairs walked, 1207 generated fields verified
MARKER_620_REAL_EXIT=0

Migration

t.CreatedAt.IsZero() still compiles against a pointer and panics on nil. Callers nil-check, or use basecamp.Deref. This needs its own entry in MIGRATING.md (#642) — it re-opens that document's per-SDK tables and the A/B split, which I'll re-derive there against post-absorption main.


Summary by cubic

Breaking: switch five Go wrapper timestamps from value time.Time to *time.Time so absent values stay nil and don’t re-marshal as 0001-01-01T00:00:00Z. Aligns wrappers with the generated client and closes #620.

  • Bug Fixes

    • Changed to pointers: TimelineEvent.CreatedAt, WebhookDelivery.CreatedAt, QuestionReminder.RemindAt, ClientApprovalResponse.CreatedAt, ClientApprovalResponse.UpdatedAt. Converters now pass pointers through.
    • Added TestNoWrapperTimestampNarrowerThanGenerated to ensure wrapper timestamps aren’t narrower than the generated schema.
    • Updated tests to nil-check before calling IsZero/Equal on these pointer timestamps to avoid panics.
  • Migration

    • CreatedAt/RemindAt/UpdatedAt are now pointers. Nil-check before use or use basecamp.Deref. Calling t.CreatedAt.IsZero() will panic if CreatedAt is nil.

Written for commit 7180557. Summary will update on new commits.

Review in cubic

BREAKING. Five hand-written wrapper fields were typed value time.Time
while their generated counterparts were *time.Time:

  TimelineEvent.CreatedAt           timeline.go
  WebhookDelivery.CreatedAt         webhooks.go
  QuestionReminder.RemindAt         checkins.go
  ClientApprovalResponse.CreatedAt  client_approvals.go
  ClientApprovalResponse.UpdatedAt  client_approvals.go

An omitted timestamp decoded to the zero time and re-marshaled as a
fabricated 0001-01-01T00:00:00Z, indistinguishable from a real value.
None of the five carried `,omitempty` — and it would not have helped:
encoding/json's empty set has no entry for a struct, so `,omitempty` on
a value-typed time.Time is inert.

Same class as #562/#615, which fixed five and left these five. The
converters drop their deref() and assign the pointer through.

Also closes the class, which is the half #620's title names — "and no
gate can see them". The evidence lives in the generated client, not the
wrapper, so a guard has to read both sides:

  - TestNoValueTypedOptionalTimestamps keys on `,omitempty` and skips
    without it, so all five were invisible to it. Its doc comment named
    this gap and deferred it.
  - check-wrapper-drift has the pairing but compares tag names only, and
    teaching it types would still miss WebhookDelivery: its header
    excludes the webhook-flavored shapes BY DESIGN.

TestNoWrapperTimestampNarrowerThanGenerated pairs by struct name + json
key instead, which is blind to the converter tiers and covers all five.
Scoped to timestamps: a nil-capability rule applied broadly reports ~345
deliberately flattened fields. An absent string marshals away harmlessly;
an absent time.Time marshals as a wrong value.

Red-proven against the un-fixed source: all five fail the absent-omit
test reporting the fabricated instant, and all five fail the new guard —
including WebhookDelivery, the one no gate could reach.
Copilot AI balanced review requested due to automatic review settings August 4, 2026 18:01
@jeremy jeremy added bug Something isn't working go labels Aug 4, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@jeremy
jeremy requested a balanced review from Copilot August 4, 2026 18:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Making the five wrapper timestamps *time.Time left three assertions in this
package's tests dereferencing them unguarded:

  checkins_test.go:1364  r1.RemindAt.IsZero()
  webhooks_test.go:177   delivery.CreatedAt.IsZero()
  timeline_test.go:81    !event.CreatedAt.Equal(expectedTime)

They compile — Go auto-dereferences for a value receiver — and pass only
because the fixtures happen to carry the key. Drop it from a fixture and
they panic, taking the whole test binary down instead of failing with a
message naming the field. That is exactly the hazard the branch documents
for consumers.

Require non-nil first, then assert what was being asserted.
Copilot AI review requested due to automatic review settings August 4, 2026 19:00
@jeremy

jeremy commented Aug 4, 2026

Copy link
Copy Markdown
Member Author

B1 — confirmed, fixed. Three assertions in this package's own tests dereferenced the newly-pointerized timestamps with no nil guard:

  • go/pkg/basecamp/checkins_test.go:1364r1.RemindAt.IsZero()
  • go/pkg/basecamp/webhooks_test.go:177delivery.CreatedAt.IsZero()
  • go/pkg/basecamp/timeline_test.go:81!event.CreatedAt.Equal(expectedTime)

All three compile because Go auto-dereferences for a value receiver, and all three pass only because the fixtures happen to carry the key. Drop it and they panic, taking the test binary down instead of failing with a message naming the field — the exact hazard this PR documents for consumers. Each now requires non-nil with its own message and then asserts what it asserted before; timeline_test.go also prints *event.CreatedAt rather than the pointer.

I swept the rest of the package for the same shape rather than fixing only the three named. rg over go/pkg/basecamp/*_test.go for .CreatedAt. / .UpdatedAt. / RemindAt. turns up plenty more, but every other hit is on a struct whose field is still value-typed time.TimeClientApproval (not ClientApprovalResponse), Campfire, Card, Boost, and so on. The only test touching ClientApprovalResponse directly (client_approvals_test.go:177) never reads its timestamps. Three is the complete set.

Verification (exit code written into the log under a marker and grepped back):

make go-check go-check-wrapper-drift go-check-optional-pointers
MARKER_GO620_EXIT=0
ok  github.com/basecamp/basecamp-sdk/go/pkg/basecamp  9.092s
Wrapper drift check: 91 pairs walked, 1207 generated fields verified

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@jeremy

jeremy commented Aug 4, 2026

Copy link
Copy Markdown
Member Author

Merging on independent adversarial review; both bot reviewers were unavailable this session.

The review re-derived the field list from scratch rather than trusting mine — a standalone program replicating the (struct name, json key) join against both trees. Against origin/main: exactly five violations, the five this PR fixes. Against this branch: zero. There is no sixth.

It also measured the guard's reach, which is better than I claimed: 119 wrapper timestamp fields, 118 paired, and the single unpaired one (Todo.CompletedAt) is already a pointer — so there are currently zero value-typed wrapper timestamps invisible to the join. It fails loudly on an empty join and is genuinely exercised at 118 pairs.

Two things fixed since review:

  • Added the breaking label. It was missing, and .github/release.yml derives the breaking-changes section solely from that label. The API Compatibility check cannot substitute — test.yml:859 is # Don't fail the build, just warn, and it only diffs ./pkg/basecamp.
  • Three unguarded dereferences left in this package's own tests (checkins_test.go:1364, webhooks_test.go:177, timeline_test.go:81). All compiled unchanged because Go auto-dereferences for a value receiver, and passed only because the fixtures happen to supply the key — the precise hazard this PR documents for consumers. Each now requires non-nil with its own message before asserting. A sweep confirms three was the complete set; every other .CreatedAt./.UpdatedAt. hit is on a still-value-typed struct.

One finding deliberately not fixed here, filed as #662: AuthorizationInfo.ExpiresAt is a value FlexTime whose decoder maps null to the zero time, so an absent expiry re-marshals as a fabricated 0001-01-01T00:00:00Z — the same failure class, on a credential-expiry field. Both timestamp guards are blind to it because isValueTime matches only the literal time.Time selector, so any named type embedding time.Time is invisible. It also has no generated counterpart to pair against, being decoded straight from Launchpad. That needs a guard change and a question answered about whether Launchpad ever omits the field, neither of which belongs in a freeze.

@jeremy
jeremy merged commit 6a8a833 into main Aug 4, 2026
43 of 44 checks passed
@jeremy
jeremy deleted the fix/620-go-optional-timestamps branch August 4, 2026 19:07
jeremy added a commit that referenced this pull request Aug 4, 2026
Rebased onto 2afc977 and re-measured rather than incremented. Eight PRs merged
since the branch was last updated, not the seven that carried the breaking
label: #647 was on the "Not in this release" list and had landed.

Counts. 55 class A and 6 class B, 61 surviving a clean build, up from 47/4/51.
Per SDK the class split is Go 12/4, Swift 10/0, TypeScript 9/0, Python 8/0,
Ruby 10/1, Kotlin 6/1, and the breaking-change column moves to 33/22/18/16/20/17.
The body parses back to those numbers rather than agreeing with them by hand.
The root README's aggregate sentence is re-derived to match, and now states both
halves numerically instead of "most" and "a few". The operation inventory is
unchanged at 238 -> 247 with the same 14 added, 5 removed and 11 same-ID route
moves, computed from openapi.json at both ends. check-targets is 43, and the
derivation is inline where the gate count was previously only projected. The
release spans 67 merged PRs, 15 labelled breaking; the gh commands that produce
both are embedded in the as-of block, with the note that a labelled PR is not
the same unit as an entry, which is why the per-SDK columns exceed 15.

#658 is class B, not class A. It does to five wrapper timestamps exactly what
#615 did to five others: QuestionReminder.RemindAt, ClientApprovalResponse's
CreatedAt and UpdatedAt, TimelineEvent.CreatedAt and WebhookDelivery.CreatedAt
compile untouched through a value-receiver call and panic on nil. #615's own
check could not see them because it keyed on the omitempty tag and these five
did not carry one. The audit is ten fields, and the entry names the near-miss
siblings that did not move, ClientApproval's pair in particular.

#664 splits. The public CreateScheduleEntryRequest fields were already string
and still are, so the wrapper half is silent: the RFC3339 ErrUsage guard is gone,
a bare date now creates an all-day entry, and a malformed value reaches bc3
instead of failing locally. That is class A. The generated
CreateScheduleEntryRequestContent went time.Time to string, which is a compile
error for pkg/generated importers. ReplaceScheduleEntryRequestContent is not a
migration from v0.12.0 at all; #632 introduced it. TypeScript and Ruby are
doc-comment only.

#647 is folded in as merged, with two corrections to what was written when it
was still a branch. It touches no schema, so the claim that it had to go
Smithy-first is withdrawn; UpdateCardStepRequestContent.DueOn was pointerized by
#560. And the v0.12.0 preservation GET was conditional, taken only when the
caller left due_on unaddressed, so the request-count table is scoped to that
path rather than presented as universal.

#648 adds no silent break anywhere. bc3's body is byte-identical before and
after, so nothing that was populated stops being so; the assignable's title was
never sent and is now spelled content. Every rename and retype is caught
statically in Go, Swift, TypeScript and Kotlin and raised immediately in Python
and Ruby, so it is one compile-or-runtime entry per SDK.

Two corrections nobody asked for. The Go class list opened "Go carries every
class-B break in the release", which stopped being true when Ruby's decode
entry moved into class B; it now claims only the panic-shaped ones. And
todos_write.json carries three errorRaised cases, not two, because #660 added a
bare-scalar kill.

#660 is a Kotlin class-B entry, which is new. Removing the client-wide isLenient
means a present, populated, wrong-typed scalar throws SerializationException
where it used to coerce to a string, and no signature moved to announce it. It
throws in the response decode, so on a write the mutation has already landed,
and it is not a BasecampException outside todolists.

#656 is Ruby class A, scoped tightly: only max_retries 0, only an ungoverned GET,
which means get_absolute and the Launchpad fetch rather than any operation
lacking a policy. Every other configuration is bit-identical.

Not in this release is now empty, and says so.
jeremy added a commit that referenced this pull request Aug 4, 2026
* MIGRATING.md: the v0.13.0 upgrade guide, silent breaks first

v0.13.0 breaks all six SDKs and 35 of those breaks are silent — no compile
error, no exception, no decoder failure. Label-generated release notes list
what merged; they cannot say what a consumer must react to or what wrong
behaviour they get if they ignore it. That had no home in this repo.

Adds MIGRATING.md at the root, linked from the root README and all six
per-SDK READMEs. Silent breaks lead the document, then one section per SDK
ordered by severity, plus an operator checklist, a "coverage: corrected and
re-scoped" section for what did not ship, and known gaps.

No CHANGELOG is reintroduced. The hand-maintained ones were deleted in #115
as superseded by auto-generated notes, and every release body since is
machine-built. CONTRIBUTING records the resulting rule: label-generated notes
say what merged, MIGRATING says what to do about it.

Corrections to the source drafts, each re-derived rather than repeated:

- TrashTodo was not a 404. bc3 draws `resources :todos, only: %i[show edit
  update destroy]`; DELETE /todos/:id returned 204 and set status to
  "archived", so every caller was archiving. It is the one #619 removal that
  takes away a working call, and it now carries its own carve-out.
- #619 removed three operations, not nine. Nine were re-pathed. Fusing the
  two sets is what made the blanket 404 reassurance look safe.
- Hook operation identity differs by SDK: Go and Ruby emit a short verb,
  the other four emit the wire operation ID, where the todolist pair kept
  its names — so an allowlist holding UpdateTodolistOrGroup passes the write
  and denies the new read.
- 238 -> 241 measured at the v0.12.0 tag and at c95d81c, not assumed.
- Kotlin binary compatibility is already disclaimed in kotlin/README.md;
  Swift has no written policy. Both are now stated rather than left unsaid.

recordings.get is documented as a known gap with a list-and-filter recipe
and its honest cost. The Go recipe compiles against this tree.

#637, #629 and #635/#641 were open at the time of writing and are recorded
under "Not in this release" rather than described as shipped.

* Fix the Go pagination advice, cut the raw-wire workaround, absorb #637/#643

Addresses both P1 review threads on #642 and folds in the two PRs that landed
since the first draft.

Pagination (P1). Cross-SDK item 1 claimed `page` was a starting offset in every
SDK and told readers to drop it to restore the old walk. For Go that was
actively harmful: `git show v0.12.0:go/pkg/basecamp/bookmarks.go` returns before
followPagination whenever page > 0, so a positive Page already meant one
request, and dropping it converts a bounded call into a full account-wide
traversal. The item is now scoped to the five SDKs where it holds — re-checked
at the tag rather than assumed, since the universal claim had already failed
once — with a Go subsection splitting the two real cases: services where the
page number was already honored (Bookmarks, Drafts, Everything*, request
unchanged) and the fourteen carrying the "not yet honored" doc, which sent no
page at all and returned page 1's rows. Gauges is in neither; it had no page.

Raw wire (P1). The Forwards().CreateReply example built a path with fmt.Sprintf
and called the raw AccountClient.Post against a route with no upstream
coverage, which is what AGENTS.md "Never Do These" 4 and 5 forbid. Removed
rather than softened, and replaced with a known-gap section stating what a
hand-built path gives up. Swept the document: the one other hit documents a real
change to the raw client's error codes, so it stays, but its fabricated path is
gone and it now says it is not a suggestion to reach for the escape hatch.

#643 landed, so basecamp.Ptr and basecamp.Deref replace the hand-rolled ptr
helper throughout, the Go section opens with the 300-pointer census and a
command that reproduces it, and ParticipantIDs *[]int64 gets its own note: nil
leaves participants alone, a pointer to an empty slice removes every one.

#637 landed and does NOT add a break to any SDK. color and comments_app_url did
not exist on Todolist at v0.12.0 in any of the six — both arrived with #628
earlier in this same release — so from the guide's baseline nothing turned from
optional to required. Counts stay 27/20/16/14/16/14. Documented where it bites:
color is required-and-nullable so explicit null decodes, comments_app_url
rejects null and absence alike.

Also: kotlin/README's append-only source-compat promise contradicted this
release repeatedly, so it now describes documented pre-1.0 breaking correctness
releases; the binary-compat disclaimer is kept and sharpened. release-github.yml
links MIGRATING.md from every release body, guarded on the file, so the link
cannot be forgotten at tag time. "Silent" is defined as source/runtime-silent
against a live server, since a suite pinning request paths does catch some.

Counts are stated as-of 51d0d86 with derivations inline, and each in-flight
change names the numbers it invalidates so the pre-tag pass is arithmetic.

* Split silent breaks into no-signal and fails-at-runtime; absorb #629 and cards

Addresses the remaining P2 and a suppressed Copilot comment on #642, re-derives
every count against main, and writes the cards due-date change.

The P2 was right, and it was a contradiction with this guide's own definition
rather than loose wording: "silent" was defined as "does not raise" and then
used to file nil-pointer panics. The section is now "Breaks your compiler will
not catch" — the property all of it actually shares — split into class A, no
signal at all, and class B, compiles then panics or raises but only when a
particular field is absent, so it passes every test where that field is
populated. Applying the definition consistently moved four entries, not the
three flagged: the three Go pointerization panics plus Ruby's
Draft#scheduled_posting_at decode, which raises NoMethodError and TypeError and
had the same defect. Two moved entries carry real no-signal residue, kept as
sub-notes rather than double-counted. Per SDK: Go 8A/3B, Swift 9A, TypeScript
5A, Python 4A, Ruby 2A/1B, Kotlin 3A — 31 + 4 = 35, unchanged in total. Body
counts verified against the table by parsing the section, not by eye.

The Swift section claimed three new optional Todolist members and named one;
the other two are required. Now singular, matching TypeScript.

Counts re-derived at 9de44b2: the inventory is 238 -> 247, not 241, since
#629 merged. Added, removed and route-moved lists are computed from openapi.json
at both ends rather than hand-edited — 14 IDs added, 5 removed, 11 same-ID moves
— and the Folders operations are flagged as drawn at /stacks, not /folders.

Cards get their own section. The half that matters most is true in production
today and is not caused by upgrading: every released SDK encodes "clear a card
due date" as omission, bc3 stopped treating omission as a clear, so that call is
a silent no-op right now. That is a reason to upgrade rather than a hazard of
it, so it sits in the operator checklist. The SDK-side change is read from
bf43715 and marked unmerged: single PUT, "due_on": "" as the clear encoding,
UpdateStepRequest.DueOn becomes *string, and the GetCard preservation read goes
away. The hook collapse is written as the inverse of the {Todolists,Update}
split because it fails the opposite way — allowlists do not start denying, but a
denylist on {Cards,Get} silently stops blocking the write it used to take down.
Removing the preservation GET also removes three named errorRaised kill cases
from cards_write.json; the class stays pinned on Todos, which still does a real
read-modify-write, so that is said rather than filed as a redundant-GET cleanup.

* Audit class A across all six SDKs; add Ruby's missing download retry

Fourth review round on #642. Four findings, all upheld.

The allowlist framing was wrong in the direction that matters. I wrote that
fewer hook events are safe for an allowlist. True only if the allowlist named
both operations: one that names UpdateCard and deliberately omits GetCard used
to reject cards.update at its read, and after the collapse permits it end to
end. Both policy shapes now carry the warning, labelled, plus the observation
that they are the same hole seen twice — in each, the thing stopping the write
was the read, expressed once as an omission and once as an entry.

The class-A counting was inconsistent across all six SDKs, not the two flagged.
Python and Kotlin excluded changes their own prose called "no signal
whatsoever"; auditing every SDK against the definition moved the totals to 47
class A and 4 class B. The counting policy is now stated in the document so it
can be checked against a rule rather than an impression: one entry per distinct
change per SDK, counted where it bites; class A if any ordinary call-site shape
stays silent even when another is compile-caught; second faces annotated as
residue and counted once; raises-only-on-malformed-response is class B.

Two things fell out that were not counting problems. Ruby's #563 was missing
from the guide entirely — no mention of download_url anywhere in the chapter —
verified against source rather than prose: v0.12.0 http.get_no_retry, which
sent Accept: application/json and did not retry, became get_download calling
request_with_retry with retry_on: DOWNLOAD_RETRY_ON and accept: nil. Ruby now
has its own section. The same check confirmed Go's omission of #563 is correct,
because Go already retried at v0.12.0. Separately, the Go note claiming the
compiler catches only the pkg/generated half of Schedules().UpdateEntry was
false: UpdateScheduleEntryRequest's fields became pointers, so any pkg/basecamp
call site that set a field fails to build.

The class-B definition described only half its own membership. It said the
trigger is an absent field, but Ruby's entry fires only when the field is
populated. It now says both, and says plainly that class B is a property of a
call plus a response rather than of the call — the same method against the
other shape is not a break at all. Class A has no such dependency.

Stale counts in the chapter intros are fixed. The Go intro still said eleven
silent and two panics, which is the first thing a #go link shows, and Swift
claimed the most no-signal breaks, which stopped being true at Go ten.

Also folds in #652 (projected-example gate, stacked on #648, takes check-targets
to 43), moves #648 out of draft at cb438ce, and records that #647 is being
reworked Smithy-first because the generated UpdateCardStepRequestContent.DueOn
is *types.Date and cannot express "". The consumer-facing card shape is
unaffected by that rework. Re-derived against #648: 238 -> 247 with 14 added,
5 removed and 11 same-ID route moves survives unchanged.

* Correct four claims in the v0.13.0 guide that do not match the source

The opening warning said the runtime failures need a payload where a field is
absent. That holds for the three Go entries; Ruby's single class-B entry has the
opposite trigger. Draft#scheduled_posting_at and MyNote#created_at/#updated_at
run through parse_datetime, which returns nil for nil and a Time otherwise, so
.start_with? and Time.parse raise only when the field is populated. A reader
following the old text builds the wrong fixture and concludes they are
unaffected. Both directions are now named, here and in the root README.

Class A was described as breaking on every response. Most of it does, but two
groups do not: the error-message and validation entries need an error status to
reach the code at all, and the field-map half needs a body of a particular
shape; downloadURL's hop-1 retry changes nothing until a network error or one of
429/502/503/504 occurs. Stated as preconditions rather than as a blanket claim.

The Go pointer example said only the field selector panics. types.Date.String
has a value receiver, so Go rewrites t.DueOn.String() to (*t.DueOn).String() and
the nil dereference panics before String is entered. The same holds for IsZero,
Before, After and Weekday on Date and for Format, Sub, Unix and Year on
time.Time. The summary bullet already said both panic; the example contradicted
it.

The Accept-header note credited only Python. Ruby dropped it on the same hop:
get_download passes accept: nil, and request_headers sets the header only when
accept is truthy. Both are named, with the observation that the other four never
sent it on that hop at v0.12.0 either.

No counts are touched.

* Re-derive every count against the final release commit

Rebased onto 2afc977 and re-measured rather than incremented. Eight PRs merged
since the branch was last updated, not the seven that carried the breaking
label: #647 was on the "Not in this release" list and had landed.

Counts. 55 class A and 6 class B, 61 surviving a clean build, up from 47/4/51.
Per SDK the class split is Go 12/4, Swift 10/0, TypeScript 9/0, Python 8/0,
Ruby 10/1, Kotlin 6/1, and the breaking-change column moves to 33/22/18/16/20/17.
The body parses back to those numbers rather than agreeing with them by hand.
The root README's aggregate sentence is re-derived to match, and now states both
halves numerically instead of "most" and "a few". The operation inventory is
unchanged at 238 -> 247 with the same 14 added, 5 removed and 11 same-ID route
moves, computed from openapi.json at both ends. check-targets is 43, and the
derivation is inline where the gate count was previously only projected. The
release spans 67 merged PRs, 15 labelled breaking; the gh commands that produce
both are embedded in the as-of block, with the note that a labelled PR is not
the same unit as an entry, which is why the per-SDK columns exceed 15.

#658 is class B, not class A. It does to five wrapper timestamps exactly what
#615 did to five others: QuestionReminder.RemindAt, ClientApprovalResponse's
CreatedAt and UpdatedAt, TimelineEvent.CreatedAt and WebhookDelivery.CreatedAt
compile untouched through a value-receiver call and panic on nil. #615's own
check could not see them because it keyed on the omitempty tag and these five
did not carry one. The audit is ten fields, and the entry names the near-miss
siblings that did not move, ClientApproval's pair in particular.

#664 splits. The public CreateScheduleEntryRequest fields were already string
and still are, so the wrapper half is silent: the RFC3339 ErrUsage guard is gone,
a bare date now creates an all-day entry, and a malformed value reaches bc3
instead of failing locally. That is class A. The generated
CreateScheduleEntryRequestContent went time.Time to string, which is a compile
error for pkg/generated importers. ReplaceScheduleEntryRequestContent is not a
migration from v0.12.0 at all; #632 introduced it. TypeScript and Ruby are
doc-comment only.

#647 is folded in as merged, with two corrections to what was written when it
was still a branch. It touches no schema, so the claim that it had to go
Smithy-first is withdrawn; UpdateCardStepRequestContent.DueOn was pointerized by
#560. And the v0.12.0 preservation GET was conditional, taken only when the
caller left due_on unaddressed, so the request-count table is scoped to that
path rather than presented as universal.

#648 adds no silent break anywhere. bc3's body is byte-identical before and
after, so nothing that was populated stops being so; the assignable's title was
never sent and is now spelled content. Every rename and retype is caught
statically in Go, Swift, TypeScript and Kotlin and raised immediately in Python
and Ruby, so it is one compile-or-runtime entry per SDK.

Two corrections nobody asked for. The Go class list opened "Go carries every
class-B break in the release", which stopped being true when Ruby's decode
entry moved into class B; it now claims only the panic-shaped ones. And
todos_write.json carries three errorRaised cases, not two, because #660 added a
bare-scalar kill.

#660 is a Kotlin class-B entry, which is new. Removing the client-wide isLenient
means a present, populated, wrong-typed scalar throws SerializationException
where it used to coerce to a string, and no signature moved to announce it. It
throws in the response decode, so on a write the mutation has already landed,
and it is not a BasecampException outside todolists.

#656 is Ruby class A, scoped tightly: only max_retries 0, only an ungoverned GET,
which means get_absolute and the Launchpad fetch rather than any operation
lacking a policy. Every other configuration is bit-identical.

Not in this release is now empty, and says so.

* State the schedule-entry clear value per field instead of universally

The Swift Behavioural bullet said an explicit "" clears any of the five
full-state fields. Only description does. "" on summary is accepted and
reads back "Untitled"; starts_at and ends_at are under
validates_presence_of in Schedule::Entry, so "" is rejected rather than
cleared; allDay is a boolean in every SDK, so "" does not typecheck at
all. The carve-out half grouped notify with the three clearable fields
even though it is a send directive with no state to clear.

* Re-derive the per-SDK README banners against the final class A/B table

The six SDK README banners still carried the counts from before the Go
reclassification and the recount that followed it, summing to 51 where
MIGRATING.md and the root README say 61. Each banner now matches its row
in the class A/B table: Go 12+4, Swift 10, TypeScript 9, Python 8, Ruby
10+1, Kotlin 6+1. Kotlin also gains the runtime clause it was missing,
since its one class B entry throws on a present field carrying a JSON
number or boolean where the model declares a string.

* Correct the merged-PR count and the two claims the reviewers caught

The release spans 55 merged pull requests, not 67. The 67 came from comparing
GitHub's Z-formatted mergedAt against a git timestamp formatted with a local
offset, using jq's string >, which is lexicographic rather than temporal; it
wrongly swept in twelve PRs merged in the hours before the v0.12.0 tag instant.
The derivation embedded in the guide taught that same broken comparison, so it
now uses %ct and fromdateiso8601 and says why. The breaking count of fifteen is
unchanged, since all fifteen merged after the tag, so the class A/B split, the
per-SDK tables and the six README banners are untouched.

The header no longer calls 2afc977 the commit the release is cut from. That
commit is the last of the release content and the baseline the counts were
measured against, but it predates this guide; the tag is cut from main after
this merges, on a tree that contains the file the release body links to.

The release-body teaser claimed the guide covers only breaks with no exception
and no decoder failure. The guide documents six breaks that do fail at runtime,
including Ruby and Kotlin raises and a Kotlin decoder failure, so the teaser now
names both the silent class and the runtime one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking Breaking change to public API bug Something isn't working go

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Five more Go wrapper timestamps cannot represent absence, and no gate can see them

2 participants