Skip to content

docs: Snapshots, Utils workspace, origin policy, and dialect list - #438

Merged
huyplb merged 3 commits into
mainfrom
cursor/engineering-documentation-updates-4ba8
Sep 29, 2026
Merged

huyplb merged 3 commits into
mainfrom
cursor/engineering-documentation-updates-4ba8

Conversation

@cursor

@cursor cursor Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Weekly engineering-docs pass against main (0.2.265). No product-code changes.

Docs added/updated

  • USER_GUIDE.md — left-rail names (Compare / Editor / Utils / Snapshots); Utils as its own workspace; Snapshots vs Applies; Same DB warning; partial-grid data compare; Edit/Delete unique-key rule; origin 403 troubleshooting.
  • README.md — 14 SQL dialects (+ MongoDB/Redis settings-only).
  • DEPLOYMENT.md + .env.example — FOX_ALLOWED_ORIGINS and the literal-IP dev allowlist.
  • CONTRIBUTING.md — DIALECTS.md is tracked; E2E sweep timeouts and Lokee 20/min rate-limit helper; dialectFamily().
  • ARCHITECTURE.md / CODE_MAP.md / WORKFLOW.md — dialect families, origin guard, unknown fromPort refused at save.
  • UNRELEASED.md — workspace and origin-policy notes for the next GitHub Release.
  • sql-editor-agent-memory.mdc — Index Management / Clone Table live in Utils, not the SQL Editor sidebar.

Codepaths covered

  • UtilitiesView.tsx (Utils workspace; Editor sidebar utilities/files return null)
  • LokeeWeaveView / ForceMigrateModal / reversalGate (Snapshots, revert vs force-migrate)
  • ActivityRail (Snapshots vs Applies)
  • origin-policy.ts (FOX_ALLOWED_ORIGINS, LAN Vite Origins)
  • alignResultGridsByKey / migrateKeysSafeForMutatingOps
  • dialectFamily() in provider-settings.ts
  • assertKnownFromPorts at workflow save
  • apps/e2e/scripts/run-all.mjs + rate-limited.ts

Knowledge gaps addressed

  • User guide still described a SQL Editor Utilities sidebar and a single History pane.
  • README/ARCHITECTURE under-counted dialects (10 vs 14 SQL).
  • LAN npm run dev 403s looked like a blank UI with no runbook.
  • E2E sweep timeouts and capture/revert 429s had no contributor notes.
  • CONTRIBUTING still called DIALECTS.md gitignored.

Verified: npx vitest run packages/shared/src/doc-paths.test.ts (20 passed, 2 skipped).

Open in Web View Automation 

Note

Low Risk
Markdown and env-example documentation only; no runtime or API behavior changes in this diff.

Overview
Documentation-only pass (no application code in the diff). Docs are brought in line with current UI and ops behavior from ~0.2.265.

Navigation & workspaces: User-facing copy now uses the left rail (Compare, Editor, Utils, Snapshots, Creds, Applies) and treats Utils as its own workspace (Index Management, Clone Table, insights, DB users & grants, Query files)—not a SQL Editor sidebar. Snapshots (Lokee schema history) is separated from Applies (migration run history). Home, credential grouping, and agent memory (sql-editor-agent-memory.mdc) are updated the same way.

Deploy & troubleshooting: .env.example and DEPLOYMENT.md document FOX_ALLOWED_ORIGINS and dev origin rules (literal LAN IPs on 5173/5199/3210/3211). USER_GUIDE.md adds origin 403 troubleshooting and FOXFLOW_FILES_DIR in workflow env examples.

Product behavior in prose: SQL Editor section moves utilities detail into a Utilities chapter; adds Same DB warning rules, partial-page data-compare behavior, and Edit/Delete unique-key requirements for data migrate. Snapshots documents revert vs force-migrate and shared normalizeDefinitionText with Compare.

Contributor / architecture: README.md / ARCHITECTURE.md list 14 SQL dialects (+ MongoDB/Redis settings-only). CONTRIBUTING.md notes tracked DIALECTS.md, E2E sweep timeouts in run-all.mjs, and rate-limited.ts for Lokee/db-access 20/min limits; conventions push dialectFamily() over hand-rolled dialect chains. CODE_MAP.md, WORKFLOW.md, and UNRELEASED.md mirror workspace split, origin policy, and workflow save-time fromPort validation.

Reviewed by Cursor Bugbot for commit 55c152e. Bugbot is set up for automated code reviews on this repo. Configure here.

cursoragent and others added 3 commits September 28, 2026 16:09
The left rail is Compare / Editor / Utils / Snapshots, not Schema Sync plus
a SQL Editor sidebar. History split into Snapshots (Lokee) and Applies
(migration runs). README lists all 14 SQL dialects.

Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
Record FOX_ALLOWED_ORIGINS and the literal-IP dev allowlist, the E2E
rate-limit helper and suite timeouts, DIALECTS.md as tracked, and
assertKnownFromPorts at workflow save. Point agent memory at the Utils
workspace instead of the SQL Editor sidebar.

Co-authored-by: huy.ph1988 <huy.ph1988@gmail.com>
@huyplb
huyplb marked this pull request as ready for review September 29, 2026 19:34
@huyplb
huyplb merged commit 783af1e into main Sep 29, 2026
11 checks passed
@huyplb
huyplb deleted the cursor/engineering-documentation-updates-4ba8 branch September 29, 2026 19:34
@cursor

cursor Bot commented Sep 29, 2026

Copy link
Copy Markdown
Contributor Author

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_15c84462-56f6-4be0-84f7-1c5a06796eb4)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants