Skip to content

docs(adr-002): align Preflight entity design with Ekrem alignment decisions#2461

Merged
GeezerPelletier merged 5 commits into
mainfrom
sites-44290-preflight-adr-update
May 22, 2026
Merged

docs(adr-002): align Preflight entity design with Ekrem alignment decisions#2461
GeezerPelletier merged 5 commits into
mainfrom
sites-44290-preflight-adr-update

Conversation

@GeezerPelletier
Copy link
Copy Markdown
Contributor

Summary

Updates ADR-002 to reflect decisions from the SITES-44675 alignment session with @ekdogan. The ADR was previously marked as pending that alignment — this PR closes it out.

Changes to the Data Model section:

  • asyncJobId field added to the entity schema — makes the 1-to-1 FK relationship to AsyncJob explicit; field is never exposed to API consumers
  • Creation flow documented — controller creates AsyncJob first, receives asyncJobId, then creates Preflight with that FK; ordering ensures the execution primitive exists before the domain record that references it
  • url index annotation removed(indexed) on url was inconsistent with the collection method already specifying in-memory filtering; composite (site_id, url) index is explicitly deferred (7-day TTL bounds per-site volume to a manageable size)
  • Endpoint coexistence corrected/preflight/beta/jobs is removed (replaced by new endpoints), not deprecated; /preflight/jobs is the only legacy endpoint continuing in parallel
  • Alignment placeholder replaced — "should be aligned with @ekdogan" replaced with confirmed decisions summary

Related

Generated with Claude Code

Guy Pelletier and others added 2 commits May 21, 2026 12:45
…isions

- Add asyncJobId FK field (1-to-1 with AsyncJob) to entity schema
- Document creation flow: AsyncJob first, then Preflight with asyncJobId
- Remove (indexed) from url field; composite index deferred, in-memory
  filter sufficient given 7-day TTL bounds per-site volume
- Clarify endpoint coexistence: /preflight/beta/jobs is removed (replaced),
  /preflight/jobs is the only legacy endpoint that continues in parallel
- Replace open alignment note with confirmed decisions from SITES-44675
- Clarify TTL: verify column name in mysticat-data-service before migration

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
updatedAt is redundant in the list view — status already communicates
the current state, and timing detail (startedAt, endedAt) belongs in
the single-resource GET response where the full picture is relevant.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions
Copy link
Copy Markdown

This PR will trigger no release when merged.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@GeezerPelletier GeezerPelletier merged commit a557cea into main May 22, 2026
20 checks passed
@GeezerPelletier GeezerPelletier deleted the sites-44290-preflight-adr-update branch May 22, 2026 13:15
@solaris007
Copy link
Copy Markdown
Member

🎉 This PR is included in version 1.511.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants