@nospt/plugin-dev-ai-hub-backend 0.2.4 → 0.3.1

package/src/router.smoke.test.ts

@@ -1,262 +0,0 @@
-/**
- * Smoke tests for the Express router created by `createRouter`.
- *
- * These tests verify that all route patterns are correctly resolved by
- * path-to-regexp (via Express), that :id parameters are captured, and that the
- * right status codes are returned — without starting a real Backstage backend.
- */
-
-import express from 'express';
-import request from 'supertest';
-import { createRouter } from './router';
-import type { AiAssetStore } from './database/AiAssetStore';
-import type { AiAssetSyncService } from './service/AiAssetSyncService';
-import type { LoggerService } from '@backstage/backend-plugin-api';
-import type { ProviderConfig } from './types';
-
-// ── Fixtures ─────────────────────────────────────────────────────────────────
-
-const ASSET_SUMMARY = {
-  id: 'asset-123',
-  providerId: 'provider-1',
-  name: 'Test Instruction',
-  description: 'A test asset',
-  type: 'instruction',
-  tools: ['github-copilot'],
-  tags: ['test'],
-  author: 'tester',
-  version: '1.0.0',
-  installCount: 5,
-  syncedAt: '2026-01-01T00:00:00Z',
-  createdAt: '2026-01-01T00:00:00Z',
-  updatedAt: '2026-01-01T00:00:00Z',
-} as const;
-
-const ASSET_FULL = {
-  ...ASSET_SUMMARY,
-  content: '# Test Instruction\n\nSome content.',
-  yamlRaw: 'name: test',
-  yamlPath: 'instructions/test.yaml',
-  mdPath: 'instructions/test.md',
-  repoUrl: 'https://github.com/org/repo',
-  branch: 'main',
-  resourcesContent: null,
-  installPaths: null,
-  installPath: null,
-  icon: null,
-  label: null,
-  metadata: null,
-};
-
-const PROVIDER: ProviderConfig = {
-  id: 'provider-1',
-  type: 'github',
-  target: 'https://github.com/org/repo',
-  branch: 'main',
-  schedule: {
-    frequency: { hours: 1 },
-    timeout: { minutes: 5 },
-  },
-};
-
-// ── Mocks ────────────────────────────────────────────────────────────────────
-
-function makeStoreMock(overrides: Partial<AiAssetStore> = {}): AiAssetStore {
-  return {
-    listAssets: jest.fn().mockResolvedValue({ items: [ASSET_SUMMARY], totalCount: 1 }),
-    getAsset: jest.fn().mockImplementation(async (id: string) =>
-      id === 'asset-123' ? ASSET_FULL : null,
-    ),
-    incrementInstallCount: jest.fn().mockResolvedValue(undefined),
-    getAllSyncStatuses: jest.fn().mockResolvedValue([
-      { providerId: 'provider-1', status: 'idle', assetCount: 1 },
-    ]),
-    getSyncStatus: jest.fn().mockImplementation(async (id: string) =>
-      id === 'provider-1' ? { providerId: 'provider-1', status: 'idle', assetCount: 1 } : null,
-    ),
-    getStats: jest.fn().mockResolvedValue({
-      totalAssets: 1,
-      byType: { instruction: 1, agent: 0, skill: 0, workflow: 0 },
-      byTool: { 'github-copilot': 1 },
-      byProvider: { 'provider-1': 1 },
-    }),
-    // remaining methods not needed by router
-    upsertAsset: jest.fn(),
-    deleteAssetsNotIn: jest.fn(),
-    upsertSyncStatus: jest.fn(),
-    ...overrides,
-  } as unknown as AiAssetStore;
-}
-
-function makeSyncServiceMock(): AiAssetSyncService {
-  return {
-    syncProvider: jest.fn().mockResolvedValue(undefined),
-    start: jest.fn().mockResolvedValue(undefined),
-  } as unknown as AiAssetSyncService;
-}
-
-const noopLogger: LoggerService = {
-  error: jest.fn(),
-  warn: jest.fn(),
-  info: jest.fn(),
-  debug: jest.fn(),
-  child: jest.fn().mockReturnThis(),
-};
-
-// ── Test app factory ──────────────────────────────────────────────────────────
-
-function makeApp(storeOverrides: Partial<AiAssetStore> = {}) {
-  const store = makeStoreMock(storeOverrides);
-  const syncService = makeSyncServiceMock();
-
-  const router = createRouter({
-    logger: noopLogger,
-    store,
-    syncService,
-    providers: [PROVIDER],
-  });
-
-  const app = express();
-  app.use(express.json());
-  app.use(router);
-  return { app, store, syncService };
-}
-
-// ── Tests ─────────────────────────────────────────────────────────────────────
-
-describe('router smoke tests (path-to-regexp route matching)', () => {
-  // ── /assets ────────────────────────────────────────────────────────────────
-
-  describe('GET /assets', () => {
-    it('returns 200 with paginated asset list', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/assets');
-      expect(res.status).toBe(200);
-      expect(res.body).toMatchObject({ items: expect.any(Array), totalCount: 1 });
-    });
-
-    it('forwards query parameters to the store', async () => {
-      const { app, store } = makeApp();
-      await request(app).get('/assets?type=instruction&search=test&page=2&pageSize=5');
-      expect(store.listAssets).toHaveBeenCalledWith(
-        expect.objectContaining({ type: 'instruction', search: 'test', page: 2, pageSize: 5 }),
-      );
-    });
-  });
-
-  describe('GET /assets/:id', () => {
-    it('returns 200 for a known asset and captures the :id param', async () => {
-      const { app, store } = makeApp();
-      const res = await request(app).get('/assets/asset-123');
-      expect(res.status).toBe(200);
-      expect(store.getAsset).toHaveBeenCalledWith('asset-123');
-      expect(res.body.id).toBe('asset-123');
-    });
-
-    it('returns 404 for an unknown asset', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/assets/does-not-exist');
-      expect(res.status).toBe(404);
-      expect(res.body.error).toMatch(/not found/i);
-    });
-  });
-
-  describe('GET /assets/:id/raw', () => {
-    it('returns 200 with text/markdown content type', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/assets/asset-123/raw');
-      expect(res.status).toBe(200);
-      expect(res.headers['content-type']).toMatch(/text\/markdown/);
-    });
-
-    it('returns 404 when asset does not exist', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/assets/missing/raw');
-      expect(res.status).toBe(404);
-    });
-  });
-
-  describe('GET /assets/:id/download', () => {
-    it('returns 200 with Content-Disposition header for non-skill assets', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/assets/asset-123/download');
-      expect(res.status).toBe(200);
-      expect(res.headers['content-disposition']).toMatch(/attachment/);
-      expect(res.headers['content-disposition']).toMatch(/\.md/);
-    });
-
-    it('returns 404 when asset does not exist', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/assets/missing/download');
-      expect(res.status).toBe(404);
-    });
-  });
-
-  describe('POST /assets/:id/track-install', () => {
-    it('returns 204 and increments count for known asset', async () => {
-      const { app, store } = makeApp();
-      const res = await request(app).post('/assets/asset-123/track-install');
-      expect(res.status).toBe(204);
-      expect(store.incrementInstallCount).toHaveBeenCalledWith('asset-123');
-    });
-
-    it('returns 404 for unknown asset', async () => {
-      const { app } = makeApp();
-      const res = await request(app).post('/assets/missing/track-install');
-      expect(res.status).toBe(404);
-    });
-  });
-
-  // ── /providers ─────────────────────────────────────────────────────────────
-
-  describe('GET /providers', () => {
-    it('returns 200 with provider list', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/providers');
-      expect(res.status).toBe(200);
-      expect(Array.isArray(res.body)).toBe(true);
-      expect(res.body[0]).toMatchObject({ id: 'provider-1' });
-    });
-  });
-
-  describe('GET /providers/:id/status', () => {
-    it('returns 200 for a known provider and captures :id param', async () => {
-      const { app, store } = makeApp();
-      const res = await request(app).get('/providers/provider-1/status');
-      expect(res.status).toBe(200);
-      expect(store.getSyncStatus).toHaveBeenCalledWith('provider-1');
-    });
-
-    it('returns 404 for an unknown provider', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/providers/unknown-provider/status');
-      expect(res.status).toBe(404);
-    });
-  });
-
-  describe('POST /providers/:id/sync', () => {
-    it('returns 200 and fires background sync for known provider', async () => {
-      const { app } = makeApp();
-      const res = await request(app).post('/providers/provider-1/sync');
-      expect(res.status).toBe(200);
-      expect(res.body.providerId).toBe('provider-1');
-    });
-
-    it('returns 404 for an unknown provider', async () => {
-      const { app } = makeApp();
-      const res = await request(app).post('/providers/unknown-provider/sync');
-      expect(res.status).toBe(404);
-    });
-  });
-
-  // ── /stats ─────────────────────────────────────────────────────────────────
-
-  describe('GET /stats', () => {
-    it('returns 200 with stats object', async () => {
-      const { app } = makeApp();
-      const res = await request(app).get('/stats');
-      expect(res.status).toBe(200);
-      expect(res.body).toMatchObject({ totalAssets: 1 });
-    });
-  });
-});

package/src/router.ts

@@ -1,338 +0,0 @@
-import { randomUUID } from 'crypto';
-import express from 'express';
-import archiver from 'archiver';
-import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
-import type { LoggerService } from '@backstage/backend-plugin-api';
-import type { AiAssetStore } from './database/AiAssetStore';
-import type { AiAssetSyncService } from './service/AiAssetSyncService';
-import { createMcpServer } from './service/McpServerService';
-import type { ProviderConfig, AssetListFilter } from './types';
-import type { AssetType } from '@nospt/plugin-dev-ai-hub-common';
-
-interface RouterOptions {
-  logger: LoggerService;
-  store: AiAssetStore;
-  syncService: AiAssetSyncService;
-  providers: ProviderConfig[];
-}
-
-export function createRouter(options: RouterOptions): express.Router {
-  const { store, syncService, providers } = options;
-  const router = express.Router();
-
-  /** Active MCP sessions: sessionId → transport */
-  const mcpSessions = new Map<string, StreamableHTTPServerTransport>();
-
-  router.use(express.json());
-
-  // ── Assets ────────────────────────────────────────────────────────────────
-
-  router.get('/assets', async (req, res) => {
-    try {
-      const filter: AssetListFilter = {
-        type: req.query.type as AssetType | undefined,
-        tool: req.query.tool as string | undefined,
-        providerId: req.query.provider as string | undefined,
-        search: req.query.search as string | undefined,
-        tags: req.query.tags
-          ? (req.query.tags as string).split(',').filter(Boolean)
-          : undefined,
-        page: req.query.page ? Number(req.query.page) : 1,
-        pageSize: req.query.pageSize ? Number(req.query.pageSize) : 20,
-      };
-
-      const { items, totalCount } = await store.listAssets(filter);
-
-      res.json({
-        items,
-        totalCount,
-        page: filter.page,
-        pageSize: filter.pageSize,
-      });
-    } catch (err) {
-      options.logger.error('GET /assets failed', err as Error);
-      res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  router.get('/assets/:id', async (req, res) => {
-    try {
-      const asset = await store.getAsset(req.params.id);
-      if (!asset) return res.status(404).json({ error: 'Asset not found' });
-      return res.json(asset);
-    } catch (err) {
-      options.logger.error('GET /assets/:id failed', err as Error);
-      return res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  /** Returns the pure markdown content of the asset */
-  router.get('/assets/:id/raw', async (req, res) => {
-    try {
-      const asset = await store.getAsset(req.params.id);
-      if (!asset) return res.status(404).json({ error: 'Asset not found' });
-      res.setHeader('Content-Type', 'text/markdown; charset=utf-8');
-      return res.send(asset.content);
-    } catch (err) {
-      options.logger.error('GET /assets/:id/raw failed', err as Error);
-      return res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  /**
-   * For skills: returns a zip with the markdown + metadata about bundled resources.
-   * For other types: returns the markdown as a text file.
-   */
-  router.get('/assets/:id/download', async (req, res) => {
-    try {
-      const asset = await store.getAsset(req.params.id);
-      if (!asset) return res.status(404).json({ error: 'Asset not found' });
-
-      const filename = `${asset.name.replace(/\s+/g, '-').toLowerCase()}`;
-
-      if (asset.type === 'skill') {
-        res.setHeader('Content-Type', 'application/zip');
-        res.setHeader(
-          'Content-Disposition',
-          `attachment; filename="${filename}.zip"`,
-        );
-        const archive = archiver('zip');
-        archive.pipe(res);
-        archive.append(asset.content, { name: 'SKILL.md' });
-        if (asset.resourcesContent) {
-          for (const [resourcePath, resourceContent] of Object.entries(asset.resourcesContent)) {
-            archive.append(resourceContent, { name: resourcePath });
-          }
-        }
-        await archive.finalize();
-      } else {
-        res.setHeader('Content-Type', 'text/markdown; charset=utf-8');
-        res.setHeader(
-          'Content-Disposition',
-          `attachment; filename="${filename}.md"`,
-        );
-        return res.send(asset.content);
-      }
-
-      return undefined;
-    } catch (err) {
-      options.logger.error('GET /assets/:id/download failed', err as Error);
-      return res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  router.post('/assets/:id/track-install', async (req, res) => {
-    try {
-      const asset = await store.getAsset(req.params.id);
-      if (!asset) return res.status(404).json({ error: 'Asset not found' });
-      await store.incrementInstallCount(req.params.id);
-      return res.status(204).send();
-    } catch (err) {
-      options.logger.error('POST /assets/:id/track-install failed', err as Error);
-      return res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  // ── Providers ─────────────────────────────────────────────────────────────
-
-  router.get('/providers', async (_req, res) => {
-    try {
-      const statuses = await store.getAllSyncStatuses();
-      const statusMap = new Map(statuses.map(s => [s.providerId, s]));
-
-      const result = providers.map(p => {
-        const status = statusMap.get(p.id);
-        return {
-          id: p.id,
-          type: p.type,
-          target: p.target,
-          branch: p.branch,
-          lastSync: status?.lastSync,
-          lastCommit: status?.lastCommit,
-          status: status?.status ?? 'idle',
-          error: status?.error,
-          assetCount: status?.assetCount ?? 0,
-        };
-      });
-
-      res.json(result);
-    } catch (err) {
-      options.logger.error('GET /providers failed', err as Error);
-      res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  router.get('/providers/:id/status', async (req, res) => {
-    try {
-      const provider = providers.find(p => p.id === req.params.id);
-      if (!provider) return res.status(404).json({ error: 'Provider not found' });
-
-      const status = await store.getSyncStatus(req.params.id);
-      return res.json(
-        status ?? {
-          providerId: req.params.id,
-          status: 'idle',
-          assetCount: 0,
-        },
-      );
-    } catch (err) {
-      options.logger.error('GET /providers/:id/status failed', err as Error);
-      return res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  router.post('/providers/:id/sync', async (req, res) => {
-    try {
-      const provider = providers.find(p => p.id === req.params.id);
-      if (!provider) return res.status(404).json({ error: 'Provider not found' });
-
-      // Fire and forget — respond immediately, sync runs in background
-      setImmediate(() => syncService.syncProvider(provider));
-
-      return res.json({ message: 'Sync triggered', providerId: provider.id });
-    } catch (err) {
-      options.logger.error('POST /providers/:id/sync failed', err as Error);
-      return res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  // ── Stats ─────────────────────────────────────────────────────────────────
-
-  router.get('/stats', async (_req, res) => {
-    try {
-      const stats = await store.getStats();
-      res.json(stats);
-    } catch (err) {
-      options.logger.error('GET /stats failed', err as Error);
-      res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  // ── MCP — StreamableHTTP transport ────────────────────────────────────────
-  //
-  // Clients connect to /mcp?tool=<ai-tool-name> using the MCP HTTP protocol.
-  // The `tool` query parameter filters assets to those compatible with that
-  // AI tool. Each session is stateful: the tool filter is captured at
-  // initialization time and reused for the session lifetime.
-  //
-  // Client configuration example (.mcp.json / mcp_settings.json):
-  //
-  //   {
-  //     "mcpServers": {
-  //       "dev-ai-hub": {
-  //         "type": "http",
-  //         "url": "http://<backstage-host>:7007/api/dev-ai-hub/mcp?tool=claude-code"
-  //       }
-  //     }
-  //   }
-  //
-  // Set AI_HUB_TOOL in your environment and substitute it into the URL, or
-  // hard-code the tool name per workspace.
-
-  /**
-   * POST /mcp — Initialize a new MCP session or handle an existing one.
-   * On first request (no mcp-session-id header), a new session is created
-   * and its ID is returned in the response header.
-   */
-  router.post('/mcp', async (req, res) => {
-    try {
-      const sessionId = req.headers['mcp-session-id'] as string | undefined;
-
-      if (sessionId) {
-        const transport = mcpSessions.get(sessionId);
-        if (!transport) {
-          res.status(404).json({ error: 'MCP session not found' });
-          return;
-        }
-        await transport.handleRequest(req, res, req.body);
-        return;
-      }
-
-      // New session — extract filters from query params or headers
-      const toolFilter =
-        (req.query.tool as string | undefined) ??
-        (req.headers['x-ai-hub-tool'] as string | undefined) ??
-        '';
-      const providerFilter =
-        (req.query.provider as string | undefined) ??
-        (req.headers['x-ai-hub-provider'] as string | undefined) ??
-        '';
-      // proactive defaults to false; pass ?proactive=true to enable check_for_assets + suggest_assets
-      const proactiveEnabled =
-        ((req.query.proactive as string | undefined) ??
-         (req.headers['x-ai-hub-proactive'] as string | undefined) ??
-         'false') === 'true';
-
-      const newSessionId = randomUUID();
-      const transport = new StreamableHTTPServerTransport({
-        sessionIdGenerator: () => newSessionId,
-        onsessioninitialized: id => {
-          mcpSessions.set(id, transport);
-          options.logger.debug(
-            `dev-ai-hub MCP: session ${id} opened (tool="${toolFilter || 'all'}", provider="${providerFilter || 'all'}", proactive=${proactiveEnabled})`,
-          );
-        },
-      });
-
-      transport.onclose = () => {
-        mcpSessions.delete(newSessionId);
-        options.logger.debug(`dev-ai-hub MCP: session ${newSessionId} closed`);
-      };
-
-      const server = createMcpServer(store, toolFilter, providerFilter, providers, proactiveEnabled);
-      await server.connect(transport);
-
-      await transport.handleRequest(req, res, req.body);
-    } catch (err) {
-      options.logger.error('POST /mcp failed', err as Error);
-      if (!res.headersSent) res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  /**
-   * GET /mcp — SSE stream for server-to-client notifications on an existing session.
-   */
-  router.get('/mcp', async (req, res) => {
-    try {
-      const sessionId = req.headers['mcp-session-id'] as string | undefined;
-      if (!sessionId) {
-        res.status(400).json({ error: 'mcp-session-id header required' });
-        return;
-      }
-      const transport = mcpSessions.get(sessionId);
-      if (!transport) {
-        res.status(404).json({ error: 'MCP session not found' });
-        return;
-      }
-      await transport.handleRequest(req, res);
-    } catch (err) {
-      options.logger.error('GET /mcp failed', err as Error);
-      if (!res.headersSent) res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  /**
-   * DELETE /mcp — Terminate an existing MCP session.
-   */
-  router.delete('/mcp', async (req, res) => {
-    try {
-      const sessionId = req.headers['mcp-session-id'] as string | undefined;
-      if (!sessionId) {
-        res.status(400).json({ error: 'mcp-session-id header required' });
-        return;
-      }
-      const transport = mcpSessions.get(sessionId);
-      if (!transport) {
-        res.status(404).json({ error: 'MCP session not found' });
-        return;
-      }
-      await transport.handleRequest(req, res);
-      mcpSessions.delete(sessionId);
-    } catch (err) {
-      options.logger.error('DELETE /mcp failed', err as Error);
-      if (!res.headersSent) res.status(500).json({ error: 'Internal server error' });
-    }
-  });
-
-  return router;
-}