Set up TanStack Start sample app with tests, CI/CD, and Bluehawk snippet extraction by tmcneil-mdb · Pull Request #101 · mongodb/docs-sample-apps

tmcneil-mdb · 2026-04-27T04:00:27Z

Overview

This PR establishes the complete workflow for the TanStack Start framework example, which serves as the tested source code for the MongoDB TanStack Start tutorial.

This sets up the foundation for maintaining framework examples as living, tested code that automatically generates documentation snippets.

What's Included

🎯 Complete TanStack Start Sample App

Restaurant browsing application demonstrating MongoDB integration
Server-side data fetching with TanStack Start
Client-side caching with TanStack Query
Full-stack TypeScript implementation

🧪 Comprehensive Test Suite (17 tests)

Unit tests (10 tests): Server functions with mocked MongoDB
Integration tests (7 tests): Full-stack queries with real database
Separate Vitest configs for unit vs integration testing
Test utilities using vite alias

🔄 CI/CD with GitHub Actions

Automated testing on push/PR to development and frameworks-tanstack branches
Sets up MongoDB using Atlas CLI
Runs both unit and integration tests
Generates test summaries with Vitest reporter

📚 Bluehawk Snippet Extraction

Generic snip.js script for all framework examples (reusable!)
Extracts 8 code snippets from annotated source files
Snippets committed directly to repo (no separate artifact repos)
Automated formatting with Prettier

📖 Documentation

Framework-specific README with tutorial link
Comprehensive test documentation
Component testing status explained (not implemented due to TanStack Start beta)

Key Review Areas

🔍 Please Review:

GitHub Actions Workflow (.github/workflows/run-tanstack-tests.yml)
- Does the CI setup make sense?
- Test reporting working as expected?
Bluehawk Snippet Extraction (frameworks/javascript/snip.js)
- Generic script designed for all framework examples
- Check path resolution and configuration handling
- Verify snippet output in testedSnippets/
- Do we like this pattern?
Test Suite (frameworks/javascript/tanstack/tests/)
- Are the test patterns appropriate?
- Unit vs integration split makes sense?
- Coverage is adequate for a sample app?

How to Test this PR

1.) Run the app locally

cd frameworks/javascript/tanstack/app
npm install
cp .env.example .env
# Add your MONGODB_URI to .env
npm run dev
# Visit http://localhost:3000

2.) Run tests

npm run test:all

Extract snippets

cd frameworks/javascript/tanstack
npm install
npm run snip
# Check testedSnippets/ directory

Files Changed

New framework example structure in frameworks/javascript/tanstack/
Generic Bluehawk tooling in frameworks/javascript/
CI/CD workflow and test summary script

Testing

All tests passing locally:

cd frameworks/javascript/tanstack/app

npm run test:all       # 17 tests pass (unit + integration)
npm run test:unit      # 10 tests pass (~400ms)
npm run test:integration # 7 tests pass (~2s)

Bluehawk extraction verified:

cd frameworks/javascript/tanstack
npm run snip          # Generates 8 snippets

Known Limitations / Future Work

📌 Version Pinning (TODO - Separate PR)

TanStack Start version should be pinned to prevent breaking changes
Currently using "latest" in package.json
Should freeze to specific version once tutorial is published

🎨 Component Testing

Not implemented due to TanStack Start beta status
Known compatibility issues between TanStack Start plugin and Vitest
Documented in tests/README.md with more information
Will revisit when TanStack Start reaches v1.0

- Set up Bluehawk for snippet extraction from source code - Add generic snip.js script for framework examples - Add processFiles.js for handling unannotated files - Extract 8 code snippets to testedSnippets/ - Add test:all npm script to run both unit and integration tests - Update all READMEs to clarify test commands (test vs test:all) - Document component testing status (not implemented due to TanStack Start beta) - Add Bluehawk annotations to source files (Header, RestaurantList, db, routes)

cbullinger · 2026-04-27T13:24:09Z

+npm test
+
+# Run only integration tests (requires MongoDB)
+npm run test:integration


I get some failed tests even when connected to an atlas instance with sample data loaded

weird. it worked with a local instance but not my atlas instance

Hmmm I have not be able to successfully reproduce this bug. Do have the error messages? Does it fail every time or intermittently? Which tests were failing?

the integration tests. they're working now; my cluster didn't have any data actually loaded in the sample_restaurants db 🤷

* Set up TanStack Start sample app with tests, CI/CD, and Bluehawk snippet extraction (#101) * Adding TanStack Start + Unit & Integration Tests * Adding GH Actions * Add Bluehawk snippet extraction and improve test documentation - Set up Bluehawk for snippet extraction from source code - Add generic snip.js script for framework examples - Add processFiles.js for handling unannotated files - Extract 8 code snippets to testedSnippets/ - Add test:all npm script to run both unit and integration tests - Update all READMEs to clarify test commands (test vs test:all) - Document component testing status (not implemented due to TanStack Start beta) - Add Bluehawk annotations to source files (Header, RestaurantList, db, routes) * addressing pr feedback * Adding in copier flow (#104)

…106) * Bump pymongo to v4.17.0 * Merge TanStack Framework into Development (#105) * Set up TanStack Start sample app with tests, CI/CD, and Bluehawk snippet extraction (#101) * Adding TanStack Start + Unit & Integration Tests * Adding GH Actions * Add Bluehawk snippet extraction and improve test documentation - Set up Bluehawk for snippet extraction from source code - Add generic snip.js script for framework examples - Add processFiles.js for handling unannotated files - Extract 8 code snippets to testedSnippets/ - Add test:all npm script to run both unit and integration tests - Update all READMEs to clarify test commands (test vs test:all) - Document component testing status (not implemented due to TanStack Start beta) - Add Bluehawk annotations to source files (Header, RestaurantList, db, routes) * addressing pr feedback * Adding in copier flow (#104) * adding pining * fix(python-fastapi): bump pillow and python-dotenv for security advisories - pillow 12.2.0 (CVE-2026-42308 through CVE-2026-42311, GHSA-5xmw-vc9v-4wf2, etc.) - python-dotenv 1.2.2 (CVE-2026-28684, GHSA-mf9w-mj56-hr94) Addresses Dependabot alerts #47-51 on mongodb/docs-sample-apps. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cory Bullinger <cory.bullinger@mongodb.com> Co-authored-by: cory <115956901+cbullinger@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>

* Bump pymongo to v4.17.0 * Merge TanStack Framework into Development (#105) * Set up TanStack Start sample app with tests, CI/CD, and Bluehawk snippet extraction (#101) * Adding TanStack Start + Unit & Integration Tests * Adding GH Actions * Add Bluehawk snippet extraction and improve test documentation - Set up Bluehawk for snippet extraction from source code - Add generic snip.js script for framework examples - Add processFiles.js for handling unannotated files - Extract 8 code snippets to testedSnippets/ - Add test:all npm script to run both unit and integration tests - Update all READMEs to clarify test commands (test vs test:all) - Document component testing status (not implemented due to TanStack Start beta) - Add Bluehawk annotations to source files (Header, RestaurantList, db, routes) * addressing pr feedback * Adding in copier flow (#104) * adding pining * fix(python-fastapi): bump pillow and python-dotenv for security advisories - pillow 12.2.0 (CVE-2026-42308 through CVE-2026-42311, GHSA-5xmw-vc9v-4wf2, etc.) - python-dotenv 1.2.2 (CVE-2026-28684, GHSA-mf9w-mj56-hr94) Addresses Dependabot alerts #47-51 on mongodb/docs-sample-apps. Co-authored-by: Cursor <cursoragent@cursor.com> * Batch Dependabot Fixes & Security Workflow (#110) * fix: dependabot issues and creating audit script * chore:remove cached audit files * chore: updating readme and gitignore * fix: batch updating the python packages for mflix to sure the security passes --------- Co-authored-by: Cory Bullinger <cory.bullinger@mongodb.com> Co-authored-by: cory <115956901+cbullinger@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>

tmcneil-mdb added 3 commits April 23, 2026 17:06

Adding TanStack Start + Unit & Integration Tests

b19747c

Adding GH Actions

3b9ded0

cbullinger requested changes Apr 27, 2026

View reviewed changes

addressing pr feedback

fe0d4f6

tmcneil-mdb requested a review from cbullinger April 28, 2026 23:49

cbullinger approved these changes Apr 29, 2026

View reviewed changes

tmcneil-mdb merged commit 6ab45e6 into development-frameworks May 4, 2026
2 checks passed

tmcneil-mdb deleted the frameworks-tanstack branch May 4, 2026 19:42

tmcneil-mdb mentioned this pull request May 4, 2026

Merge TanStack Framework into Development #105

Merged

tmcneil-mdb mentioned this pull request May 4, 2026

Integrating TanStack Quick Start Application in the Sample App Repo #106

Merged

cbullinger mentioned this pull request Jun 24, 2026

fix: upgrade undici and langsmith to address security vulnerabilities #123

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Set up TanStack Start sample app with tests, CI/CD, and Bluehawk snippet extraction#101

Set up TanStack Start sample app with tests, CI/CD, and Bluehawk snippet extraction#101
tmcneil-mdb merged 4 commits into
development-frameworksfrom
frameworks-tanstack

tmcneil-mdb commented Apr 27, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cbullinger Apr 27, 2026

Uh oh!

cbullinger Apr 27, 2026

Uh oh!

tmcneil-mdb Apr 28, 2026 •

edited

Loading

Uh oh!

cbullinger Apr 29, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

tmcneil-mdb commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

What's Included

🎯 Complete TanStack Start Sample App

🧪 Comprehensive Test Suite (17 tests)

🔄 CI/CD with GitHub Actions

📚 Bluehawk Snippet Extraction

📖 Documentation

Key Review Areas

🔍 Please Review:

How to Test this PR

Files Changed

Testing

Known Limitations / Future Work

📌 Version Pinning (TODO - Separate PR)

🎨 Component Testing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cbullinger Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

cbullinger Apr 27, 2026

Choose a reason for hiding this comment

Uh oh!

tmcneil-mdb Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cbullinger Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tmcneil-mdb commented Apr 27, 2026 •

edited

Loading

tmcneil-mdb Apr 28, 2026 •

edited

Loading