Add Mongoose + DocumentDB playground#415
Open
hossain-rayhan wants to merge 1 commit into
Open
Conversation
hossain-rayhan
requested review from
WentingWu666666,
alaye-ms and
xgerman
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new self-contained Node.js playground under documentdb-playground/mongoose/ to demonstrate and validate using Mongoose (ODM) against the DocumentDB gateway (TLS + direct connection), including both an Express REST API and a standalone CRUD/compatibility test script.
Changes:
- Introduces an Express + Mongoose demo API (
/health,/booksCRUD,/stats/genresaggregation). - Adds a standalone Mongoose CRUD/compatibility suite plus helper scripts to run locally via
kubectl port-forward(and optionally deploy in-cluster). - Provides Kubernetes manifests and detailed README covering setup, configuration, and known compatibility caveats.
Reviewed changes
Copilot reviewed 15 out of 16 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| documentdb-playground/mongoose/README.md | Documents architecture, setup paths, configuration, and compatibility notes. |
| documentdb-playground/mongoose/documentdb.yaml | Sample DocumentDB instance manifest sized/pinned for the playground. |
| documentdb-playground/mongoose/k8s/mongoose-app.yaml | Optional in-cluster Deployment/Service for the demo app. |
| documentdb-playground/mongoose/scripts/lib.sh | Shared helpers for resolving the connection string and managing port-forward. |
| documentdb-playground/mongoose/scripts/run-app.sh | Runs the Express app locally via a temporary port-forward. |
| documentdb-playground/mongoose/scripts/run-test.sh | Runs the CRUD/compatibility test locally via a temporary port-forward. |
| documentdb-playground/mongoose/scripts/deploy.sh | Optional path: build image, (kind) load, create Secret, deploy app in-cluster. |
| documentdb-playground/mongoose/scripts/cleanup.sh | Removes the optional in-cluster demo deployment. |
| documentdb-playground/mongoose/app/package.json | Declares Node app metadata and dependencies (express, mongoose). |
| documentdb-playground/mongoose/app/package-lock.json | Locks dependency graph for reproducible installs. |
| documentdb-playground/mongoose/app/db.js | Centralizes DocumentDB-specific Mongoose connection options + URI sanitization. |
| documentdb-playground/mongoose/app/models/book.js | Defines the sample Book schema/model and indexes. |
| documentdb-playground/mongoose/app/server.js | Implements the REST API and health endpoint. |
| documentdb-playground/mongoose/app/mongoose-crud-test.js | Standalone CRUD/compatibility test runner with pass/fail summary. |
| documentdb-playground/mongoose/app/Dockerfile | Container image build for the optional in-cluster deployment path. |
| documentdb-playground/mongoose/app/.dockerignore | Excludes local-only artifacts from Docker build context. |
Files not reviewed (1)
- documentdb-playground/mongoose/app/package-lock.json: Generated file
Comment on lines
+44
to
+48
| gateway_port() { | ||
| local uri="$1" port | ||
| port=$(echo "$uri" | sed -E 's#.*@[^:/]+:([0-9]+).*#\1#') | ||
| echo "${port:-10260}" | ||
| } |
Comment on lines
+68
to
+81
| local i | ||
| for i in $(seq 1 15); do | ||
| if grep -q "Forwarding from" "$logfile" 2>/dev/null; then | ||
| break | ||
| fi | ||
| if ! kill -0 "$pid" 2>/dev/null; then | ||
| echo "port-forward to $svc failed; see $logfile" >&2 | ||
| return 1 | ||
| fi | ||
| sleep 1 | ||
| done | ||
|
|
||
| echo "$pid" | ||
| } |
Comment on lines
+44
to
+52
| // Fetch a single book by id. | ||
| app.get('/books/:id', async (req, res) => { | ||
| try { | ||
| const book = await Book.findById(req.params.id).lean(); | ||
| if (!book) return res.status(404).json({ error: 'not found' }); | ||
| res.json(book); | ||
| } catch (err) { | ||
| res.status(400).json({ error: err.message }); | ||
| } |
Comment on lines
+36
to
+37
| echo "Installing app dependencies (express, mongoose)..." | ||
| (cd "$APP_DIR" && npm install --omit=dev --no-audit --no-fund >/dev/null) |
Comment on lines
+34
to
+35
| echo "Installing test dependencies (mongoose)..." | ||
| (cd "$APP_DIR" && npm install --omit=dev --no-audit --no-fund >/dev/null) |
Comment on lines
+6
to
+8
| # Install dependencies first for better layer caching. | ||
| COPY package.json ./ | ||
| RUN npm install --omit=dev |
Signed-off-by: Rayhan Hossain <hossain.rayhan@outlook.com>
hossain-rayhan
force-pushed
the
rayhan/mongoose-playground
branch
from
79726a5 to
8521785
Compare
documentdb-triage-tool
Bot
added
documentation
|
🤖 Auto-triaged by documentdb-triage-tool. Applied: Reasoningcomponent from path globs (playground, docs); effort from diff stats (2243+0 LOC, 16 files); LLM: Adds a new self-contained Mongoose + DocumentDB playground under documentdb-playground/, including app code, test suites, helper scripts, manifests, and documentation — a multi-file addition to one component. If a label is wrong, remove it manually and ping |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Mongoose + DocumentDB playground
Adds a self-contained playground under
documentdb-playground/mongoose/that demonstrates and validates using Mongoose (the popular Node.js MongoDB ODM) against DocumentDB.What's included
app/server.js,app/models/book.js,app/db.js) — health, CRUD, and a genre-aggregation endpoint.app/mongoose-crud-test.js) — connect, index sync, insertOne/insertMany, filtered find + sort + limit, countDocuments, updateOne, findOneAndUpdate, aggregation, unique-index enforcement, deleteOne, and drop.scripts/):run-app.sh/run-test.sh— primary path: run the app/tests locally against an in-cluster DocumentDB via a temporarykubectl port-forward.deploy.sh/cleanup.sh— optional path: build the image, load into kind, and run the app in-cluster.lib.sh— shared helpers (resolveMONGO_URIfrom the DocumentDB status, manage the port-forward).documentdb.yaml(sample DocumentDB instance sized for the demo) andk8s/mongoose-app.yaml(in-cluster Deployment + Service).How Mongoose connects
The DocumentDB gateway speaks the MongoDB wire protocol as a standalone server over TLS, so the app/test require
directConnection: true,tls: true,tlsAllowInvalidCertificates: true(for the default self-signed install), and stripreplicaSet=rs0from the connection string. The scripts handle this automatically.Validation (local kind, all default images