mirror of
https://github.com/hanzoai/opencode-openai-codex-auth.git
synced 2026-09-24 17:01:02 +00:00
This release includes comprehensive OpenAI ToS compliance updates and fixes 4 critical bugs that prevented per-model options and multi-turn conversations from working correctly. ## ๐ Compliance & Legal Updates ### Terms of Service & Usage Guidelines - Added comprehensive ToS & Usage Notice to README emphasizing personal use only - Added Rate Limits & Responsible Use section with best practices - Added extensive FAQ section addressing TOS compliance questions - Updated LICENSE with MIT + Usage Disclaimer for personal development use - Added compliance header to index.ts documenting intended use cases ### New Documentation - **CONTRIBUTING.md**: Complete contribution guidelines with compliance requirements - **SECURITY.md**: Security policy, vulnerability reporting, best practices - **docs/privacy.md**: Comprehensive privacy & data handling documentation - **Issue Templates**: Bug reports & feature requests with compliance checklists ### Documentation Updates - Updated docs/index.md with usage notice and trademark disclaimers - Updated docs/getting-started.md with "Before You Begin" compliance notice - Updated docs/troubleshooting.md with subscription & compliance sections - All references updated to "Plus/Pro" (removed Team/Enterprise mentions) ### Key Compliance Principles - โ Emphasizes personal development use with own ChatGPT Plus/Pro subscription - โ Uses OpenAI's official OAuth authentication (same as Codex CLI) - โ Clear prohibition of commercial resale, multi-user services - โ Not a "free API alternative" - uses existing ChatGPT subscription - โ Proper trademark notices and attribution to OpenAI - โ Transparent about data handling and privacy ## ๐ Critical Bug Fixes ### Bug #1: Per-Model Options Ignored (Config Lookup Mismatch) **Severity:** ๐ด HIGH Users configured different reasoning levels for each model variant, but all variants behaved identically because the plugin was looking up normalized model names instead of the original config keys. **Fix:** lib/request/request-transformer.ts:277 - Use original model name for config lookup before normalization - Allows per-model options to work correctly - Impact: Different reasoning levels now properly applied per variant ### Bug #2: Multi-Turn Conversations Fail (AI SDK Compatibility) **Severity:** ๐ด CRITICAL Multi-turn conversations failed with "Item not found" errors because: 1. AI SDK sends `item_reference` (not in Codex API spec) 2. IDs weren't completely stripped for stateless mode (store: false) **Fix:** lib/request/request-transformer.ts:114-135 - Filter out AI SDK `item_reference` items - Strip ALL IDs from remaining items (not just rs_* prefix) - Confirmed ChatGPT backend requires store: false via testing - Full message history preserved for LLM context ### Bug #3: Case-Sensitive Normalization **Severity:** ๐ก MEDIUM **Fix:** lib/request/request-transformer.ts:22-27 - Added toLowerCase() for case-insensitive matching - Backwards compatible with old verbose config names - Handles uppercase/mixed case user input ### Bug #4: GitHub API Rate Limiting **Severity:** ๐ก MEDIUM Plugin checked GitHub on every request, exhausting 60 req/hour limit. 15-minute cache timestamp was stored but never checked. **Fix:** lib/prompts/codex.ts:50-53, lib/prompts/opencode-codex.ts:47-50 - Check cache TTL before GitHub API call - Only fetch if cache >15min old - Prevents rate limit exhaustion during testing ## โจ Enhancements ### Debug Logging System - New environment variable: `DEBUG_CODEX_PLUGIN=1` - Added logDebug() and logWarn() functions - Shows config lookups, ID filtering, options resolution - File: lib/logger.ts ### Optimized Config Structure - Changed to Codex CLI preset names (gpt-5-codex-low, etc.) - Removed redundant `id` field (not used by OpenAI provider) - Added `name` field for friendly TUI display - File: config/full-opencode.json ### GitHub Pages Documentation - Complete documentation restructure for GitHub Pages - User guides: getting-started.md, configuration.md, troubleshooting.md - Developer guides: ARCHITECTURE.md, CONFIG_FLOW.md, CONFIG_FIELDS.md, TESTING.md - Privacy policy, security policy, contribution guidelines ## ๐งช Testing ### Test Coverage - โ 159 unit tests passing (30+ new tests) - โ 14 integration tests passing (actual API verification) - โ All documented scenarios have test coverage ### Integration Tests (scripts/test-all-models.sh) - Tests all 9 custom model configurations - Tests all 4 default OpenCode models - Verifies backwards compatibility with old config format - Uses ENABLE_PLUGIN_REQUEST_LOGGING to verify actual API requests ### Test Results - 14/14 model configuration tests passing - All per-model options verified correct - Multi-turn conversations work without errors - Backwards compatibility confirmed ## ๐ Files Changed ### Modified (7 files) - lib/request/request-transformer.ts: Config lookup & ID filtering fixes - lib/prompts/codex.ts: 15-minute cache TTL - lib/prompts/opencode-codex.ts: 15-minute cache TTL - lib/logger.ts: Debug logging system - config/full-opencode.json: Optimized structure - test/request-transformer.test.ts: 30+ new tests - LICENSE: Added usage disclaimer - index.ts: Added compliance header - README.md: Added ToS, Rate Limits, FAQ sections ### Created (20+ files) - CONTRIBUTING.md: Contribution guidelines - SECURITY.md: Security policy - docs/index.md: GitHub Pages landing - docs/getting-started.md: Installation guide - docs/configuration.md: Advanced config - docs/troubleshooting.md: Debug guide - docs/privacy.md: Privacy policy - docs/development/ARCHITECTURE.md: Technical architecture - docs/development/CONFIG_FLOW.md: Config system internals - docs/development/CONFIG_FIELDS.md: Field usage guide - docs/development/TESTING.md: Testing guide - .github/ISSUE_TEMPLATE/bug_report.md - .github/ISSUE_TEMPLATE/feature_request.md - .github/ISSUE_TEMPLATE/config.yml - scripts/test-all-models.sh: Automated testing ## ๐ฏ Verification All scenarios tested and verified: - โ Default models work without config - โ Custom models with per-variant options - โ Old config format (backwards compatible) - โ Mixed default + custom models - โ Multi-turn conversations (no "item not found" errors) - โ Model switching with different options - โ All normalization patterns - โ Complete ID filtering ## ๐ Documentation Complete documentation suite (100+ KB): - User guides for installation, configuration, troubleshooting - Developer guides for architecture, config system, testing - Privacy policy and security policy - Compliance guidelines and contribution requirements - Release notes in tmp/release-notes/ ## ๐ References - OpenAI Terms of Use: https://openai.com/policies/terms-of-use/ - OpenAI Usage Policies: https://openai.com/policies/usage-policies/ - OpenAI Platform API: https://platform.openai.com/ - OpenAI Codex CLI: https://github.com/openai/codex Co-authored-by: Hanzo Dev <[email protected]>
121 lines
3.4 KiB
TypeScript
121 lines
3.4 KiB
TypeScript
/**
|
|
* OpenCode Codex Prompt Fetcher
|
|
*
|
|
* Fetches and caches the codex.txt system prompt from OpenCode's GitHub repository.
|
|
* Uses ETag-based caching to efficiently track updates.
|
|
*/
|
|
|
|
import { join } from "node:path";
|
|
import { homedir } from "node:os";
|
|
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
|
|
|
const OPENCODE_CODEX_URL =
|
|
"https://raw.githubusercontent.com/sst/opencode/main/packages/opencode/src/session/prompt/codex.txt";
|
|
const CACHE_DIR = join(homedir(), ".opencode", "cache");
|
|
const CACHE_FILE = join(CACHE_DIR, "opencode-codex.txt");
|
|
const CACHE_META_FILE = join(CACHE_DIR, "opencode-codex-meta.json");
|
|
|
|
interface CacheMeta {
|
|
etag: string;
|
|
lastFetch?: string; // Legacy field for backwards compatibility
|
|
lastChecked: number; // Timestamp for rate limit protection
|
|
}
|
|
|
|
/**
|
|
* Fetch OpenCode's codex.txt prompt with ETag-based caching
|
|
* Uses HTTP conditional requests to efficiently check for updates
|
|
*
|
|
* Rate limit protection: Only checks GitHub if cache is older than 15 minutes
|
|
* @returns The codex.txt content
|
|
*/
|
|
export async function getOpenCodeCodexPrompt(): Promise<string> {
|
|
await mkdir(CACHE_DIR, { recursive: true });
|
|
|
|
// Try to load cached content and metadata
|
|
let cachedContent: string | null = null;
|
|
let cachedMeta: CacheMeta | null = null;
|
|
|
|
try {
|
|
cachedContent = await readFile(CACHE_FILE, "utf-8");
|
|
const metaContent = await readFile(CACHE_META_FILE, "utf-8");
|
|
cachedMeta = JSON.parse(metaContent);
|
|
} catch {
|
|
// Cache doesn't exist or is invalid, will fetch fresh
|
|
}
|
|
|
|
// Rate limit protection: If cache is less than 15 minutes old, use it
|
|
const CACHE_TTL_MS = 15 * 60 * 1000; // 15 minutes
|
|
if (cachedMeta?.lastChecked && (Date.now() - cachedMeta.lastChecked) < CACHE_TTL_MS && cachedContent) {
|
|
return cachedContent;
|
|
}
|
|
|
|
// Fetch from GitHub with conditional request
|
|
const headers: Record<string, string> = {};
|
|
if (cachedMeta?.etag) {
|
|
headers["If-None-Match"] = cachedMeta.etag;
|
|
}
|
|
|
|
try {
|
|
const response = await fetch(OPENCODE_CODEX_URL, { headers });
|
|
|
|
// 304 Not Modified - cache is still valid
|
|
if (response.status === 304 && cachedContent) {
|
|
return cachedContent;
|
|
}
|
|
|
|
// 200 OK - new content available
|
|
if (response.ok) {
|
|
const content = await response.text();
|
|
const etag = response.headers.get("etag") || "";
|
|
|
|
// Save to cache with timestamp
|
|
await writeFile(CACHE_FILE, content, "utf-8");
|
|
await writeFile(
|
|
CACHE_META_FILE,
|
|
JSON.stringify(
|
|
{
|
|
etag,
|
|
lastFetch: new Date().toISOString(), // Keep for backwards compat
|
|
lastChecked: Date.now(),
|
|
} satisfies CacheMeta,
|
|
null,
|
|
2
|
|
),
|
|
"utf-8"
|
|
);
|
|
|
|
return content;
|
|
}
|
|
|
|
// Fallback to cache if available
|
|
if (cachedContent) {
|
|
return cachedContent;
|
|
}
|
|
|
|
throw new Error(`Failed to fetch OpenCode codex.txt: ${response.status}`);
|
|
} catch (error) {
|
|
// Network error - fallback to cache
|
|
if (cachedContent) {
|
|
return cachedContent;
|
|
}
|
|
|
|
throw new Error(
|
|
`Failed to fetch OpenCode codex.txt and no cache available: ${error}`
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get first N characters of the cached OpenCode prompt for verification
|
|
* @param chars Number of characters to get (default: 50)
|
|
* @returns First N characters or null if not cached
|
|
*/
|
|
export async function getCachedPromptPrefix(chars = 50): Promise<string | null> {
|
|
try {
|
|
const content = await readFile(CACHE_FILE, "utf-8");
|
|
return content.substring(0, chars);
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|