feat(ai-integrations): Initial code drop of model catalog backend module (#579)

* feat(ai-integrations): Initial code drop of model catalog backend module

Signed-off-by: John Collier <jcollier@redhat.com>

* fix: add comments to app-config example

Signed-off-by: John Collier <jcollier@redhat.com>

---------

Signed-off-by: John Collier <jcollier@redhat.com>

Author: johnmcollier

workspaces/ai-integrations/.changeset/crazy-clouds-shake.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-catalog-backend-module-model-catalog': patch
+---
+
+Initial code drop of prototype model catalog plugin originally from redhat-ai-dev fork

workspaces/ai-integrations/app-config.yaml

@@ -43,6 +43,7 @@ backend:
       - host: '*.mozilla.org'
       - host: '*.openshift.com'
       - host: '*.openshiftapps.com'
+      - host: '${RHDH_BRIDGE_HOST}'
 
 integrations:
   github:
@@ -91,5 +92,7 @@ catalog:
     - allow: [Component, System, API, Resource, Location]
   providers:
     modelCatalog:
-      ollama:
+      # The field underneath here can be any value that you feel represents your model catalog bridge instance
+      development:
+        # If testing locally, this value should be set to `localhost:9090`
         baseUrl: '${RHDH_AI_BRIDGE_SERVER}'

workspaces/ai-integrations/babel.config.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 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.
+ */
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: 'current',
+        },
+      },
+    ],
+  ],
+};

workspaces/ai-integrations/packages/backend/src/index.ts

@@ -15,6 +15,11 @@
  */
 
 import { createBackend } from '@backstage/backend-defaults';
+import {
+  catalogModuleRHDHRHOAIReaderProcessor,
+  catalogModuleRHDHRHOAILocationsExtensionPoint,
+  catalogModuleRHDHRHOAIEntityProvider,
+} from '@red-hat-developer-hub/backstage-plugin-catalog-backend-module-model-catalog';
 
 const backend = createBackend();
 
@@ -64,4 +69,7 @@ backend.add(
     '@red-hat-developer-hub/backstage-plugin-catalog-backend-module-model-catalog'
   ),
 );
+backend.add(catalogModuleRHDHRHOAILocationsExtensionPoint);
+backend.add(catalogModuleRHDHRHOAIReaderProcessor);
+backend.add(catalogModuleRHDHRHOAIEntityProvider);
 backend.start();

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/config.d.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 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.
+ */
+import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
+
+export interface Config {
+  catalog?: {
+    providers?: {
+      modelCatalog?: {
+        [key: string]: {
+          /**
+           * ModelCatalogConfig
+           */
+          baseUrl: string;
+          name?: string;
+          system?: string;
+          owner?: string;
+          schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
+        };
+      };
+    };
+  };
+}

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/package.json

@@ -19,7 +19,10 @@
   "backstage": {
     "role": "backend-plugin-module",
     "pluginId": "catalog",
-    "pluginPackage": "@backstage/plugin-catalog-backend"
+    "pluginPackage": "@backstage/plugin-catalog-backend",
+    "pluginPackages": [
+      "@red-hat-developer-hub/backstage-plugin-catalog-backend-module-model-catalog"
+    ]
   },
   "scripts": {
     "start": "backstage-cli package start",
@@ -31,7 +34,16 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.2.1"
+    "@backstage/backend-plugin-api": "^1.1.1",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/catalog-model": "^1.7.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-catalog-backend": "^1.30.0",
+    "@backstage/plugin-catalog-common": "^1.1.3",
+    "@backstage/plugin-catalog-node": "^1.15.1",
+    "@redhat-ai-dev/model-catalog-types": "^1.0.1",
+    "stream": "^0.0.3",
+    "yaml": "^2.7.0"
   },
   "devDependencies": {
     "@backstage/backend-test-utils": "^1.3.1",

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/report.api.md

@@ -4,8 +4,70 @@
 
 ```ts
 import { BackendFeature } from '@backstage/backend-plugin-api';
+import { CatalogProcessor } from '@backstage/plugin-catalog-node';
+import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
+import { CatalogProcessorParser } from '@backstage/plugin-catalog-node';
+import type { Config } from '@backstage/config';
+import { Entity } from '@backstage/catalog-model';
+import { EntityProvider } from '@backstage/plugin-catalog-node';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-node';
+import { LocationSpec } from '@backstage/plugin-catalog-common';
+import { LoggerService } from '@backstage/backend-plugin-api';
+import { RootConfigService } from '@backstage/backend-plugin-api';
+import type { SchedulerService } from '@backstage/backend-plugin-api';
+import type { SchedulerServiceTaskRunner } from '@backstage/backend-plugin-api';
+import { UrlReaderService } from '@backstage/backend-plugin-api';
 
 // @public
-const catalogModuleModelCatalog: BackendFeature;
-export default catalogModuleModelCatalog;
+const catalogModuleModelCatalogResourceEntityProvider: BackendFeature;
+export default catalogModuleModelCatalogResourceEntityProvider;
+
+// @public
+export const catalogModuleRHDHRHOAIEntityProvider: BackendFeature;
+
+// @public
+export const catalogModuleRHDHRHOAILocationsExtensionPoint: BackendFeature;
+
+// @public
+export const catalogModuleRHDHRHOAIReaderProcessor: BackendFeature;
+
+// @public
+export function fetchCatalogEntities(baseUrl: string): Promise<Entity[]>;
+
+// @public
+export class ModelCatalogResourceEntityProvider implements EntityProvider {
+  connect(connection: EntityProviderConnection): Promise<void>;
+  createScheduleFn(taskRunner: SchedulerServiceTaskRunner): () => Promise<void>;
+  static fromConfig(
+    deps: {
+      config: Config;
+      logger: LoggerService;
+    },
+    options:
+      | {
+          schedule: SchedulerServiceTaskRunner;
+        }
+      | {
+          scheduler: SchedulerService;
+        },
+  ): ModelCatalogResourceEntityProvider[];
+  getProviderName(): string;
+  run(): Promise<void>;
+}
+
+// @public
+export class RHDHRHOAIReaderProcessor implements CatalogProcessor {
+  constructor(
+    reader: UrlReaderService,
+    config: RootConfigService,
+    logger: LoggerService,
+  );
+  getProcessorName(): string;
+  readLocation(
+    location: LocationSpec,
+    _optional: boolean,
+    emit: CatalogProcessorEmit,
+    parser: CatalogProcessorParser,
+  ): Promise<boolean>;
+}
 ```

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/clients/BridgeResourceConnector.test.ts

@@ -0,0 +1,83 @@
+/*
+ * Copyright 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.
+ */
+
+import YAML from 'yaml';
+import { Entity, ResourceEntity } from '@backstage/catalog-model';
+import { Stream } from 'stream';
+
+const fakeEntity: ResourceEntity = {
+  apiVersion: 'backstage.io/v1beta1',
+  kind: 'Resource',
+  metadata: {
+    name: 'ibm-granite',
+    description: 'IBM Granite code model',
+    tags: [],
+    links: [],
+  },
+  spec: {
+    dependencyOf: [],
+    owner: 'example-user',
+    type: 'ai-model',
+  },
+};
+const blob = new Blob([YAML.stringify(fakeEntity)], {
+  type: 'application/json',
+});
+
+// Mock different fetch results based on the url passed in, to trigger success vs. error scenarios
+global.fetch = jest.fn(url => {
+  if (url === 'errorTest') {
+    return Promise.resolve({
+      ok: false,
+      status: 401,
+      json: () => 'error',
+    });
+  }
+  return Promise.resolve({
+    ok: true,
+    status: 200,
+    blob: () => Promise.resolve(blob),
+  });
+}) as jest.Mock;
+
+import { fetchCatalogEntities } from './BridgeResourceConnector';
+
+const httpsMock = require('https');
+
+describe('Bridge Resource Connector', () => {
+  it('should fetch catallog entities successfully', async () => {
+    const streamStream = new Stream();
+    httpsMock.get = jest.fn().mockImplementation(cb => {
+      cb(streamStream);
+      streamStream.emit('data', 'test');
+      streamStream.emit('end');
+    });
+    const entities: Entity[] = await fetchCatalogEntities('fake-url');
+    expect(entities.length).toEqual(1);
+    expect(entities[0].metadata.name).toEqual('ibm-granite');
+  });
+  it('should error out if error encountered', async () => {
+    const streamStream = new Stream();
+    httpsMock.get = jest.fn().mockImplementation(cb => {
+      cb(streamStream);
+      streamStream.emit('data', 'test');
+      streamStream.emit('end');
+    });
+    await expect(
+      async () => await fetchCatalogEntities('errorTest'),
+    ).rejects.toThrow();
+  });
+});

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/clients/BridgeResourceConnector.ts

@@ -0,0 +1,63 @@
+/*
+ * Copyright 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.
+ */
+import { Entity } from '@backstage/catalog-model';
+
+import YAML from 'yaml';
+
+// listModels will list the models from an OpenAI compatible endpoint
+/*
+export async function listModels(
+  baseUrl: string,
+  access_token: string,
+): Promise<ModelList> {
+  const res = await fetch(`${baseUrl}/v1/models`, {
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: access_token,
+    },
+    method: 'GET',
+  });
+
+  if (!res.ok) {
+    throw new Error(res.statusText);
+  }
+
+  const data = await res.json();
+  return data;
+}*/
+
+/**
+ * fetchCatalogEntities retrieves model catalog entities from the Model Catalog Bridge services
+ * @public
+ */
+export async function fetchCatalogEntities(baseUrl: string): Promise<Entity[]> {
+  // ToDo: Discover catalog-info endpoint?
+  const res = await fetch(`${baseUrl}`, {
+    method: 'GET',
+  });
+
+  if (!res.ok) {
+    throw new Error(res.statusText);
+  }
+
+  // ToDo: Look at seeing if we can use the parser provided by the CatalogProcessorProvider package
+  const data = await res
+    .blob()
+    .then(blob => blob.text())
+    .then(yamlStr => YAML.parseAllDocuments(yamlStr))
+    .then(yamlData => yamlData.map(item => item.toJS()));
+  return data;
+}