Skip to content

test (docs) Guide for writing e2e tests that take summaries - #27488

Merged
Navin Agarwal (agarwal-navin) merged 4 commits into
microsoft:mainfrom
agarwal-navin:summaryE2ETestDoc
Jun 8, 2026
Merged

test (docs) Guide for writing e2e tests that take summaries#27488
Navin Agarwal (agarwal-navin) merged 4 commits into
microsoft:mainfrom
agarwal-navin:summaryE2ETestDoc

Conversation

@agarwal-navin

@agarwal-navin Navin Agarwal (agarwal-navin) commented Jun 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Adds a new doc, WritingTestsThatTakeSummaries.md, to the test-end-to-end-tests package documenting the pattern for writing end-to-end tests that drive summaries on demand. It covers:

  • The two container configurations — interactive containers (with the automatic summarizer disabled) vs. the dedicated summarizer.
  • How to take a summary with summarizeNow and inspect the result.
  • How to load a new container or summarizer from a specific summary version.
  • The rules that keep these tests deterministic (syncSummarizer: true, ensureSynchronized() before summarizing, chaining via summaryVersion, closing one summarizer before starting another, etc.).

It also adds a Table of Contents and an Introduction section to the package README.md and WritingCompatCorrectTests.md for consistency and navigation, links the new doc from the README, and fixes a heading typo ("Enpdoint" → "Endpoint") in the README.

Documentation-only change — no code or public API is affected.

@agarwal-navin @claude
docs: Add guide for writing e2e tests that take summaries
bc3a77e 
Add WritingTestsThatTakeSummaries.md documenting the pattern for
end-to-end tests that drive summaries on demand: the two container
configurations (interactive vs. summarizer), how to take and inspect a
summary, how to load a container or summarizer from a specific summary,
and the rules that keep these tests deterministic.

Also add a table of contents and Introduction section to the package
README and WritingCompatCorrectTests.md, and link the new doc from the
README.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 4, 2026 22:04
Copilot AI reviewed Jun 4, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

@github-actions

github-actions Bot commented Jun 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Hi! Thank you for opening this PR. Want me to review it?

Based on the diff (450 lines, 5 files), I've queued these reviewers:

  • Correctness — logic errors, race conditions, lifecycle issues
  • Security — vulnerabilities, secret exposure, injection
  • API Compatibility — breaking changes, release tags, type design
  • Performance — algorithmic regressions, memory leaks
  • Testing — coverage gaps, hollow tests

How this works

  • Adjust the reviewer set by ticking/unticking boxes above. Reviewer toggles alone don't trigger anything.

  • Tick Start review below to dispatch the review fleet.

  • After review finishes, tick Start review again to request another run — it auto-resets after each dispatch.

  • This comment updates as new commits land; your reviewer selections are preserved.

  • Start review

@agarwal-navin @claude
docs: Add README to summarization test folder linking the summary-tes…
b57364c 
…ting guide

Point readers who browse src/test/summarization/ to
WritingTestsThatTakeSummaries.md, with a few worked examples.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@agarwal-navin Navin Agarwal (agarwal-navin) changed the title docs: Add guide for writing e2e tests that take summaries docs: Added guide for writing e2e tests that take summaries Jun 4, 2026
@agarwal-navin Navin Agarwal (agarwal-navin) changed the title docs: Added guide for writing e2e tests that take summaries test (docs) Added guide for writing e2e tests that take summaries Jun 4, 2026
@agarwal-navin Navin Agarwal (agarwal-navin) changed the title test (docs) Added guide for writing e2e tests that take summaries test (docs) Guide for writing e2e tests that take summaries Jun 4, 2026
markfields
Mark Fields (markfields) reviewed Jun 5, 2026
View reviewed changes
Comment thread packages/test/test-end-to-end-tests/src/test/summarization/README.md Outdated
markfields
Mark Fields (markfields) approved these changes Jun 5, 2026
View reviewed changes

@markfields Mark Fields (markfields) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is great!

Josmithr
Joshua Smithrud (Josmithr) reviewed Jun 5, 2026
View reviewed changes
Comment thread packages/test/test-end-to-end-tests/WritingTestsThatTakeSummaries.md Outdated
Josmithr
Joshua Smithrud (Josmithr) approved these changes Jun 5, 2026
View reviewed changes

@Josmithr Joshua Smithrud (Josmithr) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I left a couple nitpicks and mechanical suggestions, but the docs look great! Thanks for doing this!

@agarwal-navin @claude
docs: Embed runnable smoke test in summary guide; wrap prose at sente…
203784c 
…nce boundaries

Add summarizeSmokeTest.spec.ts as a real, runnable smoke test and embed it
into WritingTestsThatTakeSummaries.md via markdown-magic, so the documented
"complete minimal example" stays in sync with code that compiles and passes.
Writing the test surfaced a bug in the prose example: passing the interactive
config (state: "disabled") into createSummarizer fails; the test uses the
default disableHeuristics config instead.

Also reformat the guide's prose to one sentence per line per the repo's
Markdown best practices, and fix two typos.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  290871 links
    1933 destination URLs
    2183 URLs ignored
       0 warnings
       0 errors

@agarwal-navin
Navin Agarwal (agarwal-navin) merged commit b9363c4 into microsoft:main Jun 8, 2026
35 checks passed
@agarwal-navin
Navin Agarwal (agarwal-navin) deleted the summaryE2ETestDoc branch June 8, 2026 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@markfields Mark Fields (markfields) markfields approved these changes
@Josmithr Joshua Smithrud (Josmithr) Josmithr approved these changes
@alexvy86 Alex Villarreal (alexvy86) Awaiting requested review from alexvy86
@Abe27342 Abram Sanderson (Abe27342) Awaiting requested review from Abe27342

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@agarwal-navin @markfields @Josmithr