Merge pull request #73 from supabase-community/chore/coveralls

chore: add coverage reporting via coveralls

Author: gregnr

.github/workflows/tests.yml

@@ -19,6 +19,12 @@ jobs:
       - name: Install dependencies
         run: npm ci --ignore-scripts
       - name: Build libs
-        run: npm run build
+        run: |
+          npm run build
+          npm rebuild # To create bin links
       - name: Tests
-        run: npm run test
+        run: npm run test:coverage
+      - name: Upload coverage results to Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          base-path: ./packages/mcp-server-supabase

package-lock.json

@@ -4,7 +4,8 @@
   ],
   "scripts": {
     "build": "npm run build --workspace @supabase/mcp-utils --workspace @supabase/mcp-server-supabase",
-    "test": "npm run test --workspace @supabase/mcp-utils --workspace @supabase/mcp-server-supabase"
+    "test": "npm run test --workspace @supabase/mcp-utils --workspace @supabase/mcp-server-supabase",
+    "test:coverage": "npm run test:coverage --workspace @supabase/mcp-server-supabase"
   },
   "devDependencies": {
     "supabase": "^2.1.1"

package.json

@@ -0,0 +1 @@
+test/coverage

packages/mcp-server-supabase/.gitignore

@@ -11,8 +11,10 @@
     "build": "tsup --clean",
     "prepublishOnly": "npm run build",
     "test": "vitest",
-    "test:e2e": "vitest --project e2e",
     "test:unit": "vitest --project unit",
+    "test:e2e": "vitest --project e2e",
+    "test:integration": "vitest --project integration",
+    "test:coverage": "vitest --coverage",
     "generate:management-api-types": "openapi-typescript https://api.supabase.com/api/v1-json -o ./src/management-api/types.ts"
   },
   "files": [
@@ -42,6 +44,7 @@
     "@total-typescript/tsconfig": "^1.0.4",
     "@types/common-tags": "^1.8.4",
     "@types/node": "^22.8.6",
+    "@vitest/coverage-v8": "^2.1.9",
     "ai": "^4.3.4",
     "date-fns": "^4.1.0",
     "dotenv": "^16.5.0",

packages/mcp-server-supabase/package.json

@@ -0,0 +1,59 @@
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+import { StreamTransport } from '@supabase/mcp-utils';
+import { describe, expect, test } from 'vitest';
+import {
+  ACCESS_TOKEN,
+  API_URL,
+  MCP_CLIENT_NAME,
+  MCP_CLIENT_VERSION,
+} from '../test/mocks.js';
+import { createSupabaseMcpServer } from './index.js';
+
+type SetupOptions = {
+  accessToken?: string;
+  projectId?: string;
+  readOnly?: boolean;
+};
+
+async function setup(options: SetupOptions = {}) {
+  const { accessToken = ACCESS_TOKEN, projectId, readOnly } = options;
+  const clientTransport = new StreamTransport();
+  const serverTransport = new StreamTransport();
+
+  clientTransport.readable.pipeTo(serverTransport.writable);
+  serverTransport.readable.pipeTo(clientTransport.writable);
+
+  const client = new Client(
+    {
+      name: MCP_CLIENT_NAME,
+      version: MCP_CLIENT_VERSION,
+    },
+    {
+      capabilities: {},
+    }
+  );
+
+  const server = createSupabaseMcpServer({
+    platform: {
+      apiUrl: API_URL,
+      accessToken,
+    },
+    projectId,
+    readOnly,
+  });
+
+  await server.connect(serverTransport);
+  await client.connect(clientTransport);
+
+  return { client, clientTransport, server, serverTransport };
+}
+
+describe('index', () => {
+  test('index.ts exports a working server', async () => {
+    const { client } = await setup();
+
+    const { tools } = await client.listTools();
+
+    expect(tools.length).toBeGreaterThan(0);
+  });
+});