Add manual QA checklist for deployment testing#15
Conversation
Reviewer's GuideAdds a new manual QA checklist document for deployment testing and links it from the README, without modifying any application code or build configuration. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Since
npm run buildcurrently fails with the unresolvedbrowser-id3-writerimport, consider updating the manual QA checklist (or Known warnings) to explicitly call out this failure, its impact on the checklist steps, and any temporary workaround so future reviewers don’t treat it as a new regression. - In the Docker and local env examples where you show secrets (JWT, Stripe keys, Gemini API key), consider adding a short note that these are placeholders and should be injected via a secure mechanism (e.g.,
.env/secret manager) rather than literal values in shell history or scripts, to reduce the risk of accidental exposure.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Since `npm run build` currently fails with the unresolved `browser-id3-writer` import, consider updating the manual QA checklist (or Known warnings) to explicitly call out this failure, its impact on the checklist steps, and any temporary workaround so future reviewers don’t treat it as a new regression.
- In the Docker and local env examples where you show secrets (JWT, Stripe keys, Gemini API key), consider adding a short note that these are placeholders and should be injected via a secure mechanism (e.g., `.env`/secret manager) rather than literal values in shell history or scripts, to reduce the risk of accidental exposure.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 49c57f12a6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ``` | ||
| 3. Start the server with safe local environment variables: | ||
| ```bash | ||
| NODE_ENV=development JWT_SECRET=dev_jwt_secret_change_me ENABLE_MOCK_CHECKOUT=true DB_PATH=./spectra.db FRONTEND_URL=http://localhost:5173 PORT=3001 npm start |
There was a problem hiding this comment.
Use matching FRONTEND_URL for local checkout QA
The local setup command sets FRONTEND_URL=http://localhost:5173 while the checklist then tells testers to run and use the app at http://localhost:3001; in this configuration, mock checkout redirects to 5173 (/api/create-checkout-session builds URLs from FRONTEND_URL), so the checkout=success|cancelled return params are not delivered to the running app and the billing QA steps for success/cancel banners become untestable or falsely fail.
Useful? React with 👍 / 👎.
Motivation
Description
docs/manual-qa-checklist.mdthat enumerates step-by-step QA procedures for local setup, API smoke tests, auth flow, billing/mock checkout, file uploads, metadata analysis, AI SEO payload generation, quick cleanse, full server cleanse, object URL/download safety, Docker deployment QA, production readiness, and known warnings.README.mdwith a newQA / Deployment Testingsection linking todocs/manual-qa-checklist.md.Dockerfile,package.json, orpackage-lock.jsonchanges were made and the committed diff contains only documentation files.Testing
npm installfollowed bynpm run build; build now passes on this docs-only branch.Dockerfile,package.json, orpackage-lock.jsonchanges were made.git status --shortwas clean after validation.