feat: CI improvements and web UI implementation #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

MBanucu wants to merge 344 commits into shekohex:main from MBanucu:fix-ci-shekohex

.github/ISSUE_TEMPLATE/bug_report.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,9 +1,9 @@
  
    ---

    name: Bug Report

    about: Report a bug with the opencode-pty plugin

    title: "[Bug]: "

    labels: ["bug"]

    assignees: ""

    title: '[Bug]: '

    labels: ['bug']

    assignees: ''

    ---

    ## Description

.github/ISSUE_TEMPLATE/feature_request.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,9 +1,9 @@
  
    ---

    name: Feature Request

    about: Suggest a new feature or enhancement

    title: "[Feature]: "

    labels: ["enhancement"]

    assignees: ""

    title: '[Feature]: '

    labels: ['enhancement']

    assignees: ''

    ---

    ## Problem Statement

.github/workflows/ci.yml

-Original file line number
+Diff line change
@@ -0,0 +1,81 @@
+    name: CI
+    on:
+      push:
+        branches: [main]
+      pull_request:
+        branches: [main]
+      workflow_dispatch:
+    permissions:
+      contents: read
+      actions: read
+    jobs:
+      test:
+        strategy:
+          fail-fast: false
+          matrix:
+            quality: [test --timeout=30000, run typecheck, run lint, run format:check, run test:e2e]
+        runs-on: ubuntu-24.04
+        steps:
+          - name: Checkout
+            uses: actions/checkout@v6
+          - name: Setup Bun
+            uses: oven-sh/setup-bun@v2
+            with:
+              bun-version: 1.3.6
+          - name: Cache Bun dependencies
+            uses: actions/cache@v5
+            with:
+              path: ~/.bun/install/cache
+              key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
+              restore-keys: |
+                ${{ runner.os }}-bun-
+          - name: Install dependencies
+            run: bun install
+          - name: Install Playwright Browsers
+            run: bunx playwright install --with-deps
+          - name: Build
+            run: bun run build:prod
+          - name: Run test
+            run: bun ${{matrix.quality}}
+      dependency-review:
+        runs-on: ubuntu-24.04
+        if: github.event_name == 'pull_request'
+        steps:
+          - name: Checkout Repository
+            uses: actions/checkout@v6
+          - name: Dependency Review
+            uses: actions/dependency-review-action@v4
+      nix-flake-test:
+        strategy:
+          fail-fast: false
+          matrix:
+            quality: [bun run quality, bun test, bun run test:e2e]
+        name: Nix Flake CI
+        runs-on: ubuntu-latest
+        steps:
+          - name: Checkout repository
+            uses: actions/checkout@v6
+          - name: Install Nix
+            uses: DeterminateSystems/nix-installer-action@v21
+          - name: Enable Magic Nix Cache
+            uses: DeterminateSystems/magic-nix-cache-action@v13
+          - name: Install dependencies (Nix devShell)
+            run: nix --experimental-features 'nix-command flakes' develop .# --command -- bun install
+          - name: Build (Nix devShell)
+            run: nix --experimental-features 'nix-command flakes' develop .# --command -- bun run build
+          - name: Quality checks (Nix devShell)
+            run: nix --experimental-features 'nix-command flakes' develop .# --command -- ${{matrix.quality}}

.github/workflows/release.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,9 +1,11 @@
  
    name: Release

    on:

      push:

        branches:

          - main

      workflow_run:

        workflows: ['CI']

        types:

          - completed

        branches: [main]

      workflow_dispatch:

    permissions:

    @@ -12,26 +14,27 @@ permissions:
  
    jobs:

      publish:

        if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}

        runs-on: ubuntu-latest

        steps:

          - name: Checkout

            uses: actions/checkout@v4

            with:

              fetch-depth: 0

          - name: Use Node.js

            uses: actions/setup-node@v4

          - name: Setup Bun

            uses: oven-sh/setup-bun@v1

            with:

              node-version: 20

              bun-version: latest

          - name: Determine release state

            id: determine

            run: |

              set -euo pipefail

              CURRENT_VERSION=$(node -p "require('./package.json').version")

              CURRENT_VERSION=$(bun -e 'import pkg from "./package.json"; console.log(pkg.version)')

              echo "current_version=$CURRENT_VERSION" >> "$GITHUB_OUTPUT"

              if git rev-parse HEAD^ >/dev/null 2>&1; then

                PREVIOUS_VERSION=$(node -e "const { execSync } = require('node:child_process'); try { const data = execSync('git show HEAD^:package.json', { stdio: ['ignore', 'pipe', 'ignore'] }); const json = JSON.parse(data.toString()); if (json && typeof json.version === 'string') { process.stdout.write(json.version); } } catch (error) {}")

                PREVIOUS_VERSION=$(bun -e "const { execSync } = require('node:child_process'); try { const data = execSync('git show HEAD^:package.json', { stdio: ['ignore', 'pipe', 'ignore'] }); const json = JSON.parse(data.toString()); if (json && typeof json.version === 'string') { process.stdout.write(json.version); } } catch (error) {}")

                PREVIOUS_VERSION=${PREVIOUS_VERSION//$'\n'/}

              else

                PREVIOUS_VERSION=""

    @@ -51,13 +54,7 @@ jobs:
  
          - name: Install dependencies

            if: steps.determine.outputs.changed == 'true' && steps.determine.outputs.tag_exists == 'false'

            run: |

              npm install -g npm@latest

              npm install

          - name: Type check

            if: steps.determine.outputs.changed == 'true' && steps.determine.outputs.tag_exists == 'false'

            run: npx tsc --noEmit

            run: bun install

          - name: Generate release notes

            if: steps.determine.outputs.changed == 'true' && steps.determine.outputs.tag_exists == 'false'

    @@ -123,15 +120,13 @@ jobs:
  
          - name: Create GitHub release

            if: steps.determine.outputs.changed == 'true' && steps.determine.outputs.tag_exists == 'false'

            uses: actions/create-release@v1

            run: |

              gh release create "v${{ steps.determine.outputs.current_version }}" \

                --title "v${{ steps.determine.outputs.current_version }}" \

                --notes "${{ steps.release_notes.outputs.body }}"

            env:

              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

            with:

              tag_name: v${{ steps.determine.outputs.current_version }}

              release_name: v${{ steps.determine.outputs.current_version }}

              body: ${{ steps.release_notes.outputs.body }}

              generate_release_notes: false

          - name: Publish to npm

            if: steps.determine.outputs.changed == 'true' && steps.determine.outputs.tag_exists == 'false'

            run: npm publish --access public --provenance

            run: bunx npm publish --access public --provenance

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,10 @@ dist @@
     coverage
     *.lcov
+    # test results and reports
+    playwright-report/
+    test-results/
     # logs
     logs
     _.log
@@ Expand Down @@

.opencode/agents/docs/architecture.md

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+    # Architecture
+    ## Project Structure (Directory/Files)
+    - `src/plugin/pty/` — Core PTY logic, types, manager, buffer, permissions, and tools
+    - `src/web/` — React-based web UI, server, live session and terminal interaction
+    - `test/` — Unit and agent-facing tests
+    - `e2e/` — End-to-end (Playwright) tests, for web UI/session validation
+    - Use camelCase for function/variable names; PascalCase for types/classes; UPPER_CASE for constants; kebab-case for directories.
+    ## Terminal System Architecture
+    ### Core Components
+    - **`RawTerminal` Component** (`src/web/client/components/TerminalRenderer.tsx`): Single React component handling all terminal rendering and input. Uses xterm.js for terminal emulation with optimized diff-based updates.
+    - **`useWebSocket` Hook** (`src/web/client/hooks/useWebSocket.ts`): Manages WebSocket connections, handles incoming messages (raw_data, session_update, session_list), and routes data to appropriate handlers.
+    - **`useSessionManager` Hook** (`src/web/client/hooks/useSessionManager.ts`): Handles session lifecycle, input sending, and session switching with buffer fetching.
+    - **PTY Manager** (`src/plugin/pty/manager.ts`): Server-side session management, process spawning, and buffer operations.
+    ### Data Flow
+. **Input Flow**: User types → `RawTerminal.onData` → `handleSendInput` → POST `/api/sessions/:id/input` → WebSocket `raw_data` message → `onRawData` callback → `rawOutput` state update → `TerminalRenderer.componentDidUpdate` → xterm.js display
+. **Output Flow**: PTY process output → `SessionLifecycle.onData` → buffer append → WebSocket `raw_data` message → `onRawData` → display update
+. **Session Switching**: Click session → `handleSessionClick` → fetch buffer → replace `rawOutput` state → clear and rewrite terminal
+    ### Key Design Decisions
+    - **No Local Echo**: Input is sent directly to PTY process; PTY handles all echoing to prevent double characters
+    - **Diff-Based Updates**: Terminal only writes changed content for performance
+    - **Single Component**: Simplified from inheritance hierarchy to single `RawTerminal` class
+    - **WebSocket-Driven**: Real-time updates via WebSocket messages rather than polling

.opencode/agents/docs/code-style.md

-Original file line number
+Diff line change
@@ -0,0 +1,38 @@
+    # Code Style
+    ## Naming Conventions
+    - **Functions/Variables**: camelCase (`setOnSessionUpdate`, `rawOutputCallbacks`)
+    - **Types/Classes**: PascalCase (`PTYManager`, `SessionLifecycleManager`)
+    - **Constants**: UPPER_CASE (`DEFAULT_READ_LIMIT`, `MAX_LINE_LENGTH`)
+    - **Directories**: kebab-case (`src/web/client`, `e2e`)
+    - **Files**: kebab-case for directories, camelCase for components/hooks (`useWebSocket.ts`, `TerminalRenderer.tsx`)
+    ## TypeScript Configuration
+    - Strict TypeScript settings enabled (`strict: true`)
+    - Module resolution: `"bundler"` with `"moduleResolution": "bundler"`
+    - Target: ESNext with modern features
+    - No implicit returns or unused variables/parameters allowed
+    - Explicit type annotations required where beneficial
+    ## Formatting (Prettier)
+    - **Semicolons**: Disabled (`semi: false`)
+    - **Quotes**: Single quotes preferred (`singleQuote: true`)
+    - **Trailing commas**: ES5 style (`trailingComma: "es5"`)
+    - **Print width**: 100 characters (`printWidth: 100`)
+    - **Indentation**: 2 spaces, no tabs (`tabWidth: 2`, `useTabs: false`)
+    ## Import/Export Style
+    - Use ES6 imports/exports
+    - Group imports: external libraries first, then internal modules
+    - Prefer named exports over default exports for better tree-shaking
+    - Use absolute imports for internal modules where possible
+    ## Documentation
+    - Use JSDoc comments for public APIs
+    - Inline comments for complex logic
+    - No redundant comments on self-explanatory code

.opencode/agents/docs/commands.md

-Original file line number
+Diff line change
@@ -0,0 +1,39 @@
+    # Commands
+    ## Development/Run/Build
+    - `bun run dev` — Start Vite-based development server (frontend only)
+    - `bun run dev:server` — Start PTY Web UI/API in dev mode (test Web server)
+    - `bun run build` — Clean, typecheck, and build all assets
+    - `bun run build:dev` — Build assets in development mode
+    - `bun run build:prod` — Build assets in production mode
+    - `bun run install:web:dev` — Build web client in dev mode
+    - `bun run install:all:dev` — Build/install plugin & web client
+    - `bun run run:all:dev` — Full build/install workflow then run OpenCode (silent)
+    - `bun run preview` — Preview built UI site
+    ## Lint/Format/Quality
+    - `bun run lint` — Run ESLint on all source (strict)
+    - `bun run lint:fix` — ESLint auto-fix
+    - `bun run format` — Prettier formatting (writes changes)
+    - `bun run format:check` — Prettier check only
+    - `bun run quality` — Lint, format check, and typecheck (all code-quality checks)
+    ## Test & Typecheck
+    - `bun run typecheck` — Typescript strict check (no emit)
+    - `bun run typecheck:watch` — Typecheck in watch mode
+    - `bun test` — Run unit tests
+    - `bun test --test-name-pattern <pattern>` — Run filtered unit tests
+    - `bun run test:e2e` — Playwright end-to-end tests; ensure dev server built, uses `PW_DISABLE_TS_ESM=1` (disables trouble causing Playwright/Bun features) and `NODE_ENV=test` (used by tests)
+    - `bun run test:all` — All unit + E2E tests
+    - Run filtered E2E tests: `bun run test:e2e -- --grep "<pattern>"` (also supports `--repeat-each <N>` for flakiness detection and `--project <name>` for specific browser projects)
+    ## Other
+    - `bun run clean` — Remove build artifacts, test results, etc.
+    - `bun run ci` — Run quality checks and all tests (used by CI pipeline)
+    - `bun run prepack` — Automatically runs before `npm pack`; builds plugin for OpenCode consumption
+    **Note:** Many scripts have special requirements or additional ENV flags; see inline package.json script comments for platform- or environment-specific details (e.g. Playwright+Bun TS support requires `PW_DISABLE_TS_ESM=1`).

.opencode/agents/docs/contributing.md

-Original file line number
+Diff line change
@@ -0,0 +1,35 @@
+    # Contributing
+    ## Development Workflow
+. **Fork & Branch**: Create feature branch from main
+. **Code Changes**: Follow established conventions
+. **Testing**: Add/update tests for new functionality
+. **Quality Checks**: Run `bun run quality` before committing
+. **Commit**: Use descriptive commit messages
+. **Pull Request**: Create PR with clear description
+    ## Pull Request Requirements
+    - **Tests**: Include unit and E2E tests as appropriate
+    - **Documentation**: Update AGENTS.md for significant changes
+    - **Breaking Changes**: Clearly document API changes
+    - **Code Review**: Address review feedback
+    - **CI**: All checks must pass
+    ## Code Review Checklist
+    - [ ] TypeScript types correct and complete
+    - [ ] Error handling appropriate
+    - [ ] Tests added/updated
+    - [ ] Documentation updated
+    - [ ] Security considerations addressed
+    - [ ] Performance implications considered
+    - [ ] Code style conventions followed
+    ## Commit Message Convention
+    - Use imperative mood: "Add feature" not "Added feature"
+    - Start with action verb (Add, Fix, Update, Remove, etc.)
+    - Keep first line under 50 characters
+    - Add detailed description for complex changes

.opencode/agents/docs/dependencies.md

-Original file line number
+Diff line change
@@ -0,0 +1,29 @@
+    # Dependencies
+    ## Package Management
+    - **Runtime**: Bun for fast package management and execution
+    - **Dependencies**: Listed in `package.json` with specific versions
+    - **Lockfile**: `bun.lockb` ensures reproducible installs
+    - **Peer Dependencies**: TypeScript ^5 required
+    ## Key Dependencies
+    - `@opencode-ai/plugin` & `@opencode-ai/sdk` — OpenCode integration
+    - `@xterm/xterm` & `@xterm/addon-*` — Terminal emulation
+    - `bun-pty` — PTY process management
+    - `react` & `react-dom` — Web UI framework
+    - `strip-ansi` — ANSI escape sequence removal
+    ## Development Dependencies
+    - Testing: `@playwright/test`, Bun test runner
+    - Code Quality: `eslint`, `prettier`, `typescript`
+    - Build: `vite`, `@vitejs/plugin-react`
+    ## Updating Dependencies
+    - Use `bun update <package>` for specific package updates
+    - Run full test suite after updates
+    - Check for breaking changes in changelogs
+    - Update lockfile and commit together

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: CI improvements and web UI implementation #13

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

feat: CI improvements and web UI implementation #13

Are you sure you want to change the base?

Uh oh!

feat: CI improvements and web UI implementation #13

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!