docs: harden Public Beta launch/ops readiness (excluding E2E/OpenAI execution)#72
Open
sasazaki1994 wants to merge 2 commits into
Open
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughPublic Beta ローンチの準備として、環境変数設定の標準化、本番環境での認証安全性ガード、包括的な起動・運用チェックリストとドキュメント、および受入テストの統合が行われた。 ChangesPublic Beta ローンチ準備フェーズ
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/openai-smoke-test-plan.md`:
- Around line 96-98: Failure triage セクションのテーブルが前後に空行がないため MD058 警告が出ていますので、ヘッダ
"## Failure triage" とその下のテーブル行（| Symptom | Likely area | Action |
...）の前後に1行ずつ空行を挿入してテーブルを空行で囲んでください。
In `@docs/public-beta-launch-checklist.md`:
- Around line 30-39: Change the "Required environment variables" section so
OpenAI keys are conditional: state that TRACEMAP_OPENAI_API_KEY or
OPENAI_API_KEY (and TRACEMAP_OPENAI_MODEL / TRACEMAP_OPENAI_TIMEOUT_MS) are only
required when running the OpenAI smoke tests or when
TRACEMAP_ANSWER_GRAPH_PROVIDER is set to an OpenAI-backed provider; keep
DATABASE_URL, TRACEMAP_SESSION_SECRET, TRACEMAP_BETA_ACCESS_CODE and
TRACEMAP_ANSWER_GRAPH_PROVIDER as always-required, and add a short note
explaining the SKIPPED-without-key behavior to align GO/NO-GO criteria.
In `@tests/beta-auth-production-guard.test.ts`:
- Around line 11-16: The code restores NODE_ENV using Reflect.set(process.env,
"NODE_ENV", originalEnv.NODE_ENV) which will turn undefined into the string
"undefined"; change the restore logic to mirror the TRACEMAP_BETA_ACCESS_CODE
handling: if originalEnv.NODE_ENV is undefined then delete process.env.NODE_ENV,
else set process.env.NODE_ENV = originalEnv.NODE_ENV so the environment is
correctly restored and avoids contaminating later tests.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c8d50c0e-bdcc-4b14-8c41-052be2aeb78e
📒 Files selected for processing (9)
.env.exampleREADME.mdacceptance/public-beta-readiness.featuredocs/openai-smoke-test-plan.mddocs/public-beta-final-validation-template.mddocs/public-beta-launch-checklist.mddocs/public-beta-operations.mdspecs/public-beta-readiness.mdtests/beta-auth-production-guard.test.ts
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
1 participant
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.
Motivation
Description
docs/public-beta-launch-checklist.md,docs/public-beta-operations.md, anddocs/public-beta-final-validation-template.mdto capture GO/NO-GO criteria, daily ops, incidents, and a final validation template.docs/openai-smoke-test-plan.mdwith a pre-run checklist, command examples, UI execution steps, post-run recording fields, secret handling guidance, and a failure triage table..env.examplewith explicit Public Beta / production guard comments and clarified mock vs OpenAI provider settings without adding secrets.## Public Beta Launchsection toREADME.mdand referenced the new docs fromspecs/public-beta-readiness.mdandacceptance/public-beta-readiness.feature(added acceptance scenario asserting doc availability).tests/beta-auth-production-guard.test.tsthat assertsTRACEMAP_BETA_ACCESS_CODEis required in production and adjusted the test to useReflect.set(process.env, ...)to avoid read-only assignment errors.Testing
pnpm installandpnpm exec prisma generate, both succeeded.DATABASE_URL="postgresql://postgres:postgres@localhost:5432/tracemap?schema=public" pnpm exec prisma validateand it succeeded.pnpm lint,pnpm typecheck,pnpm test(Vitest), andpnpm build, all succeeded (pnpm testresult: 205 tests passed); the newly added unit test passes.pnpm exec playwright install --with-deps chromiumandpnpm test:e2e, but Playwright browser install failed in this environment (network/proxy/CDN 403), so E2E runs were not executed as intended and OpenAI 3-topic smoke tests were intentionally not executed in this task (API key required).Codex Task
Summary by CodeRabbit
Documentation
Tests
Chores