test: no shared conformance suite across runtimes

Open
#24,052 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript
Domain
testing-qa

Research direction

Start by locating the existing per-runtime integration tests and the repository's conventions for generated documentation or shared test matrices. Map the listed behaviors to existing coverage, then choose the supported matrix format and populate its current results. Done means one cross-runtime table exists, with empty cells clearly identifying missing coverage and existing tests reflected accurately.

Written by the indexing model from the issue text.

Description

javascript

Many items in this project's issues are the same questions asked repeatedly: does this runtime propagate trace headers on its default HTTP client? Does it keep a span open for a streaming response? Does it report the right SDK name and runtime? Does double init do the same thing?

Each was found by reading one package and comparing to another. A table would have found them all at once, and would keep finding them.

Work item. Add a single matrix table to the repo (a test, or a generated doc) with one row per behavior and one column per runtime, covering at least:

Behavior
sdk.name and sdk.packages
contexts.runtime.name / .version
incoming server span: name, sentry.op, source
incoming server span: continues an inbound sentry-trace
outgoing default HTTP client: child span created
outgoing default HTTP client: sentry-trace + baggage sent
streaming response: span stays open until the body ends
streaming response: client cancel propagates upstream
request body capture honors dataCollection.httpBodies
ignoreStatusCodes drops the transaction
OPTIONS / HEAD produce no span
double init() behavior
tracing-off: tracing integrations absent
unhandled error in the handler is captured and rethrown

Fill it from the existing per-runtime integration tests where they already exist, and let the empty cells drive the backlog. This is the item with the highest long-term return; every other item in this document is one cell in it.

Prior art Four open issues ask for more test coverage, but none of them for a cross-runtime behavior matrix:

  • #18635
  • #20874
  • #23610
  • #22523
  • #18635 similar, but it is about running existing suites against more frameworks, not about asking every runtime the same behavioral question.
Dominant language
TypeScript
Stars
8.7k
Forks
1.9k
Avg merge
1d 18h
Merged PRs (30d)
543

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-javascript

All issues in getsentry/sentry-javascript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.