Skip to content

Add manual QA checklist for deployment testing#15

Merged
ChrisAdamsdevelopment merged 1 commit into
mainfrom
codex/add-manual-qa-checklist-documentation
May 4, 2026
Merged

Add manual QA checklist for deployment testing#15
ChrisAdamsdevelopment merged 1 commit into
mainfrom
codex/add-manual-qa-checklist-documentation

Conversation

@ChrisAdamsdevelopment
Copy link
Copy Markdown
Owner

@ChrisAdamsdevelopment ChrisAdamsdevelopment commented May 4, 2026

Motivation

  • Provide a repeatable, practical manual QA checklist so the SpectraCleanseAI app can be consistently validated before and after deployment.
  • Make it easy for engineers and QA to follow step-by-step flows for local setup, API smoke tests, auth, billing/mock checkout, uploads, metadata analysis, AI SEO generation, quick/server cleanses, download safety, Docker verification, and production readiness.

Description

  • Added a detailed checklist file at docs/manual-qa-checklist.md that 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.
  • Updated README.md with a new QA / Deployment Testing section linking to docs/manual-qa-checklist.md.
  • Confirmed no application code, Dockerfile, package.json, or package-lock.json changes were made and the committed diff contains only documentation files.

Testing

  • Re-ran npm install followed by npm run build; build now passes on this docs-only branch.
  • Confirmed no application code, Dockerfile, package.json, or package-lock.json changes were made.
  • Confirmed git status --short was clean after validation.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 4, 2026

Reviewer's Guide

Adds 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

Change Details Files
Document a comprehensive, repeatable manual QA workflow covering local setup, core APIs, auth, billing, uploads, cleansing flows, Docker verification, and production readiness.
  • Created a new docs/manual-qa-checklist.md file describing step-by-step QA procedures for local setup and health checks.
  • Documented API smoke tests, auth validation, billing/mock checkout behavior, file upload constraints, metadata analysis, and AI SEO payload generation flows.
  • Outlined quick cleanse vs full server cleanse behaviors, download/object URL safety checks, Docker deployment QA steps, production readiness configuration checklist, and known warnings/limitations.
docs/manual-qa-checklist.md
Expose the new QA checklist from the main project documentation so engineers and QA can easily discover it.
  • Added a 'QA / Deployment Testing' section to the README.
  • Linked the new docs/manual-qa-checklist.md from the README and separated it with markdown horizontal rules for readability.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • 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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ChrisAdamsdevelopment ChrisAdamsdevelopment merged commit 7cfb6dc into main May 4, 2026
2 of 5 checks passed
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 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
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant