Merge branch 'main' into feat/scenarios

Author: markurtz

.eslintrc.json

@@ -0,0 +1,69 @@
+{
+  "env": {
+    "browser": true,
+    "es2024": true,
+    "jest": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "next",
+    "next/core-web-vitals",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 2024,
+    "project": ["src/ui/tsconfig.json", "tsconfig.test.json", "tsconfig.cypress.json"],
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "import", "jest", "no-secrets", "react"],
+  "root": true,
+  "rules": {
+    "complexity": ["warn", { "max": 8 }],
+    "curly": ["error", "all"],
+    "import/order": [
+      "error",
+      {
+        "groups": [
+          ["builtin", "external"],
+          ["internal", "parent", "sibling", "index"]
+        ],
+        "newlines-between": "always-and-inside-groups",
+        "pathGroups": [
+          {
+            "pattern": "@{app,assets,classes,components,hooks,lib,pages,store,tests,types,utils}/**",
+            "group": "internal",
+            "position": "before"
+          },
+          {
+            "pattern": "{.,..}/**",
+            "group": "internal",
+            "position": "after"
+          }
+        ],
+        "pathGroupsExcludedImportTypes": ["builtin"],
+        "alphabetize": { "order": "asc", "caseInsensitive": true }
+      }
+    ],
+    "import/no-extraneous-dependencies": ["error"],
+    "no-secrets/no-secrets": ["error", { "additionalRegexes": {}, "ignoreContent": [] }]
+  },
+  "settings": {
+    "next": { "rootDir": ["src/ui/", "tests/ui/"] },
+    "import/resolver": {
+      "typescript": {
+        "project": [
+          "src/ui/tsconfig.json",
+          "tsconfig.test.json",
+          "tsconfig.cypress.json"
+        ]
+      }
+    }
+  }
+}

.github/workflows/development.yml

@@ -1,7 +1,7 @@
 name: Development
 
 on:
-  pull_request:
+  pull_request_target:
     types: [opened, synchronize, reopened]
 
 jobs:
@@ -31,11 +31,9 @@ jobs:
 
       - name: Install dependencies
         run: npm ci
-        working-directory: src/ui
 
       - name: Run quality and typing checks
         run: npm run lint
-        working-directory: src/ui
 
   type-checks:
     runs-on: ubuntu-latest
@@ -63,11 +61,9 @@ jobs:
 
       - name: Install dependencies
         run: npm ci
-        working-directory: src/ui
 
       - name: Run quality and typing checks
         run: npm run type-check
-        working-directory: src/ui
 
   precommit-checks:
     runs-on: ubuntu-latest
@@ -83,7 +79,7 @@ jobs:
       - name: Install dependencies
         run: pip install pre-commit
       - name: Run pre-commit checks
-        run: pre-commit run --all-files
+        run: SKIP=ruff-format pre-commit run --all-files
 
   ui-precommit-check:
     permissions:
@@ -94,12 +90,10 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install dependencies
-        working-directory: src/ui
         run: npm ci
 
       - name: Run pre-commit checks
         run: npx husky run pre-commit
-        working-directory: src/ui
 
   unit-tests:
     runs-on: ubuntu-latest
@@ -117,6 +111,20 @@ jobs:
       - name: Run unit tests
         run: tox -e test-unit -- -m "smoke or sanity"
 
+  ui-unit-tests:
+    permissions:
+      contents: "read"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run unit tests
+        run: npm run test:unit
+
   integration-tests:
     runs-on: ubuntu-latest
     strategy:
@@ -133,6 +141,20 @@ jobs:
       - name: Run integration tests
         run: tox -e test-integration -- -m smoke
 
+  ui-integration-tests:
+    permissions:
+      contents: "read"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run integration tests
+        run: npm run test:integration
+
   build:
     runs-on: ubuntu-latest
     strategy:

.github/workflows/main.yml

@@ -52,7 +52,7 @@ jobs:
       - name: Install dependencies
         run: pip install pre-commit
       - name: Run pre-commit checks
-        run: pre-commit run --all-files
+        run: SKIP=ruff-format pre-commit run --all-files
 
   unit-tests:
     runs-on: ubuntu-latest

.gitignore

@@ -217,11 +217,14 @@ yarn-error.log*
 src/ui/.vercel
 
 # typescript
-src/ui/*.tsbuildinfo
+*.tsbuildinfo
 src/ui/next-env.d.ts
 
 # Root-level UI config files that should be tracked
 !package.json
 !package-lock.json
 !.eslintrc.json
 !tsconfig.json
+!tsconfig.*.json
+!src/ui/lib
+!src/ui/public/manifest.json

.pre-commit-config.yaml

@@ -8,6 +8,10 @@ repos:
   rev: v0.11.7
   hooks:
     - id: ruff
+      name: run linter
+      args: [ --fix, --show-fixes ]
+    - id: ruff-format
+      name: run formatter
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: v1.15.0
   hooks:

.prettierignore

@@ -0,0 +1,18 @@
+# === Don't touch ===
+*.md
+*.mdx
+*.yaml
+*.yml
+
+# === Skip all JSON …
+*.json
+
+# === include relevant json ===
+!src/ui/**/*.json
+!tests/ui/**/*.json
+
+# Root-level configs to format
+!/.eslintrc.json
+!/tsconfig*.json
+!/*.config.{js,ts}
+!/jest.setup.ts

src/ui/.prettierrc renamed to .prettierrc

@@ -179,6 +179,68 @@ Review the coverage report to confirm that your new code is adequately tested.
 
 3. **Address Feedback**: Respond to any feedback from reviewers and make necessary changes.
 
+## Developing the Web UI
+
+The GuideLLM project includes a frontend UI located in `src/ui`, built using [Next.js](https://nextjs.org/). This section provides instructions for working on the UI.
+
+### Getting Started
+
+To start the local development server:
+
+```bash
+npm run dev
+```
+
+Then open [http://localhost:3000](http://localhost:3000) in your browser.
+
+### Building for Production
+
+To build the app for production (output in the `out` directory):
+
+```bash
+npm run build
+```
+
+### Running UI Tests
+
+- **Unit tests**:
+
+  ```bash
+  npm run test:unit
+  ```
+
+- **Integration tests**:
+
+  ```bash
+  npm run test:integration
+  ```
+
+- **End-to-end tests** (using Cypress, ensure live dev server):
+
+  ```bash
+  npm run test:e2e
+  ```
+
+### Code Quality and Styling
+
+- **Fix styling issues**:
+
+  ```bash
+  npm run format
+  ```
+
+- **Run ESLint checks**:
+
+  ```bash
+  npm run lint
+  ```
+
+- **Run TS type checks**:
+
+  ```bash
+  npm run type-checks
+  ```
+
 ## Additional Resources
 
 - [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.

DEVELOPING.md

@@ -0,0 +1,9 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {
+    specPattern: 'tests/ui/cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'tests/ui/cypress/support/e2e.ts',
+    baseUrl: 'http://localhost:3000', // optional, but good practice
+  },
+});

cypress.config.ts

@@ -0,0 +1,48 @@
+ARG PYTHON=3.13
+
+# Use a multi-stage build to create a lightweight production image
+FROM docker.io/python:${PYTHON}-slim as builder
+
+# Copy repository files
+COPY / /src
+
+# Create a venv and install guidellm
+RUN python3 -m venv /opt/guidellm \
+    && /opt/guidellm/bin/pip install --no-cache-dir /src
+
+# Copy entrypoint script into the venv bin directory
+RUN install -m0755 /src/deploy/entrypoint.sh /opt/guidellm/bin/entrypoint.sh
+
+# Prod image
+FROM docker.io/python:${PYTHON}-slim
+
+# Copy the virtual environment from the builder stage
+COPY --from=builder /opt/guidellm /opt/guidellm
+
+# Add guidellm bin to PATH
+ENV PATH="/opt/guidellm/bin:$PATH"
+
+# Create a non-root user
+RUN useradd -md /results guidellm
+
+# Switch to non-root user
+USER guidellm
+
+# Set working directory
+WORKDIR /results
+
+# Metadata
+LABEL org.opencontainers.image.source="https://github.com/neuralmagic/guidellm" \
+      org.opencontainers.image.description="GuideLLM Performance Benchmarking Container"
+
+# Set the environment variable for the benchmark script
+# TODO: Replace with scenario environment variables
+ENV GUIDELLM_TARGET="http://localhost:8000" \
+    GUIDELLM_MODEL="neuralmagic/Meta-Llama-3.1-8B-Instruct-quantized.w4a16" \
+    GUIDELLM_RATE_TYPE="sweep" \
+    GUIDELLM_DATA="prompt_tokens=256,output_tokens=128" \
+    GUIDELLM_MAX_REQUESTS="100" \
+    GUIDELLM_MAX_SECONDS="" \
+    GUIDELLM_OUTPUT_PATH="/results/results.json"
+
+ENTRYPOINT [ "/opt/guidellm/bin/entrypoint.sh" ]