Flag type divergence in attribute deprecation chains
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation, testing
Research direction
Start by locating the convention tests that validate attribute deprecation chains and the documentation generation or rendering entry point. Add coverage for diverging types so the status is not backfill, then add a warning-like indication in the docs. Done means both the validation behavior and the documented warning are covered by tests.
Written by the indexing model from the issue text.
Description
If an attribute is deprecated in favour of a replacing attribute, Relay and the Sentry backend can automatically backfill and forward-coalesce these chains, so that users continue receiving the deprecated and replacing attribute, regardless of what the SDK sent (within the backfilling period).
This only works as long as the types of the attributes in the deprecation chain are consistent. For diverging types, we can currently document them but backfilling wouldn't work. Therefore, we should:
- Test against type divergence in conventions: It's fine to document a type-diverging deprecation but in this case, the
_statusMUST NOT be'backfill'. For now, it should benull. In the future, it might also be'transform'. - In docs, show a "warning-like" indication when an attribute has a type-diverging deprecation chain.
Further steps for transformations/normalization are subject to #465
- Dominant language
- TypeScript
- Stars
- 16
- Forks
- 7
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 63
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-conventions
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
getsentry/sentry-conventions#732 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 61/100
getsentry/sentry-conventions#731 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
getsentry/sentry-conventions#730 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
getsentry/sentry-conventions#709 · 1 comment ·
Maintainers usually reply within 1 day
-
Span SpecificationsOpen
Difficulty 5/5 Over a week Newbie friendliness 35/100
getsentry/sentry-conventions#659 · 1 comment ·
Maintainers usually reply within 1 day
All issues in getsentry/sentry-conventions
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
kunchenguid/gh-axi#220 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
prerender: wait for env-runner worker readiness before crawlingPossibly taken @sarankumar1325 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day