diff --git a/.github/workflows/publish-nightly.yml b/.github/workflows/publish-nightly.yml new file mode 100644 index 0000000..acb09ba --- /dev/null +++ b/.github/workflows/publish-nightly.yml @@ -0,0 +1,87 @@ +name: Publish Nightly Extension + +permissions: + contents: read + +on: + push: + branches: + - main + workflow_dispatch: + +concurrency: + group: publish-nightly + cancel-in-progress: true + +jobs: + publish-nightly: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + cache: 'npm' + + - name: Install dependencies + run: npm ci + + - name: Build + run: npm run vscode:prepublish + + - name: Compute nightly version + id: nightly_version + run: | + NIGHTLY_VERSION=$(node -e "const [maj,min] = require('./package.json').version.split('.').map(Number); const nightlyMinor = min % 2 === 0 ? min + 1 : min; process.stdout.write(`${maj}.${nightlyMinor}.${process.env.GITHUB_RUN_NUMBER}`)") + echo "VERSION=$NIGHTLY_VERSION" >> $GITHUB_OUTPUT + echo "Using nightly version: $NIGHTLY_VERSION" + + - name: Prepare nightly manifests + env: + NIGHTLY_VERSION: ${{ steps.nightly_version.outputs.VERSION }} + OPENVSX_NIGHTLY_NAME: postgres-explorer-nightly + run: node ./scripts/prepare-nightly-manifests.js + + - name: Package VS Code Marketplace nightly + id: package_marketplace + run: | + cp package.json package.json.bak + cp .nightly/package.marketplace.json package.json + VSIX_FILE=$(node -e "const pkg=require('./package.json'); process.stdout.write(`${pkg.name}-${pkg.version}.vsix`)") + npx @vscode/vsce package --pre-release + mv package.json.bak package.json + echo "VSIX_FILE=$VSIX_FILE" >> $GITHUB_OUTPUT + + - name: Publish VS Code Marketplace nightly (pre-release) + run: | + npx @vscode/vsce publish \ + --pre-release \ + --packagePath ${{ steps.package_marketplace.outputs.VSIX_FILE }} \ + -p ${{ secrets.VSCE_PAT }} + + - name: Package Open VSX nightly companion + id: package_openvsx + run: | + cp package.json package.json.bak + cp .nightly/package.openvsx.json package.json + VSIX_FILE=$(node -e "const pkg=require('./package.json'); process.stdout.write(`${pkg.name}-${pkg.version}.vsix`)") + npx @vscode/vsce package + mv package.json.bak package.json + echo "VSIX_FILE=$VSIX_FILE" >> $GITHUB_OUTPUT + + - name: Publish Open VSX nightly companion + run: | + npx ovsx publish \ + ${{ steps.package_openvsx.outputs.VSIX_FILE }} \ + -p ${{ secrets.OVSX_PAT }} + + - name: Upload nightly artifacts + uses: actions/upload-artifact@v4 + with: + name: nightly-vsix + path: "*.vsix" + retention-days: 30 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 31087f3..0bdfb0d 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -36,7 +36,8 @@ jobs: echo "Package.json version: $PKG_VERSION" if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then - echo "::warning::Tag version ($TAG_VERSION) doesn't match package.json version ($PKG_VERSION)" + echo "::error::Tag version ($TAG_VERSION) doesn't match package.json version ($PKG_VERSION)" + exit 1 fi # Set VSIX filename diff --git a/.gitignore b/.gitignore index 7883255..d65f5b7 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,7 @@ test_* mock_ai_server.js *.pgpass src/test/unit/PgPassSupport.test.ts +.kiro/ +.nightly/ +CLAUDE.md +.claude/ \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..7a73a41 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,2 @@ +{ +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index f21347d..e20677c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 --- +## [0.9.5] - 2026-04-09 + +### Added +- **Image support in SQL Assistant**: Paste images directly from clipboard or upload via the new image button (🖼) in the chat input. Images render as fixed 56×56px thumbnails in a dedicated preview strip above the textarea. +- **Image lightbox**: Click any image thumbnail (in the input strip or in message history) to open a full-size overlay preview. +- **Vision AI support**: Images are now properly sent to AI providers that support vision — OpenAI/custom as `image_url` parts, Anthropic as `base64` image blocks, Gemini as `inline_data` parts, and VS Code LM via `LanguageModelImagePart`. +- **File preview from chat**: Clicking an attached file chip (in the input area or in message history) opens the file as a preview tab in the VS Code editor. Works for files attached via the file picker, "Send to Chat", and "Analyze Data" buttons. +- **GitHub Models account sign-in**: Added first-class GitHub Models provider support using VS Code GitHub authentication sessions, including model listing and connection checks from AI Settings. + +### Changed +- **GitHub auth UX**: GitHub provider connection now uses the standard VS Code GitHub sign-in flow in AI Settings, with provider state reflected in the UI. +- **Nightly release channel**: Nightly builds are now available as pre-release updates, including a dedicated Open VSX nightly companion package for early access testing. + +### Fixed +- **Image CSP**: Added `img-src data: blob:` to the webview Content Security Policy so image thumbnails actually render (previously blocked by `default-src 'none'`). +- **File path missing on attach**: Files picked via the attachment button now include their filesystem path, enabling click-to-preview. +- **Open VSX GitHub auth fallback**: Removed invalid OAuth scope requests for GitHub session auth to prevent users from being redirected to PAT-only fallback prompts. + +--- + +## [0.9.2] - 2026-04-07 + +### Added +- **Local AI model support**: New **Ollama** and **LM Studio** providers connect to locally-running models at their default endpoints (`http://localhost:11434` and `http://localhost:1234`). No API key required. +- **Nightly build pipeline**: Automated GitHub Actions workflow publishes pre-release builds to VS Code Marketplace and Open VSX on every push to `main`. Nightly versions use odd minor numbers (e.g., `0.9.1.{run}`). +- **AI response timing**: Chat responses now display elapsed time alongside token usage for quick performance feedback. +- **Code snippet execution**: Suggestion bubbles in chat can now run code snippets directly via a new `runSnippet()` action. + +### Changed +- **Connection edit flow**: Editing a connection now opens `ConnectionFormPanel` directly instead of dispatching a command, making the flow more reliable. +- **Connection card styling**: Environment-specific accent colors (green for DEV, orange for STAGING, red for PROD) applied consistently across connection cards. +- **Chat input focus**: `sendSuggestion()` now properly focuses the input and positions the cursor after inserting a suggestion. +- **Publish workflow**: Version mismatch between the git tag and `package.json` now fails the build instead of emitting a warning. + +### Fixed +- **Inline code rendering**: Fixed markdown rendering of inline code in chat responses (resolves display issues with meta-notation like `(u, o)`). +- **SVG icon sizing**: Code block action buttons now have explicit `width`/`height` attributes, preventing layout inconsistencies across themes. + +### Removed +- **Tree filter commands**: `postgres-explorer.filterTree` and `postgres-explorer.clearFilter` removed from activation — these experimental commands were unused. + +--- + +## [0.9.0] - 2026-04-06 + +### Added +- **Anthropic model discovery**: AI Settings now lists Anthropic models from the official `/v1/models` API instead of a fixed local list. +- **Guided chat responses**: Assistant replies can now include numbered follow-up questions, optional next-step suggestion bubbles, and contextual quote-style factoids or jokes when they genuinely fit. + +### Changed +- **AI key lookup**: Direct AI provider keys now resolve from `SecretStorage` first, fixing false “API key required” errors when the key is already saved. +- **Chat identity and styling**: Assistant messages are labeled **PG Studio Bot**, with improved assistant bubble contrast and quote styling for richer responses. +- **Composer UX**: The chat input and suggestion bubbles were tightened for readability, capped to a compact height, and styled to avoid carrying stale next-step actions between chats. + +### Fixed +- **Follow-up selection**: Typing a number now resolves to the corresponding numbered follow-up question from the previous assistant message, instead of being treated as a fresh prompt. +- **Next-step carry-over**: Next-step bubbles are hidden when a new follow-up is sent or when switching chats, so actions remain specific to the active conversation. + ## [0.8.8] - 2026-03-21 ### Added diff --git a/LICENSE b/LICENSE index 20c1565..dd4a1c4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2025 Richie Varghese +Copyright (c) 2026 Richie Varghese Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/MARKETPLACE.md b/MARKETPLACE.md index 33674b5..095f0bc 100644 --- a/MARKETPLACE.md +++ b/MARKETPLACE.md @@ -43,7 +43,7 @@ | 🔍 **EXPLAIN CodeLens** | One-click EXPLAIN/ANALYZE with results in notebooks | | 🛡️ **Auto-LIMIT** | Automatic query protection with configurable row limits (default 1000) | | 🌍 **Foreign Data Wrappers** | Manage foreign servers, user mappings, and tables | -| 🤖 **AI-Powered** | GitHub Copilot, OpenAI, Anthropic, and Google Gemini integration | +| 🤖 **AI-Powered** | GitHub Copilot, GitHub Models, OpenAI, Anthropic, and Google Gemini integration | | ⌨️ **Developer Tools** | IntelliSense, keyboard shortcuts, PSQL terminal access | | 📤 **Export Data** | Export query results to CSV, JSON, or Excel formats | @@ -160,6 +160,7 @@ PgStudio provides a **Safe Execution Model** for AI interactions. **Supported AI Providers:** - GitHub Copilot (VS Code LM) +- GitHub Models (GitHub account sign-in) - OpenAI - Anthropic Claude - Google Gemini @@ -229,16 +230,16 @@ code --install-extension ric-v.postgres-explorer ## 📚 Resources -- 📖 [Full Documentation](https://dev-asterix.github.io/yape/) -- 🐛 [Report Issues](https://github.com/dev-asterix/yape/issues) -- 💡 [Request Features](https://github.com/dev-asterix/yape/issues/new?template=feature_request.md) -- ⭐ [Star on GitHub](https://github.com/dev-asterix/yape) +- 📖 [Full Documentation](https://pgstudio.astrx.dev/) +- 🐛 [Report Issues](https://github.com/dev-asterix/PgStudio/issues) +- 💡 [Request Features](https://github.com/dev-asterix/PgStudio/issues/new?template=feature_request.md) +- ⭐ [Star on GitHub](https://github.com/dev-asterix/PgStudio) --- ## 📝 License -This extension is licensed under the [MIT License](https://github.com/dev-asterix/yape/blob/main/LICENSE). +This extension is licensed under the [MIT License](https://github.com/dev-asterix/PgStudio/blob/main/LICENSE). --- diff --git a/Makefile b/Makefile index 61adf4c..a6c640a 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,13 @@ -.PHONY: all clean install build package publish publish-ovsx publish-vsx git-tag test test-unit test-integration test-renderer test-all coverage docker-up docker-down +.PHONY: all clean install build package package-nightly publish publish-nightly publish-ovsx publish-vsx git-tag test test-unit test-integration test-renderer test-all coverage docker-up docker-down # Variables NODE_BIN := node NPM_BIN := npm VSCE_CMD := npx -y @vscode/vsce@2.24.0 OVSX_CMD := npx -y ovsx +OPENVSX_NIGHTLY_NAME ?= postgres-explorer-nightly +# Evaluate once per make invocation to keep package/publish nightly version consistent. +NIGHTLY_RUN_NUMBER := $(shell date +%s) # Get version and name from package.json using node EXTENSION_NAME := $(shell $(NODE_BIN) -p "require('./package.json').name") @@ -38,6 +41,25 @@ package: build echo "Restored original README.md"; \ exit $$EXIT_CODE +# Package nightly VSIX artifacts for Marketplace (pre-release) and Open VSX companion +package-nightly: build + @echo "Computing nightly version..." + @NIGHTLY_VERSION=$$($(NODE_BIN) -e "const [maj,min]=require('./package.json').version.split('.').map(Number); const nightlyMinor=min%2===0?min+1:min; const run='$(NIGHTLY_RUN_NUMBER)'; process.stdout.write(maj + '.' + nightlyMinor + '.' + run)"); \ + echo "Using nightly version: $$NIGHTLY_VERSION"; \ + NIGHTLY_VERSION=$$NIGHTLY_VERSION OPENVSX_NIGHTLY_NAME=$(OPENVSX_NIGHTLY_NAME) $(NODE_BIN) ./scripts/prepare-nightly-manifests.js + @echo "Packaging VS Code Marketplace nightly (pre-release)..." + @cp package.json package.json.bak + @cp .nightly/package.marketplace.json package.json + @$(VSCE_CMD) package --pre-release + @mv package.json.bak package.json + @echo "Packaging Open VSX nightly companion..." + @cp package.json package.json.bak + @cp .nightly/package.openvsx.json package.json + @$(VSCE_CMD) package + @mv package.json.bak package.json + @echo "Nightly packages created:" + @ls -1 *.vsix + # Publish the extension to VS Code Marketplace and Open VSX Registry publish: package @echo "Publishing $(VSIX_FILE) to VS Code Marketplace..." @@ -50,6 +72,20 @@ publish: package $(OVSX_CMD) publish $(VSIX_FILE) -p $(shell cat ./pat-open-vsx) @echo "Successfully published to Open VSX Registry." +# Publish nightly artifacts to both VS Code Marketplace and Open VSX +publish-nightly: package-nightly + @echo "Publishing nightly pre-release to VS Code Marketplace..." + test -f ./pat || (echo "Error: pat file not found. Please create a file named 'pat' containing your Personal Access Token." && exit 1) + @NIGHTLY_VERSION=$$($(NODE_BIN) -e "const [maj,min]=require('./package.json').version.split('.').map(Number); const nightlyMinor=min%2===0?min+1:min; const run='$(NIGHTLY_RUN_NUMBER)'; process.stdout.write(maj + '.' + nightlyMinor + '.' + run)"); \ + MARKET_VSIX="$(EXTENSION_NAME)-$$NIGHTLY_VERSION.vsix"; \ + $(VSCE_CMD) publish --pre-release --packagePath $$MARKET_VSIX -p $$(cat ./pat) + @echo "Publishing nightly companion to Open VSX..." + test -f ./pat-open-vsx || (echo "Error: pat-open-vsx file not found. Please create a file named 'pat-open-vsx' containing your Open VSX Access Token." && exit 1) + @NIGHTLY_VERSION=$$($(NODE_BIN) -e "const [maj,min]=require('./package.json').version.split('.').map(Number); const nightlyMinor=min%2===0?min+1:min; const run='$(NIGHTLY_RUN_NUMBER)'; process.stdout.write(maj + '.' + nightlyMinor + '.' + run)"); \ + OPENVSX_VSIX="$(OPENVSX_NIGHTLY_NAME)-$$NIGHTLY_VERSION.vsix"; \ + $(OVSX_CMD) publish $$OPENVSX_VSIX -p $$(cat ./pat-open-vsx) + @echo "Successfully published nightly builds to both registries." + # Publish the extension to VS Code Marketplace only publish-vsx: package @echo "Publishing $(VSIX_FILE) to VS Code Marketplace..." @@ -138,7 +174,9 @@ help: @echo " install : Install dependencies" @echo " build : Build the extension" @echo " package : Create VSIX package" + @echo " package-nightly : Create nightly VSIX packages (Marketplace pre-release + Open VSX companion)" @echo " publish : Publish to BOTH VS Code Marketplace and Open VSX" + @echo " publish-nightly : Publish nightly builds to BOTH VS Code Marketplace and Open VSX" @echo " publish-vsx : Publish to VS Code Marketplace only" @echo " publish-ovsx : Publish to Open VSX Registry only" @echo " git-tag : Interactive version bump, commit, tag, and push" diff --git a/README.md b/README.md index 9228735..cdf1103 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,9 @@ - 🔍 **EXPLAIN CodeLens** — One-click query analysis directly in notebooks - 🛡️ **Auto-LIMIT** — Intelligent query protection (configurable, default 1000 rows) - 🌍 **Foreign Data Wrappers** — Manage foreign servers, user mappings & tables -- 🤖 **AI-Powered** — Generate, Optimize, Explain & Analyze (OpenAI, Anthropic, Gemini) +- 🤖 **AI-Powered** — Generate, Optimize, Explain & Analyze with guided follow-ups and next-step suggestions (GitHub Models, OpenAI, Anthropic, Gemini, VS Code LM) +- 🖼️ **Vision AI** — Paste or upload images directly in the SQL Assistant; sent to vision-capable AI providers +- 📎 **File Preview** — Click attached file chips to open them as preview tabs in the editor - 📤 **Export Data** — Export results to CSV, JSON, or Excel --- @@ -130,7 +132,7 @@ Then: **PostgreSQL icon** → **Add Connection** → Enter details → **Connect - `SECURITY.md` - Security policy and vulnerability reporting guidance - `CHANGELOG.md` - Release notes and what changed across versions -**v0.8.8 (latest) —** Sidebar puts **Connections** and **SQL Assistant** first; **Saved Queries** and **Query History** start collapsed for fresh view state; **What’s New** is command-palette only. Notebook inline edits use **parameterized SQL inside transactions**. **Table Designer** adds **create-mode column reorder** and improved **SQL preview** styling. Details: `CHANGELOG.md`. +**v0.9.5 (latest) —** SQL Assistant now supports image paste/upload with thumbnail previews, vision AI (OpenAI, Anthropic, Gemini, VS Code LM), click-to-preview for attached files, and GitHub Models sign-in via standard VS Code GitHub auth. Details: `CHANGELOG.md`. --- @@ -202,6 +204,12 @@ Organize, manage, and reuse your most important queries with intelligent tagging PgStudio integrates advanced AI capabilities directly into your workflow, but keeps **YOU** in control. +### 🔐 GitHub Models via GitHub Sign-In +Use GitHub Models without manually managing a PAT in normal VS Code authentication flows. +- **Native Sign-In**: Connect with your GitHub account from AI Settings. +- **Model Catalog Access**: List and select available GitHub-hosted models. +- **Session-Based Auth**: Uses VS Code GitHub authentication sessions instead of storing provider tokens. + ### 🪄 Generate Query (Natural Language → SQL) Describe what you need in plain English (e.g., "Show me top 10 users by order count"), and PgStudio will generate the SQL for you using your schema context. - **Command Palette**: `AI: Generate Query` @@ -401,6 +409,31 @@ npx vsce publish npx ovsx publish ``` +### Stable And Nightly Channels + +- Stable releases are published from version tags (`v*`) via `.github/workflows/publish.yml`. +- Nightly releases are published on every merge to `main` via `.github/workflows/publish-nightly.yml`. + +VS Code Marketplace channel behavior: + +- Stable extension ID: `ric-v.postgres-explorer` +- Nightly is published as a **pre-release** of the same extension ID. +- Users can opt in/out directly from the extension page with: + - `Switch to Pre-Release Version` + - `Switch to Release Version` + +Open VSX channel behavior: + +- Stable extension ID: `ric-v.postgres-explorer` +- Nightly companion extension ID: `ric-v.postgres-explorer-nightly` +- To opt out of nightly on Open VSX-based editors, uninstall the nightly companion extension and install stable. + +Nightly versioning policy: + +- Nightly builds use an odd minor stream and CI run number as patch. +- Example format: `0.9.` +- This keeps nightly versions monotonically increasing for reliable updates. + --- ## 📝 License diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index b67d28f..42dec7b 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -36,7 +36,7 @@ graph TB subgraph "External Systems" PG[(PostgreSQL Database)] - AI[AI Services
OpenAI/Anthropic/Gemini] + AI[AI Services
GitHub Models/OpenAI/Anthropic/Gemini] end EXT --> CMD diff --git a/docs/index.html b/docs/index.html index 5b2712f..fd60d70 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,6 +7,21 @@ PgStudio - Professional Database Management for VS Code + + + + + + + + + + + + + @@ -37,7 +69,7 @@ Features Workflow AI - GitHub + GitHub Install @@ -54,7 +86,7 @@
VS Code Marketplace - 0.8.4 + 0.9.5
@@ -284,7 +316,7 @@

Advanced Operations

Developer Tools

Built for speed with integrated workflow tools.

    -
  • GitHub Copilot integration
    • +
  • GitHub Copilot & GitHub Models integration
  • IntelliSense completions
  • Keyboard shortcuts
  • PSQL terminal access
    • @@ -335,7 +367,7 @@

    Advanced Visualizations

    ✨ AI-Powered

    Intelligent SQL Assistance

    -

    Leverage multiple AI providers to write, optimize, and debug faster

    +

    Leverage multiple AI providers, including GitHub Models, to write, optimize, and debug faster

    @@ -374,6 +406,16 @@

    Schema Understanding

    Send to Chat

    One-click button to send query results directly to AI chat for follow-up analysis

    +
    +
    🔐
    +

    GitHub Models Sign-In

    +

    Connect with your GitHub account in AI Settings using the standard VS Code authentication flow

    +
    +
    +
    🖼️
    +

    Vision AI

    +

    Paste or upload images directly in the chat — sent to vision-capable models (OpenAI, Anthropic, Gemini)

    +
    🛠️

    Custom Instructions

    @@ -479,13 +521,13 @@

    AI Assistant in Action

    Resources

    - Documentation - Changelog + Documentation + Changelog

    Community

    - GitHub - Report Issues + GitHub + Report Issues

    Install

    diff --git a/package-lock.json b/package-lock.json index ba9aca8..a19698b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "postgres-explorer", - "version": "0.8.5", + "version": "0.9.5", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "postgres-explorer", - "version": "0.8.5", + "version": "0.9.5", "license": "MIT", "dependencies": { "@types/pg-cursor": "^2.7.2", @@ -14,6 +14,7 @@ "esbuild": ">=0.28.0", "pg": "^8.20.0", "pg-cursor": "^2.19.0", + "sql-formatter": "^15.7.3", "ssh2": "^1.17.0" }, "devDependencies": { @@ -25,10 +26,12 @@ "@types/pg": "^8.20.0", "@types/sinon": "^21.0.1", "@types/ssh2": "^1.15.5", - "@types/vscode": "^1.110.0", + "@types/vscode": "^1.105.0", "@types/vscode-notebook-renderer": "^1.72.4", + "baseline-browser-mapping": "^2.10.17", "chai": "^6.2.2", "esbuild": ">=0.28.0", + "fast-check": "^4.6.0", "jsdom": "^29.0.1", "mocha": "^11.7.5", "module-alias": "^2.3.4", @@ -42,7 +45,7 @@ }, "engines": { "node": ">=18.0.0", - "vscode": "^1.90.0" + "vscode": "^1.105.0" } }, "node_modules/@asamuzakjp/css-color": { @@ -2830,13 +2833,16 @@ "optional": true }, "node_modules/baseline-browser-mapping": { - "version": "2.8.32", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.8.32.tgz", - "integrity": "sha512-OPz5aBThlyLFgxyhdwf/s2+8ab3OvT7AdTNvKHBwpXomIYeXqpUUuT8LrdtxZSsWJ4R4CU1un4XGh5Ez3nlTpw==", + "version": "2.10.17", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.17.tgz", + "integrity": "sha512-HdrkN8eVG2CXxeifv/VdJ4A4RSra1DTW8dc/hdxzhGHN8QePs6gKaWM9pHPcpCoxYZJuOZ8drHmbdpLHjCYjLA==", "dev": true, "license": "Apache-2.0", "bin": { - "baseline-browser-mapping": "dist/cli.js" + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" } }, "node_modules/bcrypt-pbkdf": { @@ -3659,6 +3665,12 @@ "node": ">=0.3.1" } }, + "node_modules/discontinuous-range": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/discontinuous-range/-/discontinuous-range-1.0.0.tgz", + "integrity": "sha512-c68LpLbO+7kP/b1Hr1qs8/BJ09F5khZGTxqxZuhzxpmwJKOgRFHJWIb9/KmqnqHhLdO55aOxFH/EGBvUQbL/RQ==", + "license": "MIT" + }, "node_modules/dom-serializer": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz", @@ -3978,6 +3990,29 @@ "node": ">=6" } }, + "node_modules/fast-check": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/fast-check/-/fast-check-4.6.0.tgz", + "integrity": "sha512-h7H6Dm0Fy+H4ciQYFxFjXnXkzR2kr9Fb22c0UBpHnm59K2zpr2t13aPTHlltFiNT6zuxp6HMPAVVvgur4BLdpA==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/dubzzz" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fast-check" + } + ], + "license": "MIT", + "dependencies": { + "pure-rand": "^8.0.0" + }, + "engines": { + "node": ">=12.17.0" + } + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -5726,6 +5761,12 @@ "dev": true, "license": "MIT" }, + "node_modules/moo": { + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/moo/-/moo-0.5.3.tgz", + "integrity": "sha512-m2fmM2dDm7GZQsY7KK2cme8agi+AAljILjQnof7p1ZMDe6dQ4bdnSMx0cPppudoeNv5hEFQirN6u+O4fDE0IWA==", + "license": "BSD-3-Clause" + }, "node_modules/ms": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", @@ -5755,6 +5796,34 @@ "license": "MIT", "optional": true }, + "node_modules/nearley": { + "version": "2.20.1", + "resolved": "https://registry.npmjs.org/nearley/-/nearley-2.20.1.tgz", + "integrity": "sha512-+Mc8UaAebFzgV+KpI5n7DasuuQCHA89dmwm7JXw3TV43ukfNQ9DnBH3Mdb2g/I4Fdxc26pwimBWvjIw0UAILSQ==", + "license": "MIT", + "dependencies": { + "commander": "^2.19.0", + "moo": "^0.5.0", + "railroad-diagrams": "^1.0.0", + "randexp": "0.4.6" + }, + "bin": { + "nearley-railroad": "bin/nearley-railroad.js", + "nearley-test": "bin/nearley-test.js", + "nearley-unparse": "bin/nearley-unparse.js", + "nearleyc": "bin/nearleyc.js" + }, + "funding": { + "type": "individual", + "url": "https://nearley.js.org/#give-to-nearley" + } + }, + "node_modules/nearley/node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "license": "MIT" + }, "node_modules/node-abi": { "version": "3.85.0", "resolved": "https://registry.npmjs.org/node-abi/-/node-abi-3.85.0.tgz", @@ -6773,6 +6842,23 @@ "node": ">=6" } }, + "node_modules/pure-rand": { + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-8.4.0.tgz", + "integrity": "sha512-IoM8YF/jY0hiugFo/wOWqfmarlE6J0wc6fDK1PhftMk7MGhVZl88sZimmqBBFomLOCSmcCCpsfj7wXASCpvK9A==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/dubzzz" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fast-check" + } + ], + "license": "MIT" + }, "node_modules/qs": { "version": "6.15.0", "resolved": "https://registry.npmjs.org/qs/-/qs-6.15.0.tgz", @@ -6810,6 +6896,25 @@ ], "license": "MIT" }, + "node_modules/railroad-diagrams": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/railroad-diagrams/-/railroad-diagrams-1.0.0.tgz", + "integrity": "sha512-cz93DjNeLY0idrCNOH6PviZGRN9GJhsdm9hpn1YCS879fj4W+x5IFJhhkRZcwVgMmFF7R82UA/7Oh+R8lLZg6A==", + "license": "CC0-1.0" + }, + "node_modules/randexp": { + "version": "0.4.6", + "resolved": "https://registry.npmjs.org/randexp/-/randexp-0.4.6.tgz", + "integrity": "sha512-80WNmd9DA0tmZrw9qQa62GPPWfuXJknrmVmLcxvq4uZBdYqb1wYoKTmnlGUchvVWe0XiLupYkBoXVOxz3C8DYQ==", + "license": "MIT", + "dependencies": { + "discontinuous-range": "1.0.0", + "ret": "~0.1.10" + }, + "engines": { + "node": ">=0.12" + } + }, "node_modules/rc": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", @@ -6986,6 +7091,15 @@ "node": ">=8" } }, + "node_modules/ret": { + "version": "0.1.15", + "resolved": "https://registry.npmjs.org/ret/-/ret-0.1.15.tgz", + "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", + "license": "MIT", + "engines": { + "node": ">=0.12" + } + }, "node_modules/reusify": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", @@ -7569,6 +7683,25 @@ "dev": true, "license": "BSD-3-Clause" }, + "node_modules/sql-formatter": { + "version": "15.7.3", + "resolved": "https://registry.npmjs.org/sql-formatter/-/sql-formatter-15.7.3.tgz", + "integrity": "sha512-5+zl9Nqg5aNjss0tb1G+StpC4dJKbjv3+g8CL/+V+00PfZop+2RKGyi53ScFl0dr+Dkx1LjmUO54Q3N7K3EtMw==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "nearley": "^2.20.1" + }, + "bin": { + "sql-formatter": "bin/sql-formatter-cli.cjs" + } + }, + "node_modules/sql-formatter/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, "node_modules/ssh2": { "version": "1.17.0", "resolved": "https://registry.npmjs.org/ssh2/-/ssh2-1.17.0.tgz", diff --git a/package.json b/package.json index 2feb9b2..b1b0102 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "postgres-explorer", "displayName": "PgStudio (PostgreSQL Explorer)", - "version": "0.8.5", - "description": "PostgreSQL database explorer for VS Code with notebook support", + "version": "0.9.5", + "description": "PostgreSQL database explorer for VS Code with notebook support [Nightly]", "publisher": "ric-v", "private": false, "license": "MIT", @@ -16,25 +16,32 @@ "homepage": "https://pgstudio.astrx.dev/", "icon": "resources/postgres-explorer.png", "galleryBanner": { - "color": "#C80000", + "color": "#575584", "theme": "dark" }, "engines": { - "vscode": "^1.90.0", + "vscode": "^1.105.0", "node": ">=18.0.0" }, "categories": [ - "Programming Languages", "Data Science", "Notebooks", - "Visualization" + "Other" ], "keywords": [ "postgresql", "postgres", "database", "sql", - "notebook" + "sql notebook", + "ai sql", + "database explorer", + "pgadmin", + "db client", + "postgresql vs code extension", + "postgres database explorer", + "sql notebook vs code", + "ai sql assistant" ], "contributes": { "languages": [ @@ -66,16 +73,6 @@ "title": "Edit Connection", "icon": "$(edit)" }, - { - "command": "postgres-explorer.filterTree", - "title": "Filter Tree", - "icon": "$(filter)" - }, - { - "command": "postgres-explorer.clearFilter", - "title": "Clear Filter", - "icon": "$(search-remove)" - }, { "command": "postgres-explorer.addToFavorites", "title": "Add to Favorites", @@ -106,6 +103,36 @@ "title": "New PostgreSQL Notebook", "icon": "$(new-file)" }, + { + "command": "postgres-explorer.jumpToSection", + "title": "Jump to Section", + "category": "PgStudio", + "icon": "$(list-unordered)" + }, + { + "command": "postgres-explorer.notebooks.open", + "title": "Open Notebook", + "category": "PgStudio", + "icon": "$(go-to-file)" + }, + { + "command": "postgres-explorer.notebooks.rename", + "title": "Rename Notebook", + "category": "PgStudio", + "icon": "$(edit)" + }, + { + "command": "postgres-explorer.notebooks.delete", + "title": "Delete Notebook", + "category": "PgStudio", + "icon": "$(trash)" + }, + { + "command": "postgres-explorer.notebooks.refresh", + "title": "Refresh Notebooks", + "category": "PgStudio", + "icon": "$(refresh)" + }, { "command": "postgres-explorer.generateQuery", "title": "AI: Generate Query", @@ -448,6 +475,11 @@ "title": "Edit Foreign Table", "icon": "$(edit)" }, + { + "command": "postgres-explorer.viewForeignTableData", + "title": "Query Foreign Table Data", + "icon": "$(table)" + }, { "command": "postgres-explorer.showForeignTableProperties", "title": "Show Foreign Table Properties", @@ -1007,8 +1039,13 @@ "activitybar": [ { "id": "postgres-explorer", - "title": "PostgreSQL Explorer", + "title": "PG Studio", "icon": "resources/postgres-vsc-icon.png" + }, + { + "id": "postgres-sql-assistant", + "title": "SQL Assistant", + "icon": "resources/sql-assistant-vsc-icon.png" } ] }, @@ -1017,34 +1054,37 @@ { "id": "postgresExplorer", "name": "Connections", - "contextualTitle": "PostgreSQL Explorer", + "contextualTitle": "PG Studio", "icon": "resources/postgres-vsc-icon.png" }, { - "id": "postgresExplorer.savedQueries", - "name": "Saved Queries", - "contextualTitle": "PostgreSQL Explorer", - "icon": "$(save)" + "id": "postgresExplorer.notebooks", + "name": "Notebooks", + "contextualTitle": "PG Studio", + "icon": "$(notebook)" }, { - "id": "postgresExplorer.chatView", - "name": "SQL Assistant", - "type": "webview", - "contextualTitle": "PostgreSQL Explorer", - "icon": "resources/ai-icon.png" + "id": "postgresExplorer.savedQueries", + "name": "Saved Queries", + "contextualTitle": "PG Studio", + "icon": "$(save)", + "visibility": "collapsed" }, { "id": "postgresExplorer.history", "name": "Query History", - "contextualTitle": "PostgreSQL Explorer", - "icon": "$(history)" - }, + "contextualTitle": "PG Studio", + "icon": "$(history)", + "visibility": "collapsed" + } + ], + "postgres-sql-assistant": [ { - "id": "postgresExplorer.whatsNew", - "name": "What's New", + "id": "postgresExplorer.chatView", + "name": "SQL Assistant", "type": "webview", - "contextualTitle": "PostgreSQL Explorer", - "icon": "resources/postgres-explorer.png" + "contextualTitle": "SQL Assistant", + "icon": "resources/sql-assistant-vsc-icon.png" } ] }, @@ -1080,7 +1120,8 @@ "mimeTypes": [ "application/x-postgres-result", "application/vnd.postgres-notebook.result", - "application/vnd.postgres-notebook.error" + "application/vnd.postgres-notebook.error", + "application/x-postgres-notebook-header+json" ], "requiresMessaging": "always" } @@ -1152,6 +1193,7 @@ "type": "string", "enum": [ "vscode-lm", + "github", "openai", "anthropic", "gemini", @@ -1163,7 +1205,7 @@ "postgresExplorer.aiApiKey": { "type": "string", "default": "", - "description": "API Key for direct AI providers (OpenAI/Anthropic)" + "description": "API Key for direct AI providers (OpenAI/Anthropic/Gemini/custom)" }, "postgresExplorer.aiModel": { "type": "string", @@ -1209,6 +1251,17 @@ "type": "boolean", "default": true, "description": "Automatically append LIMIT clause to SELECT queries that don't have one. Always enabled in read-only mode." + }, + "postgresExplorer.autoRefresh.enabled": { + "type": "boolean", + "default": true, + "description": "Enable automatic background refresh of the explorer tree and notebooks panel." + }, + "postgresExplorer.autoRefresh.pollIntervalSeconds": { + "type": "number", + "default": 30, + "minimum": 10, + "description": "How often (in seconds) to poll PostgreSQL for schema changes." } } }, @@ -1225,20 +1278,22 @@ } }, "menus": { - "view/title": [ + "notebook/toolbar": [ { - "command": "postgres-explorer.addConnection", - "when": "view == postgresExplorer", - "group": "navigation" - }, + "command": "postgres-explorer.jumpToSection", + "when": "notebookType == 'postgres-notebook'", + "group": "navigation@99" + } + ], + "view/title": [ { - "command": "postgres-explorer.filterTree", - "when": "view == postgresExplorer && !postgresExplorer.filterActive", + "command": "postgres-explorer.notebooks.refresh", + "when": "view == postgresExplorer.notebooks", "group": "navigation" }, { - "command": "postgres-explorer.clearFilter", - "when": "view == postgresExplorer && postgresExplorer.filterActive", + "command": "postgres-explorer.addConnection", + "when": "view == postgresExplorer", "group": "navigation" }, { @@ -1283,6 +1338,21 @@ } ], "view/item/context": [ + { + "command": "postgres-explorer.notebooks.open", + "when": "view == postgresExplorer.notebooks && viewItem == notebook-file", + "group": "inline@1" + }, + { + "command": "postgres-explorer.notebooks.rename", + "when": "view == postgresExplorer.notebooks && viewItem == notebook-file", + "group": "1_actions" + }, + { + "command": "postgres-explorer.notebooks.delete", + "when": "view == postgresExplorer.notebooks && viewItem == notebook-file", + "group": "9_destructive" + }, { "command": "postgres-explorer.copyQuery", "when": "view == postgresExplorer.history", @@ -1439,10 +1509,15 @@ "group": "1_actions@0" }, { - "submenu": "postgres-explorer.viewScriptsMenu", + "command": "postgres-explorer.editViewDefinition", "when": "view == postgresExplorer && viewItem == view", "group": "1_actions@1" }, + { + "submenu": "postgres-explorer.viewScriptsMenu", + "when": "view == postgresExplorer && viewItem == view", + "group": "1_actions@2" + }, { "command": "postgres-explorer.truncateTable", "when": "view == postgresExplorer && viewItem == table", @@ -1505,6 +1580,11 @@ "when": "view == postgresExplorer && viewItem == materialized-view", "group": "1_operations@0" }, + { + "command": "postgres-explorer.editMaterializedView", + "when": "view == postgresExplorer && viewItem == materialized-view", + "group": "1_operations@1" + }, { "command": "postgres-explorer.foreignTableOperations", "when": "view == postgresExplorer && viewItem == foreign-table", @@ -1515,6 +1595,11 @@ "when": "view == postgresExplorer && viewItem == type", "group": "1_operations@0" }, + { + "command": "postgres-explorer.editType", + "when": "view == postgresExplorer && viewItem == type", + "group": "1_operations@1" + }, { "command": "postgres-explorer.createDatabase", "when": "view == postgresExplorer && viewItem == databases-group", @@ -1670,6 +1755,11 @@ "when": "view == postgresExplorer && viewItem == foreign-table", "group": "inline@2" }, + { + "command": "postgres-explorer.viewForeignTableData", + "when": "view == postgresExplorer && viewItem == foreign-table", + "group": "inline@3" + }, { "command": "postgres-explorer.dropForeignTable", "when": "view == postgresExplorer && viewItem == foreign-table", @@ -1751,11 +1841,6 @@ "when": "view == postgresExplorer && viewItem == database", "group": "1_operations@2" }, - { - "command": "postgres-explorer.dropDatabase", - "when": "view == postgresExplorer && viewItem == database", - "group": "9_delete" - }, { "command": "postgres-explorer.disconnectDatabase", "when": "view == postgresExplorer && viewItem == database", @@ -2065,6 +2150,9 @@ "main": "./dist/extension.js", "scripts": { "vscode:prepublish": "npm run esbuild-base -- --minify && npm run esbuild-renderer -- --minify", + "prepare:nightly:manifests": "node ./scripts/prepare-nightly-manifests.js", + "package:prerelease": "npx @vscode/vsce package --pre-release", + "package:openvsx:nightly": "npx @vscode/vsce package", "esbuild-base": "esbuild ./src/extension.ts --bundle --outfile=dist/extension.js --external:vscode --external:ssh2 --external:pg --format=cjs --platform=node --main-fields=main", "esbuild-renderer": "esbuild ./src/renderer_v2.ts --bundle --outfile=dist/renderer_v2.js --format=esm --platform=browser", "copy-templates": "cp -r templates dist/", @@ -2108,10 +2196,12 @@ "@types/pg": "^8.20.0", "@types/sinon": "^21.0.1", "@types/ssh2": "^1.15.5", - "@types/vscode": "^1.110.0", + "@types/vscode": "^1.105.0", "@types/vscode-notebook-renderer": "^1.72.4", + "baseline-browser-mapping": "^2.10.17", "chai": "^6.2.2", "esbuild": ">=0.28.0", + "fast-check": "^4.6.0", "jsdom": "^29.0.1", "mocha": "^11.7.5", "module-alias": "^2.3.4", @@ -2131,4 +2221,4 @@ "webpack": "^5.76.0", "webpack-cli": "^5.0.0" } -} \ No newline at end of file +} diff --git a/resources/sql-assistant-vsc-icon.png b/resources/sql-assistant-vsc-icon.png new file mode 100644 index 0000000..3f45328 Binary files /dev/null and b/resources/sql-assistant-vsc-icon.png differ diff --git a/scripts/prepare-nightly-manifests.js b/scripts/prepare-nightly-manifests.js new file mode 100644 index 0000000..8f3b5b1 --- /dev/null +++ b/scripts/prepare-nightly-manifests.js @@ -0,0 +1,58 @@ +const fs = require('fs'); +const path = require('path'); + +function ensureNightlySuffix(description) { + const suffix = ' [Nightly]'; + if (typeof description !== 'string') { + return suffix.trim(); + } + return description.includes(suffix) ? description : `${description}${suffix}`; +} + +function main() { + const root = process.cwd(); + const pkgPath = path.join(root, 'package.json'); + const outDir = path.join(root, '.nightly'); + + if (!fs.existsSync(pkgPath)) { + throw new Error('package.json not found in repository root'); + } + + const nightlyVersion = process.env.NIGHTLY_VERSION; + if (!nightlyVersion) { + throw new Error('NIGHTLY_VERSION environment variable is required'); + } + + const openVsxNightlyName = process.env.OPENVSX_NIGHTLY_NAME || 'postgres-explorer-nightly'; + const basePackage = JSON.parse(fs.readFileSync(pkgPath, 'utf8')); + + const marketplaceNightly = { + ...basePackage, + version: nightlyVersion, + description: ensureNightlySuffix(basePackage.description), + }; + + const openVsxNightly = { + ...basePackage, + name: openVsxNightlyName, + displayName: `${basePackage.displayName} Nightly`, + version: nightlyVersion, + description: ensureNightlySuffix(basePackage.description), + }; + + fs.mkdirSync(outDir, { recursive: true }); + fs.writeFileSync( + path.join(outDir, 'package.marketplace.json'), + `${JSON.stringify(marketplaceNightly, null, 2)}\n`, + 'utf8' + ); + fs.writeFileSync( + path.join(outDir, 'package.openvsx.json'), + `${JSON.stringify(openVsxNightly, null, 2)}\n`, + 'utf8' + ); + + process.stdout.write(`Generated nightly manifests for version ${nightlyVersion}\n`); +} + +main(); diff --git a/src/activation/commands.ts b/src/activation/commands.ts index 7b008de..7a45d34 100644 --- a/src/activation/commands.ts +++ b/src/activation/commands.ts @@ -11,11 +11,11 @@ import { cmdConnectDatabase, cmdDisconnectConnection, cmdDisconnectDatabase, cmd import { showIndexProperties, copyIndexName, generateDropIndexScript, generateReindexScript, generateScriptCreate, analyzeIndexUsage, generateAlterIndexScript, addIndexComment, cmdIndexOperations, cmdAddIndex } from '../commands/indexes'; import { cmdAddObjectInDatabase, cmdBackupDatabase, cmdCreateDatabase, cmdDatabaseDashboard, cmdDatabaseOperations, cmdDeleteDatabase, cmdDisconnectDatabase as cmdDisconnectDatabaseLegacy, cmdGenerateCreateScript, cmdMaintenanceDatabase, cmdPsqlTool, cmdQueryTool, cmdRestoreDatabase, cmdScriptAlterDatabase, cmdShowConfiguration } from '../commands/database'; import { cmdDropExtension, cmdEnableExtension, cmdExtensionOperations, cmdRefreshExtension } from '../commands/extensions'; -import { cmdCreateForeignTable, cmdEditForeignTable, cmdForeignTableOperations, cmdRefreshForeignTable } from '../commands/foreignTables'; +import { cmdCreateForeignTable, cmdDropForeignTable, cmdEditForeignTable, cmdForeignTableOperations, cmdRefreshForeignTable, cmdShowForeignTableProperties, cmdViewForeignTableData } from '../commands/foreignTables'; import { cmdForeignDataWrapperOperations, cmdShowForeignDataWrapperProperties, cmdCreateForeignServer, cmdForeignServerOperations, cmdShowForeignServerProperties, cmdDropForeignServer, cmdCreateUserMapping, cmdUserMappingOperations, cmdShowUserMappingProperties, cmdDropUserMapping, cmdRefreshForeignDataWrapper, cmdRefreshForeignServer, cmdRefreshUserMapping } from '../commands/foreignDataWrappers'; import { cmdCallFunction, cmdCreateFunction, cmdDropFunction, cmdEditFunction, cmdFunctionOperations, cmdRefreshFunction, cmdShowFunctionProperties } from '../commands/functions'; import { cmdCreateMaterializedView, cmdDropMatView, cmdEditMatView, cmdMatViewOperations, cmdRefreshMatView, cmdViewMatViewData, cmdViewMatViewProperties } from '../commands/materializedViews'; -import { cmdNewNotebook, cmdExplainQuery } from '../commands/notebook'; +import { cmdNewNotebook, cmdExplainQuery, cmdJumpToSection } from '../commands/notebook'; import { cmdCreateObjectInSchema, cmdCreateSchema, cmdSchemaOperations, cmdShowSchemaProperties, cmdPasteTable } from '../commands/schema'; import { cmdCreateTable, cmdDropTable, cmdEditTable, cmdInsertTable, cmdMaintenanceAnalyze, cmdMaintenanceReindex, cmdMaintenanceVacuum, cmdScriptCreate, cmdScriptDelete, cmdScriptInsert, cmdScriptSelect, cmdScriptUpdate, cmdShowTableProperties, cmdTableOperations, cmdTruncateTable, cmdUpdateTable, cmdViewTableData, cmdTableProfile, cmdTableActivity, cmdQuickCloneTable, cmdExportTable, cmdIndexUsage, cmdTableDefinition @@ -53,13 +53,15 @@ import { pickQueryHistory } from '../commands/pickQueryHistory'; // Visual Schema Design import { cmdOpenTableDesigner, cmdCreateTableVisual, cmdOpenSchemaDiff } from '../commands/schemaDesigner'; +import { NotebookTreeItem, NotebooksTreeProvider } from '../providers/NotebooksTreeProvider'; export function registerAllCommands( context: vscode.ExtensionContext, databaseTreeProvider: DatabaseTreeProvider, chatViewProviderInstance: ChatViewProvider | undefined, outputChannel: vscode.OutputChannel, - savedQueriesTreeProvider?: SavedQueriesTreeProvider + savedQueriesTreeProvider?: SavedQueriesTreeProvider, + notebooksTreeProvider?: NotebooksTreeProvider ) { const commands = [ { @@ -150,58 +152,6 @@ export function registerAllCommands( command: 'postgres-explorer.tableDefinition', callback: async (item: DatabaseTreeItem) => await cmdTableDefinition(item, context) }, - { - command: 'postgres-explorer.filterTree', - callback: async () => { - const currentFilter = databaseTreeProvider.filterPattern; - - if (currentFilter) { - // Filter is active - show options to modify or clear - const choice = await vscode.window.showQuickPick([ - { label: '$(close) Clear Filter', value: 'clear' }, - { label: '$(edit) Change Filter', value: 'change', description: `Current: "${currentFilter}"` } - ], { placeHolder: `Filter active: "${currentFilter}"` }); - - if (choice?.value === 'clear') { - databaseTreeProvider.clearFilter(); - vscode.commands.executeCommand('setContext', 'postgresExplorer.filterActive', false); - vscode.window.showInformationMessage('Filter cleared'); - } else if (choice?.value === 'change') { - const pattern = await vscode.window.showInputBox({ - prompt: 'Enter filter pattern', - placeHolder: 'e.g., users, product, order', - value: currentFilter - }); - if (pattern !== undefined) { - databaseTreeProvider.setFilter(pattern); - vscode.commands.executeCommand('setContext', 'postgresExplorer.filterActive', pattern.length > 0); - if (pattern) { - vscode.window.showInformationMessage(`Filter applied: "${pattern}"`); - } - } - } - } else { - // No filter active - show input - const pattern = await vscode.window.showInputBox({ - prompt: 'Enter filter pattern', - placeHolder: 'e.g., users, product, order' - }); - if (pattern !== undefined && pattern.length > 0) { - databaseTreeProvider.setFilter(pattern); - vscode.commands.executeCommand('setContext', 'postgresExplorer.filterActive', true); - vscode.window.showInformationMessage(`Filter applied: "${pattern}"`); - } - } - } - }, - { - command: 'postgres-explorer.clearFilter', - callback: () => { - databaseTreeProvider.clearFilter(); - vscode.commands.executeCommand('setContext', 'postgresExplorer.filterActive', false); - vscode.window.showInformationMessage('Filter cleared'); - } - }, { command: 'postgres-explorer.generateQuery', callback: async () => { @@ -297,6 +247,38 @@ export function registerAllCommands( } } }, + { + command: 'postgres-explorer.optimizeQuery', + callback: async () => { + if (!chatViewProviderInstance) { + vscode.window.showErrorMessage('AI Chat is not initialized'); + return; + } + + let query = ''; + const activeNotebookEditor = vscode.window.activeNotebookEditor; + if (activeNotebookEditor && activeNotebookEditor.selections.length > 0) { + const cellIndex = activeNotebookEditor.selections[0].start; + const cell = activeNotebookEditor.notebook.cellAt(cellIndex); + query = cell.document.getText().trim(); + } + + if (!query) { + query = (await vscode.window.showInputBox({ + prompt: 'Paste or type the SQL query you want to optimize', + placeHolder: 'SELECT ...' + }))?.trim() || ''; + } + + if (!query) { + vscode.window.showWarningMessage('No query provided for optimization.'); + return; + } + + await vscode.commands.executeCommand('postgresExplorer.chatView.focus'); + await chatViewProviderInstance.handleOptimizeQuery(query); + } + }, { command: 'postgres-explorer.addToFavorites', callback: async (item: DatabaseTreeItem) => { @@ -354,6 +336,52 @@ export function registerAllCommands( command: 'postgres-explorer.newNotebook', callback: async (item: any) => await cmdNewNotebook(item) }, + { + command: 'postgres-explorer.jumpToSection', + callback: async () => await cmdJumpToSection() + }, + { + command: 'postgres-explorer.notebooks.refresh', + callback: () => notebooksTreeProvider?.refresh() + }, + { + command: 'postgres-explorer.notebooks.open', + callback: async (item: NotebookTreeItem) => { + if (item?.uri) { + const doc = await vscode.workspace.openNotebookDocument(item.uri); + await vscode.window.showNotebookDocument(doc, { preserveFocus: false }); + } + } + }, + { + command: 'postgres-explorer.notebooks.rename', + callback: async (item: NotebookTreeItem) => { + if (!item?.uri) { return; } + const oldName = (item.label as string); + const newName = await vscode.window.showInputBox({ + prompt: 'New notebook name', + value: oldName, + validateInput: v => v && /^[a-zA-Z0-9_-]+$/.test(v) ? null : 'Use only letters, numbers, hyphens, underscores' + }); + if (!newName || newName === oldName) { return; } + const newUri = vscode.Uri.joinPath(item.uri, '..', `${newName}.pgsql`); + await vscode.workspace.fs.rename(item.uri, newUri, { overwrite: false }); + notebooksTreeProvider?.refresh(); + } + }, + { + command: 'postgres-explorer.notebooks.delete', + callback: async (item: NotebookTreeItem) => { + if (!item?.uri) { return; } + const confirm = await vscode.window.showWarningMessage( + `Delete "${item.label as string}.pgsql"? This cannot be undone.`, + { modal: true }, 'Delete' + ); + if (confirm !== 'Delete') { return; } + await vscode.workspace.fs.delete(item.uri, { recursive: false }); + notebooksTreeProvider?.refresh(); + } + }, { command: 'postgres-explorer.refresh', callback: () => databaseTreeProvider.refresh() @@ -584,6 +612,10 @@ export function registerAllCommands( command: 'postgres-explorer.editMatView', callback: async (item: DatabaseTreeItem) => await cmdEditMatView(item, context) }, + { + command: 'postgres-explorer.editMaterializedView', + callback: async (item: DatabaseTreeItem) => await cmdEditMatView(item, context) + }, { command: 'postgres-explorer.viewMaterializedViewData', callback: async (item: DatabaseTreeItem) => await cmdViewMatViewData(item, context) @@ -634,6 +666,18 @@ export function registerAllCommands( command: 'postgres-explorer.editForeignTable', callback: async (item: DatabaseTreeItem) => await cmdEditForeignTable(item, context) }, + { + command: 'postgres-explorer.showForeignTableProperties', + callback: async (item: DatabaseTreeItem) => await cmdShowForeignTableProperties(item, context) + }, + { + command: 'postgres-explorer.viewForeignTableData', + callback: async (item: DatabaseTreeItem) => await cmdViewForeignTableData(item, context) + }, + { + command: 'postgres-explorer.dropForeignTable', + callback: async (item: DatabaseTreeItem) => await cmdDropForeignTable(item, context) + }, // Add role/user commands { command: 'postgres-explorer.refreshRole', @@ -905,6 +949,10 @@ export function registerAllCommands( command: 'postgres-explorer.generateSelectStatement', callback: async (item: DatabaseTreeItem) => await generateSelectStatement(item) }, + { + command: 'postgresExplorer.openColumnNotebook', + callback: async (item: DatabaseTreeItem) => await showColumnProperties(item) + }, { command: 'postgres-explorer.generateWhereClause', callback: async (item: DatabaseTreeItem) => await generateWhereClause(item) @@ -1188,6 +1236,18 @@ export function registerAllCommands( command: 'postgres-explorer.openSchemaDiff', callback: (item: DatabaseTreeItem) => cmdOpenSchemaDiff(item, context) }, + { + command: 'postgres-explorer.viewMaintenanceVacuum', + callback: async () => { + vscode.window.showInformationMessage('VACUUM is not applicable to regular views. Use this on tables or materialized views.'); + } + }, + { + command: 'postgres-explorer.viewMaintenanceAnalyze', + callback: async () => { + vscode.window.showInformationMessage('ANALYZE is not applicable to regular views. Use this on tables or materialized views.'); + } + }, ]; console.log('Starting command registration...'); diff --git a/src/activation/providers.ts b/src/activation/providers.ts index 3ecb6e8..9ebe537 100644 --- a/src/activation/providers.ts +++ b/src/activation/providers.ts @@ -7,6 +7,8 @@ import { PostgresNotebookSerializer } from '../postgresNotebook'; import { QueryCodeLensProvider } from '../providers/QueryCodeLensProvider'; import { QueryHistoryProvider } from '../providers/QueryHistoryProvider'; import { ProfilesTreeProvider, SavedQueriesTreeProvider } from '../providers/Phase7TreeProviders'; +import { NotebooksTreeProvider } from '../providers/NotebooksTreeProvider'; +import { AutoRefreshService } from '../services/AutoRefreshService'; export function registerProviders(context: vscode.ExtensionContext, outputChannel: vscode.OutputChannel) { // Create database tree provider instance @@ -66,6 +68,7 @@ export function registerProviders(context: vscode.ExtensionContext, outputChanne // Register Query CodeLens Provider for EXPLAIN actions const queryCodeLensProvider = new QueryCodeLensProvider(); + QueryCodeLensProvider.setInstance(queryCodeLensProvider); context.subscriptions.push( vscode.languages.registerCodeLensProvider( { language: 'postgres', scheme: 'vscode-notebook-cell' }, @@ -81,7 +84,7 @@ export function registerProviders(context: vscode.ExtensionContext, outputChanne // Register Query History Provider const queryHistoryProvider = new QueryHistoryProvider(); context.subscriptions.push( - vscode.window.registerTreeDataProvider('postgresExplorer.executedQueryHistory', queryHistoryProvider) + vscode.window.registerTreeDataProvider('postgresExplorer.history', queryHistoryProvider) ); // Store query history provider instance for command access @@ -90,14 +93,34 @@ export function registerProviders(context: vscode.ExtensionContext, outputChanne // Phase 7: Register Saved Queries Tree Provider const savedQueriesTreeProvider = new SavedQueriesTreeProvider(); context.subscriptions.push( - vscode.window.registerTreeDataProvider('postgresExplorer.savedQueryLibrary', savedQueriesTreeProvider) + vscode.window.registerTreeDataProvider('postgresExplorer.savedQueries', savedQueriesTreeProvider) ); + // Notebooks panel — browse all notebooks in globalStorage + const notebooksTreeProvider = new NotebooksTreeProvider(context.globalStorageUri); + const notebooksTreeView = vscode.window.createTreeView('postgresExplorer.notebooks', { + treeDataProvider: notebooksTreeProvider, + showCollapseAll: true + }); + context.subscriptions.push(notebooksTreeView); + + // Auto-refresh service — keeps the explorer and notebooks panel in sync + const autoRefreshService = new AutoRefreshService( + databaseTreeProvider, + notebooksTreeProvider, + context.globalStorageUri, + outputChannel + ); + autoRefreshService.start(); + databaseTreeProvider.setAutoRefreshService(autoRefreshService); + return { databaseTreeProvider, treeView, chatViewProviderInstance, queryHistoryProvider, - savedQueriesTreeProvider + savedQueriesTreeProvider, + notebooksTreeProvider, + autoRefreshService }; } diff --git a/src/activation/statusBar.ts b/src/activation/statusBar.ts index 6981e73..b8c015e 100644 --- a/src/activation/statusBar.ts +++ b/src/activation/statusBar.ts @@ -2,6 +2,7 @@ import * as vscode from 'vscode'; import { PostgresMetadata } from '../common/types'; import { extensionContext } from '../extension'; import { ProfileManager } from '../services/ProfileManager'; +import { getTransactionManager } from '../services/TransactionManager'; /** * Manages the notebook status bar items that display connection and database info. @@ -12,6 +13,7 @@ export class NotebookStatusBar implements vscode.Disposable { private readonly databaseItem: vscode.StatusBarItem; private readonly riskIndicatorItem: vscode.StatusBarItem; private readonly profileItem: vscode.StatusBarItem; + private readonly transactionItem: vscode.StatusBarItem; private readonly disposables: vscode.Disposable[] = []; constructor() { @@ -31,11 +33,15 @@ export class NotebookStatusBar implements vscode.Disposable { this.profileItem.command = 'postgres-explorer.switchConnectionProfile'; this.profileItem.tooltip = 'Click to switch connection profile'; + this.transactionItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 96); + this.transactionItem.tooltip = 'Transaction is open — click to view transaction details'; + this.disposables.push( this.connectionItem, this.databaseItem, this.riskIndicatorItem, this.profileItem, + this.transactionItem, vscode.window.onDidChangeActiveNotebookEditor(() => this.update()), vscode.workspace.onDidChangeNotebookDocument((e) => { if (vscode.window.activeNotebookEditor?.notebook === e.notebook) { @@ -85,6 +91,7 @@ export class NotebookStatusBar implements vscode.Disposable { this.databaseItem.hide(); this.riskIndicatorItem.hide(); this.profileItem.hide(); + this.transactionItem.hide(); } private showNoConnection(): void { @@ -94,6 +101,7 @@ export class NotebookStatusBar implements vscode.Disposable { this.databaseItem.hide(); this.riskIndicatorItem.hide(); this.profileItem.hide(); + this.transactionItem.hide(); } private showConnection(connection: any, metadata: PostgresMetadata): void { @@ -188,6 +196,32 @@ export class NotebookStatusBar implements vscode.Disposable { } } + /** + * Updates the transaction status bar item based on the current transaction state. + * Call this after a transaction begins, commits, or rolls back. + * @param sessionId The notebook URI string used as the session ID. + */ + public updateTransactionState(sessionId?: string): void { + const editor = vscode.window.activeNotebookEditor; + if (!this.isPostgresNotebook(editor)) { + this.transactionItem.hide(); + return; + } + + const id = sessionId ?? editor!.notebook.uri.toString(); + const txManager = getTransactionManager(); + const txInfo = txManager.getTransactionInfo(id); + + if (txInfo?.isActive) { + this.transactionItem.text = '$(sync~spin) Transaction open'; + this.transactionItem.backgroundColor = new vscode.ThemeColor('statusBarItem.warningBackground'); + this.transactionItem.tooltip = 'A PostgreSQL transaction is open — commit or rollback to close it'; + this.transactionItem.show(); + } else { + this.transactionItem.hide(); + } + } + dispose(): void { this.disposables.forEach(d => d.dispose()); } diff --git a/src/aiSettingsPanel.ts b/src/aiSettingsPanel.ts index 2301b5d..22e317a 100644 --- a/src/aiSettingsPanel.ts +++ b/src/aiSettingsPanel.ts @@ -1,5 +1,6 @@ import * as vscode from 'vscode'; import * as https from 'https'; +import * as http from 'http'; import { getChatViewProvider } from './extension'; export interface AiSettings { @@ -7,8 +8,18 @@ export interface AiSettings { apiKey?: string; model?: string; endpoint?: string; + githubAuth?: { + connected: boolean; + accountLabel?: string; + }; } +// GitHub Models access for OAuth sessions does not require a dedicated OAuth scope. +// Requesting `models:read` here can force PAT fallback in some VS Code distributions. +const GITHUB_MODELS_SCOPES: string[] = []; +const GITHUB_MODELS_API_VERSION = '2026-03-10'; +const DEFAULT_GITHUB_MODEL = 'openai/gpt-4.1'; + export class AiSettingsPanel { public static currentPanel: AiSettingsPanel | undefined; private readonly _panel: vscode.WebviewPanel; @@ -29,17 +40,23 @@ export class AiSettingsPanel { this._panel.webview.onDidReceiveMessage( async (message) => { switch (message.command) { + case 'connectGitHub': + await this._connectGitHub(); + break; + + case 'disconnectGitHub': + await this._disconnectGitHub(); + break; + case 'saveSettings': try { const settings = message.settings; - const config = vscode.workspace.getConfiguration('postgresExplorer'); - - await config.update('aiProvider', settings.provider, vscode.ConfigurationTarget.Global); - await config.update('aiModel', settings.model || '', vscode.ConfigurationTarget.Global); - await config.update('aiEndpoint', settings.endpoint || '', vscode.ConfigurationTarget.Global); + await this._setProvider(settings.provider, settings.model || '', settings.endpoint || ''); // Store API key in secret storage - if (settings.apiKey) { + if (settings.provider === 'github') { + await this._extensionContext.secrets.delete('postgresExplorer.aiApiKey'); + } else if (settings.apiKey) { await this._extensionContext.secrets.store('postgresExplorer.aiApiKey', settings.apiKey); } else { await this._extensionContext.secrets.delete('postgresExplorer.aiApiKey'); @@ -103,6 +120,9 @@ export class AiSettingsPanel { throw new Error('No VS Code Language Models available. Please install GitHub Copilot or other LM extension.'); } } + } else if (settings.provider === 'github') { + const session = await this._requestGitHubSession(true); + testResult = await this._testGitHubModels(session.accessToken, settings.model || DEFAULT_GITHUB_MODEL); } else if (settings.provider === 'openai') { // Test OpenAI connection if (!settings.apiKey) { @@ -127,6 +147,12 @@ export class AiSettingsPanel { throw new Error('Endpoint is required for custom provider'); } testResult = 'Custom endpoint configured. Ensure it supports OpenAI-compatible API.'; + } else if (settings.provider === 'ollama') { + const ep = settings.endpoint || 'http://localhost:11434/v1/chat/completions'; + testResult = await this._testLocalEndpoint(ep, 'Ollama'); + } else if (settings.provider === 'lmstudio') { + const ep = settings.endpoint || 'http://localhost:1234/v1/chat/completions'; + testResult = await this._testLocalEndpoint(ep, 'LM Studio'); } this._panel.webview.postMessage({ @@ -143,18 +169,7 @@ export class AiSettingsPanel { case 'loadSettings': try { - const config = vscode.workspace.getConfiguration('postgresExplorer'); - const apiKey = await this._extensionContext.secrets.get('postgresExplorer.aiApiKey'); - - this._panel.webview.postMessage({ - type: 'settingsLoaded', - settings: { - provider: config.get('aiProvider', 'vscode-lm'), - apiKey: apiKey || '', - model: config.get('aiModel', ''), - endpoint: config.get('aiEndpoint', '') - } - }); + await this._sendSettingsLoaded(); } catch (err: any) { console.error('Failed to load settings:', err); } @@ -173,20 +188,20 @@ export class AiSettingsPanel { const family = m.family; return family && family !== name ? `${name} (${family})` : name; }); + } else if (settings.provider === 'github') { + const session = await this._requestGitHubSession(true); + models = await this._listGitHubModels(session.accessToken); } else if (settings.provider === 'openai') { if (!settings.apiKey) { throw new Error('API Key is required to list models'); } models = await this._listOpenAIModels(settings.apiKey); } else if (settings.provider === 'anthropic') { - // Anthropic doesn't have a public models API, use known models - models = [ - 'claude-3-5-sonnet-20241022', - 'claude-3-5-haiku-20241022', - 'claude-3-opus-20240229', - 'claude-3-sonnet-20240229', - 'claude-3-haiku-20240307' - ]; + // Use Anthropic's models API when an API key is provided + if (!settings.apiKey) { + throw new Error('API Key is required to list models for Anthropic'); + } + models = await this._listAnthropicModels(settings.apiKey); } else if (settings.provider === 'gemini') { if (!settings.apiKey) { throw new Error('API Key is required to list models'); @@ -199,6 +214,12 @@ export class AiSettingsPanel { } else { models = ['custom-model']; } + } else if (settings.provider === 'ollama') { + const ep = settings.endpoint || 'http://localhost:11434/v1/chat/completions'; + models = await this._listCustomModels(ep, ''); + } else if (settings.provider === 'lmstudio') { + const ep = settings.endpoint || 'http://localhost:1234/v1/chat/completions'; + models = await this._listCustomModels(ep, ''); } this._panel.webview.postMessage({ @@ -258,6 +279,63 @@ export class AiSettingsPanel { }); } + private async _listAnthropicModels(apiKey: string): Promise { + return new Promise((resolve, reject) => { + const options = { + hostname: 'api.anthropic.com', + path: '/v1/models', + method: 'GET', + headers: { + 'X-Api-Key': apiKey, + 'anthropic-version': '2023-06-01' + } + }; + + const req = https.request(options, (res: any) => { + let body = ''; + res.on('data', (chunk: any) => body += chunk); + res.on('end', () => { + if (res.statusCode === 200) { + try { + const data = JSON.parse(body); + + // Accept several response shapes (models, data, or array) + let list: any[] = []; + if (Array.isArray(data)) { + list = data; + } else if (Array.isArray(data.models)) { + list = data.models; + } else if (Array.isArray(data.data)) { + list = data.data; + } else { + for (const k of Object.keys(data)) { + if (Array.isArray((data as any)[k])) { + list = (data as any)[k]; + break; + } + } + } + + const models = list + .map((m: any) => m.id || m.name || m.model || (typeof m === 'string' ? m : undefined)) + .filter(Boolean) + .sort(); + + resolve(models as string[]); + } catch (e) { + reject(new Error('Failed to parse Anthropic models response')); + } + } else { + reject(new Error(`Failed to list Anthropic models: ${res.statusCode} - ${body}`)); + } + }); + }); + + req.on('error', (err: any) => reject(err)); + req.end(); + }); + } + private async _listGeminiModels(apiKey: string): Promise { return new Promise((resolve, reject) => { const options = { @@ -313,7 +391,7 @@ export class AiSettingsPanel { } : {} }; - const protocol = url.protocol === 'https:' ? https : require('http'); + const protocol = url.protocol === 'https:' ? https : http; const req = protocol.request(options, (res: any) => { let body = ''; res.on('data', (chunk: any) => body += chunk); @@ -340,6 +418,192 @@ export class AiSettingsPanel { }); } + private async _requestGitHubSession(interactive: boolean): Promise { + return await vscode.authentication.getSession('github', GITHUB_MODELS_SCOPES, interactive ? { + createIfNone: true, + forceNewSession: false, + clearSessionPreference: false + } as any : { + silent: true, + clearSessionPreference: false + }); + } + + private async _getGitHubSession(): Promise { + try { + return await vscode.authentication.getSession('github', GITHUB_MODELS_SCOPES, { + silent: true, + clearSessionPreference: false + }); + } catch { + return undefined; + } + } + + private async _listGitHubModels(token: string): Promise { + return new Promise((resolve, reject) => { + const options = { + hostname: 'models.github.ai', + path: '/catalog/models', + method: 'GET', + headers: { + 'Accept': 'application/vnd.github+json', + 'Authorization': `Bearer ${token}`, + 'X-GitHub-Api-Version': GITHUB_MODELS_API_VERSION + } + }; + + const req = https.request(options, (res: any) => { + let body = ''; + res.on('data', (chunk: any) => body += chunk); + res.on('end', () => { + if (res.statusCode === 200) { + try { + const data = JSON.parse(body); + const models = Array.isArray(data) + ? data + .filter((model: any) => (model.supported_output_modalities?.includes('text') ?? true)) + .map((model: any) => model.id) + .filter(Boolean) + .sort() + : []; + resolve(models); + } catch { + reject(new Error('Failed to parse GitHub Models catalog response')); + } + } else { + reject(new Error(`Failed to list GitHub Models: ${res.statusCode} - ${body}`)); + } + }); + }); + + req.on('error', (err: any) => reject(err)); + req.end(); + }); + } + + private async _testGitHubModels(token: string, model: string): Promise { + return new Promise((resolve, reject) => { + const data = JSON.stringify({ + model, + messages: [{ role: 'user', content: 'Hello' }], + max_tokens: 16, + temperature: 0.2 + }); + + const options = { + hostname: 'models.github.ai', + path: '/inference/chat/completions', + method: 'POST', + headers: { + 'Accept': 'application/vnd.github+json', + 'Authorization': `Bearer ${token}`, + 'X-GitHub-Api-Version': GITHUB_MODELS_API_VERSION, + 'Content-Type': 'application/json', + 'Content-Length': Buffer.byteLength(data) + } + }; + + const req = https.request(options, (res) => { + let body = ''; + res.on('data', (chunk) => body += chunk); + res.on('end', () => { + if (res.statusCode === 200) { + resolve(`GitHub Models connection successful! Model: ${model}`); + } else { + reject(new Error(`GitHub Models API error: ${res.statusCode} - ${body}`)); + } + }); + }); + + req.on('error', (err) => reject(err)); + req.write(data); + req.end(); + }); + } + + private async _sendSettingsLoaded(): Promise { + const config = vscode.workspace.getConfiguration('postgresExplorer'); + const apiKey = await this._extensionContext.secrets.get('postgresExplorer.aiApiKey'); + const githubSession = await this._getGitHubSession(); + + await this._panel.webview.postMessage({ + type: 'settingsLoaded', + settings: { + provider: config.get('aiProvider', 'vscode-lm'), + apiKey: apiKey || '', + model: config.get('aiModel', ''), + endpoint: config.get('aiEndpoint', ''), + githubAuth: { + connected: !!githubSession, + accountLabel: githubSession?.account.label + } + } + }); + } + + private async _setProvider(provider: string, model: string, endpoint: string): Promise { + const config = vscode.workspace.getConfiguration('postgresExplorer'); + await config.update('aiProvider', provider, vscode.ConfigurationTarget.Global); + await config.update('aiModel', model, vscode.ConfigurationTarget.Global); + await config.update('aiEndpoint', endpoint, vscode.ConfigurationTarget.Global); + } + + private async _connectGitHub(): Promise { + const session = await this._requestGitHubSession(true); + await this._setProvider('github', '', ''); + await this._panel.webview.postMessage({ + type: 'githubConnected', + accountLabel: session.account.label, + scopes: session.scopes + }); + await this._sendSettingsLoaded(); + await this._refreshModelInfo(); + } + + private async _disconnectGitHub(): Promise { + await this._setProvider('vscode-lm', '', ''); + await this._panel.webview.postMessage({ + type: 'githubDisconnected' + }); + await this._sendSettingsLoaded(); + await this._refreshModelInfo(); + } + + private async _refreshModelInfo(): Promise { + const chatViewProvider = getChatViewProvider(); + if (chatViewProvider) { + chatViewProvider.refreshModelInfo(); + } + } + + private async _testLocalEndpoint(endpoint: string, name: string): Promise { + return new Promise((resolve, reject) => { + try { + const url = new URL(endpoint); + const modelsPath = url.pathname.replace(/\/chat\/completions$/, '') + '/models'; + const protocol = url.protocol === 'https:' ? https : http; + const req = protocol.request({ + hostname: url.hostname, + port: url.port || (url.protocol === 'https:' ? 443 : 80), + path: modelsPath, + method: 'GET' + }, (res: any) => { + if (res.statusCode === 200) { + resolve(`${name} is running and reachable at ${url.hostname}:${url.port || 80}`); + } else { + reject(new Error(`${name} responded with status ${res.statusCode}. Is it running?`)); + } + res.resume(); + }); + req.on('error', () => reject(new Error(`Cannot reach ${name} at ${endpoint}. Make sure it is running.`))); + req.end(); + } catch (e: any) { + reject(new Error(`Invalid endpoint URL: ${e.message}`)); + } + }); + } + private async _testOpenAI(apiKey: string, model: string): Promise { return new Promise((resolve, reject) => { const data = JSON.stringify({ diff --git a/src/commands/aiAssist.ts b/src/commands/aiAssist.ts index 08805f1..5b2da5b 100644 --- a/src/commands/aiAssist.ts +++ b/src/commands/aiAssist.ts @@ -3,6 +3,7 @@ import { ErrorHandlers, StringUtils } from './helper'; import { ConnectionManager } from '../services/ConnectionManager'; import { PostgresMetadata } from '../common/types'; import { AiService } from '../providers/chat/AiService'; +import { QueryCodeLensProvider } from '../providers/QueryCodeLensProvider'; interface TableSchemaInfo { tableName: string; @@ -62,6 +63,82 @@ export async function cmdAiAssist(cell: vscode.NotebookCell | undefined, context return; } + // Apply visual feedback to the cell while AI is working + const cellUri = validCell.document.uri.toString(); + const codeLensProvider = QueryCodeLensProvider.getInstance(); + + // Option 6: CodeLens spinner + codeLensProvider?.setAiWorking(cellUri, true); + + // Option 3: background tint + animated after-line spinner + const spinnerFrames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']; + let spinnerIndex = 0; + let activeSpinnerType: vscode.TextEditorDecorationType | null = null; + + const bgDecorationType = vscode.window.createTextEditorDecorationType({ + isWholeLine: true, + backgroundColor: 'rgba(99, 179, 237, 0.07)', + }); + + const getCellEditor = () => vscode.window.visibleTextEditors.find( + e => e.document.uri.toString() === validCell.document.uri.toString() + ); + + const applyBgDecoration = () => { + const cellEditor = getCellEditor(); + if (!cellEditor) { return; } + const lineCount = cellEditor.document.lineCount; + const fullRanges = Array.from({ length: lineCount }, (_, i) => + new vscode.Range(i, 0, i, cellEditor.document.lineAt(i).text.length) + ); + cellEditor.setDecorations(bgDecorationType, fullRanges); + }; + + const updateSpinner = () => { + const cellEditor = getCellEditor(); + if (!cellEditor) { return; } + // Clear previous spinner decoration + if (activeSpinnerType) { + cellEditor.setDecorations(activeSpinnerType, []); + activeSpinnerType.dispose(); + } + // Create new one with updated frame + activeSpinnerType = vscode.window.createTextEditorDecorationType({ + after: { + contentText: spinnerFrames[spinnerIndex], + color: 'rgba(99, 179, 237, 0.9)', + margin: '0 0 0 12px', + } + }); + const lastLine = cellEditor.document.lineCount - 1; + cellEditor.setDecorations(activeSpinnerType, [ + new vscode.Range(lastLine, 0, lastLine, cellEditor.document.lineAt(lastLine).text.length) + ]); + }; + + const removeDecorations = () => { + clearInterval(spinnerInterval); + const cellEditor = getCellEditor(); + if (cellEditor) { + cellEditor.setDecorations(bgDecorationType, []); + if (activeSpinnerType) { + cellEditor.setDecorations(activeSpinnerType, []); + } + } + bgDecorationType.dispose(); + activeSpinnerType?.dispose(); + activeSpinnerType = null; + codeLensProvider?.setAiWorking(cellUri, false); + }; + + applyBgDecoration(); + updateSpinner(); + + const spinnerInterval = setInterval(() => { + spinnerIndex = (spinnerIndex + 1) % spinnerFrames.length; + updateSpinner(); + }, 100); + try { const config = vscode.workspace.getConfiguration('postgresExplorer'); const provider = config.get('aiProvider') || 'vscode-lm'; @@ -128,7 +205,11 @@ export async function cmdAiAssist(cell: vscode.NotebookCell | undefined, context } }); + removeDecorations(); + } catch (error) { + removeDecorations(); + console.error('AI Assist Error:', error); const message = error instanceof Error ? error.message : String(error); await ErrorHandlers.showError( diff --git a/src/commands/columns.ts b/src/commands/columns.ts index b67583c..42b4fdf 100644 --- a/src/commands/columns.ts +++ b/src/commands/columns.ts @@ -3,7 +3,6 @@ import { DatabaseTreeItem } from '../providers/DatabaseTreeProvider'; import { MarkdownUtils, - FormatHelpers, ValidationHelpers, ErrorHandlers, SQL_TEMPLATES, @@ -53,7 +52,7 @@ export async function showColumnProperties(item: DatabaseTreeItem) { 'Data Type': `${dataTypeDetails}`, 'UDT Name': `${col.udt_name}`, 'Position': `${col.ordinal_position}`, - 'Nullable': FormatHelpers.formatBoolean(col.is_nullable === 'YES'), + 'Nullable': col.is_nullable === 'YES' ? 'Yes' : 'No', 'Default Value': col.column_default ? `${col.column_default}` : '—' }) ); @@ -66,11 +65,8 @@ export async function showColumnProperties(item: DatabaseTreeItem) { nb.addMarkdown(`#### 💬 Comment\n\n\`\`\`\n${col.column_comment}\n\`\`\``); } - nb.addMarkdown('---') - .addMarkdown('##### 📖 Query Column') - .addSql(ColumnSQL.select(item.schema!, tableName, columnName)) - .addMarkdown('##### 📊 Column Statistics') - .addSql(ColumnSQL.statistics(item.schema!, tableName, columnName)); + nb.addMarkdown('##### 📖 Query Column') + .addSql(ColumnSQL.select(item.schema!, tableName, columnName)); await nb.show(); @@ -102,14 +98,8 @@ export async function generateSelectStatement(item: DatabaseTreeItem) { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📖 SELECT Statement: \`${columnName}\``) + - MarkdownUtils.infoBox(`Query specific column from \`${item.schema}.${tableName}\``) - ) - .addSql(`-- Select ${columnName} column -SELECT ${columnName} -FROM ${item.schema}.${tableName} -LIMIT 100;`) + .addMarkdown(`### 📖 SELECT Statement: \`${columnName}\`\n\nQuery specific column from \`${item.schema}.${tableName}\`.`) + .addSql(ColumnSQL.select(item.schema!, tableName, columnName)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'generate SELECT statement'); @@ -127,11 +117,24 @@ export async function generateWhereClause(item: DatabaseTreeItem) { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🔍 WHERE Clause Templates: \`${columnName}\``) + - MarkdownUtils.infoBox(`Common WHERE clause patterns for filtering by \`${columnName}\``) - ) - .addSql(ColumnSQL.whereTemplates(item.schema!, tableName, columnName)) + .addMarkdown(`### 🔍 WHERE Clause: \`${columnName}\`\n\nFilter rows by \`${columnName}\` in \`${item.schema}.${tableName}\`.`) + .addSql(`-- Filter by column value +SELECT * +FROM ${item.schema}.${tableName} +WHERE ${columnName} = 'value'; + +-- Use IS NULL / IS NOT NULL to filter nulls +-- SELECT * FROM ${item.schema}.${tableName} WHERE ${columnName} IS NULL; +-- SELECT * FROM ${item.schema}.${tableName} WHERE ${columnName} IS NOT NULL; + +-- Use LIKE for pattern matching (text columns) +-- SELECT * FROM ${item.schema}.${tableName} WHERE ${columnName} LIKE '%pattern%'; + +-- Use BETWEEN for range filtering +-- SELECT * FROM ${item.schema}.${tableName} WHERE ${columnName} BETWEEN 'a' AND 'z'; + +-- Use IN for multiple values +-- SELECT * FROM ${item.schema}.${tableName} WHERE ${columnName} IN ('val1', 'val2');`) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'generate WHERE clause'); @@ -149,18 +152,7 @@ export async function generateAlterColumnScript(item: DatabaseTreeItem) { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`✏️ ALTER COLUMN Script: \`${columnName}\``) + - MarkdownUtils.warningBox('Modifying column structure may fail if data doesn\'t match new constraints or type.') + - `\n\n#### Available Modifications\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'Change Data Type', description: 'Convert column to different type' }, - { operation: 'Set NOT NULL', description: 'Prevent NULL values' }, - { operation: 'Drop NOT NULL', description: 'Allow NULL values' }, - { operation: 'Set Default', description: 'Add default value for new rows' }, - { operation: 'Drop Default', description: 'Remove default value' } - ]) - ) + .addMarkdown(`### ✏️ ALTER COLUMN Script: \`${columnName}\`\n\nModify column structure in \`${item.schema}.${tableName}\`.`) .addSql(ColumnSQL.alter(item.schema!, tableName, columnName)) .show(); } catch (err: any) { @@ -179,17 +171,7 @@ export async function generateDropColumnScript(item: DatabaseTreeItem) { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🗑️ DROP COLUMN Script: \`${columnName}\``) + - MarkdownUtils.dangerBox('This will permanently delete the column and ALL its data! This operation cannot be undone.') + - `\n\n#### Before You Drop\n\n` + - `1. **Backup your data** - Export table or create a snapshot\n` + - `2. **Check dependencies** - Views, functions, or triggers may use this column\n` + - `3. **Test on non-production** - Verify the change works as expected\n\n` + - `\n\n#### Options\n\n` + - `- **RESTRICT** (default): Fails if column has dependencies\n` + - `- **CASCADE**: Automatically drops dependent objects (views, triggers, etc.)` - ) + .addMarkdown(`### 🗑️ DROP COLUMN Script: \`${columnName}\`\n\n⚠️ **Danger:** This permanently deletes the column and all its data. This cannot be undone.`) .addSql(ColumnSQL.drop(item.schema!, tableName, columnName)) .show(); } catch (err: any) { @@ -218,10 +200,7 @@ export async function generateRenameColumnScript(item: DatabaseTreeItem) { } await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🔄 RENAME COLUMN: \`${columnName}\` → \`${newName}\``) + - MarkdownUtils.infoBox('Renaming is safe and atomic. Dependent objects (views, functions) will be automatically updated.') - ) + .addMarkdown(`### 🔄 RENAME COLUMN: \`${columnName}\` → \`${newName}\`\n\nRename column in \`${item.schema}.${tableName}\`.`) .addSql(ColumnSQL.rename(item.schema!, tableName, columnName, newName)) .show(); } catch (err: any) { @@ -249,10 +228,7 @@ export async function addColumnComment(item: DatabaseTreeItem) { } await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`💬 Add Column Comment: \`${columnName}\``) + - MarkdownUtils.infoBox('Column comments are stored in PostgreSQL system catalogs and visible in `pg_stats`') - ) + .addMarkdown(`### 💬 Add Column Comment: \`${columnName}\`\n\nSet a comment on column \`${item.schema}.${tableName}.${columnName}\`.`) .addSql(`-- Add/update comment for column ${columnName} ${SQL_TEMPLATES.COMMENT.COLUMN(item.schema!, tableName, columnName, comment)} @@ -285,18 +261,7 @@ export async function generateIndexOnColumn(item: DatabaseTreeItem) { } await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🔍 CREATE INDEX: \`${indexName}\``) + - MarkdownUtils.infoBox('Indexes improve query performance but slow down write operations. Choose the right index type for your use case.') + - `\n\n#### Index Types\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'B-tree (default)', description: 'Most queries, equality and range' }, - { operation: 'Hash', description: 'Simple equality comparisons only' }, - { operation: 'GIN', description: 'Array, JSONB, full-text search' }, - { operation: 'GiST', description: 'Geometric data, full-text search' } - ]) + `\n` + - MarkdownUtils.successBox('Use `CREATE INDEX CONCURRENTLY` to avoid locking the table during index creation on production databases.') - ) + .addMarkdown(`### 🔍 CREATE INDEX: \`${indexName}\`\n\nCreate an index on \`${item.schema}.${tableName}.${columnName}\`.`) .addSql(ColumnSQL.createIndex(item.schema!, tableName, columnName, indexName)) .show(); } catch (err: any) { @@ -315,18 +280,22 @@ export async function viewColumnStatistics(item: DatabaseTreeItem) { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📊 Column Statistics: \`${columnName}\``) + - MarkdownUtils.infoBox(`Statistics are collected by \`ANALYZE\` and used by the query planner for optimization. Run \`ANALYZE ${item.schema}.${tableName};\` if statistics are missing.`) + - `\n\n#### Statistics Explained\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'n_distinct', description: 'Estimated number of distinct values (-1 = all unique, 0-1 = fraction, >1 = count)' }, - { operation: 'null_frac', description: 'Fraction of NULL values (0.0 to 1.0)' }, - { operation: 'avg_width', description: 'Average storage width in bytes' }, - { operation: 'correlation', description: 'Statistical correlation between physical row order and logical order (-1 to 1)' } - ]) - ) - .addSql(ColumnSQL.detailedStatistics(item.schema!, tableName, columnName)) + .addMarkdown(`### 📊 Column Statistics: \`${columnName}\`\n\nQuery planner statistics for \`${item.schema}.${tableName}.${columnName}\`.`) + .addSql(`-- Column statistics from pg_stats +SELECT + n_distinct, + null_frac, + avg_width, + correlation, + most_common_vals, + most_common_freqs +FROM pg_stats +WHERE schemaname = '${item.schema}' + AND tablename = '${tableName}' + AND attname = '${columnName}'; + +-- Run ANALYZE to refresh statistics if missing +-- ANALYZE ${item.schema}.${tableName};`) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'view column statistics'); @@ -336,7 +305,7 @@ export async function viewColumnStatistics(item: DatabaseTreeItem) { } /** - * Add new column to table - generates a comprehensive notebook with guidelines and SQL templates + * Add new column to table */ export async function cmdAddColumn(item: DatabaseTreeItem): Promise { let dbConn; @@ -347,46 +316,18 @@ export async function cmdAddColumn(item: DatabaseTreeItem): Promise { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`➕ Add New Column to \`${schema}.${tableName}\``) + - MarkdownUtils.infoBox('This notebook provides templates for adding new columns. Modify the templates below and execute to add columns.') + - `\n\n#### 📋 Guidelines for Adding Columns\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'Naming', description: 'Use snake_case (e.g., user_name, created_at). Avoid reserved words.' }, - { operation: 'Data Types', description: 'Choose appropriate types: INTEGER, VARCHAR(n), TEXT, BOOLEAN, TIMESTAMP, JSONB, UUID' }, - { operation: 'Constraints', description: 'Consider NOT NULL, DEFAULT, CHECK constraints at column level' }, - { operation: 'Performance', description: 'Adding columns is fast but adding with DEFAULT on large tables may lock' } - ]) + - `\n\n#### 🏷️ Common Data Types Reference\n\n` + - MarkdownUtils.propertiesTable({ - 'INTEGER / BIGINT': 'Whole numbers (4/8 bytes)', - 'SERIAL / BIGSERIAL': 'Auto-incrementing integer', - 'VARCHAR(n) / TEXT': 'Variable-length strings', - 'BOOLEAN': 'true/false values', - 'TIMESTAMP / TIMESTAMPTZ': 'Date and time (with/without timezone)', - 'DATE / TIME': 'Date or time only', - 'NUMERIC(p,s)': 'Exact decimal numbers', - 'JSONB': 'Binary JSON (recommended for JSON data)', - 'UUID': 'Universally unique identifier', - 'ARRAY': 'Array of any type (e.g., INTEGER[])', - }) + - `\n\n---` - ) - .addMarkdown('##### 📝 Basic Column (Recommended Start)') - .addSql(ColumnSQL.add.basic(schema, tableName)) - .addMarkdown('##### 🔒 Column with NOT NULL and DEFAULT') - .addSql(ColumnSQL.add.withDefault(schema, tableName)) - .addMarkdown('##### ⏰ Timestamp Columns') - .addSql(ColumnSQL.add.timestamps(schema, tableName)) - .addMarkdown('##### ✅ Column with CHECK Constraint') - .addSql(ColumnSQL.add.withCheck(schema, tableName)) - .addMarkdown('##### 🔗 Foreign Key Column') - .addSql(ColumnSQL.add.foreignKey(schema, tableName)) - .addMarkdown('##### 📄 JSON Column') - .addSql(ColumnSQL.add.jsonb(schema, tableName)) - .addMarkdown('##### 🆔 UUID Column') - .addSql(ColumnSQL.add.uuid(schema, tableName)) - .addMarkdown(MarkdownUtils.warningBox('After adding columns, consider adding indexes for frequently queried columns and updating application code.')) + .addMarkdown(`### ➕ Add Column to \`${schema}.${tableName}\`\n\nAdd a new column using the template below.`) + .addSql(`-- Add a new column +ALTER TABLE ${schema}.${tableName} + ADD COLUMN column_name data_type; + +-- Use NOT NULL with a DEFAULT to avoid locking on large tables +-- ALTER TABLE ${schema}.${tableName} +-- ADD COLUMN column_name data_type NOT NULL DEFAULT default_value; + +-- Use IF NOT EXISTS to suppress error if column already exists +-- ALTER TABLE ${schema}.${tableName} +-- ADD COLUMN IF NOT EXISTS column_name data_type;`) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'add column'); diff --git a/src/commands/constraints.ts b/src/commands/constraints.ts index e005cb9..0923803 100644 --- a/src/commands/constraints.ts +++ b/src/commands/constraints.ts @@ -2,10 +2,7 @@ import * as vscode from 'vscode'; import { DatabaseTreeItem } from '../providers/DatabaseTreeProvider'; import { MarkdownUtils, - FormatHelpers, ErrorHandlers, - SQL_TEMPLATES, - ObjectUtils, getDatabaseConnection, NotebookBuilder, QueryBuilder @@ -34,33 +31,20 @@ export async function showConstraintProperties(treeItem: DatabaseTreeItem): Prom const constraint = result.rows[0]; - // Build constraint type icon - const typeIcon = ObjectUtils.getConstraintIcon(constraint.constraint_type); - const nb = new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`${typeIcon} Constraint Properties: \`${constraint.constraint_name}\``) + - MarkdownUtils.infoBox(`Table: \`${schema}.${tableName}\``) + - `\n\n#### 📊 Basic Information\n\n` + - MarkdownUtils.propertiesTable({ - 'Constraint Name': `${constraint.constraint_name}`, - 'Type': `${constraint.constraint_type}`, - 'Columns': `${constraint.columns || '—'}`, - 'Deferrable': FormatHelpers.formatBoolean(constraint.is_deferrable === 'YES'), - 'Initially Deferred': FormatHelpers.formatBoolean(constraint.initially_deferred === 'YES') - }) + `### 🛡️ Constraint Properties: \`${constraint.constraint_name}\`\n\n` + + `Table: \`${schema}.${tableName}\` — Type: \`${constraint.constraint_type}\`` ); if (constraint.constraint_definition) { - nb.addMarkdown(`#### 🔧 Definition\n\n\`\`\`sql\n${constraint.constraint_definition}\n\`\`\``); + nb.addMarkdown(`##### Definition`); + nb.addMarkdown(`\`\`\`sql\n${constraint.constraint_definition}\n\`\`\``); } if (constraint.check_clause) { - nb.addMarkdown(`#### ✓ Check Clause\n\n\`\`\`sql\n${constraint.check_clause}\n\`\`\``); - } - - if (constraint.comment) { - nb.addMarkdown(`#### 💬 Comment\n\n\`\`\`\n${constraint.comment}\n\`\`\``); + nb.addMarkdown(`##### Check Clause`); + nb.addMarkdown(`\`\`\`sql\n${constraint.check_clause}\n\`\`\``); } // Get foreign key details if applicable @@ -68,21 +52,13 @@ export async function showConstraintProperties(treeItem: DatabaseTreeItem): Prom const fkResult = await client.query(QueryBuilder.foreignKeyDetails(schema, constraintName)); if (fkResult.rows.length > 0) { - let fkMarkdown = `#### 🔗 Foreign Key References\n\n - `; - - fkResult.rows.forEach((row: any) => { - fkMarkdown += `\n `; - }); - - fkMarkdown += '\n
    ColumnReferencesOn UpdateOn Delete
    ${row.column_name}${row.foreign_table_schema}.${row.foreign_table_name}.${row.foreign_column_name}${row.update_rule}${row.delete_rule}
    '; - nb.addMarkdown(fkMarkdown); + const refs = fkResult.rows.map((row: any) => + `${row.column_name} → ${row.foreign_table_schema}.${row.foreign_table_name}.${row.foreign_column_name} (ON UPDATE ${row.update_rule}, ON DELETE ${row.delete_rule})` + ).join('\n'); + nb.addMarkdown(`##### Foreign Key References\n\n\`\`\`\n${refs}\n\`\`\``); } } - nb.addMarkdown('##### 📖 Query Constraint Details') - .addSql(ConstraintSQL.details(schema, constraintName)); - await nb.show(); } catch (err: any) { @@ -115,11 +91,11 @@ export async function generateDropConstraintScript(treeItem: DatabaseTreeItem): await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`🗑️ DROP CONSTRAINT: \`${constraintName}\``) + - MarkdownUtils.dangerBox('This will remove the constraint from the table. Data integrity checks enforced by this constraint will no longer apply.') + - MarkdownUtils.infoBox(`Table: \`${schema}.${tableName}\``) + `### 🗑️ Drop Constraint: \`${constraintName}\`\n\n` + + `Removes constraint from \`${schema}.${tableName}\`.` ) - .addSql(SQL_TEMPLATES.DROP.CONSTRAINT(schema, tableName, constraintName)) + .addMarkdown(`##### ⚠️ Drop Constraint — danger: this permanently removes the constraint and its data integrity enforcement.`) + .addSql(ConstraintSQL.drop(schema, tableName, constraintName)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'generate drop constraint script'); @@ -129,7 +105,7 @@ export async function generateDropConstraintScript(treeItem: DatabaseTreeItem): } /** - * Generate ALTER CONSTRAINT script + * Generate ALTER CONSTRAINT script (RENAME) */ export async function generateAlterConstraintScript(treeItem: DatabaseTreeItem): Promise { let dbConn; @@ -142,15 +118,15 @@ export async function generateAlterConstraintScript(treeItem: DatabaseTreeItem): await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`✏️ ALTER CONSTRAINT: \`${constraintName}\``) + - MarkdownUtils.infoBox(`Table: \`${schema}.${tableName}\``) + - `\n\n#### Available Operations\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'RENAME', description: 'Change the name of the constraint' }, - { operation: 'VALIDATE', description: 'Validate a constraint that was created as NOT VALID' } - ]) + `### ✏️ Rename Constraint: \`${constraintName}\`\n\n` + + `Renames constraint on \`${schema}.${tableName}\`.` + ) + .addMarkdown(`##### ✏️ Rename Constraint`) + .addSql( + `-- Rename constraint +ALTER TABLE "${schema}"."${tableName}" +RENAME CONSTRAINT "${constraintName}" TO new_constraint_name;` ) - .addSql(ConstraintSQL.rename(schema, tableName, constraintName)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'generate alter constraint script'); @@ -173,10 +149,10 @@ export async function validateConstraint(treeItem: DatabaseTreeItem): PromisePRIMARY KEY', description: 'Uniquely identifies each row' }, - { operation: 'FOREIGN KEY', description: 'Ensures referential integrity' }, - { operation: 'UNIQUE', description: 'Ensures all values in a column are different' }, - { operation: 'CHECK', description: 'Ensures that all values in a column satisfy a specific condition' } - ]) + `### ➕ Add Constraint: \`${schema}.${tableName}\`\n\n` + + `Templates for adding primary key, foreign key, unique, and check constraints.` ) - .addSql(`-- Add Primary Key Constraint -ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT "${tableName}_pkey" -PRIMARY KEY (column_name); - --- Add Foreign Key Constraint -ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT "${tableName}_fkey" -FOREIGN KEY (column_name) -REFERENCES other_schema.other_table(other_column) -ON DELETE CASCADE -ON UPDATE CASCADE; - --- Add Unique Constraint -ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT "${tableName}_unique" -UNIQUE (column_name); - --- Add Check Constraint -ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT "${tableName}_check" -CHECK (column_name > 0);`) + .addMarkdown(`##### 🔑 Add Primary Key`) + .addSql(ConstraintSQL.addPrimaryKey(schema, tableName)) + .addMarkdown(`##### 🔗 Add Foreign Key`) + .addSql(ConstraintSQL.addForeignKey(schema, tableName)) + .addMarkdown(`##### ⭐ Add Unique Constraint`) + .addSql(ConstraintSQL.addUnique(schema, tableName)) + .addMarkdown(`##### ✓ Add Check Constraint`) + .addSql(ConstraintSQL.addCheck(schema, tableName)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'generate add constraint script'); @@ -253,10 +208,10 @@ export async function viewConstraintDependencies(treeItem: DatabaseTreeItem): Pr await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`🕸️ Constraint Dependencies: \`${constraintName}\``) + - MarkdownUtils.infoBox(`Table: \`${schema}.${tableName}\``) + - MarkdownUtils.infoBox('Shows objects that depend on this constraint.') + `### 🕸️ Constraint Dependencies: \`${constraintName}\`\n\n` + + `Shows objects that depend on this constraint in \`${schema}.${tableName}\`.` ) + .addMarkdown(`##### 🕸️ Find Dependencies`) .addSql(`-- Find all dependencies for this constraint SELECT d.deptype as dependency_type, @@ -286,42 +241,35 @@ ORDER BY dependent_schema, dependent_object;`) } } -export async function cmdConstraintOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext) { +/** + * Constraint Operations notebook — read → write → destructive + */ +export async function cmdConstraintOperations(item: DatabaseTreeItem, _context?: vscode.ExtensionContext) { let dbConn; try { dbConn = await getDatabaseConnection(item); const { metadata } = dbConn; + const schema = item.schema!; + const tableName = item.tableName!; + const constraintName = item.label; await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`🛡️ Constraint Operations: \`${item.label}\``) + - MarkdownUtils.infoBox('This notebook provides a dashboard for managing your constraint. Each cell is a ready-to-execute template.') + - `\n\n#### 🎯 Available Operations\n\n` + - MarkdownUtils.operationsTable([ - { operation: '🔍 View Definition', description: 'Display constraint definition', riskLevel: '✅ Safe' }, - { operation: '✅ Validate', description: 'Check existing data against constraint', riskLevel: '✅ Safe' }, - { operation: '✏️ Rename', description: 'Change constraint name', riskLevel: '⚠️ Low Risk' }, - { operation: '❌ Drop', description: 'Remove constraint permanently', riskLevel: '🔴 Destructive' } - ]) + `\n` + - MarkdownUtils.successBox('Use `Ctrl+Enter` to execute individual cells.') + - `\n---` + `### 🛡️ Constraint Operations: \`${constraintName}\`\n\n` + + `Manage constraint on \`${schema}.${tableName}\`: validate, add variants, and drop.` ) - .addMarkdown(`##### 🔍 View Definition`) - .addSql(ConstraintSQL.definition(item.schema!, item.tableName!, item.label)) - .addMarkdown(`#### ✅ Validate Constraint\n\n` + - MarkdownUtils.infoBox('Validating a constraint ensures all existing rows satisfy the condition. This is useful for constraints added as NOT VALID.')) - .addSql(`-- Validate constraint -ALTER TABLE ${item.schema}.${item.tableName} -VALIDATE CONSTRAINT ${item.label};`) - .addMarkdown(`#### ✏️ Rename Constraint`) - .addSql(`-- Rename constraint -ALTER TABLE ${item.schema}.${item.tableName} -RENAME CONSTRAINT ${item.label} TO new_constraint_name;`) - .addMarkdown(`#### ❌ Drop Constraint\n\n` + - MarkdownUtils.dangerBox('This will remove the constraint. Data integrity checks enforced by this constraint will no longer apply.', 'Caution')) - .addSql(`-- Drop constraint -ALTER TABLE ${item.schema}.${item.tableName} -DROP CONSTRAINT ${item.label};`) + .addMarkdown(`##### ✅ Validate Constraint`) + .addSql(ConstraintSQL.validate(schema, tableName, constraintName)) + .addMarkdown(`##### 🔑 Add Primary Key`) + .addSql(ConstraintSQL.addPrimaryKey(schema, tableName)) + .addMarkdown(`##### 🔗 Add Foreign Key`) + .addSql(ConstraintSQL.addForeignKey(schema, tableName)) + .addMarkdown(`##### ⭐ Add Unique Constraint`) + .addSql(ConstraintSQL.addUnique(schema, tableName)) + .addMarkdown(`##### ✓ Add Check Constraint`) + .addSql(ConstraintSQL.addCheck(schema, tableName)) + .addMarkdown(`##### ❌ Drop Constraint — ⚠️ warning: permanently removes the constraint and its data integrity enforcement.`) + .addSql(ConstraintSQL.drop(schema, tableName, constraintName)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create constraint operations notebook'); @@ -331,7 +279,7 @@ DROP CONSTRAINT ${item.label};`) } /** - * Add new constraint to table - generates a comprehensive notebook with guidelines and SQL templates + * Add new constraint to table */ export async function cmdAddConstraint(item: DatabaseTreeItem): Promise { let dbConn; @@ -343,36 +291,17 @@ export async function cmdAddConstraint(item: DatabaseTreeItem): Promise { await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`➕ Add New Constraint to \`${schema}.${tableName}\``) + - MarkdownUtils.infoBox('This notebook provides templates for adding constraints. Constraints enforce data integrity rules.') + - `\n\n#### 📋 Constraint Types Overview\n\n` + - MarkdownUtils.operationsTable([ - { operation: '🔑 PRIMARY KEY', description: 'Uniquely identifies each row. Only one per table. Cannot be NULL.' }, - { operation: '🔗 FOREIGN KEY', description: 'References primary key in another table. Enforces referential integrity.' }, - { operation: '⭐ UNIQUE', description: 'Ensures all values in column(s) are distinct. Multiple allowed per table.' }, - { operation: '✓ CHECK', description: 'Validates data against a boolean expression. Flexible validation rules.' }, - { operation: '⊗ EXCLUSION', description: 'Prevents overlapping values using operators (useful for ranges, schedules).' }, - { operation: '⊕ NOT NULL', description: 'Prevents NULL values in a column.' } - ]) + - `\n\n#### ⚡ Important Considerations\n\n` + - MarkdownUtils.warningBox('Adding constraints to large tables may take time and lock the table. Consider using NOT VALID with later VALIDATE.') + - `\n\n---` + `### ➕ Add Constraint: \`${schema}.${tableName}\`\n\n` + + `Templates for adding constraints to enforce data integrity.` ) - .addMarkdown(`##### 🔑 Primary Key Constraint`) - .addSql(ConstraintSQL.add.primaryKey(schema, tableName)) - .addMarkdown(`##### 🔗 Foreign Key Constraint`) - .addSql(ConstraintSQL.add.foreignKey(schema, tableName)) - .addMarkdown(`##### ⭐ Unique Constraint`) - .addSql(ConstraintSQL.add.unique(schema, tableName)) - .addMarkdown(`##### ✓ Check Constraint`) - .addSql(ConstraintSQL.add.check(schema, tableName)) - .addMarkdown(`##### ⊗ Exclusion Constraint (for non-overlapping ranges)`) - .addSql(ConstraintSQL.add.exclusion(schema, tableName)) - .addMarkdown(`##### ⊕ NOT NULL Constraint`) - .addSql(ConstraintSQL.add.notNull(schema, tableName)) - .addMarkdown(`##### ⚡ Add Constraint Without Locking (Large Tables)`) - .addSql(ConstraintSQL.add.notValid(schema, tableName)) - .addMarkdown(MarkdownUtils.successBox('After adding constraints, test with sample data to ensure they work as expected.')) + .addMarkdown(`##### 🔑 Add Primary Key`) + .addSql(ConstraintSQL.addPrimaryKey(schema, tableName)) + .addMarkdown(`##### 🔗 Add Foreign Key`) + .addSql(ConstraintSQL.addForeignKey(schema, tableName)) + .addMarkdown(`##### ⭐ Add Unique Constraint`) + .addSql(ConstraintSQL.addUnique(schema, tableName)) + .addMarkdown(`##### ✓ Add Check Constraint`) + .addSql(ConstraintSQL.addCheck(schema, tableName)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'add constraint'); diff --git a/src/commands/database.ts b/src/commands/database.ts index f8db531..d285974 100644 --- a/src/commands/database.ts +++ b/src/commands/database.ts @@ -770,7 +770,7 @@ export async function cmdQueryTool(item: DatabaseTreeItem, context: vscode.Exten ) .addSql(`-- Write your SQL query here SELECT 1;`) - .show(); + .showNew(); // always open a fresh notebook } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'open query tool'); } finally { diff --git a/src/commands/foreignTables.ts b/src/commands/foreignTables.ts index 9bc3bc8..0641a4b 100644 --- a/src/commands/foreignTables.ts +++ b/src/commands/foreignTables.ts @@ -158,4 +158,127 @@ export async function cmdCreateForeignTable(item: DatabaseTreeItem, context: vsc } finally { if (dbConn && dbConn.release) dbConn.release(); } +} + +/** + * cmdViewForeignTableData - Single-operation notebook: SELECT from foreign table + */ +export async function cmdViewForeignTableData(item: DatabaseTreeItem, context: vscode.ExtensionContext) { + let dbConn; + try { + dbConn = await getDatabaseConnection(item); + const { metadata } = dbConn; + + await new NotebookBuilder(metadata) + .addMarkdown( + MarkdownUtils.header(`📖 Query Foreign Table Data: \`${item.schema}.${item.label}\``) + + MarkdownUtils.infoBox('Runs a safe preview query so you can validate mapping and connectivity to the remote source.') + ) + .addMarkdown('##### 📖 SELECT') + .addSql(ForeignTableSQL.queryData(item.schema!, item.label)) + .show(); + } catch (err: any) { + await ErrorHandlers.handleCommandError(err, 'query foreign table data'); + } finally { + if (dbConn && dbConn.release) dbConn.release(); + } +} + +/** + * cmdShowForeignTableProperties - Properties notebook for a foreign table + */ +export async function cmdShowForeignTableProperties(item: DatabaseTreeItem, context: vscode.ExtensionContext) { + let dbConn; + try { + dbConn = await getDatabaseConnection(item); + const { client, metadata } = dbConn; + + const [infoResult, definitionResult] = await Promise.all([ + client.query(QueryBuilder.foreignTableInfo(item.schema!, item.label)), + client.query(QueryBuilder.foreignTableDefinition(item.schema!, item.label)) + ]); + + if (infoResult.rows.length === 0 || definitionResult.rows.length === 0) { + throw new Error('Foreign table not found'); + } + + const first = infoResult.rows[0]; + const serverName = first.server_name; + const options = first.options || []; + + const columnRows = infoResult.rows.map((row: any, index: number) => { + const defaultSql = row.column_default ? `${row.column_default}` : '—'; + return ` + ${index + 1} + ${row.column_name} + ${row.data_type} + ${row.is_nullable === 'YES' ? 'YES' : 'NO'} + ${defaultSql} + `; + }).join('\n'); + + const tableInfo = definitionResult.rows[0]; + const createStatement = `CREATE FOREIGN TABLE ${item.schema}.${item.label} (\n${tableInfo.columns.map((col: string) => ' ' + col).join(',\n')}\n) SERVER ${tableInfo.server_name}${tableInfo.options ? '\nOPTIONS (\n ' + tableInfo.options.map((opt: string) => opt).join(',\n ') + '\n)' : ''};`; + + await new NotebookBuilder(metadata) + .addMarkdown( + MarkdownUtils.header(`🔗 Foreign Table Properties: \`${item.schema}.${item.label}\``) + + MarkdownUtils.infoBox(`Server: ${serverName}`) + + `\n\n#### 📊 General Information\n\n` + + MarkdownUtils.propertiesTable({ + 'Schema': item.schema || 'public', + 'Name': item.label, + 'Server': serverName, + 'Column Count': `${infoResult.rows.length}`, + 'Options': options.length ? `${options.join(', ')}` : '—' + }) + + `\n\n#### 📋 Columns (${infoResult.rows.length})\n\n` + + ` + + + + + + + +${columnRows} +
    #NameData TypeNullableDefault
    ` + ) + .addMarkdown('##### 📝 CREATE FOREIGN TABLE Script') + .addSql(createStatement) + .addMarkdown('##### 📖 Query Data') + .addSql(ForeignTableSQL.queryData(item.schema!, item.label)) + .addMarkdown('##### ❌ DROP Foreign Table Script — ⚠️ Warning: permanently deletes the foreign table') + .addSql(ForeignTableSQL.drop(item.schema!, item.label)) + .show(); + + } catch (err: any) { + await ErrorHandlers.handleCommandError(err, 'show foreign table properties'); + } finally { + if (dbConn && dbConn.release) dbConn.release(); + } +} + +/** + * cmdDropForeignTable - Single-operation notebook: DROP foreign table + */ +export async function cmdDropForeignTable(item: DatabaseTreeItem, context: vscode.ExtensionContext) { + let dbConn; + try { + dbConn = await getDatabaseConnection(item); + const { metadata } = dbConn; + + await new NotebookBuilder(metadata) + .addMarkdown( + MarkdownUtils.header(`❌ Drop Foreign Table: \`${item.schema}.${item.label}\``) + + MarkdownUtils.warningBox('This permanently deletes the foreign table mapping. Remote source data is not deleted, but local access via this object is removed.') + ) + .addMarkdown('##### ❌ DROP') + .addSql(ForeignTableSQL.drop(item.schema!, item.label)) + .show(); + } catch (err: any) { + await ErrorHandlers.handleCommandError(err, 'drop foreign table'); + } finally { + if (dbConn && dbConn.release) dbConn.release(); + } } \ No newline at end of file diff --git a/src/commands/formatSql.ts b/src/commands/formatSql.ts new file mode 100644 index 0000000..37e9f1a --- /dev/null +++ b/src/commands/formatSql.ts @@ -0,0 +1,77 @@ +/** + * formatSql.ts + * VS Code command implementation for formatting SQL in notebooks and editors. + */ + +import * as vscode from 'vscode'; +import { SqlFormatterService } from '../services/SqlFormatterService'; + +export async function formatSqlCommand(): Promise { + const editor = vscode.window.activeTextEditor; + if (!editor) { + vscode.window.showInformationMessage('No active editor to format'); + return; + } + + const doc = editor.document; + const languageId = doc.languageId; + + // Only format SQL and PostgreSQL files + const supportedLanguages = ['sql', 'pgsql', 'postgresql', 'postgres']; + if (!supportedLanguages.includes(languageId)) { + vscode.window.showInformationMessage( + `Format SQL is not available for ${languageId} files. Supported: ${supportedLanguages.join(', ')}` + ); + return; + } + + const service = SqlFormatterService.getInstance(); + + try { + // Check if there's a selection + const selection = editor.selection; + const hasSelection = !selection.isEmpty; + + if (hasSelection) { + // Format only selected text + const selectedText = doc.getText(selection); + const formatted = await service.format(selectedText); + await editor.edit(editBuilder => { + editBuilder.replace(selection, formatted); + }); + vscode.window.setStatusBarMessage('$(check) SQL formatted (selection)', 3000); + } else { + // Format entire document + const edits = await service.formatDocument(doc); + if (edits.length === 0) { + vscode.window.setStatusBarMessage('$(check) SQL already formatted', 2000); + return; + } + const wsEdit = new vscode.WorkspaceEdit(); + wsEdit.set(doc.uri, edits); + await vscode.workspace.applyEdit(wsEdit); + vscode.window.setStatusBarMessage('$(check) SQL formatted', 3000); + } + } catch (err) { + vscode.window.showErrorMessage(`Failed to format SQL: ${(err as Error).message}`); + } +} + +/** + * Format-on-save handler — registered in extension.ts + */ +export function createFormatOnSaveListener(): vscode.Disposable { + return vscode.workspace.onWillSaveTextDocument(async (event) => { + const doc = event.document; + const supportedLanguages = ['sql', 'pgsql', 'postgresql', 'postgres']; + + if (!supportedLanguages.includes(doc.languageId)) { return; } + + const config = vscode.workspace.getConfiguration('postgresExplorer.formatter'); + if (!config.get('formatOnSave', false)) { return; } + + const service = SqlFormatterService.getInstance(); + const editsPromise = service.formatDocument(doc); + event.waitUntil(editsPromise); + }); +} diff --git a/src/commands/functions.ts b/src/commands/functions.ts index 45187df..605d7ed 100644 --- a/src/commands/functions.ts +++ b/src/commands/functions.ts @@ -1,11 +1,11 @@ import * as vscode from 'vscode'; import { DatabaseTreeItem, DatabaseTreeProvider } from '../providers/DatabaseTreeProvider'; +import { CommandBase } from '../common/commands/CommandBase'; import { MarkdownUtils, FormatHelpers, ErrorHandlers, - SQL_TEMPLATES, ObjectUtils, getDatabaseConnection, NotebookBuilder, @@ -16,13 +16,8 @@ import { FunctionSQL } from './sql'; /** - * This function creates a notebook with common operations for a PostgreSQL function. - * It retrieves the function's definition, arguments, and description from the database, - * and generates a notebook with cells for viewing the function definition, calling the function, - * and dropping the function. - * - * @param {DatabaseTreeItem} item - The selected function item from the tree view. - * @param {vscode.ExtensionContext} context - The extension context. + * cmdFunctionOperations - Operations_Notebook for a function. + * Cell order: read (metadata, definition) → write/modify (call, create or replace) → destructive (drop) */ export async function cmdFunctionOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; @@ -30,7 +25,6 @@ export async function cmdFunctionOperations(item: DatabaseTreeItem, context: vsc dbConn = await getDatabaseConnection(item); const { client, metadata } = dbConn; - const functionResult = await client.query(QueryBuilder.functionInfo(item.schema!, item.label)); if (functionResult.rows.length === 0) { throw new Error('Function not found'); @@ -39,33 +33,17 @@ export async function cmdFunctionOperations(item: DatabaseTreeItem, context: vsc const functionInfo = functionResult.rows[0]; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`⚡ Function Operations: \`${item.schema}.${item.label}\``) + - (functionInfo.description ? MarkdownUtils.infoBox(`Description: ${functionInfo.description}`) : '') + - MarkdownUtils.infoBox('This notebook contains common operations for the PostgreSQL function. Run the cells below to execute the operations.') + - `\n\n#### 🎯 Available Operations\n\n` + - MarkdownUtils.operationsTable([ - { operation: '📝 View Definition', description: 'Show the current function code' }, - { operation: '📞 Call Function', description: 'Template for executing the function' }, - { operation: '❌ Drop', description: 'Delete the function (Warning: Irreversible)' } - ]) - ) - .addMarkdown('##### 📝 Function Definition') + .addMarkdown(`### ⚡ Function Operations: \`${item.schema}.${item.label}\`\n\nCommon operations for this PostgreSQL function.`) + .addMarkdown('##### 📊 Metadata') + .addSql(FunctionSQL.metadata(item.schema!, item.label)) + .addMarkdown('##### 📝 Definition') .addSql(`-- Current function definition\n${functionInfo.definition} `) - .addMarkdown('##### 📞 Call Function') - .addSql(`-- Call function (returns single value) -SELECT ${item.schema}.${item.label}(${functionInfo.arguments ? - '\n -- Replace with actual values:\n ' + functionInfo.arguments.split(',').join(',\n ') - : '' - }); - --- Call function (returns table/set - use for multi-row results) -SELECT * FROM ${item.schema}.${item.label}(${functionInfo.arguments ? - '\n -- Replace with actual values:\n ' + functionInfo.arguments.split(',').join(',\n ') - : '' - });`) - .addMarkdown('##### ❌ Drop Function') - .addSql(SQL_TEMPLATES.DROP.FUNCTION(item.schema!, item.label, functionInfo.arguments || '')) + .addMarkdown('##### 📞 Call') + .addSql(FunctionSQL.call(item.schema!, item.label, functionInfo.arguments || '')) + .addMarkdown('##### ✏️ Create or Replace') + .addSql(FunctionSQL.createOrReplace(item.schema!)) + .addMarkdown('##### ❌ DROP — ⚠️ Warning: permanently deletes the function') + .addSql(FunctionSQL.drop(item.schema!, item.label, functionInfo.arguments || '')) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create function operations notebook'); @@ -75,12 +53,8 @@ SELECT * FROM ${item.schema}.${item.label}(${functionInfo.arguments ? } /** - * This function creates a notebook for replacing a PostgreSQL function. - * It retrieves the function's definition from the database and generates a notebook - * with a cell for editing the function definition. - * - * @param {DatabaseTreeItem} item - The selected function item from the tree view. - * @param {vscode.ExtensionContext} context - The extension context. + * cmdEditFunction - Fetches the actual function definition from the DB and opens it for editing. + * Kept as-is: it queries the live definition, not a template. */ export async function cmdEditFunction(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; @@ -88,7 +62,6 @@ export async function cmdEditFunction(item: DatabaseTreeItem, context: vscode.Ex dbConn = await getDatabaseConnection(item); const { client, metadata } = dbConn; - const functionResult = await client.query(QueryBuilder.functionDefinition(item.schema!, item.label)); if (functionResult.rows.length === 0) { throw new Error('Function not found'); @@ -97,10 +70,7 @@ export async function cmdEditFunction(item: DatabaseTreeItem, context: vscode.Ex const functionInfo = functionResult.rows[0]; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`✏️ Edit Function: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Modify the function definition below and execute the cell to update the function.') - ) + .addMarkdown(`### ✏️ Edit Function: \`${item.schema}.${item.label}\`\n\nModify the function definition below and execute to update.`) .addMarkdown('##### 📝 Function Definition') .addSql(functionInfo.definition) .show(); @@ -112,20 +82,10 @@ export async function cmdEditFunction(item: DatabaseTreeItem, context: vscode.Ex } /** - * This function creates a notebook for calling a PostgreSQL function. - * It retrieves the function's arguments and result type from the database - * and generates a notebook with a cell for calling the function. - * - * @param {DatabaseTreeItem} item - The selected function item from the tree view. - * @param {vscode.ExtensionContext} context - The extension context. + * cmdCallFunction - Single-operation notebook: CALL function. */ export async function cmdCallFunction(item: DatabaseTreeItem, context: vscode.ExtensionContext) { - let dbConn; - try { - dbConn = await getDatabaseConnection(item); - const { client, metadata } = dbConn; - - + await CommandBase.run(context, item, 'create function call notebook', async (conn: any, client: any, metadata: any) => { const functionResult = await client.query(QueryBuilder.functionSignature(item.schema!, item.label)); if (functionResult.rows.length === 0) { throw new Error('Function not found'); @@ -134,50 +94,17 @@ export async function cmdCallFunction(item: DatabaseTreeItem, context: vscode.Ex const functionInfo = functionResult.rows[0]; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📞 Call Function: \`${item.schema}.${item.label}\``) + - (functionInfo.description ? MarkdownUtils.infoBox(`Description: ${functionInfo.description}`) : '') + - `\n\n` + - MarkdownUtils.propertiesTable({ - 'Arguments': functionInfo.arguments ? `${functionInfo.arguments}` : 'None', - 'Returns': `${functionInfo.result_type}` - }) + - MarkdownUtils.infoBox('Edit the argument values below and execute the cell to call the function.') - ) - .addMarkdown('##### 📞 Execution') - .addSql(`-- Call function (returns single value) -SELECT ${item.schema}.${item.label}(${functionInfo.arguments ? - '\n -- Replace with actual values:\n ' + functionInfo.arguments.split(',').join(',\n ') - : '' - }); - --- Call function (returns table/set - use for multi-row results) -SELECT * FROM ${item.schema}.${item.label}(${functionInfo.arguments ? - '\n -- Replace with actual values:\n ' + functionInfo.arguments.split(',').join(',\n ') - : '' - });`) + .addMarkdown(`### 📞 Call Function: \`${item.schema}.${item.label}\`\n\nExecute the function with the arguments below.`) + .addSql(FunctionSQL.call(item.schema!, item.label, functionInfo.arguments || '')) .show(); - } catch (err: any) { - await ErrorHandlers.handleCommandError(err, 'create function call notebook'); - } finally { - if (dbConn && dbConn.release) dbConn.release(); - } + }); } /** - * This function creates a notebook for dropping a PostgreSQL function. - * It generates a notebook with a cell for dropping the function. - * - * @param {DatabaseTreeItem} item - The selected function item from the tree view. - * @param {vscode.ExtensionContext} context - The extension context. + * cmdDropFunction - Single-operation notebook: DROP function. */ export async function cmdDropFunction(item: DatabaseTreeItem, context: vscode.ExtensionContext) { - let dbConn; - try { - dbConn = await getDatabaseConnection(item); - const { client, metadata } = dbConn; - - + await CommandBase.run(context, item, 'create drop function notebook', async (conn: any, client: any, metadata: any) => { const functionResult = await client.query(QueryBuilder.functionArguments(item.schema!, item.label)); if (functionResult.rows.length === 0) { throw new Error('Function not found'); @@ -186,26 +113,14 @@ export async function cmdDropFunction(item: DatabaseTreeItem, context: vscode.Ex const functionInfo = functionResult.rows[0]; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`❌ Drop Function: \`${item.schema}.${item.label}\``) + - MarkdownUtils.dangerBox('This action will permanently delete the function. This operation cannot be undone.') - ) - .addMarkdown('##### ❌ Drop Command') - .addSql(SQL_TEMPLATES.DROP.FUNCTION(item.schema!, item.label, functionInfo.arguments || '')) + .addMarkdown(`### ❌ Drop Function: \`${item.schema}.${item.label}\`\n\n⚠️ **Warning:** This permanently deletes the function and cannot be undone.`) + .addSql(FunctionSQL.drop(item.schema!, item.label, functionInfo.arguments || '')) .show(); - } catch (err: any) { - await ErrorHandlers.handleCommandError(err, 'create drop function notebook'); - } finally { - if (dbConn && dbConn.release) dbConn.release(); - } + }); } /** - * This function shows the properties of a PostgreSQL function in a panel. - * It retrieves the function's details from the database and displays them in a table. - * - * @param {DatabaseTreeItem} item - The selected function item from the tree view. - * @param {vscode.ExtensionContext} context - The extension context. + * cmdShowFunctionProperties - Properties panel for a function. Kept as-is. */ export async function cmdShowFunctionProperties(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; @@ -213,10 +128,8 @@ export async function cmdShowFunctionProperties(item: DatabaseTreeItem, context: dbConn = await getDatabaseConnection(item); const { client, metadata } = dbConn; - // Gather comprehensive function information const [functionInfo, dependenciesInfo] = await Promise.all([ - // Detailed function info client.query(` SELECT p.proname as function_name, @@ -247,7 +160,6 @@ export async function cmdShowFunctionProperties(item: DatabaseTreeItem, context: WHERE n.nspname = $1 AND p.proname = $2 `, [item.schema, item.label]), - // Get objects that depend on this function client.query(` SELECT DISTINCT dependent_ns.nspname as schema, @@ -336,32 +248,10 @@ ${dependencyRows} .addMarkdown('##### 📝 Function Definition') .addSql(func.definition) .addMarkdown('##### ⚡ Call Function') - .addSql(`-- Call function (returns single value) -SELECT ${item.schema}.${item.label}(${func.arguments ? func.arguments.split(',').map((arg: string, idx: number) => { - const parts = arg.trim().split(' '); - const type = parts[parts.length - 1]; - if (type.includes('int')) return `${idx + 1}`; - if (type.includes('text') || type.includes('char') || type.includes('varchar')) return `'value${idx + 1}'`; - if (type.includes('bool')) return 'true'; - if (type.includes('date')) return `'2024-01-01'`; - if (type.includes('timestamp')) return `'2024-01-01 00:00:00'`; - return `'value${idx + 1}'`; - }).join(', ') : ''}); - --- Call function (returns table/set - use for multi-row results) -SELECT * FROM ${item.schema}.${item.label}(${func.arguments ? func.arguments.split(',').map((arg: string, idx: number) => { - const parts = arg.trim().split(' '); - const type = parts[parts.length - 1]; - if (type.includes('int')) return `${idx + 1}`; - if (type.includes('text') || type.includes('char') || type.includes('varchar')) return `'value${idx + 1}'`; - if (type.includes('bool')) return 'true'; - if (type.includes('date')) return `'2024-01-01'`; - if (type.includes('timestamp')) return `'2024-01-01 00:00:00'`; - return `'value${idx + 1}'`; - }).join(', ') : ''});`) - .addMarkdown('##### 🗑️ DROP Function Script') - .addSql(`${SQL_TEMPLATES.DROP.FUNCTION(item.schema!, item.label, func.arguments || '')}\n\n-- Drop function (with dependencies)\n-- DROP FUNCTION IF EXISTS ${item.schema}.${item.label}(${func.arguments || ''}) CASCADE;\n\n-- Drop function (without dependencies - will fail if referenced)\n-- DROP FUNCTION IF EXISTS ${item.schema}.${item.label}(${func.arguments || ''}) RESTRICT;`) - .addMarkdown('##### 📊 Function Statistics') + .addSql(FunctionSQL.call(item.schema!, item.label, func.arguments || '')) + .addMarkdown('##### ❌ DROP Function Script — ⚠️ Warning: permanently deletes the function') + .addSql(FunctionSQL.drop(item.schema!, item.label, func.arguments || '')) + .addMarkdown('##### 📊 Function Metadata') .addSql(FunctionSQL.metadata(item.schema!, item.label)) .show(); } catch (err: any) { @@ -379,56 +269,15 @@ export async function cmdRefreshFunction(item: DatabaseTreeItem, context: vscode } /** - * cmdCreateFunction - Command to create a new function in the database. + * cmdCreateFunction - Single-cell notebook with CREATE OR REPLACE FUNCTION template. */ export async function cmdCreateFunction(item: DatabaseTreeItem, context: vscode.ExtensionContext) { - let dbConn; - try { - dbConn = await getDatabaseConnection(item); - const { metadata } = dbConn; + await CommandBase.run(context, item, 'create function notebook', async (conn: any, client: any, metadata: any) => { const schema = item.schema!; - const markdown = MarkdownUtils.header(`➕ Create New Function in Schema: \`${schema}\``) + - MarkdownUtils.infoBox('This notebook provides templates for creating functions. Modify the templates below and execute to create functions.') + - `\n\n#### 📋 Function Design Guidelines\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'Naming', description: 'Use snake_case for function names (e.g., calculate_total, get_user_by_id)' }, - { operation: 'Language', description: 'Choose appropriate language: SQL, PL/pgSQL, PL/Python, etc.' }, - { operation: 'Volatility', description: 'Mark as IMMUTABLE, STABLE, or VOLATILE based on behavior' }, - { operation: 'Security', description: 'Use SECURITY DEFINER carefully - runs with function owner privileges' }, - { operation: 'Performance', description: 'IMMUTABLE functions can be optimized better by query planner' } - ]) + - `\n\n#### 🏷️ Common Function Patterns\n\n` + - MarkdownUtils.propertiesTable({ - 'SQL Function': 'Simple functions written in SQL', - 'PL/pgSQL Function': 'Procedural language with variables and control flow', - 'Aggregate Function': 'Functions that operate on sets of rows', - 'Window Function': 'Functions that operate on window frames', - 'Trigger Function': 'Functions called automatically by triggers', - 'Security Function': 'Functions with SECURITY DEFINER for privilege escalation' - }) + - MarkdownUtils.successBox('Use CREATE OR REPLACE to update existing functions. Functions are schema-scoped objects.') + - `\n\n---`; - await new NotebookBuilder(metadata) - .addMarkdown(markdown) - .addMarkdown('##### 📝 Basic SQL Function (Recommended Start)') - .addSql(FunctionSQL.create.sqlFunction(schema)) - .addMarkdown('##### 🔧 PL/pgSQL Function (With Logic)') - .addSql(FunctionSQL.create.plpgsqlFunction(schema)) - .addMarkdown('##### 🔄 Function Returning Table') - .addSql(FunctionSQL.create.tableFunction(schema)) - .addMarkdown('##### 🔒 Security Definer Function') - .addSql(FunctionSQL.create.securityDefiner(schema)) - .addMarkdown('##### ⚡ Trigger Function') - .addSql(FunctionSQL.create.triggerFunction(schema)) - .addMarkdown('##### 📊 Aggregate Function') - .addSql(FunctionSQL.create.aggregateFunction(schema)) - .addMarkdown(MarkdownUtils.warningBox('After creating a function, remember to: 1) Test with sample inputs, 2) Grant appropriate EXECUTE permissions, 3) Document parameters and return values, 4) Consider performance implications of volatility settings.')) + .addMarkdown(`### ➕ Create New Function in Schema: \`${schema}\`\n\nCreate or replace a function using the template below.`) + .addSql(FunctionSQL.createOrReplace(schema)) .show(); - } catch (err: any) { - await ErrorHandlers.handleCommandError(err, 'create function notebook'); - } finally { - if (dbConn && dbConn.release) dbConn.release(); - } -} \ No newline at end of file + }); +} diff --git a/src/commands/helper.ts b/src/commands/helper.ts index 837ec86..2c2dcd4 100644 --- a/src/commands/helper.ts +++ b/src/commands/helper.ts @@ -3,6 +3,10 @@ import { DatabaseTreeItem } from '../providers/DatabaseTreeProvider'; import { createAndShowNotebook, createMetadata, getConnectionWithPassword, validateItem, validateCategoryItem, validateRoleItem } from './connection'; import { ConnectionManager } from '../services/ConnectionManager'; import { ErrorService } from '../services/ErrorService'; +import { SessionRegistry } from '../services/SessionRegistry'; + +/** Module-level ExtensionContext set once by NotebookBuilder.setContext() */ +let _extensionContext: vscode.ExtensionContext | undefined; // Re-export SQL templates from sql/helper.ts for backward compatibility export { SQL_TEMPLATES, QueryBuilder, MaintenanceTemplates } from './sql/helper'; @@ -25,15 +29,33 @@ export async function getDatabaseConnection(item: DatabaseTreeItem, validateFn: return { connection, client, - metadata, + metadata: { ...metadata, name: connection.name }, release: () => client.release() }; } /** Fluent builder for notebook cells */ export class NotebookBuilder { private cells: vscode.NotebookCellData[] = []; + private readonly connectionId: string | undefined; + private readonly databaseName: string | undefined; + /** Composite key used for registry and scratch file: "{connectionId}:{databaseName}" */ + private readonly sessionKey: string | undefined; + + constructor(private metadata: any) { + this.connectionId = metadata?.connectionId as string | undefined; + this.databaseName = (metadata?.databaseName ?? metadata?.database) as string | undefined; + if (this.connectionId && this.databaseName) { + this.sessionKey = `${this.connectionId}:${this.databaseName}`; + } + } - constructor(private metadata: any) { } + /** + * Called once during extension activation to provide the ExtensionContext. + * Satisfies Requirement 5.4. + */ + static setContext(context: vscode.ExtensionContext): void { + _extensionContext = context; + } addMarkdown(content: string): NotebookBuilder { this.cells.push(new vscode.NotebookCellData(vscode.NotebookCellKind.Markup, content, 'markdown')); @@ -45,8 +67,205 @@ export class NotebookBuilder { return this; } + /** Human-readable tab title: "{connectionName}-{databaseName}" or just "{databaseName}" */ + private _scratchTitle(): string { + const connName = (this.metadata?.name ?? this.metadata?.connectionName) as string | undefined; + return connName ? `${connName}-${this.databaseName}` : this.databaseName!; + } + + /** + * Always opens a brand-new named notebook file, bypassing the persistent session. + * Creates `{connectionName}-{databaseName}-{n}.pgsql` in globalStorageUri. + * Use this for explicit "New Notebook" / "Query Tool" actions. + */ + async showNew(): Promise { + if (_extensionContext && this.databaseName) { + const { getNewNotebookUri } = await import('../services/SessionRegistry'); + await vscode.workspace.fs.createDirectory(_extensionContext.globalStorageUri); + const uri = await getNewNotebookUri( + _extensionContext.globalStorageUri, + this.databaseName, + this.metadata?.name as string | undefined + ); + // Ensure nested folder exists before writing + await vscode.workspace.fs.createDirectory(vscode.Uri.joinPath(uri, '..')); + const fileMetadata = { + connectionId: this.metadata?.connectionId, + host: this.metadata?.host, + port: this.metadata?.port, + username: this.metadata?.username, + database: this.databaseName, + databaseName: this.databaseName, + title: this._scratchTitle(), + }; + // Serialize initial cells into the file so content is immediately visible + const cells = this.cells.map(c => ({ + value: c.value, + kind: c.kind === vscode.NotebookCellKind.Markup ? 'markdown' : 'sql', + language: c.kind === vscode.NotebookCellKind.Markup ? 'markdown' : 'sql', + })); + await vscode.workspace.fs.writeFile(uri, Buffer.from(JSON.stringify({ cells, metadata: fileMetadata }))); + const notebook = await vscode.workspace.openNotebookDocument(uri); + const editor = await vscode.window.showNotebookDocument(notebook, { preserveFocus: false }); + if (notebook.cellCount > 0) { + editor.revealRange(new vscode.NotebookRange(0, 1), vscode.NotebookEditorRevealType.AtTop); + } + } else { + // Fallback when context not set (e.g. tests / legacy path) + await createAndShowNotebook(this.cells, this.metadata); + } + } + async show(): Promise { - await createAndShowNotebook(this.cells, this.metadata); + // Persistent session path: requires sessionKey (connectionId + databaseName) and extension context + if (this.sessionKey && _extensionContext) { + await this._showPersistent(); + } else { + // Legacy fallback: open a new untitled notebook (Req 5.3) + await createAndShowNotebook(this.cells, this.metadata); + } + } + + private async _showPersistent(): Promise { + const sessionKey = this.sessionKey!; + const context = _extensionContext!; + const { getScratchUri, getLatestNumberedUri, isNotebookForSession } = await import('../services/SessionRegistry'); + const scratchUri = getScratchUri( + context.globalStorageUri, + this.connectionId!, + this.databaseName!, + this.metadata?.name as string | undefined + ); + + const connName = this.metadata?.name as string | undefined; + + // ── Priority 1: active notebook editor, if it belongs to this connection+db ── + let doc: vscode.NotebookDocument | undefined; + const activeEditor = vscode.window.activeNotebookEditor; + if (activeEditor && !activeEditor.notebook.isClosed) { + if (isNotebookForSession(activeEditor.notebook.uri, this.databaseName!, connName, this.connectionId)) { + doc = activeEditor.notebook; + // Keep registry in sync + SessionRegistry.set(sessionKey, doc); + } + } + + // ── Priority 2: registry entry (last known open doc for this session) ── + if (!doc) { + const registered = SessionRegistry.get(sessionKey); + if (registered && !registered.isClosed) { + doc = registered; + } else if (registered?.isClosed) { + SessionRegistry.delete(sessionKey); + } + } + + // ── Priority 3: scan open notebook documents for any matching file ── + if (!doc) { + const existing = vscode.workspace.notebookDocuments.find( + nd => !nd.isClosed && isNotebookForSession(nd.uri, this.databaseName!, connName, this.connectionId) + ); + if (existing) { + SessionRegistry.set(sessionKey, existing); + doc = existing; + } + } + + // ── Priority 4: latest numbered file on disk (e.g. -2.pgsql before -1.pgsql) ── + if (!doc) { + const latestUri = await getLatestNumberedUri(context.globalStorageUri, this.databaseName!, connName); + if (latestUri) { + const notebook = await vscode.workspace.openNotebookDocument(latestUri); + SessionRegistry.set(sessionKey, notebook); + doc = notebook; + } + } + + // ── Priority 5: base scratch file ── + if (!doc) { + let fileExists = false; + try { await vscode.workspace.fs.stat(scratchUri); fileExists = true; } catch { /* not found */ } + if (fileExists) { + const notebook = await vscode.workspace.openNotebookDocument(scratchUri); + SessionRegistry.set(sessionKey, notebook); + doc = notebook; + } + } + + if (doc) { + // Cell count guard: warn when the notebook is getting large + const CELL_LIMIT = 150; + if (doc.cellCount >= CELL_LIMIT) { + const choice = await vscode.window.showWarningMessage( + `The scratch notebook for ${this.databaseName} has ${doc.cellCount} cells and may be getting large.`, + { modal: false }, + 'Continue anyway', + 'Open new notebook instead' + ); + if (choice === 'Open new notebook instead') { + await this.showNew(); + return; + } + if (!choice) { return; } // dismissed + } + + // Capture insertion point before appending so we can scroll to the first new cell + const firstNewCellIndex = doc.cellCount; + + // Add a visual separator when appending to an existing notebook with content + const cellsToInsert = [...this.cells]; + if (firstNewCellIndex > 0) { + const timestamp = new Date().toLocaleString(); + const separator = new vscode.NotebookCellData( + vscode.NotebookCellKind.Markup, + `---\n\n*Section added: ${timestamp}*`, + 'markdown' + ); + cellsToInsert.unshift(separator); + } + + // Append cells to the already-open document (Req 2.1, 2.2, 4.2) + const edit = new vscode.WorkspaceEdit(); + edit.set(doc.uri, [ + vscode.NotebookEdit.insertCells(firstNewCellIndex, cellsToInsert) + ]); + await vscode.workspace.applyEdit(edit); + + // Reveal the first of the newly appended cells so the user lands at the top of the new content + const notebookEditor = await vscode.window.showNotebookDocument(doc, { preserveFocus: false }); + if (firstNewCellIndex < doc.cellCount) { + notebookEditor.revealRange( + new vscode.NotebookRange(firstNewCellIndex, firstNewCellIndex + 1), + vscode.NotebookEditorRevealType.AtTop + ); + } + } else { + // No existing file found — create the base scratch file for this connection+db + // Ensure nested folder structure exists: {globalStorageUri}/{connectionName}/{databaseName}/ + const scratchDir = vscode.Uri.joinPath(scratchUri, '..'); + await vscode.workspace.fs.createDirectory(scratchDir); + const fileMetadata = { + connectionId: this.metadata?.connectionId, + host: this.metadata?.host, + port: this.metadata?.port, + username: this.metadata?.username, + database: this.databaseName, + databaseName: this.databaseName, + title: this._scratchTitle(), + }; + await vscode.workspace.fs.writeFile(scratchUri, Buffer.from(JSON.stringify({ cells: [], metadata: fileMetadata }))); + const notebook = await vscode.workspace.openNotebookDocument(scratchUri); + SessionRegistry.set(sessionKey, notebook); + + const edit = new vscode.WorkspaceEdit(); + edit.set(notebook.uri, [vscode.NotebookEdit.insertCells(0, this.cells)]); + await vscode.workspace.applyEdit(edit); + + const notebookEditor = await vscode.window.showNotebookDocument(notebook, { preserveFocus: false }); + if (notebook.cellCount > 0) { + notebookEditor.revealRange(new vscode.NotebookRange(0, 1), vscode.NotebookEditorRevealType.AtTop); + } + } } } /** Markdown formatting utilities */ diff --git a/src/commands/indexes.ts b/src/commands/indexes.ts index d86775e..43d3d99 100644 --- a/src/commands/indexes.ts +++ b/src/commands/indexes.ts @@ -5,7 +5,6 @@ import { MarkdownUtils, FormatHelpers, ErrorHandlers, - SQL_TEMPLATES, ObjectUtils, getDatabaseConnection, NotebookBuilder, @@ -117,14 +116,12 @@ export async function showIndexProperties(treeItem: DatabaseTreeItem): PromiseProperties', description: 'View index definition and stats', riskLevel: '✅ Safe' }, - { operation: '📊 Analyze', description: 'Check usage statistics', riskLevel: '✅ Safe' }, - { operation: '🔄 Reindex', description: 'Rebuild the index', riskLevel: '⚠️ Locks Table' }, - { operation: '✏️ Alter', description: 'Rename or change settings', riskLevel: '⚠️ Modifies Schema' }, - { operation: '❌ Drop', description: 'Remove the index', riskLevel: '🔴 Destructive' } - ]) + `\n---` - ) - .addMarkdown('##### 🔍 Index Definition') - .addSql(IndexSQL.definition(schema, indexName)) - .addMarkdown('##### 📊 Analyze Usage') - .addSql(IndexSQL.statistics(schema, indexName)) + .addMarkdown(`### 🔧 Index Operations: \`${schema}.${indexName}\`\n\nCommon operations for managing this index.`) + .addMarkdown('##### 📊 Usage Statistics') + .addSql(IndexSQL.usageStats(schema, indexName)) .addMarkdown('##### 🔄 Reindex') .addSql(IndexSQL.reindex(schema, indexName)) - .addMarkdown('##### ❌ Drop Index') + .addMarkdown('##### ✏️ Alter Index') + .addSql(IndexSQL.alter(schema, indexName)) + .addMarkdown('##### 🗑️ Drop Index\n\n⚠️ **Warning:** Dropping this index is permanent and may affect query performance.') .addSql(IndexSQL.drop(schema, indexName)) .show(); } catch (err: any) { @@ -372,7 +333,7 @@ export async function cmdIndexOperations(item: DatabaseTreeItem, context: vscode } /** - * Add new index to table - generates a comprehensive notebook with guidelines and SQL templates + * Add new index to table - generates a notebook with a CREATE INDEX template */ export async function cmdAddIndex(item: DatabaseTreeItem): Promise { let dbConn; @@ -383,107 +344,23 @@ export async function cmdAddIndex(item: DatabaseTreeItem): Promise { const tableName = item.tableName!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`➕ Add New Index to \`${schema}.${tableName}\``) + - MarkdownUtils.infoBox('Indexes improve query performance by providing fast lookup paths. Choose the right index type for your use case.') + - `\n\n#### 📋 Index Types Overview\n\n` + - MarkdownUtils.operationsTable([ - { operation: '🔍 B-tree', description: 'Default. Best for equality and range queries (=, <, >, BETWEEN).' }, - { operation: '📚 Hash', description: 'Equality comparisons only (=). Faster for exact matches.' }, - { operation: '🔎 GiST', description: 'Generalized. Good for geometric, full-text, and range types.' }, - { operation: '📖 GIN', description: 'Inverted index. Best for arrays, JSONB, and full-text search.' }, - { operation: '🔤 BRIN', description: 'Block Range. Very efficient for large, naturally ordered tables.' } - ]) + - `\n\n#### ⚡ Best Practices\n\n` + - MarkdownUtils.propertiesTable({ - 'WHERE clauses': 'Index columns frequently used in WHERE conditions', - 'JOIN columns': 'Index foreign keys and join columns', - 'ORDER BY': 'Index columns used for sorting', - 'Partial Index': 'Use WHERE clause to index subset of rows', - 'Expression Index': 'Index computed expressions (e.g., LOWER(email))', - 'Concurrently': 'Use CONCURRENTLY to avoid locking in production' - }) + - MarkdownUtils.warningBox('Too many indexes slow down INSERT/UPDATE/DELETE. Only create indexes for frequent queries.') + - `\n\n---` - ) - .addMarkdown('##### 🔍 Basic B-tree Index (Most Common)') - .addSql(`-- Create basic B-tree index -CREATE INDEX idx_${tableName}_column_name + .addMarkdown(`### ➕ Add Index to \`${schema}.${tableName}\`\n\nCreate a new index using the template below.`) + .addSql(`-- Create B-tree index (default) +CREATE INDEX idx_${tableName}_column_name ON "${schema}"."${tableName}" (column_name); --- Create index concurrently (doesn't block writes) --- CREATE INDEX CONCURRENTLY idx_${tableName}_column_name --- ON "${schema}"."${tableName}" (column_name);`) - .addMarkdown('##### ⭐ Unique Index') - .addSql(`-- Create unique index (enforces uniqueness) -CREATE UNIQUE INDEX idx_${tableName}_unique_column -ON "${schema}"."${tableName}" (column_name); +-- Use CONCURRENTLY to avoid locking the table during creation +-- CREATE INDEX CONCURRENTLY idx_${tableName}_column_name +-- ON "${schema}"."${tableName}" (column_name); + +-- Use UNIQUE to enforce uniqueness +-- CREATE UNIQUE INDEX idx_${tableName}_column_name_unique +-- ON "${schema}"."${tableName}" (column_name); --- Unique index on multiple columns --- CREATE UNIQUE INDEX idx_${tableName}_multi_unique --- ON "${schema}"."${tableName}" (col1, col2);`) - .addMarkdown('##### 📊 Composite Index (Multiple Columns)') - .addSql(`-- Composite index (column order matters!) --- Place most selective columns first -CREATE INDEX idx_${tableName}_composite -ON "${schema}"."${tableName}" (status, created_at, user_id); - --- Good for queries like: --- WHERE status = 'active' AND created_at > '2024-01-01'`) - .addMarkdown('##### 📍 Partial Index (WHERE clause)') - .addSql(`-- Partial index - only indexes rows matching condition --- Smaller and faster than full index -CREATE INDEX idx_${tableName}_active_only -ON "${schema}"."${tableName}" (created_at) -WHERE status = 'active'; - --- Index only non-null values --- CREATE INDEX idx_${tableName}_not_null --- ON "${schema}"."${tableName}" (email) --- WHERE email IS NOT NULL;`) - .addMarkdown('##### 🔤 Expression Index') - .addSql(`-- Index on expression (for case-insensitive search) -CREATE INDEX idx_${tableName}_lower_email -ON "${schema}"."${tableName}" (LOWER(email)); - --- Date extraction --- CREATE INDEX idx_${tableName}_year --- ON "${schema}"."${tableName}" (EXTRACT(YEAR FROM created_at));`) - .addMarkdown('##### 📖 GIN Index (for JSONB, Arrays, Full-Text)') - .addSql(`-- GIN index for JSONB column -CREATE INDEX idx_${tableName}_jsonb_gin -ON "${schema}"."${tableName}" USING GIN (data); - --- GIN index for JSONB with specific operators --- CREATE INDEX idx_${tableName}_jsonb_path --- ON "${schema}"."${tableName}" USING GIN (data jsonb_path_ops); - --- For array columns --- CREATE INDEX idx_${tableName}_tags --- ON "${schema}"."${tableName}" USING GIN (tags);`) - .addMarkdown('##### 🔎 Full-Text Search Index') - .addSql(`-- Full-text search index -CREATE INDEX idx_${tableName}_fts -ON "${schema}"."${tableName}" -USING GIN (to_tsvector('english', title || ' ' || description)); - --- Usage: --- SELECT * FROM ${tableName} --- WHERE to_tsvector('english', title || ' ' || description) @@ to_tsquery('search_term');`) - .addMarkdown('##### 🔤 BRIN Index (for large, ordered tables)') - .addSql(`-- BRIN index - very compact, good for time-series data --- Works best when data is naturally ordered by the indexed column -CREATE INDEX idx_${tableName}_brin -ON "${schema}"."${tableName}" USING BRIN (created_at);`) - .addMarkdown('##### 📈 Covering Index (INCLUDE columns)') - .addSql(`-- Covering index with INCLUDE (PostgreSQL 11+) --- Includes additional columns in the index for index-only scans -CREATE INDEX idx_${tableName}_covering -ON "${schema}"."${tableName}" (user_id) -INCLUDE (username, email); - --- Useful for: SELECT username, email FROM ${tableName} WHERE user_id = 123;`) - .addMarkdown(MarkdownUtils.successBox('After creating an index, use EXPLAIN ANALYZE to verify it is being used by your queries.')) +-- Use WHERE to create a partial index +-- CREATE INDEX idx_${tableName}_partial +-- ON "${schema}"."${tableName}" (column_name) +-- WHERE condition;`) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'add index'); diff --git a/src/commands/materializedViews.ts b/src/commands/materializedViews.ts index 0502fbd..4a3bffd 100644 --- a/src/commands/materializedViews.ts +++ b/src/commands/materializedViews.ts @@ -5,7 +5,6 @@ import { MarkdownUtils, FormatHelpers, ErrorHandlers, - SQL_TEMPLATES, ObjectUtils, getDatabaseConnection, NotebookBuilder, @@ -15,6 +14,9 @@ import { MaterializedViewSQL } from './sql'; +/** + * cmdRefreshMatView - Single-operation notebook: REFRESH materialized view + */ export async function cmdRefreshMatView(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; try { @@ -22,11 +24,8 @@ export async function cmdRefreshMatView(item: DatabaseTreeItem, context: vscode. const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🔄 Refresh Materialized View: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Execute the cell below to refresh the materialized view data.') - ) - .addMarkdown('##### 🔄 Refresh Command') + .addMarkdown(`### 🔄 Refresh Materialized View: \`${item.schema}.${item.label}\`\n\nRefresh the materialized view data from underlying tables.`) + .addMarkdown('##### 🔄 REFRESH') .addSql(MaterializedViewSQL.refresh(item.schema!, item.label)) .show(); } catch (err: any) { @@ -58,7 +57,7 @@ export async function cmdEditMatView(item: DatabaseTreeItem, context: vscode.Ext MarkdownUtils.warningBox('This will drop and recreate the materialized view.') ) .addMarkdown('##### 📝 View Definition') - .addSql(`DROP MATERIALIZED VIEW IF EXISTS ${item.schema}.${item.label};\n\n${createMatViewStatement}\nWITH DATA;`) + .addSql(`DROP MATERIALIZED VIEW IF EXISTS ${item.schema}.${item.label};\n\n${createMatViewStatement}`) .show(); } finally { // Connection is managed by ConnectionManager @@ -70,6 +69,9 @@ export async function cmdEditMatView(item: DatabaseTreeItem, context: vscode.Ext } } +/** + * cmdViewMatViewData - Single-operation notebook: SELECT from materialized view + */ export async function cmdViewMatViewData(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; try { @@ -77,12 +79,9 @@ export async function cmdViewMatViewData(item: DatabaseTreeItem, context: vscode const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📖 View Data: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Modify the query below to filter or transform the data as needed.') - ) - .addMarkdown('##### 📖 Query Data') - .addSql(MaterializedViewSQL.queryData(item.schema!, item.label)) + .addMarkdown(`### 📖 View Data: \`${item.schema}.${item.label}\`\n\nQuery data from the materialized view.`) + .addMarkdown('##### 📖 SELECT') + .addSql(MaterializedViewSQL.select(item.schema!, item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create view data notebook'); @@ -244,13 +243,13 @@ ${dependencyRows} .addMarkdown('##### 📝 CREATE MATERIALIZED VIEW Script') .addSql(`-- DROP MATERIALIZED VIEW IF EXISTS ${item.schema}.${item.label};\n\nCREATE MATERIALIZED VIEW ${item.schema}.${item.label} AS\n${viewDefinition}\nWITH DATA;\n\n-- Materialized view comment\n${matview.comment ? `COMMENT ON MATERIALIZED VIEW ${item.schema}.${item.label} IS '${matview.comment.replace(/'/g, "''")}';` : `-- COMMENT ON MATERIALIZED VIEW ${item.schema}.${item.label} IS 'view description';`}\n\n-- Indexes\n${indexes.map((idx: any) => idx.definition).join('\n')}`) .addMarkdown('##### 🔄 Refresh Materialized View') - .addSql(`-- Refresh materialized view (blocking)\nREFRESH MATERIALIZED VIEW ${item.schema}.${item.label};\n\n-- Refresh materialized view (concurrent, allows reads during refresh)\n-- REFRESH MATERIALIZED VIEW CONCURRENTLY ${item.schema}.${item.label};`) - .addMarkdown('##### 🗑️ DROP Materialized View Script') - .addSql(`${SQL_TEMPLATES.DROP.MATERIALIZED_VIEW(item.schema!, item.label)}\n\n-- Drop materialized view (with dependencies)\n-- DROP MATERIALIZED VIEW IF EXISTS ${item.schema}.${item.label} CASCADE;\n\n-- Drop materialized view (without dependencies - will fail if referenced)\n-- DROP MATERIALIZED VIEW IF EXISTS ${item.schema}.${item.label} RESTRICT;`) - .addMarkdown('##### 🔍 Query Materialized View Data') - .addSql(`-- Query materialized view data\nSELECT * FROM ${item.schema}.${item.label}\nLIMIT 100;`) + .addSql(MaterializedViewSQL.refresh(item.schema!, item.label)) + .addMarkdown('##### 📖 Query Materialized View Data') + .addSql(MaterializedViewSQL.select(item.schema!, item.label)) .addMarkdown('##### 📊 Statistics and Metadata') .addSql(`-- Get detailed statistics\nSELECT \n schemaname,\n matviewname,\n matviewowner,\n tablespace,\n hasindexes,\n ispopulated,\n pg_size_pretty(pg_total_relation_size(schemaname||'.'||matviewname)) as total_size\nFROM pg_matviews\nWHERE schemaname = '${item.schema}' AND matviewname = '${item.label}';\n\n-- Check when it was last refreshed\nSELECT \n schemaname,\n relname,\n last_vacuum,\n last_autovacuum,\n last_analyze,\n last_autoanalyze,\n n_live_tup,\n n_dead_tup\nFROM pg_stat_user_tables\nWHERE schemaname = '${item.schema}' AND relname = '${item.label}';`) + .addMarkdown('##### ❌ DROP Materialized View Script — ⚠️ Warning: permanently deletes the materialized view') + .addSql(MaterializedViewSQL.drop(item.schema!, item.label)) .show(); } finally { // Do not close shared client @@ -262,6 +261,9 @@ ${dependencyRows} } } +/** + * cmdDropMatView - Single-operation notebook: DROP materialized view + */ export async function cmdDropMatView(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; try { @@ -269,12 +271,9 @@ export async function cmdDropMatView(item: DatabaseTreeItem, context: vscode.Ext const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`❌ Drop Materialized View: \`${item.schema}.${item.label}\``) + - MarkdownUtils.dangerBox('This action will permanently delete the materialized view. This operation cannot be undone.') - ) - .addMarkdown('##### ❌ Drop Command') - .addSql(SQL_TEMPLATES.DROP.MATERIALIZED_VIEW(item.schema!, item.label)) + .addMarkdown(`### ❌ Drop Materialized View: \`${item.schema}.${item.label}\`\n\n⚠️ **Warning:** This permanently deletes the materialized view and cannot be undone.`) + .addMarkdown('##### ❌ DROP — ⚠️ Warning: permanently deletes the materialized view') + .addSql(MaterializedViewSQL.drop(item.schema!, item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create drop materialized view notebook'); @@ -283,6 +282,10 @@ export async function cmdDropMatView(item: DatabaseTreeItem, context: vscode.Ext } } +/** + * cmdMatViewOperations - Operations_Notebook for a materialized view. + * Cell order: read (SELECT, ANALYZE) → write/modify (REFRESH, CREATE INDEX) → destructive (DROP) + */ export async function cmdMatViewOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; try { @@ -290,34 +293,17 @@ export async function cmdMatViewOperations(item: DatabaseTreeItem, context: vsco const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🔄 Materialized View Operations: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Materialized views store query results as physical tables that need periodic refreshing. They provide faster query performance at the cost of data freshness.') + - `\n\n#### 📋 Common Operations\n\n` + - MarkdownUtils.operationsTable([ - { operation: '🔄 Refresh', description: 'Updates the materialized view with fresh data from underlying tables. Locks the view during refresh.', riskLevel: 'Standard data refresh' }, - { operation: '⚡ Concurrent Refresh', description: 'Refreshes without locking (requires unique index). Allows reads during refresh.', riskLevel: 'High-availability scenarios' }, - { operation: '🔍 Create Index', description: 'Adds indexes to improve query performance on the materialized view.', riskLevel: 'Query optimization' }, - { operation: '📊 Analyze', description: 'Updates statistics for the query planner to optimize query execution.', riskLevel: 'After large refreshes' }, - { operation: '🔍 Query Data', description: 'Query the materialized view data like a regular table.', riskLevel: 'Data analysis' }, - { operation: '📈 Check Freshness', description: 'View when the materialized view was last refreshed.', riskLevel: 'Monitoring data staleness' } - ]) - ) - .addMarkdown(`##### 🔄 Standard Refresh\n\n${MarkdownUtils.warningBox('This operation locks the materialized view and prevents reads during refresh.')}`) - .addSql(MaterializedViewSQL.refreshWithOptions(item.schema!, item.label)) - .addMarkdown(`##### ⚡ Concurrent Refresh\n\n${MarkdownUtils.infoBox('Requires a unique index. Allows queries during refresh but is slower than standard refresh.', 'Note')}`) - .addSql(MaterializedViewSQL.refreshConcurrently(item.schema!, item.label)) - .addMarkdown(`##### 🔍 Create Indexes\n\n${MarkdownUtils.successBox('Indexes on materialized views improve query performance, just like on regular tables.')}`) - .addSql(MaterializedViewSQL.createIndexes(item.schema!, item.label)) - .addMarkdown('##### 📊 Update Statistics') + .addMarkdown(`### 💾 Materialized View Operations: \`${item.schema}.${item.label}\`\n\nCommon operations for this PostgreSQL materialized view.`) + .addMarkdown('##### 📖 SELECT') + .addSql(MaterializedViewSQL.select(item.schema!, item.label)) + .addMarkdown('##### 📊 ANALYZE') .addSql(MaterializedViewSQL.analyze(item.schema!, item.label)) - .addMarkdown('##### 🔍 Query Data') - .addSql(`-- Query materialized view data\nSELECT * FROM ${item.schema}.${item.label}\nLIMIT 100;\n\n-- Count rows\nSELECT COUNT(*) as row_count\nFROM ${item.schema}.${item.label};\n\n-- Get column statistics\nSELECT column_name, data_type, is_nullable\nFROM information_schema.columns\nWHERE table_schema = '${item.schema}' \n AND table_name = '${item.label}'\nORDER BY ordinal_position;`) - .addMarkdown('##### 📈 Monitor Freshness and Performance') - .addSql(MaterializedViewSQL.monitorFreshness(item.schema!, item.label)) - .addMarkdown('##### 🔧 Advanced Operations') - .addSql(MaterializedViewSQL.advancedOperations(item.schema!, item.label)) - .addMarkdown(`##### 📚 Best Practices\n\n${MarkdownUtils.infoBox(`✨ Refresh Strategy:
    • Use REFRESH MATERIALIZED VIEW CONCURRENTLY for high-availability scenarios (requires unique index)
    • Schedule regular refreshes based on data freshness requirements
    • Run ANALYZE after large refreshes to update statistics
    • Monitor materialized view size and query performance
    • Consider partitioning for very large materialized views`, 'Best Practices')}`) + .addMarkdown('##### 🔄 REFRESH') + .addSql(MaterializedViewSQL.refresh(item.schema!, item.label)) + .addMarkdown('##### 🔍 CREATE INDEX') + .addSql(MaterializedViewSQL.createIndex(item.schema!, item.label)) + .addMarkdown('##### ❌ DROP — ⚠️ Warning: permanently deletes the materialized view') + .addSql(MaterializedViewSQL.drop(item.schema!, item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'show materialized view operations'); @@ -327,7 +313,7 @@ export async function cmdMatViewOperations(item: DatabaseTreeItem, context: vsco } /** - * cmdCreateMaterializedView - Command to create a new materialized view in the database. + * cmdCreateMaterializedView - Single-cell notebook with CREATE MATERIALIZED VIEW template. */ export async function cmdCreateMaterializedView(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; @@ -338,46 +324,13 @@ export async function cmdCreateMaterializedView(item: DatabaseTreeItem, context: const schema = item.schema!; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`➕ Create New Materialized View in Schema: \`${schema}\``) + - MarkdownUtils.infoBox('This notebook provides templates for creating materialized views. Modify the templates below and execute to create materialized views.') + - `\n\n#### 📋 Materialized View Design Guidelines\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'Naming', description: 'Use snake_case for materialized view names (e.g., sales_summary, user_statistics)' }, - { operation: 'Purpose', description: 'Store pre-computed query results for faster access to expensive queries' }, - { operation: 'Refresh Strategy', description: 'Plan regular refreshes based on data freshness requirements' }, - { operation: 'Indexes', description: 'Create unique indexes to enable CONCURRENT refresh' }, - { operation: 'Performance', description: 'Trade data freshness for query speed - data is stored physically' } - ]) + - `\n\n#### 🏷️ Materialized View vs Regular View\n\n` + - MarkdownUtils.propertiesTable({ - 'Regular View': 'Virtual - queries underlying tables each time', - 'Materialized View': 'Physical - stores data, requires refresh', - 'Query Speed': 'Regular: Slower | Materialized: Faster', - 'Data Freshness': 'Regular: Always current | Materialized: Stale until refresh', - 'Storage': 'Regular: None | Materialized: Uses disk space', - 'Refresh': 'Regular: Automatic | Materialized: Manual or scheduled' - }) + - MarkdownUtils.successBox('Use materialized views for expensive aggregations, complex joins, or frequently accessed query results. Create a unique index to enable CONCURRENT refresh.') + - `\n\n---` - ) - .addMarkdown('##### 📝 Basic Materialized View (Recommended Start)') - .addSql(MaterializedViewSQL.create.basic(schema)) - .addMarkdown('##### 📊 Aggregated Materialized View') - .addSql(MaterializedViewSQL.create.aggregated(schema)) - .addMarkdown('##### 🔄 Materialized View with Refresh Strategy') - .addSql(`-- Create materialized view with refresh setup\nCREATE MATERIALIZED VIEW ${schema}.daily_stats AS\nSELECT \n DATE(created_at) as stat_date,\n COUNT(*) as total_records,\n COUNT(DISTINCT user_id) as unique_users\nFROM ${schema}.events\nGROUP BY DATE(created_at)\nWITH DATA;\n\n-- Unique index for concurrent refresh\nCREATE UNIQUE INDEX idx_daily_stats_date ON ${schema}.daily_stats (stat_date);\n\n-- Schedule refresh (example using pg_cron extension)\n-- SELECT cron.schedule('refresh-daily-stats', '0 2 * * *', \n-- 'REFRESH MATERIALIZED VIEW CONCURRENTLY ${schema}.daily_stats');`) - .addMarkdown('##### 🔗 Joined Materialized View') - .addSql(MaterializedViewSQL.create.joined(schema)) - .addMarkdown('##### 📈 Time-Series Materialized View') - .addSql(MaterializedViewSQL.create.timeSeries(schema)) - .addMarkdown('##### 🎯 Materialized View with Filtered Data') - .addSql(`-- Materialized view with WHERE clause filter\nCREATE MATERIALIZED VIEW ${schema}.active_users_summary AS\nSELECT \n u.id,\n u.name,\n u.email,\n COUNT(DISTINCT o.id) as active_orders,\n SUM(o.total_amount) as active_total\nFROM ${schema}.users u\nJOIN ${schema}.orders o ON u.id = o.user_id\nWHERE o.status = 'active'\n AND o.created_at >= NOW() - INTERVAL '30 days'\nGROUP BY u.id, u.name, u.email\nWITH DATA;\n\n-- Create unique index\nCREATE UNIQUE INDEX idx_active_users_summary_id \n ON ${schema}.active_users_summary (id);`) - .addMarkdown(MarkdownUtils.warningBox('After creating a materialized view, remember to: 1) Create a unique index for concurrent refresh, 2) Set up a refresh schedule, 3) Monitor data freshness, 4) Run ANALYZE after refreshes, 5) Consider partitioning for very large materialized views.')) + .addMarkdown(`### ➕ Create New Materialized View in Schema: \`${schema}\`\n\nCreate a materialized view using the template below.`) + .addMarkdown('##### 📝 CREATE MATERIALIZED VIEW') + .addSql(MaterializedViewSQL.create(schema, 'new_matview')) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create materialized view notebook'); } finally { if (dbConn && dbConn.release) dbConn.release(); } -} \ No newline at end of file +} diff --git a/src/commands/notebook.ts b/src/commands/notebook.ts index 013396d..6807cfa 100644 --- a/src/commands/notebook.ts +++ b/src/commands/notebook.ts @@ -5,8 +5,6 @@ import { PostgresMetadata } from '../common/types'; export async function cmdNewNotebook(item: DatabaseTreeItem) { try { - // For schema and table items, validateItem is appropriate - // For database-level operations, would need validateCategoryItem const dbConn = await getDatabaseConnection(item); const { metadata } = dbConn; if (dbConn.release) dbConn.release(); @@ -20,7 +18,7 @@ export async function cmdNewNotebook(item: DatabaseTreeItem) { -- Write your SQL query here SELECT * FROM ${item.schema ? `${item.schema}.${item.label}` : 'your_table'} LIMIT 100;`) - .show(); + .showNew(); // always open a fresh notebook } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create new notebook'); @@ -28,7 +26,61 @@ LIMIT 100;`) } /** - * Execute EXPLAIN or EXPLAIN ANALYZE for a query + * Jump to a section in the active scratch notebook via Quick Pick. + * Scans all markdown cells for top-level headings (lines starting with #) + * and lets the user pick one to navigate to. + */ +export async function cmdJumpToSection() { + const editor = vscode.window.activeNotebookEditor; + if (!editor) { + vscode.window.showInformationMessage('No notebook is currently open.'); + return; + } + + const doc = editor.notebook; + const sections: { label: string; detail: string; cellIndex: number }[] = []; + + doc.getCells().forEach((cell, index) => { + if (cell.kind !== vscode.NotebookCellKind.Markup) { return; } + const lines = cell.document.getText().split('\n'); + for (const line of lines) { + const match = line.match(/^(#{1,3})\s+(.+)/); + if (match) { + const depth = match[1].length; + const title = match[2].trim(); + const indent = depth === 1 ? '' : depth === 2 ? ' ' : ' '; + sections.push({ + label: `${indent}${depth === 1 ? '$(symbol-namespace)' : depth === 2 ? '$(symbol-class)' : '$(symbol-method)'} ${title}`, + detail: `Cell ${index + 1}`, + cellIndex: index + }); + break; // only use the first heading per cell + } + } + }); + + if (sections.length === 0) { + vscode.window.showInformationMessage('No sections found. Add markdown headings (# Title) to create navigable sections.'); + return; + } + + const picked = await vscode.window.showQuickPick(sections, { + placeHolder: 'Jump to section…', + title: 'Notebook Sections', + matchOnDetail: true + }); + + if (!picked) { return; } + + await vscode.window.showNotebookDocument(doc, { preserveFocus: false }); + editor.revealRange( + new vscode.NotebookRange(picked.cellIndex, picked.cellIndex + 1), + vscode.NotebookEditorRevealType.AtTop + ); +} + +/** + * Execute EXPLAIN or EXPLAIN ANALYZE for a query. * Executes in the notebook so results can be sent to chat */ export async function cmdExplainQuery(cellUri: vscode.Uri, analyze: boolean) { diff --git a/src/commands/schema/operations.ts b/src/commands/schema/operations.ts index fc152ca..db67431 100644 --- a/src/commands/schema/operations.ts +++ b/src/commands/schema/operations.ts @@ -1,4 +1,3 @@ -import { Client } from 'pg'; import * as vscode from 'vscode'; import { DatabaseTreeItem, DatabaseTreeProvider } from '../../providers/DatabaseTreeProvider'; import { @@ -26,43 +25,9 @@ export async function cmdCreateSchema(item: DatabaseTreeItem, context: vscode.Ex const databaseName = item.label; - const markdown = MarkdownUtils.header(`➕ Create New Schema in Database: \`${databaseName}\``) + - MarkdownUtils.infoBox('This notebook provides templates for creating schemas. Modify the templates below and execute to create schemas.') + - `\n\n#### 📋 Schema Design Guidelines\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'Naming', description: 'Use lowercase names (e.g., app_data, analytics, reporting). Avoid reserved names like "public".' }, - { operation: 'Purpose', description: 'Organize database objects logically. Use schemas to separate applications, environments, or features' }, - { operation: 'Security', description: 'Control access with GRANT/REVOKE. Use schemas for multi-tenant applications' }, - { operation: 'Search Path', description: 'Set search_path to include schemas in order of preference' }, - { operation: 'Ownership', description: 'Assign appropriate owners. Owners can create objects and grant privileges' } - ]) + - `\n\n#### 🏷️ Common Schema Patterns\n\n` + - MarkdownUtils.propertiesTable({ - 'Application Schema': 'Separate schema per application (e.g., app1, app2)', - 'Feature Schema': 'Schema per feature/module (e.g., billing, inventory)', - 'Environment Schema': 'Schema per environment (e.g., dev, staging, prod)', - 'Tenant Schema': 'Schema per tenant in multi-tenant applications', - 'Archive Schema': 'Schema for historical/archived data', - 'Reporting Schema': 'Schema for reporting views and materialized views' - }) + - MarkdownUtils.successBox('Schemas provide logical organization and security boundaries. Use them to organize large databases and control access.') + - `\n\n---`; - await new NotebookBuilder(metadata) - .addMarkdown(markdown) - .addMarkdown('##### 📝 Basic Schema (Recommended Start)') - .addSql(SchemaSQL.create.basic()) - .addMarkdown('##### 🔐 Schema with Permissions') - .addSql(SchemaSQL.create.withPermissions()) - .addMarkdown('##### 🔄 Default Privileges Setup') - .addSql(SchemaSQL.create.defaultPrivileges()) - .addMarkdown('##### 🏢 Multi-Tenant Schema Pattern') - .addSql(SchemaSQL.create.multiTenant()) - .addMarkdown('##### 📊 Reporting Schema Pattern') - .addSql(SchemaSQL.create.reporting()) - .addMarkdown('##### 🔍 Search Path Configuration') - .addSql(SchemaSQL.searchPath()) - .addMarkdown(MarkdownUtils.warningBox('After creating a schema, remember to: 1) Grant appropriate permissions, 2) Set up default privileges for future objects, 3) Configure search_path if needed, 4) Document the schema purpose with comments.')) + .addMarkdown(`### ➕ Create New Schema in Database: \`${databaseName}\`\n\nCreate a new schema using the template below.`) + .addSql(SchemaSQL.create()) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create schema notebook'); @@ -85,7 +50,7 @@ export async function cmdCreateObjectInSchema(item: DatabaseTreeItem, context: v const items = [ { label: 'Table', detail: 'Create a new table in this schema', query: `CREATE TABLE ${item.schema}.table_name(\n id serial PRIMARY KEY, \n column_name data_type, \n created_at timestamptz DEFAULT current_timestamp\n); ` }, { label: 'View', detail: 'Create a new view in this schema', query: `CREATE VIEW ${item.schema}.view_name AS\nSELECT column1, column2\nFROM some_table\nWHERE condition; ` }, - { label: 'Function', detail: 'Create a new function in this schema', query: `CREATE OR REPLACE FUNCTION ${item.schema}.function_name(\n param1 data_type, \n param2 data_type\n) RETURNS return_type AS $$\nBEGIN\n-- Function logic here\n RETURN result; \nEND; \n$$ LANGUAGE plpgsql; ` }, + { label: 'Function', detail: 'Create a new function in this schema', query: `CREATE OR REPLACE FUNCTION ${item.schema}.function_name(\n param1 data_type, \n param2 data_type\n) RETURNS return_type AS $\nBEGIN\n-- Function logic here\n RETURN result; \nEND; \n$ LANGUAGE plpgsql; ` }, { label: 'Materialized View', detail: 'Create a new materialized view in this schema', query: `CREATE MATERIALIZED VIEW ${item.schema}.matview_name AS\nSELECT column1, column2\nFROM source_table\nWHERE condition\nWITH DATA; ` }, { label: 'Type', detail: 'Create a new composite type in this schema', query: `CREATE TYPE ${item.schema}.type_name AS(\n field1 data_type, \n field2 data_type\n); ` }, { label: 'Foreign Table', detail: 'Create a new foreign table in this schema', query: `CREATE FOREIGN TABLE ${item.schema}.foreign_table_name(\n column1 data_type, \n column2 data_type\n) SERVER foreign_server_name\nOPTIONS(schema_name 'remote_schema', table_name 'remote_table'); ` } @@ -114,44 +79,23 @@ export async function cmdCreateObjectInSchema(item: DatabaseTreeItem, context: v } /** - * cmdAllSchemaOperations - Command to create a notebook with various schema operations - * @param {DatabaseTreeItem} item - The selected schema item in the tree - * @param {vscode.ExtensionContext} context - The extension context + * cmdSchemaOperations - Operations_Notebook for a schema. + * Cell order: read (listObjects) → write/modify (grant) → destructive (drop) */ export async function cmdSchemaOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext) { let dbConn; try { dbConn = await getDatabaseConnection(item); - const { client, metadata } = dbConn; - - const schemaInfo = await client.query(QueryBuilder.schemaInfo(item.schema!)); - const info = schemaInfo.rows[0]; - - const privileges = (info.privileges || []).filter((p: string | null) => p !== null); - const privilegesText = privileges.length > 0 ? privileges.join(', ') : 'No specific privileges found'; + const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🗂️ Schema Operations: \`${item.schema}\``) + - MarkdownUtils.infoBox('This notebook contains operations for managing the schema. Execute the cells below to perform operations.') + - `\n\n#### 📊 Schema Information\n\n` + - MarkdownUtils.propertiesTable({ - 'Owner': info.owner, - 'Total Size': info.total_size, - 'Objects': `${info.tables_count} tables, ${info.views_count} views, ${info.functions_count} functions`, - 'Privileges': privilegesText - }) - ) - .addMarkdown('##### 📦 Schema Objects') - .addSql(`-- List all objects in schema with sizes\nSELECT \n CASE c.relkind\n WHEN 'r' THEN 'table'\n WHEN 'v' THEN 'view'\n WHEN 'm' THEN 'materialized view'\n WHEN 'i' THEN 'index'\n WHEN 'S' THEN 'sequence'\n WHEN 's' THEN 'special'\n WHEN 'f' THEN 'foreign table'\n WHEN 'p' THEN 'partitioned table'\nEND as object_type,\n c.relname as object_name,\n pg_size_pretty(pg_total_relation_size(quote_ident('public') || '.' || quote_ident(c.relname))) as size,\n CASE WHEN c.relkind = 'r' THEN\n (SELECT reltuples:: bigint FROM pg_class WHERE oid = c.oid)\n ELSE NULL END as estimated_row_count\nFROM pg_class c\nJOIN pg_namespace n ON n.oid = c.relnamespace\nWHERE n.nspname = 'public'\nAND c.relkind in ('r', 'v', 'm', 'S', 'f', 'p')\nORDER BY c.relkind, pg_total_relation_size(c.oid) DESC; `) - .addMarkdown('##### 🔐 Schema Privileges') - .addSql(`-- List schema privileges\nSELECT grantee, string_agg(privilege_type, ', ') as privileges\nFROM(\n SELECT DISTINCT grantee, privilege_type\n FROM information_schema.table_privileges\n WHERE table_schema = '${item.schema}'\n UNION\n SELECT DISTINCT grantee, privilege_type\n FROM information_schema.routine_privileges\n WHERE routine_schema = '${item.schema}'\n UNION\n SELECT DISTINCT grantee, privilege_type\n FROM information_schema.usage_privileges\n WHERE object_schema = '${item.schema}'\n) p\nGROUP BY grantee\nORDER BY grantee; `) + .addMarkdown(`### 🗂️ Schema Operations: \`${item.schema}\`\n\nCommon operations for managing this PostgreSQL schema.`) + .addMarkdown('##### 📦 List Objects') + .addSql(SchemaSQL.listObjects(item.schema!)) .addMarkdown('##### 🛡️ Grant Privileges') - .addSql(`-- Grant privileges(modify as needed)\nGRANT USAGE ON SCHEMA ${item.schema} TO role_name;\nGRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA ${item.schema} TO role_name;\nGRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA ${item.schema} TO role_name;\nGRANT SELECT, USAGE ON ALL SEQUENCES IN SCHEMA ${item.schema} TO role_name;\n\n--Set default privileges for future objects\nALTER DEFAULT PRIVILEGES IN SCHEMA ${item.schema}\n GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO role_name;\nALTER DEFAULT PRIVILEGES IN SCHEMA ${item.schema}\n GRANT EXECUTE ON FUNCTIONS TO role_name;\nALTER DEFAULT PRIVILEGES IN SCHEMA ${item.schema}\n GRANT SELECT, USAGE ON SEQUENCES TO role_name; `) - .addMarkdown('##### 🧹 Maintenance') - .addSql(`-- Schema maintenance\n\n--First analyze all tables(can be run within DO block)\nDO $$\nDECLARE\n t record;\nBEGIN\n FOR t IN \n SELECT tablename \n FROM pg_tables \n WHERE pg_tables.schemaname = '${item.schema}'\nLOOP\n EXECUTE 'ANALYZE VERBOSE ' || quote_ident('${item.schema}') || '.' || quote_ident(t.tablename);\n END LOOP;\nEND $$;\n\n--Note: VACUUM commands must be run as separate statements\n--The following are example VACUUM commands for each table in the schema\nSELECT format('VACUUM ANALYZE %I.%I;', schemaname, tablename) as vacuum_command\nFROM pg_tables \nWHERE schemaname = '${item.schema}'\nORDER BY tablename;\n\n--To execute VACUUM on a specific table, uncomment and modify:\n--VACUUM ANALYZE ${item.schema}.table_name; `) - .addMarkdown('##### ❌ Drop Schema') - .addSql(`-- Drop schema(BE CAREFUL!)\nDROP SCHEMA ${item.schema}; --This will fail if schema is not empty\n\n--To force drop schema and all objects:\n--DROP SCHEMA ${item.schema} CASCADE; `) + .addSql(SchemaSQL.grant(item.schema!)) + .addMarkdown('##### ❌ Drop Schema\n\n⚠️ **Warning:** Dropping this schema is permanent and will remove all contained objects if CASCADE is used.') + .addSql(SchemaSQL.drop(item.schema!)) .show(); } catch (err: any) { @@ -305,4 +249,4 @@ ${extensionRows} } finally { if (dbConn && dbConn.release) dbConn.release(); } -} \ No newline at end of file +} diff --git a/src/commands/sql/columns.ts b/src/commands/sql/columns.ts index 5933362..eb2a016 100644 --- a/src/commands/sql/columns.ts +++ b/src/commands/sql/columns.ts @@ -12,80 +12,6 @@ SELECT ${column} FROM ${schema}.${table} LIMIT ${limit};`, - /** - * Column statistics query - */ - statistics: (schema: string, table: string, column: string) => - `-- Column statistics (run ANALYZE first if no data) -SELECT - n_distinct, - null_frac, - avg_width, - correlation -FROM pg_stats -WHERE schemaname = '${schema}' - AND tablename = '${table}' - AND attname = '${column}';`, - - /** - * Detailed column statistics with percentages - */ - detailedStatistics: (schema: string, table: string, column: string) => - `-- View column statistics -SELECT - schemaname, - tablename, - attname as column_name, - n_distinct, - ROUND((null_frac * 100)::numeric, 2) as null_percentage, - avg_width as avg_bytes, - ROUND(correlation::numeric, 4) as correlation -FROM pg_stats -WHERE schemaname = '${schema}' - AND tablename = '${table}' - AND attname = '${column}'; - --- Get most common values and their frequencies -SELECT - attname as column_name, - most_common_vals as common_values, - most_common_freqs as frequencies -FROM pg_stats -WHERE schemaname = '${schema}' - AND tablename = '${table}' - AND attname = '${column}'; - --- Refresh statistics --- ANALYZE ${schema}.${table};`, - - /** - * WHERE clause templates for filtering - */ - whereTemplates: (schema: string, table: string, column: string) => - `-- Exact match -SELECT * FROM ${schema}.${table} -WHERE ${column} = 'value'; - --- Multiple values -SELECT * FROM ${schema}.${table} -WHERE ${column} IN ('value1', 'value2', 'value3'); - --- Range query -SELECT * FROM ${schema}.${table} -WHERE ${column} BETWEEN 'start' AND 'end'; - --- Pattern matching (for text columns) -SELECT * FROM ${schema}.${table} -WHERE ${column} LIKE '%pattern%'; - --- NULL check -SELECT * FROM ${schema}.${table} -WHERE ${column} IS NULL; - --- NOT NULL check -SELECT * FROM ${schema}.${table} -WHERE ${column} IS NOT NULL;`, - /** * ALTER COLUMN templates */ @@ -94,27 +20,27 @@ WHERE ${column} IS NOT NULL;`, ALTER TABLE ${schema}.${table} ALTER COLUMN ${column} TYPE varchar(255); --- Set NOT NULL constraint -ALTER TABLE ${schema}.${table} - ALTER COLUMN ${column} SET NOT NULL; +-- Use SET NOT NULL to add a not-null constraint +-- ALTER TABLE ${schema}.${table} +-- ALTER COLUMN ${column} SET NOT NULL; --- Drop NOT NULL constraint -ALTER TABLE ${schema}.${table} - ALTER COLUMN ${column} DROP NOT NULL; +-- Use DROP NOT NULL to remove a not-null constraint +-- ALTER TABLE ${schema}.${table} +-- ALTER COLUMN ${column} DROP NOT NULL; --- Set default value -ALTER TABLE ${schema}.${table} - ALTER COLUMN ${column} SET DEFAULT 'default_value'; +-- Use SET DEFAULT to add a default value +-- ALTER TABLE ${schema}.${table} +-- ALTER COLUMN ${column} SET DEFAULT 'default_value'; --- Drop default value -ALTER TABLE ${schema}.${table} - ALTER COLUMN ${column} DROP DEFAULT; +-- Use DROP DEFAULT to remove the default value +-- ALTER TABLE ${schema}.${table} +-- ALTER COLUMN ${column} DROP DEFAULT; --- Multiple changes in one statement -ALTER TABLE ${schema}.${table} - ALTER COLUMN ${column} TYPE integer USING ${column}::integer, - ALTER COLUMN ${column} SET NOT NULL, - ALTER COLUMN ${column} SET DEFAULT 0;`, +-- Use multiple clauses to change type, nullability, and default in one statement +-- ALTER TABLE ${schema}.${table} +-- ALTER COLUMN ${column} TYPE integer USING ${column}::integer, +-- ALTER COLUMN ${column} SET NOT NULL, +-- ALTER COLUMN ${column} SET DEFAULT 0;`, /** * DROP COLUMN template @@ -124,13 +50,13 @@ ALTER TABLE ${schema}.${table} ALTER TABLE ${schema}.${table} DROP COLUMN ${column}; --- Drop column with CASCADE (removes all dependent objects) +-- Use CASCADE to also drop all dependent objects -- ALTER TABLE ${schema}.${table} - -- DROP COLUMN ${column} CASCADE; +-- DROP COLUMN ${column} CASCADE; --- Drop only if exists +-- Use IF EXISTS to suppress error if column does not exist -- ALTER TABLE ${schema}.${table} - -- DROP COLUMN IF EXISTS ${column};`, +-- DROP COLUMN IF EXISTS ${column};`, /** * RENAME COLUMN template @@ -145,73 +71,31 @@ ALTER TABLE ${schema}.${table} */ createIndex: (schema: string, table: string, column: string, indexName: string) => `-- Basic index (B-tree) -CREATE INDEX ${indexName} +CREATE INDEX ${indexName} ON ${schema}.${table} (${column}); --- Unique index (prevents duplicate values) --- CREATE UNIQUE INDEX ${indexName} +-- Use UNIQUE to prevent duplicate values +-- CREATE UNIQUE INDEX ${indexName} -- ON ${schema}.${table} (${column}); --- Concurrent index (doesn't lock table, slower creation) --- CREATE INDEX CONCURRENTLY ${indexName} +-- Use CONCURRENTLY to avoid locking the table during creation +-- CREATE INDEX CONCURRENTLY ${indexName} -- ON ${schema}.${table} (${column}); --- Index with specific method --- CREATE INDEX ${indexName} --- ON ${schema}.${table} USING btree (${column}); +-- Use USING to specify a different index method (hash, gin, gist, brin) +-- CREATE INDEX ${indexName} +-- ON ${schema}.${table} USING hash (${column}); --- Partial index (index only matching rows) --- CREATE INDEX ${indexName} --- ON ${schema}.${table} (${column}) +-- Use WHERE to create a partial index on matching rows only +-- CREATE INDEX ${indexName} +-- ON ${schema}.${table} (${column}) -- WHERE ${column} IS NOT NULL; --- Index with sorting and null handling --- CREATE INDEX ${indexName} +-- Use DESC NULLS LAST to control sort order and null placement +-- CREATE INDEX ${indexName} -- ON ${schema}.${table} (${column} DESC NULLS LAST); --- Functional/expression index --- CREATE INDEX ${indexName} +-- Use an expression to create a functional index +-- CREATE INDEX ${indexName} -- ON ${schema}.${table} (LOWER(${column}));`, - - /** - * ADD COLUMN templates - */ - add: { - basic: (schema: string, table: string) => - `-- Add a basic column -ALTER TABLE "${schema}"."${table}" -ADD COLUMN new_column_name VARCHAR(255);`, - - withDefault: (schema: string, table: string) => - `-- Add column with NOT NULL constraint and default value -ALTER TABLE "${schema}"."${table}" -ADD COLUMN status VARCHAR(50) NOT NULL DEFAULT 'active';`, - - timestamps: (schema: string, table: string) => - `-- Add created_at and updated_at timestamps -ALTER TABLE "${schema}"."${table}" -ADD COLUMN created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), -ADD COLUMN updated_at TIMESTAMPTZ;`, - - withCheck: (schema: string, table: string) => - `-- Add column with inline CHECK constraint -ALTER TABLE "${schema}"."${table}" -ADD COLUMN priority INTEGER CHECK (priority >= 1 AND priority <= 10);`, - - foreignKey: (schema: string, table: string) => - `-- Add column with foreign key reference -ALTER TABLE "${schema}"."${table}" -ADD COLUMN category_id INTEGER REFERENCES ${schema}.categories(id) ON DELETE SET NULL;`, - - jsonb: (schema: string, table: string) => - `-- Add JSONB column (preferred over JSON for performance) -ALTER TABLE "${schema}"."${table}" -ADD COLUMN metadata JSONB DEFAULT '{}';`, - - uuid: (schema: string, table: string) => - `-- Add UUID column with auto-generation --- Note: Requires uuid-ossp or pgcrypto extension -ALTER TABLE "${schema}"."${table}" -ADD COLUMN external_id UUID DEFAULT gen_random_uuid();` - } }; diff --git a/src/commands/sql/constraints.ts b/src/commands/sql/constraints.ts index d3a21c5..ea02648 100644 --- a/src/commands/sql/constraints.ts +++ b/src/commands/sql/constraints.ts @@ -4,157 +4,89 @@ export const ConstraintSQL = { /** - * View constraint definition + * Add primary key constraint */ - definition: (schema: string, tableName: string, constraintName: string) => - `-- View constraint definition -SELECT pg_get_constraintdef(oid) as constraint_def -FROM pg_constraint -WHERE conname = '${constraintName}' -AND conrelid = '${schema}.${tableName}'::regclass;`, - - /** - * View constraint details - */ - details: (schema: string, constraintName: string) => - `-- View constraint details -SELECT * FROM information_schema.table_constraints -WHERE constraint_name = '${constraintName}' - AND table_schema = '${schema}';`, - - /** - * Validate constraint - */ - validate: (schema: string, tableName: string, constraintName: string) => - `-- Validate constraint ${constraintName} -ALTER TABLE "${schema}"."${tableName}" -VALIDATE CONSTRAINT "${constraintName}";`, - - /** - * Rename constraint - */ - rename: (schema: string, tableName: string, constraintName: string) => - `-- Rename constraint -ALTER TABLE "${schema}"."${tableName}" -RENAME CONSTRAINT "${constraintName}" TO "${constraintName}_new"; - --- Validate a NOT VALID constraint -ALTER TABLE "${schema}"."${tableName}" -VALIDATE CONSTRAINT "${constraintName}";`, - - /** - * DROP CONSTRAINT - */ - drop: (schema: string, tableName: string, constraintName: string) => - `-- Drop constraint -ALTER TABLE "${schema}"."${tableName}" -DROP CONSTRAINT "${constraintName}";`, - - /** - * ADD CONSTRAINT templates - */ - add: { - primaryKey: (schema: string, tableName: string) => - `-- Add primary key constraint + addPrimaryKey: (schema: string, tableName: string) => + `-- Add primary key constraint ALTER TABLE "${schema}"."${tableName}" ADD CONSTRAINT ${tableName}_pkey PRIMARY KEY (id); --- Composite primary key (multiple columns) +-- Use composite primary key when multiple columns form the key -- ALTER TABLE "${schema}"."${tableName}" -- ADD CONSTRAINT ${tableName}_pkey PRIMARY KEY (column1, column2);`, - foreignKey: (schema: string, tableName: string) => - `-- Add foreign key constraint + /** + * Add foreign key constraint + */ + addForeignKey: (schema: string, tableName: string) => + `-- Add foreign key constraint ALTER TABLE "${schema}"."${tableName}" ADD CONSTRAINT fk_${tableName}_reference - FOREIGN KEY (reference_id) + FOREIGN KEY (reference_id) REFERENCES ${schema}.other_table(id) ON DELETE CASCADE ON UPDATE CASCADE; --- Foreign Key Actions: --- ON DELETE CASCADE - Delete child rows when parent is deleted --- ON DELETE SET NULL - Set to NULL when parent is deleted --- ON DELETE RESTRICT - Prevent deletion if children exist --- ON UPDATE CASCADE - Update child values when parent key changes`, +-- Use ON DELETE SET NULL when child rows should be kept with null reference +-- ALTER TABLE "${schema}"."${tableName}" +-- ADD CONSTRAINT fk_${tableName}_reference +-- FOREIGN KEY (reference_id) +-- REFERENCES ${schema}.other_table(id) +-- ON DELETE SET NULL; - unique: (schema: string, tableName: string) => - `-- Add unique constraint on single column +-- Use ON DELETE RESTRICT when deletion of parent should be prevented +-- ALTER TABLE "${schema}"."${tableName}" +-- ADD CONSTRAINT fk_${tableName}_reference +-- FOREIGN KEY (reference_id) +-- REFERENCES ${schema}.other_table(id) +-- ON DELETE RESTRICT;`, + + /** + * Add unique constraint + */ + addUnique: (schema: string, tableName: string) => + `-- Add unique constraint on single column ALTER TABLE "${schema}"."${tableName}" ADD CONSTRAINT ${tableName}_email_unique UNIQUE (email); --- Unique constraint on multiple columns (composite) +-- Use composite unique when uniqueness spans multiple columns -- ALTER TABLE "${schema}"."${tableName}" -- ADD CONSTRAINT ${tableName}_multi_unique UNIQUE (column1, column2);`, - check: (schema: string, tableName: string) => - `-- Add CHECK constraint for value validation + /** + * Add check constraint + */ + addCheck: (schema: string, tableName: string) => + `-- Add CHECK constraint for value validation ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT ${tableName}_status_check +ADD CONSTRAINT ${tableName}_status_check CHECK (status IN ('active', 'inactive', 'pending')); --- Range check +-- Use range check when column must fall within numeric bounds -- ALTER TABLE "${schema}"."${tableName}" -- ADD CONSTRAINT ${tableName}_age_check CHECK (age >= 0 AND age <= 150); --- Compare columns +-- Use compare columns when one column must relate to another -- ALTER TABLE "${schema}"."${tableName}" -- ADD CONSTRAINT ${tableName}_date_check CHECK (end_date > start_date);`, - exclusion: (schema: string, tableName: string) => - `-- Prevent overlapping time ranges (requires btree_gist extension) --- CREATE EXTENSION IF NOT EXISTS btree_gist; - -ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT ${tableName}_no_overlap - EXCLUDE USING gist ( - resource_id WITH =, - tsrange(start_time, end_time) WITH && - );`, - - notNull: (schema: string, tableName: string) => - `-- Add NOT NULL constraint + /** + * Drop constraint + */ + drop: (schema: string, tableName: string, constraintName: string) => + `-- Drop constraint ALTER TABLE "${schema}"."${tableName}" -ALTER COLUMN column_name SET NOT NULL; +DROP CONSTRAINT "${constraintName}"; --- Remove NOT NULL constraint +-- Use CASCADE to also drop dependent objects -- ALTER TABLE "${schema}"."${tableName}" --- ALTER COLUMN column_name DROP NOT NULL;`, - - notValid: (schema: string, tableName: string) => - `-- Add constraint without validating existing data (faster, no lock) -ALTER TABLE "${schema}"."${tableName}" -ADD CONSTRAINT ${tableName}_check_new - CHECK (column_name IS NOT NULL) NOT VALID; - --- Later, validate existing data in background -ALTER TABLE "${schema}"."${tableName}" -VALIDATE CONSTRAINT ${tableName}_check_new;` - }, +-- DROP CONSTRAINT "${constraintName}" CASCADE;`, /** - * Find constraint dependencies + * Validate constraint */ - dependencies: (schema: string, constraintName: string) => - `-- Find all dependencies for this constraint -SELECT - d.deptype as dependency_type, - c.relname as dependent_object, - n.nspname as dependent_schema, - CASE c.relkind - WHEN 'r' THEN 'table' - WHEN 'v' THEN 'view' - WHEN 'm' THEN 'materialized view' - WHEN 'i' THEN 'index' - WHEN 'S' THEN 'sequence' - WHEN 'f' THEN 'foreign table' - ELSE c.relkind::text - END as object_type -FROM pg_constraint con -JOIN pg_depend d ON d.refobjid = con.oid -JOIN pg_class c ON c.oid = d.objid -JOIN pg_namespace n ON n.oid = c.relnamespace -WHERE con.conname = '${constraintName}' - AND con.connamespace = (SELECT oid FROM pg_namespace WHERE nspname = '${schema}') -ORDER BY dependent_schema, dependent_object;` + validate: (schema: string, tableName: string, constraintName: string) => + `-- Validate constraint ${constraintName} +ALTER TABLE "${schema}"."${tableName}" +VALIDATE CONSTRAINT "${constraintName}";`, }; diff --git a/src/commands/sql/functions.ts b/src/commands/sql/functions.ts index cfe665d..4309e57 100644 --- a/src/commands/sql/functions.ts +++ b/src/commands/sql/functions.ts @@ -4,144 +4,57 @@ export const FunctionSQL = { /** - * Call function template - provides both SELECT and SELECT * FROM syntax + * Call function — primary: SELECT (single value), variant: SELECT * FROM (table/set) */ call: (schema: string, name: string, args: string) => `-- Call function (returns single value) -SELECT ${schema}.${name}(${args ? '\n -- Replace with actual values:\n ' + args.split(',').join(',\n ') : ''}); +SELECT ${schema}.${name}(${args}); --- Call function (returns table/set - use for multi-row results) -SELECT * FROM ${schema}.${name}(${args ? '\n -- Replace with actual values:\n ' + args.split(',').join(',\n ') : ''});`, +-- Use SELECT * FROM when the function returns a table or set of rows +-- SELECT * FROM ${schema}.${name}(${args});`, + + /** + * Create or replace function template + */ + createOrReplace: (schema: string) => + `-- Create or replace function +CREATE OR REPLACE FUNCTION ${schema}.function_name(param1 integer, param2 text) +RETURNS text +LANGUAGE sql +IMMUTABLE +AS $$ + SELECT 'Result: ' || param2 || ' with value ' || param1::text; +$$;`, + + /** + * Drop function — primary: DROP, variant: CASCADE + */ + drop: (schema: string, name: string, args: string) => + `-- Drop function +DROP FUNCTION IF EXISTS ${schema}.${name}(${args}); + +-- Use CASCADE to also drop dependent objects (views, other functions, etc.) +-- DROP FUNCTION IF EXISTS ${schema}.${name}(${args}) CASCADE;`, /** * Function metadata query */ metadata: (schema: string, name: string) => `-- Get function details and metadata -SELECT - p.proname as function_name, - pg_get_function_arguments(p.oid) as arguments, - pg_get_function_result(p.oid) as return_type, - l.lanname as language, +SELECT + p.proname AS function_name, + pg_get_function_arguments(p.oid) AS arguments, + pg_get_function_result(p.oid) AS return_type, + l.lanname AS language, CASE p.provolatile WHEN 'i' THEN 'IMMUTABLE' WHEN 's' THEN 'STABLE' WHEN 'v' THEN 'VOLATILE' - END as volatility, - p.prosecdef as security_definer, - p.proisstrict as strict + END AS volatility, + p.prosecdef AS security_definer, + p.proisstrict AS strict FROM pg_proc p JOIN pg_namespace n ON n.oid = p.pronamespace LEFT JOIN pg_language l ON l.oid = p.prolang WHERE n.nspname = '${schema}' AND p.proname = '${name}';`, - - /** - * DROP FUNCTION with options - */ - dropWithOptions: (schema: string, name: string, args: string) => - `-- Drop function (with dependencies) --- DROP FUNCTION IF EXISTS ${schema}.${name}(${args}) CASCADE; - --- Drop function (without dependencies - will fail if referenced) --- DROP FUNCTION IF EXISTS ${schema}.${name}(${args}) RESTRICT;`, - - /** - * CREATE FUNCTION templates - */ - create: { - sqlFunction: (schema: string) => - `-- Create simple SQL function -CREATE OR REPLACE FUNCTION ${schema}.function_name(param1 integer, param2 text) -RETURNS text AS $$ - SELECT 'Result: ' || param2 || ' with value ' || param1::text; -$$ LANGUAGE sql IMMUTABLE; - --- Add comment -COMMENT ON FUNCTION ${schema}.function_name(integer, text) IS 'Function description';`, - - plpgsqlFunction: (schema: string) => - `-- Create PL/pgSQL function with variables and control flow -CREATE OR REPLACE FUNCTION ${schema}.calculate_total(order_id integer) -RETURNS numeric AS $$ -DECLARE - total_amount numeric := 0; - item_record record; -BEGIN - FOR item_record IN - SELECT price, quantity - FROM ${schema}.order_items - WHERE order_id = calculate_total.order_id - LOOP - total_amount := total_amount + (item_record.price * item_record.quantity); - END LOOP; - - RETURN total_amount; -END; -$$ LANGUAGE plpgsql STABLE;`, - - tableFunction: (schema: string) => - `-- Function that returns a table (set of rows) -CREATE OR REPLACE FUNCTION ${schema}.get_user_orders(user_id integer) -RETURNS TABLE ( - order_id integer, - order_date timestamp, - total_amount numeric -) AS $$ -BEGIN - RETURN QUERY - SELECT - o.id, - o.created_at, - o.total_amount - FROM ${schema}.orders o - WHERE o.user_id = get_user_orders.user_id - ORDER BY o.created_at DESC; -END; -$$ LANGUAGE plpgsql STABLE;`, - - securityDefiner: (schema: string) => - `-- Function that runs with owner's privileges (use carefully!) -CREATE OR REPLACE FUNCTION ${schema}.admin_delete_user(user_id integer) -RETURNS boolean AS $$ -BEGIN - -- This function runs with the privileges of the function owner - DELETE FROM ${schema}.users WHERE id = user_id; - RETURN FOUND; -END; -$$ LANGUAGE plpgsql SECURITY DEFINER; - --- Grant execute to specific roles only --- GRANT EXECUTE ON FUNCTION ${schema}.admin_delete_user(integer) TO admin_role;`, - - triggerFunction: (schema: string) => - `-- Function for triggers (returns trigger type) -CREATE OR REPLACE FUNCTION ${schema}.update_modified_timestamp() -RETURNS trigger AS $$ -BEGIN - NEW.updated_at := NOW(); - RETURN NEW; -END; -$$ LANGUAGE plpgsql; - --- Create trigger to use this function --- CREATE TRIGGER set_updated_at --- BEFORE UPDATE ON ${schema}.table_name --- FOR EACH ROW --- EXECUTE FUNCTION ${schema}.update_modified_timestamp();`, - - aggregateFunction: (schema: string) => - `-- Custom aggregate function -CREATE OR REPLACE FUNCTION ${schema}.sum_state(state numeric, value numeric) -RETURNS numeric AS $$ -BEGIN - RETURN COALESCE(state, 0) + COALESCE(value, 0); -END; -$$ LANGUAGE plpgsql; - -CREATE AGGREGATE ${schema}.safe_sum(numeric) ( - SFUNC = ${schema}.sum_state, - STYPE = numeric, - INITCOND = 0 -);` - } }; diff --git a/src/commands/sql/index.ts b/src/commands/sql/index.ts index 5d2661d..ad2bec3 100644 --- a/src/commands/sql/index.ts +++ b/src/commands/sql/index.ts @@ -10,7 +10,7 @@ export { ViewSQL } from './views'; export { FunctionSQL } from './functions'; export { SchemaSQL } from './schema'; export { ConstraintSQL } from './constraints'; -export { UsersRolesSQL } from './usersRoles'; +export { UserRoleSQL, UsersRolesSQL } from './usersRoles'; export { TypeSQL } from './types'; export { ExtensionSQL } from './extensions'; export { MaterializedViewSQL } from './materializedViews'; diff --git a/src/commands/sql/indexes.ts b/src/commands/sql/indexes.ts index 7de0de2..990905a 100644 --- a/src/commands/sql/indexes.ts +++ b/src/commands/sql/indexes.ts @@ -4,51 +4,45 @@ export const IndexSQL = { /** - * Get index definition + * DROP INDEX statement */ - definition: (schema: string, indexName: string) => - `-- View index definition -SELECT pg_get_indexdef(indexrelid) as index_def -FROM pg_stat_user_indexes -WHERE indexrelname = '${indexName}' -AND schemaname = '${schema}';`, + drop: (schema: string, indexName: string) => + `-- Drop index +DROP INDEX "${schema}"."${indexName}"; + +-- Use CONCURRENTLY to avoid locking the table +-- DROP INDEX CONCURRENTLY "${schema}"."${indexName}"; + +-- Use IF EXISTS to suppress error if not found +-- DROP INDEX IF EXISTS "${schema}"."${indexName}";`, /** - * Index usage statistics + * REINDEX statement */ - statistics: (schema: string, indexName: string) => - `-- Check index usage -SELECT - idx_scan as scans, - idx_tup_read as tuples_read, - idx_tup_fetch as tuples_fetched -FROM pg_stat_user_indexes -WHERE indexrelname = '${indexName}' -AND schemaname = '${schema}';`, + reindex: (schema: string, indexName: string) => + `-- Reindex (locks table) +REINDEX INDEX "${schema}"."${indexName}"; + +-- Use CONCURRENTLY to avoid locking the table (PostgreSQL 12+) +-- REINDEX INDEX CONCURRENTLY "${schema}"."${indexName}";`, /** - * Detailed index statistics + * ALTER INDEX statement */ - detailedStatistics: (schema: string, indexName: string) => - `-- Get detailed statistics for this index -SELECT - schemaname, - relname as table_name, - indexrelname as index_name, - idx_scan as number_of_scans, - idx_tup_read as tuples_read, - idx_tup_fetch as tuples_fetched -FROM pg_stat_user_indexes -WHERE schemaname = '${schema}' - AND indexrelname = '${indexName}'; + alter: (schema: string, indexName: string) => + `-- Rename index +ALTER INDEX "${schema}"."${indexName}" RENAME TO new_index_name; + +-- Use SET TABLESPACE to move index to a different tablespace +-- ALTER INDEX "${schema}"."${indexName}" SET TABLESPACE new_tablespace; --- Check index size -SELECT pg_size_pretty(pg_relation_size('${schema}.${indexName}')) as index_size;`, +-- Use ALTER COLUMN SET STATISTICS to adjust per-column statistics +-- ALTER INDEX "${schema}"."${indexName}" ALTER COLUMN column_name SET STATISTICS 1000;`, /** - * Index usage analysis + * Index usage statistics */ - usageAnalysis: (schema: string, table: string, indexName: string) => + usageStats: (schema: string, indexName: string) => `-- Index Usage Statistics SELECT schemaname, @@ -77,143 +71,4 @@ SELECT FROM pg_statio_user_indexes WHERE schemaname = '${schema}' AND indexrelname = '${indexName}';`, - - /** - * Compare index vs sequential scans - */ - scanComparison: (schema: string, table: string, indexName: string) => - `-- Compare with table scans -SELECT - 'Index Scans' as scan_type, - idx_scan as count -FROM pg_stat_user_indexes -WHERE indexrelname = '${indexName}' - AND schemaname = '${schema}' -UNION ALL -SELECT - 'Sequential Scans' as scan_type, - seq_scan as count -FROM pg_stat_user_tables -WHERE schemaname = '${schema}' - AND relname = '${table}';`, - - /** - * DROP INDEX statement - */ - drop: (schema: string, indexName: string) => - `-- Drop index -DROP INDEX "${schema}"."${indexName}"; - --- Drop concurrently --- DROP INDEX CONCURRENTLY "${schema}"."${indexName}";`, - - /** - * REINDEX statement - */ - reindex: (schema: string, indexName: string) => - `-- Reindex (locks table) -REINDEX INDEX "${schema}"."${indexName}"; - --- Reindex concurrently (PostgreSQL 12+) --- REINDEX INDEX CONCURRENTLY "${schema}"."${indexName}";`, - - /** - * ALTER INDEX templates - */ - alter: { - rename: (schema: string, indexName: string) => - `-- Rename index -ALTER INDEX "${schema}"."${indexName}" RENAME TO new_index_name;`, - - setTablespace: (schema: string, indexName: string) => - `-- Move index to different tablespace -ALTER INDEX "${schema}"."${indexName}" SET TABLESPACE new_tablespace;`, - - setStatistics: (schema: string, indexName: string) => - `-- Adjust index statistics -ALTER INDEX "${schema}"."${indexName}" ALTER COLUMN column_name SET STATISTICS 1000;` - }, - - /** - * CREATE INDEX templates - */ - create: { - btree: (schema: string, table: string, indexName: string) => - `-- Create Basic B-tree Index -CREATE INDEX ${indexName} -ON "${schema}"."${table}" (column_name);`, - - unique: (schema: string, table: string, indexName: string) => - `-- Create Unique Index -CREATE UNIQUE INDEX ${indexName} -ON "${schema}"."${table}" (column_name);`, - - partial: (schema: string, table: string, indexName: string) => - `-- Create Partial Index (with WHERE clause) -CREATE INDEX ${indexName} -ON "${schema}"."${table}" (column_name) -WHERE column_name IS NOT NULL;`, - - composite: (schema: string, table: string, indexName: string) => - `-- Create Composite Index (multiple columns) -CREATE INDEX ${indexName} -ON "${schema}"."${table}" (column1, column2, column3);`, - - concurrent: (schema: string, table: string, indexName: string) => - `-- Create Index Concurrently (doesn't block writes) -CREATE INDEX CONCURRENTLY ${indexName} -ON "${schema}"."${table}" (column_name);`, - - gin: (schema: string, table: string, indexName: string) => - `-- Create GIN Index (for arrays, JSONB, full-text search) -CREATE INDEX ${indexName} -ON "${schema}"."${table}" USING GIN (jsonb_column);`, - - expression: (schema: string, table: string, indexName: string) => - `-- Index on expression (for case-insensitive search) -CREATE INDEX ${indexName} -ON "${schema}"."${table}" (LOWER(email)); - --- Date extraction --- CREATE INDEX ${indexName} --- ON "${schema}"."${table}" (EXTRACT(YEAR FROM created_at));`, - - ginJsonb: (schema: string, table: string, indexName: string) => - `-- GIN index for JSONB column -CREATE INDEX ${indexName} -ON "${schema}"."${table}" USING GIN (data); - --- GIN index for JSONB with specific operators --- CREATE INDEX ${indexName} --- ON "${schema}"."${table}" USING GIN (data jsonb_path_ops); - --- For array columns --- CREATE INDEX ${indexName} --- ON "${schema}"."${table}" USING GIN (tags);`, - - fullText: (schema: string, table: string, indexName: string) => - `-- Full-text search index -CREATE INDEX ${indexName} -ON "${schema}"."${table}" -USING GIN (to_tsvector('english', title || ' ' || description)); - --- Usage: --- SELECT * FROM ${table} --- WHERE to_tsvector('english', title || ' ' || description) @@ to_tsquery('search_term');`, - - brin: (schema: string, table: string, indexName: string) => - `-- BRIN index - very compact, good for time-series data --- Works best when data is naturally ordered by the indexed column -CREATE INDEX ${indexName} -ON "${schema}"."${table}" USING BRIN (created_at);`, - - covering: (schema: string, table: string, indexName: string) => - `-- Covering index with INCLUDE (PostgreSQL 11+) --- Includes additional columns in the index for index-only scans -CREATE INDEX ${indexName} -ON "${schema}"."${table}" (user_id) -INCLUDE (username, email); - --- Useful for: SELECT username, email FROM ${table} WHERE user_id = 123;` - } }; diff --git a/src/commands/sql/materializedViews.ts b/src/commands/sql/materializedViews.ts index efc7e78..21dd263 100644 --- a/src/commands/sql/materializedViews.ts +++ b/src/commands/sql/materializedViews.ts @@ -4,225 +4,57 @@ export const MaterializedViewSQL = { /** - * Refresh materialized view + * Select data from materialized view */ - refresh: (schema: string, matviewName: string) => - `REFRESH MATERIALIZED VIEW ${schema}.${matviewName};`, - - /** - * Refresh options - */ - refreshWithOptions: (schema: string, matviewName: string) => - `-- Refresh materialized view (blocking operation) -REFRESH MATERIALIZED VIEW ${schema}.${matviewName}; - --- Alternative: Truncate and rebuild -REFRESH MATERIALIZED VIEW ${schema}.${matviewName} WITH DATA; - --- Clear data without dropping structure -REFRESH MATERIALIZED VIEW ${schema}.${matviewName} WITH NO DATA;`, - - /** - * Concurrent refresh - */ - refreshConcurrently: (schema: string, matviewName: string) => - `-- Concurrent refresh (non-blocking, requires unique index) -REFRESH MATERIALIZED VIEW CONCURRENTLY ${schema}.${matviewName}; - --- First, ensure you have a unique index --- Example: --- CREATE UNIQUE INDEX ${matviewName}_unique_idx ON ${schema}.${matviewName} (id);`, - - /** - * Query data - */ - queryData: (schema: string, matviewName: string) => + select: (schema: string, matviewName: string) => `SELECT * FROM ${schema}.${matviewName} LIMIT 100;`, /** - * Create indexes + * Refresh materialized view. + * Variant: CONCURRENTLY (non-blocking, requires unique index) */ - createIndexes: (schema: string, matviewName: string) => - `-- Create a unique index (enables concurrent refresh) -CREATE UNIQUE INDEX ${matviewName}_unique_idx - ON ${schema}.${matviewName} (id); - --- Create a regular B-tree index -CREATE INDEX ${matviewName}_column_idx - ON ${schema}.${matviewName} (column_name); - --- Create a multi-column index -CREATE INDEX ${matviewName}_multi_idx - ON ${schema}.${matviewName} (col1, col2); - --- Create a partial index (with WHERE clause) -CREATE INDEX ${matviewName}_partial_idx - ON ${schema}.${matviewName} (status) - WHERE status = 'active'; + refresh: (schema: string, matviewName: string) => + `REFRESH MATERIALIZED VIEW ${schema}.${matviewName}; --- Create a GiST index (for spatial/full-text data) -CREATE INDEX ${matviewName}_gist_idx - ON ${schema}.${matviewName} USING GIST (column_name);`, +-- Use CONCURRENTLY when you need non-blocking refresh (requires a unique index) +-- REFRESH MATERIALIZED VIEW CONCURRENTLY ${schema}.${matviewName};`, /** - * Update statistics + * Create materialized view template */ - analyze: (schema: string, matviewName: string) => - `-- Update query planner statistics -ANALYZE ${schema}.${matviewName}; - --- Analyze specific columns -ANALYZE ${schema}.${matviewName} (column1, column2); - --- Verbose analyze (shows detailed output) -ANALYZE VERBOSE ${schema}.${matviewName};`, + create: (schema: string, matviewName: string) => + `CREATE MATERIALIZED VIEW ${schema}.${matviewName} AS +SELECT + column1, + column2, + COUNT(*) AS count +FROM ${schema}.source_table +WHERE condition = true +WITH DATA;`, /** - * Monitor freshness + * Drop materialized view. + * Variant: CASCADE to also drop dependent objects */ - monitorFreshness: (schema: string, matviewName: string) => - `-- Check when materialized view was last refreshed -SELECT - schemaname, - matviewname, - matviewowner, - tablespace, - hasindexes, - ispopulated, - pg_size_pretty(pg_total_relation_size(schemaname||'.'||matviewname)) as total_size -FROM pg_matviews -WHERE schemaname = '${schema}' AND matviewname = '${matviewName}'; - --- Check statistics and last maintenance -SELECT - schemaname, - tablename, - last_vacuum, - last_autovacuum, - last_analyze, - last_autoanalyze, - n_live_tup as live_rows, - n_dead_tup as dead_rows -FROM pg_stat_user_tables -WHERE schemaname = '${schema}' AND tablename = '${matviewName}'; + drop: (schema: string, matviewName: string) => + `DROP MATERIALIZED VIEW ${schema}.${matviewName}; --- View all indexes on the materialized view -SELECT - indexname, - indexdef, - pg_size_pretty(pg_relation_size(indexname::regclass)) as index_size -FROM pg_indexes -WHERE schemaname = '${schema}' AND tablename = '${matviewName}' -ORDER BY indexname;`, +-- Use CASCADE to also drop dependent objects +-- DROP MATERIALIZED VIEW ${schema}.${matviewName} CASCADE;`, /** - * Advanced operations + * Update query planner statistics */ - advancedOperations: (schema: string, matviewName: string) => - `-- Change materialized view owner -ALTER MATERIALIZED VIEW ${schema}.${matviewName} OWNER TO new_owner; - --- Rename materialized view -ALTER MATERIALIZED VIEW ${schema}.${matviewName} RENAME TO new_name; - --- Move to different schema -ALTER MATERIALIZED VIEW ${schema}.${matviewName} SET SCHEMA new_schema; - --- Change tablespace -ALTER MATERIALIZED VIEW ${schema}.${matviewName} SET TABLESPACE new_tablespace; - --- Add comment -COMMENT ON MATERIALIZED VIEW ${schema}.${matviewName} IS 'Description of the materialized view';`, + analyze: (schema: string, matviewName: string) => + `ANALYZE ${schema}.${matviewName};`, /** - * CREATE MATERIALIZED VIEW templates + * Create a unique index on the materialized view. + * A unique index is required to enable CONCURRENT refresh. */ - create: { - basic: (schema: string) => - `-- Create basic materialized view -CREATE MATERIALIZED VIEW ${schema}.matview_name AS -SELECT - column1, - column2, - COUNT(*) as count -FROM ${schema}.source_table -WHERE condition = true -WITH DATA; - --- Add unique index (enables concurrent refresh) -CREATE UNIQUE INDEX idx_matview_name_id ON ${schema}.matview_name (column1); - --- Add comment -COMMENT ON MATERIALIZED VIEW ${schema}.matview_name IS 'Materialized view description';`, - - aggregated: (schema: string) => - `-- Materialized view with aggregations -CREATE MATERIALIZED VIEW ${schema}.sales_summary AS -SELECT - product_id, - DATE_TRUNC('month', order_date) as month, - COUNT(*) as order_count, - SUM(quantity) as total_quantity, - SUM(amount) as total_revenue, - AVG(amount) as avg_order_value -FROM ${schema}.orders o -JOIN ${schema}.order_items oi ON o.id = oi.order_id -GROUP BY product_id, DATE_TRUNC('month', order_date) -WITH DATA; - --- Create unique index for concurrent refresh -CREATE UNIQUE INDEX idx_sales_summary_unique - ON ${schema}.sales_summary (product_id, month); - --- Create additional indexes for common queries -CREATE INDEX idx_sales_summary_month ON ${schema}.sales_summary (month); -CREATE INDEX idx_sales_summary_product ON ${schema}.sales_summary (product_id);`, - - timeSeries: (schema: string) => - `-- Materialized view for time-series data -CREATE MATERIALIZED VIEW ${schema}.hourly_metrics AS -SELECT - DATE_TRUNC('hour', created_at) as hour, - metric_type, - SUM(value) as total_value, - AVG(value) as avg_value, - MIN(value) as min_value, - MAX(value) as max_value -FROM ${schema}.metrics -WHERE created_at >= NOW() - INTERVAL '7 days' -GROUP BY DATE_TRUNC('hour', created_at), metric_type -WITH DATA; - --- Create unique index -CREATE UNIQUE INDEX idx_hourly_metrics_unique - ON ${schema}.hourly_metrics (hour, metric_type); - --- Create index for time-based queries -CREATE INDEX idx_hourly_metrics_hour ON ${schema}.hourly_metrics (hour DESC);`, - - joined: (schema: string) => - `-- Materialized view joining multiple tables -CREATE MATERIALIZED VIEW ${schema}.user_order_summary AS -SELECT - u.id as user_id, - u.name as user_name, - u.email, - COUNT(o.id) as total_orders, - SUM(o.total_amount) as lifetime_value, - MAX(o.created_at) as last_order_date -FROM ${schema}.users u -LEFT JOIN ${schema}.orders o ON u.id = o.user_id -GROUP BY u.id, u.name, u.email -WITH DATA; - --- Create unique index -CREATE UNIQUE INDEX idx_user_order_summary_user_id - ON ${schema}.user_order_summary (user_id); - --- Create index for common queries -CREATE INDEX idx_user_order_summary_lifetime_value - ON ${schema}.user_order_summary (lifetime_value DESC);` - } + createIndex: (schema: string, matviewName: string) => + `CREATE UNIQUE INDEX ${matviewName}_unique_idx + ON ${schema}.${matviewName} (id);`, }; diff --git a/src/commands/sql/schema.ts b/src/commands/sql/schema.ts index 52973db..087871e 100644 --- a/src/commands/sql/schema.ts +++ b/src/commands/sql/schema.ts @@ -4,114 +4,45 @@ export const SchemaSQL = { /** - * CREATE SCHEMA templates + * CREATE SCHEMA */ - create: { - basic: () => - `-- Create basic schema + create: () => + `-- Create schema CREATE SCHEMA schema_name; --- Add comment -COMMENT ON SCHEMA schema_name IS 'Description of the schema purpose'; - --- Grant basic usage (modify as needed) -GRANT USAGE ON SCHEMA schema_name TO PUBLIC; --- GRANT CREATE ON SCHEMA schema_name TO role_name;`, - - withPermissions: () => - `-- Create schema with owner -CREATE SCHEMA schema_name - AUTHORIZATION owner_role; - --- Grant permissions to roles -GRANT USAGE ON SCHEMA schema_name TO app_role; -GRANT CREATE ON SCHEMA schema_name TO app_role; - --- Grant privileges on all existing tables -GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA schema_name TO app_role; - --- Grant privileges on all sequences -GRANT SELECT, USAGE ON ALL SEQUENCES IN SCHEMA schema_name TO app_role; - --- Grant execute on all functions -GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA schema_name TO app_role;`, - - defaultPrivileges: () => - `-- Set default privileges for future objects --- This ensures new objects automatically get the right permissions - --- Default privileges on tables -ALTER DEFAULT PRIVILEGES IN SCHEMA schema_name - GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO app_role; - --- Default privileges on sequences -ALTER DEFAULT PRIVILEGES IN SCHEMA schema_name - GRANT SELECT, USAGE ON SEQUENCES TO app_role; - --- Default privileges on functions -ALTER DEFAULT PRIVILEGES IN SCHEMA schema_name - GRANT EXECUTE ON FUNCTIONS TO app_role; - --- Default privileges on types -ALTER DEFAULT PRIVILEGES IN SCHEMA schema_name - GRANT USAGE ON TYPES TO app_role;`, - - multiTenant: () => - `-- Create schema for tenant isolation -CREATE SCHEMA tenant_123; - --- Grant tenant-specific access -GRANT USAGE ON SCHEMA tenant_123 TO tenant_123_role; - --- Grant privileges on all objects -GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA tenant_123 TO tenant_123_role; -GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA tenant_123 TO tenant_123_role; -GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA tenant_123 TO tenant_123_role; - --- Set default privileges for future objects -ALTER DEFAULT PRIVILEGES IN SCHEMA tenant_123 - GRANT ALL ON TABLES TO tenant_123_role; -ALTER DEFAULT PRIVILEGES IN SCHEMA tenant_123 - GRANT ALL ON SEQUENCES TO tenant_123_role; -ALTER DEFAULT PRIVILEGES IN SCHEMA tenant_123 - GRANT EXECUTE ON FUNCTIONS TO tenant_123_role;`, - - reporting: () => - `-- Create schema for reporting/analytics -CREATE SCHEMA reporting; - --- Grant read-only access to reporting role -GRANT USAGE ON SCHEMA reporting TO reporting_role; - --- Grant SELECT on all tables and views -GRANT SELECT ON ALL TABLES IN SCHEMA reporting TO reporting_role; - --- Set default privileges for future objects (read-only) -ALTER DEFAULT PRIVILEGES IN SCHEMA reporting - GRANT SELECT ON TABLES TO reporting_role; - --- Create materialized views in reporting schema --- CREATE MATERIALIZED VIEW reporting.sales_summary AS ...;` - }, +-- Use WITH AUTHORIZATION to set the owner +-- CREATE SCHEMA schema_name AUTHORIZATION owner_role;`, /** - * Search path configuration + * DROP SCHEMA */ - searchPath: () => - `-- Set search path for current session -SET search_path TO schema_name, public; + drop: (schema: string) => + `-- Drop schema (BE CAREFUL!) +DROP SCHEMA ${schema}; --- Set search path for a role (persistent) -ALTER ROLE role_name SET search_path = schema_name, public; +-- Use CASCADE to also drop all objects in the schema +-- DROP SCHEMA ${schema} CASCADE;`, --- Set search path for a database (affects all connections) -ALTER DATABASE database_name SET search_path = schema_name, public; + /** + * GRANT privileges on schema + */ + grant: (schema: string) => + `-- Grant privileges (modify as needed) +GRANT USAGE ON SCHEMA ${schema} TO role_name; +GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA ${schema} TO role_name; +GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA ${schema} TO role_name; +GRANT SELECT, USAGE ON ALL SEQUENCES IN SCHEMA ${schema} TO role_name; --- View current search path -SHOW search_path;`, +-- Set default privileges for future objects +ALTER DEFAULT PRIVILEGES IN SCHEMA ${schema} + GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO role_name; +ALTER DEFAULT PRIVILEGES IN SCHEMA ${schema} + GRANT EXECUTE ON FUNCTIONS TO role_name; +ALTER DEFAULT PRIVILEGES IN SCHEMA ${schema} + GRANT SELECT, USAGE ON SEQUENCES TO role_name;`, /** - * List schema objects + * List all objects in schema */ listObjects: (schema: string) => `-- List all objects in schema with sizes @@ -135,55 +66,5 @@ FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace WHERE n.nspname = '${schema}' AND c.relkind in ('r', 'v', 'm', 'S', 'f', 'p') -ORDER BY c.relkind, pg_total_relation_size(c.oid) DESC;`, - - /** - * Schema privileges - */ - privileges: (schema: string) => - `-- List schema privileges -SELECT grantee, string_agg(privilege_type, ', ') as privileges -FROM( - SELECT DISTINCT grantee, privilege_type - FROM information_schema.table_privileges - WHERE table_schema = '${schema}' - UNION - SELECT DISTINCT grantee, privilege_type - FROM information_schema.routine_privileges - WHERE routine_schema = '${schema}' - UNION - SELECT DISTINCT grantee, privilege_type - FROM information_schema.usage_privileges - WHERE object_schema = '${schema}' -) p -GROUP BY grantee -ORDER BY grantee;`, - - /** - * Grant privileges template - */ - grantPrivileges: (schema: string) => - `-- Grant privileges (modify as needed) -GRANT USAGE ON SCHEMA ${schema} TO role_name; -GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA ${schema} TO role_name; -GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA ${schema} TO role_name; -GRANT SELECT, USAGE ON ALL SEQUENCES IN SCHEMA ${schema} TO role_name; - --- Set default privileges for future objects -ALTER DEFAULT PRIVILEGES IN SCHEMA ${schema} - GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO role_name; -ALTER DEFAULT PRIVILEGES IN SCHEMA ${schema} - GRANT EXECUTE ON FUNCTIONS TO role_name; -ALTER DEFAULT PRIVILEGES IN SCHEMA ${schema} - GRANT SELECT, USAGE ON SEQUENCES TO role_name;`, - - /** - * DROP SCHEMA - */ - drop: (schema: string) => - `-- Drop schema (BE CAREFUL!) -DROP SCHEMA ${schema}; -- This will fail if schema is not empty - --- To force drop schema and all objects: --- DROP SCHEMA ${schema} CASCADE;` +ORDER BY c.relkind, pg_total_relation_size(c.oid) DESC;` }; diff --git a/src/commands/sql/tables.ts b/src/commands/sql/tables.ts index 717e494..f26c7dc 100644 --- a/src/commands/sql/tables.ts +++ b/src/commands/sql/tables.ts @@ -7,56 +7,67 @@ export const TableSQL = { * SELECT statement */ select: (schema: string, table: string, limit: number = 100) => - `SELECT * FROM ${schema}.${table} LIMIT ${limit};`, + `SELECT * FROM "${schema}"."${table}" LIMIT ${limit};`, /** - * DELETE statement template + * INSERT statement template */ - delete: (schema: string, table: string) => - `-- Delete rows -DELETE FROM ${schema}.${table} -WHERE condition; -- e.g., id = 1 + insert: (schema: string, table: string) => + `-- Insert a single row +INSERT INTO "${schema}"."${table}" ( + -- column1, + -- column2 +) +VALUES ( + -- value1, + -- value2 +) +RETURNING *; --- Delete with RETURNING +-- Use multi-row syntax to insert multiple rows at once /* -DELETE FROM ${schema}.${table} -WHERE condition +INSERT INTO "${schema}"."${table}" ( + -- column1, + -- column2 +) +VALUES + (-- value1, value2), + (-- value1, value2) RETURNING *; */`, /** * UPDATE statement template */ - update: (schema: string, table: string, whereClause: string) => - `-- Update data -UPDATE ${schema}.${table} + update: (schema: string, table: string) => + `-- Update rows matching a condition +UPDATE "${schema}"."${table}" +SET + column_name = new_value +WHERE condition; -- e.g., id = 1 +-- RETURNING *; + +-- Use RETURNING to see the updated rows +/* +UPDATE "${schema}"."${table}" SET - -- List columns to update: column_name = new_value -${whereClause} -RETURNING *;`, +WHERE condition +RETURNING *; +*/`, /** - * INSERT statement template + * DELETE statement template */ - insert: (schema: string, table: string, columns: string[], placeholders: string[]) => - `-- Insert single row -INSERT INTO ${schema}.${table} ( - ${columns.join(',\n ')} -) -VALUES ( - ${placeholders.join(',\n ')} -) -RETURNING *; + delete: (schema: string, table: string) => + `-- Delete rows matching a condition +DELETE FROM "${schema}"."${table}" +WHERE condition; -- e.g., id = 1 --- Insert multiple rows (example) +-- Use RETURNING to see the deleted rows /* -INSERT INTO ${schema}.${table} ( - ${columns.join(',\n ')} -) -VALUES - (${placeholders.join(', ')}), - (${placeholders.join(', ')}) +DELETE FROM "${schema}"."${table}" +WHERE condition RETURNING *; */`, @@ -64,128 +75,66 @@ RETURNING *; * TRUNCATE statement */ truncate: (schema: string, table: string) => - `-- Truncate table -TRUNCATE TABLE ${schema}.${table};`, + `-- Remove all rows from the table (faster than DELETE, cannot be filtered) +TRUNCATE TABLE "${schema}"."${table}"; + +-- Use CASCADE to also truncate tables that reference this table via foreign keys +-- TRUNCATE TABLE "${schema}"."${table}" CASCADE;`, /** - * DROP TABLE statement + * DROP TABLE statement — includes CASCADE as a commented variant */ drop: (schema: string, table: string) => - `-- Drop table -DROP TABLE ${schema}.${table};`, + `-- Drop the table permanently +DROP TABLE "${schema}"."${table}"; + +-- Use CASCADE to also drop dependent objects (views, foreign keys, etc.) +-- DROP TABLE "${schema}"."${table}" CASCADE; + +-- Use IF EXISTS to suppress error if the table does not exist +-- DROP TABLE IF EXISTS "${schema}"."${table}";`, /** - * VACUUM statement with options + * VACUUM statement */ vacuum: (schema: string, table: string) => - `VACUUM (VERBOSE, ANALYZE) ${schema}.${table};`, + `-- Reclaim storage and update planner statistics +VACUUM (VERBOSE, ANALYZE) "${schema}"."${table}"; + +-- Use FULL to reclaim more space (locks the table — schedule during maintenance windows) +-- VACUUM (FULL, VERBOSE, ANALYZE) "${schema}"."${table}";`, /** * ANALYZE statement */ analyze: (schema: string, table: string) => - `ANALYZE VERBOSE ${schema}.${table};`, + `-- Update planner statistics for the table +ANALYZE VERBOSE "${schema}"."${table}";`, /** * REINDEX statement */ reindex: (schema: string, table: string) => - `REINDEX TABLE ${schema}.${table};`, - - /** - * Table bloat and statistics query - */ - bloatStats: (schema: string, table: string) => - `-- Table bloat and statistics -SELECT - schemaname, - relname, - n_live_tup, - n_dead_tup, - ROUND(100.0 * n_dead_tup / NULLIF(n_live_tup + n_dead_tup, 0), 2) as dead_tuple_percent, - last_vacuum, - last_autovacuum, - last_analyze, - last_autoanalyze -FROM pg_stat_user_tables -WHERE schemaname = '${schema}' AND relname = '${table}'; - --- Column statistics -SELECT - attname as column_name, - n_distinct, - ROUND((null_frac * 100)::numeric, 2) as null_percentage, - avg_width, - correlation -FROM pg_stats -WHERE schemaname = '${schema}' AND tablename = '${table}' -ORDER BY attname;`, - - /** - * Table operations notebook templates - */ - operations: { - queryData: (schema: string, table: string) => - `-- Query data -SELECT * -FROM ${schema}.${table} -LIMIT 100;`, - - insertData: (schema: string, table: string) => - `-- Insert data -INSERT INTO ${schema}.${table} ( - -- List columns here -) -VALUES ( - -- List values here -);`, - - updateData: (schema: string, table: string) => - `-- Update data -UPDATE ${schema}.${table} -SET column_name = new_value -WHERE condition;`, + `-- Rebuild all indexes on the table (locks writes — schedule during maintenance windows) +REINDEX TABLE "${schema}"."${table}"; - deleteData: (schema: string, table: string) => - `-- Delete data -DELETE FROM ${schema}.${table} -WHERE condition;`, - - truncateData: (schema: string, table: string) => - `-- Truncate table (remove all data) -TRUNCATE TABLE ${schema}.${table};`, - - dropTable: (schema: string, table: string) => - `-- Drop table -DROP TABLE ${schema}.${table};` - }, +-- Use CONCURRENTLY to rebuild without locking writes (PostgreSQL 12+) +-- REINDEX TABLE CONCURRENTLY "${schema}"."${table}";`, /** - * DROP TABLE with options + * CREATE TABLE script template */ - dropWithOptions: (schema: string, table: string) => - `-- Drop table (with dependencies) -DROP TABLE IF EXISTS ${schema}.${table} CASCADE; - --- Drop table (without dependencies - will fail if referenced) --- DROP TABLE IF EXISTS ${schema}.${table} RESTRICT;`, - - /** - * Build Create Table Definition Body - */ - buildCreateDefinition: (columns: any[], constraints: any[]) => { - const columnDefs = columns.map(col => { - let def = ` ${col.column_name} ${col.data_type}`; - if (col.character_maximum_length) def += `(${col.character_maximum_length})`; - else if (col.numeric_precision) def += `(${col.numeric_precision}${col.numeric_scale ? ',' + col.numeric_scale : ''})`; - - if (col.is_nullable === 'NO') def += ' NOT NULL'; - if (col.column_default) def += ` DEFAULT ${col.column_default}`; - return def; - }).join(',\n'); - - const constraintDefs = constraints.map(c => ` CONSTRAINT ${c.constraint_name} ${c.definition}`).join(',\n'); - - return `(\n${columnDefs}${constraintDefs ? ',\n' + constraintDefs : ''}\n);`; - } + createScript: (schema: string, table: string) => + `-- Create a new table in schema "${schema}" +CREATE TABLE "${schema}"."${table}" ( + id bigserial PRIMARY KEY, + name varchar(255) NOT NULL, + description text, + is_active boolean NOT NULL DEFAULT true, + created_at timestamptz NOT NULL DEFAULT now(), + updated_at timestamptz NOT NULL DEFAULT now() +); + +-- Add a comment describing the table +-- COMMENT ON TABLE "${schema}"."${table}" IS 'Description of ${table}';`, }; diff --git a/src/commands/sql/types.ts b/src/commands/sql/types.ts index c6d71f6..fc30e87 100644 --- a/src/commands/sql/types.ts +++ b/src/commands/sql/types.ts @@ -4,38 +4,35 @@ export const TypeSQL = { /** - * View type information + * Create a composite type */ - info: (schema: string, typeName: string) => - `-- View type information -SELECT - t.typname as type_name, - n.nspname as schema_name, - pg_get_userbyid(t.typowner) as owner, - CASE t.typtype - WHEN 'c' THEN 'composite' - WHEN 'e' THEN 'enum' - WHEN 'r' THEN 'range' - ELSE t.typtype::text - END as type_category, - obj_description(t.oid) as comment -FROM pg_type t -JOIN pg_namespace n ON n.oid = t.typnamespace -WHERE t.typname = '${typeName}' AND n.nspname = '${schema}';`, + createComposite: (schema: string) => + `-- Create composite type +CREATE TYPE "${schema}".type_name AS ( + field1 text, + field2 integer +);`, /** - * Add value to enum + * Create an enum type */ - addEnumValue: (schema: string, typeName: string) => - `-- Add value to enum type -ALTER TYPE "${schema}"."${typeName}" ADD VALUE 'new_value';`, + createEnum: (schema: string) => + `-- Create enum type +CREATE TYPE "${schema}".status_enum AS ENUM ( + 'active', + 'inactive', + 'pending' +);`, /** - * Add attribute to composite + * Drop type */ - addAttribute: (schema: string, typeName: string) => - `-- Add attribute to composite type -ALTER TYPE "${schema}"."${typeName}" ADD ATTRIBUTE new_attribute_name data_type;`, + drop: (schema: string, typeName: string) => + `-- Drop type +DROP TYPE "${schema}"."${typeName}"; + +-- Use CASCADE to also drop dependent objects +-- DROP TYPE "${schema}"."${typeName}" CASCADE;`, /** * Rename type @@ -58,52 +55,4 @@ JOIN pg_class c ON c.oid = a.attrelid JOIN pg_namespace n ON n.oid = c.relnamespace JOIN pg_type t ON t.oid = a.atttypid WHERE t.typname = '${typeName}' AND n.nspname = '${schema}';`, - - /** - * Drop type - */ - drop: (schema: string, typeName: string) => - `-- Drop type -DROP TYPE "${schema}"."${typeName}"; - --- Drop type and dependent objects --- DROP TYPE "${schema}"."${typeName}" CASCADE;`, - - /** - * CREATE TYPE templates - */ - create: { - composite: (schema: string) => - `-- Create new composite type -CREATE TYPE ${schema}.type_name AS ( - field1 text, - field2 integer -); - --- Add comment -COMMENT ON TYPE ${schema}.type_name IS 'Type description';`, - - enum: (schema: string) => - `-- Create an enum type -CREATE TYPE ${schema}.status_enum AS ENUM ( - 'active', - 'inactive', - 'pending' -); - --- Add comment -COMMENT ON TYPE ${schema}.status_enum IS 'Enum for status values';` - }, - - /** - * Edit type (drop and recreate) - */ - edit: (schema: string, typeName: string, fields: string) => - `-- Drop existing type -DROP TYPE IF EXISTS ${schema}.${typeName} CASCADE; - --- Create type with new definition -CREATE TYPE ${schema}.${typeName} AS ( -${fields} -);` }; diff --git a/src/commands/sql/usersRoles.ts b/src/commands/sql/usersRoles.ts index f3085b5..d359734 100644 --- a/src/commands/sql/usersRoles.ts +++ b/src/commands/sql/usersRoles.ts @@ -2,69 +2,7 @@ * SQL Templates for User and Role Operations */ -export const UsersRolesSQL = { - /** - * View role attributes - */ - roleAttributes: (roleName: string) => - `-- View role attributes -SELECT - r.rolname as "Name", - r.rolsuper as "Superuser", - r.rolinherit as "Inherit", - r.rolcreaterole as "Create Role", - r.rolcreatedb as "Create DB", - r.rolcanlogin as "Can Login", - r.rolreplication as "Replication", - r.rolconnlimit as "Connection Limit", - r.rolvaliduntil as "Valid Until", - r.rolbypassrls as "Bypass RLS" -FROM pg_roles r -WHERE r.rolname = '${roleName}';`, - - /** - * Role memberships - */ - roleMemberships: (roleName: string) => - `-- View role memberships (roles this role belongs to) -SELECT - r.rolname as "Role", - m.rolname as "Member Of", - g.rolname as "Granted By", - am.admin_option as "Admin Option" -FROM pg_auth_members am -JOIN pg_roles r ON r.oid = am.member -JOIN pg_roles m ON m.oid = am.roleid -JOIN pg_roles g ON g.oid = am.grantor -WHERE r.rolname = '${roleName}'; - --- View members of this role -SELECT - r.rolname as "Role", - m.rolname as "Has Member", - g.rolname as "Granted By", - am.admin_option as "Admin Option" -FROM pg_auth_members am -JOIN pg_roles r ON r.oid = am.roleid -JOIN pg_roles m ON m.oid = am.member -JOIN pg_roles g ON g.oid = am.grantor -WHERE r.rolname = '${roleName}';`, - - /** - * Granted privileges - */ - grantedPrivileges: (roleName: string) => - `-- View granted privileges -SELECT - grantor, - table_schema, - table_name, - privilege_type, - is_grantable -FROM information_schema.table_privileges -WHERE grantee = '${roleName}' -ORDER BY table_schema, table_name, privilege_type;`, - +export const UserRoleSQL = { /** * CREATE USER template */ @@ -73,7 +11,6 @@ ORDER BY table_schema, table_name, privilege_type;`, CREATE USER new_username WITH LOGIN PASSWORD 'strong_password_here' - -- Uncomment and modify as needed: -- CREATEDB -- CREATEROLE -- SUPERUSER @@ -85,11 +22,8 @@ CREATE USER new_username WITH -- Grant connect privilege to specific database GRANT CONNECT ON DATABASE ${databaseName} TO new_username; --- Optional: Grant role membership --- GRANT existing_role TO new_username; - --- Optional: Grant schema usage --- GRANT USAGE ON SCHEMA public TO new_username;`, +-- Use role membership to assign permissions +-- GRANT existing_role TO new_username;`, /** * CREATE ROLE template @@ -99,16 +33,11 @@ GRANT CONNECT ON DATABASE ${databaseName} TO new_username; CREATE ROLE new_role_name WITH NOLOGIN INHERIT - -- Uncomment and modify as needed: -- CREATEDB -- CREATEROLE -- SUPERUSER ; --- Grant privileges to the role --- GRANT SELECT, INSERT, UPDATE ON ALL TABLES IN SCHEMA public TO new_role_name; --- GRANT USAGE ON SCHEMA public TO new_role_name; - -- Grant role to users -- GRANT new_role_name TO some_user;`, @@ -118,7 +47,6 @@ CREATE ROLE new_role_name WITH alterRole: (roleName: string) => `-- Modify role attributes ALTER ROLE ${roleName} - -- Uncomment and modify the attributes you want to change: -- WITH PASSWORD 'new_password' -- SUPERUSER | NOSUPERUSER -- CREATEDB | NOCREATEDB @@ -130,159 +58,45 @@ ALTER ROLE ${roleName} -- VALID UNTIL '2025-12-31' ; --- Rename role +-- Use RENAME TO to rename the role -- ALTER ROLE ${roleName} RENAME TO new_role_name; --- Set role-specific configuration --- ALTER ROLE ${roleName} SET search_path TO public, my_schema; --- ALTER ROLE ${roleName} SET statement_timeout TO '30s';`, - - /** - * Change password - */ - changePassword: (roleName: string) => - `-- Change role password -ALTER ROLE ${roleName} WITH PASSWORD 'new_secure_password'; - --- Set password with expiration --- ALTER ROLE ${roleName} WITH PASSWORD 'new_password' VALID UNTIL '2025-12-31';`, +-- Use SET to apply role-specific configuration +-- ALTER ROLE ${roleName} SET search_path TO public, my_schema;`, /** - * GRANT/REVOKE privileges templates + * GRANT privileges template — covers schema, tables, functions, and sequences */ - privileges: { - database: (roleName: string, dbName: string) => - `-- Grant database privileges -GRANT CONNECT ON DATABASE ${dbName} TO ${roleName}; --- GRANT CREATE ON DATABASE ${dbName} TO ${roleName}; --- GRANT TEMP ON DATABASE ${dbName} TO ${roleName}; - --- Revoke database privileges --- REVOKE CONNECT ON DATABASE ${dbName} FROM ${roleName};`, - - schema: (roleName: string) => - `-- Grant schema privileges + grant: (roleName: string) => + `-- Grant schema usage GRANT USAGE ON SCHEMA public TO ${roleName}; --- GRANT CREATE ON SCHEMA public TO ${roleName}; --- GRANT ALL ON SCHEMA public TO ${roleName}; - --- Revoke schema privileges --- REVOKE USAGE ON SCHEMA public FROM ${roleName};`, - table: (roleName: string) => - `-- Grant table privileges (all tables in schema) +-- Grant table privileges GRANT SELECT ON ALL TABLES IN SCHEMA public TO ${roleName}; -- GRANT INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO ${roleName}; --- GRANT ALL ON ALL TABLES IN SCHEMA public TO ${roleName}; - --- Grant on specific table --- GRANT SELECT, INSERT ON public.table_name TO ${roleName}; - --- Set default privileges for future tables -ALTER DEFAULT PRIVILEGES IN SCHEMA public - GRANT SELECT ON TABLES TO ${roleName}; --- Revoke table privileges --- REVOKE ALL ON ALL TABLES IN SCHEMA public FROM ${roleName};`, - - function: (roleName: string) => - `-- Grant function privileges +-- Grant function and sequence privileges GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO ${roleName}; --- GRANT EXECUTE ON FUNCTION public.function_name() TO ${roleName}; - --- Grant sequence privileges GRANT USAGE ON ALL SEQUENCES IN SCHEMA public TO ${roleName}; --- GRANT ALL ON ALL SEQUENCES IN SCHEMA public TO ${roleName}; --- Set default privileges -ALTER DEFAULT PRIVILEGES IN SCHEMA public - GRANT EXECUTE ON FUNCTIONS TO ${roleName}; -ALTER DEFAULT PRIVILEGES IN SCHEMA public - GRANT USAGE ON SEQUENCES TO ${roleName};`, +-- Set default privileges for future objects +ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO ${roleName}; +ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT EXECUTE ON FUNCTIONS TO ${roleName}; +ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT USAGE ON SEQUENCES TO ${roleName}; - roleMembership: (roleName: string) => - `-- Grant role membership --- GRANT other_role TO ${roleName}; --- GRANT other_role TO ${roleName} WITH ADMIN OPTION; - --- Revoke role membership --- REVOKE other_role FROM ${roleName};` - }, +-- Use WITH ADMIN OPTION to allow the role to grant to others +-- GRANT ${roleName} TO some_user WITH ADMIN OPTION;`, /** - * DROP ROLE with owned objects check + * DROP ROLE template */ dropRole: (roleName: string) => - `-- Step 1: View objects owned by this role -SELECT - n.nspname as schema, - c.relname as name, - CASE c.relkind - WHEN 'r' THEN 'table' - WHEN 'v' THEN 'view' - WHEN 'm' THEN 'materialized view' - WHEN 'S' THEN 'sequence' - WHEN 'f' THEN 'foreign table' - ELSE c.relkind::text - END as type -FROM pg_class c -JOIN pg_namespace n ON n.oid = c.relnamespace -JOIN pg_roles r ON r.oid = c.relowner -WHERE r.rolname = '${roleName}' -ORDER BY n.nspname, c.relname; - --- Step 2: Reassign owned objects to another role --- REASSIGN OWNED BY ${roleName} TO postgres; + `-- Drop the role +DROP ROLE ${roleName}; --- Step 3: Drop owned objects (if not needed) --- DROP OWNED BY ${roleName}; - --- Step 4: Drop the role --- DROP ROLE ${roleName}; - --- Alternative: Drop role if exists +-- Use IF EXISTS to suppress error if role does not exist -- DROP ROLE IF EXISTS ${roleName};`, - - /** - * Role dependencies - */ - roleDependencies: (roleName: string) => - `-- Objects owned by this role -SELECT - n.nspname as "Schema", - c.relname as "Name", - CASE c.relkind - WHEN 'r' THEN 'table' - WHEN 'v' THEN 'view' - WHEN 'm' THEN 'materialized view' - WHEN 'S' THEN 'sequence' - WHEN 'f' THEN 'foreign table' - WHEN 'i' THEN 'index' - ELSE c.relkind::text - END as "Type" -FROM pg_class c -JOIN pg_namespace n ON n.oid = c.relnamespace -JOIN pg_roles r ON r.oid = c.relowner -WHERE r.rolname = '${roleName}' -AND n.nspname NOT LIKE 'pg_%' -ORDER BY n.nspname, c.relname; - --- Functions owned by this role -SELECT - n.nspname as "Schema", - p.proname as "Function", - pg_get_function_identity_arguments(p.oid) as "Arguments" -FROM pg_proc p -JOIN pg_namespace n ON n.oid = p.pronamespace -JOIN pg_roles r ON r.oid = p.proowner -WHERE r.rolname = '${roleName}' -AND n.nspname NOT LIKE 'pg_%' -ORDER BY n.nspname, p.proname; - --- Databases owned by this role -SELECT - d.datname as "Database" -FROM pg_database d -JOIN pg_roles r ON r.oid = d.datdba -WHERE r.rolname = '${roleName}';` }; + +// Backward-compatibility alias +export { UserRoleSQL as UsersRolesSQL }; diff --git a/src/commands/sql/views.ts b/src/commands/sql/views.ts index 1bca8fc..501a95c 100644 --- a/src/commands/sql/views.ts +++ b/src/commands/sql/views.ts @@ -3,212 +3,61 @@ */ export const ViewSQL = { - /** - * SELECT from view - */ - select: (schema: string, view: string, limit: number = 100) => - `SELECT * FROM ${schema}.${view} LIMIT ${limit};`, - - /** - * View columns information - */ - columns: (schema: string, view: string) => - `-- View columns -SELECT - column_name, - data_type, - is_nullable, - column_default -FROM information_schema.columns -WHERE table_schema = '${schema}' - AND table_name = '${view}' -ORDER BY ordinal_position;`, - - /** - * View data with limit - */ - viewData: (schema: string, view: string) => - `-- View data -SELECT * - FROM ${schema}.${view} -LIMIT 100;`, - - /** - * Query with filters template - */ - queryWithFilters: (schema: string, view: string) => - `-- Query with filters -SELECT * -FROM ${schema}.${view} -WHERE condition = value -ORDER BY column_name -LIMIT 100;`, - - /** - * Query with aggregation template - */ - queryWithAggregation: (schema: string, view: string) => - `-- Query with aggregation -SELECT - column_name, - COUNT(*) as count, - AVG(numeric_column) as average -FROM ${schema}.${view} -GROUP BY column_name -ORDER BY count DESC;`, - - /** - * Modify view definition template - */ - modifyDefinition: (schema: string, view: string) => - `-- Modify view definition -CREATE OR REPLACE VIEW ${schema}.${view} AS -SELECT * FROM source_table -WHERE condition;`, - - /** - * View definition details - */ - definitionDetails: (schema: string, view: string) => - `-- Get detailed view information -SELECT + /** + * SELECT from view + */ + select: (schema: string, view: string, limit: number = 100) => + `SELECT * FROM "${schema}"."${view}" LIMIT ${limit};`, + + /** + * CREATE OR REPLACE VIEW template + */ + createOrReplace: (schema: string, view: string) => + `-- Create or replace the view definition +CREATE OR REPLACE VIEW "${schema}"."${view}" AS +SELECT + -- column1, + -- column2 +FROM "${schema}".source_table +WHERE true; -- replace with actual condition + +-- Add a comment describing the view +-- COMMENT ON VIEW "${schema}"."${view}" IS 'Description of ${view}';`, + + /** + * DROP VIEW statement — includes CASCADE as a commented variant + */ + drop: (schema: string, view: string) => + `-- Drop the view permanently +DROP VIEW "${schema}"."${view}"; + +-- Use CASCADE to also drop dependent objects (other views, rules, etc.) +-- DROP VIEW "${schema}"."${view}" CASCADE; + +-- Use IF EXISTS to suppress error if the view does not exist +-- DROP VIEW IF EXISTS "${schema}"."${view}";`, + + /** + * View definition and dependency details + */ + definition: (schema: string, view: string) => + `-- Get view definition and owner +SELECT schemaname, viewname, viewowner, definition FROM pg_views -WHERE schemaname = '${schema}' AND viewname = '${view}'; +WHERE schemaname = '${schema}' + AND viewname = '${view}'; --- Check view dependencies +-- Check columns and tables this view depends on SELECT DISTINCT v.table_schema, v.table_name, v.column_name FROM information_schema.view_column_usage v -WHERE v.view_schema = '${schema}' -AND v.view_name = '${view}' +WHERE v.view_schema = '${schema}' + AND v.view_name = '${view}' ORDER BY v.table_schema, v.table_name, v.column_name;`, - - /** - * DROP VIEW with options - */ - dropWithOptions: (schema: string, view: string) => - `-- Drop view (with dependencies) --- DROP VIEW IF EXISTS ${schema}.${view} CASCADE; - --- Drop view (without dependencies - will fail if referenced) --- DROP VIEW IF EXISTS ${schema}.${view} RESTRICT;`, - - /** - * CREATE VIEW templates - */ - create: { - basic: (schema: string) => - `-- Create basic view -CREATE OR REPLACE VIEW ${schema}.view_name AS -SELECT - column1, - column2, - column3 -FROM - ${schema}.table_name -WHERE - condition; - --- Add comment -COMMENT ON VIEW ${schema}.view_name IS 'Description of what this view provides';`, - - joined: (schema: string) => - `-- View with JOINs -CREATE OR REPLACE VIEW ${schema}.user_orders_summary AS -SELECT - u.id as user_id, - u.name as user_name, - o.id as order_id, - o.total_amount, - o.created_at -FROM - ${schema}.users u - INNER JOIN ${schema}.orders o ON u.id = o.user_id -WHERE - o.status = 'completed';`, - - aggregated: (schema: string) => - `-- View with aggregations -CREATE OR REPLACE VIEW ${schema}.sales_summary AS -SELECT - product_id, - COUNT(*) as total_orders, - SUM(quantity) as total_quantity, - SUM(amount) as total_revenue, - AVG(amount) as avg_order_value -FROM - ${schema}.order_items -GROUP BY - product_id;`, - - security: (schema: string) => - `-- View that restricts data access -CREATE OR REPLACE VIEW ${schema}.my_documents AS -SELECT - id, - title, - content, - created_at -FROM - ${schema}.documents -WHERE - created_by = current_user_id() - AND deleted_at IS NULL;`, - - computed: (schema: string) => - `-- View with calculated columns -CREATE OR REPLACE VIEW ${schema}.product_pricing AS -SELECT - id, - name, - base_price, - discount_percent, - base_price * (1 - discount_percent / 100.0) as final_price, - CASE - WHEN discount_percent > 20 THEN 'High Discount' - WHEN discount_percent > 10 THEN 'Medium Discount' - ELSE 'Low Discount' - END as discount_category -FROM - ${schema}.products -WHERE - is_active = true;`, - - recursive: (schema: string) => - `-- View using Common Table Expression (CTE) -CREATE OR REPLACE VIEW ${schema}.category_hierarchy AS -WITH RECURSIVE category_tree AS ( - -- Base case: root categories - SELECT - id, - name, - parent_id, - 0 as level, - name as path - FROM - ${schema}.categories - WHERE - parent_id IS NULL - - UNION ALL - - -- Recursive case: child categories - SELECT - c.id, - c.name, - c.parent_id, - ct.level + 1, - ct.path || ' > ' || c.name - FROM - ${schema}.categories c - INNER JOIN category_tree ct ON c.parent_id = ct.id -) -SELECT * FROM category_tree;` - } }; diff --git a/src/commands/tables/maintenance.ts b/src/commands/tables/maintenance.ts index 3d0142c..5d41763 100644 --- a/src/commands/tables/maintenance.ts +++ b/src/commands/tables/maintenance.ts @@ -2,7 +2,7 @@ import * as vscode from 'vscode'; import { DatabaseTreeItem } from '../../providers/DatabaseTreeProvider'; import { CommandBase } from '../../common/commands/CommandBase'; import { NotebookBuilder, MarkdownUtils } from '../helper'; -import { TableSQL } from '../sql/tables'; +import { TableSQL } from '../sql'; export async function cmdMaintenanceVacuum(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create VACUUM notebook', async (conn, client, metadata) => { diff --git a/src/commands/tables/operations.ts b/src/commands/tables/operations.ts index 2ddc946..fdd7a3b 100644 --- a/src/commands/tables/operations.ts +++ b/src/commands/tables/operations.ts @@ -9,6 +9,7 @@ import { NotebookBuilder, QueryBuilder } from '../helper'; +import { TableSQL } from '../sql'; export async function cmdTableOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create table operations notebook', async (conn, client, metadata) => { @@ -19,52 +20,24 @@ export async function cmdTableOperations(item: DatabaseTreeItem, context: vscode const tableDefinition = buildTableDefinition(item.schema!, item.label, columnsResult.rows, constraintsResult.rows); const notebook = new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📊 Table Operations: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('This notebook provides comprehensive CRUD (Create, Read, Update, Delete) operations and maintenance tools for your PostgreSQL table. Each cell is a ready-to-execute template.') + - `\n\n#### 🎯 Available Operations\n\n` + - MarkdownUtils.operationsTable([ - { operation: '🔍 View Definition', description: 'Display CREATE TABLE statement', riskLevel: '✅ Safe' }, - { operation: '📖 Query Data', description: 'Select and view table rows', riskLevel: '✅ Safe' }, - { operation: '➕ Insert Data', description: 'Add new rows to the table', riskLevel: '⚠️ Modifies Data' }, - { operation: '✏️ Update Data', description: 'Modify existing rows', riskLevel: '⚠️ Modifies Data' }, - { operation: '🗑️ Delete Data', description: 'Remove specific rows', riskLevel: '⚠️ Modifies Data' }, - { operation: '🧹 Truncate', description: 'Remove ALL data (fast)', riskLevel: '🔴 Destructive' }, - { operation: '❌ Drop Table', description: 'Delete table permanently', riskLevel: '🔴 Destructive' } - ]) + - MarkdownUtils.successBox('Use `Ctrl+Enter` to execute individual cells. Consider wrapping destructive operations in transactions for safety.', 'Tip') + - '\n\n---' - ) - .addMarkdown('##### 🔍 Table Definition') + .addMarkdown(`### 📊 Table Operations: \`${item.schema}.${item.label}\`\n\nCommon operations for the \`${item.schema}.${item.label}\` table.`) + // Read operations + .addMarkdown('##### Table Definition') .addSql(`-- Table definition\n${tableDefinition}`) - .addMarkdown('##### 📖 Query Data') - .addSql(`-- Query data\nSELECT *\nFROM ${item.schema}.${item.label}\nLIMIT 100;`) - .addMarkdown('#### ➕ Insert Data\n\nAdd new rows to the table. Replace placeholder comments with actual column names and values.') - .addSql(`-- Insert data\nINSERT INTO ${item.schema}.${item.label} (\n -- List columns here\n)\nVALUES (\n -- List values here\n);`) - .addMarkdown( - '#### ✏️ Update Data\n\n' + - MarkdownUtils.warningBox('Always include a WHERE clause to avoid updating all rows unintentionally. Test with SELECT first!') - ) - .addSql(`-- Update data\nUPDATE ${item.schema}.${item.label}\nSET column_name = new_value\nWHERE condition;`) - .addMarkdown( - '#### 🗑️ Delete Data\n\n' + - MarkdownUtils.warningBox('Deleted rows cannot be recovered unless you have backups. Always include a WHERE clause!') - ) - .addSql(`-- Delete data\nDELETE FROM ${item.schema}.${item.label}\nWHERE condition;`) - .addMarkdown( - '#### 🧹 Truncate Table\n\n' + - MarkdownUtils.dangerBox('This removes ALL DATA from the table instantly. This operation cannot be undone. Consider backing up data first.', 'Caution') - ) - .addSql(`-- Truncate table (remove all data)\nTRUNCATE TABLE ${item.schema}.${item.label};`) - .addMarkdown( - '#### ❌ Drop Table\n\n' + - MarkdownUtils.dangerBox('This action will PERMANENTLY DELETE the table and ALL DATA. This cannot be undone!', 'Caution') + - '\n\n**Before dropping:**\n' + - '- ✅ Verify you\'re targeting the correct table\n' + - '- ✅ Ensure you have recent backups\n' + - '- ✅ Check for dependent objects (views, foreign keys)' - ) - .addSql(`-- Drop table\nDROP TABLE ${item.schema}.${item.label};`); + .addMarkdown('##### SELECT') + .addSql(TableSQL.select(item.schema!, item.label)) + // Write/modify operations + .addMarkdown('##### INSERT') + .addSql(TableSQL.insert(item.schema!, item.label)) + .addMarkdown('##### UPDATE') + .addSql(TableSQL.update(item.schema!, item.label)) + // Destructive operations + .addMarkdown('##### DELETE\n\n⚠️ Warning: This operation modifies or removes data permanently.') + .addSql(TableSQL.delete(item.schema!, item.label)) + .addMarkdown('##### TRUNCATE\n\n⚠️ Warning: This operation removes all rows permanently and cannot be filtered.') + .addSql(TableSQL.truncate(item.schema!, item.label)) + .addMarkdown('##### DROP\n\n⚠️ Warning: This operation permanently deletes the table and all its data.') + .addSql(TableSQL.drop(item.schema!, item.label)); await notebook.show(); }); @@ -126,22 +99,8 @@ export async function cmdInsertTable(item: DatabaseTreeItem, context: vscode.Ext }); await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`➕ Insert Data: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Replace placeholder values below with your actual data. Use the data type reference to format values correctly.') + - `\n\n#### 📋 Common Data Type Formats\n\n` + - MarkdownUtils.propertiesTable({ - 'Text/Varchar': "`'example text'` (Single quotes required)", - 'Integer/Numeric': "`42` or `3.14` (No quotes)", - 'Boolean': "`true` or `false` (Lowercase, no quotes)", - 'Date': "`'2024-01-15'` (Format: YYYY-MM-DD)", - 'Timestamp': "`'2024-01-15 14:30:00'` (Or use `NOW()`)", - 'UUID': "`'550e8400...'` (Or use `gen_random_uuid()`)", - 'JSON/JSONB': "`'{\"key\": \"value\"}'` (Valid JSON in quotes)", - 'NULL': "`NULL` (For optional fields)" - }) + - MarkdownUtils.successBox('Use `RETURNING *` to see the inserted row immediately. For bulk inserts, specify multiple value tuples.', 'Tip') - ) + .addMarkdown(`### ➕ Insert Data: \`${item.schema}.${item.label}\`\n\nInsert a new row into the \`${item.schema}.${item.label}\` table.`) + .addMarkdown('##### INSERT') .addSql(`-- Insert single row\nINSERT INTO ${item.schema}.${item.label} (\n ${columns.join(',\n ')}\n)\nVALUES (\n ${placeholders.join(',\n ')}\n)\nRETURNING *;\n\n-- Insert multiple rows (example)\n/*\nINSERT INTO ${item.schema}.${item.label} (\n ${columns.join(',\n ')}\n)\nVALUES\n (${placeholders.join(', ')}),\n (${placeholders.join(', ')})\nRETURNING *;\n*/`) .show(); }); @@ -167,26 +126,8 @@ export async function cmdUpdateTable(item: DatabaseTreeItem, context: vscode.Ext }).join(',\n '); await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`✏️ Update Data: \`${item.schema}.${item.label}\``) + - MarkdownUtils.warningBox('Always include a WHERE clause to avoid updating all rows unintentionally. Test with SELECT first!') + - `\n\n#### 🎯 Safety Checklist\n\n` + - MarkdownUtils.propertiesTable({ - '✅ Test WHERE': 'Test your WHERE clause with a SELECT query first', - '✅ Transaction': 'Consider using a transaction (BEGIN/COMMIT/ROLLBACK)', - '✅ Verify Count': 'Verify the number of affected rows matches expectations', - '✅ Backup': 'Have a backup if updating critical data' - }) + - `\n\n#### 💡 Common Update Patterns\n\n` + - MarkdownUtils.propertiesTable({ - 'Single Column': "`SET status = 'active'`", - 'Multiple Columns': "`SET status = 'active', updated_at = NOW()`", - 'Conditional': "`SET price = CASE WHEN qty > 10 THEN price * 0.9 ELSE price END`", - 'From Table': "`FROM other_table WHERE table.id = other_table.ref_id`" - }) + - MarkdownUtils.successBox('Use `RETURNING *` to see updated rows. For safer updates, wrap in a transaction and review changes before committing.', 'Tip') - ) - .addMarkdown('##### 📝 Update Command') + .addMarkdown(`### ✏️ Update Data: \`${item.schema}.${item.label}\`\n\nUpdate rows in the \`${item.schema}.${item.label}\` table.`) + .addMarkdown('##### UPDATE') .addSql(`-- Update data\nUPDATE ${item.schema}.${item.label}\nSET\n -- List columns to update:\n column_name = new_value\n${whereClause}\nRETURNING *;\n\n-- Example of updating multiple columns with CASE\n/*\nUPDATE ${item.schema}.${item.label}\nSET\n ${updateCaseExample}\n${whereClause}\nRETURNING *;\n*/`) .show(); }); @@ -208,21 +149,11 @@ export async function cmdViewTableData(item: DatabaseTreeItem, context: vscode.E export async function cmdDropTable(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create drop table notebook', async (conn, client, metadata) => { await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`❌ Drop Table: \`${item.schema}.${item.label}\``) + - MarkdownUtils.dangerBox('This action will PERMANENTLY DELETE the table and ALL DATA. This cannot be undone!', 'Caution') + - `\n\n#### 🔍 Pre-Drop Checklist\n\n` + - MarkdownUtils.propertiesTable({ - '✅ Backups': 'Do you have recent backups of this data?', - '✅ Verification': 'Is this definitely the table you want to drop?', - '✅ Dependencies': 'Check for views, foreign keys, and app usage', - '✅ Production': 'Have you followed change management procedures?' - }) + - `\n\n#### 🔗 Check Dependencies\n\nRun this query first to check for dependencies:` - ) + .addMarkdown(`### ❌ Drop Table: \`${item.schema}.${item.label}\`\n\nPermanently delete the \`${item.schema}.${item.label}\` table.`) + .addMarkdown('##### Check Dependencies') .addSql(QueryBuilder.objectDependencies(item.schema!, item.label)) - .addMarkdown('#### 🗑️ Drop Command') - .addSql(`-- Drop table\nDROP TABLE ${item.schema}.${item.label};`) + .addMarkdown('##### DROP\n\n⚠️ Warning: This operation permanently deletes the table and all its data.') + .addSql(TableSQL.drop(item.schema!, item.label)) .show(); }); } @@ -230,28 +161,9 @@ export async function cmdDropTable(item: DatabaseTreeItem, context: vscode.Exten export async function cmdTruncateTable(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create truncate notebook', async (conn, client, metadata) => { await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🧹 Truncate Table: \`${item.schema}.${item.label}\``) + - MarkdownUtils.dangerBox('This removes ALL DATA from the table instantly. This operation cannot be undone.', 'Caution') + - `\n\n#### 🔄 TRUNCATE vs DELETE\n\n` + - ` - - - - - -
    FeatureTRUNCATEDELETE
    Speed⚡ Very fast🐌 Slower
    Triggers❌ No triggers✅ Fires triggers
    Rollback⚠️ Transaction only✅ Can rollback
    Space✅ Reclaimed⚠️ Needs VACUUM
    ` + - `\n\n#### 🔒 Safety Recommendations\n\n` + - MarkdownUtils.propertiesTable({ - '✅ Backup First': 'Ensure you have recent backups', - '✅ Verify Table': 'Double-check you\'re truncating the correct table', - '✅ Transaction': 'Wrap in BEGIN/COMMIT for safety', - '✅ References': 'Ensure no foreign key constraints will break' - }) + - MarkdownUtils.successBox(`To truncate despite foreign key constraints, use \`TRUNCATE TABLE ${item.schema}.${item.label} CASCADE\`. This will also truncate tables that reference this table (use with extreme caution!).`, 'Tip') - ) - .addMarkdown('##### 🧹 Truncate Command') - .addSql(`-- Truncate table\nTRUNCATE TABLE ${item.schema}.${item.label};`) + .addMarkdown(`### 🧹 Truncate Table: \`${item.schema}.${item.label}\`\n\nRemove all rows from the \`${item.schema}.${item.label}\` table.`) + .addMarkdown('##### TRUNCATE\n\n⚠️ Warning: This operation removes all rows permanently and cannot be filtered.') + .addSql(TableSQL.truncate(item.schema!, item.label)) .show(); }); } diff --git a/src/commands/tables/scripts.ts b/src/commands/tables/scripts.ts index 2b73171..a33694b 100644 --- a/src/commands/tables/scripts.ts +++ b/src/commands/tables/scripts.ts @@ -2,7 +2,7 @@ import * as vscode from 'vscode'; import { DatabaseTreeItem } from '../../providers/DatabaseTreeProvider'; import { CommandBase } from '../../common/commands/CommandBase'; import { NotebookBuilder, MarkdownUtils } from '../helper'; -import { TableSQL } from '../sql/tables'; +import { TableSQL } from '../sql'; import { cmdInsertTable, cmdUpdateTable, cmdEditTable } from './operations'; export async function cmdScriptSelect(item: DatabaseTreeItem, context: vscode.ExtensionContext) { diff --git a/src/commands/types.ts b/src/commands/types.ts index a2d0892..6469086 100644 --- a/src/commands/types.ts +++ b/src/commands/types.ts @@ -1,25 +1,10 @@ import * as vscode from 'vscode'; import { DatabaseTreeItem, DatabaseTreeProvider } from '../providers/DatabaseTreeProvider'; -/** - * SQL Queries for type operations - */ - -/** - * TYPE_INFO_QUERY - Query to get detailed type information including fields and constraints - */ - - -// Reuse shared helpers and utilities import { - SQL_TEMPLATES, MarkdownUtils, QueryBuilder, - FormatHelpers, ErrorHandlers, - StringUtils, - ValidationHelpers, - MaintenanceTemplates, ObjectUtils, getDatabaseConnection, NotebookBuilder @@ -36,29 +21,18 @@ export async function cmdAllOperationsTypes(item: DatabaseTreeItem, context: vsc await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`🔧 Type Operations: \`${schema}.${typeName}\``) + - MarkdownUtils.infoBox('Custom types allow you to define reusable data structures. Composite types group related fields, while enums define a set of allowed values.', 'About PostgreSQL Types') + - '\n\n#### 📋 Common Operations\n\n' + - MarkdownUtils.operationsTable([ - { operation: '📝 View Definition', description: 'Display the complete CREATE TYPE statement', riskLevel: 'Safe' }, - { operation: '✏️ Modify Type', description: 'Alter type properties (limited changes allowed)', riskLevel: 'Safe' }, - { operation: '🔄 Recreate Type', description: 'Drop and recreate with modifications (requires CASCADE)', riskLevel: 'Destructive' }, - { operation: '🔍 Find Usage', description: 'Search for tables/columns using this type', riskLevel: 'Safe' }, - { operation: '💬 Add Comment', description: 'Document the type\'s purpose and usage', riskLevel: 'Safe' }, - { operation: '❌ Drop Type', description: 'Remove the type from the database', riskLevel: 'Destructive' } - ]) + '\n---' + `### 🔧 Type Operations: \`${schema}.${typeName}\`\n\n` + + `Manage composite and enum types: find usage, rename, create, and drop.` ) - .addMarkdown('##### 📝 View Type Definition\n\n' + MarkdownUtils.infoBox('Query the system catalog to see the complete type definition.', 'Info')) - .addSql(TypeSQL.info(schema, typeName)) - .addMarkdown('##### ✏️ Modify Type (Enum)\n\n' + MarkdownUtils.infoBox('Add a new value to an existing enum type.', 'Enum Only')) - .addSql(TypeSQL.addEnumValue(schema, typeName)) - .addMarkdown('##### ✏️ Modify Type (Composite)\n\n' + MarkdownUtils.infoBox('Add a new attribute to a composite type.', 'Composite Only')) - .addSql(TypeSQL.addAttribute(schema, typeName)) - .addMarkdown('##### 🔄 Rename Type') - .addSql(TypeSQL.rename(schema, typeName)) - .addMarkdown('##### 🔍 Find Usage') + .addMarkdown(`##### 🔍 Find Usage`) .addSql(TypeSQL.findUsage(schema, typeName)) - .addMarkdown('##### ❌ Drop Type') + .addMarkdown(`##### ✏️ Rename Type`) + .addSql(TypeSQL.rename(schema, typeName)) + .addMarkdown(`##### ➕ Create Composite Type`) + .addSql(TypeSQL.createComposite(schema)) + .addMarkdown(`##### ➕ Create Enum Type`) + .addSql(TypeSQL.createEnum(schema)) + .addMarkdown(`##### ❌ Drop Type — ⚠️ warning: permanently removes the type and may break dependent objects.`) .addSql(TypeSQL.drop(schema, typeName)) .show(); } catch (err: any) { @@ -84,10 +58,10 @@ export async function cmdEditTypes(item: DatabaseTreeItem, context: vscode.Exten await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`Edit Type: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Modify the type definition below and execute the cells to update it.') + `### ✏️ Edit Type: \`${item.schema}.${item.label}\`\n\n` + + `Modify the type definition below and execute the cells to update it.` ) - .addMarkdown('##### 📝 Type Definition') + .addMarkdown(`##### 📝 Type Definition`) .addSql(`-- Drop existing type\nDROP TYPE IF EXISTS ${item.schema}.${item.label} CASCADE;\n\n-- Create type with new definition\nCREATE TYPE ${item.schema}.${item.label} AS (\n${fields}\n);`) .show(); } finally { @@ -237,11 +211,10 @@ export async function cmdDropType(item: DatabaseTreeItem, context: vscode.Extens await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`❌ Drop Type: \`${item.schema}.${item.label}\``) + - MarkdownUtils.dangerBox('This action will permanently delete the type. This operation cannot be undone.') + `### ❌ Drop Type: \`${item.schema}.${item.label}\`\n\n` + + `⚠️ warning: permanently removes the type and may break dependent objects.` ) - .addMarkdown('##### ❌ Drop Command') - .addSql(`-- Drop type\nDROP TYPE IF EXISTS ${item.schema}.${item.label} CASCADE;`) + .addSql(TypeSQL.drop(item.schema!, item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create drop type notebook'); @@ -268,11 +241,13 @@ export async function cmdCreateType(item: DatabaseTreeItem, context: vscode.Exte await new NotebookBuilder(metadata) .addMarkdown( - MarkdownUtils.header(`➕ Create New Type in Schema: \`${item.schema}\``) + - MarkdownUtils.infoBox('Modify the type definition below and execute the cell to create the type.') + `### ➕ Create New Type in Schema: \`${item.schema}\`\n\n` + + `Templates for creating composite and enum types.` ) - .addMarkdown('##### 📝 Type Definition') - .addSql(TypeSQL.create.composite(item.schema!)) + .addMarkdown(`##### ➕ Create Composite Type`) + .addSql(TypeSQL.createComposite(item.schema!)) + .addMarkdown(`##### ➕ Create Enum Type`) + .addSql(TypeSQL.createEnum(item.schema!)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create type notebook'); diff --git a/src/commands/usersRoles.ts b/src/commands/usersRoles.ts index 27fec24..cce9c90 100644 --- a/src/commands/usersRoles.ts +++ b/src/commands/usersRoles.ts @@ -4,22 +4,12 @@ import { MarkdownUtils, FormatHelpers, ErrorHandlers, - QueryBuilder, NotebookBuilder, getDatabaseConnection, validateRoleItem } from './helper'; -import { UsersRolesSQL } from './sql'; - -/** - * SQL Queries for role operations - */ - -/** - * ROLE_DETAILS_QUERY - Query to get detailed role information including attributes, memberships, and privileges - */ - +import { UserRoleSQL } from './sql'; /** * Show role properties in a notebook @@ -70,7 +60,6 @@ export async function cmdShowRoleProperties(item: DatabaseTreeItem, context: vsc markdown += '\n\n#### 🔑 Active Privileges\n\n' + attributes.join(' | '); } - // Memberships if (role.member_of && role.member_of.length > 0) { markdown += '\n\n#### 👪 Member Of\n\n- ' + role.member_of.join('\n- '); } @@ -79,21 +68,68 @@ export async function cmdShowRoleProperties(item: DatabaseTreeItem, context: vsc markdown += '\n\n#### 👥 Has Members\n\n- ' + role.members.join('\n- '); } - // Accessible databases if (role.accessible_databases && role.accessible_databases.length > 0) { markdown += '\n\n#### 🗄️ Accessible Databases\n\n- ' + role.accessible_databases.join('\n- '); } - markdown += '\n\n---'; - await new NotebookBuilder(metadata) .addMarkdown(markdown) .addMarkdown('##### 🔍 Query Role Attributes') - .addSql(UsersRolesSQL.roleAttributes(roleName)) + .addSql(`SELECT + r.rolname, + r.rolsuper, + r.rolinherit, + r.rolcreaterole, + r.rolcreatedb, + r.rolcanlogin, + r.rolreplication, + r.rolconnlimit, + r.rolvaliduntil, + r.rolbypassrls, + pg_catalog.shobj_description(r.oid, 'pg_authid') as description +FROM pg_roles r +WHERE r.rolname = '${roleName}'`) .addMarkdown('##### 👪 Role Memberships') - .addSql(UsersRolesSQL.roleMemberships(roleName)) + .addSql(`-- Roles this role belongs to +SELECT + m.rolname as "Member Of", + g.rolname as "Granted By", + am.admin_option as "Admin Option" +FROM pg_auth_members am +JOIN pg_roles r ON r.oid = am.member +JOIN pg_roles m ON m.oid = am.roleid +JOIN pg_roles g ON g.oid = am.grantor +WHERE r.rolname = '${roleName}'; + +-- Roles that belong to this role +SELECT + m.rolname as "Has Member", + g.rolname as "Granted By", + am.admin_option as "Admin Option" +FROM pg_auth_members am +JOIN pg_roles r ON r.oid = am.roleid +JOIN pg_roles m ON m.oid = am.member +JOIN pg_roles g ON g.oid = am.grantor +WHERE r.rolname = '${roleName}';`) .addMarkdown('##### 🔐 Granted Privileges') - .addSql(UsersRolesSQL.grantedPrivileges(roleName)) + .addSql(`-- Table privileges +SELECT + table_schema as "Schema", + table_name as "Table", + privilege_type as "Privilege", + is_grantable as "Grantable" +FROM information_schema.table_privileges +WHERE grantee = '${roleName}' +ORDER BY table_schema, table_name, privilege_type; + +-- Schema privileges +SELECT + n.nspname as "Schema", + 'USAGE' as "Privilege" +FROM pg_namespace n +WHERE has_schema_privilege('${roleName}', n.nspname, 'USAGE') +AND n.nspname NOT LIKE 'pg_%' +AND n.nspname != 'information_schema';`) .show(); } catch (err: any) { @@ -122,7 +158,7 @@ export async function copyRoleNameQuoted(item: DatabaseTreeItem): Promise } /** - * Generate CREATE USER script + * Generate CREATE USER script — single-operation notebook */ export async function cmdAddUser(item: DatabaseTreeItem, context: vscode.ExtensionContext): Promise { let dbConn; @@ -131,20 +167,8 @@ export async function cmdAddUser(item: DatabaseTreeItem, context: vscode.Extensi const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header('➕ Create New User') + - MarkdownUtils.infoBox('Users are roles with LOGIN privilege. Modify the template below to create a new user.') + - '\n\n#### 👤 User Attributes\n\n' + - MarkdownUtils.operationsTable([ - { operation: 'LOGIN', description: 'Allows the role to connect to the database' }, - { operation: 'PASSWORD', description: 'Sets the authentication password' }, - { operation: 'CREATEDB', description: 'Allows creating new databases' }, - { operation: 'CREATEROLE', description: 'Allows creating new roles' }, - { operation: 'SUPERUSER', description: 'Grants all privileges (use with caution!)' }, - { operation: 'VALID UNTIL', description: 'Sets password expiration date' } - ]) - ) - .addSql(UsersRolesSQL.createUser(item.databaseName || 'database_name')) + .addMarkdown(`### ➕ Create New User\n\nCreate a new PostgreSQL user with login privileges.`) + .addSql(UserRoleSQL.createUser(item.databaseName || 'database_name')) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create user notebook'); @@ -154,7 +178,7 @@ export async function cmdAddUser(item: DatabaseTreeItem, context: vscode.Extensi } /** - * Generate CREATE ROLE script + * Generate CREATE ROLE script — single-operation notebook */ export async function cmdAddRole(item: DatabaseTreeItem, context: vscode.ExtensionContext): Promise { let dbConn; @@ -163,18 +187,8 @@ export async function cmdAddRole(item: DatabaseTreeItem, context: vscode.Extensi const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header('➕ Create New Role') + - MarkdownUtils.infoBox('Roles are used to manage database access permissions. Roles without LOGIN are typically used for grouping privileges.') + - '\n\n#### 🛡️ Role Attributes\n\n' + - MarkdownUtils.operationsTable([ - { operation: 'NOLOGIN', description: 'Role cannot connect directly (default for roles)' }, - { operation: 'INHERIT', description: 'Role inherits privileges from member roles' }, - { operation: 'CREATEDB', description: 'Role can create databases' }, - { operation: 'CREATEROLE', description: 'Role can create other roles' } - ]) - ) - .addSql(UsersRolesSQL.createRole()) + .addMarkdown(`### ➕ Create New Role\n\nCreate a new PostgreSQL role for grouping privileges.`) + .addSql(UserRoleSQL.createRole()) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'create role notebook'); @@ -184,7 +198,7 @@ export async function cmdAddRole(item: DatabaseTreeItem, context: vscode.Extensi } /** - * Generate ALTER ROLE script + * Generate ALTER ROLE script — single-operation notebook */ export async function cmdEditRole(item: DatabaseTreeItem, context: vscode.ExtensionContext): Promise { let dbConn; @@ -193,20 +207,8 @@ export async function cmdEditRole(item: DatabaseTreeItem, context: vscode.Extens const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`✏️ Edit Role: \`${item.label}\``) + - MarkdownUtils.infoBox('Modify the role\'s attributes using ALTER ROLE. Changes take effect immediately.') + - '\n\n#### 🛠️ Available Modifications\n\n' + - MarkdownUtils.operationsTable([ - { operation: 'PASSWORD', description: 'Change the role password' }, - { operation: 'LOGIN/NOLOGIN', description: 'Enable or disable login capability' }, - { operation: 'SUPERUSER', description: 'Grant or revoke superuser status' }, - { operation: 'CREATEDB', description: 'Grant or revoke database creation' }, - { operation: 'CREATEROLE', description: 'Grant or revoke role creation' }, - { operation: 'VALID UNTIL', description: 'Set password expiration' } - ]) - ) - .addSql(UsersRolesSQL.alterRole(item.label)) + .addMarkdown(`### ✏️ Edit Role: \`${item.label}\`\n\nModify role attributes using ALTER ROLE.`) + .addSql(UserRoleSQL.alterRole(item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'edit role'); @@ -216,7 +218,7 @@ export async function cmdEditRole(item: DatabaseTreeItem, context: vscode.Extens } /** - * Generate GRANT/REVOKE script + * Generate GRANT script — single-operation notebook */ export async function cmdGrantRevokeRole(item: DatabaseTreeItem, context: vscode.ExtensionContext): Promise { let dbConn; @@ -224,31 +226,9 @@ export async function cmdGrantRevokeRole(item: DatabaseTreeItem, context: vscode dbConn = await getDatabaseConnection(item, validateRoleItem); const { metadata } = dbConn; - const dbName = item.databaseName || 'database_name'; - await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🔐 Manage Privileges: \`${item.label}\``) + - MarkdownUtils.infoBox('Grant or revoke privileges for this role. Uncomment the operations you want to execute.') + - '\n\n#### 🔑 Privilege Levels\n\n' + - MarkdownUtils.operationsTable([ - { operation: 'Database', description: 'CONNECT, CREATE, TEMP privileges' }, - { operation: 'Schema', description: 'USAGE, CREATE privileges' }, - { operation: 'Table', description: 'SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER' }, - { operation: 'Function', description: 'EXECUTE privilege' }, - { operation: 'Sequence', description: 'USAGE, SELECT, UPDATE privileges' } - ]) - ) - .addMarkdown('##### 🗄️ Database Privileges') - .addSql(UsersRolesSQL.privileges.database(item.label, dbName)) - .addMarkdown('##### 📂 Schema Privileges') - .addSql(UsersRolesSQL.privileges.schema(item.label)) - .addMarkdown('##### 📊 Table Privileges') - .addSql(UsersRolesSQL.privileges.table(item.label)) - .addMarkdown('##### ⚡ Function & Sequence Privileges') - .addSql(UsersRolesSQL.privileges.function(item.label)) - .addMarkdown('##### 👥 Role Membership') - .addSql(UsersRolesSQL.privileges.roleMembership(item.label)) + .addMarkdown(`### 🔐 Manage Privileges: \`${item.label}\`\n\nGrant or revoke privileges for this role.`) + .addSql(UserRoleSQL.grant(item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'manage privileges'); @@ -258,7 +238,7 @@ export async function cmdGrantRevokeRole(item: DatabaseTreeItem, context: vscode } /** - * Generate DROP ROLE script + * Generate DROP ROLE script — single-operation notebook */ export async function cmdDropRole(item: DatabaseTreeItem, context: vscode.ExtensionContext): Promise { let dbConn; @@ -267,17 +247,8 @@ export async function cmdDropRole(item: DatabaseTreeItem, context: vscode.Extens const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`❌ Drop Role: \`${item.label}\``) + - MarkdownUtils.dangerBox('This will permanently delete the role. All objects owned by this role must be reassigned or dropped first.') + - '\n\n#### ⚠️ Before Dropping\n\n' + - '1. **Reassign owned objects** to another role\n' + - '2. **Drop owned objects** if no longer needed\n' + - '3. **Revoke privileges** granted to this role\n' + - '4. **Remove role memberships**\n\n' + - MarkdownUtils.warningBox('Cannot drop a role that owns objects or has privileges on objects.') - ) - .addSql(UsersRolesSQL.dropRole(item.label)) + .addMarkdown(`### ❌ Drop Role: \`${item.label}\`\n\n⚠️ **Warning:** This permanently deletes the role. Reassign or drop owned objects first.`) + .addSql(UserRoleSQL.dropRole(item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'drop role'); @@ -287,7 +258,8 @@ export async function cmdDropRole(item: DatabaseTreeItem, context: vscode.Extens } /** - * Show role operations notebook + * Show role operations notebook — Operations_Notebook + * Cell order: read → write/modify → destructive */ export async function cmdRoleOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext): Promise { let dbConn; @@ -296,33 +268,29 @@ export async function cmdRoleOperations(item: DatabaseTreeItem, context: vscode. const { metadata } = dbConn; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`🛠️ Role Operations: \`${item.label}\``) + - MarkdownUtils.infoBox('This notebook provides a dashboard for managing your role. Each cell is a ready-to-execute template.') + - '\n\n#### ⚡ Available Operations\n\n' + - MarkdownUtils.operationsTable([ - { operation: '🔍 View Attributes', description: 'Display role settings and configuration', riskLevel: '🟢 Safe' }, - { operation: '👥 View Memberships', description: 'Show role membership hierarchy', riskLevel: '🟢 Safe' }, - { operation: '🔑 View Privileges', description: 'List all granted privileges', riskLevel: '🟢 Safe' }, - { operation: '✏️ Modify Role', description: 'Change role attributes', riskLevel: '🟡 Low Risk' }, - { operation: '🔑 Change Password', description: 'Update role password', riskLevel: '🟡 Low Risk' }, - { operation: '❌ Drop Role', description: 'Remove role permanently', riskLevel: '🔴 Destructive' } - ]) + '\n' + - MarkdownUtils.successBox('Use Ctrl+Enter to execute individual cells.') + - '\n---' - ) - .addMarkdown('##### 🔍 View Role Attributes') - .addSql(`-- View role attributes\nSELECT \n r.rolname as "Name",\n r.rolsuper as "Superuser",\n r.rolinherit as "Inherit",\n r.rolcreaterole as "Create Role",\n r.rolcreatedb as "Create DB",\n r.rolcanlogin as "Can Login",\n r.rolreplication as "Replication",\n r.rolconnlimit as "Connection Limit",\n r.rolvaliduntil as "Valid Until",\n r.rolbypassrls as "Bypass RLS",\n pg_catalog.shobj_description(r.oid, 'pg_authid') as "Description"\nFROM pg_roles r\nWHERE r.rolname = '${item.label}';`) - .addMarkdown('##### 👥 Role Memberships') - .addSql(`-- Roles this role belongs to\nSELECT \n m.rolname as "Member Of",\n g.rolname as "Granted By",\n am.admin_option as "Admin Option"\nFROM pg_auth_members am\nJOIN pg_roles r ON r.oid = am.member\nJOIN pg_roles m ON m.oid = am.roleid\nJOIN pg_roles g ON g.oid = am.grantor\nWHERE r.rolname = '${item.label}';\n\n-- Roles that belong to this role\nSELECT \n m.rolname as "Has Member",\n g.rolname as "Granted By",\n am.admin_option as "Admin Option"\nFROM pg_auth_members am\nJOIN pg_roles r ON r.oid = am.roleid\nJOIN pg_roles m ON m.oid = am.member\nJOIN pg_roles g ON g.oid = am.grantor\nWHERE r.rolname = '${item.label}';`) - .addMarkdown('##### 🔑 Granted Privileges') - .addSql(`-- Table privileges\nSELECT \n table_schema as "Schema",\n table_name as "Table",\n privilege_type as "Privilege",\n is_grantable as "Grantable"\nFROM information_schema.table_privileges\nWHERE grantee = '${item.label}'\nORDER BY table_schema, table_name, privilege_type;\n\n-- Schema privileges\nSELECT \n n.nspname as "Schema",\n 'USAGE' as "Privilege"\nFROM pg_namespace n\nWHERE has_schema_privilege('${item.label}', n.nspname, 'USAGE')\nAND n.nspname NOT LIKE 'pg_%'\nAND n.nspname != 'information_schema';`) - .addMarkdown('##### ✏️ Modify Role') - .addSql(`-- Modify role attributes\nALTER ROLE ${item.label}\n -- Uncomment and modify:\n -- WITH PASSWORD 'new_password'\n -- SUPERUSER | NOSUPERUSER\n -- CREATEDB | NOCREATEDB\n -- CREATEROLE | NOCREATEROLE\n -- LOGIN | NOLOGIN\n -- VALID UNTIL '2025-12-31'\n;`) - .addMarkdown('##### 🔑 Change Password') - .addSql(`-- Change role password\nALTER ROLE ${item.label} WITH PASSWORD 'new_secure_password';\n\n-- Set password with expiration\n-- ALTER ROLE ${item.label} WITH PASSWORD 'new_password' VALID UNTIL '2025-12-31';`) - .addMarkdown(MarkdownUtils.dangerBox('The following operation is destructive and cannot be undone.') + '\n\n##### ❌ Drop Role') - .addSql(`-- Reassign owned objects first\n-- REASSIGN OWNED BY ${item.label} TO postgres;\n\n-- Drop owned objects\n-- DROP OWNED BY ${item.label};\n\n-- Drop the role\n-- DROP ROLE ${item.label};`) + .addMarkdown(`### 🛠️ Role Operations: \`${item.label}\`\n\nCommon operations for this PostgreSQL role.`) + .addMarkdown('##### 🔍 Role Attributes') + .addSql(`-- View role attributes +SELECT + r.rolname as "Name", + r.rolsuper as "Superuser", + r.rolinherit as "Inherit", + r.rolcreaterole as "Create Role", + r.rolcreatedb as "Create DB", + r.rolcanlogin as "Can Login", + r.rolreplication as "Replication", + r.rolconnlimit as "Connection Limit", + r.rolvaliduntil as "Valid Until", + r.rolbypassrls as "Bypass RLS", + pg_catalog.shobj_description(r.oid, 'pg_authid') as "Description" +FROM pg_roles r +WHERE r.rolname = '${item.label}';`) + .addMarkdown('##### ✏️ ALTER ROLE') + .addSql(UserRoleSQL.alterRole(item.label)) + .addMarkdown('##### 🔐 GRANT Privileges') + .addSql(UserRoleSQL.grant(item.label)) + .addMarkdown('##### ❌ DROP ROLE — ⚠️ Warning: permanently deletes the role') + .addSql(UserRoleSQL.dropRole(item.label)) .show(); } catch (err: any) { await ErrorHandlers.handleCommandError(err, 'show role operations'); @@ -341,11 +309,24 @@ export async function viewRoleDependencies(item: DatabaseTreeItem): Promise { await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📖 SELECT Script: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Execute the query below to retrieve data from the view.') - ) - .addSql(`SELECT * FROM ${item.schema}.${item.label} LIMIT 100;`) + .addMarkdown(`### 📖 SELECT Script: \`${item.schema}.${item.label}\`\n\nQuery data from the view.`) + .addSql(ViewSQL.select(item.schema!, item.label)) .show(); }); } /** - * cmdScriptCreate - Command to generate a CREATE script for a view + * cmdScriptCreate - Delegates to cmdEditView to fetch the actual view definition */ export async function cmdScriptCreate(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await cmdEditView(item, context); } /** - * viewEditCmd - Command to edit a PostgreSQL view in a notebook. - * @param {DatabaseTreeItem} item - The selected view item in the database tree. - * @param {vscode.ExtensionContext} context - The extension context. - * @returns {Promise} - A promise that resolves when the notebook is created and displayed. + * cmdEditView - Fetches the actual view definition from the DB and opens it for editing. + * Kept as-is: it queries the live definition, not a template. */ export async function cmdEditView(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create view edit notebook', async (conn: any, client: any, metadata: any) => { @@ -60,10 +44,7 @@ export async function cmdEditView(item: DatabaseTreeItem, context: vscode.Extens const createViewStatement = `CREATE OR REPLACE VIEW ${item.schema}.${item.label} AS\n${viewResult.rows[0].definition} `; await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`✏️ Edit View: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Modify the view definition below and execute the cell to update the view.') - ) + .addMarkdown(`### ✏️ Edit View: \`${item.schema}.${item.label}\`\n\nModify the view definition below and execute to update.`) .addMarkdown('##### 📝 View Definition') .addSql(createViewStatement) .show(); @@ -71,110 +52,54 @@ export async function cmdEditView(item: DatabaseTreeItem, context: vscode.Extens } /** - * viewViewDataCmd - Command to view data from a PostgreSQL view in a notebook. - * @param {DatabaseTreeItem} item - The selected view item in the database tree. - * @param {vscode.ExtensionContext} context - The extension context. - * @returns {Promise} - A promise that resolves when the notebook is created and displayed. + * cmdViewData - Single-operation notebook: SELECT from view */ export async function cmdViewData(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create view data notebook', async (conn: any, client: any, metadata: any) => { await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`📖 View Data: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('Modify the query below to filter or transform the data as needed.') - ) - .addMarkdown('##### 📖 Query Data') - .addSql(ViewSQL.viewData(item.schema!, item.label)) + .addMarkdown(`### 📖 View Data: \`${item.schema}.${item.label}\`\n\nQuery data from the view.`) + .addSql(ViewSQL.select(item.schema!, item.label)) .show(); }); } /** - * viewDropCmd - Command to drop a PostgreSQL view in a notebook. - * @param {DatabaseTreeItem} item - The selected view item in the database tree. - * @param {vscode.ExtensionContext} context - The extension context. - * @returns {Promise} - A promise that resolves when the notebook is created and displayed. + * cmdDropView - Single-operation notebook: DROP view */ export async function cmdDropView(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create drop view notebook', async (conn: any, client: any, metadata: any) => { await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`❌ Drop View: \`${item.schema}.${item.label}\``) + - MarkdownUtils.dangerBox('This action will permanently delete the view. This operation cannot be undone.') - ) - .addMarkdown('##### ❌ Drop Command') - .addSql(SQL_TEMPLATES.DROP.VIEW(item.schema!, item.label)) + .addMarkdown(`### ❌ Drop View: \`${item.schema}.${item.label}\`\n\n⚠️ **Warning:** This permanently deletes the view and cannot be undone.`) + .addSql(ViewSQL.drop(item.schema!, item.label)) .show(); }); } /** - * viewOperationsCmd - Command to create a notebook for common operations on a PostgreSQL view. - * @param {DatabaseTreeItem} item - The selected view item in the database tree. - * @param {vscode.ExtensionContext} context - The extension context. - * @returns {Promise} - A promise that resolves when the notebook is created and displayed. + * cmdViewOperations - Operations_Notebook for a view. + * Cell order: read (SELECT, definition) → write/modify (CREATE OR REPLACE) → destructive (DROP) */ export async function cmdViewOperations(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create view operations notebook', async (conn: any, client: any, metadata: any) => { - const viewResult = await client.query(QueryBuilder.viewDefinition(item.schema!, item.label)); - if (!viewResult.rows[0]?.definition) { - throw new Error('View definition not found'); - } - - // Get column information - const columnsResult = await client.query(QueryBuilder.columns(item.schema!, item.label)); - const columns = columnsResult.rows; - - const viewDefinition = `CREATE OR REPLACE VIEW ${item.schema}.${item.label} AS\n${viewResult.rows[0].definition} `; - await new NotebookBuilder(metadata) - .addMarkdown( - MarkdownUtils.header(`👁️ View Operations: \`${item.schema}.${item.label}\``) + - MarkdownUtils.infoBox('This notebook contains common operations for the PostgreSQL view. Run the cells below to execute the operations.') + - `\n\n#### 📋 View Information\n\n` + - MarkdownUtils.propertiesTable({ - 'Schema': item.schema || '', - 'View Name': item.label, - 'Column Count': `${columns.length}` - }) + - `\n\n#### 🎯 Available Operations\n\n` + - MarkdownUtils.operationsTable([ - { operation: '📋 View Columns', description: 'Display column definitions' }, - { operation: '📝 View Definition', description: 'Show the CREATE VIEW statement' }, - { operation: '📖 Query Data', description: 'Select the first 100 rows' }, - { operation: '🔍 Query with Filters', description: 'Advanced SELECT with WHERE clause' }, - { operation: '📊 Query with Aggregation', description: 'Group and aggregate data' }, - { operation: '✏️ Modify Definition', description: 'Template for updating the view' }, - { operation: '❌ Drop', description: 'Delete the view (Warning: Irreversible)' } - ]) - ) - .addMarkdown('##### 📋 View Columns') - .addSql(ViewSQL.columns(item.schema!, item.label)) - .addMarkdown('##### 📝 View Definition') - .addSql(`-- View definition\n${viewDefinition} `) - .addMarkdown('##### 📖 Query Data') - .addSql(`-- Query view data\nSELECT *\nFROM ${item.schema}.${item.label}\nLIMIT 100;`) - .addMarkdown('##### 🔍 Query with Filters') - .addSql(ViewSQL.queryWithFilters(item.schema!, item.label)) - .addMarkdown('##### 📊 Query with Aggregation') - .addSql(ViewSQL.queryWithAggregation(item.schema!, item.label)) - .addMarkdown('##### ✏️ Modify Definition') - .addSql(ViewSQL.modifyDefinition(item.schema!, item.label)) - .addMarkdown('##### ❌ Drop View') - .addSql(SQL_TEMPLATES.DROP.VIEW(item.schema!, item.label)) + .addMarkdown(`### 👁️ View Operations: \`${item.schema}.${item.label}\`\n\nCommon operations for this PostgreSQL view.`) + .addMarkdown('##### 📖 SELECT') + .addSql(ViewSQL.select(item.schema!, item.label)) + .addMarkdown('##### 📝 Definition') + .addSql(ViewSQL.definition(item.schema!, item.label)) + .addMarkdown('##### ✏️ CREATE OR REPLACE') + .addSql(ViewSQL.createOrReplace(item.schema!, item.label)) + .addMarkdown('##### ❌ DROP — ⚠️ Warning: permanently deletes the view') + .addSql(ViewSQL.drop(item.schema!, item.label)) .show(); }); } /** - * Show properties of a PostgreSQL view. - * @param {DatabaseTreeItem} item - The selected view item in the database tree. - * @param {vscode.ExtensionContext} context - The extension context. - * @returns {Promise} - A promise that resolves when the properties are shown. + * cmdShowViewProperties - Properties panel for a view. Kept as-is. */ export async function cmdShowViewProperties(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'view properties', async (conn: any, client: any, metadata: any) => { - // Gather comprehensive view information const [viewInfo, columnInfo, dependenciesInfo, referencedInfo, sizeInfo] = await Promise.all([ client.query(QueryBuilder.viewInfo(item.schema!, item.label)), client.query(QueryBuilder.tableColumns(item.schema!, item.label)), @@ -189,11 +114,9 @@ export async function cmdShowViewProperties(item: DatabaseTreeItem, context: vsc const references = referencedInfo.rows; const sizes = sizeInfo.rows[0]; - // Get view definition const viewDefResult = await client.query(`SELECT pg_get_viewdef($1::regclass, true) as definition`, [`${item.schema}.${item.label}`]); const viewDefinition = viewDefResult.rows[0]?.definition || ''; - // Build column table HTML const columnRows = columns.map((col: any) => { const dataType = col.character_maximum_length ? `${col.data_type}(${col.character_maximum_length})` @@ -204,35 +127,25 @@ export async function cmdShowViewProperties(item: DatabaseTreeItem, context: vsc ${col.ordinal_position} ${col.column_name} ${dataType} - ${FormatHelpers.formatBoolean(col.is_nullable === 'YES')} + ${col.is_nullable === 'YES' ? 'YES' : 'NO'} ${col.column_default ? `${col.column_default}` : '—'} ${col.description || '—'} `; }).join('\n'); - // Build dependencies table HTML - const dependencyRows = dependents.map((dep: any) => { - return ` - ${ObjectUtils.getKindLabel(dep.kind)} - ${dep.schema}.${dep.name} - `; - }).join('\n'); + const dependencyRows = dependents.map((dep: any) => + ` ${dep.kind}${dep.schema}.${dep.name}` + ).join('\n'); - // Build references table HTML - const referenceRows = references.map((ref: any) => { - return ` - ${ObjectUtils.getKindLabel(ref.kind)} - ${ref.schema}.${ref.name} - `; - }).join('\n'); + const referenceRows = references.map((ref: any) => + ` ${ref.kind}${ref.schema}.${ref.name}` + ).join('\n'); - // Build CREATE VIEW script const createViewScript = `-- DROP VIEW IF EXISTS ${item.schema}.${item.label}; CREATE OR REPLACE VIEW ${item.schema}.${item.label} AS ${viewDefinition}; --- View comment ${view.comment ? `COMMENT ON VIEW ${item.schema}.${item.label} IS '${view.comment.replace(/'/g, "''")}';` : `-- COMMENT ON VIEW ${item.schema}.${item.label} IS 'view description';`}`; const ownerInfo = view.owner + (view.comment ? ` | Comment: ${view.comment}` : ''); @@ -286,19 +199,18 @@ ${MarkdownUtils.infoBox('Objects that depend on this view (other views that refe ${dependencyRows} -` : '') + - '---'; +` : ''); await new NotebookBuilder(metadata) .addMarkdown(markdown) .addMarkdown('##### 📝 CREATE VIEW Script') .addSql(createViewScript) - .addMarkdown('##### 🗑️ DROP VIEW Script') - .addSql(`${SQL_TEMPLATES.DROP.VIEW(item.schema!, item.label)}\n\n-- Drop view (with dependencies)\n-- DROP VIEW IF EXISTS ${item.schema}.${item.label} CASCADE;\n\n-- Drop view (without dependencies - will fail if referenced)\n-- DROP VIEW IF EXISTS ${item.schema}.${item.label} RESTRICT;`) - .addMarkdown('##### 🔍 Query View Data') - .addSql(`-- Select all data from view\nSELECT * FROM ${item.schema}.${item.label}\nLIMIT 100;`) + .addMarkdown('##### ❌ DROP VIEW Script — ⚠️ Warning: permanently deletes the view') + .addSql(ViewSQL.drop(item.schema!, item.label)) + .addMarkdown('##### 📖 Query View Data') + .addSql(ViewSQL.select(item.schema!, item.label)) .addMarkdown('##### 📊 View Definition Details') - .addSql(ViewSQL.definitionDetails(item.schema!, item.label)) + .addSql(ViewSQL.definition(item.schema!, item.label)) .show(); }); } @@ -311,49 +223,15 @@ export async function cmdRefreshView(item: DatabaseTreeItem, context: vscode.Ext } /** - * cmdCreateView - Command to create a new view in the database. + * cmdCreateView - Single-cell notebook with CREATE OR REPLACE VIEW template. */ export async function cmdCreateView(item: DatabaseTreeItem, context: vscode.ExtensionContext) { await CommandBase.run(context, item, 'create view notebook', async (conn: any, client: any, metadata: any) => { const schema = item.schema!; - const markdown = MarkdownUtils.header(`➕ Create New View in Schema: \`${schema}\``) + - MarkdownUtils.infoBox('This notebook provides templates for creating views. Modify the templates below and execute to create views.') + - `\n\n#### 📋 View Design Guidelines\n\n` + - MarkdownUtils.operationsTable([ - { operation: 'Naming', description: 'Use snake_case for view names (e.g., user_summary, order_details)' }, - { operation: 'Purpose', description: 'Views simplify complex queries, provide abstraction, or enforce security' }, - { operation: 'Performance', description: 'Views don\'t store data; queries execute against underlying tables' }, - { operation: 'Materialized Views', description: 'For better performance, consider materialized views for expensive queries' }, - { operation: 'Security', description: 'Use views to restrict column/row access without modifying base tables' } - ]) + - `\n\n#### 🏷️ Common View Patterns\n\n` + - MarkdownUtils.propertiesTable({ - 'Simple View': 'SELECT columns FROM single table', - 'Joined View': 'JOIN multiple tables for simplified access', - 'Aggregated View': 'GROUP BY with aggregate functions', - 'Filtered View': 'WHERE clause to show subset of data', - 'Computed View': 'Calculated columns and expressions', - 'Security View': 'Row-level security with WHERE conditions' - }) + - MarkdownUtils.successBox('Views are updated automatically when underlying tables change. Use CREATE OR REPLACE to modify existing views.') + - `\n\n---`; - await new NotebookBuilder(metadata) - .addMarkdown(markdown) - .addMarkdown('##### 📝 Basic View (Recommended Start)') - .addSql(ViewSQL.create.basic(schema)) - .addMarkdown('##### 🔗 Joined View') - .addSql(ViewSQL.create.joined(schema)) - .addMarkdown('##### 📊 Aggregated View') - .addSql(ViewSQL.create.aggregated(schema)) - .addMarkdown('##### 🔒 Security View (Row-Level Access)') - .addSql(ViewSQL.create.security(schema)) - .addMarkdown('##### 🧮 Computed View (Calculated Columns)') - .addSql(ViewSQL.create.computed(schema)) - .addMarkdown('##### 🔄 Recursive View (CTE)') - .addSql(ViewSQL.create.recursive(schema)) - .addMarkdown(MarkdownUtils.warningBox('After creating a view, remember to: 1) Test the view with sample queries, 2) Add appropriate indexes on underlying tables if needed, 3) Grant necessary permissions to roles, 4) Consider materialized views for expensive queries.')) + .addMarkdown(`### ➕ Create New View in Schema: \`${schema}\`\n\nCreate or replace a view using the template below.`) + .addSql(ViewSQL.createOrReplace(schema, 'new_view')) .show(); }); -} \ No newline at end of file +} diff --git a/src/common/htmlStyles.ts b/src/common/htmlStyles.ts index 789d91a..a6550a6 100644 --- a/src/common/htmlStyles.ts +++ b/src/common/htmlStyles.ts @@ -1,8 +1,137 @@ /** * Common HTML/CSS styles and utilities for consistent UI across the extension * This module provides reusable style definitions and HTML template builders + * + * Design system: + * - 4px base unit: 8px internal padding, 16px between sections, 24px between groups + * - Typography: section headers 12px/500, body 12–13px/400, meta/labels 11px/400 muted + * - Destructive actions: always text-danger colored, never primary button + * - Hover affordance: contextual actions visible only on row hover + * - Loading: pulsing skeleton shimmer, no spinner-in-blank-space + * - Empty states: 1-line prompt + single CTA button + * - Tooltips: title attribute on all icon-only buttons */ +/** + * Shared CSS block injected into every webview @@ -441,7 +510,7 @@ export class ConnectionManagementPanel {

    Connection Management

    Manage your PostgreSQL database connections

    @@ -456,7 +525,7 @@ export class ConnectionManagementPanel { function addConnection() { vscode.postMessage({ command: 'addConnection' }); } - + function editConnection(id) { vscode.postMessage({ command: 'edit', id: id }); } @@ -467,27 +536,22 @@ export class ConnectionManagementPanel { function testConnection(id) { const btn = document.querySelector(\`[data-test-id="\${id}"]\`); - const originalText = btn.innerHTML; - btn.textContent = 'Testing...'; + btn.textContent = 'Testing…'; btn.disabled = true; - vscode.postMessage({ command: 'test', id: id }); - - // Store original text - btn.setAttribute('data-original-text', originalText); } - + function showDeleteConfirm(id) { const card = document.querySelector(\`[data-card-id="\${id}"]\`); if (card.querySelector('.delete-confirm-overlay')) return; - + const overlay = document.createElement('div'); overlay.className = 'delete-confirm-overlay'; overlay.innerHTML = \`

    Delete this connection?

    - - + +
    \`; card.appendChild(overlay); @@ -499,103 +563,112 @@ export class ConnectionManagementPanel { window.addEventListener('message', event => { const message = event.data; - + if (message.type === 'testSuccess') { const btn = document.querySelector(\`[data-test-id="\${message.id}"]\`); const card = document.querySelector(\`[data-card-id="\${message.id}"]\`); - - btn.innerHTML = 'Scan ✓'; + btn.textContent = 'Test'; btn.disabled = false; - - showNotification(card, 'Connection successful!', 'success'); - - setTimeout(() => { - const original = btn.getAttribute('data-original-text'); - if(original) btn.innerHTML = original; - }, 3000); + showToast(card, '✓ Connected', 'success'); } else if (message.type === 'testError') { - const btn = document.querySelector(\`[data-test-id="\${message.id}"]\`); + const btn = document.querySelector(\`[data-test-id="\${message.id}"]\`); const card = document.querySelector(\`[data-card-id="\${message.id}"]\`); - - btn.innerHTML = 'Error ✕'; + btn.textContent = 'Test'; btn.disabled = false; - - showNotification(card, message.error, 'error'); - setTimeout(() => { - const original = btn.getAttribute('data-original-text'); - if(original) btn.innerHTML = original; - }, 3000); + showToast(card, '✕ ' + (message.error || 'Failed'), 'error'); } }); - - function showNotification(card, text, type) { - const existing = card.querySelector('.test-result-overlay'); - if(existing) existing.remove(); - + + function showToast(card, text, type) { + const existing = card.querySelector('.test-toast'); + if (existing) existing.remove(); + const el = document.createElement('div'); - el.className = \`test-result-overlay \${type}\`; + el.className = 'test-toast ' + type; el.textContent = text; card.appendChild(el); - el.style.display = 'block'; - + setTimeout(() => { + el.style.transition = 'opacity 0.3s'; el.style.opacity = '0'; setTimeout(() => el.remove(), 300); - }, 4000); + }, 3500); } `; } - private _getConnectionCardHtml(conn: ConnectionInfo & { hasPassword: boolean }): string { - const connectionString = this._buildConnectionString(conn); - const authStatus = conn.hasPassword || conn.username - ? 'Auth ✓' - : 'No Auth'; + /** + * Attempts a quick TCP connection to the host:port to determine reachability. + * Times out after 3 seconds to keep the panel load fast. + */ + private async _probeConnection(conn: ConnectionInfo, password?: string): Promise { + return new Promise((resolve) => { + const net = require('net') as typeof import('net'); + const socket = new net.Socket(); + const timeout = 3000; + let settled = false; + const done = (result: boolean) => { + if (settled) { return; } + settled = true; + socket.destroy(); + resolve(result); + }; + socket.setTimeout(timeout); + socket.on('connect', () => done(true)); + socket.on('timeout', () => done(false)); + socket.on('error', () => done(false)); + socket.connect(conn.port || 5432, conn.host || 'localhost'); + }); + } - // Escaping helper + private _getConnectionCardHtml(conn: ConnectionInfo & { hasPassword: boolean; isReachable: boolean }): string { const escape = (s: string | undefined) => this._escapeHtml(s || ''); + // Derive env class from connection name (case-insensitive keywords) + const nameLower = (conn.name || '').toLowerCase(); + let envClass = ''; + if (/prod|production/.test(nameLower)) { envClass = 'env-prod'; } + else if (/stag|staging|uat/.test(nameLower)) { envClass = 'env-staging'; } + else if (/dev|local|test/.test(nameLower)) { envClass = 'env-dev'; } + + // Status pill based on actual TCP reachability + const pillClass = conn.isReachable ? 'live' : 'offline'; + const pillLabel = conn.isReachable ? 'Live' : 'Down'; + return ` -
    +
    - 🗄️ + 🗄️ ${escape(conn.name)}
    -
    - Live - ${authStatus} -
    + + ${pillLabel} +
    - Host: + Host ${escape(conn.host)}:${conn.port}
    - Database: + Database ${escape(conn.database)}
    - User: + User ${escape(conn.username)}
    - - - + + +
    `; } diff --git a/src/dashboard/DashboardHtml.ts b/src/dashboard/DashboardHtml.ts index 3c74ac0..a1a61f0 100644 --- a/src/dashboard/DashboardHtml.ts +++ b/src/dashboard/DashboardHtml.ts @@ -15,43 +15,24 @@ export async function getHtmlForWebview(webview: vscode.Webview, extensionUri: v let html = new TextDecoder().decode(htmlBuffer); const css = new TextDecoder().decode(cssBuffer); - let js = new TextDecoder().decode(jsBuffer); + const js = new TextDecoder().decode(jsBuffer); // Security: Content Security Policy const csp = `default-src 'none'; img-src ${cspSource} https:; style-src ${cspSource} 'unsafe-inline'; script-src 'nonce-${nonce}' https://cdn.jsdelivr.net;`; - // Inject Data safely - js = js.replace('null; // __STATS_JSON__', JSON.stringify(stats)); - - console.log('DashboardHtml: Loaded resources. HTML length:', html.length, 'CSS length:', css.length, 'JS length:', js.length); - - // Inject content - // Use replacer function to avoid special replacement patterns (like $&) in the code/css - // Inject content with flexible Regex: matches {{NAME}}, { { NAME } }, or /* NAME */ - const replacePlaceholder = (name: string, value: string) => { - // Regex explanation: - // 1. (?:\s*\{\s*\{\s*${name}\s*\}\s*\}\s*) -> Matches curly braces with optional whitespace/split - // 2. (?:\/\*\s*${name}\s*\*\/) -> Matches /* NAME */ comments - const regex = new RegExp(`(?:\\{\\s*\\{\\s*${name}\\s*\\}\\s*\\}|\\/\\*\\s*${name}\\s*\\*\\/)`); - - if (regex.test(html)) { - html = html.replace(regex, () => value); - console.log(`DashboardHtml: Successfully replaced ${name}`); - } else { - console.error(`DashboardHtml: Placeholder ${name} NOT found! Regex: ${regex.source}`); - // Log start and end of HTML to debug - console.log('DashboardHtml Head (500 chars):', html.substring(0, 500)); - console.log('DashboardHtml Tail (500 chars):', html.substring(html.length - 500)); - } - }; + const statsJson = JSON.stringify(stats) + .replace(/&/g, '\\u0026') + .replace(//g, '\\u003e') + .replace(/\u2028/g, '\\u2028') + .replace(/\u2029/g, '\\u2029'); html = html.replace('{{CSP}}', () => csp); - replacePlaceholder('INLINE_STYLES', css); - replacePlaceholder('INLINE_SCRIPTS', js); - + html = html.replace('{{STATS_JSON}}', () => statsJson); + html = html.replace('{{INLINE_STYLES}}', () => css); + html = html.replace('{{INLINE_SCRIPTS}}', () => js); html = html.replace('{{NONCE}}', () => nonce); - console.log('DashboardHtml: Final HTML length:', html.length); return html; } catch (error) { console.error('Failed to load dashboard templates:', error); diff --git a/src/extension.ts b/src/extension.ts index 13a13c1..4558d58 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -6,7 +6,8 @@ import { ConnectionManager } from './services/ConnectionManager'; import { SecretStorageService } from './services/SecretStorageService'; import { ProfileManager } from './services/ProfileManager'; import { SavedQueriesService } from './services/SavedQueriesService'; -import { ErrorHandlers } from './commands/helper'; +import { ErrorHandlers, NotebookBuilder } from './commands/helper'; +import { SessionRegistry } from './services/SessionRegistry'; import { registerProviders } from './activation/providers'; import { registerAllCommands } from './activation/commands'; import { NotebookStatusBar } from './activation/statusBar'; @@ -21,7 +22,7 @@ import { ExplainErrorHandler, FixQueryHandler, AnalyzeDataHandler, OptimizeQueryHandler, SendToChatHandler, ShowExplainPlanHandler, ConvertExplainHandler } from './services/handlers/ExplainHandlers'; -import { ShowConnectionSwitcherHandler, ShowDatabaseSwitcherHandler, ShowErrorMessageHandler, ExportRequestHandler } from './services/handlers/CoreHandlers'; +import { ShowConnectionSwitcherHandler, ShowDatabaseSwitcherHandler, ShowErrorMessageHandler, ExportRequestHandler, RetryCellHandler, ShowConnectionInfoHandler } from './services/handlers/CoreHandlers'; import { ExecuteUpdateBackgroundHandler, ScriptDeleteHandler, SaveChangesHandler } from './services/handlers/QueryHandlers'; export let outputChannel: vscode.OutputChannel; @@ -30,12 +31,54 @@ export let statusBar: NotebookStatusBar; let chatViewProvider: ChatViewProvider | undefined; +function isAzurePostgresHost(host?: string): boolean { + if (!host) { + return false; + } + + const normalizedHost = host.toLowerCase(); + return normalizedHost.includes('postgres.database.azure.com'); +} + +function migrateLegacyAzureConnectionTimeouts(connections: any[]): { connections: any[]; migratedCount: number } { + let migratedCount = 0; + + const migratedConnections = connections.map((connection) => { + // Legacy Azure connections from v0.8.8 commonly carried a 5s default timeout. + if (isAzurePostgresHost(connection.host) && connection.connectTimeout === 5) { + migratedCount++; + return { ...connection, connectTimeout: 15 }; + } + + return connection; + }); + + return { connections: migratedConnections, migratedCount }; +} + export function getChatViewProvider(): ChatViewProvider | undefined { return chatViewProvider; } export async function activate(context: vscode.ExtensionContext) { extensionContext = context; + + // Provide extension context to NotebookBuilder for persistent session support (Req 5.4) + NotebookBuilder.setContext(context); + + // Clean up SessionRegistry when a scratch notebook is closed (Req 6.1, 6.2) + context.subscriptions.push( + vscode.workspace.onDidCloseNotebookDocument((closedDoc) => { + const closedUri = closedDoc.uri.toString(); + for (const [connectionId, doc] of SessionRegistry.entries()) { + if (doc.uri.toString() === closedUri) { + SessionRegistry.delete(connectionId); + break; + } + } + }) + ); + outputChannel = vscode.window.createOutputChannel('PgStudio'); outputChannel.appendLine('Activating PgStudio extension'); @@ -63,18 +106,32 @@ export async function activate(context: vscode.ExtensionContext) { console.log('Migrated legacy connections to include IDs'); } + const azureTimeoutMigrationKey = 'postgresExplorer.migrations.azureConnectionTimeouts.v0_8_9'; + const azureTimeoutMigrationDone = context.globalState.get(azureTimeoutMigrationKey, false); + + if (!azureTimeoutMigrationDone) { + const timeoutMigration = migrateLegacyAzureConnectionTimeouts(migratedConnections); + if (timeoutMigration.migratedCount > 0) { + await config.update('postgresExplorer.connections', timeoutMigration.connections, vscode.ConfigurationTarget.Global); + console.log(`Migrated ${timeoutMigration.migratedCount} Azure connection(s) to a 15 second timeout`); + } + + await context.globalState.update(azureTimeoutMigrationKey, true); + } + // Phase 7: Initialize ProfileManager and SavedQueriesService ProfileManager.getInstance().initialize(context); SavedQueriesService.getInstance().initialize(context); await ProfileManager.getInstance().initializeDefaultProfiles(); - const { databaseTreeProvider, treeView, chatViewProviderInstance: chatView, savedQueriesTreeProvider } = registerProviders(context, outputChannel); + const { databaseTreeProvider, treeView, chatViewProviderInstance: chatView, savedQueriesTreeProvider, notebooksTreeProvider, autoRefreshService } = registerProviders(context, outputChannel); + context.subscriptions.push(autoRefreshService); chatViewProvider = chatView; // Store tree view instance for reveal functionality (databaseTreeProvider as any).setTreeView(treeView); - registerAllCommands(context, databaseTreeProvider, chatView, outputChannel, savedQueriesTreeProvider); + registerAllCommands(context, databaseTreeProvider, chatView, outputChannel, savedQueriesTreeProvider, notebooksTreeProvider); // Kernel initialization const rendererMessaging = vscode.notebooks.createRendererMessaging('postgres-query-renderer'); @@ -97,6 +154,8 @@ export async function activate(context: vscode.ExtensionContext) { void whatsNewManager.checkAndShow(true); }) ); + // Auto-open once on install/update; manager tracks the last shown version in global state. + void whatsNewManager.checkAndShow(false); const queryKernel = new PostgresKernel(context, rendererMessaging, 'postgres-query'); @@ -121,6 +180,8 @@ export async function activate(context: vscode.ExtensionContext) { registry.register('showDatabaseSwitcher', new ShowDatabaseSwitcherHandler(statusBar)); registry.register('showErrorMessage', new ShowErrorMessageHandler()); registry.register('export_request', new ExportRequestHandler()); + registry.register('retryCell', new RetryCellHandler()); + registry.register('showConnectionInfo', new ShowConnectionInfoHandler()); // Query Execution Handlers registry.register('execute_update_background', new ExecuteUpdateBackgroundHandler()); @@ -134,6 +195,16 @@ export async function activate(context: vscode.ExtensionContext) { }); }); + // Auto-generate notebook title on open + const { updateNotebookTitle } = await import('./utils/notebookTitle'); + context.subscriptions.push( + vscode.workspace.onDidOpenNotebookDocument(async (notebook) => { + if (notebook.notebookType === 'postgres-notebook' || notebook.notebookType === 'postgres-query') { + await updateNotebookTitle(notebook); + } + }) + ); + const { migrateExistingPasswords } = await import('./services/SecretStorageService'); await migrateExistingPasswords(context); } diff --git a/src/providers/ChatViewProvider.ts b/src/providers/ChatViewProvider.ts index b4a84af..f902dfa 100644 --- a/src/providers/ChatViewProvider.ts +++ b/src/providers/ChatViewProvider.ts @@ -30,6 +30,10 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { private _messages: ChatMessage[] = []; private _isProcessing = false; + // Phase C: Track current connection/database context for session metadata + private _currentConnectionName: string | undefined; + private _currentDatabase: string | undefined; + // Services private _dbObjectService: DbObjectService; private _aiService: AiService; @@ -282,6 +286,9 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { case 'openInNotebook': await this._handleOpenInNotebook(data.code); break; + case 'previewFile': + await this._handlePreviewFile(data.path, data.name); + break; } }); } @@ -308,8 +315,10 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { let fullMessage = message; if (attachments && attachments.length > 0) { const attachmentLinks = attachments.map(att => { + if (att.type === 'image') { + return `\n\n🖼️ **Image:** ${att.name}`; + } if (att.path) { - // If path exists, create a clickable link (using file URI scheme) return `\n\n📎 [${att.name}](${vscode.Uri.file(att.path).toString()})`; } else { return `\n\n📎 **Attached:** ${att.name}`; @@ -321,9 +330,12 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { // For AI (current turn), we need the full content let aiMessage = message; if (attachments && attachments.length > 0) { - const attachmentContent = attachments.map(att => - `\n\nFile: ${att.name} (${att.type})\n\`\`\`${att.type}\n${att.content}\n\`\`\`` - ).join(''); + const attachmentContent = attachments.map(att => { + if (att.type === 'image') { + return `\n\n[Image attached: ${att.name}]`; + } + return `\n\nFile: ${att.name} (${att.type})\n\`\`\`${att.type}\n${att.content}\n\`\`\``; + }).join(''); aiMessage = message + attachmentContent; } @@ -331,6 +343,15 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { // aiMessage already has attachments, now add schema context if (mentions && mentions.length > 0) { console.log('[ChatView] Processing mentions for schema context...'); + + // Phase C: Capture connection context from first mention + if (mentions[0]) { + this._currentDatabase = mentions[0].database; + // Note: connectionName might not be populated in DbMention, so we use connectionId as fallback + this._currentConnectionName = mentions[0].breadcrumb?.split('.')[0] || mentions[0].connectionId; + this._sendContextUpdate(); + } + let schemaContext = '\n\n=== DATABASE SCHEMA CONTEXT (Use this information to answer the question) ===\n'; for (const mention of mentions) { @@ -402,6 +423,7 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { this._aiService.setMessages(this._messages); let responseText: string; let usageInfo: string | undefined; + const aiStartTime = Date.now(); if (provider === 'vscode-lm') { console.log('[ChatView] Calling VS Code LM API...'); @@ -415,6 +437,13 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { usageInfo = result.usage; } + const aiElapsed = ((Date.now() - aiStartTime) / 1000).toFixed(1); + if (usageInfo) { + usageInfo = `${usageInfo} · ${aiElapsed}s`; + } else { + usageInfo = `${aiElapsed}s`; + } + console.log('[ChatView] AI response received, length:', responseText.length); // Sanitize response - remove any HTML-like patterns that shouldn't be there @@ -563,7 +592,8 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { file: { name: fileName, content: truncatedContent, - type: this._getFileType(fileName) + type: this._getFileType(fileName), + path: fileUri[0].fsPath } }); } catch (error) { @@ -572,6 +602,15 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { } } + private async _handlePreviewFile(filePath: string, fileName: string): Promise { + try { + const uri = vscode.Uri.file(filePath); + await vscode.commands.executeCommand('vscode.open', uri, { preview: true }); + } catch (error) { + vscode.window.showErrorMessage(`Could not open file: ${fileName}`); + } + } + private _getFileType(fileName: string): string { const ext = fileName.split('.').pop()?.toLowerCase() || ''; const typeMap: { [key: string]: string } = { @@ -634,9 +673,14 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { const config = vscode.workspace.getConfiguration('postgresExplorer'); const provider = config.get('aiProvider') || 'vscode-lm'; + // Phase C: Pass metadata to session service await this._sessionService.saveSession( this._messages, - (msg) => this._aiService.generateTitle(msg, provider) + (msg) => this._aiService.generateTitle(msg, provider), + { + connectionName: this._currentConnectionName, + database: this._currentDatabase + } ); this._sendHistoryToWebview(); } @@ -672,6 +716,17 @@ export class ChatViewProvider implements vscode.WebviewViewProvider { } } + // Phase C: Send context bar update to webview + private _sendContextUpdate(): void { + if (this._view) { + this._view.webview.postMessage({ + type: 'contextUpdate', + connectionName: this._currentConnectionName || null, + database: this._currentDatabase || null + }); + } + } + // ==================== UI Helpers ==================== private _updateChatHistory(): void { diff --git a/src/providers/DatabaseTreeProvider.ts b/src/providers/DatabaseTreeProvider.ts index 148eb9d..cd82761 100644 --- a/src/providers/DatabaseTreeProvider.ts +++ b/src/providers/DatabaseTreeProvider.ts @@ -4,6 +4,7 @@ import * as path from 'path'; import { ConnectionManager } from '../services/ConnectionManager'; import { getSchemaCache, SchemaCache } from '../lib/schema-cache'; import { Debouncer } from '../lib/debounce'; +import { AutoRefreshService } from '../services/AutoRefreshService'; function buildItemKey(item: DatabaseTreeItem): string { return [item.type, item.connectionId || '', item.databaseName || '', item.schema || '', item.label].join(':'); @@ -16,9 +17,9 @@ export class DatabaseTreeProvider implements vscode.TreeDataProvider; + private _autoRefreshService: AutoRefreshService | undefined; // Filter, Favorites, and Recent Items - private _filterPattern: string = ''; private _favorites: Set = new Set(); private _recentItems: string[] = []; private static readonly MAX_RECENT_ITEMS = 10; @@ -43,6 +44,10 @@ export class DatabaseTreeProvider implements vscode.TreeDataProvider 0) { - filteredSchemas.push(new DatabaseTreeItem( - row.schema_name, - vscode.TreeItemCollapsibleState.Collapsed, - 'schema', - element.connectionId, - element.databaseName, - row.schema_name, - undefined, // tableName - undefined, // columnName - undefined, // comment - undefined, // isInstalled - undefined, // installedVersion - undefined, // roleAttributes - undefined, // isDisconnected - undefined, // isFavorite - undefined, // count - undefined, // rowCount - row.size // size - )); - } - } - return filteredSchemas; - } - return schemaResult.rows.map(row => new DatabaseTreeItem( row.schema_name, vscode.TreeItemCollapsibleState.Collapsed, @@ -813,7 +756,6 @@ i.relname as index_name, [element.schema] ); return tableResult.rows - .filter(row => this.matchesFilter(row.table_name)) .map(row => { const isFav = this.isFavoriteItem('table', element.connectionId, element.databaseName, element.schema, row.table_name); return new DatabaseTreeItem( @@ -843,7 +785,6 @@ i.relname as index_name, [element.schema] ); return viewResult.rows - .filter(row => this.matchesFilter(row.table_name)) .map(row => { const isFav = this.isFavoriteItem('view', element.connectionId, element.databaseName, element.schema, row.table_name); return new DatabaseTreeItem( @@ -864,7 +805,6 @@ i.relname as index_name, [element.schema] ); return functionResult.rows - .filter(row => this.matchesFilter(row.routine_name)) .map(row => { const isFav = this.isFavoriteItem('function', element.connectionId, element.databaseName, element.schema, row.routine_name); return new DatabaseTreeItem( @@ -894,7 +834,6 @@ i.relname as index_name, [element.schema] ); return materializedViewResult.rows - .filter(row => this.matchesFilter(row.name)) .map(row => { const isFav = this.isFavoriteItem('materialized-view', element.connectionId, element.databaseName, element.schema, row.name); return new DatabaseTreeItem( @@ -967,35 +906,24 @@ i.relname as index_name, return []; case 'schema': - // Query counts for each category (with filter applied if active) - const filterPattern = this._filterPattern ? `% ${this._filterPattern.toLowerCase()}% ` : null; - const tablesCountResult = await client.query( - filterPattern - ? "SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = $1 AND table_type = 'BASE TABLE' AND LOWER(table_name) LIKE $2" - : "SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = $1 AND table_type = 'BASE TABLE'", - filterPattern ? [element.schema, filterPattern] : [element.schema] + "SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = $1 AND table_type = 'BASE TABLE'", + [element.schema] ); const viewsCountResult = await client.query( - filterPattern - ? "SELECT COUNT(*) FROM information_schema.views WHERE table_schema = $1 AND LOWER(table_name) LIKE $2" - : "SELECT COUNT(*) FROM information_schema.views WHERE table_schema = $1", - filterPattern ? [element.schema, filterPattern] : [element.schema] + "SELECT COUNT(*) FROM information_schema.views WHERE table_schema = $1", + [element.schema] ); const functionsCountResult = await client.query( - filterPattern - ? "SELECT COUNT(*) FROM information_schema.routines WHERE routine_schema = $1 AND routine_type = 'FUNCTION' AND LOWER(routine_name) LIKE $2" - : "SELECT COUNT(*) FROM information_schema.routines WHERE routine_schema = $1 AND routine_type = 'FUNCTION'", - filterPattern ? [element.schema, filterPattern] : [element.schema] + "SELECT COUNT(*) FROM information_schema.routines WHERE routine_schema = $1 AND routine_type = 'FUNCTION'", + [element.schema] ); const materializedViewsCountResult = await client.query( - filterPattern - ? "SELECT COUNT(*) FROM pg_matviews WHERE schemaname = $1 AND LOWER(matviewname) LIKE $2" - : "SELECT COUNT(*) FROM pg_matviews WHERE schemaname = $1", - filterPattern ? [element.schema, filterPattern] : [element.schema] + "SELECT COUNT(*) FROM pg_matviews WHERE schemaname = $1", + [element.schema] ); const typesCountResult = await client.query( diff --git a/src/providers/NotebookKernel.ts b/src/providers/NotebookKernel.ts index aac6188..2deabc8 100644 --- a/src/providers/NotebookKernel.ts +++ b/src/providers/NotebookKernel.ts @@ -11,7 +11,7 @@ import { ExecuteUpdateBackgroundHandler, ScriptDeleteHandler, ExecuteUpdateHandler, CancelQueryHandler, DeleteRowsHandler, SaveChangesHandler } from '../services/handlers/QueryHandlers'; -import { ExportRequestHandler, ShowErrorMessageHandler, ImportRequestHandler } from '../services/handlers/CoreHandlers'; +import { ExportRequestHandler, ShowErrorMessageHandler, ImportRequestHandler, ImportPickFileHandler } from '../services/handlers/CoreHandlers'; import { SendToChatHandler } from '../services/handlers/ExplainHandlers'; export class PostgresKernel implements vscode.Disposable { @@ -61,12 +61,17 @@ export class PostgresKernel implements vscode.Disposable { registry.register('savepoint_release', new SavepointReleaseHandler()); registry.register('savepoint_rollback', new SavepointRollbackHandler()); + // Renderer-side camelCase aliases for commit/rollback (posted by TransactionBanner) + registry.register('commitTransaction', new TransactionCommitHandler()); + registry.register('rollbackTransaction', new TransactionRollbackHandler()); + registry.register('cancel_query', new CancelQueryHandler()); registry.register('execute_update_background', new ExecuteUpdateBackgroundHandler()); registry.register('script_delete', new ScriptDeleteHandler()); registry.register('execute_update', new ExecuteUpdateHandler()); registry.register('export_request', new ExportRequestHandler()); registry.register('import_request', new ImportRequestHandler()); + registry.register('import_pick_file', new ImportPickFileHandler()); registry.register('delete_row', new DeleteRowsHandler()); registry.register('delete_rows', new DeleteRowsHandler()); registry.register('sendToChat', new SendToChatHandler(undefined)); @@ -76,7 +81,49 @@ export class PostgresKernel implements vscode.Disposable { (this._controller as any).onDidReceiveMessage(async (event: any) => { // console.log('[NotebookKernel] onDidReceiveMessage', event.message.type); - await registry.handleMessage(event.message, { + const msg = event.message; + + // Handle notebook-level TopBar actions + if (msg.type === 'runAll') { + const notebook = event.editor?.notebook; + if (notebook) { + await vscode.commands.executeCommand('notebook.execute', notebook.uri); + } + return; + } + if (msg.type === 'clearOutputs') { + const notebook = event.editor?.notebook; + if (notebook) { + await vscode.commands.executeCommand('notebook.clearAllCellsOutputs', notebook.uri); + } + return; + } + if (msg.type === 'addCodeCell') { + await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); + return; + } + if (msg.type === 'addMarkdownCell') { + await vscode.commands.executeCommand('notebook.cell.insertMarkdownCellBelow'); + return; + } + if (msg.type === 'showConnectionInfo') { + const notebook = event.editor?.notebook; + if (notebook) { + const metadata = notebook.metadata as any; + const connections = vscode.workspace.getConfiguration().get('postgresExplorer.connections') || []; + const conn = connections.find(c => c.id === metadata?.connectionId); + if (conn) { + vscode.window.showInformationMessage( + `Connection: ${conn.name || conn.host} | Host: ${conn.host}:${conn.port} | Database: ${metadata?.databaseName || conn.database}` + ); + } else { + vscode.window.showInformationMessage('No active connection for this notebook.'); + } + } + return; + } + + await registry.handleMessage(msg, { editor: event.editor, executor: this._executor, postMessage: (msg) => this.messaging.postMessage(msg, event.editor) diff --git a/src/providers/NotebooksTreeProvider.ts b/src/providers/NotebooksTreeProvider.ts new file mode 100644 index 0000000..15ab974 --- /dev/null +++ b/src/providers/NotebooksTreeProvider.ts @@ -0,0 +1,163 @@ +import * as vscode from 'vscode'; +import * as path from 'path'; + +export type NotebookTreeItemType = 'connection-folder' | 'db-folder' | 'notebook-file'; + +export class NotebookTreeItem extends vscode.TreeItem { + constructor( + public readonly label: string, + public readonly collapsibleState: vscode.TreeItemCollapsibleState, + public readonly itemType: NotebookTreeItemType, + public readonly uri?: vscode.Uri, + description?: string, + tooltip?: string + ) { + super(label, collapsibleState); + this.description = description; + this.tooltip = tooltip ?? label; + this.contextValue = itemType; + + switch (itemType) { + case 'connection-folder': + this.iconPath = new vscode.ThemeIcon('server', new vscode.ThemeColor('charts.blue')); + break; + case 'db-folder': + this.iconPath = new vscode.ThemeIcon('database', new vscode.ThemeColor('charts.purple')); + break; + case 'notebook-file': + this.iconPath = new vscode.ThemeIcon('notebook', new vscode.ThemeColor('charts.yellow')); + this.command = { + command: 'postgres-explorer.notebooks.open', + title: 'Open Notebook', + arguments: [this] + }; + break; + } + } +} + +export class NotebooksTreeProvider implements vscode.TreeDataProvider { + private _onDidChangeTreeData = new vscode.EventEmitter(); + readonly onDidChangeTreeData = this._onDidChangeTreeData.event; + + constructor(private readonly globalStorageUri: vscode.Uri) {} + + refresh(): void { + this._onDidChangeTreeData.fire(); + } + + getTreeItem(element: NotebookTreeItem): vscode.TreeItem { + return element; + } + + async getChildren(element?: NotebookTreeItem): Promise { + try { + if (!element) { + return await this._getConnectionFolders(); + } + if (element.itemType === 'connection-folder' && element.uri) { + return await this._getDbFolders(element.uri); + } + if (element.itemType === 'db-folder' && element.uri) { + return await this._getNotebookFiles(element.uri); + } + } catch { + // globalStorage may not exist yet + } + return []; + } + + private async _getConnectionFolders(): Promise { + let entries: [string, vscode.FileType][]; + try { + entries = await vscode.workspace.fs.readDirectory(this.globalStorageUri); + } catch { + return []; + } + return entries + .filter(([, type]) => type === vscode.FileType.Directory) + .map(([name]) => new NotebookTreeItem( + name, + vscode.TreeItemCollapsibleState.Collapsed, + 'connection-folder', + vscode.Uri.joinPath(this.globalStorageUri, name) + )); + } + + private async _getDbFolders(connUri: vscode.Uri): Promise { + let entries: [string, vscode.FileType][]; + try { + entries = await vscode.workspace.fs.readDirectory(connUri); + } catch { + return []; + } + return entries + .filter(([, type]) => type === vscode.FileType.Directory) + .map(([name]) => new NotebookTreeItem( + name, + vscode.TreeItemCollapsibleState.Collapsed, + 'db-folder', + vscode.Uri.joinPath(connUri, name) + )); + } + + private async _getNotebookFiles(dbUri: vscode.Uri): Promise { + let entries: [string, vscode.FileType][]; + try { + entries = await vscode.workspace.fs.readDirectory(dbUri); + } catch { + return []; + } + + const files = entries.filter(([name, type]) => + type === vscode.FileType.File && name.endsWith('.pgsql') + ); + + const items: NotebookTreeItem[] = []; + for (const [name] of files) { + const uri = vscode.Uri.joinPath(dbUri, name); + const { description, tooltip } = await this._getFileMeta(uri, name); + items.push(new NotebookTreeItem( + name.replace(/\.pgsql$/, ''), + vscode.TreeItemCollapsibleState.None, + 'notebook-file', + uri, + description, + tooltip + )); + } + // Sort: scratch file first, then named notebooks alphabetically + items.sort((a, b) => { + const aLabel = a.label as string; + const bLabel = b.label as string; + const aIsScratch = aLabel === 'scratch'; + const bIsScratch = bLabel === 'scratch'; + if (aIsScratch !== bIsScratch) { return aIsScratch ? -1 : 1; } + return aLabel.localeCompare(bLabel); + }); + return items; + } + + private async _getFileMeta(uri: vscode.Uri, filename: string): Promise<{ description: string; tooltip: string }> { + try { + const [stat, raw] = await Promise.all([ + vscode.workspace.fs.stat(uri), + vscode.workspace.fs.readFile(uri) + ]); + const mtime = new Date(stat.mtime).toLocaleDateString(); + let sectionCount = 0; + try { + const data = JSON.parse(Buffer.from(raw).toString()); + if (Array.isArray(data.cells)) { + sectionCount = data.cells.filter((c: any) => + c.kind === 'markdown' && /^#{1,3}\s/.test(c.value ?? '') + ).length; + } + } catch { /* malformed file */ } + const desc = sectionCount > 0 ? `${sectionCount} section${sectionCount !== 1 ? 's' : ''} · ${mtime}` : mtime; + return { description: desc, tooltip: `${filename}\nModified: ${mtime}\nSections: ${sectionCount}` }; + } catch { + return { description: '', tooltip: filename }; + } + } +} diff --git a/src/providers/QueryCodeLensProvider.ts b/src/providers/QueryCodeLensProvider.ts index 13d8f9d..2d05415 100644 --- a/src/providers/QueryCodeLensProvider.ts +++ b/src/providers/QueryCodeLensProvider.ts @@ -1,17 +1,53 @@ import * as vscode from 'vscode'; +export interface PillData { + success: boolean; + elapsedSeconds?: number; + rowCount?: number; +} + /** * Provides CodeLens actions for SQL queries in notebook cells * Detects SELECT queries and offers EXPLAIN and EXPLAIN ANALYZE options */ export class QueryCodeLensProvider implements vscode.CodeLensProvider { + private static _instance: QueryCodeLensProvider | undefined; + + public static getInstance(): QueryCodeLensProvider | undefined { + return QueryCodeLensProvider._instance; + } + + public static setInstance(instance: QueryCodeLensProvider): void { + QueryCodeLensProvider._instance = instance; + } + private _onDidChangeCodeLenses: vscode.EventEmitter = new vscode.EventEmitter(); public readonly onDidChangeCodeLenses: vscode.Event = this._onDidChangeCodeLenses.event; + private pillData: Map = new Map(); + private aiWorkingCells: Set = new Set(); + + public setAiWorking(cellUri: string, working: boolean): void { + if (working) { + this.aiWorkingCells.add(cellUri); + } else { + this.aiWorkingCells.delete(cellUri); + } + this._onDidChangeCodeLenses.fire(); + } + + public isAiWorking(cellUri: string): boolean { + return this.aiWorkingCells.has(cellUri); + } public refresh(): void { this._onDidChangeCodeLenses.fire(); } + public updatePill(cellUri: string, data: PillData): void { + this.pillData.set(cellUri, data); + this._onDidChangeCodeLenses.fire(); + } + provideCodeLenses(document: vscode.TextDocument, token: vscode.CancellationToken): vscode.CodeLens[] { // Only provide CodeLens for SQL in notebook cells if (document.uri.scheme !== 'vscode-notebook-cell') { @@ -34,13 +70,14 @@ export class QueryCodeLensProvider implements vscode.CodeLensProvider { const codeLenses: vscode.CodeLens[] = []; const range = new vscode.Range(0, 0, 0, 0); + const isAiWorking = this.aiWorkingCells.has(document.uri.toString()); - // 1. Ask AI + // 1. Ask AI (shows spinner while working) codeLenses.push( new vscode.CodeLens(range, { - title: '$(sparkle) Ask AI ', - tooltip: 'Ask AI to modify this query', - command: 'postgres-explorer.aiAssist', + title: isAiWorking ? '$(loading~spin) Working...' : '✦ Ask AI', + tooltip: isAiWorking ? 'AI is analyzing your query...' : 'Ask AI to modify this query', + command: isAiWorking ? '' : 'postgres-explorer.aiAssist', arguments: [] }) ); @@ -48,7 +85,7 @@ export class QueryCodeLensProvider implements vscode.CodeLensProvider { // 2. Chat codeLenses.push( new vscode.CodeLens(range, { - title: '$(comment-discussion) Chat ', + title: '◻ Chat', tooltip: 'Open SQL Assistant chat with this query', command: 'postgres-explorer.chatWithQuery', arguments: [] @@ -58,7 +95,7 @@ export class QueryCodeLensProvider implements vscode.CodeLensProvider { // 3. Save Query (Always available) codeLenses.push( new vscode.CodeLens(range, { - title: '$(save) Save Query ', + title: '⊞ Save Query', tooltip: 'Save this query to the library for easy reuse', command: 'postgres-explorer.saveQueryToLibraryUI' }) @@ -69,7 +106,7 @@ export class QueryCodeLensProvider implements vscode.CodeLensProvider { // 4. EXPLAIN ANALYZE codeLenses.push( new vscode.CodeLens(range, { - title: '$(telescope) Explain Analyze', + title: '⟐ Explain Analyze', tooltip: 'Show query execution plan with actual runtime statistics', command: 'postgres-explorer.explainQuery', arguments: [document.uri, true] @@ -77,6 +114,21 @@ export class QueryCodeLensProvider implements vscode.CodeLensProvider { ); } + // 5. Execution time pill (shown after execution) + const pill = this.pillData.get(document.uri.toString()); + if (pill) { + const pillTitle = pill.success + ? `${pill.elapsedSeconds}s · ${pill.rowCount} rows` + : 'failed'; + codeLenses.push( + new vscode.CodeLens(range, { + title: pillTitle, + tooltip: pill.success ? 'Last execution result' : 'Last execution failed', + command: '' + }) + ); + } + return codeLenses; } } diff --git a/src/providers/chat/AiService.ts b/src/providers/chat/AiService.ts index 8cbd9c0..3373c42 100644 --- a/src/providers/chat/AiService.ts +++ b/src/providers/chat/AiService.ts @@ -5,6 +5,14 @@ import * as vscode from 'vscode'; import * as https from 'https'; import * as http from 'http'; import { ChatMessage } from './types'; +import { SecretStorageService } from '../../services/SecretStorageService'; + +// GitHub Models permission applies to fine-grained tokens/GitHub Apps. +// For VS Code OAuth sessions, request no explicit scope. +const GITHUB_MODELS_SCOPES: string[] = []; +const GITHUB_MODELS_API_BASE = 'https://models.github.ai'; +const GITHUB_MODELS_API_VERSION = '2026-03-10'; +const DEFAULT_GITHUB_MODEL = 'openai/gpt-4.1'; export class AiService { private _messages: ChatMessage[] = []; @@ -115,7 +123,48 @@ IMPORTANT: At the end of each response, provide 2-4 numbered follow-up questions 2. [Second question] 3. [Third question] -Make these questions relevant to the topic discussed and progressively more advanced.`; +Make these questions relevant to the topic discussed and progressively more advanced. + +IMPORTANT: If there is a genuinely good factoid or contextual joke, add it immediately before the follow-up questions as a short Markdown blockquote. +- Use your judgment: this is mainly for general-knowledge, conceptual, or exploratory answers. +- For simple fix, error, or query-generation tasks, usually omit it unless there is a truly apt one-liner. +- You may include a factoid, a joke, both, or neither. +- Keep it short, self-contained, and clearly relevant to the current answer. +- Format it as quote style markdown using blockquote lines only; do not add a heading. + +IMPORTANT: Follow-up questions are distinct from next-step suggestion bubbles. +- If the user's latest message is only a number, treat it as selecting that numbered question from the immediately previous assistant response's "Follow-up questions:" list. +- Answer the selected follow-up question directly. +- Do not confuse this with next-step bubbles, which are optional model suggestions and not user selections. + +**PHASE D: NEXT STEPS SUGGESTION BUBBLES (Optional):** +After your response, you MAY optionally provide suggested follow-up actions the user might want to take. If you do, append them as a raw JSON object at the very end of your response (after the follow-up questions). Do not wrap the JSON in markdown or code fences. + +{ + "next_steps": [ + "Short action phrase, 3 to 6 words max", + "Short action phrase, 3 to 6 words max", + "Short action phrase, 3 to 6 words max" + ] +} + + +IMPORTANT: Only include this JSON block if you have 2-3 truly valuable next-step suggestions. The suggestions should be: +- Actionable and relevant to the current conversation +- Phrased as concise, self-contained action phrases or prompts (ideally 3-6 words, max 40 characters each) +- Progressive in complexity or depth +- Examples: "Review query plan", "Add missing index", "Compare join options" + +Do NOT include the JSON block if: +- There are no clear follow-up actions +- The suggestions are obvious or trivial +- You're uncertain about what would be helpful next +- Do not invent filler suggestions just to reach 3 entries +- Do not repeat the follow-up questions in this JSON block +- If only 1 or 2 actions are appropriate, provide only those +- If no actions are appropriate, omit the JSON block entirely + +The UI will automatically parse this and show clickable suggestion bubbles.`; } async callVsCodeLm(userMessage: string, config: vscode.WorkspaceConfiguration, customSystemPrompt?: string): Promise<{ text: string, usage?: string }> { @@ -150,22 +199,79 @@ Make these questions relevant to the topic discussed and progressively more adva throw new Error('No AI models available via VS Code API. Please ensure GitHub Copilot Chat is installed or switch provider.'); } + console.log('[AiService] Selected model details:', JSON.stringify({ + id: model.id, + name: model.name, + family: (model as any).family, + vendor: (model as any).vendor, + version: (model as any).version, + maxInputTokens: (model as any).maxInputTokens, + maxOutputTokens: (model as any).maxOutputTokens + })); + const systemPrompt = customSystemPrompt !== undefined ? customSystemPrompt : this.buildSystemPrompt(); - const messages = []; + const messages: any[] = []; if (systemPrompt) { - messages.push(vscode.LanguageModelChatMessage.User(systemPrompt)); + const lmMessageCtor = vscode.LanguageModelChatMessage as any; + // Prefer system role when available; older API versions only expose User/Assistant. + if (typeof lmMessageCtor.System === 'function') { + messages.push(lmMessageCtor.System(systemPrompt)); + } else { + messages.push(vscode.LanguageModelChatMessage.User(systemPrompt)); + } } + const history = this._messages.slice(-10); + messages.push( - ...this._messages.slice(-10).map(msg => - msg.role === 'user' - ? vscode.LanguageModelChatMessage.User(this._sanitizeContent(this._getMessageContent(msg))) - : vscode.LanguageModelChatMessage.Assistant(this._sanitizeContent(this._getMessageContent(msg))) - ) + ...history.map(msg => { + const text = this._sanitizeContent(this._getMessageContent(msg)); + const images = msg.attachments?.filter(a => a.type === 'image' && a.dataUrl) || []; + if (images.length > 0) { + const parts: any[] = []; + for (const img of images) { + const match = img.dataUrl!.match(/^data:([^;]+);base64,(.+)$/); + if (match) { + const bytes = Buffer.from(match[2], 'base64'); + const lmImagePart = (vscode as any).LanguageModelImagePart; + if (typeof lmImagePart === 'function') { + parts.push(new lmImagePart(match[1], bytes)); + } + } + } + if (text.trim()) { + parts.push(new (vscode as any).LanguageModelTextPart(text)); + } + return msg.role === 'user' + ? vscode.LanguageModelChatMessage.User(parts.length > 0 ? parts : text) + : vscode.LanguageModelChatMessage.Assistant(text); + } + return msg.role === 'user' + ? vscode.LanguageModelChatMessage.User(text) + : vscode.LanguageModelChatMessage.Assistant(text); + }) ); + // Always include the latest user prompt as the final turn. + // Some models are sensitive to explicit final-turn structure. messages.push(vscode.LanguageModelChatMessage.User(userMessage)); + const compactHistory = history.map((msg, idx) => ({ + idx, + role: msg.role, + contentLength: this._getMessageContent(msg).length, + attachmentCount: msg.attachments?.length || 0, + mentionCount: msg.mentions?.length || 0 + })); + + console.log('[AiService] Prepared request payload summary:', JSON.stringify({ + totalMessages: messages.length, + historyMessages: history.length, + userMessageLength: userMessage.length, + systemPromptLength: systemPrompt.length, + history: compactHistory + })); + // Debug: Log all messages being sent to model console.log('[AiService] ========== MESSAGES SENT TO MODEL =========='); console.log('[AiService] System prompt length:', systemPrompt.length); @@ -175,11 +281,69 @@ Make these questions relevant to the topic discussed and progressively more adva this._cancellationTokenSource = new vscode.CancellationTokenSource(); try { + console.log('[AiService] sendRequest initial attempt started'); const chatRequest = await model.sendRequest(messages, {}, this._cancellationTokenSource.token); - let responseText = ''; + const rawChatRequest = chatRequest as any; + console.log('[AiService] sendRequest initial attempt resolved:', JSON.stringify({ + hasStream: !!rawChatRequest?.stream, + hasText: !!rawChatRequest?.text, + hasResult: !!rawChatRequest?.result, + resultKeys: rawChatRequest?.result ? Object.keys(rawChatRequest.result) : [] + })); + + let responseText = await this._extractVsCodeLmResponseText(chatRequest as any); + console.log('[AiService] Initial extraction result length:', responseText.length); + + // Some models may return an empty text stream on the first attempt for verbose histories. + // Retry once with a minimal context to avoid persisting blank assistant replies. + let effectiveMessagesForFallback = messages; + if (!responseText.trim()) { + console.warn('[AiService] Empty response from VS Code LM; retrying with minimal prompt context.'); + const retryMessages: any[] = []; + if (systemPrompt) { + const lmMessageCtor = vscode.LanguageModelChatMessage as any; + if (typeof lmMessageCtor.System === 'function') { + retryMessages.push(lmMessageCtor.System(systemPrompt)); + } else { + retryMessages.push(vscode.LanguageModelChatMessage.User(systemPrompt)); + } + } + retryMessages.push(vscode.LanguageModelChatMessage.User(userMessage)); + + console.log('[AiService] Retry payload summary:', JSON.stringify({ + totalMessages: retryMessages.length, + userMessageLength: userMessage.length, + systemPromptLength: systemPrompt.length + })); + + console.log('[AiService] sendRequest retry attempt started'); + const retryRequest = await model.sendRequest(retryMessages, {}, this._cancellationTokenSource.token); + const rawRetryRequest = retryRequest as any; + console.log('[AiService] sendRequest retry attempt resolved:', JSON.stringify({ + hasStream: !!rawRetryRequest?.stream, + hasText: !!rawRetryRequest?.text, + hasResult: !!rawRetryRequest?.result, + resultKeys: rawRetryRequest?.result ? Object.keys(rawRetryRequest.result) : [] + })); + + responseText = await this._extractVsCodeLmResponseText(retryRequest as any); + console.log('[AiService] Retry extraction result length:', responseText.length); + effectiveMessagesForFallback = retryMessages; + } - for await (const fragment of chatRequest.text) { - responseText += fragment; + // If the configured model yields no chunks at all, try another available model once. + if (!responseText.trim()) { + const fallbackModel = await this._findAlternateModel(model.id); + if (fallbackModel) { + console.warn('[AiService] Selected model produced empty output. Trying alternate model:', fallbackModel.name || fallbackModel.id); + const fallbackRequest = await fallbackModel.sendRequest(effectiveMessagesForFallback, {}, this._cancellationTokenSource.token); + responseText = await this._extractVsCodeLmResponseText(fallbackRequest as any); + console.log('[AiService] Alternate model extraction result length:', responseText.length); + } + } + + if (!responseText.trim()) { + throw new Error('AI model returned an empty response. Please retry or select a different model.'); } return { text: responseText }; @@ -192,6 +356,173 @@ Make these questions relevant to the topic discussed and progressively more adva } } + private async _findAlternateModel(currentModelId: string): Promise { + const allModels = await this._selectChatModelsWithTimeout({}); + if (allModels.length === 0) { + return undefined; + } + + const candidates = allModels.filter(m => m.id !== currentModelId); + if (candidates.length === 0) { + return undefined; + } + + // Prefer known stable families first if available. + const preferredFamilyOrder = ['gpt-4o', 'gpt-4.1', 'o3', 'claude']; + for (const family of preferredFamilyOrder) { + const match = candidates.find(m => (m.family || '').toLowerCase().includes(family)); + if (match) { + return match; + } + } + + return candidates[0]; + } + + private async _extractVsCodeLmResponseText(chatRequest: any): Promise { + let responseText = ''; + const streamPartDebug: string[] = []; + let streamChunkCount = 0; + let textChunkCount = 0; + + // Stream is the canonical response channel in current VS Code APIs. + if (chatRequest?.stream && Symbol.asyncIterator in Object(chatRequest.stream)) { + for await (const part of chatRequest.stream) { + streamChunkCount += 1; + responseText += this._extractTextFromStreamPart(part, streamPartDebug); + } + } + + console.log('[AiService] Stream extraction stats:', JSON.stringify({ + streamChunkCount, + streamChunkTypes: streamPartDebug, + extractedLength: responseText.length + })); + + if (responseText.trim()) { + return responseText; + } + + // Fallback for environments where text is the only available channel. + if (chatRequest?.text && Symbol.asyncIterator in Object(chatRequest.text)) { + for await (const fragment of chatRequest.text) { + textChunkCount += 1; + responseText += this._normalizeLmTextFragment(fragment); + } + } + + console.log('[AiService] Text extraction stats:', JSON.stringify({ + textChunkCount, + extractedLength: responseText.length + })); + + if (responseText.trim()) { + return responseText; + } + + // Last-resort compatibility fallback. + const resultContent = chatRequest?.result?.content; + if (typeof resultContent === 'string') { + console.log('[AiService] Using result.content string fallback with length:', resultContent.length); + return resultContent; + } + if (Array.isArray(resultContent)) { + console.log('[AiService] Using result.content array fallback with parts:', resultContent.length); + return resultContent + .map((item: any) => { + if (typeof item === 'string') return item; + if (typeof item?.text === 'string') return item.text; + if (typeof item?.value === 'string') return item.value; + return ''; + }) + .join(''); + } + + if (!responseText.trim() && streamPartDebug.length > 0) { + console.warn('[AiService] LM stream yielded non-text parts only:', streamPartDebug.join(' | ')); + } + + return responseText; + } + + private _normalizeLmTextFragment(fragment: any): string { + if (fragment === null || fragment === undefined) { + return ''; + } + if (typeof fragment === 'string') { + return fragment; + } + if (typeof fragment?.value === 'string') { + return fragment.value; + } + if (typeof fragment?.text === 'string') { + return fragment.text; + } + return ''; + } + + private _extractTextFromStreamPart(part: any, debugParts?: string[]): string { + if (!part) { + return ''; + } + + const addDebugPart = (value: string): void => { + if (!debugParts) { + return; + } + if (debugParts.length < 8) { + debugParts.push(value); + } + }; + + const ctorName = part?.constructor?.name || typeof part; + addDebugPart(ctorName); + + if (part instanceof (vscode as any).LanguageModelTextPart) { + return typeof part.value === 'string' ? part.value : ''; + } + + if (part instanceof (vscode as any).LanguageModelToolCallPart) { + addDebugPart(`tool:${part.name || 'unknown'}`); + return ''; + } + + if (typeof part === 'string') { + return part; + } + if (typeof part.text === 'string') { + return part.text; + } + if (typeof part.value === 'string') { + return part.value; + } + + const nestedText = part?.part?.text; + if (typeof nestedText === 'string') { + return nestedText; + } + + const nestedValue = part?.part?.value; + if (typeof nestedValue === 'string') { + return nestedValue; + } + + const candidates = [part?.content, part?.chunk, part?.delta]; + for (const candidate of candidates) { + if (typeof candidate === 'string') { + return candidate; + } + if (typeof candidate?.text === 'string') { + return candidate.text; + } + if (typeof candidate?.value === 'string') { + return candidate.value; + } + } + + return ''; + } + // Sanitize content to remove any HTML/CSS artifacts before sending to AI private _sanitizeContent(content: string): string { let cleaned = content; @@ -203,19 +534,95 @@ Make these questions relevant to the topic discussed and progressively more adva private _getMessageContent(msg: ChatMessage): string { let content = msg.content; if (msg.attachments && msg.attachments.length > 0) { - const attachmentTexts = msg.attachments.map(att => - `\n\nFile: ${att.name} (${att.type})\n\`\`\`${att.type}\n${att.content}\n\`\`\`` - ).join(''); + const attachmentTexts = msg.attachments + .filter(att => att.type !== 'image') + .map(att => `\n\nFile: ${att.name} (${att.type})\n\`\`\`${att.type}\n${att.content}\n\`\`\``) + .join(''); content += attachmentTexts; } return content; } + /** + * Build a multipart content array for providers that support vision (images). + * Returns null if there are no image attachments (caller should use plain string). + */ + private _buildMultipartContent(msg: ChatMessage, textOverride?: string): any[] | null { + const images = msg.attachments?.filter(att => att.type === 'image' && att.dataUrl) || []; + if (images.length === 0) return null; + + const text = textOverride ?? this._getMessageContent(msg); + const parts: any[] = []; + + if (text.trim()) { + parts.push({ type: 'text', text }); + } + + for (const img of images) { + // dataUrl format: "data:;base64," + const match = img.dataUrl!.match(/^data:([^;]+);base64,(.+)$/); + if (match) { + parts.push({ + type: 'image_url', + image_url: { url: img.dataUrl! } + }); + } + } + + return parts.length > 0 ? parts : null; + } + + /** + * Build Anthropic-style multipart content with image blocks. + */ + private _buildAnthropicContent(msg: ChatMessage, textOverride?: string): any[] | string { + const images = msg.attachments?.filter(att => att.type === 'image' && att.dataUrl) || []; + const text = textOverride ?? this._getMessageContent(msg); + + if (images.length === 0) return text; + + const parts: any[] = []; + for (const img of images) { + const match = img.dataUrl!.match(/^data:([^;]+);base64,(.+)$/); + if (match) { + parts.push({ + type: 'image', + source: { type: 'base64', media_type: match[1], data: match[2] } + }); + } + } + if (text.trim()) { + parts.push({ type: 'text', text }); + } + return parts; + } + + /** + * Build Gemini-style parts array with inline image data. + */ + private _buildGeminiParts(msg: ChatMessage, textOverride?: string): any[] { + const images = msg.attachments?.filter(att => att.type === 'image' && att.dataUrl) || []; + const text = textOverride ?? this._getMessageContent(msg); + const parts: any[] = []; + + if (text.trim()) { + parts.push({ text }); + } + for (const img of images) { + const match = img.dataUrl!.match(/^data:([^;]+);base64,(.+)$/); + if (match) { + parts.push({ inline_data: { mime_type: match[1], data: match[2] } }); + } + } + return parts; + } + async callDirectApi(provider: string, userMessage: string, config: vscode.WorkspaceConfiguration, customSystemPrompt?: string): Promise<{ text: string, usage?: string }> { - const apiKey = config.get('aiApiKey'); + const apiKey = await this._getDirectApiKey(config); + const githubSession = provider === 'github' ? await this._getGitHubSession() : undefined; // API key is required for most providers, but optional for custom endpoints - if (!apiKey && provider !== 'custom') { + if (!apiKey && provider !== 'custom' && provider !== 'ollama' && provider !== 'lmstudio' && provider !== 'github') { throw new Error(`API Key is required for ${provider} provider. Please configure postgresExplorer.aiApiKey.`); } @@ -248,8 +655,18 @@ Make these questions relevant to the topic discussed and progressively more adva if (systemPrompt) { messages.push({ role: 'system', content: systemPrompt }); } - messages.push(...conversationHistory); - messages.push({ role: 'user', content: userMessage }); + // History with vision support + for (const msg of this._messages.slice(-10)) { + const multipart = this._buildMultipartContent(msg); + messages.push({ + role: msg.role, + content: multipart ?? this._sanitizeContent(this._getMessageContent(msg)) + }); + } + // Current user message — check if it carries images + const currentMsg: ChatMessage = { role: 'user', content: userMessage, attachments: this._messages[this._messages.length - 1]?.attachments }; + const currentMultipart = this._buildMultipartContent(currentMsg, userMessage); + messages.push({ role: 'user', content: currentMultipart ?? userMessage }); body = { model: model, @@ -262,13 +679,24 @@ Make these questions relevant to the topic discussed and progressively more adva headers['x-api-key'] = apiKey; headers['anthropic-version'] = '2023-06-01'; delete headers['Authorization']; + + const anthropicMessages: any[] = []; + for (const msg of this._messages.slice(-10)) { + anthropicMessages.push({ + role: msg.role === 'assistant' ? 'assistant' : 'user', + content: this._buildAnthropicContent(msg) + }); + } + const lastMsg = this._messages[this._messages.length - 1]; + const currentAnthropicContent = lastMsg?.attachments?.some(a => a.type === 'image') + ? this._buildAnthropicContent(lastMsg, userMessage) + : userMessage; + anthropicMessages.push({ role: 'user', content: currentAnthropicContent }); + body = { model: model, system: systemPrompt, - messages: [ - ...conversationHistory, - { role: 'user', content: userMessage } - ], + messages: anthropicMessages, max_tokens: 4096 }; } else if (provider === 'gemini') { @@ -277,15 +705,22 @@ Make these questions relevant to the topic discussed and progressively more adva headers['X-goog-api-key'] = apiKey; delete headers['Authorization']; + const geminiContents: any[] = []; + for (const msg of this._messages.slice(-10)) { + geminiContents.push({ + role: msg.role === 'assistant' ? 'model' : 'user', + parts: this._buildGeminiParts(msg) + }); + } + const lastMsg = this._messages[this._messages.length - 1]; + const currentGeminiParts = lastMsg?.attachments?.some(a => a.type === 'image') + ? this._buildGeminiParts(lastMsg, userMessage) + : [{ text: userMessage }]; + geminiContents.push({ role: 'user', parts: currentGeminiParts }); + body = { systemInstruction: systemPrompt ? { parts: [{ text: systemPrompt }] } : undefined, - contents: [ - ...conversationHistory.map(msg => ({ - role: msg.role === 'assistant' ? 'model' : 'user', - parts: [{ text: msg.content }] - })), - { role: 'user', parts: [{ text: userMessage }] } - ] + contents: geminiContents }; } else if (provider === 'custom') { endpoint = config.get('aiEndpoint') || ''; @@ -305,6 +740,57 @@ Make these questions relevant to the topic discussed and progressively more adva model: model, messages: messages }; + } else if (provider === 'ollama') { + endpoint = config.get('aiEndpoint') || 'http://localhost:11434/v1/chat/completions'; + model = model || ''; + + const messages: any[] = []; + if (systemPrompt) { + messages.push({ role: 'system', content: systemPrompt }); + } + messages.push(...conversationHistory); + messages.push({ role: 'user', content: userMessage }); + + body = { model, messages }; + } else if (provider === 'lmstudio') { + endpoint = config.get('aiEndpoint') || 'http://localhost:1234/v1/chat/completions'; + model = model || ''; + + const messages: any[] = []; + if (systemPrompt) { + messages.push({ role: 'system', content: systemPrompt }); + } + messages.push(...conversationHistory); + messages.push({ role: 'user', content: userMessage }); + + body = { model, messages }; + } else if (provider === 'github') { + if (!githubSession) { + throw new Error('Sign in to GitHub in AI Settings to use GitHub Models.'); + } + + endpoint = `${GITHUB_MODELS_API_BASE}/inference/chat/completions`; + model = model || DEFAULT_GITHUB_MODEL; + + const messages: any[] = []; + if (systemPrompt) { + messages.push({ role: 'system', content: systemPrompt }); + } + messages.push(...conversationHistory); + messages.push({ role: 'user', content: userMessage }); + + headers = { + 'Accept': 'application/vnd.github+json', + 'Authorization': `Bearer ${githubSession.accessToken}`, + 'X-GitHub-Api-Version': GITHUB_MODELS_API_VERSION, + 'Content-Type': 'application/json' + }; + + body = { + model, + messages, + temperature: 0.7 + }; } else { throw new Error(`Unsupported provider: ${provider}`); } @@ -312,6 +798,26 @@ Make these questions relevant to the topic discussed and progressively more adva return this._makeHttpRequest(endpoint, headers, body, provider); } + private async _getDirectApiKey(config: vscode.WorkspaceConfiguration): Promise { + try { + const secretApiKey = await SecretStorageService.getInstance().getAiApiKey(); + return secretApiKey || config.get('aiApiKey') || ''; + } catch { + return config.get('aiApiKey') || ''; + } + } + + private async _getGitHubSession(): Promise { + try { + return await vscode.authentication.getSession('github', GITHUB_MODELS_SCOPES, { + silent: true, + clearSessionPreference: false + }); + } catch { + return undefined; + } + } + private _makeHttpRequest(endpoint: string, headers: any, body: any, provider: string): Promise<{ text: string, usage?: string }> { return new Promise((resolve, reject) => { const url = new URL(endpoint); @@ -437,10 +943,13 @@ Make these questions relevant to the topic discussed and progressively more adva private _getDefaultModel(provider: string): string { switch (provider) { + case 'github': return DEFAULT_GITHUB_MODEL; case 'openai': return 'gpt-4o'; case 'anthropic': return 'claude-3-5-sonnet-20241022'; case 'gemini': return 'gemini-1.5-flash'; case 'custom': return 'custom-model'; + case 'ollama': return 'ollama'; + case 'lmstudio': return 'lm-studio'; default: return 'Unknown'; } } diff --git a/src/providers/chat/SessionService.ts b/src/providers/chat/SessionService.ts index 7174c89..de7af51 100644 --- a/src/providers/chat/SessionService.ts +++ b/src/providers/chat/SessionService.ts @@ -35,7 +35,7 @@ export class SessionService { this._currentSessionId = id; } - async saveSession(messages: ChatMessage[], generateTitle: (msg: string) => Promise): Promise { + async saveSession(messages: ChatMessage[], generateTitle: (msg: string) => Promise, metadata?: { connectionName?: string; database?: string }): Promise { if (messages.length === 0) return; const sessions = this.getChatSessions(); @@ -46,18 +46,56 @@ export class SessionService { if (index !== -1) { sessions[index].messages = [...messages]; sessions[index].updatedAt = now; + + // Phase C: Update metadata if provided + if (metadata?.connectionName) { + sessions[index].connectionName = metadata.connectionName; + } + if (metadata?.database) { + sessions[index].database = metadata.database; + } + + // Phase C: Extract preview from first AI response if not already set + if (!sessions[index].preview) { + const firstAiMessage = messages.find(m => m.role === 'assistant'); + if (firstAiMessage) { + // Strip markdown fence markers and take first 100 chars + const cleanContent = firstAiMessage.content + .replace(/^```[\s\S]*?```/gm, '') // Remove code blocks + .replace(/\*\*/g, '') // Remove bold markers + .replace(/\*/g, '') // Remove italic markers + .trim(); + sessions[index].preview = cleanContent.substring(0, 100); + } + } } } else { this._currentSessionId = this.generateSessionId(); const firstUserMessage = messages.find(m => m.role === 'user')?.content || 'New Chat'; const title = await generateTitle(firstUserMessage); + // Phase C: Extract preview from first AI response + let preview: string | undefined; + const firstAiMessage = messages.find(m => m.role === 'assistant'); + if (firstAiMessage) { + const cleanContent = firstAiMessage.content + .replace(/^```[\s\S]*?```/gm, '') + .replace(/\*\*/g, '') + .replace(/\*/g, '') + .trim(); + preview = cleanContent.substring(0, 100); + } + sessions.unshift({ id: this._currentSessionId, title, messages: [...messages], createdAt: now, - updatedAt: now + updatedAt: now, + // Phase C: Store metadata + preview, + connectionName: metadata?.connectionName, + database: metadata?.database }); } @@ -98,7 +136,11 @@ export class SessionService { createdAt: s.createdAt, updatedAt: s.updatedAt, messageCount: s.messages.length, - isActive: s.id === this._currentSessionId + isActive: s.id === this._currentSessionId, + // Phase C: Include metadata in summaries + preview: s.preview, + connectionName: s.connectionName, + database: s.database })); } diff --git a/src/providers/chat/types.ts b/src/providers/chat/types.ts index c943790..060a8bc 100644 --- a/src/providers/chat/types.ts +++ b/src/providers/chat/types.ts @@ -15,6 +15,9 @@ export interface FileAttachment { content: string; type: string; path?: string; + // For image attachments: base64 data URL + dataUrl?: string; + mimeType?: string; } export interface DbMention { @@ -47,6 +50,10 @@ export interface ChatSession { messages: ChatMessage[]; createdAt: number; updatedAt: number; + // Phase C: Optional metadata for enhanced history UI + preview?: string; // First 100 chars of first AI response + connectionName?: string; // Name of the connection this session used + database?: string; // Name of the database this session used } export interface ChatSessionSummary { @@ -56,4 +63,8 @@ export interface ChatSessionSummary { updatedAt: number; messageCount: number; isActive: boolean; + // Phase C: Optional metadata for history display + preview?: string; + connectionName?: string; + database?: string; } diff --git a/src/providers/chat/webviewHtml.ts b/src/providers/chat/webviewHtml.ts index 398785c..e74d0cb 100644 --- a/src/providers/chat/webviewHtml.ts +++ b/src/providers/chat/webviewHtml.ts @@ -29,7 +29,7 @@ export async function getWebviewHtml( const themeDetection = new TextDecoder().decode(themeBuffer); // Build CSP string - const csp = `default-src 'none'; style-src ${cspSource} 'unsafe-inline'; script-src ${cspSource} 'unsafe-inline';`; + const csp = `default-src 'none'; style-src ${cspSource} 'unsafe-inline'; script-src ${cspSource} 'unsafe-inline'; img-src ${cspSource} data: blob:;`; // Replace placeholders html = html.replace('{{CSP}}', csp); diff --git a/src/providers/kernel/SqlExecutor.ts b/src/providers/kernel/SqlExecutor.ts index ce176cf..1266846 100644 --- a/src/providers/kernel/SqlExecutor.ts +++ b/src/providers/kernel/SqlExecutor.ts @@ -6,16 +6,55 @@ import { TelemetryService, SpanNames } from '../../services/TelemetryService'; import { PostgresMetadata, QueryResults } from '../../common/types'; import { SqlParser } from './SqlParser'; import { SecretStorageService } from '../../services/SecretStorageService'; -import { ErrorService } from '../../services/ErrorService'; +import { ErrorService, getErrorExplanation } from '../../services/ErrorService'; import { QueryHistoryService } from '../../services/QueryHistoryService'; import { getTransactionManager } from '../../services/TransactionManager'; import { QueryAnalyzer } from '../../services/QueryAnalyzer'; import { QueryPerformanceService } from '../../services/QueryPerformanceService'; import { extensionContext } from '../../extension'; +import { QueryCodeLensProvider } from '../QueryCodeLensProvider'; +import { updateNotebookTitle } from '../../utils/notebookTitle'; export class SqlExecutor { + private static readonly REVIEW_COUNT_KEY = 'postgresExplorer.reviewPrompt.successCount'; + private static readonly REVIEW_SHOWN_KEY = 'postgresExplorer.reviewPrompt.shown'; + private static readonly REVIEW_THRESHOLD = 3; + constructor(private readonly _controller: vscode.NotebookController) { } + private async maybePromptForReview(): Promise { + if (!extensionContext) { + return; + } + + const shown = extensionContext.globalState.get(SqlExecutor.REVIEW_SHOWN_KEY, false); + if (shown) { + return; + } + + const currentCount = extensionContext.globalState.get(SqlExecutor.REVIEW_COUNT_KEY, 0); + const nextCount = currentCount + 1; + await extensionContext.globalState.update(SqlExecutor.REVIEW_COUNT_KEY, nextCount); + + if (nextCount < SqlExecutor.REVIEW_THRESHOLD) { + return; + } + + const leaveReview = 'Leave a Review'; + const maybeLater = 'Maybe Later'; + const selection = await vscode.window.showInformationMessage( + 'Enjoying PgStudio? A quick VS Code Marketplace review helps other PostgreSQL users discover it.', + leaveReview, + maybeLater + ); + + await extensionContext.globalState.update(SqlExecutor.REVIEW_SHOWN_KEY, true); + + if (selection === leaveReview) { + await vscode.env.openExternal(vscode.Uri.parse('https://marketplace.visualstudio.com/items?itemName=ric-v.postgres-explorer&ssr=false#review-details')); + } + } + /** * Apply auto-LIMIT to SELECT queries that don't already have one * Respects both global settings and profile-level autoLimitSelectResults @@ -289,6 +328,13 @@ export class SqlExecutor { new NotebookCellOutputItem(Buffer.from(JSON.stringify(outputData), 'utf8'), 'application/vnd.postgres-notebook.result') ])); + // Update execution time pill in CodeLens bar + QueryCodeLensProvider.getInstance()?.updatePill(cell.document.uri.toString(), { + success: true, + elapsedSeconds: executionTime, + rowCount: result.rowCount ?? 0 + }); + // Log to history QueryHistoryService.getInstance().add({ query: query, @@ -300,6 +346,8 @@ export class SqlExecutor { connectionName: connection.name }); + await this.maybePromptForReview(); + } catch (err: any) { const stmtEndTime = Date.now(); const executionTime = (stmtEndTime - stmtStartTime) / 1000; @@ -319,19 +367,27 @@ export class SqlExecutor { const durationMs = executionTime * 1000; const isSlow = durationMs >= slowThresholdMs; + const pgErrorCode: string | undefined = err.code; const errorData = { success: false, error: err.message, query: query, executionTime, slowQuery: isSlow, - canExplain: true + canExplain: true, + errorCode: pgErrorCode, + errorExplanation: pgErrorCode ? getErrorExplanation(pgErrorCode) : undefined }; await execution.appendOutput(new NotebookCellOutput([ new NotebookCellOutputItem(Buffer.from(JSON.stringify(errorData), 'utf8'), 'application/vnd.postgres-notebook.error') ])); + // Update execution time pill in CodeLens bar (failure) + QueryCodeLensProvider.getInstance()?.updatePill(cell.document.uri.toString(), { + success: false + }); + // Log to history QueryHistoryService.getInstance().add({ query: query, @@ -349,6 +405,8 @@ export class SqlExecutor { client.removeListener('notice', noticeListener); execution.end(true, Date.now()); + // Update notebook title after successful cell execution + updateNotebookTitle(cell.notebook).catch(err => console.warn('Failed to update notebook title:', err)); } catch (err: any) { console.error('SqlExecutor: Execution failed:', err); @@ -356,6 +414,8 @@ export class SqlExecutor { new NotebookCellOutputItem(Buffer.from(String(err), 'utf8'), 'application/vnd.code.notebook.error') ])); execution.end(false, Date.now()); + // Update notebook title even after failed execution (cell content may have changed) + updateNotebookTitle(cell.notebook).catch(err => console.warn('Failed to update notebook title:', err)); } } diff --git a/src/renderer/components/ActionBar.ts b/src/renderer/components/ActionBar.ts new file mode 100644 index 0000000..b419c16 --- /dev/null +++ b/src/renderer/components/ActionBar.ts @@ -0,0 +1,98 @@ +/** + * ActionBar component for the Result Panel table data view. + * Renders a split bar with data actions on the left and AI actions on the right, + * separated by a visible vertical divider. + */ + +export interface ActionBarOptions { + onSelectAll: () => void; + onCopy: () => void; + onImport: () => void; + onExport: (exportBtn: HTMLElement) => void; + onSendToChat: () => void; + onAnalyzeWithAI: () => void; + onOptimize: () => void; +} + +/** + * Creates an action bar element with data actions (left) and AI actions (right). + * Layout: [ Select All | Copy | Import | Export ] | [ Send to Chat | Analyze with AI | Optimize ] + */ +export function createActionBar(options: ActionBarOptions): HTMLElement { + const container = document.createElement('div'); + container.style.cssText = ` + display: flex; + align-items: center; + justify-content: space-between; + padding: 4px 8px; + gap: 8px; + font-family: var(--vscode-font-family); + `; + + // Left group: data actions + const leftGroup = document.createElement('div'); + leftGroup.style.cssText = ` + display: flex; + align-items: center; + gap: 4px; + `; + leftGroup.appendChild(createButton('☐ Select All', options.onSelectAll)); + leftGroup.appendChild(createButton('⎘ Copy', options.onCopy)); + leftGroup.appendChild(createButton('⬆ Import', options.onImport)); + + // Export button — passed to onExport so the dropdown can anchor to it + const exportBtn = createButton('↓ Export', () => {}); + exportBtn.style.position = 'relative'; + exportBtn.onclick = () => options.onExport(exportBtn); + leftGroup.appendChild(exportBtn); + + // Vertical divider + const divider = document.createElement('div'); + divider.style.cssText = ` + border-left: 1px solid var(--vscode-panel-border); + align-self: stretch; + margin: 2px 4px; + `; + + // Right group: AI actions + const rightGroup = document.createElement('div'); + rightGroup.style.cssText = ` + display: flex; + align-items: center; + gap: 4px; + `; + rightGroup.appendChild(createButton('✦ Send to Chat', options.onSendToChat)); + rightGroup.appendChild(createButton('◎ Analyze with AI', options.onAnalyzeWithAI)); + rightGroup.appendChild(createButton('⚡ Optimize', options.onOptimize)); + + container.appendChild(leftGroup); + container.appendChild(divider); + container.appendChild(rightGroup); + + return container; +} + +function createButton(label: string, onClick: () => void): HTMLElement { + const btn = document.createElement('button'); + btn.textContent = label; + btn.style.cssText = ` + padding: 3px 8px; + font-size: 11px; + font-family: var(--vscode-font-family); + color: var(--vscode-button-secondaryForeground); + background: var(--vscode-button-secondaryBackground); + border: 1px solid var(--vscode-button-border, transparent); + border-radius: 3px; + cursor: pointer; + white-space: nowrap; + transition: background 0.15s; + `; + btn.onmouseover = () => { + btn.style.background = 'var(--vscode-button-secondaryHoverBackground)'; + }; + btn.onmouseout = () => { + btn.style.background = 'var(--vscode-button-secondaryBackground)'; + }; + btn.onclick = () => onClick(); + return btn; +} diff --git a/src/renderer/components/ColumnStats.ts b/src/renderer/components/ColumnStats.ts new file mode 100644 index 0000000..5af7fff --- /dev/null +++ b/src/renderer/components/ColumnStats.ts @@ -0,0 +1,175 @@ +/** + * ColumnStats.ts + * Computes and displays column statistics as a hover tooltip on column headers. + * Computed client-side from the current result rows (no additional DB query needed for typical result sizes). + */ + +import { ColumnStatsData } from '../../common/types'; + +export class ColumnStatsTooltip { + private tooltip: HTMLElement; + private currentAnchor: HTMLElement | null = null; + + constructor() { + this.tooltip = document.createElement('div'); + this.tooltip.style.cssText = ` + position:fixed; + background:var(--vscode-editorHoverWidget-background, #252526); + border:1px solid var(--vscode-editorHoverWidget-border, #454545); + border-radius:4px; + padding:10px 12px; + font-size:11px; + color:var(--vscode-editor-foreground); + z-index:9999; + pointer-events:none; + min-width:180px; + max-width:280px; + box-shadow:0 4px 12px rgba(0,0,0,0.4); + display:none; + line-height:1.6; + `; + document.body.appendChild(this.tooltip); + } + + /** + * Compute stats from in-memory rows (fast, client-side) + */ + static compute(rows: any[], column: string): ColumnStatsData { + let nullCount = 0; + const distinctSet = new Set(); + let min: any = undefined; + let max: any = undefined; + let totalLength = 0; + let stringCount = 0; + + for (const row of rows) { + const v = row[column]; + if (v === null || v === undefined || v === '') { + nullCount++; + continue; + } + distinctSet.add(String(v)); + + // Numeric min/max + const num = Number(v); + if (!isNaN(num)) { + if (min === undefined || num < min) { min = num; } + if (max === undefined || num > max) { max = num; } + } else { + // String min/max (lexicographic) + const s = String(v); + if (min === undefined || s < String(min)) { min = s; } + if (max === undefined || s > String(max)) { max = s; } + totalLength += s.length; + stringCount++; + } + } + + return { + column, + nullCount, + nullPct: rows.length > 0 ? (nullCount / rows.length) * 100 : 0, + distinctCount: distinctSet.size, + min, + max, + avgLength: stringCount > 0 ? totalLength / stringCount : undefined, + totalRows: rows.length, + }; + } + + private formatValue(v: any): string { + if (v === undefined) { return 'N/A'; } + if (typeof v === 'number') { + return v % 1 === 0 ? v.toString() : v.toFixed(4); + } + const s = String(v); + return s.length > 30 ? s.slice(0, 30) + '...' : s; + } + + show(anchor: HTMLElement, stats: ColumnStatsData) { + this.currentAnchor = anchor; + const rect = anchor.getBoundingClientRect(); + const nullBar = Math.round(stats.nullPct); + const nonNullBar = 100 - nullBar; + + this.tooltip.innerHTML = ` +
    ${stats.column}
    +
    + Rows +
    + ${stats.totalRows.toLocaleString()} + + Nulls +
    +
    +
    + ${stats.nullCount.toLocaleString()} (${stats.nullPct.toFixed(1)}%) + + Distinct +
    +
    +
    + ${stats.distinctCount.toLocaleString()} + + Min +
    + ${this.formatValue(stats.min)} + + Max +
    + ${this.formatValue(stats.max)} + ${stats.avgLength !== undefined ? ` + Avg len +
    + ${stats.avgLength.toFixed(1)} + ` : ''} +
    + `; + + // Position below the header cell + const top = rect.bottom + 4; + const left = Math.min(rect.left, window.innerWidth - 290); + this.tooltip.style.top = `${top}px`; + this.tooltip.style.left = `${left}px`; + this.tooltip.style.display = 'block'; + } + + hide() { + this.tooltip.style.display = 'none'; + this.currentAnchor = null; + } + + destroy() { + document.body.removeChild(this.tooltip); + } +} + +/** + * Attach stats tooltip to a column header element + */ +export function attachColumnStatsTooltip( + headerCell: HTMLElement, + column: string, + getRows: () => any[], + tooltip: ColumnStatsTooltip, + delayMs = 600 +) { + let hoverTimer: any; + + headerCell.style.cursor = 'help'; + headerCell.title = 'Hover for column statistics'; + + headerCell.addEventListener('mouseenter', () => { + hoverTimer = setTimeout(() => { + const rows = getRows(); + if (rows.length === 0) { return; } + const stats = ColumnStatsTooltip.compute(rows, column); + tooltip.show(headerCell, stats); + }, delayMs); + }); + + headerCell.addEventListener('mouseleave', () => { + clearTimeout(hoverTimer); + tooltip.hide(); + }); +} diff --git a/src/renderer/components/ErrorPanel.ts b/src/renderer/components/ErrorPanel.ts new file mode 100644 index 0000000..f042490 --- /dev/null +++ b/src/renderer/components/ErrorPanel.ts @@ -0,0 +1,99 @@ +/** + * ErrorPanel component for displaying query execution errors. + * Shows the raw PostgreSQL error, an optional plain-English explanation, + * and three action buttons: Explain error, Fix with AI, and Retry. + */ + +export interface ErrorPanelOptions { + errorCode?: string; + errorMessage: string; + explanation?: string; + cellId?: string; + onExplainError: () => void; + onFixWithAI: () => void; + onRetry: () => void; +} + +/** + * Creates an error panel element for displaying query execution failures. + */ +export function createErrorPanel(options: ErrorPanelOptions): HTMLElement { + const container = document.createElement('div'); + container.style.cssText = ` + border-left: 3px solid var(--vscode-errorForeground); + padding: 12px 16px; + margin: 8px 0; + background: var(--vscode-inputValidation-errorBackground, rgba(255, 0, 0, 0.05)); + font-family: var(--vscode-font-family); + color: var(--vscode-foreground); + `; + + // Raw error in monospace + const errorLine = document.createElement('div'); + const errorText = options.errorCode + ? `ERROR ${options.errorCode}: ${options.errorMessage}` + : options.errorMessage; + errorLine.textContent = errorText; + errorLine.style.cssText = ` + font-family: var(--vscode-editor-font-family, monospace); + font-size: 12px; + color: var(--vscode-errorForeground); + white-space: pre-wrap; + word-break: break-word; + margin-bottom: 8px; + `; + container.appendChild(errorLine); + + // Plain-English explanation (omitted when undefined) + if (options.explanation !== undefined) { + const explanationEl = document.createElement('p'); + explanationEl.textContent = options.explanation; + explanationEl.style.cssText = ` + margin: 0 0 12px 0; + font-size: 12px; + color: var(--vscode-descriptionForeground); + line-height: 1.5; + `; + container.appendChild(explanationEl); + } + + // Action buttons row + const actionsRow = document.createElement('div'); + actionsRow.style.cssText = ` + display: flex; + gap: 8px; + flex-wrap: wrap; + `; + + actionsRow.appendChild(createButton('◎ Explain error', options.onExplainError)); + actionsRow.appendChild(createButton('✦ Fix with AI', options.onFixWithAI)); + actionsRow.appendChild(createButton('↺ Retry', options.onRetry)); + + container.appendChild(actionsRow); + + return container; +} + +function createButton(label: string, onClick: () => void): HTMLElement { + const btn = document.createElement('button'); + btn.textContent = label; + btn.style.cssText = ` + padding: 4px 10px; + font-size: 11px; + font-family: var(--vscode-font-family); + color: var(--vscode-button-secondaryForeground); + background: var(--vscode-button-secondaryBackground); + border: 1px solid var(--vscode-button-border, transparent); + border-radius: 3px; + cursor: pointer; + transition: background 0.15s; + `; + btn.onmouseover = () => { + btn.style.background = 'var(--vscode-button-secondaryHoverBackground)'; + }; + btn.onmouseout = () => { + btn.style.background = 'var(--vscode-button-secondaryBackground)'; + }; + btn.onclick = () => onClick(); + return btn; +} diff --git a/src/renderer/components/ExplainVisualizer.ts b/src/renderer/components/ExplainVisualizer.ts index 1c39b34..6ce9ae5 100644 --- a/src/renderer/components/ExplainVisualizer.ts +++ b/src/renderer/components/ExplainVisualizer.ts @@ -39,6 +39,39 @@ export class ExplainVisualizer { return max; } + public getTimeBadgeColor(actualTotalTime: number): 'green' | 'amber' | 'red' { + if (actualTotalTime < 10) return 'green'; + if (actualTotalTime <= 100) return 'amber'; + return 'red'; + } + + public findHottestNode(node: ExplainNode): ExplainNode { + let hottest = node; + let maxTime = node['Actual Total Time'] ?? -Infinity; + + const traverse = (n: ExplainNode) => { + const t = n['Actual Total Time']; + if (t !== undefined && t > maxTime) { + maxTime = t; + hottest = n; + } + if (n.Plans) { + for (const child of n.Plans) { + traverse(child); + } + } + }; + + traverse(node); + + // If no node had Actual Total Time defined, return root + if (maxTime === -Infinity) { + return node; + } + + return hottest; + } + public render() { this.container.innerHTML = ''; @@ -139,6 +172,64 @@ export class ExplainVisualizer { background: var(--vscode-badge-background); color: var(--vscode-badge-foreground); } + .time-badge { + padding: 2px 6px; + border-radius: 3px; + font-size: 0.85em; + font-weight: 600; + } + .time-badge-green { + background: rgba(0, 180, 0, 0.2); + color: #4caf50; + } + .time-badge-amber { + background: rgba(255, 165, 0, 0.2); + color: #ff9800; + } + .time-badge-red { + background: rgba(220, 0, 0, 0.2); + color: #f44336; + } + .seq-scan-warning { + display: inline-block; + margin-left: 8px; + font-size: 0.85em; + font-weight: 600; + color: #ff9800; + } + .explain-summary-card { + margin: 12px 20px 20px; + padding: 12px 16px; + border: 1px solid var(--vscode-widget-border); + border-radius: 4px; + background: var(--vscode-editor-background); + font-family: var(--vscode-editor-font-family); + font-size: 13px; + } + .explain-summary-card h4 { + margin: 0 0 8px; + font-size: 0.9em; + text-transform: uppercase; + letter-spacing: 0.05em; + opacity: 0.6; + } + .explain-summary-bottleneck { + margin-bottom: 8px; + } + .explain-summary-suggestion { + margin-top: 8px; + padding: 8px; + background: rgba(255, 165, 0, 0.1); + border-left: 3px solid #ff9800; + border-radius: 2px; + } + .explain-summary-suggestion code { + font-family: var(--vscode-editor-font-family); + font-size: 0.9em; + display: block; + margin-top: 4px; + opacity: 0.9; + } `; this.container.appendChild(style); @@ -146,22 +237,79 @@ export class ExplainVisualizer { treeContainer.className = 'explain-tree'; if (this.plan) { - treeContainer.appendChild(this.createNodeElement(this.plan)); + const hottestNode = this.findHottestNode(this.plan); + treeContainer.appendChild(this.createNodeElement(this.plan, hottestNode)); + + // Append sequential scan warning to the hottest node element + if ( + hottestNode['Node Type'] === 'Seq Scan' && + (hottestNode['Actual Rows'] ?? 0) > 1000 + ) { + const hottestEl = treeContainer.querySelector('[data-hottest="true"]'); + if (hottestEl) { + const header = hottestEl.querySelector('.explain-node-header'); + if (header) { + const warning = document.createElement('span'); + warning.className = 'seq-scan-warning'; + warning.textContent = `⚠ missing index on ${hottestNode['Relation Name'] ?? 'unknown'}`; + header.appendChild(warning); + } + } + } } else { treeContainer.textContent = 'No plan data available'; } this.container.appendChild(treeContainer); + + // Render summary card below the tree + if (this.plan) { + const hottestNodeForSummary = this.findHottestNode(this.plan); + this.container.appendChild(this.renderSummaryCard(hottestNodeForSummary)); + } + } + + public renderSummaryCard(hottestNode: ExplainNode): HTMLElement { + const card = document.createElement('div'); + card.className = 'explain-summary-card'; + + const title = document.createElement('h4'); + title.textContent = 'Performance Summary'; + card.appendChild(title); + + const bottleneck = document.createElement('div'); + bottleneck.className = 'explain-summary-bottleneck'; + const actualTime = hottestNode['Actual Total Time']; + const timeStr = actualTime !== undefined ? ` (${actualTime.toFixed(2)} ms)` : ''; + bottleneck.textContent = `Primary bottleneck: ${hottestNode['Node Type']}${timeStr}`; + card.appendChild(bottleneck); + + if (hottestNode['Node Type'] === 'Seq Scan') { + const suggestion = document.createElement('div'); + suggestion.className = 'explain-summary-suggestion'; + + const label = document.createElement('span'); + label.textContent = '💡 Consider adding an index to speed up this sequential scan:'; + suggestion.appendChild(label); + + const relationName = hottestNode['Relation Name'] ?? 'table_name'; + const code = document.createElement('code'); + code.textContent = `CREATE INDEX ON ${relationName} (...);`; + suggestion.appendChild(code); + + card.appendChild(suggestion); + } + + return card; } - private createNodeElement(node: ExplainNode): HTMLElement { + private createNodeElement(node: ExplainNode, hottestNode?: ExplainNode): HTMLElement { const el = document.createElement('div'); el.className = 'explain-node'; - // Heuristic for cost coloring - const costRatio = (node['Total Cost'] || 0) / (this.maxCost || 1); - if (costRatio > 0.5) el.classList.add('high-cost'); - else if (costRatio > 0.2) el.classList.add('medium-cost'); + if (hottestNode && node === hottestNode) { + el.dataset.hottest = 'true'; + } // Header const header = document.createElement('div'); @@ -208,7 +356,8 @@ export class ExplainVisualizer { const totalCost = node['Total Cost']; if (actualTime !== undefined) { - stats.innerHTML = `⏱️ ${actualTime.toFixed(2)}ms`; + const color = this.getTimeBadgeColor(actualTime); + stats.innerHTML = `⏱ ${actualTime.toFixed(2)}ms`; } stats.innerHTML += `💰 ${totalCost.toFixed(2)}`; @@ -228,10 +377,8 @@ export class ExplainVisualizer { // Cost Bar const bar = document.createElement('div'); bar.className = 'cost-bar'; + const costRatio = (node['Total Cost'] || 0) / (this.maxCost || 1); bar.style.width = `${Math.min(100, costRatio * 100)}%`; - // Color logic - if (costRatio > 0.5) bar.style.backgroundColor = 'var(--vscode-errorForeground)'; - else if (costRatio > 0.2) bar.style.backgroundColor = 'var(--vscode-charts-yellow)'; el.appendChild(bar); // Details Panel @@ -268,7 +415,7 @@ export class ExplainVisualizer { const children = document.createElement('div'); children.className = 'explain-children'; node.Plans.forEach(child => { - children.appendChild(this.createNodeElement(child)); + children.appendChild(this.createNodeElement(child, hottestNode)); }); el.appendChild(children); } diff --git a/src/renderer/components/ResultTabStrip.ts b/src/renderer/components/ResultTabStrip.ts new file mode 100644 index 0000000..30bad0d --- /dev/null +++ b/src/renderer/components/ResultTabStrip.ts @@ -0,0 +1,117 @@ +/** + * ResultTabStrip.ts + * Maintains a history of result sets per notebook cell output element. + * Allows users to switch between previous results within the same cell. + */ + +import { ResultHistoryEntry } from '../../common/types'; + +const MAX_HISTORY = 5; + +// WeakMap keyed by the output container element — cleared by GC when element is removed +const historyStore = new WeakMap(); + +export function getResultHistory(element: Element): ResultHistoryEntry[] { + return historyStore.get(element) || []; +} + +export function addResultToHistory(element: Element, entry: ResultHistoryEntry): ResultHistoryEntry[] { + const existing = historyStore.get(element) || []; + const updated = [entry, ...existing].slice(0, MAX_HISTORY); + historyStore.set(element, updated); + return updated; +} + +/** + * Renders the tab strip and returns the selected history entry. + * Returns null if only one result (no tabs needed). + */ +export function renderTabStrip( + container: HTMLElement, + history: ResultHistoryEntry[], + activeIndex: number, + onSelect: (index: number) => void +): HTMLElement | null { + if (history.length <= 1) { return null; } + + const strip = document.createElement('div'); + strip.style.cssText = ` + display:flex; + align-items:center; + gap:0; + background:var(--vscode-tab-inactiveBackground, #2d2d2d); + border-bottom:1px solid var(--vscode-widget-border); + overflow-x:auto; + scrollbar-width:thin; + flex-shrink:0; + `; + + history.forEach((entry, i) => { + const tab = document.createElement('div'); + const isActive = i === activeIndex; + const elapsed = Date.now() - entry.timestamp; + const timeAgo = formatTimeAgo(elapsed); + const rowCount = entry.rowCount ?? (entry.rows?.length ?? 0); + const label = entry.command + ? `${entry.command} · ${rowCount.toLocaleString()} rows` + : `${rowCount.toLocaleString()} rows`; + + tab.style.cssText = ` + padding:5px 12px; + font-size:11px; + cursor:pointer; + white-space:nowrap; + border-right:1px solid var(--vscode-widget-border); + color:${isActive ? 'var(--vscode-tab-activeForeground)' : 'var(--vscode-tab-inactiveForeground)'}; + background:${isActive ? 'var(--vscode-tab-activeBackground)' : 'transparent'}; + border-bottom:${isActive ? '2px solid var(--vscode-focusBorder)' : '2px solid transparent'}; + user-select:none; + display:flex;flex-direction:column;gap:1px; + `; + + const labelDiv = document.createElement('div'); + labelDiv.textContent = i === 0 ? `▶ ${label}` : label; + labelDiv.style.fontWeight = isActive ? '500' : '400'; + + const metaDiv = document.createElement('div'); + metaDiv.textContent = `${timeAgo}${entry.executionTime ? ` · ${entry.executionTime}ms` : ''}`; + metaDiv.style.cssText = 'font-size:9px;color:var(--vscode-descriptionForeground);'; + + tab.appendChild(labelDiv); + tab.appendChild(metaDiv); + + tab.addEventListener('click', () => onSelect(i)); + tab.addEventListener('mouseenter', () => { + if (!isActive) { tab.style.background = 'var(--vscode-list-hoverBackground)'; } + }); + tab.addEventListener('mouseleave', () => { + if (!isActive) { tab.style.background = 'transparent'; } + }); + + strip.appendChild(tab); + }); + + // "Clear history" button at end + const clearBtn = document.createElement('div'); + clearBtn.textContent = '⊗'; + clearBtn.title = 'Clear result history'; + clearBtn.style.cssText = ` + padding:5px 10px;cursor:pointer; + color:var(--vscode-descriptionForeground); + font-size:14px;line-height:1; + margin-left:auto; + `; + clearBtn.addEventListener('click', () => { + historyStore.delete(container); + onSelect(0); // Re-render with cleared history + }); + strip.appendChild(clearBtn); + + return strip; +} + +function formatTimeAgo(ms: number): string { + if (ms < 60000) { return 'just now'; } + if (ms < 3600000) { return `${Math.floor(ms / 60000)}m ago`; } + return `${Math.floor(ms / 3600000)}h ago`; +} diff --git a/src/renderer/components/TopBar.ts b/src/renderer/components/TopBar.ts new file mode 100644 index 0000000..ffcb9e0 --- /dev/null +++ b/src/renderer/components/TopBar.ts @@ -0,0 +1,153 @@ +/** + * TopBar component for the Notebook top-level action bar. + * Renders a flex container with notebook-level action buttons and a right-aligned connection pill. + * + * Requirements: 1.1, 1.2, 1.3, 1.4 + */ + +export interface TopBarOptions { + connectionName: string; + host: string; + database: string; + isConnected: boolean; + onRunAll: () => void; + onClearOutputs: () => void; + onAddCodeCell: () => void; + onAddMarkdownCell: () => void; +} + +/** + * Creates a TopBar element with action buttons and a connection pill. + */ +export function createTopBar(options: TopBarOptions, postMessage: (msg: any) => void): HTMLElement { + ensureTopBarStyle(); + + const bar = document.createElement('div'); + bar.style.cssText = ` + display: flex; + align-items: center; + gap: 6px; + padding: 6px 12px; + background: var(--vscode-editor-background); + border-bottom: 1px solid var(--vscode-widget-border); + font-family: var(--vscode-font-family); + font-size: 12px; + `; + + // Action buttons (left side) + bar.appendChild(createTopBarButton('▶ Run All', options.onRunAll)); + bar.appendChild(createTopBarButton('✕ Clear Outputs', options.onClearOutputs)); + bar.appendChild(createSeparator()); + bar.appendChild(createTopBarButton('+ Code Cell', options.onAddCodeCell)); + bar.appendChild(createTopBarButton('+ Markdown Cell', options.onAddMarkdownCell)); + + // Connection pill (right-aligned via margin-left: auto) + const pill = createConnectionPill(options, postMessage); + bar.appendChild(pill); + + return bar; +} + +function createConnectionPill(options: TopBarOptions, postMessage: (msg: any) => void): HTMLElement { + const pill = document.createElement('button'); + pill.style.cssText = ` + margin-left: auto; + display: flex; + align-items: center; + gap: 6px; + padding: 3px 10px; + font-size: 11px; + font-family: var(--vscode-font-family); + border-radius: 10px; + cursor: pointer; + border: 1px solid ${options.isConnected ? 'var(--vscode-testing-iconPassed)' : 'var(--vscode-editorError-foreground)'}; + background: ${options.isConnected + ? 'color-mix(in srgb, var(--vscode-testing-iconPassed) 12%, var(--vscode-editor-background))' + : 'color-mix(in srgb, var(--vscode-editorError-foreground) 12%, var(--vscode-editor-background))'}; + color: var(--vscode-editor-foreground); + transition: opacity 0.15s; + white-space: nowrap; + `; + + // Status dot + const dot = document.createElement('span'); + dot.style.cssText = ` + width: 7px; + height: 7px; + border-radius: 50%; + display: inline-block; + background: ${options.isConnected ? 'var(--vscode-testing-iconPassed)' : 'var(--vscode-editorError-foreground)'}; + flex-shrink: 0; + `; + if (!options.isConnected) { + dot.className = 'topbar-dot-disconnected'; + } + + const label = document.createElement('span'); + if (options.isConnected) { + label.textContent = `${options.connectionName} · ${options.database}`; + pill.title = `Host: ${options.host}\nDatabase: ${options.database}`; + } else { + label.textContent = 'Not connected'; + pill.title = 'No active connection'; + } + + pill.appendChild(dot); + pill.appendChild(label); + + pill.onmouseover = () => { pill.style.opacity = '0.8'; }; + pill.onmouseout = () => { pill.style.opacity = '1'; }; + pill.onclick = () => { + postMessage({ type: 'showConnectionInfo' }); + }; + + return pill; +} + +function createTopBarButton(label: string, onClick: () => void): HTMLElement { + const btn = document.createElement('button'); + btn.textContent = label; + btn.style.cssText = ` + padding: 3px 8px; + font-size: 11px; + font-family: var(--vscode-font-family); + color: var(--vscode-button-secondaryForeground); + background: var(--vscode-button-secondaryBackground); + border: 1px solid var(--vscode-button-border, transparent); + border-radius: 3px; + cursor: pointer; + white-space: nowrap; + transition: background 0.15s; + `; + btn.onmouseover = () => { btn.style.background = 'var(--vscode-button-secondaryHoverBackground)'; }; + btn.onmouseout = () => { btn.style.background = 'var(--vscode-button-secondaryBackground)'; }; + btn.onclick = () => onClick(); + return btn; +} + +function createSeparator(): HTMLElement { + const sep = document.createElement('div'); + sep.style.cssText = ` + border-left: 1px solid var(--vscode-panel-border); + align-self: stretch; + margin: 2px 2px; + `; + return sep; +} + +function ensureTopBarStyle(): void { + const STYLE_ID = 'topbar-disconnected-style'; + if (document.getElementById(STYLE_ID)) return; + const style = document.createElement('style'); + style.id = STYLE_ID; + style.textContent = ` + @keyframes topbar-blink { + 0%, 100% { opacity: 1; } + 50% { opacity: 0.3; } + } + .topbar-dot-disconnected { + animation: topbar-blink 1.4s ease-in-out infinite; + } + `; + document.head.appendChild(style); +} diff --git a/src/renderer/components/TransactionBanner.ts b/src/renderer/components/TransactionBanner.ts new file mode 100644 index 0000000..16b1062 --- /dev/null +++ b/src/renderer/components/TransactionBanner.ts @@ -0,0 +1,89 @@ +/** + * TransactionBanner component for displaying an open transaction state. + * Renders an amber pulsing banner with statement count and Commit/Rollback buttons. + */ + +export interface TransactionBannerOptions { + statementCount: number; + onCommit: () => void; + onRollback: () => void; +} + +// Inject the pulse-amber keyframe animation once into the document +function ensurePulseAmberStyle(): void { + const STYLE_ID = 'transaction-banner-pulse-amber'; + if (document.getElementById(STYLE_ID)) return; + + const style = document.createElement('style'); + style.id = STYLE_ID; + style.textContent = ` + @keyframes pulse-amber { + 0% { background-color: rgba(255, 176, 0, 0.18); } + 50% { background-color: rgba(255, 176, 0, 0.32); } + 100% { background-color: rgba(255, 176, 0, 0.18); } + } + .transaction-banner-pulse { + animation: pulse-amber 2s ease-in-out infinite; + } + `; + document.head.appendChild(style); +} + +/** + * Creates a TransactionBanner element. + * Shows "Transaction open · {n} statements · not committed" with Commit and Rollback buttons. + */ +export function createTransactionBanner(options: TransactionBannerOptions): HTMLElement { + ensurePulseAmberStyle(); + + const banner = document.createElement('div'); + banner.className = 'transaction-banner-pulse'; + banner.dataset.transactionBanner = 'true'; + banner.style.cssText = ` + display: flex; + align-items: center; + gap: 12px; + padding: 8px 16px; + border-left: 4px solid #ffb000; + border-bottom: 1px solid rgba(255, 176, 0, 0.4); + font-family: var(--vscode-font-family); + font-size: 12px; + color: var(--vscode-editorWarning-foreground, #ffb000); + `; + + // Text label + const label = document.createElement('span'); + label.style.cssText = 'flex: 1; font-weight: 500;'; + label.textContent = `Transaction open · ${options.statementCount} statement${options.statementCount !== 1 ? 's' : ''} · not committed`; + banner.appendChild(label); + + // Commit button + banner.appendChild(createBannerButton('Commit', '#ffb000', options.onCommit)); + + // Rollback button + banner.appendChild(createBannerButton('Rollback', 'transparent', options.onRollback)); + + return banner; +} + +function createBannerButton(label: string, bgColor: string, onClick: () => void): HTMLElement { + const btn = document.createElement('button'); + btn.textContent = label; + const isFilled = bgColor !== 'transparent'; + btn.style.cssText = ` + padding: 3px 10px; + font-size: 11px; + font-family: var(--vscode-font-family); + color: ${isFilled ? '#000' : 'var(--vscode-editorWarning-foreground, #ffb000)'}; + background: ${bgColor}; + border: 1px solid #ffb000; + border-radius: 3px; + cursor: pointer; + font-weight: ${isFilled ? '600' : '400'}; + transition: opacity 0.15s; + `; + btn.onmouseover = () => { btn.style.opacity = '0.8'; }; + btn.onmouseout = () => { btn.style.opacity = '1'; }; + btn.onclick = () => onClick(); + return btn; +} diff --git a/src/renderer/components/TransposeView.ts b/src/renderer/components/TransposeView.ts new file mode 100644 index 0000000..75a9920 --- /dev/null +++ b/src/renderer/components/TransposeView.ts @@ -0,0 +1,133 @@ +/** + * TransposeView.ts + * Flips rows and columns for wide-row inspection. + * Limited to MAX_ROWS_TO_TRANSPOSE rows to avoid UI overflow. + */ + +export const MAX_ROWS_TO_TRANSPOSE = 100; + +export interface TransposeResult { + columns: string[]; // ['Column', 'Row 0', 'Row 1', ...] + rows: any[]; // One row per original column +} + +export function transposeResult( + originalColumns: string[], + originalRows: any[] +): TransposeResult | { error: string } { + if (originalRows.length > MAX_ROWS_TO_TRANSPOSE) { + return { + error: `Transpose is limited to ${MAX_ROWS_TO_TRANSPOSE} rows. Current result has ${originalRows.length} rows.` + }; + } + + const headerRow: string[] = ['Column', ...originalRows.map((_, i) => `Row ${i + 1}`)]; + + const transposedRows = originalColumns.map(col => { + const rowObj: Record = { Column: col }; + originalRows.forEach((row, i) => { + rowObj[`Row ${i + 1}`] = row[col]; + }); + return rowObj; + }); + + return { + columns: headerRow, + rows: transposedRows, + }; +} + +/** + * Creates a transposed table element directly (lightweight, no full TableRenderer) + */ +export function renderTransposeTable( + columns: string[], + rows: any[], + formatValue: (v: any) => string +): HTMLElement { + const result = transposeResult(columns, rows); + + if ('error' in result) { + const err = document.createElement('div'); + err.style.cssText = 'padding:12px;color:var(--vscode-errorForeground);font-size:12px;'; + err.textContent = result.error; + return err; + } + + const wrapper = document.createElement('div'); + wrapper.style.cssText = 'overflow:auto;max-height:60vh;'; + + const table = document.createElement('table'); + table.style.cssText = ` + border-collapse:collapse; + font-size:12px; + width:100%; + font-variant-numeric:tabular-nums; + `; + + // Header row + const thead = document.createElement('thead'); + const headerTr = document.createElement('tr'); + result.columns.forEach((col, i) => { + const th = document.createElement('th'); + th.textContent = col; + th.style.cssText = ` + padding:4px 8px; + text-align:left; + background:var(--vscode-editor-background); + border-bottom:2px solid var(--vscode-widget-border); + font-size:11px;font-weight:600; + color:var(--vscode-descriptionForeground); + position:sticky;top:0; + ${i === 0 ? 'position:sticky;left:0;z-index:2;background:var(--vscode-editor-background);border-right:1px solid var(--vscode-widget-border);' : ''} + `; + headerTr.appendChild(th); + }); + thead.appendChild(headerTr); + table.appendChild(thead); + + // Data rows + const tbody = document.createElement('tbody'); + result.rows.forEach((row, rowIdx) => { + const tr = document.createElement('tr'); + tr.style.background = rowIdx % 2 === 0 ? '' : 'rgba(128,128,128,0.04)'; + + result.columns.forEach((col, colIdx) => { + const td = document.createElement('td'); + const v = row[col]; + + if (colIdx === 0) { + // Column name cell + td.style.cssText = ` + padding:4px 8px; + font-weight:600; + font-size:11px; + color:var(--vscode-descriptionForeground); + border-right:1px solid var(--vscode-widget-border); + border-bottom:1px solid rgba(128,128,128,0.1); + position:sticky;left:0; + background:var(--vscode-editor-background); + white-space:nowrap; + `; + td.textContent = v; + } else { + td.style.cssText = ` + padding:4px 8px; + border-bottom:1px solid rgba(128,128,128,0.1); + max-width:200px; + overflow:hidden;text-overflow:ellipsis;white-space:nowrap; + color:${v === null || v === undefined ? 'var(--vscode-descriptionForeground)' : 'var(--vscode-editor-foreground)'}; + `; + td.textContent = v === null || v === undefined ? 'NULL' : formatValue(v); + if (v !== null && v !== undefined) { + td.title = String(v); + } + } + tr.appendChild(td); + }); + tbody.appendChild(tr); + }); + table.appendChild(tbody); + wrapper.appendChild(table); + return wrapper; +} diff --git a/src/renderer/components/chart/ChartControls.ts b/src/renderer/components/chart/ChartControls.ts index 9d49832..b9f1c40 100644 --- a/src/renderer/components/chart/ChartControls.ts +++ b/src/renderer/components/chart/ChartControls.ts @@ -1,377 +1,241 @@ -import { DEFAULT_COLORS, BORDER_COLORS } from './ChartRenderer'; import { ChartRenderOptions } from '../../../common/types'; -import { isDateColumn, formatDate, rgbaToHex, hexToRgba, getNumericColumns } from '../../utils/formatting'; +import { getNumericColumns } from '../../utils/formatting'; export interface ChartControlsProps { columns: string[]; + columnTypes?: Record; rows: any[]; onConfigChange: (config: ChartRenderOptions) => void; } +/** + * Numeric PostgreSQL type names used for Y-axis auto-detection. + */ +const NUMERIC_PG_TYPES = new Set([ + 'int2', 'int4', 'int8', 'float4', 'float8', 'numeric', 'decimal', + 'money', 'real', 'double precision', 'bigint', 'integer', 'smallint' +]); + +/** + * Detect numeric columns using PostgreSQL column type metadata when available, + * falling back to value-based heuristics. + */ +export function detectNumericColumns( + columns: string[], + rows: any[], + columnTypes?: Record +): string[] { + if (columnTypes && Object.keys(columnTypes).length > 0) { + const byType = columns.filter(col => { + const t = (columnTypes[col] || '').toLowerCase().trim(); + return NUMERIC_PG_TYPES.has(t) || t.startsWith('int') || t.startsWith('float') || t.startsWith('numeric'); + }); + if (byType.length > 0) return byType; + } + // Fallback: value-based detection + return getNumericColumns(columns, rows); +} + +/** + * Auto-detect X and Y axis columns: + * - Y-axis: numeric columns + * - X-axis: first non-numeric column (or first column if all are numeric) + */ +export function autoDetectAxes( + columns: string[], + rows: any[], + columnTypes?: Record +): { xAxis: string; yAxes: string[] } { + const numericCols = detectNumericColumns(columns, rows, columnTypes); + const numericSet = new Set(numericCols); + + const firstNonNumeric = columns.find(col => !numericSet.has(col)); + const xAxis = firstNonNumeric ?? columns[0] ?? ''; + const yAxes = numericCols.length > 0 ? [numericCols[0]] : []; + + return { xAxis, yAxes }; +} + export class ChartControls { private container: HTMLElement; private props: ChartControlsProps; - // State + // State — only the five required controls private selectedChartType: string = 'bar'; - private selectedXAxis: string; + private selectedXAxis: string = ''; private selectedYAxis: string[] = []; - private selectedPieValueCol: string = ''; - - // Options - private chartTitle = ''; - private legendPosition = 'bottom'; - private showGridX = true; - private showGridY = true; - private enableAnimation = true; // Not used in RenderOptions directly but useful for Renderer if we passed it? - // Actually Renderer has 'animation' option. - private yAxisMin: number | null = null; - private yAxisMax: number | null = null; - private useLogScale = false; - private sortBy = 'none'; - private limitRows: number | null = null; - private horizontalBars = false; - private lineStyle = 'solid'; - private pointStyle = 'circle'; - private curveTension = 0.4; - private showDataLabels = false; - private blurEffect = false; - - // Pie specific - private hiddenSlices = new Set(); - private sliceColors = new Map(); - private seriesColors = new Map(); // For bar/line/area - - // UI Refs - private slicesContainer!: HTMLElement; - private yAxisSection!: HTMLElement; - private valuesSection!: HTMLElement; - private slicesSection!: HTMLElement; + private useLogScale: boolean = false; + private showLegend: boolean = true; constructor(container: HTMLElement, props: ChartControlsProps) { this.container = container; this.props = props; - // Defaults - this.selectedXAxis = props.columns[0] || ''; - const numericCols = getNumericColumns(props.columns, props.rows); - if (numericCols.length > 0) { - this.selectedYAxis = [numericCols[0]]; - this.selectedPieValueCol = numericCols[0]; - } + // Auto-detect axes on first render (Requirement 7.3) + const { xAxis, yAxes } = autoDetectAxes(props.columns, props.rows, props.columnTypes); + this.selectedXAxis = xAxis; + this.selectedYAxis = yAxes; this.createUI(); this.emitConfig(); } - // Should be called if data changes + /** Call when data changes to re-validate selections. */ public updateProps(newProps: Partial) { this.props = { ...this.props, ...newProps }; - // Re-validate selections - if (!this.props.columns.includes(this.selectedXAxis)) this.selectedXAxis = this.props.columns[0] || ''; - // Re-render UI chunks if needed - this.rebuildSlicesUI(); + if (!this.props.columns.includes(this.selectedXAxis)) { + const { xAxis, yAxes } = autoDetectAxes(this.props.columns, this.props.rows, this.props.columnTypes); + this.selectedXAxis = xAxis; + this.selectedYAxis = yAxes; + } } private createUI() { this.container.innerHTML = ''; - this.container.style.cssText = 'display: flex; flex-direction: column; gap: 12px; height: 100%; overflow-y: auto; padding-right: 4px;'; - - // 1. Chart Type Selection - const typeSection = this.createSection('Chart Type'); - const typeSelect = document.createElement('select'); - typeSelect.style.cssText = 'width: 100%; padding: 4px; margin-bottom: 8px; border: 1px solid var(--vscode-input-border); background: var(--vscode-input-background); color: var(--vscode-input-foreground); border-radius: 3px; font-size: 11px;'; - - [['bar', '📊 Bar Chart'], ['line', '📈 Line Chart'], ['area', '🗻 Area Chart'], - ['pie', '🥧 Pie Chart'], ['doughnut', '🍩 Doughnut'], ['stackedBar', '📚 Stacked Bar']] - .forEach(([val, text]) => { - const opt = document.createElement('option'); - opt.value = val; - opt.textContent = text; - if (val === this.selectedChartType) opt.selected = true; - typeSelect.appendChild(opt); - }); - + // Sidebar is exactly 140 px wide (Requirement 7.2) + this.container.style.cssText = [ + 'width: 140px', + 'min-width: 140px', + 'max-width: 140px', + 'display: flex', + 'flex-direction: column', + 'gap: 10px', + 'height: 100%', + 'overflow-y: auto', + 'padding: 8px', + 'box-sizing: border-box', + 'border-left: 1px solid var(--vscode-panel-border)', + 'background: var(--vscode-sideBar-background)', + ].join('; '); + + const numericCols = detectNumericColumns(this.props.columns, this.props.rows, this.props.columnTypes); + + // ── 1. Chart Type ────────────────────────────────────────────── + this.container.appendChild(this.makeLabel('Chart Type')); + const typeSelect = this.makeSelect( + [ + ['bar', 'Bar'], + ['line', 'Line'], + ['area', 'Area'], + ['pie', 'Pie'], + ['doughnut', 'Doughnut'], + ['stackedBar', 'Stacked Bar'], + ], + this.selectedChartType + ); typeSelect.onchange = () => { this.selectedChartType = typeSelect.value; - this.updateSectionsVisibility(); - this.emitConfig(); + this.emitConfig(); // Requirement 7.4 — immediate re-render }; - typeSection.appendChild(typeSelect); - this.container.appendChild(typeSection); - - // 2. X-Axis Selection - const axisSection = this.createSection('Axes'); - const xLabel = document.createElement('label'); - xLabel.textContent = 'X-Axis (Category/Time)'; - xLabel.style.cssText = 'font-size: 11px; display: block; margin-bottom: 3px; opacity: 0.8;'; - axisSection.appendChild(xLabel); - - const xSelect = document.createElement('select'); - xSelect.style.cssText = 'width: 100%; padding: 4px; margin-bottom: 8px; border: 1px solid var(--vscode-input-border); background: var(--vscode-input-background); color: var(--vscode-input-foreground); border-radius: 3px; font-size: 11px;'; - this.props.columns.forEach(col => { - const opt = document.createElement('option'); - opt.value = col; - opt.textContent = col; - if (col === this.selectedXAxis) opt.selected = true; - xSelect.appendChild(opt); - }); + this.container.appendChild(typeSelect); + + // ── 2. X-Axis ────────────────────────────────────────────────── + this.container.appendChild(this.makeLabel('X-Axis')); + const xSelect = this.makeSelect( + this.props.columns.map(c => [c, c]), + this.selectedXAxis + ); xSelect.onchange = () => { this.selectedXAxis = xSelect.value; - this.rebuildSlicesUI(); // Slices depend on X-Axis labels - this.emitConfig(); - }; - axisSection.appendChild(xSelect); - this.container.appendChild(axisSection); - - // 3. Y-Axis Section (for non-pie) - this.yAxisSection = document.createElement('div'); - const yLabel = document.createElement('label'); - yLabel.textContent = 'Y-Axis (Values)'; - yLabel.style.cssText = 'font-size: 11px; display: block; margin-bottom: 3px; opacity: 0.8;'; - this.yAxisSection.appendChild(yLabel); - - const numericCols = getNumericColumns(this.props.columns, this.props.rows); - const yContainer = document.createElement('div'); - yContainer.style.cssText = 'display: flex; flex-direction: column; gap: 4px; max-height: 150px; overflow-y: auto; padding: 4px; border: 1px solid var(--vscode-widget-border); border-radius: 3px;'; - - if (numericCols.length === 0) { - yContainer.textContent = 'No numeric columns found'; - yContainer.style.padding = '8px'; - yContainer.style.fontStyle = 'italic'; - yContainer.style.opacity = '0.7'; - } else { - numericCols.forEach((col, idx) => { - const row = document.createElement('div'); - row.style.cssText = 'display: flex; align-items: center; gap: 6px;'; - - const cb = document.createElement('input'); - cb.type = 'checkbox'; - cb.checked = this.selectedYAxis.includes(col); - cb.onchange = () => { - if (cb.checked) { - if (!this.selectedYAxis.includes(col)) this.selectedYAxis.push(col); - } else { - this.selectedYAxis = this.selectedYAxis.filter(c => c !== col); - } - // Color picker visibility? - // For simplicity, re-render Y-axis list if we want to show/hide color pickers dynamically - // or just always show them. - this.emitConfig(); - }; - - const span = document.createElement('span'); - span.textContent = col; - span.style.flex = '1'; - - // Color Picker for series - const colorPicker = document.createElement('input'); - colorPicker.type = 'color'; - // Default color logic matching Renderer - const defaultColor = DEFAULT_COLORS[idx % DEFAULT_COLORS.length]; - colorPicker.value = rgbaToHex(this.seriesColors.get(col) || defaultColor); - colorPicker.style.cssText = 'width: 16px; height: 16px; border: none; cursor: pointer; padding: 0;'; - colorPicker.oninput = () => { - this.seriesColors.set(col, hexToRgba(colorPicker.value, 0.6)); - this.emitConfig(); - }; - - row.appendChild(cb); - row.appendChild(span); - row.appendChild(colorPicker); - yContainer.appendChild(row); - }); - } - this.yAxisSection.appendChild(yContainer); - this.container.appendChild(this.yAxisSection); - - // 4. Values Section (for Pie) - this.valuesSection = document.createElement('div'); - this.valuesSection.style.display = 'none'; // Hidden by default - const vLabel = document.createElement('label'); - vLabel.textContent = 'Value Column (Size)'; - vLabel.style.cssText = 'font-size: 11px; display: block; margin-bottom: 3px; opacity: 0.8;'; - this.valuesSection.appendChild(vLabel); - - const vSelect = document.createElement('select'); - vSelect.style.cssText = 'width: 100%; padding: 4px; margin-bottom: 8px; border: 1px solid var(--vscode-input-border); background: var(--vscode-input-background); color: var(--vscode-input-foreground); border-radius: 3px; font-size: 11px;'; - - // Option for "Count of Rows" - const countOpt = document.createElement('option'); - countOpt.value = ''; - countOpt.textContent = 'Count of Rows'; - vSelect.appendChild(countOpt); - - numericCols.forEach(col => { - const opt = document.createElement('option'); - opt.value = col; - opt.textContent = col; - if (col === this.selectedPieValueCol) opt.selected = true; - vSelect.appendChild(opt); - }); - vSelect.onchange = () => { - this.selectedPieValueCol = vSelect.value; - this.rebuildSlicesUI(); - this.emitConfig(); + this.emitConfig(); // Requirement 7.4 }; - this.valuesSection.appendChild(vSelect); - this.container.appendChild(this.valuesSection); - - // 5. Slices Section (Pie) - this.slicesSection = this.createSection('Slices'); - this.slicesSection.style.display = 'none'; - this.slicesContainer = document.createElement('div'); - this.slicesContainer.style.cssText = 'display: flex; flex-direction: column; gap: 4px; max-height: 200px; overflow-y: auto;'; - this.slicesSection.appendChild(this.slicesContainer); - this.container.appendChild(this.slicesSection); - - // 6. General Options - const optionsSection = this.createSection('⚙️ Options'); - const optsContainer = document.createElement('div'); - optsContainer.style.cssText = 'display: flex; flex-direction: column; gap: 8px;'; - - const createRow = (label: string, elem: HTMLElement) => { - const r = document.createElement('div'); - r.style.cssText = 'display: flex; align-items: center; justify-content: space-between; gap: 6px;'; - const l = document.createElement('span'); - l.textContent = label; - l.style.cssText = 'font-size: 11px; flex-shrink: 0;'; - r.appendChild(l); - elem.style.cssText += 'flex: 1; max-width: 100px;'; - r.appendChild(elem); - return r; + this.container.appendChild(xSelect); + + // ── 3. Y-Axis ────────────────────────────────────────────────── + this.container.appendChild(this.makeLabel('Y-Axis')); + const ySelect = this.makeSelect( + numericCols.length > 0 + ? numericCols.map(c => [c, c]) + : this.props.columns.map(c => [c, c]), + this.selectedYAxis[0] ?? '' + ); + ySelect.onchange = () => { + this.selectedYAxis = ySelect.value ? [ySelect.value] : []; + this.emitConfig(); // Requirement 7.4 }; + this.container.appendChild(ySelect); - // Title - const titleInput = document.createElement('input'); - titleInput.placeholder = 'Chart title...'; - titleInput.style.cssText = 'padding: 4px; border: 1px solid var(--vscode-input-border); background: var(--vscode-input-background); color: var(--vscode-input-foreground); border-radius: 3px; font-size: 11px;'; - titleInput.oninput = () => { this.chartTitle = titleInput.value; this.emitConfig(); }; - optsContainer.appendChild(createRow('Title', titleInput)); - - // Legend - const legSelect = document.createElement('select'); - legSelect.style.cssText = 'padding: 3px; border: 1px solid var(--vscode-input-border); background: var(--vscode-input-background); color: var(--vscode-input-foreground); border-radius: 3px; font-size: 11px;'; - ['top', 'bottom', 'left', 'right', 'hidden'].forEach(p => legSelect.add(new Option(p, p, p === this.legendPosition))); - legSelect.onchange = () => { this.legendPosition = legSelect.value; this.emitConfig(); }; - optsContainer.appendChild(createRow('Legend', legSelect)); - - // Sorting - const sortSelect = document.createElement('select'); - sortSelect.style.cssText = 'padding: 3px; border: 1px solid var(--vscode-input-border); background: var(--vscode-input-background); color: var(--vscode-input-foreground); border-radius: 3px; font-size: 10px;'; - [['none', 'None'], ['label-asc', 'Label ↑'], ['label-desc', 'Label ↓'], ['value-asc', 'Value ↑'], ['value-desc', 'Value ↓']].forEach(([v, t]) => sortSelect.add(new Option(t, v))); - sortSelect.onchange = () => { this.sortBy = sortSelect.value; this.emitConfig(); }; - optsContainer.appendChild(createRow('Sort', sortSelect)); - - optionsSection.appendChild(optsContainer); - this.container.appendChild(optionsSection); - - this.updateSectionsVisibility(); - } + // ── 4. Log Scale toggle ──────────────────────────────────────── + const logRow = this.makeToggleRow('Log Scale', this.useLogScale, (checked) => { + this.useLogScale = checked; + this.emitConfig(); // Requirement 7.4 + 7.5 + }); + this.container.appendChild(logRow); - // Helpers - private createSection(title: string) { - const div = document.createElement('div'); - div.style.cssText = 'border-top: 1px solid var(--vscode-panel-border); padding-top: 10px;'; - const h = document.createElement('div'); - h.textContent = title; - h.style.cssText = 'font-weight: 600; margin-bottom: 8px; font-size: 11px; text-transform: uppercase; opacity: 0.8;'; - div.appendChild(h); - return div; + // ── 5. Legend toggle ─────────────────────────────────────────── + const legendRow = this.makeToggleRow('Legend', this.showLegend, (checked) => { + this.showLegend = checked; + this.emitConfig(); // Requirement 7.4 + 7.6 + }); + this.container.appendChild(legendRow); } - private updateSectionsVisibility() { - const isPie = this.selectedChartType === 'pie' || this.selectedChartType === 'doughnut'; - this.yAxisSection.style.display = isPie ? 'none' : 'block'; - this.valuesSection.style.display = isPie ? 'block' : 'none'; - this.slicesSection.style.display = isPie ? 'block' : 'none'; - if (isPie) this.rebuildSlicesUI(); + private makeLabel(text: string): HTMLElement { + const label = document.createElement('div'); + label.textContent = text; + label.style.cssText = 'font-size: 11px; font-weight: 600; opacity: 0.8; text-transform: uppercase; margin-top: 4px;'; + return label; } - private rebuildSlicesUI() { - this.slicesContainer.innerHTML = ''; - if (this.props.rows.length === 0) return; - - const isXDate = isDateColumn(this.selectedXAxis); - const aggregated = new Map(); - this.props.rows.forEach(row => { - const raw = row[this.selectedXAxis]; - const label = isXDate && raw ? formatDate(raw, 'YYYY-MM-DD') : String(raw ?? 'Unknown'); - const exist = aggregated.get(label) || { value: 0, count: 0 }; - if (this.selectedPieValueCol) exist.value += parseFloat(row[this.selectedPieValueCol]) || 0; - exist.count++; - aggregated.set(label, exist); - }); - - const sliceData: { label: string; value: number; index: number }[] = []; - let i = 0; - let total = 0; - aggregated.forEach((val, label) => { - const v = this.selectedPieValueCol ? val.value : val.count; - sliceData.push({ label, value: v, index: i++ }); - if (!this.hiddenSlices.has(label)) total += v; + private makeSelect(options: [string, string][], selectedValue: string): HTMLSelectElement { + const sel = document.createElement('select'); + sel.style.cssText = [ + 'width: 100%', + 'padding: 3px 4px', + 'border: 1px solid var(--vscode-input-border)', + 'background: var(--vscode-input-background)', + 'color: var(--vscode-input-foreground)', + 'border-radius: 3px', + 'font-size: 11px', + 'box-sizing: border-box', + ].join('; '); + options.forEach(([val, text]) => { + const opt = document.createElement('option'); + opt.value = val; + opt.textContent = text; + if (val === selectedValue) opt.selected = true; + sel.appendChild(opt); }); + return sel; + } - sliceData.forEach(({ label, value, index }) => { - if (!this.sliceColors.has(label)) this.sliceColors.set(label, DEFAULT_COLORS[index % DEFAULT_COLORS.length]); - - const isHidden = this.hiddenSlices.has(label); - const pct = total > 0 && !isHidden ? ((value / total) * 100).toFixed(1) : '0.0'; - - const row = document.createElement('div'); - row.style.cssText = 'display: flex; align-items: center; gap: 6px; padding: 2px 0;'; - const cb = document.createElement('input'); - cb.type = 'checkbox'; cb.checked = !isHidden; - cb.onchange = () => { - if (cb.checked) this.hiddenSlices.delete(label); else this.hiddenSlices.add(label); - this.rebuildSlicesUI(); // Update percentages - this.emitConfig(); - }; - - const span = document.createElement('span'); - span.textContent = isHidden ? label : `${label} (${pct}%)`; - span.style.cssText = `flex: 1; font-size: 11px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; ${isHidden ? 'opacity: 0.5' : ''}`; - - const color = document.createElement('input'); - color.type = 'color'; - color.value = rgbaToHex(this.sliceColors.get(label)!); - color.style.cssText = 'width: 16px; height: 16px; border: none; padding: 0; cursor: pointer;'; - color.oninput = () => { - this.sliceColors.set(label, hexToRgba(color.value, 0.85)); - this.emitConfig(); - }; - - row.append(cb, span, color); - this.slicesContainer.appendChild(row); - }); + private makeToggleRow( + label: string, + initialValue: boolean, + onChange: (checked: boolean) => void + ): HTMLElement { + const row = document.createElement('div'); + row.style.cssText = 'display: flex; align-items: center; justify-content: space-between; gap: 4px; margin-top: 4px;'; + + const lbl = document.createElement('span'); + lbl.textContent = label; + lbl.style.cssText = 'font-size: 11px; opacity: 0.8;'; + + const cb = document.createElement('input'); + cb.type = 'checkbox'; + cb.checked = initialValue; + cb.style.cssText = 'cursor: pointer;'; + cb.onchange = () => onChange(cb.checked); + + row.appendChild(lbl); + row.appendChild(cb); + return row; } private emitConfig() { + const numericCols = detectNumericColumns(this.props.columns, this.props.rows, this.props.columnTypes); const config: ChartRenderOptions = { type: this.selectedChartType, xAxisCol: this.selectedXAxis, yAxisCols: this.selectedYAxis, - numericCols: getNumericColumns(this.props.columns, this.props.rows), - sortBy: this.sortBy, - limitRows: this.limitRows || undefined, - dateFormat: 'YYYY-MM-DD', + numericCols, useLogScale: this.useLogScale, - showGridX: this.showGridX, - showGridY: this.showGridY, - showDataLabels: this.showDataLabels, + legendPosition: this.showLegend ? 'bottom' : 'hidden', + showGridX: true, + showGridY: true, showLabels: true, - chartTitle: this.chartTitle, - legendPosition: this.legendPosition, - horizontalBars: this.horizontalBars, - curveTension: this.curveTension, - lineStyle: this.lineStyle, - pointStyle: this.pointStyle, - blurEffect: this.blurEffect, - hiddenSlices: this.hiddenSlices, - selectedPieValueCol: this.selectedPieValueCol, - seriesColors: this.seriesColors, - sliceColors: this.sliceColors, - textColor: '#ccc' // Ideally detect theme but defaulting for now + dateFormat: 'YYYY-MM-DD', + textColor: '#ccc', }; this.props.onConfigChange(config); } diff --git a/src/renderer/components/table/CellEditors.ts b/src/renderer/components/table/CellEditors.ts new file mode 100644 index 0000000..cdae5b5 --- /dev/null +++ b/src/renderer/components/table/CellEditors.ts @@ -0,0 +1,683 @@ +/** + * CellEditors.ts + * Type-aware inline cell editor factory for PgStudio's data grid. + * All editors run in the notebook webview (no VS Code API access). + */ + +export interface CellEditorOptions { + columnName: string; + columnType: string; // PostgreSQL type name e.g. 'int4', 'timestamptz', '_text' + currentValue: any; + isNullable?: boolean; + onSave: (newValue: any) => void; + onCancel: () => void; + onFkLookup?: (searchText: string, callback: (rows: any[], columns: string[]) => void) => void; + isFkColumn?: boolean; +} + +export type EditorType = 'text' | 'number' | 'boolean' | 'date' | 'time' | 'datetime' | 'json' | 'array' | 'fk' | 'longtext'; + +/** + * Determine editor type from PostgreSQL type string + */ +export function getEditorType(columnType: string, currentValue: any): EditorType { + const type = (columnType || '').toLowerCase(); + + // Array types start with underscore in pg OID naming + if (type.startsWith('_') || type === 'array') { return 'array'; } + + // Boolean + if (type === 'bool' || type === 'boolean') { return 'boolean'; } + + // Numeric + if (['int2', 'int4', 'int8', 'float4', 'float8', 'numeric', 'decimal', 'money', + 'smallint', 'integer', 'bigint', 'real', 'double precision'].includes(type)) { + return 'number'; + } + + // Date/time + if (type === 'date') { return 'date'; } + if (type === 'time' || type === 'timetz') { return 'time'; } + if (type === 'timestamp' || type === 'timestamptz' || + type === 'timestamp without time zone' || type === 'timestamp with time zone') { + return 'datetime'; + } + + // JSON + if (type === 'json' || type === 'jsonb') { return 'json'; } + + // Long text detection + if (typeof currentValue === 'string' && currentValue.length > 200) { return 'longtext'; } + + return 'text'; +} + +/** + * Main factory function: creates the appropriate editor element + * and returns it ready to be injected into the cell. + */ +export function createCellEditor(options: CellEditorOptions): HTMLElement { + const { columnType, currentValue, isFkColumn, onFkLookup } = options; + + if (isFkColumn && onFkLookup) { + return createFkEditor(options); + } + + const editorType = getEditorType(columnType, currentValue); + + switch (editorType) { + case 'boolean': return createBooleanEditor(options); + case 'number': return createNumberEditor(options); + case 'date': return createDateEditor(options); + case 'time': return createTimeEditor(options); + case 'datetime': return createDateTimeEditor(options); + case 'json': return createJsonEditor(options); + case 'array': return createArrayEditor(options); + case 'longtext': return createLongTextEditor(options); + default: return createTextEditor(options); + } +} + +// ─── Shared utilities ─────────────────────────────────────────────── + +function applyEditorBaseStyle(el: HTMLElement) { + el.style.cssText = ` + background: var(--vscode-input-background, #1e1e1e); + color: var(--vscode-input-foreground, #cccccc); + border: 1px solid var(--vscode-focusBorder, #007acc); + border-radius: 2px; + padding: 2px 4px; + font-family: inherit; + font-size: inherit; + outline: none; + box-sizing: border-box; + width: 100%; + `; +} + +function handleKeydown(e: KeyboardEvent, onSave: () => void, onCancel: () => void) { + if (e.key === 'Enter' && !e.shiftKey) { e.preventDefault(); onSave(); } + if (e.key === 'Escape') { e.preventDefault(); onCancel(); } +} + +// ─── Boolean ──────────────────────────────────────────────────────── + +function createBooleanEditor(opts: CellEditorOptions): HTMLElement { + const wrapper = document.createElement('div'); + wrapper.style.cssText = 'display:flex;align-items:center;gap:6px;padding:2px 4px;'; + + const checkbox = document.createElement('input'); + checkbox.type = 'checkbox'; + checkbox.checked = Boolean(opts.currentValue); + checkbox.style.cursor = 'pointer'; + + const label = document.createElement('label'); + label.textContent = checkbox.checked ? 'true' : 'false'; + label.style.cssText = 'font-size:11px;color:var(--vscode-descriptionForeground);'; + + checkbox.addEventListener('change', () => { + label.textContent = checkbox.checked ? 'true' : 'false'; + }); + + checkbox.addEventListener('keydown', (e) => { + if (e.key === 'Enter') { opts.onSave(checkbox.checked); } + if (e.key === 'Escape') { opts.onCancel(); } + }); + + checkbox.addEventListener('blur', () => opts.onSave(checkbox.checked)); + + wrapper.appendChild(checkbox); + wrapper.appendChild(label); + setTimeout(() => checkbox.focus(), 0); + return wrapper; +} + +// ─── Number ───────────────────────────────────────────────────────── + +function createNumberEditor(opts: CellEditorOptions): HTMLElement { + const input = document.createElement('input'); + input.type = 'number'; + input.value = opts.currentValue !== null && opts.currentValue !== undefined + ? String(opts.currentValue) : ''; + applyEditorBaseStyle(input); + input.style.minWidth = '80px'; + + const save = () => { + const v = input.value.trim(); + opts.onSave(v === '' ? null : Number(v)); + }; + + input.addEventListener('keydown', (e) => handleKeydown(e, save, opts.onCancel)); + input.addEventListener('blur', save); + setTimeout(() => { input.focus(); input.select(); }, 0); + return input; +} + +// ─── Text ──────────────────────────────────────────────────────────── + +function createTextEditor(opts: CellEditorOptions): HTMLElement { + const input = document.createElement('input'); + input.type = 'text'; + input.value = opts.currentValue !== null && opts.currentValue !== undefined + ? String(opts.currentValue) : ''; + applyEditorBaseStyle(input); + + const save = () => opts.onSave(input.value === '' && opts.isNullable ? null : input.value); + input.addEventListener('keydown', (e) => handleKeydown(e, save, opts.onCancel)); + input.addEventListener('blur', save); + setTimeout(() => { input.focus(); input.select(); }, 0); + return input; +} + +// ─── Long Text (modal overlay) ─────────────────────────────────────── + +function createLongTextEditor(opts: CellEditorOptions): HTMLElement { + return createModalEditor({ + title: opts.columnName, + initialContent: opts.currentValue != null ? String(opts.currentValue) : '', + isCode: false, + validate: () => null, + onSave: opts.onSave, + onCancel: opts.onCancel, + }); +} + +// ─── Date ──────────────────────────────────────────────────────────── + +function createDateEditor(opts: CellEditorOptions): HTMLElement { + const input = document.createElement('input'); + input.type = 'date'; + + // Normalize current value to YYYY-MM-DD + if (opts.currentValue) { + try { + const d = new Date(opts.currentValue); + if (!isNaN(d.getTime())) { + input.value = d.toISOString().split('T')[0]; + } else { + input.value = String(opts.currentValue).split('T')[0]; + } + } catch { input.value = ''; } + } + + applyEditorBaseStyle(input); + const save = () => opts.onSave(input.value || null); + input.addEventListener('keydown', (e) => handleKeydown(e, save, opts.onCancel)); + input.addEventListener('blur', save); + setTimeout(() => input.focus(), 0); + return input; +} + +// ─── Time ──────────────────────────────────────────────────────────── + +function createTimeEditor(opts: CellEditorOptions): HTMLElement { + const input = document.createElement('input'); + input.type = 'time'; + input.step = '1'; // Show seconds + + if (opts.currentValue) { + // Extract HH:MM:SS from time string + const timeStr = String(opts.currentValue); + const match = timeStr.match(/(\d{2}:\d{2}(:\d{2})?)/); + if (match) { input.value = match[1]; } + } + + applyEditorBaseStyle(input); + const save = () => opts.onSave(input.value || null); + input.addEventListener('keydown', (e) => handleKeydown(e, save, opts.onCancel)); + input.addEventListener('blur', save); + setTimeout(() => input.focus(), 0); + return input; +} + +// ─── DateTime ──────────────────────────────────────────────────────── + +function createDateTimeEditor(opts: CellEditorOptions): HTMLElement { + const wrapper = document.createElement('div'); + wrapper.style.cssText = 'display:flex;flex-direction:column;gap:4px;min-width:220px;'; + + const input = document.createElement('input'); + input.type = 'datetime-local'; + input.step = '1'; + + if (opts.currentValue) { + try { + const d = new Date(opts.currentValue); + if (!isNaN(d.getTime())) { + // datetime-local format: YYYY-MM-DDTHH:MM:SS + const iso = d.toISOString().replace('Z', '').slice(0, 19); + input.value = iso; + } + } catch { /* leave empty */ } + } + + applyEditorBaseStyle(input); + + const hint = document.createElement('span'); + hint.textContent = 'Local time (UTC stored if timestamptz)'; + hint.style.cssText = 'font-size:10px;color:var(--vscode-descriptionForeground);'; + + const save = () => { + if (!input.value) { opts.onSave(null); return; } + // Return ISO string - PostgreSQL handles it + opts.onSave(input.value.replace('T', ' ')); + }; + + input.addEventListener('keydown', (e) => handleKeydown(e, save, opts.onCancel)); + input.addEventListener('blur', save); + + wrapper.appendChild(input); + wrapper.appendChild(hint); + setTimeout(() => input.focus(), 0); + return wrapper; +} + +// ─── JSON Modal ─────────────────────────────────────────────────────── + +function createJsonEditor(opts: CellEditorOptions): HTMLElement { + let formatted = ''; + try { + const parsed = typeof opts.currentValue === 'string' + ? JSON.parse(opts.currentValue) + : opts.currentValue; + formatted = JSON.stringify(parsed, null, 2); + } catch { + formatted = opts.currentValue != null ? String(opts.currentValue) : ''; + } + + return createModalEditor({ + title: `${opts.columnName} (JSON)`, + initialContent: formatted, + isCode: true, + validate: (content) => { + try { JSON.parse(content); return null; } + catch (e) { return `Invalid JSON: ${(e as Error).message}`; } + }, + onSave: (content) => { + try { opts.onSave(JSON.parse(content)); } + catch { opts.onSave(content); } // fallback: save as string + }, + onCancel: opts.onCancel, + }); +} + +// ─── Array Editor ───────────────────────────────────────────────────── + +function createArrayEditor(opts: CellEditorOptions): HTMLElement { + // Parse PostgreSQL array literal: {val1,val2,"val3"} + const parseArrayLiteral = (v: any): string[] => { + if (Array.isArray(v)) { return v.map(String); } + if (typeof v !== 'string') { return []; } + const s = v.trim(); + if (!s.startsWith('{') || !s.endsWith('}')) { return [s]; } + // Simple split — handles basic cases (not nested arrays) + return s.slice(1, -1).split(',').map(item => { + item = item.trim(); + if (item.startsWith('"') && item.endsWith('"')) { + return item.slice(1, -1).replace(/\\"/g, '"'); + } + return item === 'NULL' ? '' : item; + }); + }; + + const toArrayLiteral = (items: string[]): string => { + return '{' + items.map(item => { + if (item === '' || item === 'NULL') { return 'NULL'; } + if (item.includes(',') || item.includes('"') || item.includes('{')) { + return '"' + item.replace(/"/g, '\\"') + '"'; + } + return item; + }).join(',') + '}'; + }; + + const wrapper = document.createElement('div'); + wrapper.style.cssText = ` + background: var(--vscode-input-background); + border: 1px solid var(--vscode-focusBorder); + border-radius: 3px; + padding: 8px; + min-width: 200px; + max-width: 400px; + position: relative; + z-index: 1000; + `; + + const items = parseArrayLiteral(opts.currentValue); + + const header = document.createElement('div'); + header.style.cssText = 'display:flex;justify-content:space-between;margin-bottom:6px;'; + header.innerHTML = `Array items (${opts.columnType})`; + + const itemsContainer = document.createElement('div'); + itemsContainer.style.cssText = 'display:flex;flex-direction:column;gap:4px;max-height:200px;overflow-y:auto;'; + + const renderItems = () => { + itemsContainer.innerHTML = ''; + items.forEach((item, idx) => { + const row = document.createElement('div'); + row.style.cssText = 'display:flex;gap:4px;align-items:center;'; + + const index = document.createElement('span'); + index.textContent = `[${idx}]`; + index.style.cssText = 'font-size:10px;color:var(--vscode-descriptionForeground);min-width:28px;'; + + const input = document.createElement('input'); + input.type = 'text'; + input.value = item; + applyEditorBaseStyle(input); + input.style.flex = '1'; + input.addEventListener('input', () => { items[idx] = input.value; }); + input.addEventListener('keydown', (e) => { + if (e.key === 'Enter') { items.splice(idx + 1, 0, ''); renderItems(); } + if (e.key === 'Escape') { opts.onCancel(); } + }); + + const removeBtn = document.createElement('button'); + removeBtn.textContent = '×'; + removeBtn.style.cssText = ` + background:none;border:none;color:var(--vscode-errorForeground); + cursor:pointer;font-size:14px;padding:0 4px;line-height:1; + `; + removeBtn.addEventListener('click', () => { items.splice(idx, 1); renderItems(); }); + + row.appendChild(index); + row.appendChild(input); + row.appendChild(removeBtn); + itemsContainer.appendChild(row); + }); + }; + + renderItems(); + + const footer = document.createElement('div'); + footer.style.cssText = 'display:flex;gap:6px;margin-top:8px;justify-content:space-between;'; + + const addBtn = document.createElement('button'); + addBtn.textContent = '+ Add item'; + addBtn.style.cssText = ` + background:none;border:1px solid var(--vscode-button-border,#555); + color:var(--vscode-button-foreground);border-radius:2px; + padding:2px 8px;cursor:pointer;font-size:11px; + `; + addBtn.addEventListener('click', () => { items.push(''); renderItems(); }); + + const btnGroup = document.createElement('div'); + btnGroup.style.cssText = 'display:flex;gap:4px;'; + + const saveBtn = document.createElement('button'); + saveBtn.textContent = 'Save'; + saveBtn.style.cssText = ` + background:var(--vscode-button-background);color:var(--vscode-button-foreground); + border:none;border-radius:2px;padding:2px 10px;cursor:pointer;font-size:11px; + `; + saveBtn.addEventListener('click', () => opts.onSave(toArrayLiteral(items))); + + const cancelBtn = document.createElement('button'); + cancelBtn.textContent = 'Cancel'; + cancelBtn.style.cssText = ` + background:none;border:1px solid var(--vscode-button-border,#555); + color:var(--vscode-descriptionForeground);border-radius:2px; + padding:2px 8px;cursor:pointer;font-size:11px; + `; + cancelBtn.addEventListener('click', opts.onCancel); + + btnGroup.appendChild(saveBtn); + btnGroup.appendChild(cancelBtn); + footer.appendChild(addBtn); + footer.appendChild(btnGroup); + + wrapper.appendChild(header); + wrapper.appendChild(itemsContainer); + wrapper.appendChild(footer); + return wrapper; +} + +// ─── FK Dropdown ────────────────────────────────────────────────────── + +function createFkEditor(opts: CellEditorOptions): HTMLElement { + const wrapper = document.createElement('div'); + wrapper.style.cssText = 'position:relative;min-width:180px;'; + + const input = document.createElement('input'); + input.type = 'text'; + input.value = opts.currentValue != null ? String(opts.currentValue) : ''; + input.placeholder = 'Search...'; + applyEditorBaseStyle(input); + + const dropdown = document.createElement('div'); + dropdown.style.cssText = ` + position:absolute;top:100%;left:0;right:0; + background:var(--vscode-dropdown-background,#252526); + border:1px solid var(--vscode-focusBorder); + border-top:none;border-radius:0 0 3px 3px; + max-height:200px;overflow-y:auto;z-index:9999; + box-shadow:0 4px 8px rgba(0,0,0,0.3); + display:none; + `; + + let debounceTimer: any; + const pendingCallbacks = new Map void>(); + + const showLoading = () => { + dropdown.style.display = 'block'; + dropdown.innerHTML = '
    Loading...
    '; + }; + + const populateDropdown = (rows: any[], columns: string[]) => { + dropdown.innerHTML = ''; + if (rows.length === 0) { + dropdown.innerHTML = '
    No matches
    '; + return; + } + + rows.forEach(row => { + const item = document.createElement('div'); + const displayValue = row[columns[0]]; + const secondaryValue = columns[1] ? ` — ${row[columns[1]]}` : ''; + item.style.cssText = ` + padding:5px 8px;cursor:pointer;font-size:12px; + border-bottom:1px solid var(--vscode-widget-border); + `; + item.innerHTML = `${displayValue}${secondaryValue}`; + item.addEventListener('mousedown', (e) => { + e.preventDefault(); + opts.onSave(displayValue); + dropdown.style.display = 'none'; + }); + item.addEventListener('mouseover', () => { item.style.background = 'var(--vscode-list-hoverBackground)'; }); + item.addEventListener('mouseout', () => { item.style.background = ''; }); + dropdown.appendChild(item); + }); + }; + + const search = (text: string) => { + if (!opts.onFkLookup) { return; } + showLoading(); + const requestId = Math.random().toString(36).slice(2); + pendingCallbacks.set(requestId, populateDropdown); + opts.onFkLookup(text, (rows, cols) => { + const cb = pendingCallbacks.get(requestId); + if (cb) { cb(rows, cols); pendingCallbacks.delete(requestId); } + }); + }; + + input.addEventListener('input', () => { + clearTimeout(debounceTimer); + debounceTimer = setTimeout(() => search(input.value), 300); + }); + + input.addEventListener('focus', () => { + dropdown.style.display = 'block'; + if (dropdown.children.length === 0) { search(input.value); } + }); + + input.addEventListener('blur', () => { + setTimeout(() => { dropdown.style.display = 'none'; }, 150); + }); + + input.addEventListener('keydown', (e) => { + if (e.key === 'Enter') { opts.onSave(input.value); dropdown.style.display = 'none'; } + if (e.key === 'Escape') { opts.onCancel(); dropdown.style.display = 'none'; } + }); + + wrapper.appendChild(input); + wrapper.appendChild(dropdown); + setTimeout(() => { input.focus(); input.select(); search(''); }, 0); + return wrapper; +} + +// ─── Modal Editor (shared by JSON and LongText) ─────────────────────── + +interface ModalEditorOptions { + title: string; + initialContent: string; + isCode: boolean; + validate: (content: string) => string | null; + onSave: (content: string) => void; + onCancel: () => void; +} + +function createModalEditor(opts: ModalEditorOptions): HTMLElement { + // The inline placeholder that triggers the modal + const placeholder = document.createElement('div'); + placeholder.style.cssText = ` + padding:2px 6px; + background:var(--vscode-input-background); + border:1px solid var(--vscode-focusBorder); + border-radius:2px; + font-size:11px; + color:var(--vscode-descriptionForeground); + cursor:pointer; + white-space:nowrap; + overflow:hidden; + text-overflow:ellipsis; + max-width:200px; + `; + const preview = opts.initialContent.slice(0, 60) + (opts.initialContent.length > 60 ? '...' : ''); + placeholder.textContent = preview || '(empty)'; + placeholder.title = 'Click to open editor'; + + // Create and show the modal immediately + const showModal = () => { + const overlay = document.createElement('div'); + overlay.style.cssText = ` + position:fixed;inset:0; + background:rgba(0,0,0,0.6); + z-index:10000; + display:flex;align-items:center;justify-content:center; + `; + + const modal = document.createElement('div'); + modal.style.cssText = ` + background:var(--vscode-editor-background); + border:1px solid var(--vscode-focusBorder); + border-radius:4px; + padding:16px; + width:600px;max-width:90vw; + display:flex;flex-direction:column;gap:10px; + box-shadow:0 8px 32px rgba(0,0,0,0.5); + `; + + const titleBar = document.createElement('div'); + titleBar.style.cssText = 'display:flex;justify-content:space-between;align-items:center;'; + titleBar.innerHTML = ` + ${opts.title} + Ctrl+Enter to save • Escape to cancel + `; + + const textarea = document.createElement('textarea'); + textarea.value = opts.initialContent; + textarea.style.cssText = ` + background:var(--vscode-input-background); + color:var(--vscode-input-foreground); + border:1px solid var(--vscode-widget-border); + border-radius:2px; + padding:8px; + font-family:var(--vscode-editor-font-family,monospace); + font-size:12px; + resize:vertical; + min-height:200px; + max-height:60vh; + outline:none; + width:100%; + box-sizing:border-box; + `; + + const errorDiv = document.createElement('div'); + errorDiv.style.cssText = 'color:var(--vscode-errorForeground);font-size:11px;min-height:16px;'; + + const btnRow = document.createElement('div'); + btnRow.style.cssText = 'display:flex;gap:6px;justify-content:flex-end;'; + + const formatBtn = opts.isCode ? document.createElement('button') : null; + if (formatBtn) { + formatBtn.textContent = 'Format JSON'; + formatBtn.style.cssText = ` + background:none;border:1px solid var(--vscode-button-border,#555); + color:var(--vscode-descriptionForeground);border-radius:2px; + padding:4px 10px;cursor:pointer;font-size:12px;margin-right:auto; + `; + formatBtn.addEventListener('click', () => { + try { + textarea.value = JSON.stringify(JSON.parse(textarea.value), null, 2); + errorDiv.textContent = ''; + } catch (e) { + errorDiv.textContent = `Cannot format: ${(e as Error).message}`; + } + }); + btnRow.appendChild(formatBtn); + } + + const saveBtn = document.createElement('button'); + saveBtn.textContent = 'Save'; + saveBtn.style.cssText = ` + background:var(--vscode-button-background);color:var(--vscode-button-foreground); + border:none;border-radius:2px;padding:4px 14px;cursor:pointer;font-size:12px; + `; + + const cancelBtn = document.createElement('button'); + cancelBtn.textContent = 'Cancel'; + cancelBtn.style.cssText = ` + background:none;border:1px solid var(--vscode-button-border,#555); + color:var(--vscode-descriptionForeground);border-radius:2px; + padding:4px 10px;cursor:pointer;font-size:12px; + `; + + const doSave = () => { + const err = opts.validate(textarea.value); + if (err) { errorDiv.textContent = err; return; } + document.body.removeChild(overlay); + opts.onSave(textarea.value); + }; + + const doCancel = () => { + document.body.removeChild(overlay); + opts.onCancel(); + }; + + textarea.addEventListener('keydown', (e) => { + if (e.key === 'Enter' && e.ctrlKey) { doSave(); } + if (e.key === 'Escape') { doCancel(); } + }); + + saveBtn.addEventListener('click', doSave); + cancelBtn.addEventListener('click', doCancel); + overlay.addEventListener('click', (e) => { if (e.target === overlay) { doCancel(); } }); + + btnRow.appendChild(saveBtn); + btnRow.appendChild(cancelBtn); + + modal.appendChild(titleBar); + modal.appendChild(textarea); + modal.appendChild(errorDiv); + modal.appendChild(btnRow); + overlay.appendChild(modal); + document.body.appendChild(overlay); + setTimeout(() => { textarea.focus(); textarea.setSelectionRange(0, 0); }, 0); + }; + + // Show immediately since we're creating this in response to a user action + showModal(); + + return placeholder; +} diff --git a/src/renderer/components/table/FilterBar.ts b/src/renderer/components/table/FilterBar.ts new file mode 100644 index 0000000..6cc53f3 --- /dev/null +++ b/src/renderer/components/table/FilterBar.ts @@ -0,0 +1,189 @@ +/** + * FilterBar.ts + * Client-side filter bar for the data grid. + * Filters visible rows without re-querying the database. + */ + +import { FilterState } from '../../../common/types'; + +export interface FilterBarOptions { + columns: string[]; + filterState: FilterState; + onFilterChange: (state: FilterState) => void; +} + +export class FilterBar { + private container: HTMLElement; + private filterState: FilterState; + private onFilterChange: (state: FilterState) => void; + private inputs: Map = new Map(); + private globalInput: HTMLInputElement | null = null; + private mode: 'global' | 'column' = 'global'; + + constructor(options: FilterBarOptions) { + this.container = document.createElement('div'); + this.filterState = new Map(options.filterState); + this.onFilterChange = options.onFilterChange; + this.render(options.columns); + } + + getElement(): HTMLElement { + return this.container; + } + + private render(columns: string[]) { + this.container.innerHTML = ''; + this.container.style.cssText = ` + display:flex;align-items:center;gap:6px; + padding:4px 8px; + background:var(--vscode-editor-background); + border-bottom:1px solid var(--vscode-widget-border); + flex-wrap:wrap; + `; + + // Mode toggle button + const modeBtn = document.createElement('button'); + modeBtn.textContent = '⚡ Filter'; + modeBtn.title = 'Toggle between global and per-column filter'; + modeBtn.style.cssText = ` + background:none;border:1px solid var(--vscode-widget-border); + color:var(--vscode-foreground);border-radius:2px; + padding:2px 8px;cursor:pointer;font-size:11px;white-space:nowrap; + `; + + const inputArea = document.createElement('div'); + inputArea.style.cssText = 'display:flex;gap:6px;align-items:center;flex:1;flex-wrap:wrap;'; + + const renderGlobal = () => { + inputArea.innerHTML = ''; + const input = document.createElement('input'); + input.type = 'text'; + input.placeholder = 'Filter all columns...'; + input.value = this.filterState.get('__global__') || ''; + input.style.cssText = ` + flex:1;min-width:120px;max-width:300px; + background:var(--vscode-input-background); + color:var(--vscode-input-foreground); + border:1px solid var(--vscode-widget-border); + border-radius:2px;padding:2px 6px;font-size:11px;outline:none; + `; + input.addEventListener('input', () => { + if (input.value) { + this.filterState.set('__global__', input.value); + } else { + this.filterState.delete('__global__'); + } + this.onFilterChange(new Map(this.filterState)); + }); + this.globalInput = input; + inputArea.appendChild(input); + setTimeout(() => input.focus(), 0); + }; + + const renderColumns = () => { + inputArea.innerHTML = ''; + this.inputs.clear(); + columns.slice(0, 8).forEach(col => { // Limit to 8 columns for UI reasons + const wrapper = document.createElement('div'); + wrapper.style.cssText = 'display:flex;flex-direction:column;gap:1px;'; + + const label = document.createElement('span'); + label.textContent = col; + label.style.cssText = 'font-size:9px;color:var(--vscode-descriptionForeground);text-transform:uppercase;letter-spacing:0.5px;'; + + const input = document.createElement('input'); + input.type = 'text'; + input.placeholder = '...'; + input.value = this.filterState.get(col) || ''; + input.style.cssText = ` + width:90px; + background:var(--vscode-input-background); + color:var(--vscode-input-foreground); + border:1px solid var(--vscode-widget-border); + border-radius:2px;padding:2px 4px;font-size:11px;outline:none; + `; + input.addEventListener('input', () => { + if (input.value) { + this.filterState.set(col, input.value); + } else { + this.filterState.delete(col); + } + this.onFilterChange(new Map(this.filterState)); + }); + this.inputs.set(col, input); + wrapper.appendChild(label); + wrapper.appendChild(input); + inputArea.appendChild(wrapper); + }); + }; + + modeBtn.addEventListener('click', () => { + this.mode = this.mode === 'global' ? 'column' : 'global'; + modeBtn.textContent = this.mode === 'global' ? '⚡ Filter' : '⚡ Columns'; + this.filterState.clear(); + this.onFilterChange(new Map(this.filterState)); + if (this.mode === 'global') { renderGlobal(); } else { renderColumns(); } + }); + + // Clear button + const clearBtn = document.createElement('button'); + clearBtn.textContent = '✕'; + clearBtn.title = 'Clear all filters'; + clearBtn.style.cssText = ` + background:none;border:none;color:var(--vscode-descriptionForeground); + cursor:pointer;font-size:13px;padding:0 4px;line-height:1; + `; + clearBtn.addEventListener('click', () => { + this.filterState.clear(); + this.onFilterChange(new Map(this.filterState)); + if (this.mode === 'global') { renderGlobal(); } else { renderColumns(); } + }); + + // Active filter count badge + const badge = document.createElement('span'); + const updateBadge = () => { + const count = this.filterState.size; + badge.textContent = count > 0 ? `${count} active` : ''; + badge.style.cssText = count > 0 + ? 'font-size:10px;color:var(--vscode-badge-foreground);background:var(--vscode-badge-background);padding:1px 5px;border-radius:8px;' + : ''; + }; + updateBadge(); + + this.container.appendChild(modeBtn); + this.container.appendChild(inputArea); + this.container.appendChild(badge); + this.container.appendChild(clearBtn); + + renderGlobal(); // Start in global mode + } + + /** + * Apply filter to rows — returns filtered rows + */ + static applyFilter(rows: any[], filterState: FilterState, columns: string[]): any[] { + if (filterState.size === 0) { return rows; } + + const globalFilter = filterState.get('__global__')?.toLowerCase(); + + return rows.filter(row => { + if (globalFilter) { + // Global: row matches if ANY column contains the filter text + return columns.some(col => { + const v = row[col]; + if (v === null || v === undefined) { return false; } + return String(v).toLowerCase().includes(globalFilter); + }); + } + + // Per-column: ALL specified column filters must match + for (const [col, filterText] of filterState.entries()) { + if (col === '__global__') { continue; } + const v = row[col]; + if (v === null || v === undefined) { return false; } + if (!String(v).toLowerCase().includes(filterText.toLowerCase())) { return false; } + } + return true; + }); + } +} diff --git a/src/renderer/components/table/TableRenderer.ts b/src/renderer/components/table/TableRenderer.ts index d781cd0..d0d95a5 100644 --- a/src/renderer/components/table/TableRenderer.ts +++ b/src/renderer/components/table/TableRenderer.ts @@ -116,16 +116,25 @@ export class TableRenderer { // Header Row const headerRow = document.createElement('tr'); - // 1. Selection Header Column + // 1. Row Number Header Column (Task 5.3) const selectTh = document.createElement('th'); + selectTh.textContent = '#'; selectTh.style.cssText = ` - width: 30px; + width: 32px; + min-width: 32px; position: sticky; top: 0; left: 0; background: var(--vscode-editor-background); border-bottom: 1px solid var(--vscode-widget-border); + border-right: 1px solid var(--vscode-widget-border); z-index: 20; + font-family: monospace; + color: var(--vscode-descriptionForeground); + text-align: right; + padding: 8px 6px; + font-weight: 400; + user-select: none; `; headerRow.appendChild(selectTh); @@ -158,31 +167,48 @@ export class TableRenderer { max-width: 400px; `; + // Task 5.1 & 5.2: flex row with space-between so type badge is right-aligned const container = document.createElement('div'); - container.style.cssText = 'display: flex; align-items: center; gap: 4px;'; + container.style.cssText = 'display: flex; justify-content: space-between; align-items: center; gap: 4px;'; + + // Left side: optional PK icon + column name + const leftSide = document.createElement('div'); + leftSide.style.cssText = 'display: flex; align-items: center; gap: 4px; overflow: hidden;'; + + // Task 5.2: PK icon (⚿) for primary key columns + if (this.tableInfo?.primaryKeys?.includes(col)) { + const pkIcon = document.createElement('span'); + pkIcon.textContent = '⚿'; + pkIcon.title = 'Primary Key'; + pkIcon.style.cssText = 'color: var(--vscode-textLink-foreground); font-size: 12px; flex-shrink: 0;'; + leftSide.appendChild(pkIcon); + } const colName = document.createElement('span'); colName.textContent = col; - container.appendChild(colName); - th.appendChild(container); + colName.style.cssText = 'overflow: hidden; text-overflow: ellipsis;'; + leftSide.appendChild(colName); + container.appendChild(leftSide); - // Type info + // Task 5.1: type badge right-aligned if (this.columnTypes[col]) { - const typeContainer = document.createElement('div'); - typeContainer.style.cssText = 'display: flex; align-items: center; gap: 4px; margin-top: 2px;'; - - const colType = document.createElement('span'); - colType.textContent = this.columnTypes[col]; - colType.style.cssText = 'font-size: 0.8em; font-weight: 500; opacity: 0.7;'; - typeContainer.appendChild(colType); - - if (this.tableInfo?.primaryKeys?.includes(col)) { - typeContainer.innerHTML += '🔑'; - } else if (this.tableInfo?.uniqueKeys?.includes(col)) { - typeContainer.innerHTML += '🔐'; - } + const typeBadge = document.createElement('span'); + typeBadge.className = 'type-badge'; + typeBadge.textContent = this.columnTypes[col]; + typeBadge.style.cssText = ` + font-size: 10px; + font-family: var(--vscode-editor-font-family), monospace; + color: var(--vscode-descriptionForeground); + flex-shrink: 0; + margin-left: 6px; + `; + container.appendChild(typeBadge); + } - // Date/Time Toggle + th.appendChild(container); + + // Date/Time Toggle (kept below the main row) + if (this.columnTypes[col]) { const lowerType = this.columnTypes[col].toLowerCase(); const isDateTime = lowerType.includes('timestamp') || lowerType === 'timestamptz' || lowerType === 'date' || lowerType === 'time' || lowerType === 'timetz'; @@ -191,6 +217,9 @@ export class TableRenderer { if (!this.dateTimeDisplayMode.has(col)) { this.dateTimeDisplayMode.set(col, false); } + const toggleRow = document.createElement('div'); + toggleRow.style.cssText = 'display: flex; align-items: center; gap: 4px; margin-top: 2px;'; + const toggle = document.createElement('button'); const isFormatted = this.dateTimeDisplayMode.get(col); toggle.textContent = isFormatted ? '📆' : '#'; @@ -210,10 +239,9 @@ export class TableRenderer { this.dateTimeDisplayMode.set(col, !isFormatted); this.rerenderTable(); }; - typeContainer.appendChild(toggle); + toggleRow.appendChild(toggle); + th.appendChild(toggleRow); } - - th.appendChild(typeContainer); } this.addResizeHandle(th); @@ -292,12 +320,19 @@ export class TableRenderer { if (!this.selectedIndices.has(index)) this.applyRowStyle(tr, index); }; + // Task 5.3: muted monospace row number cell const selectTd = document.createElement('td'); selectTd.textContent = String(index + 1); selectTd.style.cssText = ` border-bottom: 1px solid var(--vscode-widget-border); border-right: 1px solid var(--vscode-widget-border); - text-align: center; font-size: 10px; color: var(--vscode-descriptionForeground); + text-align: right; + font-family: monospace; + font-size: 10px; + color: var(--vscode-descriptionForeground); + user-select: none; + min-width: 32px; + padding: 6px 6px; position: sticky; left: 0; z-index: 5; @@ -368,7 +403,16 @@ export class TableRenderer { td.style.color = '#856404'; } - td.textContent = text; + // Task 5.4: render NULL/undefined values in italics with dim color + if (val === null || val === undefined) { + const nullSpan = document.createElement('span'); + nullSpan.textContent = 'NULL'; + nullSpan.style.cssText = 'color: var(--vscode-descriptionForeground); font-style: italic; opacity: 0.6;'; + td.appendChild(nullSpan); + } else { + td.textContent = text; + } + return td; } diff --git a/src/renderer/features/import.ts b/src/renderer/features/import.ts index b4d7233..c2290a3 100644 --- a/src/renderer/features/import.ts +++ b/src/renderer/features/import.ts @@ -9,274 +9,35 @@ export const createImportButton = ( importBtn.style.position = 'relative'; if (!tableInfo) { - importBtn.style.display = 'none'; // Completely hide if not a table + importBtn.style.display = 'none'; return importBtn; } importBtn.addEventListener('click', (e) => { e.stopPropagation(); - showImportModal(columns, tableInfo, context); + // Delegate entirely to the extension host — it will open a native file picker + // and handle parsing + inserting. No in-iframe modal needed. + context?.postMessage?.({ + type: 'import_pick_file', + table: tableInfo.table, + schema: tableInfo.schema, + columns, + }); }); return importBtn; }; -function showImportModal(tableColumns: string[], tableInfo: any, context?: { postMessage?: (msg: any) => void }) { - // Create Modal Overlay - const overlay = document.createElement('div'); - overlay.style.cssText = ` - position: fixed; top: 0; left: 0; width: 100%; height: 100%; - background: rgba(0, 0, 0, 0.5); z-index: 1000; - display: flex; justify-content: center; align-items: center; - `; - - // Create Modal Content - const modal = document.createElement('div'); - modal.style.cssText = ` - background: var(--vscode-editor-background); - border: 1px solid var(--vscode-widget-border); - box-shadow: 0 4px 12px rgba(0, 0, 0, 0.25); - border-radius: 6px; - width: 600px; - max-height: 80vh; - display: flex; flex-direction: column; - color: var(--vscode-editor-foreground); - font-family: var(--vscode-font-family); - `; - - // Header - const header = document.createElement('div'); - header.style.cssText = 'padding: 12px 16px; border-bottom: 1px solid var(--vscode-widget-border); font-weight: 600; display: flex; justify-content: space-between; align-items: center;'; - header.innerHTML = `Import Data into ${tableInfo.schema}.${tableInfo.table}`; - - const closeBtn = document.createElement('span'); - closeBtn.innerHTML = '×'; - closeBtn.style.cssText = 'cursor: pointer; font-size: 20px;'; - closeBtn.onclick = () => overlay.remove(); - header.appendChild(closeBtn); - modal.appendChild(header); - - // Body - const body = document.createElement('div'); - body.style.cssText = 'padding: 16px; overflow-y: auto; flex: 1;'; - modal.appendChild(body); - - // Step 1: File Selection - const dropZone = document.createElement('div'); - dropZone.style.cssText = ` - border: 2px dashed var(--vscode-widget-border); - padding: 32px; text-align: center; - border-radius: 4px; cursor: pointer; - transition: background 0.2s; - `; - dropZone.innerHTML = ` -
    📂
    -
    Click or Drag & Drop CSV/JSON file here
    -
    Max size recommended: 10MB
    - `; - - const fileInput = document.createElement('input'); - fileInput.type = 'file'; - fileInput.accept = '.csv,.json,.txt'; - fileInput.style.display = 'none'; - body.appendChild(fileInput); - - dropZone.onclick = () => fileInput.click(); - - dropZone.ondragover = (e) => { e.preventDefault(); dropZone.style.background = 'var(--vscode-list-hoverBackground)'; }; - dropZone.ondragleave = () => { dropZone.style.background = 'transparent'; }; - dropZone.ondrop = (e) => { - e.preventDefault(); - dropZone.style.background = 'transparent'; - if (e.dataTransfer?.files?.length) handleFile(e.dataTransfer.files[0]); - }; - - fileInput.onchange = (e: any) => { - if (e.target.files?.length) handleFile(e.target.files[0]); - }; - - body.appendChild(dropZone); - - // Preview Container (Initially Hidden) - const previewContainer = document.createElement('div'); - previewContainer.style.display = 'none'; - previewContainer.style.marginTop = '16px'; - body.appendChild(previewContainer); - - // Footer (Actions) - const footer = document.createElement('div'); - footer.style.cssText = 'padding: 12px 16px; border-top: 1px solid var(--vscode-widget-border); display: flex; justify-content: flex-end; gap: 8px;'; - - const cancelBtn = createButton('Cancel', false); - cancelBtn.onclick = () => overlay.remove(); - - const importBtn = createButton('Import', true) as HTMLButtonElement; - importBtn.disabled = true; - importBtn.style.opacity = '0.5'; - - footer.appendChild(cancelBtn); - footer.appendChild(importBtn); - modal.appendChild(footer); - - overlay.appendChild(modal); - document.body.appendChild(overlay); - - // Logic - let parsedData: any[] = []; - let fileColumns: string[] = []; - const columnMapping: Record = {}; // FileCol -> TableCol - - const handleFile = (file: File) => { - const reader = new FileReader(); - reader.onload = (e) => { - const content = e.target?.result as string; - if (!content) return; - - if (file.name.endsWith('.json')) { - try { - const json = JSON.parse(content); - if (Array.isArray(json)) { - parsedData = json; - if (parsedData.length > 0) fileColumns = Object.keys(parsedData[0]); - showMappingUI(); - } else { - alert('JSON file must contain an array of objects'); - } - } catch (err) { alert('Invalid JSON file'); } - } else { - parsedData = parseCSV(content); - if (parsedData.length > 0) { - fileColumns = Object.keys(parsedData[0]); - showMappingUI(); - } - } - }; - reader.readAsText(file); - }; - - const showMappingUI = () => { - dropZone.style.display = 'none'; - previewContainer.style.display = 'block'; - - // Auto-map based on name match (case-insensitive) - fileColumns.forEach(fCol => { - const match = tableColumns.find(tCol => tCol.toLowerCase() === fCol.toLowerCase()); - if (match) columnMapping[fCol] = match; - }); - - const rowsHtml = fileColumns.map(fCol => { - const options = [``] - .concat(tableColumns.map(tCol => - `` - )).join(''); - - return ` - - ${fCol} - ➜ - - - - - `; - }).join(''); - - previewContainer.innerHTML = ` -
    Map Columns
    -
    - Matched ${parsedData.length} rows. Map file columns to table columns. -
    - - - - - - - ${rowsHtml} -
    File HeaderTable Column
    - `; - - // Bind events - previewContainer.querySelectorAll('select').forEach((select: any) => { - select.onchange = (e: any) => { - const fCol = select.getAttribute('data-file-col'); - const val = e.target.value; - if (val) columnMapping[fCol] = val; - else delete columnMapping[fCol]; - }; - }); - - importBtn.disabled = false; - importBtn.style.opacity = '1'; - importBtn.onclick = () => { - const mappedData = parsedData.map(row => { - const newRow: any = {}; - Object.keys(row).forEach(fCol => { - if (columnMapping[fCol]) { - newRow[columnMapping[fCol]] = row[fCol]; - } - }); - return newRow; - }); - - // Filter out empty rows (if any) or rows with no mapped keys - const validData = mappedData.filter(r => Object.keys(r).length > 0); - - if (validData.length === 0) { - alert('No data to import (check column mappings)'); - return; - } - - importBtn.innerText = 'Importing...'; - importBtn.disabled = true; - - context?.postMessage?.({ - type: 'import_request', - table: tableInfo.table, - schema: tableInfo.schema, - data: validData - }); - - setTimeout(() => overlay.remove(), 500); - }; - }; - - function parseCSV(text: string): any[] { - const lines = text.split(/\r?\n/).filter(l => l.trim().length > 0); - if (lines.length < 2) return []; - - const headers = lines[0].split(',').map(h => h.trim().replace(/^"|"$/g, '')); - const result = []; - - for (let i = 1; i < lines.length; i++) { - // Simple regex-based splitter that respects quotes - const line = lines[i]; - const values: string[] = []; - let inQuote = false; - let val = ''; - for (let j = 0; j < line.length; j++) { - const c = line[j]; - if (c === '"') { - inQuote = !inQuote; - } else if (c === ',' && !inQuote) { - values.push(val.trim().replace(/^"|"$/g, '').replace(/""/g, '"')); - val = ''; - } else { - val += c; - } - } - values.push(val.trim().replace(/^"|"$/g, '').replace(/""/g, '"')); - - const row: any = {}; - headers.forEach((h, idx) => { - if (idx < values.length) { - row[h] = values[idx]; - } - }); - result.push(row); - } - return result; - } +// Keep showImportModal exported for any legacy callers, but it now just triggers the host flow. +export function showImportModal( + tableColumns: string[], + tableInfo: any, + context?: { postMessage?: (msg: any) => void } +) { + context?.postMessage?.({ + type: 'import_pick_file', + table: tableInfo.table, + schema: tableInfo.schema, + columns: tableColumns, + }); } diff --git a/src/renderer/utils/sqlParsing.ts b/src/renderer/utils/sqlParsing.ts new file mode 100644 index 0000000..dc9e9da --- /dev/null +++ b/src/renderer/utils/sqlParsing.ts @@ -0,0 +1,67 @@ +/** + * Extracts schema and table from a SQL statement containing a FROM or JOIN clause + * with a qualified `schema.table` reference. + * + * Handles: + * - FROM schema.table + * - FROM schema.table WHERE ... + * - JOIN schema.table ON ... + * - FROM schema.table AS alias + * + * Returns `{}` when no match is found (e.g., subqueries, CTEs, unqualified table names). + */ +export function parseBreadcrumbFromSql(sql: string): { schema?: string; table?: string } { + // Match FROM or JOIN followed by schema.table, optionally followed by alias or clause keyword + // Identifiers may be plain or double-quoted + const identPart = `(?:"[^"]+"|[A-Za-z_][A-Za-z0-9_$]*)`; + const pattern = new RegExp( + `(?:FROM|JOIN)\\s+(${identPart})\\.(${identPart})(?:\\s+(?:AS\\s+${identPart}|WHERE|ON|LEFT|RIGHT|INNER|OUTER|CROSS|JOIN|GROUP|ORDER|LIMIT|HAVING|UNION|EXCEPT|INTERSECT|;|$))?`, + 'i' + ); + + const match = pattern.exec(sql); + if (!match) { + return {}; + } + + // Strip surrounding double-quotes if present + const stripQuotes = (s: string) => s.startsWith('"') && s.endsWith('"') ? s.slice(1, -1) : s; + + return { + schema: stripQuotes(match[1]), + table: stripQuotes(match[2]), + }; +} + +/** + * Scans an array of notebook cell SQL strings in order and returns a title + * derived from the first cell that contains a SELECT statement. + * + * Title format: + * - `View {schema}.{table}` when schema/table can be parsed from the SELECT + * - A truncated version of the SELECT clause (max 50 chars) otherwise + * + * Returns `""` when no SELECT statement is found in any cell. + */ +export function deriveNotebookTitle(cells: string[]): string { + for (const cell of cells) { + if (!/SELECT/i.test(cell)) { + continue; + } + + // Try to extract schema.table from this cell + const { schema, table } = parseBreadcrumbFromSql(cell); + if (schema && table) { + return `View ${schema}.${table}`; + } + + // Fall back to a truncated version of the SELECT statement + const selectMatch = /SELECT\b.*/i.exec(cell); + if (selectMatch) { + const raw = selectMatch[0].trim().replace(/\s+/g, ' '); + return raw.length > 50 ? raw.slice(0, 50) : raw; + } + } + + return ''; +} diff --git a/src/renderer_v2.ts b/src/renderer_v2.ts index eea3f32..c231c5b 100644 --- a/src/renderer_v2.ts +++ b/src/renderer_v2.ts @@ -2,14 +2,15 @@ import type { ActivationFunction } from 'vscode-notebook-renderer'; import { Chart, registerables } from 'chart.js'; import { createButton, createTab, createBreadcrumb, BreadcrumbSegment } from './renderer/components/ui'; import { createExportButton } from './renderer/features/export'; -import { createImportButton } from './renderer/features/import'; -import { createAiButtons } from './renderer/features/ai'; import { TableRenderer, TableEvents } from './renderer/components/table/TableRenderer'; import { ChartRenderer } from './renderer/components/chart/ChartRenderer'; import { ChartControls } from './renderer/components/chart/ChartControls'; -import { TableInfo, QueryResults, ChartRenderOptions } from './common/types'; -import { getNumericColumns, isDateColumn } from './renderer/utils/formatting'; import { ExplainVisualizer } from './renderer/components/ExplainVisualizer'; +import { createErrorPanel } from './renderer/components/ErrorPanel'; +import { createActionBar } from './renderer/components/ActionBar'; +import { showImportModal } from './renderer/features/import'; +import { createTransactionBanner } from './renderer/components/TransactionBanner'; +import { parseBreadcrumbFromSql } from './renderer/utils/sqlParsing'; // Register Chart.js components Chart.register(...registerables); @@ -20,9 +21,64 @@ const tableInstances = new WeakMap(); const BRAND_ACCENT = 'var(--vscode-textLink-foreground)'; const BRAND_ACCENT_MUTED = 'color-mix(in srgb, var(--vscode-textLink-foreground) 20%, transparent)'; +const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']; + +/** + * Puts a button into a loading state with an animated braille spinner. + * Returns a cleanup function that restores the original label and re-enables the button. + */ +function startButtonLoading(btn: HTMLElement, loadingLabel: string): () => void { + const originalText = btn.innerText; + const originalDisabled = (btn as HTMLButtonElement).disabled; + (btn as HTMLButtonElement).disabled = true; + btn.style.opacity = '0.7'; + btn.style.cursor = 'not-allowed'; + + let frame = 0; + btn.innerText = `${SPINNER_FRAMES[frame]} ${loadingLabel}`; + const interval = setInterval(() => { + frame = (frame + 1) % SPINNER_FRAMES.length; + btn.innerText = `${SPINNER_FRAMES[frame]} ${loadingLabel}`; + }, 100); + + return () => { + clearInterval(interval); + btn.innerText = originalText; + (btn as HTMLButtonElement).disabled = originalDisabled; + btn.style.opacity = ''; + btn.style.cursor = ''; + }; +} + +// Inject amber-gutter CSS once +function ensureAmberGutterStyle(): void { + const STYLE_ID = 'amber-gutter-style'; + if (document.getElementById(STYLE_ID)) return; + const style = document.createElement('style'); + style.id = STYLE_ID; + style.textContent = ` + .amber-gutter { + border-left: 4px solid #ffb000 !important; + } + `; + document.head.appendChild(style); +} + +/** Remove all transaction banners and amber gutters from the document */ +function clearTransactionUI(): void { + document.querySelectorAll('[data-transaction-banner="true"]').forEach(el => el.remove()); + document.querySelectorAll('.amber-gutter').forEach(el => el.classList.remove('amber-gutter')); +} + export const activate: ActivationFunction = context => { return { renderOutputItem(data, element) { + // Silently ignore the legacy TopBar header output (removed feature) + if (data.mime === 'application/x-postgres-notebook-header+json') { + element.innerHTML = ''; + return; + } + const json = data.json(); if (!json) { @@ -32,6 +88,10 @@ export const activate: ActivationFunction = context => { const { columns = [], rows, rowCount, command, query, notices, executionTime, tableInfo, success, columnTypes, backendPid, breadcrumb } = json; + // Transaction state from payload + const transactionState: { isActive: boolean; statementCount: number } | undefined = json.transactionState; + const pendingCommit: boolean = !!json.pendingCommit; + // Data Management const originalRows: any[] = rows ? JSON.parse(JSON.stringify(rows)) : []; let currentRows: any[] = rows ? JSON.parse(JSON.stringify(rows)) : []; @@ -88,6 +148,26 @@ export const activate: ActivationFunction = context => { header.appendChild(chevron); header.appendChild(title); header.appendChild(summary); + + // Pending commit badge — shown when result was produced inside an open transaction + if (pendingCommit) { + const pendingBadge = document.createElement('span'); + pendingBadge.textContent = 'pending commit'; + pendingBadge.style.cssText = ` + font-size: 10px; + font-weight: 600; + padding: 2px 6px; + border-radius: 10px; + background: rgba(255, 176, 0, 0.25); + color: #ffb000; + border: 1px solid rgba(255, 176, 0, 0.5); + margin-left: 8px; + text-transform: uppercase; + letter-spacing: 0.04em; + `; + header.appendChild(pendingBadge); + } + mainContainer.appendChild(header); // Performance Warning @@ -111,6 +191,19 @@ export const activate: ActivationFunction = context => { // Breadcrumb Navigation if (breadcrumb) { + // Auto-populate schema/table from SQL when not provided in the payload (12.1) + let resolvedSchema = breadcrumb.schema; + let resolvedTable = breadcrumb.object?.name; + if ((!resolvedSchema || !resolvedTable) && query) { + const parsed = parseBreadcrumbFromSql(query); + if (!resolvedSchema && parsed.schema) { + resolvedSchema = parsed.schema; + } + if (!resolvedTable && parsed.table) { + resolvedTable = parsed.table; + } + } + const segments: BreadcrumbSegment[] = []; if (breadcrumb.connectionName) { @@ -119,12 +212,19 @@ export const activate: ActivationFunction = context => { if (breadcrumb.database) { segments.push({ label: breadcrumb.database, id: 'database', type: 'database' }); } - if (breadcrumb.schema) { - segments.push({ label: breadcrumb.schema, id: 'schema', type: 'schema' }); + if (resolvedSchema) { + segments.push({ + label: resolvedSchema, + id: 'schema', + type: 'schema', + onClick: () => { + context.postMessage?.({ type: 'breadcrumbNavigate', segment: resolvedSchema, segmentType: 'schema' }); + } + }); } - if (breadcrumb.object?.name) { + if (resolvedTable) { segments.push({ - label: breadcrumb.object.name, + label: resolvedTable, id: 'object', type: 'object', isLast: true @@ -138,12 +238,16 @@ export const activate: ActivationFunction = context => { const breadcrumbEl = createBreadcrumb(segments, { onConnectionDropdown: (anchorEl: HTMLElement) => { + // Also emit breadcrumbNavigate for connection (12.2) + context.postMessage?.({ type: 'breadcrumbNavigate', segment: breadcrumb.connectionName, segmentType: 'connection' }); context.postMessage?.({ type: 'showConnectionSwitcher', connectionId: breadcrumb.connectionId }); }, onDatabaseDropdown: (anchorEl: HTMLElement) => { + // Also emit breadcrumbNavigate for database (12.2) + context.postMessage?.({ type: 'breadcrumbNavigate', segment: breadcrumb.database, segmentType: 'database' }); context.postMessage?.({ type: 'showDatabaseSwitcher', connectionId: breadcrumb.connectionId, @@ -169,35 +273,22 @@ export const activate: ActivationFunction = context => { // Error Section if (json.error) { - const errorContainer = document.createElement('div'); - errorContainer.style.cssText = 'padding: 12px; border-bottom: 1px solid var(--vscode-widget-border);'; - - const errorMsg = document.createElement('div'); - errorMsg.style.cssText = 'color: var(--vscode-errorForeground); padding: 8px;'; - errorMsg.innerHTML = `Error executing query:
    ${json.error}
    `; - errorContainer.appendChild(errorMsg); - - if (json.canExplain) { - const btnContainer = document.createElement('div'); - btnContainer.style.cssText = 'margin-top: 12px; display: flex; gap: 8px;'; - - const explainBtn = createButton('✨ Explain Error'); - explainBtn.onclick = (e: MouseEvent) => { - e.stopPropagation(); + const errorPanel = createErrorPanel({ + errorCode: json.errorCode, + errorMessage: json.error, + explanation: json.errorExplanation, + onExplainError: () => { context.postMessage?.({ type: 'explainError', error: json.error, query: json.query }); - }; - - const fixBtn = createButton('🛠️ Fix Query'); - fixBtn.onclick = (e: MouseEvent) => { - e.stopPropagation(); + }, + onFixWithAI: () => { context.postMessage?.({ type: 'fixQuery', error: json.error, query: json.query }); - }; - - btnContainer.appendChild(explainBtn); - btnContainer.appendChild(fixBtn); - errorMsg.appendChild(btnContainer); - } - contentContainer.appendChild(errorContainer); + }, + onRetry: () => { + // Client-side retry: re-execute the cell by posting retryCell to the kernel + context.postMessage?.({ type: 'retryCell', query: json.query }); + } + }); + contentContainer.appendChild(errorPanel); } // Messages Section @@ -222,72 +313,171 @@ export const activate: ActivationFunction = context => { contentContainer.appendChild(msgContainer); } - // Actions Bar - const actionsBar = document.createElement('div'); - actionsBar.style.cssText = ` - display: none; padding: 8px 12px; gap: 8px; align-items: center; justify-content: space-between; - border-bottom: 1px solid var(--vscode-panel-border); background: var(--vscode-editor-background); - `; + // Build the hidden export button to reuse its existing dropdown flow + const exportBtn = createExportButton(columns, currentRows, tableInfo, context, query); + exportBtn.style.display = 'none'; + + // Actions Bar — built with ActionBar component + const actionsBar = createActionBar({ + onSelectAll: () => { + // Toggle: if all rows are selected, deselect all; otherwise select all + if (selectedIndices.size === currentRows.length && currentRows.length > 0) { + selectedIndices.clear(); + } else { + currentRows.forEach((_: any, i: number) => selectedIndices.add(i)); + } + tableRenderer.updateSelection(selectedIndices); + updateActionsVisibility(); + }, + onCopy: () => { + // Copy selected rows (or all rows if none selected) to clipboard as CSV + const rowsToCopy = selectedIndices.size > 0 + ? Array.from(selectedIndices).map(i => currentRows[i]) + : currentRows; + const escapeCSV = (val: any): string => { + if (val === null || val === undefined) return ''; + const str = typeof val === 'object' ? JSON.stringify(val) : String(val); + if (str.includes(',') || str.includes('"') || str.includes('\n')) { + return `"${str.replace(/"/g, '""')}"`; + } + return str; + }; + const csv = [ + columns.map((c: string) => `"${c.replace(/"/g, '""')}"`).join(','), + ...rowsToCopy.map((r: any) => columns.map((c: string) => escapeCSV(r[c])).join(',')) + ].join('\n'); + navigator.clipboard?.writeText(csv); + }, + onImport: () => { + showImportModal(columns, tableInfo, context); + }, + onExport: (anchorBtn: HTMLElement) => { + // Remove existing dropdown if open (toggle) + const existing = document.querySelector('.export-dropdown'); + if (existing) { existing.remove(); return; } + + const stringifyValue = (val: any): string => { + if (val === null || val === undefined) return ''; + if (typeof val === 'object') return JSON.stringify(val); + return String(val); + }; + const getCSV = () => { + const header = columns.map((c: string) => `"${c.replace(/"/g, '""')}"`).join(','); + const body = currentRows.map((row: any) => columns.map((col: string) => { + const str = stringifyValue(row[col]); + return (str.includes(',') || str.includes('"') || str.includes('\n')) + ? `"${str.replace(/"/g, '""')}"` : str; + }).join(',')).join('\n'); + return `${header}\n${body}`; + }; + const downloadFile = (content: string, filename: string, type: string) => { + const blob = new Blob([content], { type }); + const url = URL.createObjectURL(blob); + const a = document.createElement('a'); + a.href = url; a.download = filename; + document.body.appendChild(a); a.click(); + document.body.removeChild(a); URL.revokeObjectURL(url); + }; - // Helper to export/copy based on CURRENT selection or ALL if none selected - const getSelectedRows = () => { - if (selectedIndices.size === 0) return currentRows; - return currentRows.filter((_, i) => selectedIndices.has(i)); - }; + const menu = document.createElement('div'); + menu.className = 'export-dropdown'; + menu.style.cssText = 'position:absolute;top:100%;left:0;background:var(--vscode-menu-background);border:1px solid var(--vscode-menu-border);box-shadow:0 2px 8px rgba(0,0,0,0.15);z-index:100;min-width:160px;border-radius:3px;padding:4px 0;'; + + const addItem = (label: string, onClick: () => void) => { + const item = document.createElement('div'); + item.textContent = label; + item.style.cssText = 'padding:6px 12px;cursor:pointer;color:var(--vscode-menu-foreground);font-size:12px;'; + item.onmouseenter = () => { item.style.background = 'var(--vscode-menu-selectionBackground)'; item.style.color = 'var(--vscode-menu-selectionForeground)'; }; + item.onmouseleave = () => { item.style.background = 'transparent'; item.style.color = 'var(--vscode-menu-foreground)'; }; + item.onclick = (e) => { e.stopPropagation(); onClick(); menu.remove(); }; + menu.appendChild(item); + }; - const selectAllBtn = createButton('Select All', true); - const copyBtn = createButton('Copy Selected', true); - const deleteBtn = createButton('🗑️ Delete Selected', true); - deleteBtn.style.cssText = 'display: none; background: var(--vscode-button-secondaryBackground); color: var(--vscode-button-secondaryForeground); margin-left: 8px;'; + addItem('Save as CSV', () => downloadFile(getCSV(), `export_${Date.now()}.csv`, 'text/csv')); + addItem('Save as JSON', () => downloadFile(JSON.stringify(currentRows, null, 2), `export_${Date.now()}.json`, 'application/json')); + addItem('Save as Markdown', () => { + const header = `| ${columns.join(' | ')} |`; + const sep = `| ${columns.map(() => '---').join(' | ')} |`; + const body = currentRows.map((row: any) => `| ${columns.map((col: string) => { + const v = row[col]; if (v === null || v === undefined) return 'NULL'; + return (typeof v === 'object' ? JSON.stringify(v) : String(v)).replace(/\|/g, '\\|').replace(/\n/g, ' '); + }).join(' | ')} |`).join('\n'); + downloadFile(`${header}\n${sep}\n${body}`, `export_${Date.now()}.md`, 'text/markdown'); + }); + addItem('Copy to Clipboard', () => { + navigator.clipboard?.writeText(getCSV()).then(() => { + anchorBtn.textContent = 'Copied!'; + setTimeout(() => { anchorBtn.textContent = '↓ Export'; }, 2000); + }); + }); + if (tableInfo) { + addItem('Copy SQL INSERT', () => { + const tableName = `"${tableInfo.schema}"."${tableInfo.table}"`; + const cols = columns.map((c: string) => `"${c}"`).join(', '); + const inserts = currentRows.map((row: any) => { + const vals = columns.map((col: string) => { + const v = row[col]; + if (v === null || v === undefined) return 'NULL'; + if (typeof v === 'number') return v; + if (typeof v === 'boolean') return v ? 'TRUE' : 'FALSE'; + const s = typeof v === 'object' ? JSON.stringify(v) : String(v); + return `'${s.replace(/'/g, "''")}'`; + }).join(', '); + return `INSERT INTO ${tableName} (${cols}) VALUES (${vals});`; + }).join('\n'); + navigator.clipboard?.writeText(inserts); + }); + } - const exportBtn = createExportButton(columns, currentRows, tableInfo, context, query); - const importBtn = createImportButton(columns, tableInfo, context); + anchorBtn.appendChild(menu); + setTimeout(() => { + const close = () => { menu.remove(); document.removeEventListener('click', close); }; + document.addEventListener('click', close); + }, 0); + }, + onSendToChat: () => { + const resultsJson = JSON.stringify({ columns, rows: currentRows }); + context.postMessage?.({ + type: 'sendToChat', + data: { + query: json.query || '', + results: resultsJson, + message: 'I ran this query and got these results. Please help me understand them.' + } + }); + }, + onAnalyzeWithAI: () => { + const escapeCSV = (val: any): string => { + if (val === null || val === undefined) return ''; + const str = typeof val === 'object' ? JSON.stringify(val) : String(val); + if (str.includes(',') || str.includes('"') || str.includes('\n')) { + return `"${str.replace(/"/g, '""')}"`; + } + return str; + }; + const csvHeader = columns.map((c: string) => `"${c.replace(/"/g, '""')}"`).join(','); + const csvRows = currentRows.map((r: any) => columns.map((c: string) => escapeCSV(r[c])).join(',')); + const dataCsv = [csvHeader, ...csvRows].join('\n'); + context.postMessage?.({ + type: 'analyzeData', + data: dataCsv, + query: json.query || '', + rowCount: currentRows.length + }); + }, + onOptimize: () => { + context.postMessage?.({ type: 'optimizeQuery', query: json.query, executionTime: json.executionTime }); + } + }); - // Left Group - const leftActions = document.createElement('div'); - leftActions.style.cssText = 'display: flex; gap: 8px; align-items: center;'; - leftActions.appendChild(selectAllBtn); - leftActions.appendChild(copyBtn); + // Capture left/right groups before appending extra elements + const leftActions = actionsBar.firstElementChild as HTMLElement; + const rightActions = actionsBar.children[2] as HTMLElement; // index 2: right group (0=left, 1=divider, 2=right) + + // Delete button — appended to leftActions, shown when rows are selected + const deleteBtn = createButton('🗑️ Delete Selected', true); + deleteBtn.style.cssText = 'display: none; background: var(--vscode-button-secondaryBackground); color: var(--vscode-button-secondaryForeground); margin-left: 8px;'; leftActions.appendChild(deleteBtn); - leftActions.appendChild(importBtn); - leftActions.appendChild(exportBtn); - - // Right Group - const rightActions = document.createElement('div'); - rightActions.style.cssText = 'display: flex; gap: 8px; align-items: center;'; - - // Copy to Chat - const copyToChatBtn = createButton('💬 Send to Chat', true); - copyToChatBtn.title = 'Send results to SQL Assistant chat'; - copyToChatBtn.onclick = () => { - const rowsToSend = currentRows.slice(0, 100); - const resultsJson = JSON.stringify({ - totalRows: currentRows.length, - columns: columns, - rows: rowsToSend - }, null, 2); - context.postMessage?.({ - type: 'sendToChat', - data: { - query: query || '-- Query', - results: resultsJson, - message: '' - } - }); - }; - rightActions.appendChild(copyToChatBtn); - - // AI Buttons - const { analyzeBtn, optimizeBtn } = createAiButtons( - { postMessage: (msg: any) => context.postMessage?.(msg) }, - columns, - currentRows, - query || command || 'result set', - command, - executionTime - ); - rightActions.appendChild(analyzeBtn); - rightActions.appendChild(optimizeBtn); // Detect if this is an EXPLAIN query (either JSON or text format) const isExplainQuery = json.explainPlan || @@ -303,12 +493,9 @@ export const activate: ActivationFunction = context => { explainPlanBtn.onclick = () => { if (json.explainPlan) { - // Already have JSON plan, show it directly - // Now we prefer the in-renderer tab if available if (explainTab) { switchTab('explain'); } else { - // Fallback / legacy external view context.postMessage?.({ type: 'showExplainPlan', plan: json.explainPlan, @@ -316,8 +503,6 @@ export const activate: ActivationFunction = context => { }); } } else { - // Text format - request re-execution with FORMAT JSON - // Log for debugging console.log('Converting EXPLAIN to JSON, query:', query); if (!query) { alert('Cannot convert EXPLAIN plan: query not available'); @@ -332,8 +517,6 @@ export const activate: ActivationFunction = context => { rightActions.appendChild(explainPlanBtn); } - actionsBar.appendChild(leftActions); - actionsBar.appendChild(rightActions); if (!json.error) { contentContainer.appendChild(actionsBar); } @@ -407,6 +590,9 @@ export const activate: ActivationFunction = context => { if (updates.length > 0 || deletions.length > 0) { console.log('Renderer: Posting saveChanges message'); + const stopLoading = startButtonLoading(saveBtn, 'Saving...'); + // stopLoading is called when saveSuccess or saveFailed arrives + (saveBtn as any)._stopLoading = stopLoading; context.postMessage?.({ type: 'saveChanges', updates, @@ -430,6 +616,10 @@ export const activate: ActivationFunction = context => { if (message.type === 'saveSuccess') { console.log('Renderer: Received saveSuccess, clearing modified cells and removing deleted rows'); + // Stop the loading spinner on the save button + (saveBtn as any)._stopLoading?.(); + (saveBtn as any)._stopLoading = undefined; + // Remove deleted rows from arrays (in reverse order to maintain indices) const deletedIndices = Array.from(rowsMarkedForDeletion).sort((a, b) => b - a); deletedIndices.forEach(index => { @@ -466,6 +656,12 @@ export const activate: ActivationFunction = context => { }); } } + + if (message.type === 'saveFailed') { + // Restore save button on error + (saveBtn as any)._stopLoading?.(); + (saveBtn as any)._stopLoading = undefined; + } }); // Tabs @@ -536,30 +732,15 @@ export const activate: ActivationFunction = context => { leftActions.appendChild(exportChartBtn); const updateActionsVisibility = () => { - // Always show actions bar - actionsBar.style.display = 'flex'; - - if (currentMode === 'table') { - // Table Mode: Show Table Buttons, Hide Chart Buttons - selectAllBtn.style.display = 'inline-block'; - copyBtn.style.display = 'inline-block'; - exportBtn.style.display = 'inline-block'; - importBtn.style.display = tableInfo ? 'inline-block' : 'none'; - exportChartBtn.style.display = 'none'; - } else { - // Chart Mode: Hide Table Buttons, Show Chart Button - selectAllBtn.style.display = 'none'; - copyBtn.style.display = 'none'; - exportBtn.style.display = 'none'; // Hide Data Export in Chart Mode - importBtn.style.display = 'none'; + if (currentMode === 'chart') { exportChartBtn.style.display = 'inline-block'; + } else { + exportChartBtn.style.display = 'none'; } - // Update Select All Button Text + // Update Select All Button Text and delete button if (currentMode === 'table') { - selectAllBtn.innerText = selectedIndices.size === currentRows.length ? 'Deselect All' : 'Select All'; - - if (selectedIndices.size > 0) { // Removed PK check for debugging + if (selectedIndices.size > 0) { deleteBtn.style.display = 'inline-block'; deleteBtn.innerText = `🗑️ Delete (${selectedIndices.size})`; if (!tableInfo?.primaryKeys) { @@ -570,7 +751,6 @@ export const activate: ActivationFunction = context => { deleteBtn.style.opacity = '1'; } } else { - // console.log('Renderer: Delete button hidden. Selected:', selectedIndices.size); deleteBtn.style.display = 'none'; } } @@ -613,37 +793,6 @@ export const activate: ActivationFunction = context => { updateActionsVisibility(); }; - selectAllBtn.onclick = () => { - const allSelected = selectedIndices.size === currentRows.length; - if (allSelected) selectedIndices.clear(); - else currentRows.forEach((_, i) => selectedIndices.add(i)); - - tableRenderer.updateSelection(selectedIndices); - updateActionsVisibility(); - }; - - copyBtn.onclick = () => { - if (selectedIndices.size === 0) return; - const selected = currentRows.filter((_, i) => selectedIndices.has(i)); - - // Convert to CSV - const csv = columns.map((c: string) => `"${c}"`).join(',') + '\n' + - selected.map(row => - columns.map((col: string) => { - const val = row[col]; - const str = (typeof val === 'object' && val !== null) ? JSON.stringify(val) : String(val ?? ''); - if (str.includes(',') || str.includes('"') || str.includes('\n')) return `"${str.replace(/"/g, '""')}"`; - return str; - }).join(',') - ).join('\n'); - - navigator.clipboard.writeText(csv).then(() => { - const prev = copyBtn.innerText; - copyBtn.innerText = 'Copied!'; - setTimeout(() => copyBtn.innerText = prev, 2000); - }); - }; - // Switch Tab Logic let currentMode = 'table'; const switchTab = (mode: string) => { @@ -677,10 +826,18 @@ export const activate: ActivationFunction = context => { updateActionsVisibility(); // Should probably hide most actions const explainWrapper = document.createElement('div'); - explainWrapper.style.cssText = 'flex: 1; overflow: hidden; height: 100%; display: flex; flex-direction: column;'; + explainWrapper.style.cssText = 'flex: 1; overflow: auto; height: 100%; display: flex; flex-direction: column;'; viewContainer.appendChild(explainWrapper); - new ExplainVisualizer(explainWrapper, json.explainPlan).render(); + if (json.explainPlan) { + try { + new ExplainVisualizer(explainWrapper, json.explainPlan).render(); + } catch (e) { + explainWrapper.textContent = 'Failed to render explain plan: ' + String(e); + } + } else { + explainWrapper.textContent = 'No explain plan data available. Run EXPLAIN (ANALYZE, FORMAT JSON) to get a visual plan.'; + } } else { // Hide table specific styles @@ -696,7 +853,7 @@ export const activate: ActivationFunction = context => { chartWrapper.style.cssText = 'flex: 1; display: flex; flex-direction: column; height: 100%; overflow: hidden;'; const controlsContainer = document.createElement('div'); - controlsContainer.style.cssText = 'width: 250px; border-left: 1px solid var(--vscode-panel-border); background: var(--vscode-sideBar-background); display: flex; flex-direction: column;'; + controlsContainer.style.cssText = 'width: 140px; min-width: 140px; max-width: 140px; display: flex; flex-direction: column;'; const canvasContainer = document.createElement('div'); canvasContainer.style.cssText = 'flex: 1; padding: 8px; position: relative; min-height: 0;'; @@ -728,6 +885,32 @@ export const activate: ActivationFunction = context => { } element.appendChild(mainContainer); + + // Transaction state: show banner and amber gutter + ensureAmberGutterStyle(); + if (transactionState?.isActive) { + mainContainer.classList.add('amber-gutter'); + + // Only add one banner per document (remove stale ones first) + const existingBanner = document.querySelector('[data-transaction-banner="true"]'); + if (!existingBanner) { + const banner = createTransactionBanner({ + statementCount: transactionState.statementCount, + onCommit: () => { + context.postMessage?.({ type: 'commitTransaction' }); + }, + onRollback: () => { + context.postMessage?.({ type: 'rollbackTransaction' }); + } + }); + // Insert banner before the first output container in the element's parent + const outputHost = element.parentElement || element; + outputHost.insertBefore(banner, outputHost.firstChild); + } + } else { + // Transaction closed — clear all transaction UI + clearTransactionUI(); + } } }; }; diff --git a/src/services/AutoRefreshService.ts b/src/services/AutoRefreshService.ts new file mode 100644 index 0000000..745f8ee --- /dev/null +++ b/src/services/AutoRefreshService.ts @@ -0,0 +1,235 @@ +import * as vscode from 'vscode'; +import { DatabaseTreeProvider } from '../providers/DatabaseTreeProvider'; +import { NotebooksTreeProvider } from '../providers/NotebooksTreeProvider'; +import { SchemaPoller } from './SchemaPoller'; +import { Debouncer } from '../lib/debounce'; +import { getSchemaCache } from '../lib/schema-cache'; + +const MIN_POLL_INTERVAL_MS = 10_000; +const DEFAULT_POLL_INTERVAL_SECONDS = 30; +const DEBOUNCE_WINDOW_MS = 500; + +/** + * Reads the `postgresExplorer.autoRefresh.enabled` setting. + * Defaults to `true` when the setting is absent or not a boolean. + */ +function getAutoRefreshEnabled(): boolean { + const value = vscode.workspace + .getConfiguration('postgresExplorer') + .get('autoRefresh.enabled'); + return typeof value === 'boolean' ? value : true; +} + +/** + * Reads `postgresExplorer.autoRefresh.pollIntervalSeconds`, converts to ms, + * and clamps to a minimum of 10 000 ms. + */ +function getPollIntervalMs(): number { + const seconds = vscode.workspace + .getConfiguration('postgresExplorer') + .get('autoRefresh.pollIntervalSeconds') ?? DEFAULT_POLL_INTERVAL_SECONDS; + const ms = seconds * 1_000; + return Math.max(ms, MIN_POLL_INTERVAL_MS); +} + +export class AutoRefreshService implements vscode.Disposable { + private readonly pollers: Map = new Map(); + private readonly debouncer = new Debouncer(); + private readonly disposables: vscode.Disposable[] = []; + private _enabled: boolean = true; + + constructor( + private readonly databaseTreeProvider: DatabaseTreeProvider, + private readonly notebooksTreeProvider: NotebooksTreeProvider, + private readonly globalStorageUri: vscode.Uri, + private readonly outputChannel: vscode.OutputChannel + ) {} + + /** Called once during extension activation. */ + start(): void { + try { + this._enabled = getAutoRefreshEnabled(); + + // Configuration_Watcher: listen for postgresExplorer config changes + const configListener = vscode.workspace.onDidChangeConfiguration(e => { + if (!e.affectsConfiguration('postgresExplorer')) { + return; + } + + // Handle autoRefresh.enabled toggle + if (e.affectsConfiguration('postgresExplorer.autoRefresh.enabled')) { + const nowEnabled = getAutoRefreshEnabled(); + if (!nowEnabled && this._enabled) { + // Transitioning to disabled: stop all pollers and unregister watchers + this._enabled = false; + for (const poller of this.pollers.values()) { + poller.dispose(); + } + this.pollers.clear(); + for (const d of this.disposables) { + d.dispose(); + } + this.disposables.length = 0; + } else if (nowEnabled && !this._enabled) { + // Transitioning to enabled: re-register watchers and restart pollers + this._enabled = true; + this._registerWatchers(); + const connections = vscode.workspace + .getConfiguration() + .get('postgresExplorer.connections') ?? []; + for (const conn of connections) { + if (conn.id) { + this.onConnectionConnected(conn.id as string); + } + } + } + return; + } + + if (!this._enabled) { + return; + } + + if (e.affectsConfiguration('postgresExplorer.autoRefresh.pollIntervalSeconds')) { + const newIntervalMs = getPollIntervalMs(); + for (const poller of this.pollers.values()) { + poller.updateInterval(newIntervalMs); + } + } + + if (e.affectsConfiguration('postgresExplorer.connections')) { + const oldIds = new Set(this.pollers.keys()); + + this.debouncer.debounce('config-refresh', () => { + this.databaseTreeProvider.refresh(); + + const newConnections = vscode.workspace + .getConfiguration() + .get('postgresExplorer.connections') ?? []; + const newIds = new Set(newConnections.map((c: any) => c.id as string)); + + // Start pollers for newly added connections + for (const id of newIds) { + if (!oldIds.has(id)) { + this.onConnectionConnected(id); + } + } + + // Dispose pollers for removed connections + for (const id of oldIds) { + if (!newIds.has(id)) { + const poller = this.pollers.get(id); + if (poller) { + poller.dispose(); + this.pollers.delete(id); + } + } + } + }, DEBOUNCE_WINDOW_MS); + } + }); + + this.disposables.push(configListener); + + if (this._enabled) { + this._registerWatchers(); + this._startPollerForAllConnections(); + } + } catch (err: any) { + const message = err?.message ?? String(err); + this.outputChannel.appendLine( + `[AutoRefreshService] Initialisation error: ${message}` + ); + } + } + + /** Starts pollers for all currently configured connections. */ + private _startPollerForAllConnections(): void { + const connections = vscode.workspace + .getConfiguration() + .get('postgresExplorer.connections') ?? []; + this.outputChannel.appendLine(`[AutoRefreshService] Starting pollers for ${connections.length} configured connection(s).`); + for (const conn of connections) { + if (conn.id) { + this.onConnectionConnected(conn.id as string); + } + } + } + + /** Registers the File_Watcher and pushes it to disposables. */ + private _registerWatchers(): void { // File_Watcher: watch for .pgsql notebook file changes in global storage + try { + const pattern = new vscode.RelativePattern(this.globalStorageUri, '**/*.pgsql'); + const fileWatcher = vscode.workspace.createFileSystemWatcher(pattern); + + const onFileEvent = () => { + this.debouncer.debounce('notebooks-refresh', () => { + this.notebooksTreeProvider.refresh(); + }, DEBOUNCE_WINDOW_MS); + }; + + fileWatcher.onDidCreate(onFileEvent); + fileWatcher.onDidDelete(onFileEvent); + fileWatcher.onDidChange(onFileEvent); + + this.disposables.push(fileWatcher); + } catch (err: any) { + const message = err?.message ?? String(err); + this.outputChannel.appendLine( + `[AutoRefreshService] FileSystemWatcher creation failed: ${message}. Notebooks panel will fall back to manual refresh.` + ); + } + } + + /** + * Called by DatabaseTreeProvider when a connection becomes active. + * Starts a SchemaPoller for the connection if one is not already running. + */ + onConnectionConnected(connectionId: string): void { + if (!this._enabled) { + return; + } + if (!this.pollers.has(connectionId)) { + const poller = new SchemaPoller( + connectionId, + (connId, database) => { + getSchemaCache().invalidateDatabase(connId, database); + this.databaseTreeProvider.refresh(); + }, + this.outputChannel + ); + poller.start(getPollIntervalMs()); + this.pollers.set(connectionId, poller); + } + } + + /** + * Called by DatabaseTreeProvider when a connection becomes inactive. + * Pauses the SchemaPoller for the connection. + */ + onConnectionDisconnected(connectionId: string): void { + if (!this._enabled) { + return; + } + const poller = this.pollers.get(connectionId); + if (poller) { + poller.pause(); + } + } + + dispose(): void { + for (const poller of this.pollers.values()) { + poller.dispose(); + } + this.pollers.clear(); + + this.debouncer.clear(); + + for (const d of this.disposables) { + d.dispose(); + } + this.disposables.length = 0; + } +} + +export { getAutoRefreshEnabled, getPollIntervalMs }; diff --git a/src/services/ConnectionManager.ts b/src/services/ConnectionManager.ts index b2b1cbe..9ebecc2 100644 --- a/src/services/ConnectionManager.ts +++ b/src/services/ConnectionManager.ts @@ -427,7 +427,7 @@ export class ConnectionManager { user: config.username || undefined, password: password || undefined, database: config.database || "postgres", - connectionTimeoutMillis: (config.connectTimeout || 5) * 1000, + connectionTimeoutMillis: (config.connectTimeout || 15) * 1000, statement_timeout: config.statementTimeout || vscode.workspace diff --git a/src/services/ErrorService.ts b/src/services/ErrorService.ts index f492bdd..c445abd 100644 --- a/src/services/ErrorService.ts +++ b/src/services/ErrorService.ts @@ -5,6 +5,31 @@ export interface IErrorService { handleCommandError(err: any, operation: string): Promise; } +const PG_ERROR_EXPLANATIONS: Record = { + '42P01': 'Table not found. The specified table does not exist in the current schema.', + '42703': 'Column not found. The specified column does not exist in the table.', + '23505': 'Unique constraint violation. A row with this value already exists.', + '23503': 'Foreign key violation. The referenced row does not exist in the parent table.', + '23502': 'Not null violation. A required column was not provided a value.', + '42601': 'Syntax error. The SQL statement contains invalid syntax.', + '42P02': 'Undefined parameter. A query parameter was referenced but not defined.', + '08006': 'Connection failure. The connection to the database server was lost.', + '40001': 'Serialization failure (deadlock). Two transactions conflicted and one was rolled back.', + '22001': 'String too long. The value exceeds the maximum length for the column.', + '22003': 'Numeric overflow. The value is outside the allowed range for the numeric type.', + '42501': 'Insufficient privilege. You do not have permission to perform this operation.', + '53300': 'Too many connections. The server has reached its maximum number of connections.', + '57014': 'Query cancelled. The query was cancelled before it completed.', +}; + +/** + * Returns a plain-English explanation for a PostgreSQL error code, + * or undefined if the code is not recognized. + */ +export function getErrorExplanation(code: string): string | undefined { + return PG_ERROR_EXPLANATIONS[code]; +} + export class ErrorService implements IErrorService { private static instance: ErrorService; diff --git a/src/services/SchemaPoller.ts b/src/services/SchemaPoller.ts new file mode 100644 index 0000000..4bebdf3 --- /dev/null +++ b/src/services/SchemaPoller.ts @@ -0,0 +1,157 @@ +import * as vscode from 'vscode'; +import { ConnectionManager } from './ConnectionManager'; + +const FINGERPRINT_SQL = ` +SELECT + COUNT(*)::text AS object_count, + COALESCE(MAX(c.oid)::text, '0') AS max_oid, + COALESCE(SUM(c.reltuples)::bigint::text, '0') AS total_rows_estimate, + (SELECT COUNT(*)::text FROM pg_namespace + WHERE nspname NOT IN ('pg_catalog','information_schema','pg_toast') + AND nspname NOT LIKE 'pg_%') AS schema_count, + COALESCE((SELECT MAX(oid)::text FROM pg_namespace + WHERE nspname NOT IN ('pg_catalog','information_schema','pg_toast') + AND nspname NOT LIKE 'pg_%'), '0') AS max_schema_oid +FROM pg_class c +JOIN pg_namespace n ON n.oid = c.relnamespace +WHERE n.nspname NOT IN ('pg_catalog', 'information_schema', 'pg_toast') + AND c.relkind IN ('r', 'v', 'f', 'm', 'p') +`; + +const MAX_CONSECUTIVE_FAILURES = 3; + +export class SchemaPoller implements vscode.Disposable { + private fingerprints: Map = new Map(); + private consecutiveFailures: number = 0; + private timer: NodeJS.Timeout | undefined; + private paused: boolean = false; + + constructor( + private readonly connectionId: string, + private readonly onFingerprintChanged: (connectionId: string, database: string) => void, + private readonly outputChannel: vscode.OutputChannel + ) {} + + /** + * Start polling at the given interval (milliseconds). + */ + start(intervalMs: number): void { + this.stopTimer(); + this.paused = false; + this.outputChannel.appendLine(`[SchemaPoller:${this.connectionId}] Starting — poll interval ${intervalMs}ms.`); + this.scheduleNext(intervalMs); + } + + /** + * Pause polling without resetting state. + */ + pause(): void { + this.paused = true; + this.stopTimer(); + } + + /** + * Resume polling at the given interval. + */ + resume(intervalMs: number): void { + this.paused = false; + this.scheduleNext(intervalMs); + } + + /** + * Update the polling interval while running. + * If currently paused, the new interval takes effect on next resume. + */ + updateInterval(intervalMs: number): void { + if (!this.paused && this.timer !== undefined) { + this.stopTimer(); + this.scheduleNext(intervalMs); + } + } + + dispose(): void { + this.stopTimer(); + this.fingerprints.clear(); + } + + // ── Private helpers ────────────────────────────────────────────────────────── + + private scheduleNext(intervalMs: number): void { + this.timer = setTimeout(() => this.poll(intervalMs), intervalMs); + } + + private stopTimer(): void { + if (this.timer !== undefined) { + clearTimeout(this.timer); + this.timer = undefined; + } + } + + private async poll(intervalMs: number): Promise { + const connections: any[] = vscode.workspace.getConfiguration().get('postgresExplorer.connections') || []; + const connection = connections.find(c => c.id === this.connectionId); + + if (!connection) { + this.outputChannel.appendLine(`[SchemaPoller:${this.connectionId}] Connection not found in configuration; stopping poller.`); + return; + } + + // Poll only the database this connection is configured for + const database = connection.database || 'postgres'; + await this.pollDatabase(connection, database); + + if (this.consecutiveFailures < MAX_CONSECUTIVE_FAILURES) { + this.scheduleNext(intervalMs); + } + } + + private async pollDatabase(connection: any, database: string): Promise { + let client: any; + try { + client = await ConnectionManager.getInstance().getPooledClient({ + ...connection, + database, + }); + + const result = await client.query(FINGERPRINT_SQL); + const row = result.rows[0]; + const fingerprint = `${row.object_count}|${row.max_oid}|${row.total_rows_estimate}|${row.schema_count}|${row.max_schema_oid}`; + + // Reset failure counter on success + this.consecutiveFailures = 0; + + const previous = this.fingerprints.get(database); + this.fingerprints.set(database, fingerprint); + + if (previous !== undefined && previous !== fingerprint) { + this.outputChannel.appendLine(`[SchemaPoller:${this.connectionId}] Fingerprint changed for "${database}": ${previous} → ${fingerprint}. Triggering refresh.`); + this.onFingerprintChanged(this.connectionId, database); + } else if (previous === undefined) { + this.outputChannel.appendLine(`[SchemaPoller:${this.connectionId}] Initial fingerprint stored for "${database}": ${fingerprint}`); + } else { + this.outputChannel.appendLine(`[SchemaPoller:${this.connectionId}] No change in "${database}" (${fingerprint})`); + } + } catch (err: any) { + this.consecutiveFailures++; + const message = err?.message ?? String(err); + this.outputChannel.appendLine( + `[SchemaPoller] Poll failed for connection ${this.connectionId}, database "${database}": ${message}` + ); + + if (this.consecutiveFailures >= MAX_CONSECUTIVE_FAILURES) { + this.outputChannel.appendLine( + `[SchemaPoller] Stopping poller for connection ${this.connectionId} after ${MAX_CONSECUTIVE_FAILURES} consecutive failures.` + ); + this.stopTimer(); + } + } finally { + if (client) { + try { + client.release(); + } catch (_) { + // ignore release errors + } + } + } + } +} diff --git a/src/services/SecretStorageService.ts b/src/services/SecretStorageService.ts index e4ff370..26df724 100644 --- a/src/services/SecretStorageService.ts +++ b/src/services/SecretStorageService.ts @@ -18,13 +18,25 @@ export class SecretStorageService { return await this.context.secrets.get(`postgres-password-${connectionId}`); } + public async getAiApiKey(): Promise { + return await this.context.secrets.get('postgresExplorer.aiApiKey'); + } + public async setPassword(connectionId: string, password: string): Promise { await this.context.secrets.store(`postgres-password-${connectionId}`, password); } + public async setAiApiKey(apiKey: string): Promise { + await this.context.secrets.store('postgresExplorer.aiApiKey', apiKey); + } + public async deletePassword(connectionId: string): Promise { await this.context.secrets.delete(`postgres-password-${connectionId}`); } + + public async deleteAiApiKey(): Promise { + await this.context.secrets.delete('postgresExplorer.aiApiKey'); + } } /** diff --git a/src/services/SessionRegistry.ts b/src/services/SessionRegistry.ts new file mode 100644 index 0000000..759f16d --- /dev/null +++ b/src/services/SessionRegistry.ts @@ -0,0 +1,173 @@ +import * as vscode from 'vscode'; + +/** + * Singleton registry mapping connectionId to the currently open NotebookDocument. + * Satisfies Requirements 2.4 and 4.1 — tracks at most one open scratch notebook per connection. + */ +class SessionRegistryClass { + private static instance: SessionRegistryClass; + private readonly map = new Map(); + + private constructor() {} + + static getInstance(): SessionRegistryClass { + if (!SessionRegistryClass.instance) { + SessionRegistryClass.instance = new SessionRegistryClass(); + } + return SessionRegistryClass.instance; + } + + get(connectionId: string): vscode.NotebookDocument | undefined { + return this.map.get(connectionId); + } + + set(connectionId: string, doc: vscode.NotebookDocument): void { + this.map.set(connectionId, doc); + } + + delete(connectionId: string): void { + this.map.delete(connectionId); + } + + has(connectionId: string): boolean { + return this.map.has(connectionId); + } + + entries(): IterableIterator<[string, vscode.NotebookDocument]> { + return this.map.entries(); + } +} + +export const SessionRegistry = SessionRegistryClass.getInstance(); + +/** + * Returns the URI for the persistent scratch notebook file for a given connection + database. + * Path: `{globalStorageUri}/{connectionName}/{databaseName}/scratch.pgsql` + */ +export function getScratchUri(globalStorageUri: vscode.Uri, connectionId: string, databaseName: string, connectionName?: string): vscode.Uri { + const safeName = (connectionName ?? connectionId).replace(/[^a-zA-Z0-9_-]/g, '_'); + const safeDb = databaseName.replace(/[^a-zA-Z0-9_-]/g, '_'); + return vscode.Uri.joinPath(globalStorageUri, safeName, safeDb, 'scratch.pgsql'); +} + +const _ADJECTIVES = [ + 'admiring', 'adoring', 'affectionate', 'agitated', 'amazing', 'angry', 'awesome', + 'blissful', 'bold', 'boring', 'brave', 'busy', 'charming', 'clever', 'cool', + 'compassionate', 'competent', 'condescending', 'confident', 'cranky', 'crazy', + 'dazzling', 'determined', 'distracted', 'dreamy', 'eager', 'ecstatic', 'elastic', + 'elated', 'elegant', 'eloquent', 'epic', 'exciting', 'fervent', 'festive', + 'flamboyant', 'focused', 'friendly', 'frosty', 'funny', 'gallant', 'gifted', + 'goofy', 'gracious', 'happy', 'hardcore', 'heuristic', 'hopeful', 'hungry', + 'infallible', 'inspiring', 'jolly', 'jovial', 'keen', 'kind', 'laughing', + 'loving', 'lucid', 'magical', 'modest', 'mystifying', 'naughty', 'nervous', + 'nifty', 'nostalgic', 'objective', 'optimistic', 'peaceful', 'pedantic', + 'pensive', 'practical', 'priceless', 'quirky', 'quizzical', 'recursing', + 'relaxed', 'reverent', 'romantic', 'sad', 'serene', 'sharp', 'silly', + 'sleepy', 'stoic', 'strange', 'stupefied', 'suspicious', 'sweet', 'tender', + 'thirsty', 'trusting', 'unruffled', 'upbeat', 'vibrant', 'vigilant', + 'vigorous', 'wizardly', 'wonderful', 'xenodochial', 'youthful', 'zealous', +]; + +const _NAMES = [ + 'albattani', 'allen', 'almeida', 'antonelli', 'archimedes', 'ardinghelli', + 'aryabhata', 'austin', 'babbage', 'banach', 'banzai', 'bardeen', 'bartik', + 'bassi', 'beaver', 'bell', 'benz', 'bhabha', 'bhaskara', 'black', 'blackburn', + 'blackwell', 'bohr', 'booth', 'borg', 'bose', 'bouman', 'boyd', 'brahmagupta', + 'brattain', 'brown', 'buck', 'burnell', 'cannon', 'carson', 'cartwright', + 'cerf', 'chandrasekhar', 'chaplygin', 'chatelet', 'chatterjee', 'chebyshev', + 'cohen', 'colden', 'cori', 'cray', 'curie', 'darwin', 'davinci', 'dewdney', + 'dhawan', 'diffie', 'dijkstra', 'dirac', 'driscoll', 'dubinsky', 'easley', + 'edison', 'einstein', 'elbakyan', 'elion', 'ellis', 'engelbart', 'euclid', + 'euler', 'faraday', 'feistel', 'fermat', 'fermi', 'feynman', 'franklin', + 'gagarin', 'galileo', 'galois', 'gates', 'gauss', 'germain', 'goldberg', + 'goldstine', 'goldwasser', 'golick', 'goodall', 'gould', 'greider', 'grothendieck', + 'haibt', 'hamilton', 'haslett', 'hawking', 'heisenberg', 'hellman', 'hertz', + 'heyrovsky', 'hodgkin', 'hofstadter', 'hoover', 'hopper', 'hugle', 'hypatia', + 'ishizaka', 'jackson', 'jang', 'jennings', 'jepsen', 'johnson', 'joliot', + 'jones', 'kalam', 'kapitsa', 'kare', 'keldysh', 'keller', 'kepler', 'khayyam', + 'khorana', 'kilby', 'kirch', 'knuth', 'kowalevski', 'lalande', 'lamarr', + 'lamport', 'leakey', 'leavitt', 'lederberg', 'lehmann', 'lewin', 'lichterman', + 'liskov', 'lovelace', 'lumiere', 'mahavira', 'margulis', 'matsumoto', 'maxwell', + 'mccarthy', 'mcclintock', 'mclaren', 'mclean', 'mcnulty', 'mendel', 'mendeleev', + 'minsky', 'mirzakhani', 'morse', 'moser', 'murdock', 'napier', 'nash', 'neumann', + 'newton', 'nightingale', 'nobel', 'noether', 'northcutt', 'noyce', 'panini', + 'pare', 'pascal', 'pasteur', 'payne', 'perlman', 'pike', 'poincare', 'poitras', + 'proskuriakova', 'ptolemy', 'raman', 'ramanujan', 'ride', 'ritchie', 'robinson', + 'roentgen', 'rosalind', 'rubin', 'saha', 'sammet', 'sanderson', 'satoshi', + 'shamir', 'shannon', 'shaw', 'shirley', 'shockley', 'shtern', 'sinoussi', + 'snyder', 'solomon', 'spence', 'stonebraker', 'sutherland', 'swanson', 'swartz', + 'swirles', 'taussig', 'tesla', 'tharp', 'thompson', 'torvalds', 'tu', 'turing', + 'varahamihira', 'vaughan', 'villani', 'visvesvaraya', 'volhard', 'wescoff', + 'wilbur', 'wiles', 'williams', 'williamson', 'wilson', 'wing', 'wozniak', + 'wright', 'wu', 'yalow', 'yonath', 'zhukovsky', +]; + +function _randomNotebookName(): string { + const adj = _ADJECTIVES[Math.floor(Math.random() * _ADJECTIVES.length)]; + const name = _NAMES[Math.floor(Math.random() * _NAMES.length)]; + return `${adj}_${name}`; +} + +/** + * Returns the URI for a new notebook file with a unique random name. + * Pattern: `{globalStorageUri}/{connectionName}/{databaseName}/{adjective}_{name}.pgsql` + */ +export async function getNewNotebookUri(globalStorageUri: vscode.Uri, databaseName: string, connectionName?: string): Promise { + const safeName = (connectionName ?? 'notebook').replace(/[^a-zA-Z0-9_-]/g, '_'); + const safeDb = databaseName.replace(/[^a-zA-Z0-9_-]/g, '_'); + while (true) { + const filename = _randomNotebookName(); + const uri = vscode.Uri.joinPath(globalStorageUri, safeName, safeDb, `${filename}.pgsql`); + try { + await vscode.workspace.fs.stat(uri); + // Name already exists, try another + } catch { + return uri; + } + } +} + +/** + * Returns the URI of the most recently modified non-scratch notebook for this connection+db, + * or undefined if none exist yet. + */ +export async function getLatestNumberedUri(globalStorageUri: vscode.Uri, databaseName: string, connectionName?: string): Promise { + const safeName = (connectionName ?? 'notebook').replace(/[^a-zA-Z0-9_-]/g, '_'); + const safeDb = databaseName.replace(/[^a-zA-Z0-9_-]/g, '_'); + const dir = vscode.Uri.joinPath(globalStorageUri, safeName, safeDb); + let entries: [string, vscode.FileType][]; + try { + entries = await vscode.workspace.fs.readDirectory(dir); + } catch { + return undefined; + } + let latestUri: vscode.Uri | undefined; + let latestMtime = -1; + for (const [name, type] of entries) { + if (type !== vscode.FileType.File || !name.endsWith('.pgsql') || name === 'scratch.pgsql') { + continue; + } + const uri = vscode.Uri.joinPath(dir, name); + try { + const stat = await vscode.workspace.fs.stat(uri); + if (stat.mtime > latestMtime) { + latestMtime = stat.mtime; + latestUri = uri; + } + } catch { + // skip unreadable files + } + } + return latestUri; +} + +/** + * Returns true if the given notebook URI belongs to the connection+db folder. + */ +export function isNotebookForSession(uri: vscode.Uri, databaseName: string, connectionName?: string, connectionId?: string): boolean { + const safeName = (connectionName ?? connectionId ?? 'notebook').replace(/[^a-zA-Z0-9_-]/g, '_'); + const safeDb = databaseName.replace(/[^a-zA-Z0-9_-]/g, '_'); + // URI path must contain /{safeName}/{safeDb}/ as a segment + const segment = `/${safeName}/${safeDb}/`; + return uri.path.includes(segment); +} diff --git a/src/services/SqlFormatterService.ts b/src/services/SqlFormatterService.ts new file mode 100644 index 0000000..45d99d3 --- /dev/null +++ b/src/services/SqlFormatterService.ts @@ -0,0 +1,76 @@ +/** + * SqlFormatterService.ts + * Wraps the sql-formatter library with PostgreSQL dialect and VS Code configuration. + */ + +import * as vscode from 'vscode'; +import { SqlFormatterConfig } from '../common/types'; + +// Lazy import to avoid loading sql-formatter on extension activate +let formatFn: ((sql: string, opts: any) => string) | null = null; + +async function getFormatter(): Promise<(sql: string, opts: any) => string> { + if (formatFn) { return formatFn; } + // Dynamic import handles both ESM and CommonJS builds + try { + const mod = await import('sql-formatter'); + formatFn = mod.format; + return formatFn!; + } catch { + // Fallback if import fails + throw new Error('sql-formatter is not available. Run: npm install sql-formatter'); + } +} + +export class SqlFormatterService { + private static instance: SqlFormatterService; + + static getInstance(): SqlFormatterService { + if (!SqlFormatterService.instance) { + SqlFormatterService.instance = new SqlFormatterService(); + } + return SqlFormatterService.instance; + } + + getConfig(): SqlFormatterConfig { + const cfg = vscode.workspace.getConfiguration('postgresExplorer.formatter'); + return { + keywordCase: cfg.get<'upper' | 'lower' | 'preserve'>('keywordCase', 'upper'), + indentStyle: cfg.get<'standard' | 'tabularLeft' | 'tabularRight'>('indentStyle', 'standard'), + tabWidth: cfg.get('tabWidth', 2), + useTabs: cfg.get('useTabs', false), + linesBetweenQueries: cfg.get('linesBetweenQueries', 1), + formatOnSave: cfg.get('formatOnSave', false), + }; + } + + async format(sql: string, overrides?: Partial): Promise { + const config = { ...this.getConfig(), ...overrides }; + const format = await getFormatter(); + + return format(sql, { + language: 'postgresql', + keywordCase: config.keywordCase, + indentStyle: config.indentStyle, + tabWidth: config.tabWidth, + useTabs: config.useTabs, + linesBetweenQueries: config.linesBetweenQueries, + }); + } + + async formatDocument(document: vscode.TextDocument): Promise { + const text = document.getText(); + try { + const formatted = await this.format(text); + if (formatted === text) { return []; } + const fullRange = new vscode.Range( + document.positionAt(0), + document.positionAt(text.length) + ); + return [vscode.TextEdit.replace(fullRange, formatted)]; + } catch (err) { + vscode.window.showErrorMessage(`SQL formatter error: ${(err as Error).message}`); + return []; + } + } +} diff --git a/src/services/handlers/CoreHandlers.ts b/src/services/handlers/CoreHandlers.ts index 3db1a12..0af813e 100644 --- a/src/services/handlers/CoreHandlers.ts +++ b/src/services/handlers/CoreHandlers.ts @@ -51,7 +51,7 @@ export class ShowDatabaseSwitcherHandler implements IMessageHandler { } } -export class ImportRequestHandler implements IMessageHandler { +export class ImportPickFileHandler implements IMessageHandler { async handle(message: any, context: { editor: vscode.NotebookEditor }) { if (!context.editor) return; @@ -68,58 +68,203 @@ export class ImportRequestHandler implements IMessageHandler { return; } - const { table, schema, data } = message; - if (!data || !Array.isArray(data) || data.length === 0) { - vscode.window.showWarningMessage('No data received for import.'); + const { table, schema } = message; + + // Step 1: Native OS file picker — no iframe issues + const uris = await vscode.window.showOpenDialog({ + canSelectMany: false, + openLabel: `Import into ${schema}.${table}`, + filters: { 'Data files': ['csv', 'tsv', 'json', 'txt'] } + }); + if (!uris || uris.length === 0) return; + + const fileUri = uris[0]; + const ext = fileUri.fsPath.split('.').pop()?.toLowerCase() ?? ''; + + // Step 2: Read file + const rawBytes = await vscode.workspace.fs.readFile(fileUri); + const content = Buffer.from(rawBytes).toString('utf8'); + + // Step 3: Parse + let parsedData: any[]; + try { + if (ext === 'json') { + const json = JSON.parse(content); + if (!Array.isArray(json)) { + vscode.window.showErrorMessage('JSON file must contain an array of objects.'); + return; + } + parsedData = json; + } else { + // CSV / TSV / TXT + const delimiter = ext === 'tsv' ? '\t' : ','; + parsedData = parseDelimited(content, delimiter); + } + } catch (err: any) { + vscode.window.showErrorMessage(`Failed to parse file: ${err.message}`); return; } - const client = await import('../../services/ConnectionManager').then(m => m.ConnectionManager.getInstance().getPooledClient(connection)); + if (parsedData.length === 0) { + vscode.window.showWarningMessage('File contains no data rows.'); + return; + } - try { - await client.query('BEGIN'); - - // Batch insert logic - const BATCH_SIZE = 100; - const columns = Object.keys(data[0]); - const quotedColumns = columns.map(c => `"${c}"`).join(', '); - const tableName = `"${schema}"."${table}"`; - - let insertedCount = 0; - - for (let i = 0; i < data.length; i += BATCH_SIZE) { - const batch = data.slice(i, i + BATCH_SIZE); - const values: any[] = []; - const placeholders: string[] = []; - - batch.forEach((row, rowIndex) => { - const rowPlaceholders: string[] = []; - columns.forEach((col, colIndex) => { - rowPlaceholders.push(`$${values.length + 1}`); - values.push(row[col] ?? null); - }); - placeholders.push(`(${rowPlaceholders.join(', ')})`); - }); + // Step 4: Ask conflict strategy via quick pick + const conflictChoice = await vscode.window.showQuickPick( + [ + { label: 'Skip duplicates', description: 'ON CONFLICT DO NOTHING', value: 'skip' }, + { label: 'Fail on duplicate', description: 'Stop and rollback on any conflict', value: 'fail' }, + ], + { placeHolder: 'How should duplicate primary keys be handled?' } + ); + if (!conflictChoice) return; - const query = `INSERT INTO ${tableName} (${quotedColumns}) VALUES ${placeholders.join(', ')}`; - await client.query(query, values); - insertedCount += batch.length; - } + // Step 5: Insert + await performImport({ table, schema, data: parsedData, onConflict: conflictChoice.value }, connection); + } +} - await client.query('COMMIT'); - vscode.window.showInformationMessage(`Successfully imported ${insertedCount} rows into ${schema}.${table}.`); +function parseDelimited(text: string, delimiter: string): any[] { + const lines = text.split(/\r?\n/).filter(l => l.trim().length > 0); + if (lines.length < 2) return []; - // Notify renderer to refresh? - // Actually we just show message. The user might need to re-run query to see data. - // We could trigger a re-run if we had access to the cell, but we are in a handler. + const headers = splitLine(lines[0], delimiter).map(h => h.replace(/^"|"$/g, '').trim()); + const result: any[] = []; - } catch (err: any) { + for (let i = 1; i < lines.length; i++) { + const values = splitLine(lines[i], delimiter); + const row: any = {}; + headers.forEach((h, idx) => { + const v = (values[idx] ?? '').replace(/^"|"$/g, '').replace(/""/g, '"').trim(); + row[h] = v === '' ? null : v; + }); + result.push(row); + } + return result; +} + +function splitLine(line: string, delimiter: string): string[] { + const values: string[] = []; + let inQuote = false; + let val = ''; + for (let j = 0; j < line.length; j++) { + const c = line[j]; + if (c === '"') { + inQuote = !inQuote; + } else if (c === delimiter && !inQuote) { + values.push(val); + val = ''; + } else { + val += c; + } + } + values.push(val); + return values; +} + +async function performImport( + message: { table: string; schema: string; data: any[]; onConflict: string }, + connection: any +) { + const { table, schema, data, onConflict } = message; + + const client = await import('../../services/ConnectionManager').then( + m => m.ConnectionManager.getInstance().getPooledClient(connection) + ); + + try { + await client.query('BEGIN'); + + // Detect auto-generated columns (serial / identity) to exclude from INSERT + const colMetaResult = await client.query( + `SELECT column_name, column_default, is_identity + FROM information_schema.columns + WHERE table_schema = $1 AND table_name = $2`, + [schema, table] + ); + + const autoGenColumns = new Set( + colMetaResult.rows + .filter((r: any) => + (r.column_default && r.column_default.includes('nextval(')) || + r.is_identity === 'YES' + ) + .map((r: any) => r.column_name) + ); + + const allColumns = Object.keys(data[0]); + const columns = allColumns.filter(c => !autoGenColumns.has(c)); + + if (columns.length === 0) { + vscode.window.showWarningMessage('No importable columns found (all columns are auto-generated).'); await client.query('ROLLBACK'); - vscode.window.showErrorMessage(`Import failed: ${err.message}`); - console.error('Import error:', err); - } finally { - client.release(); + return; + } + + const quotedColumns = columns.map(c => `"${c}"`).join(', '); + const tableName = `"${schema}"."${table}"`; + const conflictClause = onConflict === 'skip' ? ' ON CONFLICT DO NOTHING' : ''; + const BATCH_SIZE = 100; + let insertedCount = 0; + + for (let i = 0; i < data.length; i += BATCH_SIZE) { + const batch = data.slice(i, i + BATCH_SIZE); + const values: any[] = []; + const placeholders: string[] = []; + + batch.forEach(row => { + const rowPlaceholders: string[] = []; + columns.forEach(col => { + rowPlaceholders.push(`$${values.length + 1}`); + const v = row[col]; + values.push(v === '' || v === undefined ? null : v); + }); + placeholders.push(`(${rowPlaceholders.join(', ')})`); + }); + + const query = `INSERT INTO ${tableName} (${quotedColumns}) VALUES ${placeholders.join(', ')}${conflictClause}`; + const result = await client.query(query, values); + insertedCount += result.rowCount ?? batch.length; } + + await client.query('COMMIT'); + vscode.window.showInformationMessage( + `Successfully imported ${insertedCount} rows into ${schema}.${table}.` + ); + } catch (err: any) { + await client.query('ROLLBACK'); + vscode.window.showErrorMessage(`Import failed: ${err.message}`); + console.error('Import error:', err); + } finally { + client.release(); + } +} + +export class ImportRequestHandler implements IMessageHandler { + async handle(message: any, context: { editor: vscode.NotebookEditor }) { + if (!context.editor) return; + + const metadata = context.editor.notebook.metadata; + const connectionId = metadata?.connectionId; + if (!connectionId) { + vscode.window.showErrorMessage('No active connection found for this notebook.'); + return; + } + + const connection = ConnectionUtils.findConnection(connectionId); + if (!connection) { + vscode.window.showErrorMessage('Connection configuration not found.'); + return; + } + + const { data } = message; + if (!data || !Array.isArray(data) || data.length === 0) { + vscode.window.showWarningMessage('No data received for import.'); + return; + } + + await performImport(message, connection); } } @@ -166,3 +311,31 @@ export class ShowErrorMessageHandler implements IMessageHandler { } } +export class RetryCellHandler implements IMessageHandler { + async handle(message: any, context: { editor?: vscode.NotebookEditor }) { + if (!context.editor) return; + // Re-execute the active cell that produced this error + const notebook = context.editor.notebook; + const cells = notebook.getCells(); + // Find the cell whose query matches, or just re-run the active selection + await vscode.commands.executeCommand('notebook.cell.execute'); + } +} + +export class ShowConnectionInfoHandler implements IMessageHandler { + async handle(message: any, context: { editor?: vscode.NotebookEditor }) { + if (!context.editor) return; + const notebook = context.editor.notebook; + const metadata = notebook.metadata as any; + const connections = vscode.workspace.getConfiguration().get('postgresExplorer.connections') || []; + const conn = connections.find(c => c.id === metadata?.connectionId); + if (conn) { + vscode.window.showInformationMessage( + `Connection: ${conn.name || conn.host} | Host: ${conn.host}:${conn.port} | Database: ${metadata?.databaseName || conn.database}` + ); + } else { + vscode.window.showInformationMessage('No active connection for this notebook.'); + } + } +} + diff --git a/src/services/handlers/ExplainHandlers.ts b/src/services/handlers/ExplainHandlers.ts index ac727f1..a588026 100644 --- a/src/services/handlers/ExplainHandlers.ts +++ b/src/services/handlers/ExplainHandlers.ts @@ -34,6 +34,7 @@ export class AnalyzeDataHandler implements IMessageHandler { async handle(message: any) { if (this.chatViewProvider) { + await vscode.commands.executeCommand('postgresExplorer.chatView.focus'); await this.chatViewProvider.handleAnalyzeData(message.data, message.query, message.rowCount); } } @@ -44,6 +45,7 @@ export class OptimizeQueryHandler implements IMessageHandler { async handle(message: any) { if (this.chatViewProvider) { + await vscode.commands.executeCommand('postgresExplorer.chatView.focus'); await this.chatViewProvider.handleOptimizeQuery(message.query, message.executionTime); } } diff --git a/src/services/handlers/FkLookupHandler.ts b/src/services/handlers/FkLookupHandler.ts new file mode 100644 index 0000000..553993d --- /dev/null +++ b/src/services/handlers/FkLookupHandler.ts @@ -0,0 +1,92 @@ +/** + * FkLookupHandler.ts + * Handles FK lookup requests from the data grid. + * Queries the referenced table and returns matching rows for the FK dropdown. + */ + +import * as vscode from 'vscode'; +import { IMessageHandler } from '../MessageHandler'; +import { ConnectionManager } from '../ConnectionManager'; +import { ConnectionUtils } from '../../utils/connectionUtils'; +import { PostgresMetadata, FkLookupRequest } from '../../common/types'; + +export class FkLookupHandler implements IMessageHandler { + async handle(message: FkLookupRequest, context: { + editor?: any; + webview?: any; + postMessage?: (message: any) => Thenable; + [key: string]: any; + }): Promise { + const { requestId, fkSchema, fkTable, fkColumn, searchText, limit } = message; + const postMessage = context.postMessage; + if (!postMessage) { return; } + + const editor = context.editor; + if (!editor) { + return; + } + + let client: any; + try { + // Get the connection from the notebook metadata + const metadata = editor.notebook?.metadata as PostgresMetadata | undefined; + if (!metadata?.connectionId) { + return; + } + + const connectionConfig = ConnectionUtils.findConnection(metadata.connectionId); + if (!connectionConfig) { + throw new Error('Connection not found'); + } + + client = await ConnectionManager.getInstance().getPooledClient(connectionConfig); + + const quotedSchema = `"${fkSchema.replace(/"/g, '""')}"`; + const quotedTable = `"${fkTable.replace(/"/g, '""')}"`; + const quotedColumn = `"${fkColumn.replace(/"/g, '""')}"`; + const trimmedSearchText = searchText.trim(); + const clampedLimit = Math.min(Math.max(Number(limit) || 50, 1), 100); + + let query: string; + let params: any[]; + + if (trimmedSearchText) { + query = ` + SELECT ${quotedColumn} + FROM ${quotedSchema}.${quotedTable} + WHERE ${quotedColumn} = $1 OR ${quotedColumn}::text ILIKE $2 + ORDER BY ${quotedColumn} + LIMIT $3 + `; + params = [trimmedSearchText, `%${trimmedSearchText}%`, clampedLimit]; + } else { + query = ` + SELECT ${quotedColumn} + FROM ${quotedSchema}.${quotedTable} + ORDER BY ${quotedColumn} + LIMIT $1 + `; + params = [clampedLimit]; + } + + const result = await client.query(query, params); + const columns = Array.isArray(result.fields) && result.fields.length > 0 + ? result.fields.map((field: any) => field.name) + : Object.keys(result.rows?.[0] || {}); + + postMessage({ + type: 'fkLookupResponse', + requestId, + rows: result.rows, + columns, + }); + } catch (err) { + console.error('FkLookupHandler error:', err); + const message = err instanceof Error ? err.message : String(err); + await vscode.window.showErrorMessage(`FK lookup failed: ${message}`); + await postMessage({ type: 'fkLookupResponse', requestId, rows: [], columns: [] }); + } finally { + if (client) { client.release(); } + } + } +} diff --git a/src/services/handlers/InsertRowHandler.ts b/src/services/handlers/InsertRowHandler.ts new file mode 100644 index 0000000..e14abd8 --- /dev/null +++ b/src/services/handlers/InsertRowHandler.ts @@ -0,0 +1,97 @@ +/** + * InsertRowHandler.ts + * Handles in-grid INSERT of a new row. + * Executes the INSERT and returns the actual inserted row (with DB defaults applied). + */ + +import { IMessageHandler } from '../MessageHandler'; +import { ConnectionManager } from '../ConnectionManager'; +import { PostgresMetadata, TableInfo } from '../../common/types'; + +interface InsertRowMessage { + type: 'insertRow'; + tableInfo: TableInfo; + values: Record; + tempId: string; +} + +function quoteIdentifier(name: string): string { + return `"${name.replace(/"/g, '""')}"`; +} + +export class InsertRowHandler implements IMessageHandler { + async handle(message: InsertRowMessage, context: { + editor?: any; + webview?: any; + postMessage?: (message: any) => Thenable; + [key: string]: any; + }): Promise { + const { tableInfo, values, tempId } = message; + const postMessage = context.postMessage; + if (!postMessage) { return; } + + const editor = context.editor; + if (!editor?.notebook?.metadata?.connectionId) { + postMessage({ type: 'insertFailed', tempId, error: 'No active connection found' }); + return; + } + + const metadata = editor.notebook.metadata as PostgresMetadata; + let client: any; + + try { + const connectionConfig = { + id: metadata.connectionId, + name: metadata.host, + host: metadata.host, + port: metadata.port, + username: metadata.username, + database: metadata.databaseName, + }; + + client = await ConnectionManager.getInstance().getPooledClient(connectionConfig); + + const schema = tableInfo.schema || 'public'; + const table = tableInfo.table; + if (!table) { + postMessage({ type: 'insertFailed', tempId, error: 'No table name in tableInfo' }); + return; + } + + // Filter out null values for columns the user left empty + // (let DB defaults apply) + const filteredValues: Record = {}; + for (const [col, val] of Object.entries(values)) { + if (val !== '' && val !== undefined) { + filteredValues[col] = val === '__NULL__' ? null : val; + } + } + + if (Object.keys(filteredValues).length === 0) { + postMessage({ type: 'insertFailed', tempId, error: 'No values provided for INSERT' }); + return; + } + + const columns = Object.keys(filteredValues); + const paramValues = Object.values(filteredValues); + const columnList = columns.map(quoteIdentifier).join(', '); + const paramList = columns.map((_, i) => `$${i + 1}`).join(', '); + const tableRef = `${quoteIdentifier(schema)}.${quoteIdentifier(table)}`; + + // Use RETURNING * to get the actual inserted row with DB defaults applied + const sql = `INSERT INTO ${tableRef} (${columnList}) VALUES (${paramList}) RETURNING *`; + const result = await client.query(sql, paramValues); + + if (result.rows.length > 0) { + postMessage({ type: 'insertSuccess', tempId, actualRow: result.rows[0] }); + } else { + postMessage({ type: 'insertFailed', tempId, error: 'INSERT did not return a row' }); + } + } catch (err: any) { + const errorMsg = err?.message || String(err); + postMessage({ type: 'insertFailed', tempId, error: errorMsg }); + } finally { + if (client) { client.release(); } + } + } +} diff --git a/src/services/handlers/QueryHandlers.ts b/src/services/handlers/QueryHandlers.ts index 0c828cb..4f6c5e2 100644 --- a/src/services/handlers/QueryHandlers.ts +++ b/src/services/handlers/QueryHandlers.ts @@ -5,6 +5,7 @@ import { ConnectionManager } from '../../services/ConnectionManager'; import { ErrorHandlers } from '../../commands/helper'; import { ConnectionUtils } from '../../utils/connectionUtils'; import { SqlExecutor } from '../../providers/kernel/SqlExecutor'; +export { FkLookupHandler } from './FkLookupHandler'; function quoteIdentifier(identifier: string): string { return `"${String(identifier).replace(/"/g, '""')}"`; @@ -315,6 +316,10 @@ export class SaveChangesHandler implements IMessageHandler { } } vscode.window.showErrorMessage(`Failed to save changes: ${err.message}`); + // Notify renderer to restore the save button + if (context.postMessage) { + context.postMessage({ type: 'saveFailed' }); + } } finally { if (client) client.release(); } diff --git a/src/services/handlers/TransactionHandlers.ts b/src/services/handlers/TransactionHandlers.ts index 22f3911..f4d33d5 100644 --- a/src/services/handlers/TransactionHandlers.ts +++ b/src/services/handlers/TransactionHandlers.ts @@ -4,6 +4,7 @@ import { getTransactionManager, IsolationLevel } from '../../services/Transactio import { ConnectionManager } from '../../services/ConnectionManager'; import { ConnectionUtils } from '../../utils/connectionUtils'; import { PostgresMetadata } from '../../common/types'; +import { statusBar } from '../../extension'; async function getSessionClient(notebook: vscode.NotebookDocument): Promise { const metadata = notebook.metadata as PostgresMetadata; @@ -36,6 +37,7 @@ export class TransactionBeginHandler implements IMessageHandler { const summary = txManager.getTransactionSummary(sessionId); vscode.window.showInformationMessage(summary); + statusBar?.updateTransactionState(sessionId); } catch (err: any) { vscode.window.showErrorMessage(`Failed to begin transaction: ${err.message}`); } @@ -53,6 +55,7 @@ export class TransactionCommitHandler implements IMessageHandler { await txManager.commitTransaction(client, sessionId); vscode.window.showInformationMessage('✅ Transaction committed'); + statusBar?.updateTransactionState(sessionId); } catch (err: any) { vscode.window.showErrorMessage(`Failed to commit transaction: ${err.message}`); } @@ -70,6 +73,7 @@ export class TransactionRollbackHandler implements IMessageHandler { await txManager.rollbackTransaction(client, sessionId); vscode.window.showInformationMessage('⏮️ Transaction rolled back'); + statusBar?.updateTransactionState(sessionId); } catch (err: any) { vscode.window.showErrorMessage(`Failed to rollback transaction: ${err.message}`); } diff --git a/src/test/unit/AiService.test.ts b/src/test/unit/AiService.test.ts new file mode 100644 index 0000000..d628a7a --- /dev/null +++ b/src/test/unit/AiService.test.ts @@ -0,0 +1,382 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { AiService } from '../../providers/chat/AiService'; +import { SecretStorageService } from '../../services/SecretStorageService'; + +class MockTextPart { + constructor(public value: string) { } +} + +class MockToolCallPart { + constructor(public name: string) { } +} + +class MockImagePart { + constructor(public mimeType: string, public bytes: Uint8Array) { } +} + +function createConfig(values: Record) { + return { + get: (key: string, defaultValue?: any) => { + if (Object.prototype.hasOwnProperty.call(values, key)) { + return values[key]; + } + + return defaultValue; + } + } as any; +} + +function asyncIterable(values: T[]): AsyncIterable { + return { + async *[Symbol.asyncIterator]() { + for (const value of values) { + yield value; + } + } + } as any; +} + +function createImageMessage() { + return { + role: 'user' as const, + content: 'Analyze the attachment', + attachments: [ + { + name: 'diagram.png', + type: 'image', + dataUrl: 'data:image/png;base64,AAAA' + }, + { + name: 'notes.txt', + type: 'text', + content: 'Important notes' + } + ] + }; +} + +function createPlainMessage() { + return { + role: 'user' as const, + content: 'Prior context' + }; +} + +describe('AiService', () => { + let sandbox: sinon.SinonSandbox; + let originalAuthentication: any; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + originalAuthentication = (vscode as any).authentication; + + (vscode as any).LanguageModelChatMessage.System = (content: string) => ({ role: 'system', content }); + (vscode as any).LanguageModelTextPart = MockTextPart; + (vscode as any).LanguageModelToolCallPart = MockToolCallPart; + (vscode as any).LanguageModelImagePart = MockImagePart; + (vscode as any).authentication = { getSession: sandbox.stub() }; + }); + + afterEach(() => { + sandbox.restore(); + delete (vscode as any).LanguageModelChatMessage.System; + delete (vscode as any).LanguageModelTextPart; + delete (vscode as any).LanguageModelToolCallPart; + delete (vscode as any).LanguageModelImagePart; + (vscode as any).authentication = originalAuthentication; + }); + + it('builds the system prompt and clears cancellation state', () => { + const service = new AiService(); + const cancelStub = sandbox.stub(); + const disposeStub = sandbox.stub(); + const abortStub = sandbox.stub(); + + (service as any)._cancellationTokenSource = { cancel: cancelStub, dispose: disposeStub }; + (service as any)._abortController = { abort: abortStub }; + + const prompt = service.buildSystemPrompt(); + expect(prompt).to.contain('PostgreSQL database assistant'); + expect(prompt).to.contain('SQL QUALITY CHECKLIST'); + expect(prompt).to.contain('DATABASE SCHEMA CONTEXT'); + + service.cancel(); + + expect(cancelStub.calledOnce).to.be.true; + expect(disposeStub.calledOnce).to.be.true; + expect(abortStub.calledOnce).to.be.true; + expect((service as any)._cancellationTokenSource).to.equal(null); + expect((service as any)._abortController).to.equal(null); + }); + + it('generates titles from VS Code LM and falls back to a simple title', async () => { + const service = new AiService(); + const titleModel = { + id: 'title-model', + name: 'Title Model', + family: 'gpt-4o', + sendRequest: sandbox.stub().resolves({ text: asyncIterable(['Chat Title']) }) + }; + const selectModelsStub = sandbox.stub(vscode.lm, 'selectChatModels').resolves([titleModel as any]); + + const generated = await service.generateTitle('Show me active users by region', 'vscode-lm'); + expect(generated).to.equal('Chat Title'); + expect(titleModel.sendRequest.calledOnce).to.be.true; + expect((titleModel.sendRequest.firstCall.args[0] as any[])[0].content).to.contain('Generate a very short title'); + + const fallback = await service.generateTitle('0123456789012345678901234567890123456789extra text', 'openai'); + expect(fallback).to.equal('0123456789012345678901234567890123456789...'); + expect(selectModelsStub.calledOnce).to.be.true; + }); + + it('reports model info for configured and fallback VS Code LM models', async () => { + const service = new AiService(); + const selectModelsStub = sandbox.stub(service as any, '_selectChatModelsWithTimeout'); + selectModelsStub.onCall(0).resolves([ + { id: 'title-model', name: 'Primary Model', family: 'gpt-4o' } + ]); + selectModelsStub.onCall(1).resolves([ + { id: 'family-model', name: 'Family Model', family: 'gpt-4o' } + ]); + selectModelsStub.onCall(2).resolves([]); + selectModelsStub.onCall(3).resolves([]); + + const configured = await service.getModelInfo('vscode-lm', createConfig({ aiModel: 'Primary Model (gpt-4o)' })); + expect(configured).to.equal('Primary Model'); + + const family = await service.getModelInfo('vscode-lm', createConfig({})); + expect(family).to.equal('Family Model'); + + const none = await service.getModelInfo('vscode-lm', createConfig({})); + expect(none).to.equal('VS Code LM (No Models)'); + + const githubDefault = await service.getModelInfo('github', createConfig({})); + expect(githubDefault).to.equal('openai/gpt-4.1'); + }); + + it('calls VS Code LM with image attachments and streamed text', async () => { + const service = new AiService(); + service.setMessages([createImageMessage() as any]); + + const primaryModel = { + id: 'primary-model', + name: 'Primary Model', + family: 'gpt-4o', + sendRequest: sandbox.stub().resolves({ stream: asyncIterable([new MockTextPart('Streamed answer')]) }) + }; + + const selectModelsStub = sandbox.stub(vscode.lm, 'selectChatModels').callsFake(async (selector: any) => { + if (selector && selector.family === 'gpt-4o') { + return [primaryModel as any]; + } + + return [primaryModel as any]; + }); + + const result = await service.callVsCodeLm('Please continue', createConfig({}), 'Custom system prompt'); + + expect(result.text).to.equal('Streamed answer'); + expect(selectModelsStub.calledOnceWithExactly({ family: 'gpt-4o' })).to.be.true; + + const requestMessages = primaryModel.sendRequest.firstCall.args[0] as any[]; + expect(requestMessages[0]).to.deep.equal({ role: 'system', content: 'Custom system prompt' }); + expect(requestMessages[1].role).to.equal('user'); + expect(Array.isArray(requestMessages[1].content)).to.be.true; + expect(requestMessages[1].content.some((part: any) => part instanceof MockImagePart)).to.be.true; + expect(requestMessages[1].content.some((part: any) => part instanceof MockTextPart)).to.be.true; + expect(requestMessages[2]).to.deep.equal({ role: 'user', content: 'Please continue' }); + }); + + it('retries an empty VS Code LM response and falls back to an alternate model', async () => { + const service = new AiService(); + service.setMessages([createPlainMessage() as any]); + + const primaryModel = { + id: 'primary-model', + name: 'Primary Model', + family: 'gpt-4o', + sendRequest: sandbox.stub() + }; + const alternateModel = { + id: 'alternate-model', + name: 'Alternate Model', + family: 'gpt-4.1', + sendRequest: sandbox.stub().resolves({ result: { content: [{ text: 'Recovered response' }] } }) + }; + + primaryModel.sendRequest.onCall(0).resolves({ + stream: asyncIterable([new MockToolCallPart('lookup')]), + text: asyncIterable([]) + }); + primaryModel.sendRequest.onCall(1).resolves({ + stream: asyncIterable([new MockToolCallPart('lookup')]), + text: asyncIterable([]) + }); + + const selectModelsStub = sandbox.stub(vscode.lm, 'selectChatModels').callsFake(async (selector: any) => { + if (selector && selector.family === 'gpt-4o') { + return [primaryModel as any]; + } + + return [primaryModel as any, alternateModel as any]; + }); + + const result = await service.callVsCodeLm('Retry please', createConfig({})); + + expect(result.text).to.equal('Recovered response'); + expect(primaryModel.sendRequest.callCount).to.equal(2); + expect(alternateModel.sendRequest.calledOnce).to.be.true; + expect(selectModelsStub.firstCall.args[0]).to.deep.equal({ family: 'gpt-4o' }); + expect(selectModelsStub.secondCall.args[0]).to.deep.equal({}); + }); + + it('builds direct API payloads for supported providers', async () => { + const service = new AiService(); + const makeHttpRequestStub = sandbox.stub(service as any, '_makeHttpRequest').resolves({ text: 'ok', usage: '1 token' }); + const getAiApiKeyStub = sandbox.stub(); + const secretService = { getAiApiKey: getAiApiKeyStub } as any; + sandbox.stub(SecretStorageService, 'getInstance').returns(secretService); + + const getSessionStub = (vscode as any).authentication.getSession as sinon.SinonStub; + const imageMessage = createImageMessage(); + + const cases = [ + { + provider: 'openai', + secretBehavior: () => getAiApiKeyStub.rejects(new Error('missing secret')), + config: createConfig({ aiApiKey: 'config-key' }), + messages: [imageMessage], + expectedEndpoint: 'https://api.openai.com/v1/chat/completions', + assert: (headers: any, body: any) => { + expect(headers.Authorization).to.equal('Bearer config-key'); + expect(body.model).to.equal('gpt-4o'); + expect(body.messages[1].role).to.equal('user'); + expect(Array.isArray(body.messages[1].content)).to.be.true; + expect(body.messages[1].content.some((part: any) => part.type === 'image_url')).to.be.true; + } + }, + { + provider: 'anthropic', + secretBehavior: () => getAiApiKeyStub.resolves('secret-key'), + config: createConfig({}), + messages: [imageMessage], + expectedEndpoint: 'https://api.anthropic.com/v1/messages', + assert: (headers: any, body: any) => { + expect(headers['x-api-key']).to.equal('secret-key'); + expect(headers.Authorization).to.be.undefined; + expect(body.model).to.equal('claude-3-5-sonnet-20241022'); + expect(body.system).to.contain('PostgreSQL database assistant'); + expect(Array.isArray(body.messages[0].content)).to.be.true; + expect(body.messages[0].content.some((part: any) => part.type === 'image')).to.be.true; + } + }, + { + provider: 'gemini', + secretBehavior: () => getAiApiKeyStub.resolves('secret-key'), + config: createConfig({}), + messages: [imageMessage], + expectedEndpoint: 'https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash:generateContent', + assert: (headers: any, body: any) => { + expect(headers['X-goog-api-key']).to.equal('secret-key'); + expect(body.contents[0].role).to.equal('user'); + expect(Array.isArray(body.contents[0].parts)).to.be.true; + expect(body.contents[0].parts.some((part: any) => part.inline_data)).to.be.true; + } + }, + { + provider: 'github', + secretBehavior: () => getAiApiKeyStub.rejects(new Error('missing secret')), + authSession: { accessToken: 'gh-token' }, + config: createConfig({}), + messages: [createPlainMessage()], + expectedEndpoint: 'https://models.github.ai/inference/chat/completions', + assert: (headers: any, body: any) => { + expect(headers.Accept).to.equal('application/vnd.github+json'); + expect(headers.Authorization).to.equal('Bearer gh-token'); + expect(headers['X-GitHub-Api-Version']).to.equal('2026-03-10'); + expect(body.model).to.equal('openai/gpt-4.1'); + } + } + ]; + + for (const testCase of cases) { + getAiApiKeyStub.resetBehavior(); + getAiApiKeyStub.resetHistory(); + getSessionStub.resetHistory(); + getSessionStub.resolves(testCase.authSession); + testCase.secretBehavior(); + service.setMessages(testCase.messages as any); + + const result = await service.callDirectApi(testCase.provider, 'Current prompt', testCase.config); + expect(result.text).to.equal('ok'); + + const [endpoint, headers, body, provider] = makeHttpRequestStub.lastCall.args; + expect(endpoint).to.equal(testCase.expectedEndpoint); + expect(provider).to.equal(testCase.provider); + testCase.assert(headers, body); + + if (testCase.provider === 'github') { + expect(getSessionStub.calledOnceWithExactly('github', [], { silent: true, clearSessionPreference: false })).to.be.true; + } + } + }); + + it('builds direct API payloads for text-only providers without an API key', async () => { + const service = new AiService(); + const makeHttpRequestStub = sandbox.stub(service as any, '_makeHttpRequest').resolves({ text: 'ok', usage: undefined }); + const getAiApiKeyStub = sandbox.stub().rejects(new Error('missing secret')); + sandbox.stub(SecretStorageService, 'getInstance').returns({ getAiApiKey: getAiApiKeyStub } as any); + + service.setMessages([createPlainMessage() as any]); + + const cases = [ + { + provider: 'custom', + config: createConfig({ aiEndpoint: 'https://custom.example/v1/chat/completions' }), + expectedEndpoint: 'https://custom.example/v1/chat/completions', + expectedModel: 'gpt-3.5-turbo' + }, + { + provider: 'ollama', + config: createConfig({}), + expectedEndpoint: 'http://localhost:11434/v1/chat/completions', + expectedModel: '' + }, + { + provider: 'lmstudio', + config: createConfig({}), + expectedEndpoint: 'http://localhost:1234/v1/chat/completions', + expectedModel: '' + } + ]; + + for (const testCase of cases) { + const result = await service.callDirectApi(testCase.provider, 'Current prompt', testCase.config); + expect(result.text).to.equal('ok'); + + const [endpoint, headers, body, provider] = makeHttpRequestStub.lastCall.args; + expect(endpoint).to.equal(testCase.expectedEndpoint); + expect(provider).to.equal(testCase.provider); + expect(headers.Authorization).to.be.undefined; + expect(body.model).to.equal(testCase.expectedModel); + expect(body.messages[0].role).to.equal('system'); + expect(body.messages[body.messages.length - 1]).to.deep.equal({ role: 'user', content: 'Current prompt' }); + } + }); + + it('falls back to the configured API key when secret storage lookup fails', async () => { + const service = new AiService(); + const makeHttpRequestStub = sandbox.stub(service as any, '_makeHttpRequest').resolves({ text: 'ok', usage: undefined }); + sandbox.stub(SecretStorageService, 'getInstance').returns({ + getAiApiKey: sandbox.stub().rejects(new Error('secret unavailable')) + } as any); + + await service.callDirectApi('openai', 'Current prompt', createConfig({ aiApiKey: 'config-key' })); + + const [, headers] = makeHttpRequestStub.lastCall.args; + expect(headers.Authorization).to.equal('Bearer config-key'); + }); +}); \ No newline at end of file diff --git a/src/test/unit/ChatViewProvider.test.ts b/src/test/unit/ChatViewProvider.test.ts new file mode 100644 index 0000000..ac62188 --- /dev/null +++ b/src/test/unit/ChatViewProvider.test.ts @@ -0,0 +1,405 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as fs from 'fs'; +import * as vscode from 'vscode'; + +import { ChatViewProvider } from '../../providers/ChatViewProvider'; +import { ErrorService } from '../../services/ErrorService'; +import { QueryAnalyzer } from '../../services/QueryAnalyzer'; + +function createExtensionContext(): vscode.ExtensionContext { + return { + subscriptions: [], + extensionUri: vscode.Uri.file('/ext'), + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: () => undefined, + update: async () => undefined + } as any, + globalState: { + get: () => [], + update: async () => undefined + } as any, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +function createProviderHarness(sandbox: sinon.SinonSandbox) { + const provider = new ChatViewProvider(vscode.Uri.file('/ext'), createExtensionContext()); + + const postMessage = sandbox.stub().resolves(true); + (provider as any)._view = { show: sandbox.stub(), webview: { postMessage } }; + + const aiService = { + getModelInfo: sandbox.stub().resolves('Mock AI'), + callVsCodeLm: sandbox.stub().resolves({ text: 'SELECT 1;', usage: 'usage' }), + callDirectApi: sandbox.stub(), + setMessages: sandbox.stub(), + generateTitle: sandbox.stub().resolves('Generated title'), + cancel: sandbox.stub() + }; + + const sessionService = { + saveSession: sandbox.stub().resolves(), + clearCurrentSession: sandbox.stub(), + getSessionSummaries: sandbox.stub().returns([]), + loadSession: sandbox.stub(), + deleteSession: sandbox.stub().resolves(false) + }; + + (provider as any)._aiService = aiService; + (provider as any)._sessionService = sessionService; + + return { provider, postMessage, aiService, sessionService }; +} + +function createWebviewViewHarness(sandbox: sinon.SinonSandbox) { + let messageHandler: ((message: any) => any) | undefined; + + const postMessage = sandbox.stub().resolves(true); + const view = { + webview: { + options: {}, + html: '', + cspSource: 'vscode-webview://test', + asWebviewUri: sandbox.stub().callsFake((uri: vscode.Uri) => uri), + postMessage, + onDidReceiveMessage: sandbox.stub().callsFake((handler: (message: any) => any) => { + messageHandler = handler; + return { dispose: () => undefined }; + }) + }, + show: sandbox.stub(), + reveal: sandbox.stub() + } as any; + + return { + view, + postMessage, + getMessageHandler: () => messageHandler + }; +} + +describe('ChatViewProvider', () => { + let sandbox: sinon.SinonSandbox; + let setStatusBarMessageStub: sinon.SinonStub; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + sandbox.stub(vscode.workspace, 'getConfiguration').callsFake((section?: string) => { + if (section === 'postgresExplorer') { + return { + get: (key: string) => { + if (key === 'aiProvider') return 'vscode-lm'; + if (key === 'aiModel') return ''; + return undefined; + } + } as any; + } + return { + get: () => undefined + } as any; + }); + + setStatusBarMessageStub = sandbox.stub(); + (vscode.window as any).setStatusBarMessage = setStatusBarMessageStub; + }); + + afterEach(() => { + sandbox.restore(); + delete (vscode.window as any).setStatusBarMessage; + }); + + it('drives the AI message pipeline for fix query requests', async () => { + const { provider, postMessage, aiService, sessionService } = createProviderHarness(sandbox); + + await provider.handleFixQuery('syntax error at or near FROM', 'SELECT * FROM users'); + + expect((provider as any)._messages).to.have.lengthOf(2); + expect((provider as any)._messages[0].role).to.equal('user'); + expect((provider as any)._messages[1].role).to.equal('assistant'); + expect((provider as any)._messages[1].content).to.equal('SELECT 1;'); + + expect(aiService.getModelInfo.calledTwice).to.be.true; + expect(aiService.callVsCodeLm.calledOnce).to.be.true; + const prompt = aiService.callVsCodeLm.firstCall.args[0] as string; + expect(prompt).to.contain('Fix this SQL query which caused an error'); + expect(prompt).to.contain('SELECT * FROM users'); + expect(prompt).to.contain('syntax error at or near FROM'); + expect(aiService.setMessages.calledOnce).to.be.true; + expect(sessionService.saveSession.calledOnce).to.be.true; + expect(postMessage.callCount).to.be.greaterThan(0); + }); + + it('builds prompt strings for explain, optimize, and generate query flows', async () => { + const { provider } = createProviderHarness(sandbox); + const handleUserMessage = sandbox.stub().resolves(); + (provider as any)._handleUserMessage = handleUserMessage; + + await provider.handleExplainError('relation "users" does not exist', 'SELECT * FROM users'); + await provider.handleOptimizeQuery('SELECT * FROM users', 12.345); + await provider.handleGenerateQuery('find active users', [ + { type: 'table', schema: 'public', name: 'users', columns: ['id', 'email'] }, + { type: 'function', schema: 'public', name: 'calc_total' } + ]); + await provider.handleGenerateQuery('find active users'); + + expect(handleUserMessage.callCount).to.equal(4); + expect(handleUserMessage.getCall(0).args[0]).to.contain('I ran this SQL query:'); + expect(handleUserMessage.getCall(0).args[0]).to.contain('relation "users" does not exist'); + expect(handleUserMessage.getCall(1).args[0]).to.contain('I want to optimize this SQL query:'); + expect(handleUserMessage.getCall(1).args[0]).to.contain('12.345ms'); + expect(handleUserMessage.getCall(2).args[0]).to.contain('Please generate a SQL query for the following request'); + expect(handleUserMessage.getCall(2).args[0]).to.contain('TABLE: public.users'); + expect(handleUserMessage.getCall(2).args[0]).to.contain('FUNCTION: public.calc_total'); + expect(handleUserMessage.getCall(3).args[0]).to.contain('No specific schema context provided'); + }); + + it('builds analysis prompts and falls back when temp file creation fails', async () => { + const { provider } = createProviderHarness(sandbox); + const handleUserMessage = sandbox.stub().resolves(); + (provider as any)._handleUserMessage = handleUserMessage; + + const writeFileStub = sandbox.stub(fs.promises, 'writeFile').resolves(); + await provider.handleAnalyzeData('id,name\n1,Alice', 'SELECT * FROM users', 2); + + expect(handleUserMessage.calledOnce).to.be.true; + expect(handleUserMessage.firstCall.args[0]).to.contain('It returned 2 rows. I have attached the data as a CSV file.'); + expect(handleUserMessage.firstCall.args[1]).to.have.lengthOf(1); + expect(handleUserMessage.firstCall.args[1][0]).to.include({ type: 'csv', content: 'id,name\n1,Alice' }); + + handleUserMessage.resetHistory(); + writeFileStub.rejects(new Error('disk full')); + const showError = sandbox.stub(); + sandbox.stub(ErrorService, 'getInstance').returns({ showError } as any); + + await provider.handleAnalyzeData('id,name\n1,Alice', 'SELECT * FROM users', 2); + + expect(showError.calledOnce).to.be.true; + expect(handleUserMessage.calledOnce).to.be.true; + expect(handleUserMessage.firstCall.args[0]).to.contain('Here is the data:'); + expect(handleUserMessage.firstCall.args[1]).to.be.undefined; + }); + + it('builds explain result and why slow prompts from execution context', async () => { + const { provider } = createProviderHarness(sandbox); + const handleUserMessage = sandbox.stub().resolves(); + (provider as any)._handleUserMessage = handleUserMessage; + + const metrics = { + totalCost: 123.45, + planningTime: 1.23, + executionTime: 4.56, + sequentialScans: 2, + indexScans: 1, + bufferStats: { hitRatio: 98.1 }, + bottlenecks: ['Seq Scan on users'], + recommendations: ['Add an index on users.id'] + }; + sandbox.stub(QueryAnalyzer, 'getInstance').returns({ + extractPlanMetrics: sandbox.stub().returns(metrics) + } as any); + + const explainPlan = { Plan: { 'Node Type': 'Seq Scan', 'Plan Rows': 10 } }; + await provider.handleExplainResult('SELECT * FROM users', 5.5, 10, explainPlan); + await provider.handleWhySlow( + 'SELECT * FROM users', + 20, + 5, + explainPlan, + [{ table: 'users', rows: 100, deadRows: 5, lastVacuum: '2026-01-01' }] + ); + + expect(handleUserMessage.callCount).to.equal(2); + expect(handleUserMessage.getCall(0).args[0]).to.contain('Performance Metrics:'); + expect(handleUserMessage.getCall(0).args[0]).to.contain('Buffer Hit Ratio: 98.1%'); + expect(handleUserMessage.getCall(0).args[0]).to.contain('Execution Plan (JSON)'); + expect(handleUserMessage.getCall(1).args[0]).to.contain('Historical Average: 5.000ms'); + expect(handleUserMessage.getCall(1).args[0]).to.contain('Affected Table Statistics:'); + expect(handleUserMessage.getCall(1).args[0]).to.contain('users: 100 rows, 5 dead rows, last vacuum 2026-01-01'); + }); + + it('resolves the webview and routes control messages to the expected handlers', async () => { + const { provider, postMessage, aiService, sessionService } = createProviderHarness(sandbox); + const { view, getMessageHandler } = createWebviewViewHarness(sandbox); + const executeCommandStub = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + const showInformationMessageStub = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + const saveCurrentSessionStub = sandbox.stub(provider as any, '_saveCurrentSession').resolves(); + const handleSearchDbObjectsStub = sandbox.stub(provider as any, '_handleSearchDbObjects').resolves(); + const handleGetDbObjectDetailsStub = sandbox.stub(provider as any, '_handleGetDbObjectDetails').resolves(); + const handleGetAllDbObjectsStub = sandbox.stub(provider as any, '_handleGetAllDbObjects').resolves(); + const handleGetDbHierarchyStub = sandbox.stub(provider as any, '_handleGetDbHierarchy').resolves(); + const loadSessionStub = sandbox.stub(provider as any, '_loadSession').resolves(); + const deleteSessionStub = sandbox.stub(provider as any, '_deleteSession').resolves(); + const handleExplainErrorStub = sandbox.stub(provider as any, 'handleExplainError').resolves(); + const handleFixQueryStub = sandbox.stub(provider as any, 'handleFixQuery').resolves(); + const handleAnalyzeDataStub = sandbox.stub(provider as any, 'handleAnalyzeData').resolves(); + const handleOptimizeQueryStub = sandbox.stub(provider as any, 'handleOptimizeQuery').resolves(); + const handleOpenInNotebookStub = sandbox.stub(provider as any, '_handleOpenInNotebook').resolves(); + const handlePreviewFileStub = sandbox.stub(provider as any, '_handlePreviewFile').resolves(); + const handleFilePickStub = sandbox.stub(provider as any, '_handleFilePick').resolves(); + + await provider.resolveWebviewView(view, {} as any, {} as any); + + expect(view.webview.options).to.deep.equal({ + enableScripts: true, + localResourceRoots: [vscode.Uri.file('/ext')] + }); + expect(view.webview.html).to.be.a('string'); + + const messageHandler = getMessageHandler(); + expect(messageHandler).to.be.a('function'); + + (provider as any)._messages = [{ role: 'user', content: 'hello' }]; + + await messageHandler!({ type: 'clearChat' }); + + (provider as any)._messages = [{ role: 'user', content: 'again' }]; + await messageHandler!({ type: 'newChat' }); + + await messageHandler!({ type: 'cancelRequest' }); + + await messageHandler!({ type: 'getHistory' }); + + await messageHandler!({ type: 'searchDbObjects', query: 'users' }); + expect(handleSearchDbObjectsStub.calledOnceWithExactly('users')).to.be.true; + + await messageHandler!({ + type: 'getDbObjectDetails', + object: { + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users' + } + }); + expect(handleGetDbObjectDetailsStub.calledOnce).to.be.true; + + await messageHandler!({ type: 'getDbObjects' }); + expect(handleGetAllDbObjectsStub.calledOnce).to.be.true; + + await messageHandler!({ type: 'getDbHierarchy', path: { connectionId: 'conn1' } }); + expect(handleGetDbHierarchyStub.calledOnceWithExactly({ connectionId: 'conn1' })).to.be.true; + + await messageHandler!({ type: 'openAiSettings' }); + expect(executeCommandStub.calledOnceWithExactly('postgres-explorer.aiSettings')).to.be.true; + + await messageHandler!({ type: 'openInNotebook', code: 'SELECT 1;' }); + expect(handleOpenInNotebookStub.calledOnceWithExactly('SELECT 1;')).to.be.true; + + await messageHandler!({ type: 'previewFile', path: '/tmp/test.sql', name: 'test.sql' }); + expect(handlePreviewFileStub.calledOnceWithExactly('/tmp/test.sql', 'test.sql')).to.be.true; + + await messageHandler!({ type: 'pickFile' }); + expect(handleFilePickStub.calledOnce).to.be.true; + + await messageHandler!({ type: 'loadSession', sessionId: 'session_1' }); + expect(loadSessionStub.calledOnceWithExactly('session_1')).to.be.true; + + await messageHandler!({ type: 'deleteSession', sessionId: 'session_2' }); + expect(deleteSessionStub.calledOnceWithExactly('session_2')).to.be.true; + + await messageHandler!({ type: 'explainError', error: 'bad syntax', query: 'SELECT' }); + expect(handleExplainErrorStub.calledOnceWithExactly('bad syntax', 'SELECT')).to.be.true; + + await messageHandler!({ type: 'fixQuery', error: 'bad syntax', query: 'SELECT' }); + expect(handleFixQueryStub.calledOnceWithExactly('bad syntax', 'SELECT')).to.be.true; + + await messageHandler!({ type: 'analyzeData', data: 'a,b\n1,2', query: 'SELECT', rowCount: 1 }); + expect(handleAnalyzeDataStub.calledOnceWithExactly('a,b\n1,2', 'SELECT', 1)).to.be.true; + + await messageHandler!({ type: 'optimizeQuery', query: 'SELECT 1', executionTime: 12.3 }); + expect(handleOptimizeQueryStub.calledOnceWithExactly('SELECT 1', 12.3)).to.be.true; + + expect(saveCurrentSessionStub.calledOnce).to.be.true; + expect(aiService.cancel.calledOnce).to.be.true; + expect(showInformationMessageStub.calledWith('AI request cancelled.')).to.be.true; + + void postMessage; + }); + + it('attaches database objects and query files to the chat view', async () => { + const { provider, postMessage } = createProviderHarness(sandbox); + const showStub = (provider as any)._view.show as sinon.SinonStub; + const getObjectSchemaStub = sandbox.stub((provider as any)._dbObjectService, 'getObjectSchema').resolves('CREATE TABLE public.users (id integer);'); + const writeFileStub = sandbox.stub(fs.promises, 'writeFile').resolves(); + const showInformationMessageStub = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + const clock = sandbox.useFakeTimers(); + + const attachPromise = provider.attachDbObject({ + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users' + }); + await clock.tickAsync(200); + await attachPromise; + + expect(showStub.calledOnceWithExactly(true)).to.be.true; + expect(getObjectSchemaStub.calledOnce).to.be.true; + expect(postMessage.calledWithMatch({ + type: 'addMentionFromTree', + object: { + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users', + details: 'CREATE TABLE public.users (id integer);' + } + })).to.be.true; + + const csvSendPromise = provider.sendToChat({ + query: 'SELECT id FROM users', + results: JSON.stringify({ columns: ['id'], rows: [{ id: 1 }] }), + message: 'Send query' + }); + await clock.tickAsync(300); + await csvSendPromise; + + expect(writeFileStub.called).to.be.true; + expect(postMessage.calledWithMatch({ + type: 'fileAttached', + file: { + type: 'sql', + content: 'SELECT id FROM users' + } + })).to.be.true; + expect(postMessage.calledWithMatch({ + type: 'fileAttached', + file: { + type: 'csv', + content: '"id"\n1\n' + } + })).to.be.true; + expect(showInformationMessageStub.calledOnce).to.be.true; + + const fallbackSendPromise = provider.sendToChat({ + query: 'SELECT id FROM users', + results: '{not valid json', + message: 'Send query' + }); + await clock.tickAsync(300); + await fallbackSendPromise; + + expect(postMessage.calledWithMatch({ + type: 'fileAttached', + file: { + type: 'json', + content: '{not valid json' + } + })).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/CloseEventCleanup.test.ts b/src/test/unit/CloseEventCleanup.test.ts new file mode 100644 index 0000000..ac483eb --- /dev/null +++ b/src/test/unit/CloseEventCleanup.test.ts @@ -0,0 +1,106 @@ +/** + * Unit tests for onDidCloseNotebookDocument cleanup logic. + * Task 4.1 — Requirements: 6.1, 6.2, 6.3 + */ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { SessionRegistry } from '../../services/SessionRegistry'; + +function makeNotebookDoc(uri: vscode.Uri, isClosed = false): vscode.NotebookDocument { + const doc = new (vscode.NotebookDocument as any)(uri) as any; + doc.cellCount = 0; + doc.isClosed = isClosed; + return doc as vscode.NotebookDocument; +} + +/** + * Simulate the close listener logic extracted from extension.ts activate(). + * This mirrors the exact implementation so we can unit-test it in isolation. + */ +function makeCloseListener() { + return (closedDoc: vscode.NotebookDocument) => { + const closedUri = closedDoc.uri.toString(); + for (const [connectionId, doc] of SessionRegistry.entries()) { + if (doc.uri.toString() === closedUri) { + SessionRegistry.delete(connectionId); + break; + } + } + }; +} + +describe('onDidCloseNotebookDocument cleanup (Req 6.1, 6.2, 6.3)', () => { + beforeEach(() => { + (SessionRegistry as any).map?.clear?.(); + }); + + afterEach(() => { + (SessionRegistry as any).map?.clear?.(); + }); + + it('removes the matching connectionId entry when a scratch URI is closed (Req 6.1)', () => { + const scratchUri = vscode.Uri.file('/global-storage/scratch-conn-abc.pgsql'); + const doc = makeNotebookDoc(scratchUri); + SessionRegistry.set('conn-abc', doc); + + const listener = makeCloseListener(); + listener(doc); + + expect(SessionRegistry.has('conn-abc')).to.be.false; + }); + + it('does not affect other registry entries when an unrelated URI is closed (Req 6.1)', () => { + const scratchUri1 = vscode.Uri.file('/global-storage/scratch-conn-1.pgsql'); + const scratchUri2 = vscode.Uri.file('/global-storage/scratch-conn-2.pgsql'); + const doc1 = makeNotebookDoc(scratchUri1); + const doc2 = makeNotebookDoc(scratchUri2); + SessionRegistry.set('conn-1', doc1); + SessionRegistry.set('conn-2', doc2); + + const unrelatedDoc = makeNotebookDoc(vscode.Uri.file('/some/other/notebook.pgsql')); + const listener = makeCloseListener(); + listener(unrelatedDoc); + + // Both entries should remain + expect(SessionRegistry.has('conn-1')).to.be.true; + expect(SessionRegistry.has('conn-2')).to.be.true; + }); + + it('only removes the matching entry and leaves others intact (Req 6.1)', () => { + const scratchUri1 = vscode.Uri.file('/global-storage/scratch-conn-1.pgsql'); + const scratchUri2 = vscode.Uri.file('/global-storage/scratch-conn-2.pgsql'); + const doc1 = makeNotebookDoc(scratchUri1); + const doc2 = makeNotebookDoc(scratchUri2); + SessionRegistry.set('conn-1', doc1); + SessionRegistry.set('conn-2', doc2); + + const listener = makeCloseListener(); + listener(doc1); + + expect(SessionRegistry.has('conn-1')).to.be.false; + expect(SessionRegistry.has('conn-2')).to.be.true; + expect(SessionRegistry.get('conn-2')).to.equal(doc2); + }); + + it('is a no-op when the registry is empty (Req 6.1)', () => { + const doc = makeNotebookDoc(vscode.Uri.file('/global-storage/scratch-conn-x.pgsql')); + const listener = makeCloseListener(); + // Should not throw + expect(() => listener(doc)).to.not.throw(); + }); + + it('is a no-op when the closed URI does not match any registry entry (Req 6.1)', () => { + const scratchUri = vscode.Uri.file('/global-storage/scratch-conn-abc.pgsql'); + const doc = makeNotebookDoc(scratchUri); + SessionRegistry.set('conn-abc', doc); + + const nonMatchingDoc = makeNotebookDoc(vscode.Uri.file('/global-storage/scratch-conn-xyz.pgsql')); + const listener = makeCloseListener(); + listener(nonMatchingDoc); + + // Original entry should still be present + expect(SessionRegistry.has('conn-abc')).to.be.true; + }); +}); diff --git a/src/test/unit/ColumnCommands.test.ts b/src/test/unit/ColumnCommands.test.ts new file mode 100644 index 0000000..e75f180 --- /dev/null +++ b/src/test/unit/ColumnCommands.test.ts @@ -0,0 +1,156 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import * as helper from '../../commands/helper'; +import * as columnCommands from '../../commands/columns'; +import { QueryBuilder } from '../../commands/helper'; +import { ColumnSQL } from '../../commands/sql/columns'; +import { DatabaseTreeItem } from '../../providers/DatabaseTreeProvider'; + +function createBuilderStub(sandbox: sinon.SinonSandbox) { + const builder: any = {}; + builder.addMarkdown = sandbox.stub().returns(builder); + builder.addSql = sandbox.stub().returns(builder); + builder.show = sandbox.stub().resolves(); + sandbox.stub(helper as any, 'NotebookBuilder').callsFake(function () { + return builder; + }); + return builder; +} + +function createDbConnection() { + const release = sinon.stub(); + const query = sinon.stub(); + return { + client: { query }, + metadata: { + connectionId: 'c1', + databaseName: 'appdb', + name: 'Primary', + host: 'localhost', + port: 5432, + username: 'postgres' + }, + release, + query + }; +} + +describe('column commands', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + function createItem(): DatabaseTreeItem { + return { + label: 'customer_name', + schema: 'public', + tableName: 'customers', + columnName: 'customer_name', + connectionId: 'c1', + databaseName: 'appdb' + } as any; + } + + it('shows column properties and reports missing columns', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + dbConnection.query.onCall(0).resolves({ + rows: [ + { + column_name: 'customer_name', + data_type: 'character varying', + character_maximum_length: 50, + numeric_precision: null, + numeric_scale: null, + udt_name: 'varchar', + ordinal_position: 2, + is_nullable: 'NO', + column_default: "''", + is_primary_key: true, + is_foreign_key: true, + foreign_table_schema: 'public', + foreign_table_name: 'users', + foreign_column_name: 'id', + is_unique: true, + column_comment: 'Customer display name' + } + ] + }); + dbConnection.query.onCall(1).resolves({ rows: [] }); + + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const errorStub = sandbox.stub(vscode.window, 'showErrorMessage').resolves(undefined); + + const item = createItem(); + await columnCommands.showColumnProperties(item); + await columnCommands.showColumnProperties(item); + + expect(dbConnection.query.firstCall.args[0]).to.equal(QueryBuilder.columnDetails('public', 'customers', 'customer_name')); + expect(builder.addMarkdown.callCount).to.be.greaterThan(1); + expect(builder.addSql.calledOnce).to.be.true; + expect(builder.show.calledOnce).to.be.true; + expect(errorStub.calledOnceWithExactly('Column not found')).to.be.true; + expect(dbConnection.release.callCount).to.equal(2); + }); + + it('copies names and builds select, where, alter, and drop notebooks', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const clipboardStub = sandbox.stub(vscode.env.clipboard, 'writeText').resolves(); + const infoStub = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + + const item = createItem(); + await columnCommands.copyColumnName(item); + await columnCommands.copyColumnNameQuoted(item); + await columnCommands.generateSelectStatement(item); + await columnCommands.generateWhereClause(item); + await columnCommands.generateAlterColumnScript(item); + await columnCommands.generateDropColumnScript(item); + + expect(clipboardStub.firstCall.args[0]).to.equal('customer_name'); + expect(clipboardStub.secondCall.args[0]).to.equal('"customer_name"'); + expect(infoStub.calledTwice).to.be.true; + expect(builder.show.callCount).to.equal(4); + expect(builder.addSql.firstCall.args[0]).to.equal(ColumnSQL.select('public', 'customers', 'customer_name')); + expect(builder.addSql.getCall(1).args[0]).to.contain('WHERE customer_name ='); + expect(builder.addSql.getCall(2).args[0]).to.equal(ColumnSQL.alter('public', 'customers', 'customer_name')); + expect(builder.addSql.getCall(3).args[0]).to.equal(ColumnSQL.drop('public', 'customers', 'customer_name')); + expect(dbConnection.release.callCount).to.equal(4); + }); + + it('builds rename, comment, index, statistics, and add-column notebooks', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const inputStub = sandbox.stub(vscode.window, 'showInputBox'); + inputStub.onCall(0).resolves('renamed_customer_name'); + inputStub.onCall(1).resolves('customer_name'); + inputStub.onCall(2).resolves('Customer display name'); + inputStub.onCall(3).resolves('idx_customers_customer_name'); + + const item = createItem(); + await columnCommands.generateRenameColumnScript(item); + await columnCommands.generateRenameColumnScript(item); + await columnCommands.addColumnComment(item); + await columnCommands.generateIndexOnColumn(item); + await columnCommands.viewColumnStatistics(item); + await columnCommands.cmdAddColumn(item); + + expect(builder.show.callCount).to.equal(5); + expect(builder.addSql.firstCall.args[0]).to.equal(ColumnSQL.rename('public', 'customers', 'customer_name', 'renamed_customer_name')); + expect(builder.addSql.getCall(1).args[0]).to.contain('COMMENT ON COLUMN public.customers.customer_name IS'); + expect(builder.addSql.getCall(2).args[0]).to.equal(ColumnSQL.createIndex('public', 'customers', 'customer_name', 'idx_customers_customer_name')); + expect(builder.addSql.getCall(3).args[0]).to.contain('FROM pg_stats'); + expect(builder.addSql.getCall(4).args[0]).to.contain('ALTER TABLE public.customers'); + expect(dbConnection.release.callCount).to.equal(6); + }); +}); \ No newline at end of file diff --git a/src/test/unit/CommandHelper.test.ts b/src/test/unit/CommandHelper.test.ts new file mode 100644 index 0000000..3ab9966 --- /dev/null +++ b/src/test/unit/CommandHelper.test.ts @@ -0,0 +1,147 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import * as connectionModule from '../../commands/connection'; +import { + ErrorHandlers, + FormatHelpers, + MarkdownUtils, + NotebookBuilder, + ObjectUtils, + StringUtils, + ValidationHelpers, + getDatabaseConnection, + validateCategoryItem, + validateItem, + validateRoleItem, +} from '../../commands/helper'; +import { ConnectionManager } from '../../services/ConnectionManager'; +import { ErrorService } from '../../services/ErrorService'; +import { DatabaseTreeItem } from '../../providers/DatabaseTreeProvider'; + +describe('CommandHelper utilities', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('validates tree item helpers', () => { + expect(() => validateItem({} as any)).to.throw('Invalid selection'); + expect(() => validateCategoryItem({} as any)).to.throw('Invalid category selection'); + expect(() => validateRoleItem({} as any)).to.throw('Invalid role selection'); + + expect(() => validateItem({ connectionId: 'c1', schema: 'public' } as any)).not.to.throw(); + expect(() => validateCategoryItem({ connectionId: 'c1' } as any)).not.to.throw(); + expect(() => validateRoleItem({ connectionId: 'c1' } as any)).not.to.throw(); + }); + + it('covers markdown, formatting, validation, and string helpers', () => { + expect(MarkdownUtils.operationsTable([ + { operation: 'Drop', description: 'Remove a table', riskLevel: 'High' }, + ])).to.contain('Risk Level'); + expect(MarkdownUtils.operationsTable([ + { operation: 'Select', description: 'Read rows' }, + ])).to.not.contain('Risk Level'); + expect(MarkdownUtils.propertiesTable({ Owner: 'alice', Size: '1 MB' })).to.contain('Owner'); + expect(MarkdownUtils.header('Title', 'Subtitle')).to.contain('### Title'); + + expect(ObjectUtils.getKindLabel('r')).to.equal('📊 Table'); + expect(ObjectUtils.getKindLabel('unknown')).to.equal('unknown'); + expect(ObjectUtils.getConstraintIcon('PRIMARY KEY')).to.equal('🔑'); + expect(ObjectUtils.getConstraintIcon('NOTHING')).to.equal('📌'); + expect(ObjectUtils.getIndexIcon(true, false)).to.equal('🔑'); + expect(ObjectUtils.getIndexIcon(false, true)).to.equal('⭐'); + expect(ObjectUtils.getIndexIcon(false, false)).to.equal('🔍'); + + expect(FormatHelpers.formatBytes(0)).to.equal('0 Bytes'); + expect(FormatHelpers.formatBytes(1024)).to.equal('1 KB'); + expect(FormatHelpers.formatBytes(1024 * 1024)).to.equal('1 MB'); + expect(FormatHelpers.formatBoolean(true)).to.contain('Yes'); + expect(FormatHelpers.formatBoolean(false)).to.contain('No'); + expect(FormatHelpers.escapeSqlString("O'Reilly")).to.equal("O''Reilly"); + expect(FormatHelpers.formatArray([])).to.equal('—'); + expect(FormatHelpers.formatArray(['a', 'b'])).to.equal('a, b'); + expect(FormatHelpers.formatNumber(12345)).to.equal('12,345'); + expect(FormatHelpers.formatPercentage(42)).to.equal('42%'); + + expect(ValidationHelpers.validateColumnName('column_name')).to.equal(null); + expect(ValidationHelpers.validateColumnName('')).to.equal('Column name cannot be empty'); + expect(ValidationHelpers.validateColumnName('123bad')).to.contain('Invalid column name'); + expect(ValidationHelpers.validateIdentifier('table_name', 'table')).to.equal(null); + expect(ValidationHelpers.validateIdentifier('', 'table')).to.equal('table name cannot be empty'); + expect(ValidationHelpers.validateIdentifier('bad-name', 'table')).to.contain('Invalid table name'); + + expect(StringUtils.cleanMarkdownCodeBlocks('```sql\nSELECT 1;\n```')).to.equal('SELECT 1;'); + expect(StringUtils.cleanMarkdownCodeBlocks('```\nSELECT 2;\n```')).to.equal('SELECT 2;'); + expect(StringUtils.truncate('short', 10)).to.equal('short'); + expect(StringUtils.truncate('this is definitely long', 10)).to.equal('this is...'); + }); + + it('covers NotebookBuilder cell collection helpers', () => { + const builder = new NotebookBuilder({ connectionId: 'c1', databaseName: 'db1' }); + builder.addMarkdown('hello').addSql('SELECT 1'); + + expect((builder as any).cells).to.have.lengthOf(2); + expect((builder as any).cells[0].language).to.equal('markdown'); + expect((builder as any).cells[1].language).to.equal('sql'); + }); + + it('gets database connection and releases the pooled client', async () => { + const item = new DatabaseTreeItem('users', vscode.TreeItemCollapsibleState.Collapsed, 'table', 'conn-1', 'db1', 'public'); + const connection = { + id: 'conn-1', + name: 'Primary', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'db1', + }; + const client = { release: sandbox.stub() }; + const pooledClient = sandbox.stub().resolves(client); + + sandbox.stub(connectionModule, 'getConnectionWithPassword').resolves(connection as any); + sandbox.stub(ConnectionManager, 'getInstance').returns({ getPooledClient: pooledClient } as any); + + const result = await getDatabaseConnection(item); + + expect(connectionModule.getConnectionWithPassword.calledOnceWithExactly('conn-1', 'db1')).to.be.true; + expect(pooledClient.calledOnce).to.be.true; + expect(result.connection).to.equal(connection); + expect(result.client).to.equal(client); + expect(result.metadata).to.include({ connectionId: 'conn-1', databaseName: 'db1', name: 'Primary' }); + + result.release(); + expect((client.release as sinon.SinonStub).calledOnce).to.be.true; + }); + + it('propagates validation failures from getDatabaseConnection', async () => { + const item = new DatabaseTreeItem('users', vscode.TreeItemCollapsibleState.Collapsed, 'table', 'conn-1', 'db1', 'public'); + + try { + await getDatabaseConnection(item, () => { + throw new Error('bad selection'); + }); + expect.fail('expected getDatabaseConnection to throw'); + } catch (err) { + expect((err as Error).message).to.equal('bad selection'); + } + }); + + it('forwards helper errors to ErrorService', async () => { + const showError = sandbox.stub().resolves(); + const handleCommandError = sandbox.stub().resolves(); + sandbox.stub(ErrorService, 'getInstance').returns({ showError, handleCommandError } as any); + + await ErrorHandlers.showError('boom', 'Retry', 'cmd.retry'); + await ErrorHandlers.handleCommandError(new Error('fail'), 'save changes'); + + expect(showError.calledOnceWithExactly('boom', 'Retry', 'cmd.retry')).to.be.true; + expect(handleCommandError.calledOnce).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/CommonHelpers.test.ts b/src/test/unit/CommonHelpers.test.ts new file mode 100644 index 0000000..4833054 --- /dev/null +++ b/src/test/unit/CommonHelpers.test.ts @@ -0,0 +1,155 @@ +import { expect } from 'chai'; + +import { + CSS_VARIABLES, + COMMON_STYLES, + HtmlBuilder, + MarkdownBuilder, + NotebookTemplates, + styleToString, +} from '../../common/htmlStyles'; +import { + createGradient, + darkenColor, + formatDate, + formatValue, + formatValueForSQL, + getNumericColumns, + getTimezoneAbbr, + hexToRgba, + isDateColumn, + rgbaToHex, +} from '../../renderer/utils/formatting'; +import { deriveNotebookTitle, parseBreadcrumbFromSql } from '../../renderer/utils/sqlParsing'; + +function expectContainsAll(text: string, fragments: string[]): void { + for (const fragment of fragments) { + expect(text).to.contain(fragment); + } +} + +describe('shared helpers', () => { + it('formats styles and markdown helpers', () => { + expect(CSS_VARIABLES.editorBackground).to.contain('vscode-editor-background'); + expect(COMMON_STYLES.buttonDanger.color).to.equal(CSS_VARIABLES.errorForeground); + + expect(styleToString({ fontSize: '12px', lineHeight: 1.5, backgroundColor: '#fff' })).to.equal( + 'font-size: 12px; line-height: 1.5; background-color: #fff' + ); + + expectContainsAll(MarkdownBuilder.infoBox('Use this query', 'Note'), ['ℹ️ Note:', 'Use this query']); + expectContainsAll(MarkdownBuilder.warningBox('Danger ahead'), ['⚠️ Warning:', 'Danger ahead']); + expectContainsAll(MarkdownBuilder.successBox('Looks good', 'Tip'), ['💡 Tip:', 'Looks good']); + expectContainsAll(MarkdownBuilder.dangerBox('Stop now'), ['🛑 Caution:', 'Stop now']); + expect(MarkdownBuilder.heading('Summary', 4, '📊')).to.equal('#### 📊 Summary'); + expect(MarkdownBuilder.divider()).to.equal('\n---\n'); + expect(MarkdownBuilder.codeBlock('SELECT 1;', 'sql')).to.equal('```sql\nSELECT 1;\n```'); + expect(MarkdownBuilder.inlineCode('value')).to.equal('`value`'); + expect(MarkdownBuilder.badge('ready', 'success')).to.contain('ready'); + expect(MarkdownBuilder.button('Run', 'runQuery()')).to.contain('onclick="runQuery()"'); + expect(MarkdownBuilder.dangerButton('Drop', 'dropQuery()')).to.contain('Drop'); + + const table = MarkdownBuilder.table(['Name', 'Value'], [['one', '1']]); + expectContainsAll(table, [' { + expect(parseBreadcrumbFromSql('SELECT * FROM public.users;')).to.deep.equal({ schema: 'public', table: 'users' }); + expect(parseBreadcrumbFromSql('SELECT * FROM "Sales"."Monthly Report";')).to.deep.equal({ schema: 'Sales', table: 'Monthly Report' }); + expect(parseBreadcrumbFromSql('SELECT * FROM users;')).to.deep.equal({}); + + expect(deriveNotebookTitle(['SELECT * FROM public.users;'])).to.equal('View public.users'); + expect(deriveNotebookTitle(['SELECT id, name, email FROM very_long_table_name_that_should_be_trimmed_to_fit the screen;'])) + .to.match(/^SELECT id, name, email FROM very_long_table_name_/); + expect(deriveNotebookTitle(['INSERT INTO public.users VALUES (1);'])).to.equal(''); + }); + + it('formats values and color helpers', () => { + expect(getNumericColumns(['amount', 'name', 'empty'], [ + { amount: '1', name: 'alpha', empty: null }, + { amount: 2, name: 'beta', empty: undefined }, + { amount: '3.5', name: 'gamma', empty: '' }, + ])).to.deep.equal(['amount']); + + expect(isDateColumn('created_at')).to.be.true; + expect(isDateColumn('value')).to.be.false; + expect(isDateColumn('value', { value: 'timestamp with time zone' })).to.be.true; + + expect(getTimezoneAbbr(new Date('2024-06-15T12:00:00.000Z'))).to.be.a('string').and.not.empty; + expect(formatDate('2024-06-15T12:00:00.000Z', 'YYYY-MM-DD HH:mm:ss SSS TZ')).to.contain('2024'); + expect(formatDate('not-a-date', 'YYYY')).to.equal('not-a-date'); + + expect(formatValueForSQL(null)).to.equal('NULL'); + expect(formatValueForSQL(42, 'integer')).to.equal('42'); + expect(formatValueForSQL(true, 'boolean')).to.equal('true'); + expect(formatValueForSQL("O'Reilly")).to.equal("'O''Reilly'"); + + expect(formatValue(null)).to.deep.equal({ text: 'NULL', isNull: true, type: 'null' }); + expect(formatValue(false)).to.deep.equal({ text: 'FALSE', isNull: false, type: 'boolean' }); + expect(formatValue(99)).to.deep.equal({ text: '99', isNull: false, type: 'number' }); + expect(formatValue(new Date('2024-06-15T12:00:00.000Z')).type).to.equal('date'); + expect(formatValue({ key: 'value' }).text).to.equal('{"key":"value"}'); + expect(formatValue('2024-06-15T12:00:00.000Z', 'timestamp').type).to.equal('timestamp'); + expect(formatValue('2024-06-15', 'date').type).to.equal('date'); + expect(formatValue('12:30:00', 'timetz').type).to.equal('time'); + + expect(rgbaToHex('rgba(255, 0, 17, 0.6)')).to.equal('#ff0011'); + expect(rgbaToHex('not rgba')).to.equal('not rgba'); + expect(hexToRgba('#112233', 0.5)).to.equal('rgba(17, 34, 51, 0.5)'); + expect(darkenColor('rgba(100, 120, 140, 0.6)')).to.equal('rgba(100, 120, 140, 0.8)'); + + let gradientArgs: any[] = []; + const gradientStops: Array<[number, string]> = []; + const gradient = { + addColorStop(position: number, color: string) { + gradientStops.push([position, color]); + } + }; + const ctx = { + createLinearGradient: (...args: any[]) => { + gradientArgs = args; + return gradient; + } + } as any; + + expect(createGradient(ctx, 1, undefined, false)).to.equal(gradient); + expect(gradientArgs).to.deep.equal([0, 0, 400, 0]); + expect(gradientStops).to.deep.equal([ + [0, 'rgba(255, 99, 132, 0.6)'], + [1, 'rgba(255, 99, 132, 0.1)'], + ]); + + const customStops: Array<[number, string]> = []; + const customCtx = { + createLinearGradient: (...args: any[]) => ({ + args, + addColorStop(position: number, color: string) { + customStops.push([position, color]); + } + }) + } as any; + createGradient(customCtx, 0, 'rgba(10, 20, 30, 0.6)', true); + expect(customStops).to.deep.equal([ + [0, 'rgba(10, 20, 30, 0.6)'], + [1, 'rgba(10, 20, 30, 0.1)'], + ]); + }); +}); \ No newline at end of file diff --git a/src/test/unit/ConnectionCommands.test.ts b/src/test/unit/ConnectionCommands.test.ts new file mode 100644 index 0000000..b191e06 --- /dev/null +++ b/src/test/unit/ConnectionCommands.test.ts @@ -0,0 +1,244 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as pg from 'pg'; +import * as vscode from 'vscode'; + +import * as pgPassUtils from '../../utils/pgPassUtils'; +import { ConnectionManager } from '../../services/ConnectionManager'; +import { SecretStorageService } from '../../services/SecretStorageService'; +import { ErrorHandlers } from '../../commands/helper'; +import { + cmdConnectDatabase, + cmdDisconnectConnection, + cmdDisconnectDatabase, + cmdReconnectConnection, + createMetadata, + getConnectionWithPassword, + revealInExplorer, + showConnectionSafety, + validateCategoryItem, + validateItem, + validateRoleItem, +} from '../../commands/connection'; +import { DatabaseTreeItem, DatabaseTreeProvider } from '../../providers/DatabaseTreeProvider'; + +describe('Connection commands', () => { + let sandbox: sinon.SinonSandbox; + let configGetStub: sinon.SinonStub; + let configUpdateStub: sinon.SinonStub; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + configGetStub = sandbox.stub().returns(undefined); + configUpdateStub = sandbox.stub().resolves(); + sandbox.stub(vscode.workspace, 'getConfiguration').callsFake(() => ({ + get: configGetStub, + update: configUpdateStub, + } as any)); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('creates metadata and validates tree items', () => { + const metadata = createMetadata({ id: 'c1', host: 'localhost', port: 5432, username: 'postgres', password: 'pw' }, 'db1'); + + expect(metadata.connectionId).to.equal('c1'); + expect(metadata.databaseName).to.equal('db1'); + expect(metadata.custom.metadata.enableScripts).to.equal(true); + + expect(() => validateItem({} as any)).to.throw('Invalid selection'); + expect(() => validateCategoryItem({} as any)).to.throw('Invalid category selection'); + expect(() => validateRoleItem({} as any)).to.throw('Invalid role selection'); + }); + + it('resolves passwords from SecretStorage and pgpass fallback', async () => { + const connection = { + id: 'conn-1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + }; + configGetStub.returns([connection]); + sandbox.stub(SecretStorageService, 'getInstance').returns({ + getPassword: sandbox.stub().resolves(undefined), + } as any); + const resolvePgPassPasswordStub = sandbox.stub(pgPassUtils, 'resolvePgPassPassword'); + resolvePgPassPasswordStub.onFirstCall().returns(undefined); + resolvePgPassPasswordStub.onSecondCall().returns('pgpass-secret'); + + const resolved = await getConnectionWithPassword('conn-1', 'appdb'); + + expect(resolved.password).to.equal('pgpass-secret'); + expect(resolvePgPassPasswordStub.calledTwice).to.be.true; + expect(resolvePgPassPasswordStub.firstCall.args).to.deep.equal(['localhost', 5432, 'appdb', 'postgres']); + expect(resolvePgPassPasswordStub.secondCall.args).to.deep.equal(['localhost', 5432, 'postgres', 'postgres']); + }); + + it('prefers inline passwords when present', async () => { + const connection = { + id: 'conn-2', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + password: 'inline-secret', + }; + configGetStub.returns([connection]); + const secret = sandbox.stub(SecretStorageService, 'getInstance').returns({ + getPassword: sandbox.stub().resolves(undefined), + } as any); + const pgPassStub = sandbox.stub(pgPassUtils, 'resolvePgPassPassword'); + + const resolved = await getConnectionWithPassword('conn-2', 'appdb'); + + expect(resolved.password).to.equal('inline-secret'); + expect(secret.calledOnce).to.be.true; + expect(pgPassStub.called).to.be.false; + }); + + it('disconnects and reconnects a connection through the tree provider', async () => { + const context = { subscriptions: [] } as any; + const provider = { + markConnectionDisconnected: sandbox.stub(), + markConnectionConnected: sandbox.stub(), + } as unknown as DatabaseTreeProvider; + const item = new DatabaseTreeItem('Primary', vscode.TreeItemCollapsibleState.Collapsed, 'connection', 'conn-1'); + const closeAll = sandbox.stub().resolves(); + sandbox.stub(ConnectionManager, 'getInstance').returns({ closeAllConnectionsById: closeAll } as any); + sandbox.stub(vscode.window, 'withProgress').callsFake(async (_options, callback) => callback({ report: sandbox.stub() } as any)); + const showInfo = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + + await cmdDisconnectConnection(item, context, provider); + await cmdReconnectConnection(item, context, provider); + + expect(closeAll.calledOnceWithExactly('conn-1')).to.be.true; + expect((provider.markConnectionDisconnected as sinon.SinonStub).calledOnceWithExactly('conn-1')).to.be.true; + expect((provider.markConnectionConnected as sinon.SinonStub).calledOnceWithExactly('conn-1')).to.be.true; + expect(showInfo.calledTwice).to.be.true; + }); + + it('reports invalid connection selections through ErrorHandlers', async () => { + const handleCommandError = sandbox.stub(ErrorHandlers, 'handleCommandError').resolves(); + const context = { subscriptions: [] } as any; + + await cmdDisconnectConnection({} as any, context); + await cmdReconnectConnection({} as any, context); + + expect(handleCommandError.calledTwice).to.be.true; + }); + + it('disconnects a database connection and updates the tree', async () => { + const context = { subscriptions: [] } as any; + configGetStub.returns([ + { id: 'conn-1', host: 'localhost', port: 5432, username: 'postgres', database: 'appdb' }, + ]); + const provider = { refresh: sandbox.stub() } as unknown as DatabaseTreeProvider; + const item = new DatabaseTreeItem('Primary', vscode.TreeItemCollapsibleState.Collapsed, 'connection', 'conn-1'); + const showWarning = sandbox.stub(vscode.window, 'showWarningMessage').resolves('Yes' as any); + const showInfo = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + const deletePassword = sandbox.stub().resolves(); + const closeConnection = sandbox.stub().resolves(); + + sandbox.stub(SecretStorageService, 'getInstance').returns({ deletePassword } as any); + sandbox.stub(ConnectionManager, 'getInstance').returns({ closeConnection } as any); + + await cmdDisconnectDatabase(item, context, provider); + + expect(showWarning.calledOnce).to.be.true; + expect(configUpdateStub.calledOnce).to.be.true; + expect(deletePassword.calledOnceWithExactly('conn-1')).to.be.true; + expect(closeConnection.calledOnce).to.be.true; + expect((provider.refresh as sinon.SinonStub).calledOnce).to.be.true; + expect(showInfo.calledOnce).to.be.true; + }); + + it('connects to a database string and closes the client', async () => { + const context = { subscriptions: [] } as any; + const provider = { refresh: sandbox.stub() } as unknown as DatabaseTreeProvider; + const inputBox = sandbox.stub(vscode.window, 'showInputBox').resolves('postgresql://user:pass@localhost:5432/appdb'); + const showInfo = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + const connect = sandbox.stub(pg.Client.prototype, 'connect').resolves(); + const end = sandbox.stub(pg.Client.prototype, 'end').resolves(); + + await cmdConnectDatabase(new DatabaseTreeItem('Primary', vscode.TreeItemCollapsibleState.Collapsed, 'connection', 'conn-1'), context, provider); + + expect(inputBox.calledOnce).to.be.true; + expect(connect.calledOnce).to.be.true; + expect(end.calledOnce).to.be.true; + expect((provider.refresh as sinon.SinonStub).calledOnce).to.be.true; + expect(showInfo.calledOnce).to.be.true; + }); + + it('skips connect when no connection string is provided', async () => { + const context = { subscriptions: [] } as any; + const provider = { refresh: sandbox.stub() } as unknown as DatabaseTreeProvider; + const inputBox = sandbox.stub(vscode.window, 'showInputBox').resolves(undefined); + const connect = sandbox.stub(pg.Client.prototype, 'connect').resolves(); + + await cmdConnectDatabase(new DatabaseTreeItem('Primary', vscode.TreeItemCollapsibleState.Collapsed, 'connection', 'conn-1'), context, provider); + + expect(inputBox.calledOnce).to.be.true; + expect(connect.called).to.be.false; + expect((provider.refresh as sinon.SinonStub).called).to.be.false; + }); + + it('shows connection safety and runs edit command when requested', async () => { + sandbox.stub(vscode.window, 'activeNotebookEditor').value({ + notebook: { + metadata: { + connectionId: 'conn-1', + databaseName: 'appdb', + }, + }, + } as any); + configGetStub.returns([ + { id: 'conn-1', name: 'Primary', host: 'localhost', port: 5432, database: 'appdb', environment: 'production', readOnlyMode: true }, + ]); + const showInfo = sandbox.stub(vscode.window, 'showInformationMessage').resolves('Edit Connection' as any); + const executeCommand = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + + await showConnectionSafety(); + + expect(showInfo.calledOnce).to.be.true; + expect(executeCommand.calledOnce).to.be.true; + }); + + it('reports when there is no active notebook for connection safety', async () => { + sandbox.stub(vscode.window, 'activeNotebookEditor').value(undefined); + const showInfo = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + + await showConnectionSafety(); + + expect(showInfo.calledOnceWithExactly('No active PostgreSQL notebook')).to.be.true; + }); + + it('reveals the current notebook connection in the explorer', async () => { + const provider = { revealItem: sandbox.stub().resolves() } as unknown as DatabaseTreeProvider; + sandbox.stub(vscode.window, 'activeNotebookEditor').value({ + notebook: { + metadata: { + connectionId: 'conn-1', + databaseName: 'appdb', + }, + }, + } as any); + + await revealInExplorer(provider); + + expect((provider.revealItem as sinon.SinonStub).calledOnceWithExactly('conn-1', 'appdb')).to.be.true; + }); + + it('reports when there is no active notebook to reveal', async () => { + const provider = { revealItem: sandbox.stub().resolves() } as unknown as DatabaseTreeProvider; + sandbox.stub(vscode.window, 'activeNotebookEditor').value(undefined); + const showInfo = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + + await revealInExplorer(provider); + + expect(showInfo.calledOnceWithExactly('No active PostgreSQL notebook')).to.be.true; + expect((provider.revealItem as sinon.SinonStub).called).to.be.false; + }); +}); \ No newline at end of file diff --git a/src/test/unit/ConnectionManager.extra.test.ts b/src/test/unit/ConnectionManager.extra.test.ts new file mode 100644 index 0000000..5556b2c --- /dev/null +++ b/src/test/unit/ConnectionManager.extra.test.ts @@ -0,0 +1,258 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as fs from 'fs'; +import * as pg from 'pg'; +import * as os from 'os'; +import * as path from 'path'; +import * as vscode from 'vscode'; + +import { ConnectionManager } from '../../services/ConnectionManager'; +import { ErrorService } from '../../services/ErrorService'; +import { SecretStorageService } from '../../services/SecretStorageService'; +import { SSHService } from '../../services/SSHService'; +import * as pgPassUtils from '../../utils/pgPassUtils'; + +describe('ConnectionManager additional coverage', () => { + let sandbox: sinon.SinonSandbox; + let secretStorageStub: sinon.SinonStubbedInstance; + let workspaceConfigGetStub: sinon.SinonStub; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + secretStorageStub = sandbox.createStubInstance(SecretStorageService); + (SecretStorageService as any).instance = secretStorageStub; + sandbox.stub(SecretStorageService, 'getInstance').returns(secretStorageStub as any); + workspaceConfigGetStub = sandbox.stub().returns(undefined); + sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: workspaceConfigGetStub, + } as any); + sandbox.stub(pgPassUtils, 'resolvePgPassPassword').returns(undefined); + }); + + afterEach(() => { + sandbox.restore(); + const instance = (ConnectionManager as any).instance; + if (instance?.cleanupTimer) { + clearInterval(instance.cleanupTimer); + } + (ConnectionManager as any).instance = undefined; + (SecretStorageService as any).instance = undefined; + }); + + it('exposes pool metrics and cleanup removes stale idle pools', async () => { + const clock = sandbox.useFakeTimers({ now: 10_000 }); + const manager = ConnectionManager.getInstance(); + const pool = { end: sandbox.stub().resolves() }; + (manager as any).pools.set('c1:postgres', pool); + (manager as any).poolMetrics.set('c1:postgres', { + connectionId: 'c1', + totalConnections: 0, + idleConnections: 0, + waitingRequests: 0, + createdAt: 1, + lastActivity: -400_000, + }); + + expect(manager.getPoolMetrics('c1:postgres')).to.deep.include({ connectionId: 'c1', totalConnections: 0 }); + expect(manager.getAllPoolMetrics()).to.have.lengthOf(1); + + await (manager as any).cleanupIdlePools(); + + expect((pool.end as sinon.SinonStub).calledOnce).to.be.true; + expect(manager.getPoolMetrics('c1:postgres')).to.equal(undefined); + expect((manager as any).pools.has('c1:postgres')).to.be.false; + clock.restore(); + }); + + it('builds SSL client config with cert files and query timeout', async () => { + secretStorageStub.getPassword.resolves('stored-password'); + workspaceConfigGetStub.callsFake((key: string) => (key === 'queryTimeout' ? 25 : undefined)); + + const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pgstudio-ssl-')); + const caPath = path.join(tempDir, 'ca.pem'); + const certPath = path.join(tempDir, 'cert.pem'); + const keyPath = path.join(tempDir, 'key.pem'); + fs.writeFileSync(caPath, 'ca-cert'); + fs.writeFileSync(certPath, 'client-cert'); + fs.writeFileSync(keyPath, 'client-key'); + + try { + const manager = ConnectionManager.getInstance(); + const config = await (manager as any).createClientConfig({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + sslmode: 'verify-full', + sslRootCertPath: caPath, + sslCertPath: certPath, + sslKeyPath: keyPath, + }); + + expect(config.connectionTimeoutMillis).to.equal(15000); + expect(config.statement_timeout).to.equal(25); + expect(config.ssl.rejectUnauthorized).to.equal(true); + expect(config.ssl.ca).to.equal('ca-cert'); + expect(config.ssl.cert).to.equal('client-cert'); + expect(config.ssl.key).to.equal('client-key'); + } finally { + fs.rmSync(tempDir, { recursive: true, force: true }); + } + }); + + it('attaches an SSH stream when ssh tunneling is enabled', async () => { + secretStorageStub.getPassword.resolves('stored-password'); + const stream = { on: sandbox.stub() }; + sandbox.stub(SSHService, 'getInstance').returns({ + createStream: sandbox.stub().resolves(stream), + } as any); + + const manager = ConnectionManager.getInstance(); + const config = await (manager as any).createClientConfig({ + id: 'c1', + host: 'db.example.com', + port: 5432, + username: 'postgres', + database: 'appdb', + ssh: { + enabled: true, + host: 'ssh.example.com', + port: 22, + username: 'tunnel', + }, + }); + + expect(config.stream).to.equal(stream); + expect((SSHService.getInstance() as any).createStream.calledOnce).to.be.true; + }); + + it('applies read-only mode when connecting pooled clients', async () => { + secretStorageStub.getPassword.resolves('stored-password'); + const client = { + query: sandbox.stub().resolves(undefined), + release: sandbox.stub(), + }; + const pool = { + connect: sandbox.stub().resolves(client), + on: sandbox.stub(), + end: sandbox.stub().resolves(), + }; + + const manager = ConnectionManager.getInstance(); + sandbox.stub(manager as any, 'createPool').returns(pool as any); + const pooledClient = await manager.getPooledClient({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + readOnlyMode: true, + }); + + expect(pooledClient).to.equal(client); + expect((client.query as sinon.SinonStub).calledOnceWithExactly('SET default_transaction_read_only = ON')).to.be.true; + }); + + it('falls back to non-SSL pooled clients after an SSL connection failure', async () => { + secretStorageStub.getPassword.resolves(undefined); + const resolvePgPass = pgPassUtils.resolvePgPassPassword as sinon.SinonStub; + resolvePgPass.returns(undefined); + const firstPool = { + connect: sandbox.stub().rejects(Object.assign(new Error('server does not support ssl'), { code: 'ECONNRESET' })), + on: sandbox.stub(), + end: sandbox.stub().resolves(), + }; + const secondClient = { + query: sandbox.stub().resolves(undefined), + release: sandbox.stub(), + }; + const secondPool = { + connect: sandbox.stub().resolves(secondClient), + on: sandbox.stub(), + end: sandbox.stub().resolves(), + }; + + const manager = ConnectionManager.getInstance(); + const createPoolStub = sandbox.stub(manager as any, 'createPool'); + createPoolStub.onCall(0).returns(firstPool as any); + createPoolStub.onCall(1).returns(secondPool as any); + const client = await manager.getPooledClient({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + }); + + expect(client).to.equal(secondClient); + expect((firstPool.end as sinon.SinonStub).calledOnce).to.be.true; + expect(createPoolStub.calledTwice).to.be.true; + }); + + it('creates and reuses session clients and closes them cleanly', async () => { + secretStorageStub.getPassword.resolves('stored-password'); + const connect = sandbox.stub(pg.Client.prototype, 'connect').resolves(); + const query = sandbox.stub(pg.Client.prototype, 'query').resolves(undefined); + const end = sandbox.stub(pg.Client.prototype, 'end').resolves(); + + const manager = ConnectionManager.getInstance(); + const config = { + id: 'c1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + readOnlyMode: true, + }; + + const first = await manager.getSessionClient(config as any, 'session-1'); + const second = await manager.getSessionClient(config as any, 'session-1'); + + expect(first).to.equal(second); + expect(connect.calledOnce).to.be.true; + expect(query.calledOnceWithExactly('SET default_transaction_read_only = ON')).to.be.true; + + await manager.closeSession(config as any, 'session-1'); + + expect(end.calledOnce).to.be.true; + }); + + it('falls back to non-SSL session clients after an SSL connection failure', async () => { + secretStorageStub.getPassword.resolves(undefined); + const resolvePgPass = pgPassUtils.resolvePgPassPassword as sinon.SinonStub; + resolvePgPass.returns(undefined); + const connect = sandbox.stub(pg.Client.prototype, 'connect'); + connect.onFirstCall().rejects(Object.assign(new Error('server does not support ssl'), { code: 'ECONNRESET' })); + connect.onSecondCall().resolves(); + sandbox.stub(pg.Client.prototype, 'query').resolves(undefined); + sandbox.stub(pg.Client.prototype, 'end').resolves(); + + const manager = ConnectionManager.getInstance(); + const client = await manager.getSessionClient({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'appdb', + } as any, 'session-2'); + + expect(client).to.exist; + expect(connect.calledTwice).to.be.true; + }); + + it('closes all resources for a connection id', async () => { + const manager = ConnectionManager.getInstance(); + const pool = { end: sandbox.stub().resolves() }; + const session = { end: sandbox.stub().resolves() }; + (manager as any).pools.set('c1:appdb', pool); + (manager as any).sessions.set('c1:appdb:session:s1', session); + + await manager.closeAllConnectionsById('c1'); + + expect((pool.end as sinon.SinonStub).calledOnce).to.be.true; + expect((session.end as sinon.SinonStub).calledOnce).to.be.true; + expect((manager as any).pools.size).to.equal(0); + expect((manager as any).sessions.size).to.equal(0); + }); +}); \ No newline at end of file diff --git a/src/test/unit/CoreHandlers.test.ts b/src/test/unit/CoreHandlers.test.ts index 1d63a5c..cff3338 100644 --- a/src/test/unit/CoreHandlers.test.ts +++ b/src/test/unit/CoreHandlers.test.ts @@ -5,7 +5,10 @@ import { ConnectionManager } from '../../services/ConnectionManager'; import { ExportRequestHandler, ImportRequestHandler, + ImportPickFileHandler, + RetryCellHandler, ShowConnectionSwitcherHandler, + ShowConnectionInfoHandler, ShowDatabaseSwitcherHandler, ShowErrorMessageHandler } from '../../services/handlers/CoreHandlers'; @@ -107,6 +110,233 @@ describe('CoreHandlers', () => { .true; }); + it('ShowDatabaseSwitcherHandler does nothing when the database stays the same', async () => { + const statusBar = { update: sandbox.stub() }; + const handler = new ShowDatabaseSwitcherHandler(statusBar); + sandbox.stub(ConnectionUtils, 'findConnection').returns({ + id: 'c1', + host: 'localhost', + port: 5432, + database: 'postgres' + }); + sandbox.stub(ConnectionUtils, 'showDatabasePicker').resolves('postgres'); + const update = sandbox.stub(ConnectionUtils, 'updateNotebookMetadata').resolves(); + + await handler.handle( + { connectionId: 'c1', currentDatabase: 'postgres' }, + { + editor: { notebook: { metadata: {} } } as unknown as vscode.NotebookEditor + } + ); + + expect(update.called).to.be.false; + expect(statusBar.update.called).to.be.false; + }); + + it('handlers return early when no editor is provided', async () => { + const statusBar = { update: sandbox.stub() }; + await new ShowConnectionSwitcherHandler(statusBar).handle({ connectionId: 'c1' }, {} as any); + await new ShowDatabaseSwitcherHandler(statusBar).handle({ connectionId: 'c1', currentDatabase: 'postgres' }, {} as any); + await new ImportPickFileHandler().handle({ table: 't', schema: 'public' }, {} as any); + await new ImportRequestHandler().handle({ data: [{ a: 1 }] }, {} as any); + await new RetryCellHandler().handle({}, {} as any); + await new ShowConnectionInfoHandler().handle({}, {} as any); + }); + + it('ImportPickFileHandler returns early when no file is selected', async () => { + sandbox.stub(ConnectionUtils, 'findConnection').returns({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'u', + database: 'postgres' + }); + const prevOpenDialog = (vscode.window as any).showOpenDialog; + (vscode.window as any).showOpenDialog = async () => undefined; + + const handler = new ImportPickFileHandler(); + try { + await handler.handle( + { table: 'users', schema: 'public' }, + { + editor: { + notebook: { + metadata: { connectionId: 'c1' } + } + } as any + } + ); + } finally { + (vscode.window as any).showOpenDialog = prevOpenDialog; + } + + expect((vscode.window.showErrorMessage as sinon.SinonStub).called).to.be.false; + }); + + it('ImportPickFileHandler rejects JSON files that are not arrays', async () => { + sandbox.stub(ConnectionUtils, 'findConnection').returns({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'u', + database: 'postgres' + }); + const prevOpenDialog = (vscode.window as any).showOpenDialog; + (vscode.window as any).showOpenDialog = async () => [vscode.Uri.file('/tmp/input.json')]; + sandbox.stub(vscode.workspace.fs, 'readFile').resolves(Buffer.from('{"id":1}')); + + const handler = new ImportPickFileHandler(); + try { + await handler.handle( + { table: 'users', schema: 'public' }, + { + editor: { + notebook: { + metadata: { connectionId: 'c1' } + } + } as any + } + ); + } finally { + (vscode.window as any).showOpenDialog = prevOpenDialog; + } + + expect((vscode.window.showErrorMessage as sinon.SinonStub).calledWith('JSON file must contain an array of objects.')).to + .be.true; + }); + + it('ImportPickFileHandler warns when CSV data has no rows', async () => { + sandbox.stub(ConnectionUtils, 'findConnection').returns({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'u', + database: 'postgres' + }); + const prevOpenDialog = (vscode.window as any).showOpenDialog; + (vscode.window as any).showOpenDialog = async () => [vscode.Uri.file('/tmp/input.csv')]; + sandbox.stub(vscode.workspace.fs, 'readFile').resolves(Buffer.from('id,name\n')); + const warning = sandbox.stub(vscode.window, 'showWarningMessage').resolves(undefined); + + const handler = new ImportPickFileHandler(); + try { + await handler.handle( + { table: 'users', schema: 'public' }, + { + editor: { + notebook: { + metadata: { connectionId: 'c1' } + } + } as any + } + ); + } finally { + (vscode.window as any).showOpenDialog = prevOpenDialog; + } + + expect(warning.calledWith('File contains no data rows.')).to.be.true; + }); + + it('ImportPickFileHandler imports CSV data and skips conflicts', async () => { + const query = sandbox.stub(); + const release = sandbox.stub(); + query.onCall(0).resolves({}); + query.onCall(1).resolves({ + rows: [ + { column_name: 'id', column_default: null, is_identity: 'NO' }, + { column_name: 'name', column_default: null, is_identity: 'NO' } + ] + }); + query.onCall(2).resolves({ rowCount: 1 }); + query.onCall(3).resolves({}); + + sandbox.stub(ConnectionManager, 'getInstance').returns({ + getPooledClient: sandbox.stub().resolves({ query, release }) + } as unknown as ConnectionManager); + sandbox.stub(ConnectionUtils, 'findConnection').returns({ + id: 'c1', + host: 'localhost', + port: 5432, + username: 'u', + database: 'postgres' + }); + const prevOpenDialog = (vscode.window as any).showOpenDialog; + (vscode.window as any).showOpenDialog = async () => [vscode.Uri.file('/tmp/input.csv')]; + sandbox.stub(vscode.workspace.fs, 'readFile').resolves(Buffer.from('id,name\n1,"Ada, Lovelace"\n')); + sandbox.stub(vscode.window, 'showQuickPick').resolves({ + label: 'Skip duplicates', + value: 'skip' + } as any); + + const handler = new ImportPickFileHandler(); + try { + await handler.handle( + { table: 'users', schema: 'public' }, + { + editor: { + notebook: { + metadata: { connectionId: 'c1' } + } + } as any + } + ); + } finally { + (vscode.window as any).showOpenDialog = prevOpenDialog; + } + + expect(query.firstCall.args[0]).to.equal('BEGIN'); + expect(query.getCall(1).args[0]).to.contain('information_schema.columns'); + expect(query.getCall(2).args[0]).to.contain('INSERT INTO "public"."users"'); + expect(query.getCall(2).args[0]).to.contain('ON CONFLICT DO NOTHING'); + expect(query.getCall(2).args[1]).to.deep.equal(['1', 'Ada, Lovelace']); + expect(query.lastCall.args[0]).to.equal('COMMIT'); + expect(release.calledOnce).to.be.true; + expect((vscode.window.showInformationMessage as sinon.SinonStub).calledWith(sinon.match(/^Successfully imported 1 rows/))).to + .be.true; + }); + + it('RetryCellHandler re-executes the notebook cell', async () => { + const execute = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + const handler = new RetryCellHandler(); + await handler.handle( + {}, + { + editor: { + notebook: { + getCells: sandbox.stub().returns([]) + } + } as any + } + ); + + expect(execute.calledWith('notebook.cell.execute')).to.be.true; + }); + + it('ShowConnectionInfoHandler displays the active connection details', async () => { + const config = { + get: sandbox.stub().returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, database: 'postgres' } + ]) + }; + sandbox.stub(vscode.workspace, 'getConfiguration').returns(config as any); + + const handler = new ShowConnectionInfoHandler(); + await handler.handle( + {}, + { + editor: { + notebook: { + metadata: { connectionId: 'c1', databaseName: 'postgres' } + } + } as any + } + ); + + expect((vscode.window.showInformationMessage as sinon.SinonStub).calledWith( + 'Connection: Primary | Host: localhost:5432 | Database: postgres' + )).to.be.true; + }); + it('ImportRequestHandler imports rows in batches', async () => { const handler = new ImportRequestHandler(); const query = sandbox.stub(); @@ -124,8 +354,14 @@ describe('CoreHandlers', () => { }); query.onCall(0).resolves({}); - query.onCall(1).resolves({}); - query.onCall(2).resolves({}); + query.onCall(1).resolves({ + rows: [ + { column_name: 'a', column_default: null, is_identity: 'NO' }, + { column_name: 'b', column_default: null, is_identity: 'NO' } + ] + }); + query.onCall(2).resolves({ rowCount: 1 }); + query.onCall(3).resolves({}); await handler.handle( { @@ -141,8 +377,10 @@ describe('CoreHandlers', () => { ); expect(query.firstCall.args[0]).to.equal('BEGIN'); - expect(query.getCall(1).args[0]).to.contain('INSERT INTO'); - expect(query.lastCall.args[0]).to.equal('COMMIT'); + expect(query.getCall(1).args[0]).to.contain('information_schema.columns'); + expect(query.getCall(2).args[0]).to.contain('INSERT INTO'); + expect(query.getCall(2).args[1]).to.deep.equal([1, 'x']); + expect(query.getCall(3).args[0]).to.equal('COMMIT'); expect(release.calledOnce).to.be.true; }); diff --git a/src/test/unit/DatabaseCommands.test.ts b/src/test/unit/DatabaseCommands.test.ts new file mode 100644 index 0000000..9e7e477 --- /dev/null +++ b/src/test/unit/DatabaseCommands.test.ts @@ -0,0 +1,190 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import * as connectionModule from '../../commands/connection'; +import * as databaseCommands from '../../commands/database'; +import * as helper from '../../commands/helper'; +import { ConnectionManager } from '../../services/ConnectionManager'; +import { DashboardPanel } from '../../dashboard/DashboardPanel'; + +function createBuilderStub(sandbox: sinon.SinonSandbox) { + const builder: any = {}; + builder.addMarkdown = sandbox.stub().returns(builder); + builder.addSql = sandbox.stub().returns(builder); + builder.show = sandbox.stub().resolves(); + builder.showNew = sandbox.stub().resolves(); + sandbox.stub(helper as any, 'NotebookBuilder').callsFake(function () { + return builder; + }); + return builder; +} + +function createDbConnection() { + const release = sinon.stub(); + const query = sinon.stub().resolves({ rows: [] }); + return { + client: { query }, + metadata: { + connectionId: 'c1', + databaseName: 'appdb', + name: 'Primary', + host: 'localhost', + port: 5432, + username: 'postgres' + }, + connection: { + id: 'c1', + name: 'Primary', + host: 'localhost', + port: 5432, + username: 'postgres' + }, + release, + query + }; +} + +describe('database commands', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('shows the dashboard, refreshes the tree, and disconnects a database', async () => { + const dbConnection = createDbConnection(); + const getDatabaseConnectionStub = sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const dashboardShowStub = sandbox.stub(DashboardPanel, 'show').resolves(); + const refreshStub = sandbox.stub(); + const infoStub = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + + const item = { label: 'appdb', databaseName: 'appdb', connectionId: 'c1' } as any; + const context = { extensionUri: vscode.Uri.file('/ext') } as any; + + await databaseCommands.cmdDatabaseDashboard(item, context); + expect(getDatabaseConnectionStub.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + expect(dashboardShowStub.calledOnceWithExactly(context.extensionUri, dbConnection.connection, 'appdb', 'c1')).to.be.true; + + await databaseCommands.cmdRefreshDatabase(item, context, { refresh: refreshStub } as any); + expect(refreshStub.calledOnceWithExactly(item)).to.be.true; + + await databaseCommands.cmdDisconnectDatabase(item, context); + expect(infoStub.calledOnceWithExactly('Disconnected from appdb (Session cleared)')).to.be.true; + }); + + it('creates, deletes, and generates database notebooks', async () => { + const builder = createBuilderStub(sandbox); + const pooledClient = { + query: sandbox.stub().resolves({ rows: [{ create_sql: 'CREATE DATABASE "appdb";' }] }), + release: sandbox.stub() + }; + const getPooledClientStub = sandbox.stub().resolves(pooledClient as any); + + sandbox.stub(connectionModule, 'getConnectionWithPassword').resolves({ + id: 'c1', + name: 'Primary', + host: 'localhost', + port: 5432, + username: 'postgres' + } as any); + sandbox.stub(connectionModule, 'createMetadata').callsFake((_config: any, databaseName: string) => ({ + connectionId: 'c1', + databaseName, + name: 'Primary', + host: 'localhost', + port: 5432, + username: 'postgres' + })); + sandbox.stub(ConnectionManager, 'getInstance').returns({ getPooledClient: getPooledClientStub } as any); + + const item = { connectionId: 'c1', label: 'appdb', databaseName: 'appdb' } as any; + const context = {} as any; + + await databaseCommands.cmdCreateDatabase(item, context); + await databaseCommands.cmdDeleteDatabase(item, context); + await databaseCommands.cmdGenerateCreateScript(item, context); + + expect((connectionModule.getConnectionWithPassword as sinon.SinonStub).callCount).to.equal(3); + expect(getPooledClientStub.callCount).to.equal(3); + expect(pooledClient.release.callCount).to.equal(3); + expect(builder.show.callCount).to.equal(3); + expect(builder.addSql.getCall(0).args[0]).to.include('CREATE DATABASE new_database;'); + expect(builder.addSql.getCall(2).args[0]).to.include('DROP DATABASE IF EXISTS "appdb";'); + expect(builder.addSql.getCall(3).args[0]).to.include('CREATE DATABASE "appdb"'); + }); + + it('opens query, maintenance, and configuration notebooks', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + const item = { label: 'appdb', databaseName: 'appdb', connectionId: 'c1' } as any; + const context = {} as any; + + await databaseCommands.cmdQueryTool(item, context); + await databaseCommands.cmdMaintenanceDatabase(item, context); + await databaseCommands.cmdShowConfiguration(item, context); + + expect(builder.showNew.calledOnce).to.be.true; + expect(builder.show.calledTwice).to.be.true; + expect(dbConnection.release.callCount).to.equal(3); + expect(builder.addMarkdown.getCalls().some((call) => String(call.args[0]).includes('Query Tool: `appdb`'))).to.be.true; + expect(builder.addMarkdown.getCalls().some((call) => String(call.args[0]).includes('Database Maintenance: `appdb`'))).to.be.true; + expect(builder.addMarkdown.getCalls().some((call) => String(call.args[0]).includes('Database Configuration: `appdb`'))).to.be.true; + }); + + it('opens a psql terminal with the resolved connection', async () => { + sandbox.stub(connectionModule, 'getConnectionWithPassword').resolves({ + host: 'localhost', + port: 5432, + username: 'postgres' + } as any); + + const terminal = { + show: sandbox.stub(), + sendText: sandbox.stub() + }; + const createTerminalStub = sandbox.stub(vscode.window, 'createTerminal').returns(terminal as any); + + const item = { connectionId: 'c1', label: 'appdb', databaseName: 'appdb' } as any; + await databaseCommands.cmdPsqlTool(item, {} as any); + + expect(createTerminalStub.calledOnceWithExactly('PSQL: appdb')).to.be.true; + expect(terminal.show.calledOnce).to.be.true; + expect(terminal.sendText.calledOnceWithExactly('psql -h localhost -p 5432 -U postgres -d "appdb"')).to.be.true; + }); + + it('builds database object notebooks for each quick-pick branch', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + const getDatabaseConnectionStub = sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const quickPickStub = sandbox.stub(vscode.window, 'showQuickPick'); + + quickPickStub.onCall(0).resolves(undefined); + quickPickStub.onCall(1).resolves({ label: 'Schema' } as any); + quickPickStub.onCall(2).resolves({ label: 'User' } as any); + quickPickStub.onCall(3).resolves({ label: 'Role' } as any); + quickPickStub.onCall(4).resolves({ label: 'Extension' } as any); + + const item = { connectionId: 'c1', label: 'appdb', databaseName: 'appdb' } as any; + const context = { extensionUri: vscode.Uri.file('/ext') } as any; + + await databaseCommands.cmdAddObjectInDatabase(item, context); + await databaseCommands.cmdAddObjectInDatabase(item, context); + await databaseCommands.cmdAddObjectInDatabase(item, context); + await databaseCommands.cmdAddObjectInDatabase(item, context); + await databaseCommands.cmdAddObjectInDatabase(item, context); + + expect(getDatabaseConnectionStub.callCount).to.equal(5); + expect(dbConnection.release.callCount).to.equal(5); + expect(quickPickStub.callCount).to.equal(5); + expect(builder.show.callCount).to.equal(4); + expect(builder.addSql.callCount).to.be.greaterThan(0); + }); +}); \ No newline at end of file diff --git a/src/test/unit/DatabaseTreeProvider.extra.test.ts b/src/test/unit/DatabaseTreeProvider.extra.test.ts new file mode 100644 index 0000000..87c24fe --- /dev/null +++ b/src/test/unit/DatabaseTreeProvider.extra.test.ts @@ -0,0 +1,241 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { DatabaseTreeItem, DatabaseTreeProvider } from '../../providers/DatabaseTreeProvider'; +import { ConnectionManager } from '../../services/ConnectionManager'; + +describe('DatabaseTreeProvider additional coverage', () => { + let sandbox: sinon.SinonSandbox; + let contextStub: any; + let configGetStub: sinon.SinonStub; + let connectionManagerStub: any; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + contextStub = { + subscriptions: [], + extensionUri: { fsPath: '/test/path' }, + globalState: { + get: sandbox.stub().callsFake((_key: string, defaultValue: any) => defaultValue), + update: sandbox.stub().resolves(), + }, + }; + + configGetStub = sandbox.stub().returns([]); + sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: configGetStub, + } as any); + + connectionManagerStub = { + getPooledClient: sandbox.stub(), + }; + sandbox.stub(ConnectionManager, 'getInstance').returns(connectionManagerStub); + + sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + sandbox.stub(vscode.window, 'showWarningMessage').resolves(undefined); + sandbox.stub(vscode.window, 'showErrorMessage').resolves(undefined); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('groups connections at the root and expands grouped connections', async () => { + configGetStub.returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, username: 'postgres' }, + { id: 'c2', name: 'Analytics', host: 'localhost', port: 5433, username: 'postgres', group: 'TeamA' }, + { id: 'c3', name: 'Reporting', host: 'localhost', port: 5434, username: 'postgres', group: 'TeamA' }, + ]); + + const provider = new DatabaseTreeProvider(contextStub); + const rootChildren = await provider.getChildren(); + + expect(rootChildren[0].type).to.equal('connection-group'); + expect(rootChildren[0].label).to.equal('TeamA'); + expect(rootChildren[1].type).to.equal('connection'); + expect(rootChildren[1].label).to.equal('Primary'); + + const groupedChildren = await provider.getChildren(rootChildren[0]); + expect(groupedChildren).to.have.lengthOf(2); + expect(groupedChildren.map(child => child.label)).to.deep.equal(['Analytics', 'Reporting']); + }); + + it('includes favorites and recent groups for a connection', async () => { + const clock = sandbox.useFakeTimers(); + configGetStub.returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, username: 'postgres' }, + ]); + const provider = new DatabaseTreeProvider(contextStub); + const item = new DatabaseTreeItem('users', vscode.TreeItemCollapsibleState.None, 'table', 'c1', 'db1', 'public'); + + await provider.addToFavorites(item); + await provider.addToRecent(item); + + const client = { + query: sandbox.stub(), + release: sandbox.stub(), + }; + client.query.onCall(0).resolves({ rows: [{ count: '3' }] }); + client.query.onCall(1).resolves({ rows: [{ count: '1' }] }); + connectionManagerStub.getPooledClient.resolves(client); + + const connectionItem = new DatabaseTreeItem('Primary', vscode.TreeItemCollapsibleState.Collapsed, 'connection', 'c1'); + const children = await provider.getChildren(connectionItem); + clock.tick(350); + + expect(children.map(child => child.type)).to.include.members(['favorites-group', 'recent-group', 'databases-group', 'category']); + expect(provider.isFavorite(item)).to.be.true; + expect(provider.getFavoriteKeys()).to.have.lengthOf(1); + expect(provider.getRecentKeys()[0]).to.contain('table:c1:db1:public:users'); + expect((contextStub.globalState.update as sinon.SinonStub).calledTwice).to.be.true; + clock.restore(); + }); + + it('materializes favorite and recent items from their dedicated groups', async () => { + const clock = sandbox.useFakeTimers(); + configGetStub.returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, username: 'postgres' }, + ]); + const provider = new DatabaseTreeProvider(contextStub); + const item = new DatabaseTreeItem('users', vscode.TreeItemCollapsibleState.None, 'table', 'c1', 'db1', 'public'); + + await provider.addToFavorites(item); + await provider.addToRecent(item); + clock.tick(350); + + const favorites = await provider.getChildren(new DatabaseTreeItem('Favorites', vscode.TreeItemCollapsibleState.Collapsed, 'favorites-group', 'c1')); + const recent = await provider.getChildren(new DatabaseTreeItem('Recent', vscode.TreeItemCollapsibleState.Collapsed, 'recent-group', 'c1')); + + expect(favorites).to.have.lengthOf(1); + expect(favorites[0].label).to.equal('users'); + expect(favorites[0].isFavorite).to.equal(true); + expect(recent).to.have.lengthOf(1); + expect(recent[0].label).to.equal('users'); + clock.restore(); + }); + + it('refreshes cache by database and connection scope', () => { + const clock = sandbox.useFakeTimers(); + const provider = new DatabaseTreeProvider(contextStub); + const cacheStub = { + clear: sandbox.stub(), + invalidateDatabase: sandbox.stub(), + invalidateConnection: sandbox.stub(), + }; + (provider as any)._cache = cacheStub; + + provider.refresh(new DatabaseTreeItem('db1', vscode.TreeItemCollapsibleState.Collapsed, 'database', 'c1', 'db1')); + clock.tick(350); + expect(cacheStub.invalidateDatabase.calledOnceWithExactly('c1', 'db1')).to.be.true; + + provider.refresh(new DatabaseTreeItem('Primary', vscode.TreeItemCollapsibleState.Collapsed, 'connection', 'c1')); + clock.tick(350); + expect(cacheStub.invalidateConnection.calledOnceWithExactly('c1')).to.be.true; + clock.restore(); + }); + + it('marks connections connected and disconnected', () => { + const provider = new DatabaseTreeProvider(contextStub); + const autoRefreshService = { + onConnectionDisconnected: sandbox.stub(), + onConnectionConnected: sandbox.stub(), + }; + provider.setAutoRefreshService(autoRefreshService as any); + const emitter = (provider as any)._onDidChangeTreeData; + const fireSpy = sandbox.spy(emitter, 'fire'); + + provider.markConnectionDisconnected('c1'); + provider.markConnectionConnected('c1'); + + expect(autoRefreshService.onConnectionDisconnected.calledOnceWithExactly('c1')).to.be.true; + expect(autoRefreshService.onConnectionConnected.calledOnceWithExactly('c1')).to.be.true; + expect(fireSpy.callCount).to.be.at.least(2); + }); + + it('reveals a connection when the tree view is ready', async () => { + configGetStub.returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, username: 'postgres' }, + ]); + const provider = new DatabaseTreeProvider(contextStub); + const treeView = { + reveal: sandbox.stub().resolves(), + }; + provider.setTreeView(treeView as any); + const focus = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + + await provider.revealItem('c1', 'db1'); + + expect(focus.calledOnceWithExactly('postgresExplorer.focus')).to.be.true; + expect((treeView.reveal as sinon.SinonStub).calledOnce).to.be.true; + }); + + it('warns when a reveal target cannot be found', async () => { + configGetStub.returns([]); + const provider = new DatabaseTreeProvider(contextStub); + const treeView = { + reveal: sandbox.stub().resolves(), + }; + provider.setTreeView(treeView as any); + + await provider.revealItem('missing'); + + expect((vscode.window.showWarningMessage as sinon.SinonStub).calledWith('Connection not found')).to.be.true; + }); + + it('returns early when no tree view is configured for reveal', async () => { + const warn = sandbox.stub(console, 'warn'); + const provider = new DatabaseTreeProvider(contextStub); + + await provider.revealItem('c1'); + + expect(warn.calledOnce).to.be.true; + }); + + it('enumerates database objects using the pooled client', async () => { + configGetStub.returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, username: 'postgres', database: 'appdb' }, + ]); + const provider = new DatabaseTreeProvider(contextStub); + const client = { + query: sandbox.stub(), + release: sandbox.stub(), + }; + client.query.onCall(0).resolves({ rows: [{ table_schema: 'public', table_name: 'users', columns: ['id', 'name'] }] }); + client.query.onCall(1).resolves({ rows: [{ table_schema: 'public', table_name: 'user_view', columns: ['id'] }] }); + client.query.onCall(2).resolves({ rows: [{ schema_name: 'public', function_name: 'calc_total' }] }); + connectionManagerStub.getPooledClient.resolves(client); + + const objects = await provider.getDbObjectsForConnection({ id: 'c1', host: 'localhost', port: 5432, username: 'postgres', database: 'appdb', name: 'Primary' }); + + expect(objects).to.deep.equal([ + { type: 'table', schema: 'public', name: 'users', columns: ['id', 'name'] }, + { type: 'view', schema: 'public', name: 'user_view', columns: ['id'] }, + { type: 'function', schema: 'public', name: 'calc_total' }, + ]); + expect((client.release as sinon.SinonStub).calledOnce).to.be.true; + }); + + it('expands foreign data wrapper and server nodes', async () => { + configGetStub.returns([ + { id: 'c1', name: 'Primary', host: 'localhost', port: 5432, username: 'postgres', database: 'appdb' }, + ]); + const provider = new DatabaseTreeProvider(contextStub); + const client = { + query: sandbox.stub(), + release: sandbox.stub(), + }; + client.query.onCall(0).resolves({ rows: [{ name: 'remote_server' }] }); + client.query.onCall(1).resolves({ rows: [{ name: 'mapping_user' }] }); + connectionManagerStub.getPooledClient.resolves(client); + + const fdwChildren = await provider.getChildren(new DatabaseTreeItem('postgres_fdw', vscode.TreeItemCollapsibleState.Collapsed, 'foreign-data-wrapper', 'c1', 'appdb')); + const serverChildren = await provider.getChildren(new DatabaseTreeItem('remote_server', vscode.TreeItemCollapsibleState.Collapsed, 'foreign-server', 'c1', 'appdb', 'postgres_fdw')); + + expect(fdwChildren[0].type).to.equal('foreign-server'); + expect(fdwChildren[0].label).to.equal('remote_server'); + expect(serverChildren[0].type).to.equal('user-mapping'); + expect(serverChildren[0].label).to.equal('mapping_user'); + expect((client.release as sinon.SinonStub).callCount).to.equal(2); + }); +}); \ No newline at end of file diff --git a/src/test/unit/DbObjectService.test.ts b/src/test/unit/DbObjectService.test.ts new file mode 100644 index 0000000..63267fb --- /dev/null +++ b/src/test/unit/DbObjectService.test.ts @@ -0,0 +1,617 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { DbObjectService } from '../../providers/chat/DbObjectService'; +import { ConnectionManager } from '../../services/ConnectionManager'; + +type QueryResponse = { + match: string; + rows: any[]; +}; + +function createQueryClient(sandbox: sinon.SinonSandbox, responses: QueryResponse[]) { + const query = sandbox.stub().callsFake(async (sql: string) => { + const response = responses.find(entry => sql.includes(entry.match)); + if (!response) { + throw new Error(`Unexpected query: ${sql}`); + } + + return { rows: response.rows }; + }); + + const release = sandbox.stub(); + + return { query, release }; +} + +function createConnectionConfig(connections: any[]) { + return { + get: (key: string) => { + if (key === 'postgresExplorer.connections') { + return connections; + } + + return undefined; + } + } as any; +} + +function createHarness( + sandbox: sinon.SinonSandbox, + connections: any[], + clientResolver: (config: any) => any +) { + sandbox.stub(vscode.workspace, 'getConfiguration').returns(createConnectionConfig(connections)); + + const getPooledClient = sandbox.stub().callsFake(async (config: any) => clientResolver(config)); + sandbox.stub(ConnectionManager, 'getInstance').returns({ getPooledClient } as any); + + const service = new DbObjectService(); + const dbListCache = { + getOrFetch: sandbox.stub().callsFake(async (_key: string, fetcher: () => Promise) => fetcher()), + clear: sandbox.stub() + }; + + (service as any)._dbListCache = dbListCache; + + return { service, getPooledClient, dbListCache }; +} + +describe('DbObjectService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('maps configured connections to top-level objects', async () => { + sandbox.stub(vscode.workspace, 'getConfiguration').returns(createConnectionConfig([ + { id: 'conn1', host: 'db.local', name: 'Primary' }, + { id: 'conn2', host: 'db2.local' } + ])); + + const service = new DbObjectService(); + const connections = await service.getConnections(); + + expect(connections).to.deep.equal([ + { + name: 'Primary', + type: 'connection', + schema: '', + database: '', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary', + isContainer: true + }, + { + name: 'db2.local', + type: 'connection', + schema: '', + database: '', + connectionId: 'conn2', + connectionName: 'db2.local', + breadcrumb: 'db2.local', + isContainer: true + } + ]); + }); + + it('loads databases, schemas, and schema objects through pooled clients', async () => { + const postgresClient = createQueryClient(sandbox, [ + { + match: 'SELECT datname FROM pg_database WHERE datistemplate = false ORDER BY datname', + rows: [{ datname: 'appdb' }] + } + ]); + + const appClient = createQueryClient(sandbox, [ + { + match: 'SELECT nspname FROM pg_namespace WHERE nspname NOT LIKE', + rows: [{ nspname: 'public' }] + }, + { + match: "SELECT table_name FROM information_schema.tables WHERE table_schema = $1 AND table_type = 'BASE TABLE'", + rows: [{ table_name: 'users' }] + }, + { + match: 'SELECT table_name FROM information_schema.views WHERE table_schema = $1', + rows: [{ table_name: 'active_users' }] + }, + { + match: "SELECT routine_name FROM information_schema.routines WHERE routine_schema = $1 AND routine_type = 'FUNCTION'", + rows: [{ routine_name: 'calc_total' }] + }, + { + match: 'SELECT matviewname FROM pg_matviews WHERE schemaname = $1', + rows: [{ matviewname: 'user_summary' }] + } + ]); + + const { service, getPooledClient } = createHarness( + sandbox, + [{ id: 'conn1', host: 'db.local', port: 5432, username: 'postgres', name: 'Primary' }], + (config: any) => config.database === 'postgres' ? postgresClient : appClient + ); + + const databases = await service.getDatabases('conn1'); + expect(databases).to.deep.equal([ + { + name: 'appdb', + type: 'database', + schema: '', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb', + isContainer: true + } + ]); + + const schemas = await service.getSchemas('conn1', 'appdb'); + expect(schemas).to.deep.equal([ + { + name: 'public', + type: 'schema', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public', + isContainer: true + } + ]); + + const objects = await service.getSchemaObjects('conn1', 'appdb', 'public'); + expect(objects.map(object => object.type)).to.deep.equal([ + 'table', + 'view', + 'function', + 'materialized-view' + ]); + expect(objects[0]).to.include({ + name: 'users', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary' + }); + + expect(getPooledClient.callCount).to.equal(3); + expect(postgresClient.release.called).to.be.false; + expect(appClient.release.called).to.be.false; + }); + + it('uses the lightweight initial search query and stores the result cache', async () => { + const postgresClient = createQueryClient(sandbox, [ + { + match: 'SELECT datname FROM pg_database WHERE datistemplate = false ORDER BY datname', + rows: [{ datname: 'appdb' }] + } + ]); + + const appClient = createQueryClient(sandbox, [ + { + match: 'ORDER BY c.relpages DESC NULLS LAST', + rows: [{ type: 'table', schema: 'public', name: 'users' }] + } + ]); + + const { service } = createHarness( + sandbox, + [{ id: 'conn1', host: 'db.local', port: 5432, username: 'postgres', name: 'Primary' }], + (config: any) => config.database === 'postgres' ? postgresClient : appClient + ); + + const initialObjects = await service.getInitialObjects(); + + expect(initialObjects).to.deep.equal([ + { + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users' + } + ]); + expect(service.getCache()).to.deep.equal(initialObjects); + }); + + it('searches objects and reuses the last query result', async () => { + const cachedObjects = [ + { + name: 'cached_users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > cached_users' + }, + { + name: 'cached_view', + type: 'view', + schema: 'analytics', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > analytics > cached_view' + } + ]; + + const postgresClient = createQueryClient(sandbox, [ + { + match: 'SELECT datname FROM pg_database WHERE datistemplate = false ORDER BY datname', + rows: [{ datname: 'appdb' }] + } + ]); + + const appClient = createQueryClient(sandbox, [ + { + match: "c.relkind IN ('r', 'v', 'm', 'f', 'p')", + rows: [{ type: 'table', schema: 'public', name: 'users' }] + } + ]); + + const { service, getPooledClient } = createHarness( + sandbox, + [{ id: 'conn1', host: 'db.local', port: 5432, username: 'postgres', name: 'Primary' }], + (config: any) => config.database === 'postgres' ? postgresClient : appClient + ); + + (service as any)._cache = cachedObjects; + + const shortResults = await service.searchObjectsAsync('u'); + expect(shortResults).to.deep.equal(cachedObjects.slice(0, 20)); + expect(getPooledClient.called).to.be.false; + + const firstSearch = await service.searchObjectsAsync('us'); + expect(firstSearch).to.deep.equal([ + { + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users' + } + ]); + + const callsAfterFirstSearch = getPooledClient.callCount; + const repeatedSearch = await service.searchObjectsAsync('us'); + + expect(repeatedSearch).to.equal(firstSearch); + expect(getPooledClient.callCount).to.equal(callsAfterFirstSearch); + }); + + it('formats schema details for supported object types and caches the result', async () => { + const cases = [ + { + label: 'table', + object: { + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users' + }, + responses: [ + { + match: 'character_maximum_length', + rows: [ + { + column_name: 'id', + data_type: 'integer', + is_nullable: 'NO', + column_default: 'nextval(users_id_seq)', + character_maximum_length: null, + numeric_precision: null, + numeric_scale: null + } + ] + }, + { + match: "constraint_type = 'PRIMARY KEY'", + rows: [{ column_name: 'id' }] + }, + { + match: "constraint_type = 'FOREIGN KEY'", + rows: [ + { + constraint_name: 'users_account_id_fkey', + column_name: 'account_id', + ref_schema: 'public', + ref_table: 'accounts', + ref_column: 'id' + } + ] + }, + { + match: 'GROUP BY i.relname, ix.indisunique, ix.indisprimary', + rows: [ + { + index_name: 'users_pkey', + indisunique: true, + indisprimary: true, + columns: ['id'] + } + ] + }, + { + match: 'reltuples::bigint as estimate', + rows: [{ estimate: '42' }] + } + ], + assertions: (output: string) => { + expect(output).to.contain('## Table: public.users'); + expect(output).to.contain('### Columns'); + expect(output).to.contain('### Primary Key'); + expect(output).to.contain('### Foreign Keys'); + expect(output).to.contain('### Indexes'); + expect(output).to.contain('Estimated Row Count: ~42'); + } + }, + { + label: 'view', + object: { + name: 'active_users', + type: 'view', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > active_users' + }, + responses: [ + { + match: 'SELECT column_name, data_type FROM information_schema.columns', + rows: [ + { column_name: 'id', data_type: 'integer' }, + { column_name: 'email', data_type: 'text' } + ] + }, + { + match: 'SELECT definition FROM pg_views', + rows: [{ definition: 'SELECT users.id, users.email FROM users;' }] + } + ], + assertions: (output: string) => { + expect(output).to.contain('## View: public.active_users'); + expect(output).to.contain('### Definition'); + expect(output).to.contain('SELECT users.id, users.email FROM users;'); + } + }, + { + label: 'function', + object: { + name: 'calc_total', + type: 'function', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > calc_total' + }, + responses: [ + { + match: 'pg_get_functiondef(p.oid) as definition', + rows: [ + { + proname: 'calc_total', + definition: 'CREATE FUNCTION public.calc_total() RETURNS numeric AS $$ SELECT 1; $$ LANGUAGE sql;', + arguments: 'amount numeric', + return_type: 'numeric', + language: 'sql', + provolatile: 's', + proisstrict: true + } + ] + } + ], + assertions: (output: string) => { + expect(output).to.contain('## Function: public.calc_total'); + expect(output).to.contain('### Signature'); + expect(output).to.contain('Volatility: STABLE'); + expect(output).to.contain('Strict: Yes'); + } + }, + { + label: 'materialized view', + object: { + name: 'user_summary', + type: 'materialized-view', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > user_summary' + }, + responses: [ + { + match: 'format_type(atttypid, atttypmod) as data_type', + rows: [{ column_name: 'user_id', data_type: 'integer' }] + }, + { + match: 'SELECT definition FROM pg_matviews', + rows: [{ definition: 'SELECT user_id, COUNT(*) FROM events GROUP BY user_id;' }] + } + ], + assertions: (output: string) => { + expect(output).to.contain('## Materialized View: public.user_summary'); + expect(output).to.contain('### Definition'); + expect(output).to.contain('SELECT user_id, COUNT(*) FROM events GROUP BY user_id;'); + } + }, + { + label: 'type', + object: { + name: 'address', + type: 'type', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > address' + }, + responses: [ + { + match: 'pg_type t JOIN pg_namespace n ON t.typnamespace = n.oid', + rows: [ + { attname: 'street', data_type: 'text' }, + { attname: 'zip', data_type: 'text' } + ] + } + ], + assertions: (output: string) => { + expect(output).to.contain('## Type: public.address'); + expect(output).to.contain('### Attributes'); + expect(output).to.contain('| street | text |'); + } + }, + { + label: 'schema', + object: { + name: 'public', + type: 'schema', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public' + }, + responses: [ + { + match: "SELECT table_name FROM information_schema.tables WHERE table_schema = $1 AND table_type = 'BASE TABLE'", + rows: [{ table_name: 'users' }] + }, + { + match: 'SELECT table_name FROM information_schema.views WHERE table_schema = $1', + rows: [{ table_name: 'active_users' }] + }, + { + match: 'SELECT routine_name FROM information_schema.routines WHERE routine_schema = $1', + rows: [{ routine_name: 'calc_total' }] + } + ], + assertions: (output: string) => { + expect(output).to.contain('## Schema: public'); + expect(output).to.contain('### Summary'); + expect(output).to.contain('- Tables: 1'); + expect(output).to.contain('- Views: 1'); + expect(output).to.contain('- Functions: 1'); + } + }, + { + label: 'unknown', + object: { + name: 'anything', + type: 'connection', + schema: '', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary' + }, + responses: [], + assertions: (output: string) => { + expect(output).to.equal('Unknown object type'); + } + } + ]; + + for (const testCase of cases) { + const caseSandbox = sinon.createSandbox(); + const client = createQueryClient(caseSandbox, testCase.responses); + const { service } = createHarness( + caseSandbox, + [{ id: 'conn1', host: 'db.local', port: 5432, username: 'postgres', name: 'Primary' }], + () => client + ); + + const firstResult = await service.getObjectSchema(testCase.object as any); + testCase.assertions(firstResult); + + const secondResult = await service.getObjectSchema(testCase.object as any); + expect(secondResult).to.equal(firstResult); + expect(client.query.callCount).to.equal(testCase.responses.length); + expect(client.release.calledOnce).to.be.true; + + caseSandbox.restore(); + } + }); + + it('returns a connection-not-found message when the object has no matching connection', async () => { + sandbox.stub(vscode.workspace, 'getConfiguration').returns(createConnectionConfig([])); + + const service = new DbObjectService(); + const output = await service.getObjectSchema({ + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'missing', + connectionName: 'Missing', + breadcrumb: 'Missing' + }); + + expect(output).to.equal('Connection not found'); + }); + + it('clears cached objects and filters cached search results in memory', async () => { + const { service, dbListCache } = createHarness( + sandbox, + [{ id: 'conn1', host: 'db.local', port: 5432, username: 'postgres', name: 'Primary' }], + () => ({ query: sandbox.stub().resolves({ rows: [] }), release: sandbox.stub() }) + ); + + (service as any)._cache = [ + { + name: 'users', + type: 'table', + schema: 'public', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > public > users' + }, + { + name: 'active_users', + type: 'view', + schema: 'analytics', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > analytics > active_users' + } + ]; + (service as any)._objectSchemaCache = new Map([['cache-key', 'cached schema']]); + + expect(service.getCache()).to.have.lengthOf(2); + expect(service.searchObjects('view')).to.deep.equal([ + { + name: 'active_users', + type: 'view', + schema: 'analytics', + database: 'appdb', + connectionId: 'conn1', + connectionName: 'Primary', + breadcrumb: 'Primary > appdb > analytics > active_users' + } + ]); + + service.clearCache(); + + expect((service as any)._objectSchemaCache.size).to.equal(0); + expect(dbListCache.clear.calledOnce).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/ErrorService.test.ts b/src/test/unit/ErrorService.test.ts new file mode 100644 index 0000000..e661810 --- /dev/null +++ b/src/test/unit/ErrorService.test.ts @@ -0,0 +1,54 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { ErrorService, getErrorExplanation } from '../../services/ErrorService'; + +describe('ErrorService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('returns PostgreSQL error explanations when known', () => { + expect(getErrorExplanation('42P01')).to.contain('Table not found'); + expect(getErrorExplanation('42601')).to.contain('Syntax error'); + expect(getErrorExplanation('00000')).to.equal(undefined); + }); + + it('shows a simple error when no action is supplied', async () => { + const showErrorMessageStub = sandbox.stub(vscode.window, 'showErrorMessage').resolves(undefined); + const executeCommandStub = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + + await ErrorService.getInstance().showError('Something went wrong'); + + expect(showErrorMessageStub.calledOnceWithExactly('Something went wrong')).to.be.true; + expect(executeCommandStub.called).to.be.false; + }); + + it('runs the action command when the user selects the error action', async () => { + const showErrorMessageStub = sandbox.stub(vscode.window, 'showErrorMessage').resolves('Retry' as any); + const executeCommandStub = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + + await ErrorService.getInstance().showError('Something went wrong', 'Retry', 'postgres-explorer.retry'); + + expect(showErrorMessageStub.calledOnceWithExactly('Something went wrong', 'Retry')).to.be.true; + expect(executeCommandStub.calledOnceWithExactly('postgres-explorer.retry')).to.be.true; + }); + + it('logs and reports command failures', async () => { + const showErrorMessageStub = sandbox.stub(vscode.window, 'showErrorMessage').resolves(undefined); + const errorStub = sandbox.stub(console, 'error'); + + await ErrorService.getInstance().handleCommandError(new Error('boom'), 'save changes'); + + expect(errorStub.calledOnce).to.be.true; + expect(String(errorStub.firstCall.args[0])).to.contain('Failed to save changes'); + expect(showErrorMessageStub.calledOnceWithExactly('Failed to save changes: boom')).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/ExplainProvider.test.ts b/src/test/unit/ExplainProvider.test.ts new file mode 100644 index 0000000..982f505 --- /dev/null +++ b/src/test/unit/ExplainProvider.test.ts @@ -0,0 +1,98 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { ExplainProvider } from '../../providers/ExplainProvider'; + +describe('ExplainProvider', () => { + let sandbox: sinon.SinonSandbox; + let panel: any; + let disposeCallback: (() => void) | undefined; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + disposeCallback = undefined; + (ExplainProvider as any).panel = undefined; + + panel = { + webview: { + html: '', + onDidReceiveMessage: sandbox.stub().returns({ dispose: () => {} }), + postMessage: sandbox.stub().resolves(true), + asWebviewUri: (uri: vscode.Uri) => uri, + cspSource: 'vscode-resource' + }, + reveal: sandbox.stub(), + onDidDispose: (callback: () => void) => { + disposeCallback = callback; + return { dispose: () => {} }; + }, + dispose: sandbox.stub() + }; + + sandbox.stub(vscode.window, 'createWebviewPanel').returns(panel as any); + }); + + afterEach(() => { + sandbox.restore(); + (ExplainProvider as any).panel = undefined; + }); + + it('renders a plan tree with query and extras, then reuses the panel', () => { + const plan = [{ + Plan: { + 'Node Type': 'Nested Loop', + 'Startup Cost': 1.25, + 'Total Cost': 9.5, + 'Actual Startup Time': 0.1, + 'Actual Total Time': 0.3, + 'Actual Rows': 5, + 'Actual Loops': 2, + 'Relation Name': 'users', + Schema: 'public', + 'Index Name': 'users_pkey', + Filter: 'id > 10', + 'Join Filter': 'users.id = orders.user_id', + 'Hash Cond': 'users.id = orders.user_id', + 'Merge Cond': 'users.id = orders.user_id', + 'Rows Removed by Filter': 3, + Plans: [ + { + 'Node Type': 'Seq Scan', + 'Plan Rows': 12 + } + ] + } + }]; + + ExplainProvider.show(vscode.Uri.file('/ext'), plan, 'SELECT * FROM users'); + + expect((vscode.window.createWebviewPanel as sinon.SinonStub).calledOnce).to.be.true; + expect(panel.webview.html).to.contain('EXPLAIN ANALYZE'); + expect(panel.webview.html).to.contain('SELECT * FROM users'); + expect(panel.webview.html).to.contain('Nested Loop'); + expect(panel.webview.html).to.contain('Cost: 1.25 → 9.5'); + expect(panel.webview.html).to.contain('Actual: 0.1ms → 0.3ms'); + expect(panel.webview.html).to.contain('Rows: 5'); + expect(panel.webview.html).to.contain('Loops: 2'); + expect(panel.webview.html).to.contain('Relation Name'); + expect(panel.webview.html).to.contain('Seq Scan'); + expect(panel.reveal.calledOnce).to.be.true; + + ExplainProvider.show(vscode.Uri.file('/ext'), [{ Plan: { 'Node Type': 'Result' } }], 'SELECT 2'); + + expect((vscode.window.createWebviewPanel as sinon.SinonStub).calledOnce).to.be.true; + expect(panel.webview.html).to.contain('SELECT 2'); + expect(panel.reveal.calledTwice).to.be.true; + }); + + it('creates a fresh panel after disposal', () => { + ExplainProvider.show(vscode.Uri.file('/ext'), [{ Plan: { 'Node Type': 'Result' } }], 'SELECT 1'); + expect((vscode.window.createWebviewPanel as sinon.SinonStub).calledOnce).to.be.true; + + disposeCallback?.(); + + ExplainProvider.show(vscode.Uri.file('/ext'), [{ Plan: { 'Node Type': 'Result' } }], 'SELECT 2'); + expect((vscode.window.createWebviewPanel as sinon.SinonStub).calledTwice).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/ForeignTables.test.ts b/src/test/unit/ForeignTables.test.ts new file mode 100644 index 0000000..6510972 --- /dev/null +++ b/src/test/unit/ForeignTables.test.ts @@ -0,0 +1,276 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import * as foreignTables from '../../commands/foreignTables'; +import { ForeignTableSQL } from '../../commands/sql/foreignTables'; +import * as helper from '../../commands/helper'; +import { QueryBuilder } from '../../commands/helper'; + +function createBuilderStub(sandbox: sinon.SinonSandbox) { + const builder: any = {}; + builder.addMarkdown = sandbox.stub().returns(builder); + builder.addSql = sandbox.stub().returns(builder); + builder.show = sandbox.stub().resolves(); + sandbox.stub(helper as any, 'NotebookBuilder').callsFake(function () { + return builder; + }); + return builder; +} + +function createDbConnection(overrides?: Partial<{ metadata: any; queryStub: sinon.SinonStub; release: sinon.SinonStub }>) { + const queryStub = overrides?.queryStub ?? sinon.stub(); + const release = overrides?.release ?? sinon.stub(); + return { + client: { query: queryStub }, + metadata: overrides?.metadata ?? { + connectionId: 'conn-1', + databaseName: 'db1', + name: 'Local DB', + host: 'localhost', + port: 5432, + username: 'postgres' + }, + release + }; +} + +describe('ForeignTableSQL', () => { + it('builds the foreign table template variants', () => { + expect(ForeignTableSQL.queryData('public', 'remote_orders')).to.equal(`-- Query data +SELECT * +FROM public.remote_orders +LIMIT 100;`); + + expect(ForeignTableSQL.edit('public', 'remote_orders')).to.equal(`-- Edit table (requires dropping and recreating) +DROP FOREIGN TABLE IF EXISTS public.remote_orders; + +CREATE FOREIGN TABLE public.remote_orders ( + -- Define columns here + column_name data_type +) SERVER server_name +OPTIONS ( + schema_name 'remote_schema', + table_name 'remote_table' +);`); + + expect(ForeignTableSQL.drop('public', 'remote_orders')).to.equal(`-- Drop table +DROP FOREIGN TABLE IF EXISTS public.remote_orders;`); + + expect(ForeignTableSQL.create.basic('public')).to.include('CREATE FOREIGN TABLE public.foreign_table_name'); + expect(ForeignTableSQL.create.postgresRemote('public')).to.include('CREATE FOREIGN TABLE public.remote_table'); + expect(ForeignTableSQL.create.fileBased('public')).to.include('CREATE FOREIGN TABLE public.csv_data'); + expect(ForeignTableSQL.queryWithJoin('public')).to.include('JOIN public.foreign_table_name ft ON lt.id = ft.id;'); + expect(ForeignTableSQL.manageForeignServer()).to.include('DROP SERVER foreign_server_name CASCADE;'); + }); +}); + +describe('foreign table commands', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('refreshes the selected tree item', async () => { + const refresh = sandbox.stub(); + + await foreignTables.cmdRefreshForeignTable({ label: 'remote_orders' } as any, {} as any, { refresh } as any); + + expect(refresh.calledOnce).to.be.true; + }); + + it('creates a preview notebook for a foreign table', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + const getDbConnection = sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'remote_orders' } as any; + + await foreignTables.cmdViewForeignTableData(item, {} as any); + + expect(getDbConnection.calledOnceWithExactly(item)).to.be.true; + expect(builder.addMarkdown.calledTwice).to.be.true; + expect(builder.addMarkdown.firstCall.args[0]).to.include('Query Foreign Table Data: `public.remote_orders`'); + expect(builder.addSql.calledOnceWithExactly(ForeignTableSQL.queryData('public', 'remote_orders'))).to.be.true; + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('builds the foreign table operations notebook from metadata', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.resolves({ + rows: [ + { + column_name: 'id', + data_type: 'integer', + is_nullable: 'NO', + column_default: null, + server_name: 'remote_server', + options: ["schema_name 'remote'", "table_name 'orders'"] + }, + { + column_name: 'customer_name', + data_type: 'text', + is_nullable: 'YES', + column_default: null, + server_name: 'remote_server', + options: ["schema_name 'remote'", "table_name 'orders'"] + } + ] + }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'remote_orders' } as any; + + await foreignTables.cmdForeignTableOperations(item, {} as any); + + expect(queryStub.calledOnceWithExactly(QueryBuilder.foreignTableInfo('public', 'remote_orders'))).to.be.true; + expect(builder.addMarkdown.firstCall.args[0]).to.include('Foreign Table Operations'); + expect(builder.addSql.callCount).to.equal(4); + expect(builder.addSql.firstCall.args[0]).to.include('CREATE FOREIGN TABLE public.remote_orders'); + expect(builder.addSql.firstCall.args[0]).to.include('SERVER remote_server'); + expect(builder.addSql.firstCall.args[0]).to.include("OPTIONS (schema_name 'remote', table_name 'orders')"); + expect(builder.addSql.getCall(1).args[0]).to.equal(ForeignTableSQL.queryData('public', 'remote_orders')); + expect(builder.addSql.getCall(2).args[0]).to.equal(ForeignTableSQL.edit('public', 'remote_orders')); + expect(builder.addSql.getCall(3).args[0]).to.equal(ForeignTableSQL.drop('public', 'remote_orders')); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('builds the foreign table edit notebook', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.resolves({ + rows: [ + { + table_name: 'remote_orders', + server_name: 'remote_server', + columns: ['id integer NOT NULL', 'customer_name text'], + options: ["schema_name 'remote'", "table_name 'orders'"] + } + ] + }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'remote_orders' } as any; + + await foreignTables.cmdEditForeignTable(item, {} as any); + + expect(queryStub.calledOnceWithExactly(QueryBuilder.foreignTableDefinition('public', 'remote_orders'))).to.be.true; + expect(builder.addMarkdown.firstCall.args[0]).to.include('Edit Foreign Table: `public.remote_orders`'); + expect(builder.addSql.calledOnce).to.be.true; + expect(builder.addSql.firstCall.args[0]).to.include('DROP FOREIGN TABLE IF EXISTS public.remote_orders;'); + expect(builder.addSql.firstCall.args[0]).to.include('CREATE FOREIGN TABLE public.remote_orders'); + expect(builder.addSql.firstCall.args[0]).to.include('SERVER remote_server'); + expect(builder.addSql.firstCall.args[0]).to.include("OPTIONS (\n schema_name 'remote',\n table_name 'orders'\n)"); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('builds the create notebook from foreign table templates', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'remote_orders' } as any; + + await foreignTables.cmdCreateForeignTable(item, {} as any); + + expect(builder.addSql.callCount).to.equal(5); + expect(builder.addSql.getCall(0).args[0]).to.equal(ForeignTableSQL.create.basic('public')); + expect(builder.addSql.getCall(1).args[0]).to.equal(ForeignTableSQL.create.postgresRemote('public')); + expect(builder.addSql.getCall(2).args[0]).to.equal(ForeignTableSQL.create.fileBased('public')); + expect(builder.addSql.getCall(3).args[0]).to.equal(ForeignTableSQL.queryWithJoin('public')); + expect(builder.addSql.getCall(4).args[0]).to.equal(ForeignTableSQL.manageForeignServer()); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('builds the properties notebook from foreign table metadata', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.onFirstCall().resolves({ + rows: [ + { + column_name: 'id', + data_type: 'integer', + is_nullable: 'NO', + column_default: "nextval('remote_orders_id_seq'::regclass)", + server_name: 'remote_server', + options: ["schema_name 'remote'", "table_name 'orders'"] + }, + { + column_name: 'customer_name', + data_type: 'text', + is_nullable: 'YES', + column_default: null, + server_name: 'remote_server', + options: ["schema_name 'remote'", "table_name 'orders'"] + } + ] + }); + queryStub.onSecondCall().resolves({ + rows: [ + { + table_name: 'remote_orders', + server_name: 'remote_server', + columns: ['id integer NOT NULL', 'customer_name text'], + options: ["schema_name 'remote'", "table_name 'orders'"] + } + ] + }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'remote_orders' } as any; + + await foreignTables.cmdShowForeignTableProperties(item, {} as any); + + expect(queryStub.firstCall.args[0]).to.equal(QueryBuilder.foreignTableInfo('public', 'remote_orders')); + expect(queryStub.secondCall.args[0]).to.equal(QueryBuilder.foreignTableDefinition('public', 'remote_orders')); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Foreign Table Properties: `public.remote_orders`'); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Server:'); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Column Count'); + expect(builder.addSql.callCount).to.equal(3); + expect(builder.addSql.getCall(0).args[0]).to.include('CREATE FOREIGN TABLE public.remote_orders'); + expect(builder.addSql.getCall(1).args[0]).to.equal(ForeignTableSQL.queryData('public', 'remote_orders')); + expect(builder.addSql.getCall(2).args[0]).to.equal(ForeignTableSQL.drop('public', 'remote_orders')); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('reports missing foreign table metadata', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.onFirstCall().resolves({ rows: [] }); + queryStub.onSecondCall().resolves({ + rows: [ + { + table_name: 'remote_orders', + server_name: 'remote_server', + columns: ['id integer NOT NULL'], + options: [] + } + ] + }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const handleCommandError = sandbox.stub(helper.ErrorHandlers, 'handleCommandError').resolves(); + + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'remote_orders' } as any; + + await foreignTables.cmdShowForeignTableProperties(item, {} as any); + + expect(handleCommandError.calledOnce).to.be.true; + expect(handleCommandError.firstCall.args[1]).to.equal('show foreign table properties'); + expect(builder.show.called).to.be.false; + expect(dbConnection.release.calledOnce).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/MaterializedViews.test.ts b/src/test/unit/MaterializedViews.test.ts new file mode 100644 index 0000000..cfdae80 --- /dev/null +++ b/src/test/unit/MaterializedViews.test.ts @@ -0,0 +1,316 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import * as materializedViews from '../../commands/materializedViews'; +import { MaterializedViewSQL } from '../../commands/sql/materializedViews'; +import * as helper from '../../commands/helper'; +import { QueryBuilder } from '../../commands/helper'; + +function createBuilderStub(sandbox: sinon.SinonSandbox) { + const builder: any = {}; + builder.addMarkdown = sandbox.stub().returns(builder); + builder.addSql = sandbox.stub().returns(builder); + builder.show = sandbox.stub().resolves(); + sandbox.stub(helper as any, 'NotebookBuilder').callsFake(function () { + return builder; + }); + return builder; +} + +function createDbConnection(overrides?: Partial<{ metadata: any; queryStub: sinon.SinonStub; release: sinon.SinonStub }>) { + const queryStub = overrides?.queryStub ?? sinon.stub(); + const release = overrides?.release ?? sinon.stub(); + return { + client: { query: queryStub }, + metadata: overrides?.metadata ?? { + connectionId: 'conn-1', + databaseName: 'db1', + name: 'Local DB', + host: 'localhost', + port: 5432, + username: 'postgres' + }, + release + }; +} + +async function assertSingleNotebookCommand( + sandbox: sinon.SinonSandbox, + command: (item: any, context: any) => Promise, + item: any, + expectedSql: string, + expectedMarkdownFragment: string +) { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + const getDbConnection = sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + + await command(item, {} as any); + + expect(getDbConnection.calledOnce).to.be.true; + expect(getDbConnection.calledWithExactly(item)).to.be.true; + expect(builder.addMarkdown.called).to.be.true; + expect(builder.addMarkdown.firstCall.args[0]).to.include(expectedMarkdownFragment); + expect(builder.addSql.calledOnce).to.be.true; + expect(builder.addSql.calledWithExactly(expectedSql)).to.be.true; + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; +} + +describe('MaterializedViewSQL', () => { + it('builds the materialized view template variants', () => { + expect(MaterializedViewSQL.select('public', 'sales_mv')).to.equal(`SELECT * +FROM public.sales_mv +LIMIT 100;`); + expect(MaterializedViewSQL.refresh('public', 'sales_mv')).to.include('REFRESH MATERIALIZED VIEW public.sales_mv;'); + expect(MaterializedViewSQL.create('public', 'sales_mv')).to.include('CREATE MATERIALIZED VIEW public.sales_mv AS'); + expect(MaterializedViewSQL.drop('public', 'sales_mv')).to.equal(`DROP MATERIALIZED VIEW public.sales_mv; + +-- Use CASCADE to also drop dependent objects +-- DROP MATERIALIZED VIEW public.sales_mv CASCADE;`); + expect(MaterializedViewSQL.analyze('public', 'sales_mv')).to.equal('ANALYZE public.sales_mv;'); + expect(MaterializedViewSQL.createIndex('public', 'sales_mv')).to.equal(`CREATE UNIQUE INDEX sales_mv_unique_idx + ON public.sales_mv (id);`); + }); +}); + +describe('materialized view commands', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('refreshes a materialized view notebook', async () => { + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + await assertSingleNotebookCommand( + sandbox, + materializedViews.cmdRefreshMatView, + item, + MaterializedViewSQL.refresh('public', 'sales_mv'), + 'Refresh Materialized View: `public.sales_mv`' + ); + }); + + it('creates a materialized view data notebook', async () => { + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + await assertSingleNotebookCommand( + sandbox, + materializedViews.cmdViewMatViewData, + item, + MaterializedViewSQL.select('public', 'sales_mv'), + 'View Data: `public.sales_mv`' + ); + }); + + it('creates a drop notebook for a materialized view', async () => { + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + await assertSingleNotebookCommand( + sandbox, + materializedViews.cmdDropMatView, + item, + MaterializedViewSQL.drop('public', 'sales_mv'), + 'Drop Materialized View: `public.sales_mv`' + ); + }); + + it('creates a create notebook for a materialized view', async () => { + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + await assertSingleNotebookCommand( + sandbox, + materializedViews.cmdCreateMaterializedView, + item, + MaterializedViewSQL.create('public', 'new_matview'), + 'Create New Materialized View in Schema: `public`' + ); + }); + + it('builds the materialized view operations notebook', async () => { + const builder = createBuilderStub(sandbox); + const dbConnection = createDbConnection(); + const getDbConnection = sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + + await materializedViews.cmdMatViewOperations(item, {} as any); + + expect(getDbConnection.calledOnceWithExactly(item)).to.be.true; + expect(builder.addMarkdown.firstCall.args[0]).to.include('Materialized View Operations: `public.sales_mv`'); + expect(builder.addSql.callCount).to.equal(5); + expect(builder.addSql.getCall(0).args[0]).to.equal(MaterializedViewSQL.select('public', 'sales_mv')); + expect(builder.addSql.getCall(1).args[0]).to.equal(MaterializedViewSQL.analyze('public', 'sales_mv')); + expect(builder.addSql.getCall(2).args[0]).to.equal(MaterializedViewSQL.refresh('public', 'sales_mv')); + expect(builder.addSql.getCall(3).args[0]).to.equal(MaterializedViewSQL.createIndex('public', 'sales_mv')); + expect(builder.addSql.getCall(4).args[0]).to.equal(MaterializedViewSQL.drop('public', 'sales_mv')); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('creates an edit notebook from the current definition', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub().resolves({ rows: [{ definition: 'SELECT id, total FROM source_sales WHERE active = true;' }] }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + + await materializedViews.cmdEditMatView(item, {} as any); + + expect(queryStub.calledOnceWithExactly(QueryBuilder.matViewDefinition('public', 'sales_mv'))).to.be.true; + expect(builder.addMarkdown.firstCall.args[0]).to.include('Edit Materialized View: `public.sales_mv`'); + expect(builder.addSql.calledOnce).to.be.true; + expect(builder.addSql.firstCall.args[0]).to.include('DROP MATERIALIZED VIEW IF EXISTS public.sales_mv;'); + expect(builder.addSql.firstCall.args[0]).to.include('CREATE MATERIALIZED VIEW public.sales_mv AS'); + expect(builder.addSql.firstCall.args[0]).to.include('SELECT id, total FROM source_sales WHERE active = true'); + expect(builder.addSql.firstCall.args[0]).to.include('WITH DATA;'); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('reports a missing materialized view definition', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub().resolves({ rows: [{}] }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const handleCommandError = sandbox.stub(helper.ErrorHandlers, 'handleCommandError').resolves(); + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + + await materializedViews.cmdEditMatView(item, {} as any); + + expect(handleCommandError.calledOnce).to.be.true; + expect(handleCommandError.firstCall.args[1]).to.equal('create materialized view edit notebook'); + expect(builder.show.called).to.be.false; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('builds the materialized view properties notebook', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.onCall(0).resolves({ + rows: [ + { + schema_name: 'public', + matview_name: 'sales_mv', + owner: 'postgres', + ispopulated: true, + total_size: '1 MB', + table_size: '768 kB', + indexes_size: '256 kB', + row_estimate: 1234, + comment: "Owner's summary" + } + ] + }); + queryStub.onCall(1).resolves({ + rows: [ + { + ordinal_position: 1, + column_name: 'id', + data_type: 'integer', + character_maximum_length: null, + numeric_precision: null, + numeric_scale: null, + is_nullable: 'NO', + default_value: null, + description: 'Primary key' + }, + { + ordinal_position: 2, + column_name: 'total', + data_type: 'numeric', + character_maximum_length: null, + numeric_precision: 12, + numeric_scale: 2, + is_nullable: 'YES', + default_value: '0.0', + description: 'Aggregated total' + } + ] + }); + queryStub.onCall(2).resolves({ + rows: [ + { + index_name: 'sales_mv_unique_idx', + is_primary: true, + is_unique: true, + columns: 'id', + index_size: '64 kB', + definition: 'CREATE UNIQUE INDEX sales_mv_unique_idx ON public.sales_mv (id);' + }, + { + index_name: 'sales_mv_total_idx', + is_primary: false, + is_unique: false, + columns: 'total', + index_size: '32 kB', + definition: 'CREATE INDEX sales_mv_total_idx ON public.sales_mv (total);' + } + ] + }); + queryStub.onCall(3).resolves({ + rows: [ + { kind: 'r', schema: 'public', name: 'source_sales' } + ] + }); + queryStub.onCall(4).resolves({ + rows: [ + { kind: 'v', schema: 'public', name: 'sales_summary' } + ] + }); + queryStub.onCall(5).resolves({ + rows: [ + { live_tuples: 1234, dead_tuples: 7 } + ] + }); + queryStub.onCall(6).resolves({ rows: [{ definition: 'SELECT id, total FROM source_sales WHERE active = true;' }] }); + + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + + await materializedViews.cmdViewMatViewProperties(item, {} as any); + + expect(queryStub.getCall(0).args[0]).to.equal(QueryBuilder.matViewInfo('public', 'sales_mv')); + expect(queryStub.getCall(1).args[0]).to.equal(QueryBuilder.tableColumns('public', 'sales_mv')); + expect(queryStub.getCall(2).args[0]).to.equal(QueryBuilder.tableIndexes('public', 'sales_mv')); + expect(queryStub.getCall(3).args[0]).to.equal(QueryBuilder.objectDependencies('public', 'sales_mv')); + expect(queryStub.getCall(4).args[0]).to.equal(QueryBuilder.objectReferences('public', 'sales_mv')); + expect(queryStub.getCall(5).args[0]).to.equal(QueryBuilder.matViewStats('public', 'sales_mv')); + expect(queryStub.getCall(6).args[0]).to.equal(QueryBuilder.matViewDefinition('public', 'sales_mv')); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Materialized View Properties: `public.sales_mv`'); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Columns (2)'); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Indexes (2)'); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Referenced Objects (1)'); + expect(builder.addMarkdown.firstCall.args[0]).to.include('Dependent Objects (1)'); + expect(builder.addSql.callCount).to.equal(5); + expect(builder.addSql.getCall(0).args[0]).to.include('DROP MATERIALIZED VIEW IF EXISTS public.sales_mv;'); + expect(builder.addSql.getCall(0).args[0]).to.include('CREATE MATERIALIZED VIEW public.sales_mv AS'); + expect(builder.addSql.getCall(0).args[0]).to.include("COMMENT ON MATERIALIZED VIEW public.sales_mv IS 'Owner''s summary';"); + expect(builder.addSql.getCall(0).args[0]).to.include('CREATE UNIQUE INDEX sales_mv_unique_idx ON public.sales_mv (id);'); + expect(builder.addSql.getCall(1).args[0]).to.equal(MaterializedViewSQL.refresh('public', 'sales_mv')); + expect(builder.addSql.getCall(2).args[0]).to.equal(MaterializedViewSQL.select('public', 'sales_mv')); + expect(builder.addSql.getCall(3).args[0]).to.include('SELECT'); + expect(builder.addSql.getCall(4).args[0]).to.equal(MaterializedViewSQL.drop('public', 'sales_mv')); + expect(builder.show.calledOnce).to.be.true; + expect(dbConnection.release.calledOnce).to.be.true; + }); + + it('reports missing materialized view metadata', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.onCall(0).resolves({ rows: [] }); + const dbConnection = createDbConnection({ queryStub }); + sandbox.stub(helper, 'getDatabaseConnection').resolves(dbConnection as any); + const handleCommandError = sandbox.stub(helper.ErrorHandlers, 'handleCommandError').resolves(); + const item = { connectionId: 'conn-1', databaseName: 'db1', schema: 'public', label: 'sales_mv' } as any; + + await materializedViews.cmdViewMatViewProperties(item, {} as any); + + expect(handleCommandError.calledOnce).to.be.true; + expect(handleCommandError.firstCall.args[1]).to.equal('show materialized view properties'); + expect(builder.show.called).to.be.false; + expect(dbConnection.release.calledOnce).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/NotebookBuilder.test.ts b/src/test/unit/NotebookBuilder.test.ts new file mode 100644 index 0000000..93ce106 --- /dev/null +++ b/src/test/unit/NotebookBuilder.test.ts @@ -0,0 +1,273 @@ +/** + * Unit tests for NotebookBuilder.show() persistent session logic. + * Task 3.1 — Requirements: 2.1, 2.2, 2.3, 4.2, 5.2, 5.3 + */ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +// We need to reset the module-level _extensionContext between tests. +// Import the module under test after setting up stubs. +import { NotebookBuilder } from '../../commands/helper'; +import { SessionRegistry } from '../../services/SessionRegistry'; + +function makeContext(globalStorageUri?: vscode.Uri): vscode.ExtensionContext { + return { + globalStorageUri: globalStorageUri ?? vscode.Uri.file('/global-storage'), + subscriptions: [], + workspaceState: { get: () => undefined, update: async () => {} } as any, + globalState: { get: () => undefined, update: async () => {} } as any, + extensionUri: vscode.Uri.file('/ext'), + extension: { packageJSON: {} }, + secrets: { get: async () => undefined, store: async () => {}, delete: async () => {} } + } as any; +} + +function makeNotebookDoc(uri: vscode.Uri, cellCount = 0, isClosed = false): vscode.NotebookDocument { + const doc = new (vscode.NotebookDocument as any)(uri) as any; + doc.cellCount = cellCount; + doc.isClosed = isClosed; + return doc as vscode.NotebookDocument; +} + +describe('NotebookBuilder.show()', () => { + let sandbox: sinon.SinonSandbox; + let prevApplyEdit: any; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + // Clear registry before each test + (SessionRegistry as any).map?.clear?.(); + // Reset context + NotebookBuilder.setContext(undefined as any); + // Default workspace.notebookDocuments to empty + (vscode.workspace as any).notebookDocuments = []; + // Save and replace applyEdit directly (avoids double-stub issues with other test files) + prevApplyEdit = (vscode.workspace as any).applyEdit; + (vscode.workspace as any).applyEdit = async (_edit: any) => true; + }); + + afterEach(() => { + sandbox.restore(); + NotebookBuilder.setContext(undefined as any); + (SessionRegistry as any).map?.clear?.(); + (vscode.workspace as any).applyEdit = prevApplyEdit; + }); + + // ── Legacy path ────────────────────────────────────────────────────────── + + it('falls back to createAndShowNotebook when no context is set (Req 5.3)', async () => { + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument').resolves(makeNotebookDoc(vscode.Uri.file('/tmp/nb'))); + const showNotebook = sandbox.stub(vscode.window, 'showNotebookDocument').resolves(new (vscode.NotebookEditor as any)()); + + const builder = new NotebookBuilder({ connectionId: 'conn-1' }); + builder.addSql('SELECT 1'); + await builder.show(); + + // openNotebookDocument called with type string (legacy path) + expect(openNotebook.calledOnce).to.be.true; + expect(openNotebook.firstCall.args[0]).to.equal('postgres-notebook'); + expect(showNotebook.calledOnce).to.be.true; + }); + + it('falls back to createAndShowNotebook when connectionId is absent (Req 5.3)', async () => { + NotebookBuilder.setContext(makeContext()); + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument').resolves(makeNotebookDoc(vscode.Uri.file('/tmp/nb'))); + const showNotebook = sandbox.stub(vscode.window, 'showNotebookDocument').resolves(new (vscode.NotebookEditor as any)()); + + const builder = new NotebookBuilder({ /* no connectionId */ }); + builder.addSql('SELECT 1'); + await builder.show(); + + expect(openNotebook.calledOnce).to.be.true; + expect(openNotebook.firstCall.args[0]).to.equal('postgres-notebook'); + expect(showNotebook.calledOnce).to.be.true; + }); + + // ── New file path ───────────────────────────────────────────────────────── + + it('creates directory, opens new notebook, inserts cells, registers in registry (Req 1.2, 1.5, 2.3)', async () => { + const ctx = makeContext(vscode.Uri.file('/global-storage')); + NotebookBuilder.setContext(ctx); + + const scratchUri = vscode.Uri.file('/global-storage/conn-1/mydb/scratch.pgsql'); + const doc = makeNotebookDoc(scratchUri, 0); + + const createDir = sandbox.stub(vscode.workspace.fs, 'createDirectory').resolves(); + const writeFile = sandbox.stub(vscode.workspace.fs, 'writeFile').resolves(); + // stat throws → file does not exist + sandbox.stub(vscode.workspace.fs, 'stat').rejects(new Error('FileNotFound')); + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument').resolves(doc); + const applyEditSpy = sinon.spy(); + (vscode.workspace as any).applyEdit = async (edit: any) => { applyEditSpy(edit); return true; }; + const mockEditor = new (vscode.NotebookEditor as any)(); + mockEditor.revealRange = sandbox.stub(); + const showNotebook = sandbox.stub(vscode.window, 'showNotebookDocument').resolves(mockEditor); + + const builder = new NotebookBuilder({ connectionId: 'conn-1', host: 'localhost', databaseName: 'mydb' }); + builder.addSql('SELECT 1'); + await builder.show(); + + expect(createDir.calledOnce).to.be.true; + expect(writeFile.calledOnce).to.be.true; + // Opens the persistent scratch URI for the connection+database pair + expect(openNotebook.calledOnce).to.be.true; + expect((openNotebook.firstCall.args[0] as vscode.Uri).fsPath).to.equal(scratchUri.fsPath); + expect(applyEditSpy.calledOnce).to.be.true; + expect(showNotebook.calledOnce).to.be.true; + // Registered in registry + expect(SessionRegistry.get('conn-1:mydb')).to.equal(doc); + }); + + it('opens existing file by URI when scratch file exists (Req 1.3, 3.1)', async () => { + const ctx = makeContext(vscode.Uri.file('/global-storage')); + NotebookBuilder.setContext(ctx); + + const scratchUri = vscode.Uri.file('/global-storage/conn-2/mydb/scratch.pgsql'); + const doc = makeNotebookDoc(scratchUri, 2); + + sandbox.stub(vscode.workspace.fs, 'createDirectory').resolves(); + // stat resolves → file exists + sandbox.stub(vscode.workspace.fs, 'stat').resolves({ type: 1, ctime: 0, mtime: 0, size: 100 }); + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument').resolves(doc); + const mockEditor = new (vscode.NotebookEditor as any)(); + mockEditor.revealRange = sandbox.stub(); + sandbox.stub(vscode.window, 'showNotebookDocument').resolves(mockEditor); + + const builder = new NotebookBuilder({ connectionId: 'conn-2', host: 'localhost', databaseName: 'mydb' }); + builder.addSql('SELECT 2'); + await builder.show(); + + // Opens by URI (not by type string) to preserve existing content + expect(openNotebook.calledOnce).to.be.true; + const firstArg = openNotebook.firstCall.args[0]; + expect((firstArg as vscode.Uri).fsPath).to.equal(scratchUri.fsPath); + }); + + // ── Append path ─────────────────────────────────────────────────────────── + + it('appends cells to already-open document and reveals last cell (Req 2.1, 2.2, 4.2)', async () => { + const ctx = makeContext(vscode.Uri.file('/global-storage')); + NotebookBuilder.setContext(ctx); + + const scratchUri = vscode.Uri.file('/global-storage/conn-3/mydb/scratch.pgsql'); + const doc = makeNotebookDoc(scratchUri, 3, false); + SessionRegistry.set('conn-3:mydb', doc); + + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument'); + const applyEditSpy = sinon.spy(); + (vscode.workspace as any).applyEdit = async (edit: any) => { + applyEditSpy(edit); + doc.cellCount += 2; + return true; + }; + const mockEditor = new (vscode.NotebookEditor as any)(); + const revealRange = sandbox.stub(mockEditor, 'revealRange'); + const showNotebook = sandbox.stub(vscode.window, 'showNotebookDocument').resolves(mockEditor); + + const builder = new NotebookBuilder({ connectionId: 'conn-3', databaseName: 'mydb' }); + builder.addSql('SELECT 3'); + await builder.show(); + + // Should NOT open a new document + expect(openNotebook.called).to.be.false; + // Should apply edit to append cells + expect(applyEditSpy.calledOnce).to.be.true; + // Should show/focus existing document + expect(showNotebook.calledOnce).to.be.true; + expect(showNotebook.firstCall.args[0]).to.equal(doc); + // Should reveal last cell + expect(revealRange.calledOnce).to.be.true; + }); + + // ── Closed document path ────────────────────────────────────────────────── + + it('treats closed document as absent and re-opens scratch file (Req 6.3)', async () => { + const ctx = makeContext(vscode.Uri.file('/global-storage')); + NotebookBuilder.setContext(ctx); + + const scratchUri = vscode.Uri.file('/global-storage/conn-4/mydb/scratch.pgsql'); + // Registry has a closed document + const closedDoc = makeNotebookDoc(scratchUri, 1, true /* isClosed */); + SessionRegistry.set('conn-4:mydb', closedDoc); + + const freshDoc = makeNotebookDoc(scratchUri, 1, false); + sandbox.stub(vscode.workspace.fs, 'createDirectory').resolves(); + sandbox.stub(vscode.workspace.fs, 'stat').resolves({ type: 1, ctime: 0, mtime: 0, size: 50 }); + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument').resolves(freshDoc); + const mockEditor = new (vscode.NotebookEditor as any)(); + mockEditor.revealRange = sandbox.stub(); + sandbox.stub(vscode.window, 'showNotebookDocument').resolves(mockEditor); + + const builder = new NotebookBuilder({ connectionId: 'conn-4', databaseName: 'mydb' }); + builder.addSql('SELECT 4'); + await builder.show(); + + // Should have opened a new document (not used the closed one) + expect(openNotebook.calledOnce).to.be.true; + // Registry should now point to the fresh document + expect(SessionRegistry.get('conn-4:mydb')).to.equal(freshDoc); + }); + + it('includes all required metadata fields when creating a new scratch file (Req 3.3)', async () => { + const ctx = makeContext(vscode.Uri.file('/global-storage')); + NotebookBuilder.setContext(ctx); + + sandbox.stub(vscode.workspace.fs, 'createDirectory').resolves(); + const writeFile = sandbox.stub(vscode.workspace.fs, 'writeFile').resolves(); + sandbox.stub(vscode.workspace.fs, 'stat').rejects(new Error('FileNotFound')); + + const scratchUri = vscode.Uri.file('/global-storage/conn-newmeta/testdb/scratch.pgsql'); + sandbox.stub(vscode.workspace, 'openNotebookDocument').callsFake(async (_typeOrUri: any) => { + return makeNotebookDoc(scratchUri, 0); + }); + + const mockEditor = new (vscode.NotebookEditor as any)(); + mockEditor.revealRange = sandbox.stub(); + sandbox.stub(vscode.window, 'showNotebookDocument').resolves(mockEditor); + + const builder = new NotebookBuilder({ connectionId: 'conn-newmeta', host: 'pg.host', databaseName: 'testdb' }); + builder.addSql('SELECT 1'); + await builder.show(); + + expect(writeFile.calledOnce).to.be.true; + const payload = JSON.parse(Buffer.from(writeFile.firstCall.args[1] as Uint8Array).toString('utf8')); + expect(payload.metadata).to.have.property('connectionId', 'conn-newmeta'); + expect(payload.metadata).to.have.property('host', 'pg.host'); + expect(payload.metadata).to.have.property('database', 'testdb'); + expect(payload.metadata).to.have.property('databaseName', 'testdb'); + expect(payload.metadata).to.have.property('title', 'testdb'); + expect(payload.cells).to.deep.equal([]); + }); + + // ── Duplicate-tab guard ─────────────────────────────────────────────────── + + it('detects duplicate open tab by URI and focuses it without opening a new document (Req 4.3)', async () => { + const ctx = makeContext(vscode.Uri.file('/global-storage')); + NotebookBuilder.setContext(ctx); + + const scratchUri = vscode.Uri.file('/global-storage/conn-5/mydb/scratch.pgsql'); + // Registry is empty but the document is already open in workspace + const existingDoc = makeNotebookDoc(scratchUri, 2, false); + (vscode.workspace as any).notebookDocuments = [existingDoc]; + + const openNotebook = sandbox.stub(vscode.workspace, 'openNotebookDocument'); + const applyEditSpy = sinon.spy(); + (vscode.workspace as any).applyEdit = async (edit: any) => { applyEditSpy(edit); return true; }; + const mockEditor = new (vscode.NotebookEditor as any)(); + mockEditor.revealRange = sandbox.stub(); + const showNotebook = sandbox.stub(vscode.window, 'showNotebookDocument').resolves(mockEditor); + + const builder = new NotebookBuilder({ connectionId: 'conn-5', databaseName: 'mydb' }); + builder.addSql('SELECT 5'); + await builder.show(); + + // Should NOT open a second document + expect(openNotebook.called).to.be.false; + // Should focus the existing document + expect(showNotebook.calledOnce).to.be.true; + expect(showNotebook.firstCall.args[0]).to.equal(existingDoc); + // Registry should now track it + expect(SessionRegistry.get('conn-5:mydb')).to.equal(existingDoc); + }); +}); diff --git a/src/test/unit/NotebookCommands.test.ts b/src/test/unit/NotebookCommands.test.ts new file mode 100644 index 0000000..8b13541 --- /dev/null +++ b/src/test/unit/NotebookCommands.test.ts @@ -0,0 +1,131 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import * as helper from '../../commands/helper'; +import * as notebookCommands from '../../commands/notebook'; +import { NotebookBuilder } from '../../commands/helper'; + +function createBuilderStub(sandbox: sinon.SinonSandbox) { + const builder: any = {}; + builder.addMarkdown = sandbox.stub().returns(builder); + builder.addSql = sandbox.stub().returns(builder); + builder.show = sandbox.stub().resolves(); + builder.showNew = sandbox.stub().resolves(); + sandbox.stub(helper as any, 'NotebookBuilder').callsFake(function () { + return builder; + }); + return builder; +} + +function createContext() { + return { + subscriptions: [], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: () => undefined, + update: async () => undefined + }, + globalState: { + get: () => undefined, + update: async () => undefined + }, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +describe('notebook commands', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('creates a new notebook from a database connection', async () => { + const builder = createBuilderStub(sandbox); + const release = sandbox.stub(); + sandbox.stub(helper, 'getDatabaseConnection').resolves({ + metadata: { connectionId: 'c1', databaseName: 'appdb' }, + release + } as any); + + const item = { connectionId: 'c1', schema: 'public', label: 'users' } as any; + await notebookCommands.cmdNewNotebook(item); + + expect(builder.addMarkdown.calledOnce).to.be.true; + expect(builder.addSql.calledOnce).to.be.true; + expect(builder.showNew.calledOnce).to.be.true; + expect(release.calledOnce).to.be.true; + }); + + it('jumps to headings in the active notebook and handles empty states', async () => { + const showInfoStub = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + const showQuickPickStub = sandbox.stub(vscode.window, 'showQuickPick'); + const showNotebookDocumentStub = sandbox.stub(vscode.window, 'showNotebookDocument').resolves(undefined); + + (vscode.window as any).activeNotebookEditor = undefined; + await notebookCommands.cmdJumpToSection(); + expect(showInfoStub.calledOnceWithExactly('No notebook is currently open.')).to.be.true; + + const revealRange = sandbox.stub(); + const notebook = { + getCells: () => [ + { kind: vscode.NotebookCellKind.Markup, document: { getText: () => '# Overview\nText' } }, + { kind: vscode.NotebookCellKind.Markup, document: { getText: () => '## Details\nMore' } }, + { kind: vscode.NotebookCellKind.Code, document: { getText: () => 'select 1;' } } + ], + uri: vscode.Uri.file('/nb') + } as any; + (vscode.window as any).activeNotebookEditor = { notebook, revealRange } as any; + + showQuickPickStub.resolves({ label: '$(symbol-namespace) Overview', detail: 'Cell 1', cellIndex: 0 } as any); + + await notebookCommands.cmdJumpToSection(); + expect(showInfoStub.calledOnce).to.be.true; + expect(showQuickPickStub.calledOnce).to.be.true; + expect(showNotebookDocumentStub.calledOnce).to.be.true; + expect(revealRange.calledOnce).to.be.true; + }); + + it('creates EXPLAIN query cells for analyze and non-analyze flows', async () => { + const showInfoStub = sandbox.stub(vscode.window, 'showInformationMessage').resolves(undefined); + const showErrorStub = sandbox.stub(vscode.window, 'showErrorMessage').resolves(undefined); + const originalApplyEdit = vscode.workspace.applyEdit; + const applyEditStub = sandbox.stub().resolves(true); + (vscode.workspace as any).applyEdit = applyEditStub; + + const cellUri = vscode.Uri.file('/nb/cell1'); + const notebook = { + metadata: { connectionId: 'c1' }, + uri: vscode.Uri.file('/nb'), + getCells: () => [ + { document: { uri: cellUri } } + ] + } as any; + + sandbox.stub(vscode.workspace, 'openTextDocument').resolves({ + getText: () => 'SELECT * FROM users;' + } as any); + (vscode.workspace as any).notebookDocuments = [notebook]; + + try { + await notebookCommands.cmdExplainQuery(cellUri, false); + await notebookCommands.cmdExplainQuery(cellUri, true); + } finally { + (vscode.workspace as any).applyEdit = originalApplyEdit; + } + + expect(applyEditStub.calledTwice).to.be.true; + expect(showInfoStub.calledTwice).to.be.true; + expect(showErrorStub.called).to.be.false; + }); +}); \ No newline at end of file diff --git a/src/test/unit/NotebookStatusBar.test.ts b/src/test/unit/NotebookStatusBar.test.ts new file mode 100644 index 0000000..ac839a3 --- /dev/null +++ b/src/test/unit/NotebookStatusBar.test.ts @@ -0,0 +1,186 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { NotebookStatusBar } from '../../activation/statusBar'; +import { ProfileManager } from '../../services/ProfileManager'; +import * as TransactionModule from '../../services/TransactionManager'; + +const extensionModule = require('../../extension'); + +function createContext(activeProfileContext?: any) { + return { + subscriptions: [], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: () => undefined, + update: async () => undefined + }, + globalState: { + get: (key: string, defaultValue?: T) => { + if (activeProfileContext && key === `activeProfile-${activeProfileContext.uri}`) { + return activeProfileContext.data as T; + } + + return defaultValue as T; + }, + update: async () => undefined + }, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +function createNotebookEditor(notebookType: string, metadata: any = {}, uri = 'nb:1'): vscode.NotebookEditor { + return { + notebook: { + notebookType, + metadata, + uri: { toString: () => uri } + } as any + } as vscode.NotebookEditor; +} + +describe('NotebookStatusBar', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (ProfileManager as any).instance = undefined; + (vscode.window as any).activeNotebookEditor = undefined; + }); + + afterEach(() => { + sandbox.restore(); + (ProfileManager as any).instance = undefined; + (vscode.window as any).activeNotebookEditor = undefined; + (extensionModule as any).extensionContext = undefined; + }); + + function createStatusBarItems() { + const items: any[] = []; + sandbox.stub(vscode.window, 'createStatusBarItem').callsFake(() => { + const item = { + text: '', + tooltip: '', + command: undefined, + backgroundColor: undefined, + show: sandbox.stub(), + hide: sandbox.stub(), + dispose: sandbox.stub() + }; + items.push(item); + return item as any; + }); + return items; + } + + it('hides items when no notebook is active and shows the no-connection state', () => { + const items = createStatusBarItems(); + sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + sandbox.stub(ProfileManager, 'getInstance').returns({ getProfiles: () => [] } as any); + sandbox.stub(TransactionModule, 'getTransactionManager').returns({ getTransactionInfo: () => null } as any); + sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: (_key: string, defaultValue?: T) => defaultValue as T + } as any); + + const context = createContext(); + extensionModule.extensionContext = context; + + const statusBar = new NotebookStatusBar(); + expect(items.every((item) => item.hide.called)).to.be.true; + + (vscode.window as any).activeNotebookEditor = createNotebookEditor('postgres-query', {}); + statusBar.update(); + + const [connectionItem, databaseItem, riskItem, profileItem, transactionItem] = items; + expect(connectionItem.text).to.equal('$(plug) Click to Connect'); + expect(connectionItem.backgroundColor.id).to.equal('statusBarItem.warningBackground'); + expect(connectionItem.show.called).to.be.true; + expect(databaseItem.hide.called).to.be.true; + expect(riskItem.hide.called).to.be.true; + expect(profileItem.hide.called).to.be.true; + + statusBar.updateTransactionState(); + expect(transactionItem.hide.called).to.be.true; + + statusBar.dispose(); + expect(connectionItem.dispose.called).to.be.true; + expect(databaseItem.dispose.called).to.be.true; + }); + + it('shows connection, profile, risk, and transaction indicators for an active notebook', () => { + const items = createStatusBarItems(); + const executeCommandStub = sandbox.stub(vscode.commands, 'executeCommand').resolves(undefined); + + const activeProfileContext = { + uri: 'nb:active', + data: { + profileId: 'profile-readonly-analyst', + readOnlyMode: true, + autoLimitSelectResults: 100 + } + }; + const context = createContext(activeProfileContext); + extensionModule.extensionContext = context; + + sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: (_key: string, defaultValue?: T) => ([{ + id: 'c1', + name: 'Primary', + host: 'localhost', + database: 'appdb', + environment: 'production', + readOnlyMode: true + }] as any) + } as any); + + sandbox.stub(ProfileManager, 'getInstance').returns({ + getProfiles: () => ([{ id: 'profile-readonly-analyst', profileName: 'Read Only Analyst' }]) + } as any); + + const txState: { current: any } = { current: null }; + sandbox.stub(TransactionModule, 'getTransactionManager').returns({ + getTransactionInfo: () => txState.current + } as any); + + (vscode.window as any).activeNotebookEditor = createNotebookEditor('postgres-notebook', { + connectionId: 'c1', + databaseName: 'appdb' + }, 'nb:active'); + + const statusBar = new NotebookStatusBar(); + const [connectionItem, databaseItem, riskItem, profileItem, transactionItem] = items; + + expect(connectionItem.text).to.equal('$(server) Primary'); + expect(databaseItem.text).to.equal('$(database) appdb'); + expect(connectionItem.backgroundColor.id).to.equal('statusBarItem.prominentBackground'); + expect(databaseItem.backgroundColor.id).to.equal('statusBarItem.prominentBackground'); + expect(riskItem.text).to.equal('$(shield) PROD (READ-ONLY)'); + expect(riskItem.tooltip).to.equal('Production environment - Read-only mode active'); + expect(profileItem.text).to.contain('Profile: Read Only Analyst'); + expect(profileItem.text).to.contain('Limit: 100'); + expect(executeCommandStub.calledWith('setContext', 'pgstudio.connectionName', 'Primary')).to.be.true; + expect(executeCommandStub.calledWith('setContext', 'pgstudio.databaseName', 'appdb')).to.be.true; + + statusBar.updateTransactionState(); + expect(transactionItem.hide.called).to.be.true; + + txState.current = { isActive: true }; + statusBar.updateTransactionState(); + expect(transactionItem.text).to.equal('$(sync~spin) Transaction open'); + expect(transactionItem.backgroundColor.id).to.equal('statusBarItem.warningBackground'); + expect(transactionItem.show.called).to.be.true; + + statusBar.dispose(); + expect(connectionItem.dispose.called).to.be.true; + expect(databaseItem.dispose.called).to.be.true; + expect(riskItem.dispose.called).to.be.true; + expect(profileItem.dispose.called).to.be.true; + expect(transactionItem.dispose.called).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/NotebookTitle.test.ts b/src/test/unit/NotebookTitle.test.ts new file mode 100644 index 0000000..457897a --- /dev/null +++ b/src/test/unit/NotebookTitle.test.ts @@ -0,0 +1,84 @@ +import { expect } from 'chai'; +import * as vscode from 'vscode'; + +import { deriveNotebookTitle, updateNotebookTitle } from '../../utils/notebookTitle'; + +function createCodeCell(text: string, index = 0): vscode.NotebookCell { + return new vscode.NotebookCell(new vscode.TextDocument(text), index, vscode.NotebookCellKind.Code); +} + +function createNotebook(path: string, metadata: any, ...cells: string[]): vscode.NotebookDocument { + const notebook = new vscode.NotebookDocument(vscode.Uri.file(path), metadata); + notebook.getCells = () => cells.map((text, index) => createCodeCell(text, index)); + return notebook; +} + +describe('notebook title helpers', () => { + it('derives a title from notebook SQL content', () => { + expect(deriveNotebookTitle(['SELECT * FROM public.users;'])).to.equal('View public.users'); + expect(deriveNotebookTitle(['SELECT id, name, email FROM a_table_with_a_very_long_select_statement_that_needs_truncation;'])) + .to.match(/^SELECT id, name, email FROM a_table_with_a_very_/); + expect(deriveNotebookTitle(['INSERT INTO public.users VALUES (1);'])).to.equal(''); + }); + + it('updates notebook metadata when the derived title changes', async () => { + const notebook = createNotebook('/workspace/customer-report.pgsql', {}, 'SELECT * FROM public.customers;'); + const previousApplyEdit = (vscode.workspace as any).applyEdit; + const calls: any[] = []; + (vscode.workspace as any).applyEdit = async (edit: any) => { + calls.push(edit); + return true; + }; + + try { + await updateNotebookTitle(notebook); + + expect(calls).to.have.lengthOf(1); + const edit = calls[0] as any; + const edits = Array.from(edit.map.values()) as any[]; + expect(edits).to.have.lengthOf(1); + expect(edits[0][0].metadata.title).to.equal('View public.customers'); + } finally { + (vscode.workspace as any).applyEdit = previousApplyEdit; + } + }); + + it('falls back to the notebook file name when there is no SELECT statement', async () => { + const notebook = createNotebook('/workspace/monthly-report.pgsql', {}, 'INSERT INTO public.customers VALUES (1);'); + const previousApplyEdit = (vscode.workspace as any).applyEdit; + const calls: any[] = []; + (vscode.workspace as any).applyEdit = async (edit: any) => { + calls.push(edit); + return true; + }; + + try { + await updateNotebookTitle(notebook); + + expect(calls).to.have.lengthOf(1); + const edit = calls[0] as any; + const edits = Array.from(edit.map.values()) as any[]; + expect(edits[0][0].metadata.title).to.equal('monthly-report'); + } finally { + (vscode.workspace as any).applyEdit = previousApplyEdit; + } + }); + + it('skips the edit when the current title already matches', async () => { + const notebook = createNotebook('/workspace/customer-report.pgsql', { title: 'View public.customers' }, 'SELECT * FROM public.customers;'); + const previousApplyEdit = (vscode.workspace as any).applyEdit; + const calls: any[] = []; + (vscode.workspace as any).applyEdit = async (edit: any) => { + calls.push(edit); + return true; + }; + + try { + await updateNotebookTitle(notebook); + + expect(calls).to.be.empty; + } finally { + (vscode.workspace as any).applyEdit = previousApplyEdit; + } + }); +}); \ No newline at end of file diff --git a/src/test/unit/PostgresKernel.test.ts b/src/test/unit/PostgresKernel.test.ts index d8d872c..55f40b3 100644 --- a/src/test/unit/PostgresKernel.test.ts +++ b/src/test/unit/PostgresKernel.test.ts @@ -172,8 +172,11 @@ describe('PostgresKernel', () => { expect(execution.end.calledWith(true)).to.be.true; expect(execution.appendOutput.called).to.be.true; - const notebookOut = execution.appendOutput.firstCall.args[0]; - expect(notebookOut.items[0].mime).to.equal('application/vnd.postgres-notebook.result'); + const allCalls = execution.appendOutput.getCalls(); + const notebookOut = allCalls.map((c: any) => c.args[0]).find((out: any) => + out.items[0].mime === 'application/vnd.postgres-notebook.result' + ); + expect(notebookOut).to.exist; const payload = JSON.parse(decodeCellOutputData(notebookOut.items[0].data)); expect(payload.rows[0].name).to.equal('Test'); }); @@ -207,7 +210,11 @@ describe('PostgresKernel', () => { await (kernel as any)._executor.executeCell(cell); const execution = controllerStub.createNotebookCellExecution.firstCall.returnValue; - const notebookOut = execution.appendOutput.firstCall.args[0]; + const allCalls = execution.appendOutput.getCalls(); + const notebookOut = allCalls.map((c: any) => c.args[0]).find((out: any) => + out.items[0].mime === 'application/vnd.postgres-notebook.result' + ); + expect(notebookOut).to.exist; const payload = JSON.parse(decodeCellOutputData(notebookOut.items[0].data)); expect(JSON.stringify(payload.rows[0].data)).to.contain('"foo":"bar"'); }); @@ -280,7 +287,11 @@ describe('PostgresKernel', () => { const execution = controllerStub.createNotebookCellExecution.firstCall.returnValue; expect(execution.end.calledWith(true)).to.be.true; - const notebookOut = execution.appendOutput.firstCall.args[0]; + const allCalls = execution.appendOutput.getCalls(); + const notebookOut = allCalls.map((c: any) => c.args[0]).find((out: any) => + out.items[0].mime === 'application/vnd.postgres-notebook.result' + ); + expect(notebookOut).to.exist; const payload = JSON.parse(decodeCellOutputData(notebookOut.items[0].data)); expect(payload.success).to.be.true; expect(payload.command).to.equal('CREATE'); @@ -356,7 +367,11 @@ describe('PostgresKernel', () => { const execution = controllerStub.createNotebookCellExecution.firstCall.returnValue; expect(execution.appendOutput.called).to.be.true; - const notebookOut = execution.appendOutput.firstCall.args[0]; + const allCalls = execution.appendOutput.getCalls(); + const notebookOut = allCalls.map((c: any) => c.args[0]).find((out: any) => + out.items[0].mime === 'application/vnd.postgres-notebook.error' + ); + expect(notebookOut).to.exist; expect(notebookOut.items[0].mime).to.equal('application/vnd.postgres-notebook.error'); const errPayload = JSON.parse(decodeCellOutputData(notebookOut.items[0].data)); expect(errPayload.success).to.equal(false); diff --git a/src/test/unit/ProfileManager.test.ts b/src/test/unit/ProfileManager.test.ts new file mode 100644 index 0000000..156a034 --- /dev/null +++ b/src/test/unit/ProfileManager.test.ts @@ -0,0 +1,120 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { ProfileManager } from '../../services/ProfileManager'; + +function createContext(initialProfiles: any[] = []) { + let profiles = [...initialProfiles]; + const update = sinon.stub().callsFake(async (_key: string, value: any) => { + profiles = value; + }); + + return { + subscriptions: [], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: (_key: string, defaultValue?: T) => defaultValue as T, + update: async () => undefined + }, + globalState: { + get: (key: string, defaultValue?: T) => { + if (key === 'postgres-explorer.connectionProfiles') { + return profiles as any; + } + + return defaultValue as T; + }, + update + }, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +describe('ProfileManager', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (ProfileManager as any).instance = undefined; + }); + + afterEach(() => { + sandbox.restore(); + (ProfileManager as any).instance = undefined; + }); + + it('creates the built-in profile set and suggests profiles by connection shape', async () => { + const context = createContext(); + const manager = ProfileManager.getInstance(); + manager.initialize(context); + + await manager.initializeDefaultProfiles(); + + expect(manager.getProfiles()).to.have.lengthOf(4); + expect(manager.suggestProfile({ environment: 'production', readOnlyMode: true } as any)?.id).to.equal('profile-prod-readonly'); + expect(manager.suggestProfile({ readOnlyMode: true } as any)?.id).to.equal('profile-readonly-analyst'); + expect(manager.suggestProfile({ environment: 'staging', readOnlyMode: false } as any)?.id).to.equal('profile-staging-dev'); + expect(manager.suggestProfile({ environment: 'development', readOnlyMode: false } as any)?.id).to.equal('profile-db-admin'); + expect((context.globalState.update as sinon.SinonStub).callCount).to.equal(4); + }); + + it('loads profiles from storage and applies them without replacing the base password', async () => { + const context = createContext([ + { + id: 'custom', + name: 'Custom Profile', + profileName: 'Custom Profile', + description: 'Custom role preset', + host: 'profile-host', + port: 6432, + environment: 'staging', + readOnlyMode: true, + password: 'profile-secret' + } + ]); + const manager = ProfileManager.getInstance(); + manager.initialize(context); + + expect(manager.getProfile('custom')).to.deep.include({ id: 'custom', profileName: 'Custom Profile' }); + + const baseConfig = { + id: 'connection-1', + host: 'base-host', + port: 5432, + username: 'postgres', + password: 'base-secret' + } as any; + + expect(manager.applyProfile(baseConfig, 'missing')).to.equal(baseConfig); + + const applied = manager.applyProfile(baseConfig, 'custom'); + expect(applied).to.include({ + id: 'custom', + host: 'profile-host', + port: 6432, + environment: 'staging', + readOnlyMode: true + }); + expect(applied.password).to.equal('base-secret'); + + await manager.initializeDefaultProfiles(); + expect(manager.getProfiles()).to.have.lengthOf(1); + + await manager.createProfile({ + id: 'extra', + name: 'Extra', + profileName: 'Extra', + host: 'extra-host', + port: 5432, + readOnlyMode: false + } as any); + await manager.deleteProfile('extra'); + + expect((context.globalState.update as sinon.SinonStub).callCount).to.equal(2); + }); +}); \ No newline at end of file diff --git a/src/test/unit/QueryAnalyzer.test.ts b/src/test/unit/QueryAnalyzer.test.ts new file mode 100644 index 0000000..a911d50 --- /dev/null +++ b/src/test/unit/QueryAnalyzer.test.ts @@ -0,0 +1,230 @@ +import { expect } from 'chai'; + +import { QueryAnalyzer } from '../../services/QueryAnalyzer'; + +describe('QueryAnalyzer', () => { + const analyzer = QueryAnalyzer.getInstance(); + + it('returns the singleton instance', () => { + expect(QueryAnalyzer.getInstance()).to.equal(analyzer); + }); + + it('detects destructive operations and computes confirmation rules', () => { + const production = { environment: 'production' } as any; + + const dropResult = analyzer.analyzeQuery('-- comment\nDROP TABLE IF EXISTS public.users;', production); + expect(dropResult.isDangerous).to.be.true; + expect(dropResult.operations).to.have.lengthOf(1); + expect(dropResult.operations[0]).to.include({ + type: 'DROP', + severity: 'critical', + hasWhereClause: false, + estimatedImpact: 'Permanent data loss' + }); + expect(dropResult.operations[0].affectedObjects).to.deep.equal(['public.users']); + expect(dropResult.riskScore).to.equal(80); + expect(dropResult.requiresConfirmation).to.be.true; + expect(dropResult.warningMessage).to.contain('PRODUCTION DATABASE'); + expect(dropResult.warningMessage).to.contain('Dropping table: public.users'); + + const truncateResult = analyzer.analyzeQuery('TRUNCATE TABLE audit_log'); + expect(truncateResult.operations[0]).to.include({ + type: 'TRUNCATE', + severity: 'critical', + hasWhereClause: false, + estimatedImpact: 'All rows will be deleted' + }); + expect(truncateResult.riskScore).to.equal(40); + expect(truncateResult.requiresConfirmation).to.be.true; + + const insertResult = analyzer.analyzeQuery('INSERT INTO public.events (id) VALUES (1)'); + expect(insertResult.operations[0]).to.include({ + type: 'INSERT', + severity: 'medium', + hasWhereClause: false, + estimatedImpact: 'New rows will be added' + }); + expect(insertResult.riskScore).to.equal(10); + expect(insertResult.requiresConfirmation).to.be.false; + + const alterResult = analyzer.analyzeQuery('ALTER TABLE public.users ADD COLUMN active boolean'); + expect(alterResult.operations[0]).to.include({ + type: 'ALTER', + severity: 'high', + hasWhereClause: false, + estimatedImpact: 'Schema changes may affect dependent objects' + }); + expect(alterResult.riskScore).to.equal(25); + expect(alterResult.requiresConfirmation).to.be.false; + + const createResult = analyzer.analyzeQuery('CREATE TABLE public.logs (id int)', production); + expect(createResult.operations[0]).to.include({ + type: 'CREATE', + severity: 'medium', + hasWhereClause: false, + estimatedImpact: 'New database object will be created' + }); + expect(createResult.riskScore).to.equal(20); + expect(createResult.requiresConfirmation).to.be.true; + + const grantResult = analyzer.analyzeQuery('GRANT SELECT ON public.users TO analyst', production); + expect(grantResult.operations[0]).to.include({ + type: 'GRANT', + severity: 'medium', + hasWhereClause: false, + estimatedImpact: 'Permission changes' + }); + expect(grantResult.requiresConfirmation).to.be.true; + + const revokeResult = analyzer.analyzeQuery('REVOKE UPDATE ON public.users FROM analyst'); + expect(revokeResult.operations[0]).to.include({ + type: 'REVOKE', + severity: 'medium', + hasWhereClause: false, + estimatedImpact: 'Permission changes' + }); + expect(revokeResult.requiresConfirmation).to.be.false; + }); + + it('distinguishes write queries with and without WHERE clauses', () => { + const production = { environment: 'production' } as any; + + const deleteWithoutWhere = analyzer.analyzeQuery('DELETE FROM public.users'); + expect(deleteWithoutWhere.operations[0]).to.include({ + type: 'DELETE', + severity: 'critical', + hasWhereClause: false + }); + expect(deleteWithoutWhere.riskScore).to.equal(40); + expect(deleteWithoutWhere.requiresConfirmation).to.be.true; + + const deleteWithWhere = analyzer.analyzeQuery('DELETE FROM public.users WHERE id = 1'); + expect(deleteWithWhere.operations[0]).to.include({ + type: 'DELETE', + severity: 'medium', + hasWhereClause: true + }); + expect(deleteWithWhere.riskScore).to.equal(10); + expect(deleteWithWhere.requiresConfirmation).to.be.false; + + const updateWithoutWhere = analyzer.analyzeQuery('UPDATE public.users SET active = false', production); + expect(updateWithoutWhere.operations[0]).to.include({ + type: 'UPDATE', + severity: 'high', + hasWhereClause: false + }); + expect(updateWithoutWhere.riskScore).to.equal(50); + expect(updateWithoutWhere.requiresConfirmation).to.be.true; + + const updateWithWhere = analyzer.analyzeQuery('UPDATE public.users SET active = false WHERE id = 1', production); + expect(updateWithWhere.operations[0]).to.include({ + type: 'UPDATE', + severity: 'medium', + hasWhereClause: true + }); + expect(updateWithWhere.riskScore).to.equal(20); + expect(updateWithWhere.requiresConfirmation).to.be.false; + }); + + it('recognizes read-only queries after stripping comments and whitespace', () => { + expect(analyzer.isReadOnlyQuery('/* update */\nSELECT 1;')).to.be.true; + expect(analyzer.isReadOnlyQuery('-- drop table users\nSELECT 1;')).to.be.true; + expect(analyzer.isReadOnlyQuery('INSERT INTO users (id) VALUES (1);')).to.be.false; + }); + + it('extracts execution-plan metrics and recommendations', () => { + const explainPlan = [ + { + Planning: {}, + Buffers: { 'Shared Hit Blocks': 10, 'Shared Read Blocks': 5 }, + 'Planning Time': 12.5, + 'Execution Time': 45.25, + Plan: { + 'Node Type': 'Seq Scan', + 'Total Cost': 20000, + 'Plan Rows': 100, + 'Actual Rows': 20, + 'Actual Total Time': 1500, + Plans: [ + { + 'Node Type': 'Index Scan', + 'Plan Rows': 5, + 'Actual Rows': 5, + 'Actual Total Time': 10 + } + ] + } + } + ]; + + const metrics = analyzer.extractPlanMetrics(explainPlan); + expect(metrics).to.not.equal(null); + expect(metrics?.totalCost).to.equal(20000); + expect(metrics?.planningTime).to.equal(12.5); + expect(metrics?.executionTime).to.equal(45.25); + expect(metrics?.sequentialScans).to.equal(1); + expect(metrics?.indexScans).to.equal(1); + expect(metrics?.bufferStats?.bufferHits).to.equal(10); + expect(metrics?.bufferStats?.bufferReads).to.equal(5); + expect(metrics?.bufferStats?.hitRatio).to.be.closeTo(66.6667, 0.001); + expect(metrics?.bottlenecks.some(entry => entry.includes('Row estimation mismatch in Seq Scan'))).to.be.true; + expect(metrics?.bottlenecks.some(entry => entry.includes('Seq Scan took 1500.00ms'))).to.be.true; + expect(metrics?.recommendations).to.include('Query planning cost is high; consider simplifying the query or analyzing table statistics'); + expect(metrics?.recommendations).to.include('Low buffer hit ratio; consider increasing work_mem or improving indexes'); + expect(metrics?.recommendations.some(entry => entry.startsWith('Review bottlenecks: '))).to.be.true; + + expect(analyzer.extractPlanMetrics(null)).to.equal(null); + expect(analyzer.extractPlanMetrics({})).to.equal(null); + }); + + it('hashes normalized queries consistently and compares performance against baselines', () => { + const hashA = analyzer.getQueryHash('SELECT * FROM users WHERE id = 1'); + const hashB = analyzer.getQueryHash(' select * from users where id = 999 '); + const hashC = analyzer.getQueryHash('SELECT * FROM users WHERE id = 1 -- comment'); + + expect(hashA).to.equal(hashB); + expect(hashA).to.equal(hashC); + + const explainPlan = { + Plan: { + 'Node Type': 'Seq Scan', + 'Total Cost': 100, + 'Plan Rows': 10, + 'Actual Rows': 10, + 'Actual Total Time': 5, + } + }; + + const noBaseline = analyzer.analyzePerformanceAgainstBaseline(120, null, explainPlan); + expect(noBaseline.isDegraded).to.be.false; + expect(noBaseline.baseline).to.equal(null); + expect(noBaseline.metrics?.sequentialScans).to.equal(1); + expect(noBaseline.analysis).to.contain('No baseline available for comparison'); + + const degraded = analyzer.analyzePerformanceAgainstBaseline(150, { + queryHash: hashA, + avgExecutionTime: 100, + minExecutionTime: 80, + maxExecutionTime: 120, + stdDev: 5, + sampleCount: 4, + lastUpdated: Date.now() + }, explainPlan); + expect(degraded.isDegraded).to.be.true; + expect(degraded.degradationPercent).to.equal(50); + expect(degraded.analysis).to.contain('Performance degradation detected: 50% slower than baseline'); + + const withinBaseline = analyzer.analyzePerformanceAgainstBaseline(110, { + queryHash: hashA, + avgExecutionTime: 100, + minExecutionTime: 80, + maxExecutionTime: 120, + stdDev: 5, + sampleCount: 4, + lastUpdated: Date.now() + }, explainPlan); + expect(withinBaseline.isDegraded).to.be.false; + expect(withinBaseline.degradationPercent).to.equal(0); + expect(withinBaseline.analysis).to.contain('Query performance is within baseline'); + }); +}); \ No newline at end of file diff --git a/src/test/unit/QueryCodeLensProvider.test.ts b/src/test/unit/QueryCodeLensProvider.test.ts new file mode 100644 index 0000000..e300c09 --- /dev/null +++ b/src/test/unit/QueryCodeLensProvider.test.ts @@ -0,0 +1,102 @@ +import { expect } from 'chai'; +import * as vscode from 'vscode'; + +import { QueryCodeLensProvider } from '../../providers/QueryCodeLensProvider'; + +function createNotebookCellDocument( + text: string, + languageId: 'sql' | 'postgres' = 'sql', + uriSuffix = 'cell-1' +) { + return new vscode.TextDocument( + text, + vscode.Uri.parse(`vscode-notebook-cell:/query-code-lens/${uriSuffix}`), + languageId + ); +} + +function attachNotebookForDocument(document: vscode.TextDocument, metadata: any = { connectionId: 'conn-1', databaseName: 'appdb' }) { + const notebook = new vscode.NotebookDocument(vscode.Uri.file('/workspace/query-notebook.pgsql'), metadata); + const cell = new vscode.NotebookCell(document, 0, vscode.NotebookCellKind.Code); + notebook.getCells = () => [cell]; + vscode.workspace.notebookDocuments = [notebook]; + return notebook; +} + +describe('QueryCodeLensProvider', () => { + afterEach(() => { + (QueryCodeLensProvider as any)._instance = undefined; + vscode.workspace.notebookDocuments = []; + }); + + it('tracks singleton state and fires change events', () => { + const provider = new QueryCodeLensProvider(); + QueryCodeLensProvider.setInstance(provider); + + expect(QueryCodeLensProvider.getInstance()).to.equal(provider); + + let changeCount = 0; + const listener = provider.onDidChangeCodeLenses(() => { + changeCount += 1; + }); + + const cellUri = 'vscode-notebook-cell:/query-code-lens/cell-1'; + provider.setAiWorking(cellUri, true); + expect(provider.isAiWorking(cellUri)).to.be.true; + + provider.updatePill(cellUri, { success: true, elapsedSeconds: 1.4, rowCount: 3 }); + provider.refresh(); + provider.setAiWorking(cellUri, false); + + expect(provider.isAiWorking(cellUri)).to.be.false; + expect(changeCount).to.equal(4); + + listener.dispose(); + }); + + it('returns no lenses for unsupported documents', () => { + const provider = new QueryCodeLensProvider(); + + expect(provider.provideCodeLenses(createNotebookCellDocument('', 'sql') as any, {} as any)).to.deep.equal([]); + expect( + provider.provideCodeLenses( + new vscode.TextDocument('SELECT 1', vscode.Uri.file('/tmp/query.sql'), 'sql') as any, + {} as any + ) + ).to.deep.equal([]); + expect( + provider.provideCodeLenses( + createNotebookCellDocument('SELECT 1', 'postgres'), + {} as any + ) + ).to.have.lengthOf(4); + }); + + it('builds lenses for runnable queries and hides explain for explain statements', () => { + const provider = new QueryCodeLensProvider(); + + const queryDocument = createNotebookCellDocument('SELECT u.user_id, o.order_total FROM public.users u JOIN sales.orders o ON o.user_id = u.user_id;'); + attachNotebookForDocument(queryDocument); + + provider.setAiWorking(queryDocument.uri.toString(), true); + provider.updatePill(queryDocument.uri.toString(), { success: true, elapsedSeconds: 12, rowCount: 99 }); + + const queryLenses = provider.provideCodeLenses(queryDocument, {} as any); + expect(queryLenses).to.have.lengthOf(5); + expect(queryLenses[0].command?.title).to.equal('$(loading~spin) Working...'); + expect(queryLenses[0].command?.command).to.equal(''); + expect(queryLenses[1].command?.title).to.equal('◻ Chat'); + expect(queryLenses[2].command?.title).to.equal('⊞ Save Query'); + expect(queryLenses[3].command?.title).to.equal('⟐ Explain Analyze'); + expect(queryLenses[3].command?.arguments).to.deep.equal([queryDocument.uri, true]); + expect(queryLenses[4].command?.title).to.equal('12s · 99 rows'); + expect(queryLenses[4].command?.command).to.equal(''); + + const explainDocument = createNotebookCellDocument('EXPLAIN SELECT 1;', 'sql', 'cell-2'); + attachNotebookForDocument(explainDocument); + + const explainLenses = provider.provideCodeLenses(explainDocument, {} as any); + expect(explainLenses).to.have.lengthOf(3); + expect(explainLenses.map(lens => lens.command?.title)).to.deep.equal(['✦ Ask AI', '◻ Chat', '⊞ Save Query']); + }); +}); \ No newline at end of file diff --git a/src/test/unit/QueryHandlers.additional.test.ts b/src/test/unit/QueryHandlers.additional.test.ts index 90d3554..207bf16 100644 --- a/src/test/unit/QueryHandlers.additional.test.ts +++ b/src/test/unit/QueryHandlers.additional.test.ts @@ -5,6 +5,7 @@ import { ErrorHandlers } from '../../commands/helper'; import { ConnectionManager } from '../../services/ConnectionManager'; import { ConnectionUtils } from '../../utils/connectionUtils'; import { + FkLookupHandler, ExecuteUpdateBackgroundHandler, ExecuteUpdateHandler, DeleteRowsHandler, @@ -70,6 +71,117 @@ describe('QueryHandlers (additional error branches)', () => { expect((vscode.window.showErrorMessage as any).called).to.be.true; }); + it('FkLookupHandler posts matching rows and clamps the limit', async () => { + const query = sandbox.stub().resolves({ + rows: [{ id: 1, name: 'Ada' }], + fields: [{ name: 'id' }, { name: 'name' }] + }); + const release = sandbox.stub(); + sandbox.stub(ConnectionManager, 'getInstance').returns({ + getPooledClient: sandbox.stub().resolves({ query, release }) + } as any); + sandbox.stub(ConnectionUtils, 'findConnection').returns({ + id: 'conn-1', + host: 'localhost', + port: 5432, + username: 'postgres', + database: 'postgres' + } as any); + const postMessage = sandbox.stub().resolves(true); + + const handler = new FkLookupHandler(); + await handler.handle( + { + requestId: 'req-1', + fkSchema: 'public', + fkTable: 'users', + fkColumn: 'name', + searchText: ' Ada ', + limit: 250 + }, + { + editor: { + notebook: { + metadata: { + connectionId: 'conn-1', + databaseName: 'postgres' + } + } + } as any, + postMessage + } + ); + + expect(query.calledOnce).to.be.true; + const [sql, params] = query.firstCall.args; + expect(sql).to.contain('SELECT "name"'); + expect(sql).to.contain('FROM "public"."users"'); + expect(sql).to.contain('ILIKE $2'); + expect(params).to.deep.equal(['Ada', '%Ada%', 100]); + expect(postMessage.calledOnceWithMatch({ + type: 'fkLookupResponse', + requestId: 'req-1', + rows: [{ id: 1, name: 'Ada' }], + columns: ['id', 'name'] + })).to.be.true; + expect(release.calledOnce).to.be.true; + }); + + it('FkLookupHandler returns an empty response when connection lookup fails', async () => { + sandbox.stub(ConnectionUtils, 'findConnection').returns(undefined); + const postMessage = sandbox.stub().resolves(true); + + const handler = new FkLookupHandler(); + await handler.handle( + { + requestId: 'req-2', + fkSchema: 'public', + fkTable: 'users', + fkColumn: 'name', + searchText: 'Ada', + limit: 10 + }, + { + editor: { + notebook: { + metadata: { + connectionId: 'conn-1', + databaseName: 'postgres' + } + } + } as any, + postMessage + } + ); + + expect(postMessage.calledOnceWithMatch({ + type: 'fkLookupResponse', + requestId: 'req-2', + rows: [], + columns: [] + })).to.be.true; + expect((vscode.window.showErrorMessage as sinon.SinonStub).calledWith(sinon.match(/^FK lookup failed:/))).to.be + .true; + }); + + it('FkLookupHandler ignores requests without an editor or connection metadata', async () => { + const handler = new FkLookupHandler(); + const postMessage = sandbox.stub(); + + await handler.handle({ requestId: 'req-3' }, {} as any); + await handler.handle( + { requestId: 'req-4' }, + { + editor: { + notebook: { metadata: {} } + } as any, + postMessage + } + ); + + expect(postMessage.called).to.be.false; + }); + it('handlers return early when no editor provided', async () => { // Call handlers with empty context to hit early return branches await new ExecuteUpdateBackgroundHandler().handle({}, {} as any); diff --git a/src/test/unit/QueryHistoryService.test.ts b/src/test/unit/QueryHistoryService.test.ts new file mode 100644 index 0000000..8daa44c --- /dev/null +++ b/src/test/unit/QueryHistoryService.test.ts @@ -0,0 +1,93 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { QueryHistoryService } from '../../services/QueryHistoryService'; + +function createStorage(initialHistory: any[] = []) { + let history = [...initialHistory]; + const update = sinon.stub().callsFake(async (_key: string, value: any) => { + history = value; + }); + + return { + get: (key: string, defaultValue?: T) => { + if (key === 'postgres-explorer.queryHistory') { + return history as any; + } + + return defaultValue as T; + }, + update, + getHistory: () => history + } as any; +} + +describe('QueryHistoryService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (QueryHistoryService as any).instance = undefined; + }); + + afterEach(() => { + sandbox.restore(); + (QueryHistoryService as any).instance = undefined; + }); + + it('adds, deletes, and clears history entries while firing change events', async () => { + expect(() => QueryHistoryService.getInstance()).to.throw('QueryHistoryService not initialized'); + + const storage = createStorage(); + QueryHistoryService.initialize(storage); + const service = QueryHistoryService.getInstance(); + const changed = sandbox.spy(); + service.onDidChangeHistory(changed); + + sandbox.useFakeTimers({ now: 1_000 }); + + await service.add({ query: 'select 1', success: true, durationMs: 25, rowCount: 1, connectionName: 'Primary' }); + await service.add({ query: 'select 2', success: false, duration: 2, slow: true }); + + expect(service.getHistory()).to.have.lengthOf(2); + expect(service.getHistory()[0]).to.include({ query: 'select 2', success: false, slow: true }); + expect(changed.callCount).to.equal(2); + + const newestId = service.getHistory()[0].id; + await service.delete(newestId); + expect(service.getHistory()).to.have.lengthOf(1); + expect(changed.callCount).to.equal(3); + + await service.clear(); + expect(service.getHistory()).to.deep.equal([]); + expect(changed.callCount).to.equal(4); + }); + + it('trims to the maximum history size and computes trend statistics', async () => { + const storage = createStorage(); + QueryHistoryService.initialize(storage); + const service = QueryHistoryService.getInstance(); + + sandbox.useFakeTimers({ now: 10_000 }); + + for (let index = 0; index < 101; index++) { + await service.add({ + query: `select ${index}`, + success: index % 2 === 0, + durationMs: index === 100 ? undefined : index + 1, + duration: index === 100 ? 2 : undefined, + rowCount: index, + slow: index % 10 === 0 + }); + } + + expect(service.getHistory()).to.have.lengthOf(100); + expect(service.getHistory()[0].query).to.equal('select 100'); + + const stats = service.getTrendStats(); + expect(stats.total).to.equal(100); + expect(stats.avgMs).to.be.greaterThan(0); + expect(stats.successRate).to.be.greaterThan(0); + expect(stats.slowRate).to.be.greaterThan(0); + }); +}); \ No newline at end of file diff --git a/src/test/unit/QueryPerformanceService.test.ts b/src/test/unit/QueryPerformanceService.test.ts new file mode 100644 index 0000000..229e127 --- /dev/null +++ b/src/test/unit/QueryPerformanceService.test.ts @@ -0,0 +1,93 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { QueryPerformanceService } from '../../services/QueryPerformanceService'; +import { QueryBaseline } from '../../services/QueryAnalyzer'; + +function createStorage(initialBaselines: Record = {}) { + const data: Record = { + 'postgres-explorer.queryPerformanceBaselines': initialBaselines + }; + const update = sinon.stub().callsFake(async (key: string, value: any) => { + data[key] = value; + }); + + return { + get: (key: string, defaultValue?: T) => (key in data ? data[key] : defaultValue as T), + update, + data + } as any; +} + +describe('QueryPerformanceService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (QueryPerformanceService as any).instance = undefined; + }); + + afterEach(() => { + sandbox.restore(); + (QueryPerformanceService as any).instance = undefined; + }); + + it('loads baselines, records execution timing, and clears cached baselines', async () => { + expect(() => QueryPerformanceService.getInstance()).to.throw('QueryPerformanceService not initialized'); + + const storage = createStorage({ + existing: { + queryHash: 'existing', + avgExecutionTime: 100, + minExecutionTime: 80, + maxExecutionTime: 120, + stdDev: 0, + sampleCount: 2, + lastUpdated: 500 + } + }); + + QueryPerformanceService.initialize(storage); + const service = QueryPerformanceService.getInstance(); + + expect(service.getBaseline('missing')).to.equal(null); + expect(service.getBaseline('existing')).to.deep.equal({ + queryHash: 'existing', + avgExecutionTime: 100, + minExecutionTime: 80, + maxExecutionTime: 120, + stdDev: 0, + sampleCount: 2, + lastUpdated: 500 + }); + + sandbox.useFakeTimers({ now: 2_000 }); + + await service.recordExecution('existing', 50); + const updated = service.getBaseline('existing'); + expect(updated).to.deep.include({ + queryHash: 'existing', + minExecutionTime: 50, + maxExecutionTime: 120, + sampleCount: 3, + lastUpdated: 2_000 + }); + expect(updated?.avgExecutionTime).to.be.closeTo(83.333, 0.001); + + await service.recordExecution('new-hash', 30); + expect(service.getBaseline('new-hash')).to.deep.equal({ + queryHash: 'new-hash', + avgExecutionTime: 30, + minExecutionTime: 30, + maxExecutionTime: 30, + stdDev: 0, + sampleCount: 1, + lastUpdated: 2_000 + }); + + await service.clear(); + expect(service.getBaseline('existing')).to.equal(null); + expect(storage.data['postgres-explorer.queryPerformanceBaselines']).to.deep.equal({}); + expect((storage.update as sinon.SinonStub).callCount).to.equal(3); + }); +}); \ No newline at end of file diff --git a/src/test/unit/RendererSurface.test.ts b/src/test/unit/RendererSurface.test.ts new file mode 100644 index 0000000..5b1e0b5 --- /dev/null +++ b/src/test/unit/RendererSurface.test.ts @@ -0,0 +1,209 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import { JSDOM } from 'jsdom'; + +import { createActionBar } from '../../renderer/components/ActionBar'; +import { createErrorPanel } from '../../renderer/components/ErrorPanel'; +import { createTopBar } from '../../renderer/components/TopBar'; +import { createTransactionBanner } from '../../renderer/components/TransactionBanner'; +import { createBreadcrumb, createButton, createTab } from '../../renderer/components/ui'; + +describe('renderer surface components', () => { + let dom: JSDOM; + let windowRef: any; + let documentRef: any; + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + dom = new JSDOM('', { url: 'http://localhost/' }); + windowRef = dom.window; + documentRef = windowRef.document; + + (global as any).window = windowRef; + (global as any).document = documentRef; + (global as any).HTMLElement = windowRef.HTMLElement; + (global as any).MouseEvent = windowRef.MouseEvent; + (global as any).Event = windowRef.Event; + }); + + afterEach(() => { + sandbox.restore(); + dom.window.close(); + }); + + it('creates reusable buttons, tabs, and breadcrumbs', () => { + const button = createButton('Save'); + expect(button.innerText).to.equal('Save'); + expect(button.style.padding).to.equal('6px 12px'); + button.onmouseover?.(new windowRef.Event('mouseover') as any); + expect(button.style.background).to.contain('var(--vscode-button-secondaryHoverBackground)'); + button.onmouseout?.(new windowRef.Event('mouseout') as any); + expect(button.style.background).to.contain('var(--vscode-button-secondaryBackground)'); + + const smallButton = createButton('Small', true); + expect(smallButton.style.padding).to.equal('4px 8px'); + expect(smallButton.style.fontSize).to.equal('11px'); + + const tabClick = sandbox.spy(); + const activeTab = createTab('SQL', 'sql-tab', true, tabClick); + expect(activeTab.textContent).to.equal('SQL'); + expect(activeTab.style.opacity).to.equal('1'); + activeTab.click(); + expect(tabClick.calledOnce).to.be.true; + + const inactiveTab = createTab('History', 'history-tab', false, () => {}); + expect(inactiveTab.style.opacity).to.equal('0.6'); + + const connectionDropdown = sandbox.spy(); + const databaseDropdown = sandbox.spy(); + const breadcrumb = createBreadcrumb( + [ + { label: 'Local', id: 'connection', type: 'connection' }, + { label: 'postgres', id: 'database', type: 'database' }, + { label: 'public', id: 'schema', type: 'schema' }, + { label: 'users', id: 'object', type: 'object', isLast: true }, + ], + { onConnectionDropdown: connectionDropdown, onDatabaseDropdown: databaseDropdown } + ); + + expect(breadcrumb.children).to.have.lengthOf(7); + expect(breadcrumb.children[0].textContent).to.contain('🗄️'); + expect(breadcrumb.children[2].textContent).to.contain('🗃️'); + (breadcrumb.children[0] as HTMLElement).click(); + (breadcrumb.children[2] as HTMLElement).click(); + expect(connectionDropdown.calledOnce).to.be.true; + expect(databaseDropdown.calledOnce).to.be.true; + }); + + it('creates error panels and action bars with working callbacks', () => { + const explain = sandbox.spy(); + const fix = sandbox.spy(); + const retry = sandbox.spy(); + + const panel = createErrorPanel({ + errorCode: '23505', + errorMessage: 'duplicate key value', + explanation: 'The row already exists.', + onExplainError: explain, + onFixWithAI: fix, + onRetry: retry, + }); + + expect(panel.textContent).to.contain('ERROR 23505'); + expect(panel.textContent).to.contain('The row already exists.'); + expect(panel.querySelectorAll('button')).to.have.lengthOf(3); + panel.querySelectorAll('button')[0].click(); + panel.querySelectorAll('button')[1].click(); + panel.querySelectorAll('button')[2].click(); + expect(explain.calledOnce).to.be.true; + expect(fix.calledOnce).to.be.true; + expect(retry.calledOnce).to.be.true; + + const minimalPanel = createErrorPanel({ + errorMessage: 'simple failure', + onExplainError: () => {}, + onFixWithAI: () => {}, + onRetry: () => {}, + }); + expect(minimalPanel.querySelector('p')).to.be.null; + + const selectAll = sandbox.spy(); + const copy = sandbox.spy(); + const importData = sandbox.spy(); + const exportData = sandbox.spy(); + const sendToChat = sandbox.spy(); + const analyze = sandbox.spy(); + const optimize = sandbox.spy(); + + const actionBar = createActionBar({ + onSelectAll: selectAll, + onCopy: copy, + onImport: importData, + onExport: exportData, + onSendToChat: sendToChat, + onAnalyzeWithAI: analyze, + onOptimize: optimize, + }); + + const buttons = Array.from(actionBar.querySelectorAll('button')) as HTMLButtonElement[]; + expect(buttons.map(btn => btn.textContent)).to.deep.equal([ + '☐ Select All', + '⎘ Copy', + '⬆ Import', + '↓ Export', + '✦ Send to Chat', + '◎ Analyze with AI', + '⚡ Optimize', + ]); + buttons[0].click(); + buttons[1].click(); + buttons[2].click(); + buttons[3].click(); + buttons[4].click(); + buttons[5].click(); + buttons[6].click(); + expect(selectAll.calledOnce).to.be.true; + expect(copy.calledOnce).to.be.true; + expect(importData.calledOnce).to.be.true; + expect(exportData.calledOnce).to.be.true; + expect(exportData.firstCall.args[0]).to.equal(buttons[3]); + expect(sendToChat.calledOnce).to.be.true; + expect(analyze.calledOnce).to.be.true; + expect(optimize.calledOnce).to.be.true; + }); + + it('creates top bars and transaction banners', () => { + const postMessage = sandbox.spy(); + const connectedTopBar = createTopBar( + { + connectionName: 'Local DB', + host: 'localhost', + database: 'app', + isConnected: true, + onRunAll: sandbox.spy(), + onClearOutputs: sandbox.spy(), + onAddCodeCell: sandbox.spy(), + onAddMarkdownCell: sandbox.spy(), + }, + postMessage + ); + + expect(documentRef.getElementById('topbar-disconnected-style')).to.exist; + expect(connectedTopBar.textContent).to.contain('Local DB · app'); + const connectionPill = connectedTopBar.lastElementChild as HTMLButtonElement; + expect(connectionPill.title).to.contain('Host: localhost'); + connectionPill.click(); + expect(postMessage.calledOnceWithExactly({ type: 'showConnectionInfo' })).to.be.true; + + const disconnectedTopBar = createTopBar( + { + connectionName: 'Local DB', + host: 'localhost', + database: 'app', + isConnected: false, + onRunAll: sandbox.spy(), + onClearOutputs: sandbox.spy(), + onAddCodeCell: sandbox.spy(), + onAddMarkdownCell: sandbox.spy(), + }, + sandbox.spy() + ); + expect(disconnectedTopBar.textContent).to.contain('Not connected'); + expect(disconnectedTopBar.querySelector('.topbar-dot-disconnected')).to.exist; + + const commit = sandbox.spy(); + const rollback = sandbox.spy(); + const singularBanner = createTransactionBanner({ statementCount: 1, onCommit: commit, onRollback: rollback }); + const pluralBanner = createTransactionBanner({ statementCount: 2, onCommit: commit, onRollback: rollback }); + + expect(documentRef.getElementById('transaction-banner-pulse-amber')).to.exist; + expect(singularBanner.textContent).to.contain('1 statement'); + expect(pluralBanner.textContent).to.contain('2 statements'); + (singularBanner.querySelectorAll('button')[0] as HTMLButtonElement).click(); + (singularBanner.querySelectorAll('button')[1] as HTMLButtonElement).click(); + expect(commit.calledOnce).to.be.true; + expect(rollback.calledOnce).to.be.true; + expect(singularBanner.dataset.transactionBanner).to.equal('true'); + }); +}); \ No newline at end of file diff --git a/src/test/unit/SavedQueriesService.test.ts b/src/test/unit/SavedQueriesService.test.ts new file mode 100644 index 0000000..80344b0 --- /dev/null +++ b/src/test/unit/SavedQueriesService.test.ts @@ -0,0 +1,150 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { SavedQueriesService, SavedQuery } from '../../services/SavedQueriesService'; + +function createContext(initialQueries: SavedQuery[] = []) { + const state = new Map([['postgres-explorer.savedQueries', initialQueries]]); + const update = sinon.stub().callsFake(async (key: string, value: any) => { + state.set(key, value); + }); + + return { + subscriptions: [], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: (key: string, defaultValue?: T) => (state.has(key) ? state.get(key) : defaultValue as T), + update + }, + globalState: { + get: (_key: string, defaultValue?: T) => defaultValue as T, + update: async () => undefined + }, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +describe('SavedQueriesService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (SavedQueriesService as any).instance = undefined; + }); + + afterEach(() => { + sandbox.restore(); + (SavedQueriesService as any).instance = undefined; + }); + + it('loads existing queries and persists save, update, delete, and usage changes', async () => { + const context = createContext([ + { + id: 'stored', + title: 'Stored query', + query: 'select 1', + description: 'Older saved query', + tags: ['ops'], + createdAt: 100, + usageCount: 1 + } + ]); + const service = SavedQueriesService.getInstance(); + service.initialize(context); + + expect(service.getQueries()).to.have.lengthOf(1); + + const clock = sandbox.useFakeTimers({ now: 1_000 }); + + await service.saveQuery({ + id: '', + title: 'New query', + query: 'select 2', + description: 'Fresh query', + tags: ['ops', 'analytics'], + usageCount: 0 + } as any); + + const [savedQuery] = service.getQueries(); + expect(savedQuery.title).to.equal('New query'); + expect(savedQuery.id).to.match(/^query_/); + expect(savedQuery.createdAt).to.equal(1_000); + + await service.updateQuery({ ...savedQuery, title: 'Renamed query' } as any); + expect(service.getQuery(savedQuery.id)?.createdAt).to.equal(1_000); + + await service.recordUsage(savedQuery.id); + expect(service.getQuery(savedQuery.id)?.usageCount).to.equal(1); + expect(service.getQuery(savedQuery.id)?.lastUsed).to.equal(1_000); + + await service.deleteQuery('stored'); + expect(service.getQuery('stored')).to.equal(undefined); + + expect((context.workspaceState.update as sinon.SinonStub).callCount).to.be.greaterThan(0); + clock.restore(); + }); + + it('filters, sorts, exports, and imports query collections', async () => { + const context = createContext([ + { + id: 'recent', + title: 'Recent maintenance', + query: 'select 1', + description: 'Archive stats report', + tags: ['maintenance', 'analytics'], + createdAt: 100, + lastUsed: 300, + usageCount: 2 + }, + { + id: 'old', + title: 'Old ops query', + query: 'select 2', + tags: ['ops', 'maintenance'], + createdAt: 200, + usageCount: 5 + }, + { + id: 'most-used', + title: 'Popular query', + query: 'select 3', + tags: ['analytics'], + createdAt: 150, + usageCount: 10 + } + ]); + const service = SavedQueriesService.getInstance(); + service.initialize(context); + + expect(service.getQueriesByTag('maintenance').map((query) => query.id)).to.deep.equal(['recent', 'old']); + expect(service.searchQueries('archive').map((query) => query.id)).to.deep.equal(['recent']); + expect(service.getMostUsedQueries(1)[0].id).to.equal('most-used'); + expect(service.getRecentQueries(1)[0].id).to.equal('recent'); + expect(service.getAllTags()).to.deep.equal(['analytics', 'maintenance', 'ops']); + expect(JSON.parse(service.exportQueries())).to.have.lengthOf(3); + + await service.importQueries(JSON.stringify([ + { + title: 'Imported query', + query: 'select 4', + description: 'Imported from JSON', + tags: ['imported'], + usageCount: 0 + } + ])); + + expect(service.getQueries().some((query) => query.title === 'Imported query')).to.be.true; + + try { + await service.importQueries('not valid json'); + expect.fail('Expected importQueries to throw for invalid JSON'); + } catch (error) { + expect((error as Error).message).to.contain('Failed to import queries'); + } + }); +}); \ No newline at end of file diff --git a/src/test/unit/SchemaPoller.test.ts b/src/test/unit/SchemaPoller.test.ts new file mode 100644 index 0000000..8a5cf14 --- /dev/null +++ b/src/test/unit/SchemaPoller.test.ts @@ -0,0 +1,132 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { ConnectionManager } from '../../services/ConnectionManager'; +import { SchemaPoller } from '../../services/SchemaPoller'; + +function createOutputChannel() { + return { + appendLine: sinon.stub(), + show: sinon.stub(), + dispose: sinon.stub() + } as any; +} + +function createFingerprintRow(objectCount: string, maxOid: string, totalRowsEstimate: string, schemaCount: string, maxSchemaOid: string) { + return { + object_count: objectCount, + max_oid: maxOid, + total_rows_estimate: totalRowsEstimate, + schema_count: schemaCount, + max_schema_oid: maxSchemaOid + }; +} + +describe('SchemaPoller', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('starts, pauses, resumes, updates intervals, and disposes timers', () => { + const outputChannel = createOutputChannel(); + const poller = new SchemaPoller('conn-1', sandbox.stub(), outputChannel); + const clock = sandbox.useFakeTimers(); + + poller.start(250); + expect(outputChannel.appendLine.calledWithMatch('[SchemaPoller:conn-1] Starting')).to.be.true; + expect(clock.countTimers()).to.equal(1); + + poller.pause(); + expect(clock.countTimers()).to.equal(0); + + poller.resume(500); + expect(clock.countTimers()).to.equal(1); + + poller.updateInterval(1_000); + expect(clock.countTimers()).to.equal(1); + + poller.pause(); + poller.updateInterval(750); + expect(clock.countTimers()).to.equal(0); + + poller.dispose(); + expect(clock.countTimers()).to.equal(0); + }); + + it('stores fingerprints, detects changes, and releases clients', async () => { + const refreshSpy = sandbox.spy(); + const outputChannel = createOutputChannel(); + const queryStub = sandbox.stub(); + const releaseStub = sandbox.stub(); + queryStub.onCall(0).resolves({ rows: [createFingerprintRow('1', '2', '3', '4', '5')] }); + queryStub.onCall(1).resolves({ rows: [createFingerprintRow('2', '2', '3', '4', '5')] }); + queryStub.onCall(2).resolves({ rows: [createFingerprintRow('2', '2', '3', '4', '5')] }); + + sandbox.stub(ConnectionManager, 'getInstance').returns({ + getPooledClient: sandbox.stub().resolves({ query: queryStub, release: releaseStub }) + } as any); + + sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: (_key: string, _defaultValue?: T) => ([{ id: 'conn-1', database: 'appdb' }] as any) + } as any); + + const poller = new SchemaPoller('conn-1', refreshSpy, outputChannel); + + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + expect(outputChannel.appendLine.calledWithMatch('Initial fingerprint stored')).to.be.true; + expect(refreshSpy.called).to.be.false; + + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + expect(outputChannel.appendLine.calledWithMatch('Fingerprint changed')).to.be.true; + expect(refreshSpy.calledOnceWith('conn-1', 'appdb')).to.be.true; + + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + expect(outputChannel.appendLine.calledWithMatch('No change in "appdb"')).to.be.true; + expect(releaseStub.callCount).to.equal(3); + + poller.dispose(); + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + expect(outputChannel.appendLine.calledWithMatch('Initial fingerprint stored')).to.be.true; + }); + + it('handles missing connections and stops after repeated polling failures', async () => { + const outputChannel = createOutputChannel(); + const poller = new SchemaPoller('conn-1', sandbox.stub(), outputChannel); + const connections: any[] = []; + + sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: (_key: string, _defaultValue?: T) => ([] as any) + } as any); + + await (poller as any).poll(100); + expect(outputChannel.appendLine.calledWithMatch('Connection not found in configuration')).to.be.true; + + const queryStub = sandbox.stub().rejects(new Error('boom')); + const releaseStub = sandbox.stub(); + + sandbox.stub(ConnectionManager, 'getInstance').returns({ + getPooledClient: sandbox.stub().resolves({ query: queryStub, release: releaseStub }) + } as any); + + (vscode.workspace.getConfiguration as sinon.SinonStub).callsFake(() => ({ + get: (_key: string, _defaultValue?: T) => (connections as any) + } as any)); + + connections.push({ id: 'conn-1', database: 'appdb' }); + + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + await (poller as any).pollDatabase({ id: 'conn-1', database: 'appdb' }, 'appdb'); + + expect(outputChannel.appendLine.calledWithMatch('Poll failed for connection conn-1, database "appdb": boom')).to.be.true; + expect(outputChannel.appendLine.calledWithMatch('Stopping poller for connection conn-1 after 3 consecutive failures.')).to.be.true; + expect(releaseStub.callCount).to.equal(3); + }); +}); \ No newline at end of file diff --git a/src/test/unit/SecretStorageService.test.ts b/src/test/unit/SecretStorageService.test.ts new file mode 100644 index 0000000..5f9d9e7 --- /dev/null +++ b/src/test/unit/SecretStorageService.test.ts @@ -0,0 +1,143 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { SecretStorageService, migrateExistingPasswords } from '../../services/SecretStorageService'; + +function createContext() { + const secretValues = new Map(); + + return { + subscriptions: [], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: () => undefined, + update: async () => undefined + }, + globalState: { + get: sinon.stub().callsFake((key: string, defaultValue?: any) => { + if (key === 'postgresql.connections') { + return (createContext as any)._connections || []; + } + + return defaultValue; + }), + update: sinon.stub().callsFake(async (key: string, value: any) => { + if (key === 'postgresql.connections') { + (createContext as any)._connections = value; + } + }) + }, + secrets: { + get: sinon.stub().callsFake(async (key: string) => secretValues.get(key)), + store: sinon.stub().callsFake(async (key: string, value: string) => { + secretValues.set(key, value); + }), + delete: sinon.stub().callsFake(async (key: string) => { + secretValues.delete(key); + }) + } + } as any; +} + +describe('SecretStorageService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (SecretStorageService as any).instance = undefined; + (createContext as any)._connections = []; + }); + + afterEach(() => { + sandbox.restore(); + (SecretStorageService as any).instance = undefined; + }); + + it('stores, retrieves, and deletes passwords and API keys', async () => { + const context = createContext(); + const service = SecretStorageService.getInstance(context); + + await service.setPassword('conn1', 'pw-1'); + await service.setAiApiKey('api-key-1'); + + expect(await service.getPassword('conn1')).to.equal('pw-1'); + expect(await service.getAiApiKey()).to.equal('api-key-1'); + + await service.deletePassword('conn1'); + await service.deleteAiApiKey(); + + expect(await service.getPassword('conn1')).to.equal(undefined); + expect(await service.getAiApiKey()).to.equal(undefined); + + expect(context.secrets.store.calledWithExactly('postgres-password-conn1', 'pw-1')).to.be.true; + expect(context.secrets.store.calledWithExactly('postgresExplorer.aiApiKey', 'api-key-1')).to.be.true; + expect(context.secrets.delete.calledWithExactly('postgres-password-conn1')).to.be.true; + expect(context.secrets.delete.calledWithExactly('postgresExplorer.aiApiKey')).to.be.true; + }); + + it('migrates stored passwords and updates the connection list', async () => { + const connections = [ + { id: 'conn1', name: 'Primary', password: 'pw-1' }, + { id: 'conn2', name: 'Secondary' } + ]; + (createContext as any)._connections = connections; + + const context = createContext(); + const service = SecretStorageService.getInstance(context); + + await migrateExistingPasswords(context); + + expect((context.secrets.store as sinon.SinonStub).calledOnceWithExactly('postgres-password-conn1', 'pw-1')).to.be.true; + expect(connections[0].password).to.equal(undefined); + expect(context.globalState.update.calledOnce).to.be.true; + expect(context.globalState.update.firstCall.args[0]).to.equal('postgresql.connections'); + expect(context.globalState.update.firstCall.args[1]).to.deep.equal([ + { id: 'conn1', name: 'Primary' }, + { id: 'conn2', name: 'Secondary' } + ]); + + expect(service).to.equal(SecretStorageService.getInstance()); + }); + + it('continues migration when one password store fails', async () => { + const connections = [ + { id: 'bad', name: 'Bad', password: 'pw-bad' }, + { id: 'good', name: 'Good', password: 'pw-good' } + ]; + (createContext as any)._connections = connections; + + const context = createContext(); + (context.secrets.store as sinon.SinonStub).callsFake(async (key: string, value: string) => { + if (key === 'postgres-password-bad') { + throw new Error('disk full'); + } + (context.secrets.get as sinon.SinonStub).callsFake(async (lookupKey: string) => { + if (lookupKey === key) { + return value; + } + return undefined; + }); + }); + const errorStub = sandbox.stub(console, 'error'); + + await migrateExistingPasswords(context); + + expect(errorStub.calledOnce).to.be.true; + expect(String(errorStub.firstCall.args[0])).to.contain('Failed to migrate password for connection Bad'); + expect(context.globalState.update.calledOnce).to.be.true; + expect(connections[0].password).to.equal('pw-bad'); + expect(connections[1].password).to.equal(undefined); + }); + + it('skips updating state when no passwords are present', async () => { + const connections = [{ id: 'conn1', name: 'Primary' }]; + (createContext as any)._connections = connections; + + const context = createContext(); + await migrateExistingPasswords(context); + + expect((context.secrets.store as sinon.SinonStub).called).to.be.false; + expect(context.globalState.update.called).to.be.false; + }); +}); \ No newline at end of file diff --git a/src/test/unit/SessionService.test.ts b/src/test/unit/SessionService.test.ts new file mode 100644 index 0000000..bd00bcc --- /dev/null +++ b/src/test/unit/SessionService.test.ts @@ -0,0 +1,210 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { SessionService } from '../../providers/chat/SessionService'; +import { ChatMessage, ChatSession } from '../../providers/chat/types'; + +function createContext(initialSessions: ChatSession[] = []) { + let sessions = [...initialSessions]; + + return { + subscriptions: [], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: () => undefined, + update: async () => undefined + }, + globalState: { + get: (key: string, defaultValue?: T) => { + if (key === 'chatSessions') { + return sessions as any; + } + + return defaultValue as T; + }, + update: async (key: string, value: any) => { + if (key === 'chatSessions') { + sessions = value; + } + } + }, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +describe('SessionService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('creates a new session with preview and metadata', async () => { + const context = createContext(); + const service = new SessionService(context); + const generateTitle = sandbox.stub().resolves('Session title'); + + const messages: ChatMessage[] = [ + { role: 'user', content: 'show users' }, + { role: 'assistant', content: '**Answer**\n```sql\nSELECT 1;\n```' } + ]; + + await service.saveSession(messages, generateTitle, { + connectionName: 'Primary', + database: 'appdb' + }); + + const currentSessionId = service.getCurrentSessionId(); + expect(currentSessionId).to.match(/^session_\d+_[A-Za-z0-9]+$/); + expect(generateTitle.calledOnceWithExactly('show users')).to.be.true; + + const sessions = service.getChatSessions(); + expect(sessions).to.have.lengthOf(1); + expect(sessions[0]).to.include({ + title: 'Session title', + preview: 'Answer', + connectionName: 'Primary', + database: 'appdb' + }); + expect(sessions[0].messages).to.deep.equal(messages); + + const summaries = service.getSessionSummaries(); + expect(summaries[0]).to.include({ + id: sessions[0].id, + title: 'Session title', + messageCount: 2, + isActive: true, + preview: 'Answer', + connectionName: 'Primary', + database: 'appdb' + }); + }); + + it('updates an existing session and preserves the existing preview', async () => { + const existingSession: ChatSession = { + id: 'session_existing', + title: 'Existing', + messages: [{ role: 'user', content: 'hello' }], + createdAt: 100, + updatedAt: 100, + preview: 'Existing preview', + connectionName: 'Old', + database: 'old_db' + }; + + const context = createContext([existingSession]); + const service = new SessionService(context); + service.setCurrentSessionId('session_existing'); + + const generateTitle = sandbox.stub().resolves('Should not be used'); + const messages: ChatMessage[] = [ + { role: 'user', content: 'new message' }, + { role: 'assistant', content: 'Fresh preview text' } + ]; + + await service.saveSession(messages, generateTitle, { + connectionName: 'Primary', + database: 'appdb' + }); + + expect(generateTitle.called).to.be.false; + + const sessions = service.getChatSessions(); + expect(sessions).to.have.lengthOf(1); + expect(sessions[0]).to.include({ + id: 'session_existing', + title: 'Existing', + preview: 'Existing preview', + connectionName: 'Primary', + database: 'appdb' + }); + expect(sessions[0].messages).to.deep.equal(messages); + expect(sessions[0].updatedAt).to.be.greaterThan(100); + }); + + it('loads, deletes, and clears sessions correctly', async () => { + const sessions: ChatSession[] = [ + { + id: 'session_one', + title: 'First', + messages: [{ role: 'user', content: 'one' }], + createdAt: 1, + updatedAt: 2, + preview: 'First preview', + connectionName: 'Primary', + database: 'appdb' + }, + { + id: 'session_two', + title: 'Second', + messages: [{ role: 'user', content: 'two' }], + createdAt: 3, + updatedAt: 4 + } + ]; + + const context = createContext(sessions); + const service = new SessionService(context); + + const loadedMessages = service.loadSession('session_one'); + expect(loadedMessages).to.deep.equal([{ role: 'user', content: 'one' }]); + expect(service.getCurrentSessionId()).to.equal('session_one'); + + const summaries = service.getSessionSummaries(); + expect(summaries).to.deep.equal([ + { + id: 'session_one', + title: 'First', + createdAt: 1, + updatedAt: 2, + messageCount: 1, + isActive: true, + preview: 'First preview', + connectionName: 'Primary', + database: 'appdb' + }, + { + id: 'session_two', + title: 'Second', + createdAt: 3, + updatedAt: 4, + messageCount: 1, + isActive: false, + preview: undefined, + connectionName: undefined, + database: undefined + } + ]); + + const wasCurrentSession = await service.deleteSession('session_one'); + expect(wasCurrentSession).to.be.true; + expect(service.getCurrentSessionId()).to.equal(null); + expect(service.getChatSessions()).to.deep.equal([ + { + id: 'session_two', + title: 'Second', + messages: [{ role: 'user', content: 'two' }], + createdAt: 3, + updatedAt: 4 + } + ]); + + service.clearCurrentSession(); + expect(service.getCurrentSessionId()).to.equal(null); + expect(await service.deleteSession('missing')).to.be.false; + }); + + it('generates a session identifier with the expected shape', () => { + const service = new SessionService(createContext()); + expect(service.generateSessionId()).to.match(/^session_\d+_[A-Za-z0-9]+$/); + }); +}); \ No newline at end of file diff --git a/src/test/unit/SqlCompletionProvider.test.ts b/src/test/unit/SqlCompletionProvider.test.ts new file mode 100644 index 0000000..bb91b42 --- /dev/null +++ b/src/test/unit/SqlCompletionProvider.test.ts @@ -0,0 +1,135 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { SqlCompletionProvider } from '../../providers/SqlCompletionProvider'; +import { ConnectionManager } from '../../services/ConnectionManager'; + +function createNotebookCellDocument(text: string, uriSuffix = 'cell-1') { + const uri = vscode.Uri.parse(`vscode-notebook-cell:/sql-completion/${uriSuffix}`); + return new vscode.TextDocument(text, uri, 'sql'); +} + +function attachNotebook(document: vscode.TextDocument, metadata: any) { + const notebook = new vscode.NotebookDocument(vscode.Uri.file('/workspace/sql-notebook.pgsql'), metadata); + const cell = new vscode.NotebookCell(document, 0, vscode.NotebookCellKind.Code); + notebook.getCells = () => [cell]; + vscode.workspace.notebookDocuments = [notebook]; + return notebook; +} + +describe('SqlCompletionProvider', () => { + let sandbox: sinon.SinonSandbox; + let getConfigurationStub: sinon.SinonStub; + let getPooledClientStub: sinon.SinonStub; + let queryStub: sinon.SinonStub; + let releaseStub: sinon.SinonStub; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + vscode.workspace.notebookDocuments = []; + + getConfigurationStub = sandbox.stub(vscode.workspace, 'getConfiguration').returns({ + get: sandbox.stub().returns([]) + } as any); + + queryStub = sandbox.stub(); + releaseStub = sandbox.stub(); + getPooledClientStub = sandbox.stub().resolves({ query: queryStub, release: releaseStub }); + sandbox.stub(ConnectionManager, 'getInstance').returns({ + getPooledClient: getPooledClientStub + } as any); + }); + + afterEach(() => { + sandbox.restore(); + vscode.workspace.notebookDocuments = []; + }); + + it('returns empty completions for unsupported documents', async () => { + const provider = new SqlCompletionProvider(); + + const nonNotebook = new vscode.TextDocument('SELECT 1', vscode.Uri.file('/tmp/query.sql'), 'sql'); + const wrongLanguage = new vscode.TextDocument('SELECT 1', vscode.Uri.parse('vscode-notebook-cell:/sql-completion/file'), 'markdown'); + const emptyNotebook = createNotebookCellDocument(' '); + + expect(await provider.provideCompletionItems(nonNotebook, new vscode.Position(0, 0), {} as any, {} as any)).to.deep.equal([]); + expect(await provider.provideCompletionItems(wrongLanguage, new vscode.Position(0, 0), {} as any, {} as any)).to.deep.equal([]); + expect(await provider.provideCompletionItems(emptyNotebook, new vscode.Position(0, 0), {} as any, {} as any)).to.deep.equal([]); + expect(getPooledClientStub.called).to.be.false; + }); + + it('returns keyword-only completions when the connection is missing from settings', async () => { + (getConfigurationStub as sinon.SinonStub).returns({ + get: (key: string) => (key === 'postgresExplorer.connections' ? [] : undefined) + } as any); + + const provider = new SqlCompletionProvider(); + const document = createNotebookCellDocument('SELECT * FROM public.users;'); + attachNotebook(document, { connectionId: 'missing', databaseName: 'appdb' }); + + const items = await provider.provideCompletionItems(document, new vscode.Position(0, document.text.length), {} as any, {} as any); + const labels = items.map(item => item.label); + + expect(getPooledClientStub.called).to.be.false; + expect(labels).to.include('SELECT'); + expect(labels).to.not.include('users'); + expect(labels).to.not.include('email'); + }); + + it('loads table and column completions from cache and reuses them on subsequent calls', async () => { + (getConfigurationStub as sinon.SinonStub).returns({ + get: (key: string) => (key === 'postgresExplorer.connections' + ? [{ id: 'conn-1', name: 'Main', host: 'localhost', port: 5432, username: 'postgres' }] + : undefined) + } as any); + + queryStub.onFirstCall().resolves({ + rows: [ + { schema: 'public', table_name: 'users' }, + { schema: 'sales', table_name: 'orders' } + ] + }); + queryStub.onSecondCall().resolves({ + rows: [ + { schema: 'public', table_name: 'users', column_name: 'user_id', data_type: 'integer' }, + { schema: 'public', table_name: 'users', column_name: 'email', data_type: 'text' }, + { schema: 'sales', table_name: 'orders', column_name: 'order_total', data_type: 'numeric' } + ] + }); + + const provider = new SqlCompletionProvider(); + const document = createNotebookCellDocument( + 'SELECT u.user_id, o.order_total FROM public.users u JOIN sales.orders o ON o.user_id = u.user_id;' + ); + attachNotebook(document, { connectionId: 'conn-1', databaseName: 'appdb' }); + + const firstItems = await provider.provideCompletionItems(document, new vscode.Position(0, document.text.length), {} as any, {} as any); + const secondItems = await provider.provideCompletionItems(document, new vscode.Position(0, document.text.length), {} as any, {} as any); + + const firstLabels = firstItems.map(item => item.label); + expect(getPooledClientStub.calledOnce).to.be.true; + expect(releaseStub.calledOnce).to.be.true; + expect(queryStub.calledTwice).to.be.true; + expect(firstLabels).to.include('SELECT'); + expect(firstLabels).to.include('users'); + expect(firstLabels).to.include('orders'); + expect(firstLabels).to.include('user_id'); + expect(firstLabels).to.include('order_total'); + + const usersItem = firstItems.find(item => item.label === 'users'); + const emailItem = firstItems.find(item => item.label === 'email'); + const orderTotalItem = firstItems.find(item => item.label === 'order_total'); + + expect(usersItem?.sortText).to.equal('0-users'); + expect(emailItem?.sortText).to.equal('0-email'); + expect(orderTotalItem?.sortText).to.equal('0-order_total'); + expect(secondItems.map(item => item.label)).to.deep.equal(firstLabels); + + const fallbackDocument = createNotebookCellDocument('SELECT 1;', 'cell-2'); + attachNotebook(fallbackDocument, { connectionId: 'conn-1', databaseName: 'appdb' }); + const fallbackItems = await provider.provideCompletionItems(fallbackDocument, new vscode.Position(0, fallbackDocument.text.length), {} as any, {} as any); + expect(fallbackItems.length).to.be.greaterThan(0); + expect(getPooledClientStub.calledOnce).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/SqlTemplates.test.ts b/src/test/unit/SqlTemplates.test.ts new file mode 100644 index 0000000..93cc5bb --- /dev/null +++ b/src/test/unit/SqlTemplates.test.ts @@ -0,0 +1,264 @@ +import { expect } from 'chai'; + +import { + ColumnSQL, + ConstraintSQL, + ExtensionSQL, + ForeignDataWrapperSQL, + ForeignTableSQL, + FunctionSQL, + IndexSQL, + MaintenanceTemplates, + MaterializedViewSQL, + QueryBuilder, + SQL_TEMPLATES, + SchemaSQL, + TableSQL, + TypeSQL, + UserRoleSQL, + UsersRolesSQL, + ViewSQL, +} from '../../commands/sql'; +import * as ProfileSQL from '../../commands/sql/profile'; + +function expectSqlContains(sql: string, fragments: string[]): void { + for (const fragment of fragments) { + expect(sql).to.contain(fragment); + } +} + +describe('SQL template modules', () => { + const schema = 'public'; + const table = 'users'; + const column = 'email'; + const indexName = 'users_email_idx'; + + it('covers the shared helper templates', () => { + expect(SQL_TEMPLATES.DROP.TABLE(schema, table)).to.equal('-- Drop table\nDROP TABLE IF EXISTS "public"."users";'); + expect(SQL_TEMPLATES.DROP.VIEW(schema, table)).to.equal('-- Drop view\nDROP VIEW IF EXISTS public.users;'); + expect(SQL_TEMPLATES.DROP.MATERIALIZED_VIEW(schema, table)).to.equal('-- Drop materialized view\nDROP MATERIALIZED VIEW IF EXISTS public.users;'); + expect(SQL_TEMPLATES.DROP.FUNCTION(schema, table, 'integer')).to.contain('DROP FUNCTION IF EXISTS public.users(integer);'); + expect(SQL_TEMPLATES.DROP.INDEX(schema, indexName)).to.contain('DROP INDEX "public"."users_email_idx";'); + expect(SQL_TEMPLATES.DROP.CONSTRAINT(schema, table, 'users_email_key')).to.contain('DROP CONSTRAINT "users_email_key";'); + expect(SQL_TEMPLATES.DROP.TYPE(schema, 'customer_status')).to.contain('DROP TYPE IF EXISTS public.customer_status CASCADE;'); + expect(SQL_TEMPLATES.DROP.EXTENSION('uuid-ossp')).to.contain('DROP EXTENSION IF EXISTS "uuid-ossp" CASCADE;'); + + expect(SQL_TEMPLATES.SELECT.ALL(schema, table)).to.contain('LIMIT 100;'); + expect(SQL_TEMPLATES.SELECT.ALL(schema, table, 25)).to.contain('LIMIT 25;'); + expect(SQL_TEMPLATES.SELECT.WITH_WHERE(schema, table)).to.contain('WHERE condition'); + + expect(SQL_TEMPLATES.COMMENT.TABLE(schema, table, "It's ours")).to.contain("IS 'It''s ours';"); + expect(SQL_TEMPLATES.COMMENT.COLUMN(schema, table, column, 'Column comment')).to.contain('COMMENT ON COLUMN public.users.email'); + expect(SQL_TEMPLATES.COMMENT.VIEW(schema, 'orders_view', 'View comment')).to.contain('COMMENT ON VIEW public.orders_view'); + expect(SQL_TEMPLATES.COMMENT.FUNCTION(schema, 'calc_total', 'integer', 'Function comment')).to.contain('COMMENT ON FUNCTION public.calc_total(integer)'); + expect(SQL_TEMPLATES.COMMENT.TYPE(schema, 'status_enum', 'Type comment')).to.contain('COMMENT ON TYPE public.status_enum'); + + expect(QueryBuilder.objectInfo('table', schema, table)).to.contain('information_schema.tables'); + expect(QueryBuilder.objectInfo('view', schema, table)).to.contain('information_schema.views'); + expect(QueryBuilder.objectInfo('function', schema, table)).to.contain('information_schema.routines'); + expect(QueryBuilder.objectInfo('type', schema, table)).to.contain('information_schema.user_defined_types'); + expect(QueryBuilder.objectInfo('unknown' as any, schema, table)).to.equal(undefined); + expect(QueryBuilder.privileges(schema, table)).to.contain('information_schema.table_privileges'); + expect(QueryBuilder.dependencies(schema, table)).to.contain('pg_depend'); + expect(QueryBuilder.columns(schema, table)).to.contain('information_schema.columns'); + expect(QueryBuilder.tableColumns(schema, table)).to.contain('col_description'); + expect(QueryBuilder.constraintDetails(schema, table, 'users_email_key')).to.contain('information_schema.table_constraints'); + expect(QueryBuilder.foreignKeyDetails(schema, 'users_fk')).to.contain('information_schema.referential_constraints'); + expect(QueryBuilder.columnDetails(schema, table, column)).to.contain('is_primary_key'); + expect(QueryBuilder.tableIndexes(schema, table)).to.contain('pg_index'); + expect(QueryBuilder.tableConstraints(schema, table)).to.contain('referenced_table'); + expect(QueryBuilder.tableConstraintDefinitions(schema, table)).to.contain('pg_get_constraintdef'); + expect(QueryBuilder.tableStats(schema, table)).to.contain('pg_stat_user_tables'); + expect(QueryBuilder.tableSize(schema, table)).to.contain('pg_total_relation_size'); + expect(QueryBuilder.tableInfo(schema, table)).to.contain('pg_class c'); + expect(QueryBuilder.viewDefinition(schema, 'orders_view')).to.contain('pg_get_viewdef'); + expect(QueryBuilder.viewInfo(schema, 'orders_view')).to.contain('c.relkind = \'v\''); + expect(QueryBuilder.viewSize(schema, 'orders_view')).to.contain('view_size'); + expect(QueryBuilder.typeInfo(schema, 'status_enum')).to.contain('type_type'); + expect(QueryBuilder.typeFields(schema, 'status_enum')).to.contain('format_type'); + expect(QueryBuilder.roleDetails('app_user')).to.contain('WITH RECURSIVE'); + expect(QueryBuilder.roleAttributes('app_user')).to.contain('pg_authid'); + expect(QueryBuilder.functionInfo(schema, 'calc_total')).to.contain('pg_get_function_arguments'); + expect(QueryBuilder.functionDefinition(schema, 'calc_total')).to.contain('pg_get_functiondef'); + expect(QueryBuilder.functionSignature(schema, 'calc_total')).to.contain('pg_get_function_result'); + expect(QueryBuilder.functionArguments(schema, 'calc_total')).to.contain('pg_get_function_arguments'); + expect(QueryBuilder.schemaInfo(schema)).to.contain('tables_count'); + expect(QueryBuilder.schemaDetails(schema)).to.contain('pg_namespace'); + expect(QueryBuilder.schemaObjectCounts(schema)).to.contain('trigger_count'); + expect(QueryBuilder.schemaSize(schema)).to.contain('relation_count'); + expect(QueryBuilder.schemaPrivileges(schema)).to.contain('routine_privileges'); + expect(QueryBuilder.schemaExtensions(schema)).to.contain('pg_extension'); + expect(QueryBuilder.schemaDependencies(schema)).to.contain('LIMIT 10'); + expect(QueryBuilder.schemaAllObjects(schema)).to.contain('estimated_row_count'); + expect(QueryBuilder.extensionObjects('uuid-ossp')).to.contain('pg_catalog.pg_depend'); + expect(QueryBuilder.foreignTableInfo(schema, 'remote_users')).to.contain('pg_foreign_table'); + expect(QueryBuilder.foreignTableDefinition(schema, 'remote_users')).to.contain('array_agg'); + expect(QueryBuilder.matViewInfo(schema, 'sales_mv')).to.contain('pg_matviews'); + expect(QueryBuilder.matViewDefinition(schema, 'sales_mv')).to.contain('pg_get_viewdef'); + expect(QueryBuilder.matViewStats(schema, 'sales_mv')).to.contain('pg_stat_user_tables'); + expect(QueryBuilder.objectDependencies(schema, 'sales_mv')).to.contain('pg_depend'); + expect(QueryBuilder.objectReferences(schema, 'sales_mv')).to.contain('pg_rewrite'); + expect(QueryBuilder.databaseStats()).to.contain('pg_database d'); + expect(QueryBuilder.databaseSchemaSizes()).to.contain('pg_total_relation_size'); + expect(QueryBuilder.databaseSchemaSizeSummary()).to.contain('GROUP BY schema_name'); + expect(QueryBuilder.databaseMaintenanceStats()).to.contain('Dead Tuples'); + expect(QueryBuilder.databaseConfiguration()).to.contain('pg_settings'); + expect(QueryBuilder.databaseMemorySettings()).to.contain('Memory'); + expect(QueryBuilder.databaseConnectionSettings()).to.contain('Connection'); + expect(QueryBuilder.databaseActiveConnections()).to.contain('pg_stat_activity'); + expect(QueryBuilder.databaseExtensions()).to.contain('pg_available_extensions'); + expect(QueryBuilder.databaseRoles()).to.contain('pg_roles r'); + expect(QueryBuilder.databaseTerminateConnections()).to.contain('WHERE datname = current_database()'); + expect(QueryBuilder.databaseTerminateConnections('inventory')).to.contain("WHERE datname = 'inventory'"); + expect(QueryBuilder.terminateConnectionsByPid('inventory')).to.contain('pg_terminate_backend(pid)'); + + expect(MaintenanceTemplates.vacuum(schema, table)).to.contain('VACUUM (VERBOSE, ANALYZE) public.users;'); + expect(MaintenanceTemplates.analyze(schema, table)).to.contain('ANALYZE VERBOSE public.users;'); + expect(MaintenanceTemplates.reindex(schema, table)).to.contain('REINDEX TABLE public.users;'); + expect(MaintenanceTemplates.vacuumFull(schema, table)).to.contain('VACUUM FULL public.users;'); + expect(MaintenanceTemplates.vacuumAnalyzeDatabase()).to.contain('VACUUM (VERBOSE, ANALYZE);'); + expect(MaintenanceTemplates.reindexDatabase('app_db')).to.contain('REINDEX DATABASE "app_db";'); + }); + + it('covers standalone table profile SQL helpers', () => { + expect(ProfileSQL.tableStats(schema, table)).to.contain('pg_stat_user_tables'); + expect(ProfileSQL.columnStats(schema, table)).to.contain('pg_stats'); + expect(ProfileSQL.columnDetails(schema, table)).to.contain('pg_attribute'); + expect(ProfileSQL.tableActivity(schema, table)).to.contain('seq_scan'); + expect(ProfileSQL.indexUsage(schema, table)).to.contain('pg_stat_user_indexes'); + expect(ProfileSQL.dataSample(schema, table, column)).to.contain('LIMIT 10'); + expect(ProfileSQL.dataSample(schema, table, column, 5)).to.contain('LIMIT 5'); + }); + + it('covers table, view, column, index, constraint, extension, type and role SQL builders', () => { + expect(TableSQL.select(schema, table)).to.equal('SELECT * FROM "public"."users" LIMIT 100;'); + expect(TableSQL.select(schema, table, 25)).to.contain('LIMIT 25;'); + expectSqlContains(TableSQL.insert(schema, table), ['INSERT INTO "public"."users"', 'RETURNING *;']); + expectSqlContains(TableSQL.update(schema, table), ['UPDATE "public"."users"', 'RETURNING *;']); + expectSqlContains(TableSQL.delete(schema, table), ['DELETE FROM "public"."users"', 'RETURNING *;']); + expectSqlContains(TableSQL.truncate(schema, table), ['TRUNCATE TABLE "public"."users";']); + expectSqlContains(TableSQL.drop(schema, table), ['DROP TABLE "public"."users";']); + expectSqlContains(TableSQL.vacuum(schema, table), ['VACUUM (VERBOSE, ANALYZE) "public"."users";']); + expectSqlContains(TableSQL.analyze(schema, table), ['ANALYZE VERBOSE "public"."users";']); + expectSqlContains(TableSQL.reindex(schema, table), ['REINDEX TABLE "public"."users";']); + expectSqlContains(TableSQL.createScript(schema, table), ['CREATE TABLE "public"."users"', 'COMMENT ON TABLE "public"."users"']); + + expect(ViewSQL.select(schema, 'orders_view')).to.contain('SELECT * FROM "public"."orders_view" LIMIT 100;'); + expectSqlContains(ViewSQL.createOrReplace(schema, 'orders_view'), ['CREATE OR REPLACE VIEW "public"."orders_view" AS', 'COMMENT ON VIEW "public"."orders_view"']); + expectSqlContains(ViewSQL.drop(schema, 'orders_view'), ['DROP VIEW "public"."orders_view";']); + expectSqlContains(ViewSQL.definition(schema, 'orders_view'), ['FROM pg_views', 'information_schema.view_column_usage']); + + expect(ColumnSQL.select(schema, table, column)).to.contain('SELECT email'); + expect(ColumnSQL.select(schema, table, column, 5)).to.contain('LIMIT 5;'); + expectSqlContains(ColumnSQL.alter(schema, table, column), ['ALTER TABLE public.users', 'SET DEFAULT']); + expectSqlContains(ColumnSQL.drop(schema, table, column), ['DROP COLUMN email']); + expectSqlContains(ColumnSQL.rename(schema, table, 'old_name', 'new_name'), ['RENAME COLUMN old_name TO new_name']); + expectSqlContains(ColumnSQL.createIndex(schema, table, column, indexName), ['CREATE INDEX users_email_idx', 'WHERE email IS NOT NULL']); + + expectSqlContains(IndexSQL.drop(schema, indexName), ['DROP INDEX "public"."users_email_idx";']); + expectSqlContains(IndexSQL.reindex(schema, indexName), ['REINDEX INDEX "public"."users_email_idx";']); + expectSqlContains(IndexSQL.alter(schema, indexName), ['ALTER INDEX "public"."users_email_idx" RENAME TO new_index_name;']); + expectSqlContains(IndexSQL.usageStats(schema, indexName), ['pg_stat_user_indexes', 'usage_status']); + + expectSqlContains(ConstraintSQL.addPrimaryKey(schema, table), ['PRIMARY KEY (id)']); + expectSqlContains(ConstraintSQL.addForeignKey(schema, table), ['FOREIGN KEY (reference_id)', 'ON DELETE CASCADE']); + expectSqlContains(ConstraintSQL.addUnique(schema, table), ['UNIQUE (email)']); + expectSqlContains(ConstraintSQL.addCheck(schema, table), ['CHECK (status IN']); + expectSqlContains(ConstraintSQL.drop(schema, table, 'users_email_key'), ['DROP CONSTRAINT "users_email_key";']); + expectSqlContains(ConstraintSQL.validate(schema, table, 'users_email_key'), ['VALIDATE CONSTRAINT "users_email_key";']); + + expectSqlContains(ExtensionSQL.enable('uuid-ossp'), ['CREATE EXTENSION IF NOT EXISTS "uuid-ossp";']); + expectSqlContains(ExtensionSQL.drop('uuid-ossp'), ['DROP EXTENSION IF EXISTS "uuid-ossp";']); + expectSqlContains(ExtensionSQL.dropCascade('uuid-ossp'), ['DROP EXTENSION IF EXISTS "uuid-ossp" CASCADE;']); + + expectSqlContains(FunctionSQL.call(schema, 'calc_total', '1, 2'), ['SELECT public.calc_total(1, 2);']); + expectSqlContains(FunctionSQL.createOrReplace(schema), ['CREATE OR REPLACE FUNCTION public.function_name', 'LANGUAGE sql']); + expectSqlContains(FunctionSQL.drop(schema, 'calc_total', 'integer'), ['DROP FUNCTION IF EXISTS public.calc_total(integer);']); + expectSqlContains(FunctionSQL.metadata(schema, 'calc_total'), ['pg_get_function_arguments', 'pg_language']); + + expectSqlContains(SchemaSQL.create(), ['CREATE SCHEMA schema_name;']); + expectSqlContains(SchemaSQL.drop(schema), ['DROP SCHEMA public;']); + expectSqlContains(SchemaSQL.grant(schema), ['GRANT USAGE ON SCHEMA public TO role_name;']); + expectSqlContains(SchemaSQL.listObjects(schema), ['object_type', 'pg_class c']); + + expectSqlContains(TypeSQL.createComposite(schema), ['CREATE TYPE "public".type_name AS (']); + expectSqlContains(TypeSQL.createEnum(schema), ['CREATE TYPE "public".status_enum AS ENUM']); + expectSqlContains(TypeSQL.drop(schema, 'status_enum'), ['DROP TYPE "public"."status_enum";']); + expectSqlContains(TypeSQL.rename(schema, 'status_enum'), ['ALTER TYPE "public"."status_enum" RENAME TO new_type_name;']); + expectSqlContains(TypeSQL.findUsage(schema, 'status_enum'), ['FROM pg_attribute a']); + + expectSqlContains(UserRoleSQL.createUser('app_db'), ['CREATE USER new_username WITH', 'GRANT CONNECT ON DATABASE app_db']); + expectSqlContains(UserRoleSQL.createRole(), ['CREATE ROLE new_role_name WITH']); + expectSqlContains(UserRoleSQL.alterRole('app_user'), ['ALTER ROLE app_user']); + expectSqlContains(UserRoleSQL.grant('app_user'), ['GRANT USAGE ON SCHEMA public TO app_user']); + expectSqlContains(UserRoleSQL.dropRole('app_user'), ['DROP ROLE app_user;']); + expectSqlContains(UsersRolesSQL.dropRole('legacy_role'), ['DROP ROLE legacy_role;']); + }); + + it('covers materialized view and foreign table SQL builders', () => { + expectSqlContains(MaterializedViewSQL.select(schema, 'sales_mv'), ['SELECT *', 'LIMIT 100;']); + expectSqlContains(MaterializedViewSQL.refresh(schema, 'sales_mv'), ['REFRESH MATERIALIZED VIEW public.sales_mv;']); + expectSqlContains(MaterializedViewSQL.create(schema, 'sales_mv'), ['CREATE MATERIALIZED VIEW public.sales_mv AS']); + expectSqlContains(MaterializedViewSQL.drop(schema, 'sales_mv'), ['DROP MATERIALIZED VIEW public.sales_mv;']); + expectSqlContains(MaterializedViewSQL.analyze(schema, 'sales_mv'), ['ANALYZE public.sales_mv;']); + expectSqlContains(MaterializedViewSQL.createIndex(schema, 'sales_mv'), ['CREATE UNIQUE INDEX sales_mv_unique_idx']); + + expectSqlContains(ForeignTableSQL.queryData(schema, 'remote_users'), ['SELECT *', 'LIMIT 100;']); + expectSqlContains(ForeignTableSQL.edit(schema, 'remote_users'), ['DROP FOREIGN TABLE IF EXISTS public.remote_users;', 'CREATE FOREIGN TABLE public.remote_users']); + expectSqlContains(ForeignTableSQL.drop(schema, 'remote_users'), ['DROP FOREIGN TABLE IF EXISTS public.remote_users;']); + expectSqlContains(ForeignTableSQL.create.basic(schema), ['CREATE FOREIGN TABLE public.foreign_table_name']); + expectSqlContains(ForeignTableSQL.create.postgresRemote(schema), ['CREATE EXTENSION IF NOT EXISTS postgres_fdw;']); + expectSqlContains(ForeignTableSQL.create.fileBased(schema), ['CREATE EXTENSION IF NOT EXISTS file_fdw;']); + expectSqlContains(ForeignTableSQL.queryWithJoin(schema), ['JOIN public.foreign_table_name ft ON lt.id = ft.id;']); + expectSqlContains(ForeignTableSQL.manageForeignServer(), ['SELECT', 'DROP SERVER foreign_server_name CASCADE;']); + }); + + it('covers foreign data wrapper SQL builders and optional branches', () => { + expectSqlContains(ForeignDataWrapperSQL.create.server.basic('postgres_fdw'), ['CREATE SERVER server_name', 'FOREIGN DATA WRAPPER postgres_fdw']); + expectSqlContains(ForeignDataWrapperSQL.create.server.postgres(), ['CREATE EXTENSION IF NOT EXISTS postgres_fdw;']); + expectSqlContains(ForeignDataWrapperSQL.create.server.mysql(), ['CREATE EXTENSION IF NOT EXISTS mysql_fdw;']); + expectSqlContains(ForeignDataWrapperSQL.create.server.file(), ['CREATE EXTENSION IF NOT EXISTS file_fdw;']); + expectSqlContains(ForeignDataWrapperSQL.create.server.withAuth('postgres_fdw'), ['sslmode', 'sslcert']); + expectSqlContains(ForeignDataWrapperSQL.create.userMapping.basic('remote_server'), ['CREATE USER MAPPING FOR CURRENT_USER']); + expectSqlContains(ForeignDataWrapperSQL.create.userMapping.withPassword('remote_server'), ['CREATE USER MAPPING FOR username']); + expectSqlContains(ForeignDataWrapperSQL.create.userMapping.public('remote_server'), ['CREATE USER MAPPING FOR PUBLIC']); + expectSqlContains(ForeignDataWrapperSQL.create.userMapping.withOptions('remote_server'), ['fetch_size', 'async_capable']); + + expectSqlContains(ForeignDataWrapperSQL.alter.serverOptions('remote_server'), ['ALTER SERVER remote_server']); + expectSqlContains(ForeignDataWrapperSQL.alter.serverOwner('remote_server'), ['OWNER TO new_owner_role;']); + expectSqlContains(ForeignDataWrapperSQL.alter.serverRename('remote_server'), ['RENAME TO new_server_name;']); + expectSqlContains(ForeignDataWrapperSQL.alter.userMappingOptions('remote_server'), ['ALTER USER MAPPING FOR CURRENT_USER']); + expectSqlContains(ForeignDataWrapperSQL.alter.addOption('remote_server'), ['OPTIONS (ADD option_name']); + expectSqlContains(ForeignDataWrapperSQL.alter.dropOption('remote_server'), ['OPTIONS (DROP option_name']); + + expectSqlContains(ForeignDataWrapperSQL.query.listFDWs(), ['FROM pg_foreign_data_wrapper']); + expectSqlContains(ForeignDataWrapperSQL.query.fdwDetails('postgres_fdw'), ["WHERE fdw.fdwname = 'postgres_fdw'"]); + expectSqlContains(ForeignDataWrapperSQL.query.listServers(), ['-- List all foreign servers']); + expectSqlContains(ForeignDataWrapperSQL.query.listServers('postgres_fdw'), ["WHERE fdw.fdwname = 'postgres_fdw'"]); + expectSqlContains(ForeignDataWrapperSQL.query.serverDetails('remote_server'), ["WHERE srv.srvname = 'remote_server'"]); + expectSqlContains(ForeignDataWrapperSQL.query.listUserMappings(), ['-- List all user mappings']); + expectSqlContains(ForeignDataWrapperSQL.query.listUserMappings('remote_server'), ["WHERE um.srvname = 'remote_server'"]); + expectSqlContains(ForeignDataWrapperSQL.query.userMappingDetails('remote_server', 'app_user'), ["WHERE um.srvname = 'remote_server'"]); + expectSqlContains(ForeignDataWrapperSQL.query.foreignTablesByServer('remote_server'), ['FROM pg_foreign_table ft']); + expectSqlContains(ForeignDataWrapperSQL.query.fdwFunctions('postgres_fdw'), ['fdwhandler::regproc']); + + expectSqlContains(ForeignDataWrapperSQL.grant.usageOnServer('remote_server', 'app_user'), ['GRANT USAGE ON FOREIGN SERVER remote_server TO app_user']); + expectSqlContains(ForeignDataWrapperSQL.grant.usageOnFDW('postgres_fdw', 'app_user'), ['GRANT USAGE ON FOREIGN DATA WRAPPER postgres_fdw TO app_user']); + + expectSqlContains(ForeignDataWrapperSQL.drop.server('remote_server'), ['DROP SERVER IF EXISTS remote_server;']); + expectSqlContains(ForeignDataWrapperSQL.drop.server('remote_server', true), ['DROP SERVER IF EXISTS remote_server CASCADE;']); + expectSqlContains(ForeignDataWrapperSQL.drop.userMapping('remote_server'), ['DROP USER MAPPING IF EXISTS FOR CURRENT_USER']); + expectSqlContains(ForeignDataWrapperSQL.drop.userMapping('remote_server', 'app_user'), ['DROP USER MAPPING IF EXISTS FOR app_user']); + expectSqlContains(ForeignDataWrapperSQL.drop.fdw('postgres_fdw'), ['DROP FOREIGN DATA WRAPPER IF EXISTS postgres_fdw;']); + expectSqlContains(ForeignDataWrapperSQL.drop.fdw('postgres_fdw', true), ['DROP FOREIGN DATA WRAPPER IF EXISTS postgres_fdw CASCADE;']); + + expectSqlContains(ForeignDataWrapperSQL.test.connection('remote_server'), ['BEGIN;', 'ROLLBACK;']); + expectSqlContains(ForeignDataWrapperSQL.test.permissions('remote_server'), ['has_server_privilege']); + + expectSqlContains(ForeignDataWrapperSQL.manage.showServerOptions('remote_server'), ['unnest(srv.srvoptions)']); + expectSqlContains(ForeignDataWrapperSQL.manage.showUserMappingOptions('remote_server'), ['unnest(um.umoptions)']); + expectSqlContains(ForeignDataWrapperSQL.manage.showUserMappingOptions('remote_server', 'app_user'), ["AND um.usename = 'app_user'"]); + expectSqlContains(ForeignDataWrapperSQL.manage.dependencies('remote_server'), ['CASE c.relkind']); + expectSqlContains(ForeignDataWrapperSQL.manage.serverStatistics('remote_server'), ['COUNT(DISTINCT um.umid)']); + }); +}); \ No newline at end of file diff --git a/src/test/unit/TelemetryService.test.ts b/src/test/unit/TelemetryService.test.ts new file mode 100644 index 0000000..236d6da --- /dev/null +++ b/src/test/unit/TelemetryService.test.ts @@ -0,0 +1,153 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; + +import { TelemetryService } from '../../services/TelemetryService'; + +function createContext() { + return { + subscriptions: [] as any[], + extensionUri: { fsPath: '/ext' } as any, + extension: { packageJSON: { version: '0.0.0' } }, + workspaceState: { + get: () => undefined, + update: async () => undefined + }, + globalState: { + get: () => undefined, + update: async () => undefined + }, + secrets: { + get: async () => undefined, + store: async () => undefined, + delete: async () => undefined + } + } as any; +} + +describe('TelemetryService', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + (TelemetryService as any).instance = undefined; + }); + + afterEach(() => { + sandbox.restore(); + (TelemetryService as any).instance = undefined; + }); + + it('stays disabled when configuration turns telemetry off', () => { + let enabled = false; + + sandbox.stub(vscode.workspace, 'getConfiguration').callsFake((section?: string) => { + if (section === 'postgresExplorer.telemetry') { + return { + get: (_key: string, defaultValue?: T) => (enabled as unknown as T) ?? defaultValue as T + } as any; + } + + return { + get: (_key: string, defaultValue?: T) => defaultValue as T + } as any; + }); + + const createOutputChannelStub = sandbox.stub(vscode.window, 'createOutputChannel'); + const configurationHandler: { current?: (event: any) => void } = {}; + sandbox.stub(vscode.workspace, 'onDidChangeConfiguration').callsFake((cb: any) => { + configurationHandler.current = cb; + return { dispose: () => undefined }; + }); + + const service = TelemetryService.getInstance(); + expect(service.isEnabled()).to.be.false; + + const context = createContext(); + service.initialize(context); + + expect(createOutputChannelStub.called).to.be.false; + expect(context.subscriptions).to.have.lengthOf(1); + + expect(service.startSpan('query.execute')).to.equal(''); + service.recordMetric('rows', 5, 'count'); + expect(service.getSummary()).to.deep.equal({ enabled: false, activeSpans: 0, spanNames: [] }); + + enabled = true; + configurationHandler.current?.({ affectsConfiguration: (setting: string) => setting === 'postgresExplorer.telemetry' }); + expect(service.isEnabled()).to.be.true; + }); + + it('records spans, metrics, and errors when telemetry is enabled', async () => { + let enabled = true; + let configurationHandler: ((event: any) => void) | undefined; + const appendLine = sandbox.stub(); + const outputChannel = { + appendLine, + show: sandbox.stub(), + dispose: sandbox.stub() + } as any; + + sandbox.stub(vscode.workspace, 'getConfiguration').callsFake((section?: string) => { + if (section === 'postgresExplorer.telemetry') { + return { + get: (_key: string, defaultValue?: T) => (enabled as unknown as T) ?? defaultValue as T + } as any; + } + + return { + get: (_key: string, defaultValue?: T) => defaultValue as T + } as any; + }); + + sandbox.stub(vscode.workspace, 'onDidChangeConfiguration').callsFake((cb: any) => { + configurationHandler = cb; + return { dispose: () => undefined }; + }); + sandbox.stub(vscode.window, 'createOutputChannel').returns(outputChannel); + + const service = TelemetryService.getInstance(); + const context = createContext(); + service.initialize(context); + + expect(appendLine.firstCall.args[0]).to.contain('Telemetry initialized'); + expect(context.subscriptions).to.have.lengthOf(1); + + const clock = sandbox.useFakeTimers({ now: 1_000 }); + + const spanId = service.startSpan('query.execute', { rows: 1 }); + expect(spanId).to.match(/^query.execute-\d+-/); + expect(service.getSummary()).to.deep.equal({ enabled: true, activeSpans: 1, spanNames: ['query.execute'] }); + + clock.tick(25); + service.endSpan(spanId, { rows: 2 }); + expect(appendLine.getCalls().some((call) => String(call.args[0]).includes('[END] query.execute (25ms)'))).to.be.true; + + service.recordMetric('rows', 10, 'count'); + expect(appendLine.getCalls().some((call) => String(call.args[0]).includes('[METRIC] rows: 10 count'))).to.be.true; + + const traced = await service.trace('ai.request', async () => 42, { model: 'test' }); + expect(traced).to.equal(42); + + let thrown: Error | undefined; + try { + await service.trace('ai.generate', async () => { + throw new Error('boom'); + }); + } catch (error) { + thrown = error as Error; + } + + expect(thrown?.message).to.equal('boom'); + + const errorSpanId = service.startSpan('query.stream'); + service.recordError(errorSpanId, new Error('failure')); + expect(appendLine.getCalls().some((call) => String(call.args[0]).includes('[ERROR] query.stream'))).to.be.true; + + enabled = false; + configurationHandler?.({ affectsConfiguration: (setting: string) => setting === 'postgresExplorer.telemetry' }); + expect(service.isEnabled()).to.be.false; + + expect(service.getSummary()).to.deep.equal({ enabled: false, activeSpans: 0, spanNames: [] }); + }); +}); \ No newline at end of file diff --git a/src/test/unit/TransactionManager.test.ts b/src/test/unit/TransactionManager.test.ts new file mode 100644 index 0000000..a0a9f74 --- /dev/null +++ b/src/test/unit/TransactionManager.test.ts @@ -0,0 +1,190 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import { TransactionManager } from '../../services/TransactionManager'; + +describe('TransactionManager', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + function createClient() { + return { + query: sandbox.stub().resolves(undefined) + } as any; + } + + it('begins, commits, rolls back, and rejects duplicate begins', async () => { + const manager = new TransactionManager(); + const client = createClient(); + const clock = sandbox.useFakeTimers({ now: 1_000 }); + + expect(manager.getTransactionInfo('missing')).to.equal(null); + expect(manager.getTransactionSummary('missing')).to.equal('No connection'); + expect(manager.getSavepoints('missing')).to.deep.equal([]); + expect(manager.getTransactionState('missing')).to.deep.equal({ isActive: false, isFailed: false, savepointCount: 0 }); + + await manager.beginTransaction(client, 'session-1', 'SERIALIZABLE', true, true); + expect(client.query.firstCall.args[0]).to.equal('BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY DEFERRABLE'); + expect(manager.getTransactionInfo('session-1')).to.deep.include({ + isActive: true, + state: 'active', + isolationLevel: 'SERIALIZABLE', + readOnly: true, + deferrable: true + }); + + clock.tick(2_000); + expect(manager.getTransactionSummary('session-1')).to.contain('Transaction Active (SERIALIZABLE)'); + expect(manager.getTransactionSummary('session-1')).to.contain('[READ-ONLY]'); + expect(manager.getTransactionSummary('session-1')).to.contain('2s'); + expect(manager.getTransactionState('session-1')).to.deep.equal({ isActive: true, isFailed: false, savepointCount: 0 }); + + try { + await manager.beginTransaction(client, 'session-1'); + expect.fail('Expected duplicate beginTransaction to fail'); + } catch (error) { + expect((error as Error).message).to.contain('Transaction already active'); + } + + await manager.commitTransaction(client, 'session-1'); + expect(client.query.calledWith('COMMIT')).to.be.true; + expect(manager.getTransactionInfo('session-1')?.isActive).to.be.false; + expect(manager.getTransactionSummary('session-1')).to.equal('No transaction'); + + await manager.beginTransaction(client, 'session-1'); + expect(client.query.getCall(2).args[0]).to.equal('BEGIN READ WRITE'); + + await manager.rollbackTransaction(client, 'session-1'); + expect(client.query.calledWith('ROLLBACK')).to.be.true; + expect(manager.getTransactionInfo('session-1')?.isActive).to.be.false; + }); + + it('manages savepoints and reports missing-savepoint errors', async () => { + const manager = new TransactionManager(); + const client = createClient(); + + await manager.beginTransaction(client, 'session-2'); + + const firstSavepoint = await manager.createSavepoint(client, 'session-2'); + const customSavepoint = await manager.createSavepoint(client, 'session-2', 'custom_sp'); + expect(firstSavepoint).to.equal('sp_pgstudio_1'); + expect(customSavepoint).to.equal('custom_sp'); + expect(manager.getSavepoints('session-2')).to.deep.equal([ + { name: 'sp_pgstudio_1', timestamp: 0 }, + { name: 'custom_sp', timestamp: 1 } + ]); + + await manager.releaseSavepoint(client, 'session-2'); + expect(client.query.calledWith('RELEASE SAVEPOINT "custom_sp"')).to.be.true; + expect(manager.getSavepoints('session-2')).to.deep.equal([ + { name: 'sp_pgstudio_1', timestamp: 0 } + ]); + + await manager.rollbackToSavepoint(client, 'session-2'); + expect(client.query.calledWith('ROLLBACK TO SAVEPOINT "sp_pgstudio_1"')).to.be.true; + expect(manager.getSavepoints('session-2')).to.deep.equal([]); + + try { + await manager.rollbackToSavepoint(client, 'session-2'); + expect.fail('Expected rollbackToSavepoint to fail without a savepoint'); + } catch (error) { + expect((error as Error).message).to.contain('No savepoint available for rollback'); + } + + try { + await manager.releaseSavepoint(client, 'session-2'); + expect.fail('Expected releaseSavepoint to fail without a savepoint'); + } catch (error) { + expect((error as Error).message).to.contain('No savepoint available for release'); + } + }); + + it('handles cell errors, isolation changes, cleanup, and invalid transitions', async () => { + const manager = new TransactionManager(); + const client = createClient(); + + try { + await manager.commitTransaction(client, 'missing'); + expect.fail('Expected commitTransaction to fail without an active transaction'); + } catch (error) { + expect((error as Error).message).to.equal('No active transaction to commit'); + } + + try { + await manager.rollbackTransaction(client, 'missing'); + expect.fail('Expected rollbackTransaction to fail without an active transaction'); + } catch (error) { + expect((error as Error).message).to.equal('No active transaction to rollback'); + } + + try { + await manager.createSavepoint(client, 'missing'); + expect.fail('Expected createSavepoint to fail without an active transaction'); + } catch (error) { + expect((error as Error).message).to.equal('No active transaction for savepoint creation'); + } + + try { + await manager.releaseSavepoint(client, 'missing'); + expect.fail('Expected releaseSavepoint to fail without an active transaction'); + } catch (error) { + expect((error as Error).message).to.equal('No active transaction for savepoint release'); + } + + try { + await manager.rollbackToSavepoint(client, 'missing'); + expect.fail('Expected rollbackToSavepoint to fail without an active transaction'); + } catch (error) { + expect((error as Error).message).to.equal('No active transaction for savepoint rollback'); + } + + manager.initializeSession('session-3', true); + await manager.beginTransaction(client, 'session-3'); + await manager.createSavepoint(client, 'session-3'); + + await manager.handleCellError(client, 'session-3', new Error('cell failed')); + expect(manager.getTransactionState('session-3')).to.deep.equal({ isActive: true, isFailed: false, savepointCount: 0 }); + + await manager.handleCellError(client, 'session-3', new Error('cell failed again')); + expect(client.query.calledWith('ROLLBACK')).to.be.true; + expect(manager.getTransactionInfo('session-3')?.isActive).to.be.false; + + manager.initializeSession('session-4', false); + await manager.beginTransaction(client, 'session-4'); + await manager.handleCellError(client, 'session-4', new Error('no rollback')); + expect(manager.isTransactionFailed('session-4')).to.be.true; + + const failingIsolationClient = { + query: sandbox.stub().rejects(new Error('bad isolation')) + } as any; + try { + await manager.setIsolationLevel(failingIsolationClient, 'SERIALIZABLE'); + expect.fail('Expected setIsolationLevel to fail when the client rejects'); + } catch (error) { + expect((error as Error).message).to.contain('Failed to set isolation level'); + } + + const brokenClient = { + query: sandbox.stub().rejects(new Error('connection failed')) + } as any; + try { + await manager.beginTransaction(brokenClient, 'session-5'); + expect.fail('Expected beginTransaction to surface the client failure'); + } catch (error) { + expect((error as Error).message).to.equal('connection failed'); + } + expect(manager.getTransactionInfo('session-5')?.state).to.equal('failed'); + expect(manager.isTransactionFailed('session-5')).to.be.true; + + manager.cleanupSession('session-4'); + expect(manager.getTransactionInfo('session-4')).to.equal(null); + expect(manager.getTransactionState('session-4')).to.deep.equal({ isActive: false, isFailed: false, savepointCount: 0 }); + }); +}); \ No newline at end of file diff --git a/src/test/unit/ViewCommands.test.ts b/src/test/unit/ViewCommands.test.ts new file mode 100644 index 0000000..b6c102b --- /dev/null +++ b/src/test/unit/ViewCommands.test.ts @@ -0,0 +1,134 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; + +import * as helper from '../../commands/helper'; +import * as views from '../../commands/views'; +import { CommandBase } from '../../common/commands/CommandBase'; +import { QueryBuilder } from '../../commands/helper'; +import { ViewSQL } from '../../commands/sql/views'; + +function createBuilderStub(sandbox: sinon.SinonSandbox) { + const builder: any = {}; + builder.addMarkdown = sandbox.stub().returns(builder); + builder.addSql = sandbox.stub().returns(builder); + builder.show = sandbox.stub().resolves(); + sandbox.stub(helper as any, 'NotebookBuilder').callsFake(function () { + return builder; + }); + return builder; +} + +describe('view commands', () => { + let sandbox: sinon.SinonSandbox; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + }); + + afterEach(() => { + sandbox.restore(); + }); + + function createItem() { + return { + connectionId: 'c1', + databaseName: 'appdb', + schema: 'public', + label: 'active_users' + } as any; + } + + it('covers the simple view notebook commands and refresh action', async () => { + const builder = createBuilderStub(sandbox); + const runStub = sandbox.stub(CommandBase, 'run').callsFake(async (_context, _item, _operation, action) => { + return await action({}, { query: sandbox.stub().resolves({ rows: [{ definition: 'SELECT 1' }] }) }, { databaseName: 'appdb' }); + }); + const refreshStub = sandbox.stub(); + + const item = createItem(); + const context = {} as any; + + await views.cmdScriptSelect(item, context); + await views.cmdScriptCreate(item, context); + await views.cmdViewData(item, context); + await views.cmdDropView(item, context); + await views.cmdCreateView(item, context); + await views.cmdRefreshView(item, context, { refresh: refreshStub } as any); + + expect(runStub.callCount).to.equal(5); + expect(refreshStub.calledOnceWithExactly(item)).to.be.true; + expect(builder.show.callCount).to.equal(5); + expect(builder.addSql.firstCall.args[0]).to.equal(ViewSQL.select('public', 'active_users')); + expect(builder.addSql.getCall(1).args[0]).to.contain('CREATE OR REPLACE VIEW public.active_users AS'); + expect(builder.addSql.getCall(2).args[0]).to.equal(ViewSQL.select('public', 'active_users')); + expect(builder.addSql.getCall(3).args[0]).to.contain('DROP VIEW IF EXISTS "public"."active_users";'); + expect(builder.addSql.getCall(4).args[0]).to.include('CREATE OR REPLACE VIEW "public"."new_view" AS'); + }); + + it('builds the editable view notebook and the full properties notebook', async () => { + const builder = createBuilderStub(sandbox); + const queryStub = sandbox.stub(); + queryStub.onCall(0).resolves({ rows: [{ definition: 'SELECT id, name FROM public.users' }] }); + queryStub.onCall(1).resolves({ + rows: [ + { + schema_name: 'public', + view_name: 'active_users', + owner: 'postgres', + comment: "Shows active users", + row_estimate: 12 + } + ] + }); + queryStub.onCall(2).resolves({ + rows: [ + { + column_name: 'id', + data_type: 'integer', + character_maximum_length: null, + numeric_precision: null, + numeric_scale: null, + ordinal_position: 1, + is_nullable: 'NO', + column_default: null, + description: 'Primary key' + }, + { + column_name: 'name', + data_type: 'text', + character_maximum_length: null, + numeric_precision: null, + numeric_scale: null, + ordinal_position: 2, + is_nullable: 'YES', + column_default: null, + description: 'Display name' + } + ] + }); + queryStub.onCall(3).resolves({ rows: [{ kind: 'view', schema: 'public', name: 'base_users' }] }); + queryStub.onCall(4).resolves({ rows: [{ kind: 'table', schema: 'public', name: 'user_roles' }] }); + queryStub.onCall(5).resolves({ rows: [{ view_size: '42 MB' }] }); + queryStub.onCall(6).resolves({ rows: [{ definition: 'SELECT id, name FROM public.users' }] }); + + const runStub = sandbox.stub(CommandBase, 'run').callsFake(async (_context, _item, _operation, action) => { + return await action({}, { query: queryStub }, { databaseName: 'appdb' }); + }); + const showErrorStub = sandbox.stub(); + + const item = createItem(); + await views.cmdEditView(item, {} as any); + await views.cmdViewOperations(item, {} as any); + await views.cmdShowViewProperties(item, {} as any); + + expect(runStub.callCount).to.equal(3); + expect(queryStub.firstCall.args[0]).to.equal(QueryBuilder.viewDefinition('public', 'active_users')); + expect(builder.addMarkdown.callCount).to.be.greaterThan(5); + expect(builder.addSql.called).to.be.true; + expect(builder.addSql.getCall(0).args[0]).to.contain('CREATE OR REPLACE VIEW public.active_users AS'); + expect(builder.addSql.getCall(1).args[0]).to.equal(ViewSQL.select('public', 'active_users')); + expect(builder.addSql.getCalls().some((call) => String(call.args[0]).includes('SELECT id, name FROM public.users'))).to.be.true; + expect(builder.addSql.getCalls().some((call) => String(call.args[0]).includes('DROP VIEW IF EXISTS "public"."active_users";'))).to.be.true; + expect(builder.show.calledThrice).to.be.true; + }); +}); \ No newline at end of file diff --git a/src/test/unit/dashboard/DashboardHtml.test.ts b/src/test/unit/dashboard/DashboardHtml.test.ts new file mode 100644 index 0000000..53956d5 --- /dev/null +++ b/src/test/unit/dashboard/DashboardHtml.test.ts @@ -0,0 +1,98 @@ +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import * as vscode from 'vscode'; +import { getHtmlForWebview } from '../../../dashboard/DashboardHtml'; + +describe('DashboardHtml', () => { + let sandbox: sinon.SinonSandbox; + let readFileStub: sinon.SinonStub; + let joinPathStub: sinon.SinonStub; + + beforeEach(() => { + sandbox = sinon.createSandbox(); + readFileStub = sandbox.stub(); + + sandbox.stub(vscode.workspace, 'fs').value({ + readFile: readFileStub + }); + + joinPathStub = sandbox.stub(vscode.Uri, 'joinPath').callsFake((base, ...segments) => { + return { fsPath: [base.fsPath, ...segments].join('/') } as vscode.Uri; + }); + }); + + afterEach(() => { + sandbox.restore(); + }); + + it('injects dashboard assets and escapes embedded stats safely', async () => { + const extensionUri = { fsPath: '/ext' } as vscode.Uri; + const webview = { cspSource: 'vscode-resource:' } as vscode.Webview; + + readFileStub.withArgs(sinon.match.has('fsPath', '/ext/templates/dashboard/index.html')) + .resolves(new TextEncoder().encode(` + + + + + + + + + + + `)); + readFileStub.withArgs(sinon.match.has('fsPath', '/ext/templates/dashboard/styles.css')) + .resolves(new TextEncoder().encode('body { color: red; }')); + readFileStub.withArgs(sinon.match.has('fsPath', '/ext/templates/dashboard/scripts.js')) + .resolves(new TextEncoder().encode('console.log("ready");')); + + const html = await getHtmlForWebview(webview, extensionUri, { + dbName: 'demo', + owner: 'owner', + size: '1 MB', + activeConnections: 0, + idleConnections: 0, + waitingConnections: 0, + totalConnections: 0, + maxConnections: 100, + extensionCount: 0, + topTables: [], + connectionStates: [], + objectCounts: { schemas: 0, tables: 0, views: 0, functions: 0, sequences: 0 }, + activeQueries: [{ + pid: 1, + usename: 'postgres', + datname: 'demo', + state: 'active', + duration: '00:00:01', + startTime: 'now', + query: 'SELECT 1;' + }], + blockingLocks: [], + metrics: { + xact_commit: 0, + xact_rollback: 0, + blks_read: 0, + blks_hit: 0, + deadlocks: 0, + conflicts: 0, + temp_bytes: 0, + temp_files: 0, + checkpoints_timed: 0, + checkpoints_req: 0, + tuples_fetched: 0, + tuples_returned: 0 + }, + waitEvents: [], + longRunningQueries: 0 + }); + + expect(html).to.contain('body { color: red; }'); + expect(html).to.contain('console.log("ready");'); + expect(html).to.contain('script-src \'nonce-'); + expect(html).to.contain('\\u003c/script\\u003e'); + expect(html).to.not.contain(' @@ -191,8 +191,10 @@

    + + diff --git a/templates/dashboard/scripts.js b/templates/dashboard/scripts.js index a45aedc..597bab3 100644 --- a/templates/dashboard/scripts.js +++ b/templates/dashboard/scripts.js @@ -53,8 +53,16 @@ let rollbackHistory = new Array(maxHistory).fill(0); let cacheHitHistory = new Array(maxHistory).fill(100); let longRunningHistory = new Array(maxHistory).fill(0); -// Initial State Placeholder - Will be injected -const initialStats = null; // __STATS_JSON__ +const statsElement = document.getElementById('dashboard-stats'); +let initialStats = null; + +if (statsElement && statsElement.textContent) { + try { + initialStats = JSON.parse(statsElement.textContent); + } catch (error) { + console.error('Dashboard: Failed to parse initial stats', error); + } +} // Track PIDs for lock visualization let blockingPids = new Set(); @@ -1118,4 +1126,6 @@ document.querySelectorAll('.tab').forEach(t => { // Init initializeDashboard(initialStats); -updateDashboard(initialStats); // Populate initial charts +if (initialStats) { + updateDashboard(initialStats); // Populate initial charts +} diff --git a/templates/dashboard/styles.css b/templates/dashboard/styles.css index 80854d9..3ae0509 100644 --- a/templates/dashboard/styles.css +++ b/templates/dashboard/styles.css @@ -5,40 +5,48 @@ --border-color: var(--vscode-widget-border); --muted-color: var(--vscode-descriptionForeground); --accent-color: var(--vscode-textLink-foreground); - --success-color: #4ade80; - --warning-color: #facc15; - --danger-color: #f87171; + --success-color: var(--vscode-testing-iconPassed, #4ade80); + --warning-color: var(--vscode-editorWarning-foreground, #facc15); + --danger-color: var(--vscode-errorForeground, #f87171); --font-family: var(--vscode-font-family); --card-radius: 6px; --card-border: 1px solid var(--border-color); + /* 4px spacing tokens */ + --sp-1: 4px; --sp-2: 8px; --sp-3: 12px; --sp-4: 16px; --sp-6: 24px; --sp-8: 32px; } body { background-color: var(--bg-color); color: var(--fg-color); font-family: var(--font-family); + font-size: 13px; margin: 0; - padding: 24px; + padding: var(--sp-6); display: flex; flex-direction: column; - gap: 32px; + gap: var(--sp-8); } -/* --- Typography --- */ -h1, -h2, -h3 { - margin: 0; - font-weight: 500; -} +/* --- Typography scale --- */ +h1, h2, h3 { margin: 0; font-weight: 500; } +/* Section headers: 12px/500 */ +.section-label, .label { - font-size: 0.75rem; + font-size: 12px; + font-weight: 500; text-transform: uppercase; letter-spacing: 0.05em; color: var(--muted-color); } +/* Meta/labels: 11px/400 muted */ +.meta, th { + font-size: 11px; + font-weight: 400; + color: var(--muted-color); +} + .value { font-size: 1.5rem; font-weight: 600; @@ -53,14 +61,14 @@ h3 { .grid-strip { display: grid; grid-template-columns: repeat(5, 1fr); - gap: 16px; + gap: var(--sp-4); } .card { background: var(--card-bg); border: var(--card-border); border-radius: var(--card-radius); - padding: 16px; + padding: var(--sp-4); display: flex; flex-direction: column; justify-content: space-between; @@ -82,17 +90,9 @@ h3 { margin-right: 6px; } -.status-ok { - background-color: var(--success-color); -} - -.status-warn { - background-color: var(--warning-color); -} - -.status-crit { - background-color: var(--danger-color); -} +.status-ok { background-color: var(--success-color); } +.status-warn { background-color: var(--warning-color); } +.status-crit { background-color: var(--danger-color); } /* --- Specific Sections --- */ .header { @@ -103,32 +103,30 @@ h3 { .header-info { display: flex; - gap: 24px; + gap: var(--sp-6); color: var(--muted-color); - font-size: 0.9rem; + font-size: 12px; } /* --- Tabs --- */ .tabs-nav { display: flex; border-bottom: 2px solid var(--border-color); - margin-bottom: 20px; + margin-bottom: var(--sp-4); } .tab { - padding: 8px 16px; + padding: var(--sp-2) var(--sp-4); cursor: pointer; opacity: 0.6; + font-size: 12px; font-weight: 500; border-bottom: 2px solid transparent; margin-bottom: -2px; transition: all 0.2s; } -.tab:hover { - opacity: 1; - color: var(--fg-color); -} +.tab:hover { opacity: 1; color: var(--fg-color); } .tab.active { opacity: 1; @@ -136,25 +134,20 @@ h3 { color: var(--accent-color); } -.tab-content { - display: none; -} - -.tab-content.active { - display: block; -} +.tab-content { display: none; } +.tab-content.active { display: block; } /* --- Charts Area --- */ .charts-row { display: grid; grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); - gap: 24px; + gap: var(--sp-6); } .chart-box { border: var(--card-border); border-radius: var(--card-radius); - padding: 16px; + padding: var(--sp-4); height: 200px; } @@ -169,52 +162,114 @@ h3 { table { width: 100%; border-collapse: collapse; - font-size: 0.9rem; + font-size: 13px; } th { text-align: left; - padding: 12px 16px; + padding: var(--sp-2) var(--sp-4); background: rgba(128, 128, 128, 0.05); font-weight: 500; + font-size: 11px; color: var(--muted-color); - font-size: 0.8rem; white-space: nowrap; } td { - padding: 12px 16px; + padding: var(--sp-2) var(--sp-4); border-top: 1px solid var(--border-color); + font-size: 13px; +} + +/* Hover-reveal row actions */ +tr { position: relative; } +tr .row-actions { + position: absolute; + right: var(--sp-2); + top: 50%; + transform: translateY(-50%); + display: flex; + gap: var(--sp-1); + opacity: 0; + pointer-events: none; + transition: opacity 0.12s ease; +} +tr:hover .row-actions { + opacity: 1; + pointer-events: auto; +} + +tr.row-crit { background: rgba(248, 113, 113, 0.15); } +tr.row-warn { background: rgba(250, 204, 21, 0.1); } + +/* --- Skeleton loading shimmer --- */ +@keyframes skeleton-pulse { + 0% { opacity: 0.45; } + 50% { opacity: 0.9; } + 100% { opacity: 0.45; } +} +.skeleton-cell { + height: 12px; + background: var(--border-color); + border-radius: 2px; + animation: skeleton-pulse 1.6s ease-in-out infinite; + display: inline-block; } -tr.row-crit { - background: rgba(248, 113, 113, 0.15); +/* --- Empty state --- */ +.empty-state { + display: flex; + flex-direction: column; + align-items: center; + gap: var(--sp-2); + padding: var(--sp-6) var(--sp-4); + color: var(--muted-color); + font-size: 12px; + text-align: center; +} +.empty-state .empty-cta { + margin-top: var(--sp-2); + padding: var(--sp-1) var(--sp-3); + font-size: 12px; + font-weight: 500; + background: var(--vscode-button-background); + color: var(--vscode-button-foreground); + border: none; + border-radius: 3px; + cursor: pointer; } +.empty-state .empty-cta:hover { background: var(--vscode-button-hoverBackground); } -tr.row-warn { - background: rgba(250, 204, 21, 0.1); +/* --- Destructive button --- */ +.btn-danger { + background: transparent; + color: var(--danger-color); + border: 1px solid var(--danger-color); + border-radius: 3px; + padding: var(--sp-1) var(--sp-3); + font-size: 12px; + font-weight: 500; + cursor: pointer; + transition: background 0.15s ease; +} +.btn-danger:hover:not(:disabled) { + background: color-mix(in srgb, var(--danger-color) 12%, transparent); } /* --- Lock Tree Visualizer --- */ .lock-node { border: 1px solid var(--border-color); - margin: 8px 0; - padding: 12px; + margin: var(--sp-2) 0; + padding: var(--sp-3); border-radius: 4px; } .lock-children { - margin-left: 24px; + margin-left: var(--sp-6); border-left: 2px solid var(--border-color); - padding-left: 12px; + padding-left: var(--sp-3); } /* --- Detail View --- */ -#detail-view { - display: none; - margin-top: 24px; -} - -#main-view { - display: block; -} \ No newline at end of file +#detail-view { display: none; margin-top: var(--sp-6); } +#main-view { display: block; } \ No newline at end of file