-
-
Notifications
You must be signed in to change notification settings - Fork 33
feat: SafeQL playground #480
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Newbie012
wants to merge
1
commit into
main
Choose a base branch
from
feat/playground
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,880
−34
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <!doctype html> | ||
| <html lang="en" class="dark"> | ||
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <meta name="color-scheme" content="dark" /> | ||
| <title>SafeQL Playground</title> | ||
| <!-- crossorigin so the cross-origin font requests pass the COEP (require-corp) check. --> | ||
| <link rel="preconnect" href="https://fonts.googleapis.com" crossorigin /> | ||
| <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin /> | ||
| <link | ||
| rel="stylesheet" | ||
| href="https://fonts.googleapis.com/css2?family=Geist+Mono:wght@400;500;600&family=Geist:wght@400;500;600;700&display=swap" | ||
| crossorigin | ||
| /> | ||
| </head> | ||
| <body> | ||
| <div id="app"></div> | ||
| <script type="module" src="/src/main.ts"></script> | ||
| </body> | ||
| </html> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| { | ||
| "name": "@ts-safeql/playground", | ||
| "private": true, | ||
| "version": "0.0.0", | ||
| "type": "module", | ||
| "scripts": { | ||
| "dev": "vite", | ||
| "build": "vue-tsc -b && vite build", | ||
| "preview": "vite preview", | ||
| "typecheck": "vue-tsc -b" | ||
| }, | ||
| "dependencies": { | ||
| "@electric-sql/pglite": "^0.5.1", | ||
| "@shikijs/monaco": "^4.2.0", | ||
| "@ts-safeql/eslint-plugin": "workspace:*", | ||
| "@ts-safeql/generate": "workspace:*", | ||
| "@ts-safeql/shared": "workspace:*", | ||
| "@ts-safeql/sql-ast": "workspace:*", | ||
| "@typescript-eslint/parser": "catalog:", | ||
| "eslint": "catalog:", | ||
| "eslint-linter-browserify": "^10.4.1", | ||
| "fp-ts": "^2.16.9", | ||
| "libpg-query": "catalog:", | ||
| "monaco-editor": "^0.55.1", | ||
| "shiki": "^4.2.0", | ||
| "vue": "^3.5.13" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "catalog:", | ||
| "@vitejs/plugin-vue": "^5.2.3", | ||
| "postgres": "catalog:", | ||
| "typescript": "catalog:", | ||
| "vite": "^6.4.3", | ||
| "vue-tsc": "^2.2.8" | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Cross-origin isolation is required for SharedArrayBuffer (the Atomics bridge to the DB worker). | ||
| # Netlify / Cloudflare Pages read this file; Vercel uses vercel.json; the dev/preview servers | ||
| # get the same headers from the crossOriginIsolation plugin in vite.config.ts. | ||
| /* | ||
| Cross-Origin-Opener-Policy: same-origin | ||
| Cross-Origin-Embedder-Policy: require-corp |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,315 @@ | ||
| <script setup lang="ts"> | ||
| import { computed, onMounted, onUnmounted, ref, watch, type Ref } from "vue"; | ||
| import MonacoEditor from "./components/MonacoEditor.vue"; | ||
| import { DEFAULT_CODE, DEFAULT_CONFIG, DEFAULT_SCHEMA } from "./lib/defaults"; | ||
| import type { EngineDiagnostic } from "./lib/eslint-engine"; | ||
| import { parsePlaygroundConfig } from "./lib/playground-config"; | ||
| import { lintReal } from "./lib/real-lint-client"; | ||
| import { readPlaygroundStateFromUrl, writePlaygroundStateToUrl } from "./lib/share-url"; | ||
|
|
||
| // Start from defaults; if the URL carries shared state we hydrate it in onMounted (decoding is | ||
| // async because it inflates a compressed hash). | ||
| const schema = ref(DEFAULT_SCHEMA); | ||
| const code = ref(DEFAULT_CODE); | ||
| const config = ref(DEFAULT_CONFIG); | ||
| const diagnostics = ref<EngineDiagnostic[]>([]); | ||
| const status = ref("Ready"); | ||
| const lintError = ref<string | null>(null); | ||
| const configError = ref<string | null>(null); | ||
| const loading = ref(false); | ||
|
|
||
| let lintTimer: ReturnType<typeof setTimeout> | undefined; | ||
| let urlTimer: ReturnType<typeof setTimeout> | undefined; | ||
| let lintId = 0; | ||
| let hydrateId = 0; | ||
| const shareStatus = ref<string | null>(null); | ||
|
|
||
| async function runLint() { | ||
| const currentId = ++lintId; | ||
| loading.value = true; | ||
| status.value = "Linting…"; | ||
| lintError.value = null; | ||
|
|
||
| const parsedConfig = parsePlaygroundConfig(config.value); | ||
| configError.value = parsedConfig.error ?? null; | ||
|
|
||
| try { | ||
| const result = await lintReal({ | ||
| schema: schema.value, | ||
| code: code.value, | ||
| config: parsedConfig.config, | ||
| }); | ||
|
|
||
| // A newer lint started while we were awaiting — drop this stale result. | ||
| if (currentId !== lintId) { | ||
| return; | ||
| } | ||
| diagnostics.value = result; | ||
| const count = result.length; | ||
| status.value = count === 0 ? "No issues" : count === 1 ? "1 issue" : `${count} issues`; | ||
| } catch (error) { | ||
| if (currentId !== lintId) { | ||
| return; | ||
| } | ||
| lintError.value = error instanceof Error ? error.message : String(error); | ||
| diagnostics.value = []; | ||
| status.value = "Lint failed"; | ||
| } finally { | ||
| if (currentId === lintId) { | ||
| loading.value = false; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| function scheduleLint() { | ||
| clearTimeout(lintTimer); | ||
| lintTimer = setTimeout(() => void runLint(), 200); | ||
| } | ||
|
|
||
| // Fire-and-forget hash sync. Swallows a rare encode failure (e.g. CompressionStream abort) so it | ||
| // can't surface as an unhandled rejection; the hash simply stays at its previous value. | ||
| function syncUrlToState() { | ||
| void writePlaygroundStateToUrl({ | ||
| schema: schema.value, | ||
| code: code.value, | ||
| config: config.value, | ||
| }).catch(() => undefined); | ||
| } | ||
|
|
||
| function scheduleUrlSync() { | ||
| // writePlaygroundStateToUrl no-ops when the encoded state is unchanged, so applying state from | ||
| // a hashchange and re-syncing is harmless. | ||
| clearTimeout(urlTimer); | ||
| urlTimer = setTimeout(syncUrlToState, 300); | ||
| } | ||
|
|
||
| async function applyStateFromUrl() { | ||
| // Guard against overlapping hydrations (rapid hashchanges, or one during initial mount): only | ||
| // the most recent invocation applies, so results can't land out of order. | ||
| const id = ++hydrateId; | ||
| const hadHash = window.location.hash.replace(/^#/, "").length > 0; | ||
| const next = await readPlaygroundStateFromUrl(); | ||
| if (id !== hydrateId) { | ||
| return; | ||
| } | ||
|
|
||
| if (!next) { | ||
| // A non-empty but undecodable hash is a broken share link — tell the user rather than | ||
| // silently showing the defaults (which looks identical to a fresh visit). | ||
| if (hadHash) { | ||
| shareStatus.value = "Failed to load shared link"; | ||
| setTimeout(() => { | ||
| shareStatus.value = null; | ||
| }, 2000); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| schema.value = next.schema; | ||
| code.value = next.code; | ||
| config.value = next.config ?? DEFAULT_CONFIG; | ||
| } | ||
|
|
||
| async function copyShareUrl() { | ||
| // Flush the pending URL-sync debounce so we never copy a hash that lags the latest edits. | ||
| clearTimeout(urlTimer); | ||
|
|
||
| try { | ||
| await writePlaygroundStateToUrl({ | ||
| schema: schema.value, | ||
| code: code.value, | ||
| config: config.value, | ||
| }); | ||
| await navigator.clipboard.writeText(window.location.href); | ||
| shareStatus.value = "Link copied"; | ||
| setTimeout(() => { | ||
| shareStatus.value = null; | ||
| }, 2000); | ||
| } catch { | ||
| shareStatus.value = "Copy failed"; | ||
| setTimeout(() => { | ||
| shareStatus.value = null; | ||
| }, 2000); | ||
| } | ||
| } | ||
|
|
||
| const panelsEl = ref<HTMLElement | null>(null); | ||
| const rightColumnEl = ref<HTMLElement | null>(null); | ||
| const columnSizes = ref([1, 1, 1]); | ||
| const rightSizes = ref([1, 0.5]); | ||
| const dragging = ref(false); | ||
|
|
||
| function ratioStyle(sizes: number[], index: number) { | ||
| return { flex: `${sizes[index]} 1 0`, minWidth: "0", minHeight: "0" }; | ||
| } | ||
|
|
||
| function columnStyle(index: number) { | ||
| return ratioStyle(columnSizes.value, index); | ||
| } | ||
|
|
||
| function rightStyle(index: number) { | ||
| return ratioStyle(rightSizes.value, index); | ||
| } | ||
|
|
||
| function createResizer( | ||
| sizes: Ref<number[]>, | ||
| axis: "x" | "y", | ||
| getContainer: () => HTMLElement | null, | ||
| ) { | ||
| let index = -1; | ||
| let startPos = 0; | ||
| let startSizes: number[] = []; | ||
| let extent = 1; | ||
|
|
||
| function onMove(event: PointerEvent) { | ||
| if (index < 0) { | ||
| return; | ||
| } | ||
|
|
||
| const total = startSizes.reduce((sum, size) => sum + size, 0); | ||
| const pos = axis === "x" ? event.clientX : event.clientY; | ||
| const delta = ((pos - startPos) / extent) * total; | ||
| const before = startSizes[index] + delta; | ||
| const after = startSizes[index + 1] - delta; | ||
| const min = 0.15; | ||
|
|
||
| if (before < min || after < min) { | ||
| return; | ||
| } | ||
|
|
||
| const next = [...startSizes]; | ||
| next[index] = before; | ||
| next[index + 1] = after; | ||
| sizes.value = next; | ||
| } | ||
|
|
||
| function stop() { | ||
| index = -1; | ||
| dragging.value = false; | ||
| window.removeEventListener("pointermove", onMove); | ||
| window.removeEventListener("pointerup", stop); | ||
| } | ||
|
|
||
| function start(handleIndex: number, event: PointerEvent) { | ||
| event.preventDefault(); | ||
| index = handleIndex; | ||
| startPos = axis === "x" ? event.clientX : event.clientY; | ||
| startSizes = [...sizes.value]; | ||
| const rect = getContainer()?.getBoundingClientRect(); | ||
| extent = (axis === "x" ? rect?.width : rect?.height) ?? 1; | ||
| dragging.value = true; | ||
| window.addEventListener("pointermove", onMove); | ||
| window.addEventListener("pointerup", stop); | ||
| } | ||
|
|
||
| return { start, stop }; | ||
| } | ||
|
|
||
| const columnResizer = createResizer(columnSizes, "x", () => panelsEl.value); | ||
| const rightResizer = createResizer(rightSizes, "y", () => rightColumnEl.value); | ||
|
|
||
| const statusText = computed( | ||
| () => lintError.value ?? configError.value ?? shareStatus.value ?? status.value, | ||
| ); | ||
| const statusTone = computed<"error" | "ok" | "neutral">(() => { | ||
| if ( | ||
| lintError.value || | ||
| configError.value || | ||
| shareStatus.value === "Copy failed" || | ||
| shareStatus.value === "Failed to load shared link" | ||
| ) { | ||
| return "error"; | ||
| } | ||
| if (loading.value || shareStatus.value === "Link copied") { | ||
| return "neutral"; | ||
| } | ||
| return diagnostics.value.length > 0 ? "error" : "ok"; | ||
| }); | ||
|
|
||
| onMounted(async () => { | ||
| // Register before the first await so an unmount during hydration can't leave a stale listener. | ||
| window.addEventListener("hashchange", applyStateFromUrl); | ||
| // Hydrate shared state before the first lint so we lint the shared content, not the defaults. | ||
| await applyStateFromUrl(); | ||
| syncUrlToState(); | ||
| // Hydration may have scheduled a debounced lint via the watcher; drop it and lint once now. | ||
| clearTimeout(lintTimer); | ||
| void runLint(); | ||
| }); | ||
|
|
||
| onUnmounted(() => { | ||
| window.removeEventListener("hashchange", applyStateFromUrl); | ||
| columnResizer.stop(); | ||
| rightResizer.stop(); | ||
| clearTimeout(lintTimer); | ||
| clearTimeout(urlTimer); | ||
| }); | ||
|
|
||
| watch([schema, code, config], () => { | ||
| scheduleLint(); | ||
| scheduleUrlSync(); | ||
| }); | ||
| </script> | ||
|
|
||
| <template> | ||
| <div class="playground"> | ||
| <header class="header"> | ||
| <h1>SafeQL Playground</h1> | ||
| <div class="header-actions"> | ||
| <span class="status" :class="`status-${statusTone}`"> | ||
| <span class="status-dot"></span> | ||
| {{ statusText }} | ||
| </span> | ||
| <button type="button" class="share-button" @click="copyShareUrl">Copy link</button> | ||
| </div> | ||
| </header> | ||
|
|
||
| <div class="panels" ref="panelsEl" :class="{ dragging }"> | ||
| <section class="panel" :style="columnStyle(0)"> | ||
| <div class="panel-header">Schema (SQL)</div> | ||
| <MonacoEditor v-model="schema" language="sql" /> | ||
| </section> | ||
|
|
||
| <div class="splitter" @pointerdown="columnResizer.start(0, $event)"></div> | ||
|
|
||
| <section class="panel" :style="columnStyle(1)"> | ||
| <div class="panel-header">TypeScript</div> | ||
| <MonacoEditor | ||
| v-model="code" | ||
| language="typescript" | ||
| :diagnostics="lintError ? [] : diagnostics" | ||
| /> | ||
| </section> | ||
|
|
||
| <div class="splitter" @pointerdown="columnResizer.start(1, $event)"></div> | ||
|
|
||
| <div class="panel-column" ref="rightColumnEl" :style="columnStyle(2)"> | ||
| <section class="panel" :style="rightStyle(0)"> | ||
| <div class="panel-header">Diagnostics</div> | ||
| <div class="errors"> | ||
| <p v-if="loading" class="empty">Running SafeQL…</p> | ||
| <p v-else-if="lintError" class="empty">{{ lintError }}</p> | ||
| <p v-else-if="diagnostics.length === 0" class="empty">No SafeQL issues found.</p> | ||
| <article v-for="(diagnostic, index) in diagnostics" :key="index" class="error-card"> | ||
| <div class="error-meta"> | ||
| {{ diagnostic.ruleId ?? "error" }} · Line {{ diagnostic.line }}, column | ||
| {{ diagnostic.column }} | ||
| </div> | ||
| <pre class="error-plain">{{ diagnostic.message }}</pre> | ||
| </article> | ||
| </div> | ||
| </section> | ||
|
|
||
| <div class="splitter splitter-h" @pointerdown="rightResizer.start(0, $event)"></div> | ||
|
|
||
| <section class="panel" :style="rightStyle(1)"> | ||
| <div class="panel-header" :class="{ 'header-error': configError }"> | ||
| Config (JSON){{ configError ? " — invalid" : "" }} | ||
| </div> | ||
| <p v-if="configError" class="config-error">{{ configError }}</p> | ||
| <MonacoEditor v-model="config" language="json" /> | ||
| </section> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </template> | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.