feat: start REST server (#1544)

* feat: start REST server

Signed-off-by: Philippe Martin <[email protected]>

* fix: removed express-openapi-validator

Signed-off-by: Jeff MAURY <[email protected]>

Co-authored-by: Philippe Martin <[email protected]>

Author: jeffmaury

Containerfile

@@ -22,7 +22,7 @@ COPY packages/backend/media/ /extension/media
 COPY LICENSE /extension/
 COPY packages/backend/icon.png /extension/
 COPY README.md /extension/
-
+COPY api/openapi.yaml /extension/api/
 
 FROM scratch
 

api/openapi.yaml

@@ -0,0 +1,39 @@
+openapi: 3.0.0
+info:
+  title: Podman Desktop AI Lab API
+  description: API for interacting with the Podman Desktop AI Lab service.
+  version: 0.0.1
+servers:
+  - url: http://{host}:{port}
+    description: Podman Desktop AI Lab API server
+    variables:
+      host:
+        default: 127.0.0.1
+      port:
+        default: '10434'
+
+tags:
+  - name: server
+    description: Server information
+
+paths:
+  /api/version:
+    get:
+      operationId: getServerVersion
+      tags:
+        - server
+      description: Return the Podman Desktop AI Lab API server version
+      summary: Return the Podman Desktop AI Lab API server version
+      responses:
+        '200':
+          description: The Podman Desktop AI Lab API server version was successfully fetched
+          content:
+            application/json:
+              schema:
+                type: object
+                additionalProperties: false
+                properties:
+                  version:
+                    type: string
+                required:
+                - version

packages/backend/package.json

@@ -61,6 +61,7 @@
   },
   "dependencies": {
     "@huggingface/gguf": "^0.1.9",
+    "express": "^4.19.2",
     "isomorphic-git": "^1.27.1",
     "mustache": "^4.2.0",
     "openai": "^4.56.0",
@@ -72,10 +73,13 @@
   },
   "devDependencies": {
     "@podman-desktop/api": "1.12.0",
+    "@types/express": "^4.17.21",
     "@types/js-yaml": "^4.0.9",
     "@types/mustache": "^4.2.5",
     "@types/node": "^20",
     "@types/postman-collection": "^3.5.10",
+    "@types/supertest": "^6.0.2",
+    "supertest": "^7.0.0",
     "vitest": "^2.0.5"
   }
 }

packages/backend/src/managers/apiServer.spec.ts

@@ -0,0 +1,103 @@
+/**********************************************************************
+ * Copyright (C) 2024 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import { afterEach, beforeEach, expect, test, vi } from 'vitest';
+import { ApiServer } from './apiServer';
+import request from 'supertest';
+import type * as podmanDesktopApi from '@podman-desktop/api';
+import path from 'path';
+import type { Server } from 'http';
+
+class TestApiServer extends ApiServer {
+  public override getListener(): Server | undefined {
+    return super.getListener();
+  }
+}
+
+const extensionContext = {} as unknown as podmanDesktopApi.ExtensionContext;
+
+let server: TestApiServer;
+
+beforeEach(async () => {
+  server = new TestApiServer(extensionContext);
+  vi.spyOn(server, 'displayApiInfo').mockReturnValue();
+  vi.spyOn(server, 'getSpecFile').mockReturnValue(path.join(__dirname, '../../../../api/openapi.yaml'));
+  vi.spyOn(server, 'getPackageFile').mockReturnValue(path.join(__dirname, '../../../../package.json'));
+  await server.init();
+});
+
+afterEach(() => {
+  server.dispose();
+});
+
+test('/spec endpoint', async () => {
+  expect(server.getListener()).toBeDefined();
+  const res = await request(server.getListener()!)
+    .get('/spec')
+    .expect(200)
+    .expect('Content-Type', 'application/yaml; charset=utf-8');
+  expect(res.text).toMatch(/^openapi:/);
+});
+
+test('/spec endpoint when spec file is not found', async () => {
+  expect(server.getListener()).toBeDefined();
+  vi.spyOn(server, 'getSpecFile').mockReturnValue(path.join(__dirname, '../../../../api/openapi-notfound.yaml'));
+  const res = await request(server.getListener()!).get('/spec').expect(500);
+  expect(res.body.message).toEqual('unable to get spec');
+});
+
+test('/spec endpoint when getting spec file fails', async () => {
+  expect(server.getListener()).toBeDefined();
+  vi.spyOn(server, 'getSpecFile').mockImplementation(() => {
+    throw 'an error getting spec file';
+  });
+  const res = await request(server.getListener()!).get('/spec').expect(500);
+  expect(res.body.message).toEqual('unable to get spec');
+  expect(res.body.errors[0]).toEqual('an error getting spec file');
+});
+
+test('/api/version endpoint', async () => {
+  expect(server.getListener()).toBeDefined();
+  const res = await request(server.getListener()!)
+    .get('/api/version')
+    .expect(200)
+    .expect('Content-Type', 'application/json; charset=utf-8');
+  expect(res.body.version).toBeDefined();
+});
+
+test('/api/version endpoint when package.json file is not found', async () => {
+  expect(server.getListener()).toBeDefined();
+  vi.spyOn(server, 'getPackageFile').mockReturnValue(path.join(__dirname, '../../../../package-notfound.json'));
+  const res = await request(server.getListener()!).get('/api/version').expect(500);
+  expect(res.body.message).toEqual('unable to get version');
+});
+
+test('/api/version endpoint when getting package.json file fails', async () => {
+  expect(server.getListener()).toBeDefined();
+  vi.spyOn(server, 'getPackageFile').mockImplementation(() => {
+    throw 'an error getting package file';
+  });
+  const res = await request(server.getListener()!).get('/api/version').expect(500);
+  expect(res.body.message).toEqual('unable to get version');
+  expect(res.body.errors[0]).toEqual('an error getting package file');
+});
+
+test('/api/wrongEndpoint', async () => {
+  expect(server.getListener()).toBeDefined();
+  await request(server.getListener()!).get('/api/wrongEndpoint').expect(404);
+});

packages/backend/src/managers/apiServer.ts

@@ -0,0 +1,153 @@
+/**********************************************************************
+ * Copyright (C) 2024 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ***********************************************************************/
+
+import type { Disposable } from '@podman-desktop/api';
+import type { Request, Response } from 'express';
+import express from 'express';
+import type { Server } from 'http';
+import path from 'node:path';
+import http from 'node:http';
+import { existsSync } from 'fs';
+import { getFreeRandomPort } from '../utils/ports';
+import * as podmanDesktopApi from '@podman-desktop/api';
+import { readFile } from 'fs/promises';
+
+const DEFAULT_PORT = 10434;
+const SHOW_API_INFO_COMMAND = 'ai-lab.show-api-info';
+
+export class ApiServer implements Disposable {
+  #listener?: Server;
+
+  constructor(private extensionContext: podmanDesktopApi.ExtensionContext) {}
+
+  protected getListener(): Server | undefined {
+    return this.#listener;
+  }
+
+  async init(): Promise<void> {
+    const app = express();
+
+    const router = express.Router();
+    router.use(express.json());
+
+    // declare routes
+    router.get('/version', this.getVersion.bind(this));
+    app.use('/api', router);
+    app.use('/spec', this.getSpec.bind(this));
+
+    const server = http.createServer(app);
+    let listeningOn = DEFAULT_PORT;
+    server.on('listening', () => {
+      this.displayApiInfo(listeningOn);
+    });
+    server.on('error', () => {
+      getFreeRandomPort('0.0.0.0')
+        .then((randomPort: number) => {
+          console.warn(`port ${DEFAULT_PORT} in use, using ${randomPort} for API server`);
+          listeningOn = randomPort;
+          this.#listener = server.listen(randomPort);
+        })
+        .catch((e: unknown) => {
+          console.error('unable to get a free port for the api server', e);
+        });
+    });
+    this.#listener = server.listen(DEFAULT_PORT);
+  }
+
+  displayApiInfo(port: number): void {
+    const apiStatusBarItem = podmanDesktopApi.window.createStatusBarItem();
+    apiStatusBarItem.text = `AI Lab API listening on port ${port}`;
+    apiStatusBarItem.command = SHOW_API_INFO_COMMAND;
+    this.extensionContext.subscriptions.push(
+      podmanDesktopApi.commands.registerCommand(SHOW_API_INFO_COMMAND, async () => {
+        const address = `http://localhost:${port}`;
+        const result = await podmanDesktopApi.window.showInformationMessage(
+          `AI Lab API is listening on\n${address}`,
+          'OK',
+          `Copy`,
+        );
+        if (result === 'Copy') {
+          await podmanDesktopApi.env.clipboard.writeText(address);
+        }
+      }),
+      apiStatusBarItem,
+    );
+    apiStatusBarItem.show();
+  }
+
+  private getFile(filepath: string): string {
+    // when plugin is installed, the file is placed in the plugin directory (~/.local/share/containers/podman-desktop/plugins/<pluginname>/)
+    const prodFile = path.join(__dirname, filepath);
+    if (existsSync(prodFile)) {
+      return prodFile;
+    }
+    // return dev file
+    return path.join(__dirname, '..', '..', filepath);
+  }
+
+  getSpecFile(): string {
+    return this.getFile('../api/openapi.yaml');
+  }
+
+  getPackageFile(): string {
+    return this.getFile('../package.json');
+  }
+
+  dispose(): void {
+    this.#listener?.close();
+  }
+
+  getSpec(_req: Request, res: Response): void {
+    const doErr = (err: unknown) => {
+      res.status(500).json({
+        message: 'unable to get spec',
+        errors: [err],
+      });
+    };
+    try {
+      const spec = this.getSpecFile();
+      readFile(spec, 'utf-8')
+        .then(content => {
+          res.status(200).type('application/yaml').send(content);
+        })
+        .catch((err: unknown) => doErr(err));
+    } catch (err: unknown) {
+      doErr(err);
+    }
+  }
+
+  getVersion(_req: Request, res: Response): void {
+    const doErr = (err: unknown) => {
+      res.status(500).json({
+        message: 'unable to get version',
+        errors: [err],
+      });
+    };
+    try {
+      const pkg = this.getPackageFile();
+      readFile(pkg, 'utf-8')
+        .then(content => {
+          const json = JSON.parse(content);
+          res.status(200).json({ version: `v${json.version}` });
+        })
+        .catch((err: unknown) => doErr(err));
+    } catch (err: unknown) {
+      doErr(err);
+    }
+  }
+}

packages/backend/src/studio.spec.ts

@@ -77,6 +77,9 @@ vi.mock('@podman-desktop/api', async () => {
         },
         onDidChangeViewState: vi.fn(),
       }),
+      createStatusBarItem: () => ({
+        show: vi.fn(),
+      }),
     },
     env: {
       createTelemetryLogger: () => ({

packages/backend/src/studio.ts

@@ -48,6 +48,7 @@ import { ConfigurationRegistry } from './registries/ConfigurationRegistry';
 import { RecipeManager } from './managers/recipes/RecipeManager';
 import { GPUManager } from './managers/GPUManager';
 import { WhisperCpp } from './workers/provider/WhisperCpp';
+import { ApiServer } from './managers/apiServer';
 
 export class Studio {
   readonly #extensionContext: ExtensionContext;
@@ -326,6 +327,10 @@ export class Studio {
     );
     // Register the instance
     this.#rpcExtension.registerInstance<StudioApiImpl>(StudioApiImpl, this.#studioApi);
+
+    const apiServer = new ApiServer(this.#extensionContext);
+    await apiServer.init();
+    this.#extensionContext.subscriptions.push(apiServer);
   }
 
   public async deactivate(): Promise<void> {

packages/backend/vite.config.js

@@ -35,6 +35,7 @@ const config = {
       '/@gen/': join(PACKAGE_ROOT, 'src-generated') + '/',
       '@shared/': join(PACKAGE_ROOT, '../shared') + '/',
     },
+    mainFields: ['module', 'jsnext:main', 'jsnext'], //https://github.com/vitejs/vite/issues/16444
   },
   build: {
     sourcemap: 'inline',