fix(ai-integrations): add null check for catalogKeys (#644)

* fix(ai-integrations): add null check for catalogKeys

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

* Add changeset

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

* Include undefined check just incase

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

* Add test

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

---------

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

Author: johnmcollier

workspaces/ai-integrations/.changeset/slimy-zebras-write.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-catalog-backend-module-model-catalog': patch
+---
+
+Add null check when retrieving keys from catalog bridge

workspaces/ai-integrations/README.md

@@ -13,3 +13,23 @@ To run the rhdh model catalog backend module in development mode:
 2. Run `yarn install` to install dependencies
 
 3. Run `yarn dev` to launch the module
+
+## Building the plugin archive
+
+**Note:** We suggest building on an x86 environment (we've found the plugin archive does not successfully deploy when built on an arm64 environment)
+
+The ai-experience plugins are packaged as part of an OCI archive.
+
+To build the plugin archive, ensure you have `docker` or `podman` installed on your system, and run:
+
+```
+npx --yes @janus-idp/cli@$latest package package-dynamic-plugins --tag "${PLUGIN_CONTAINER_TAG}"
+```
+
+Where `PLUGIN_CONTAINER_TAG` is the image tag you would like to use (e.g. `quay.io/<your-user>/ai-experience:latest`)
+
+If you would like to build with `docker`, add the `--user-docker` tag like so:
+
+```
+npx --yes @janus-idp/cli@$latest package package-dynamic-plugins --tag "${PLUGIN_CONTAINER_TAG}" --use-docker
+```

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/providers/ModelCatalogResourceEntityProvider.test.ts

@@ -141,4 +141,29 @@ describe('ModelCatalogResourceEntityProvider', () => {
       (connection.applyMutation as jest.Mock).mock.calls,
     ).toMatchSnapshot();
   });
+
+  it('should connect and run should resolve even if the keys returned are null', async () => {
+    (fetchModelCatalogKeys as jest.Mock).mockReturnValue(Promise.resolve(null));
+
+    const mcprovider = ModelCatalogResourceEntityProvider.fromConfig(
+      {
+        config: mockServices.rootConfig({ data: CONFIG }),
+        logger: mockServices.logger.mock(),
+      },
+      {
+        schedule,
+      },
+    );
+
+    for await (const k of mcprovider) {
+      await k.connect(connection);
+      await schedule.runAll();
+    }
+
+    expect(connection.applyMutation).toHaveBeenCalledTimes(1);
+    expect(fetchModelCatalogFromKey).toHaveBeenCalledTimes(0);
+    expect(
+      (connection.applyMutation as jest.Mock).mock.calls,
+    ).toMatchSnapshot();
+  });
 });

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/providers/ModelCatalogResourceEntityProvider.ts

@@ -154,7 +154,11 @@ export class ModelCatalogResourceEntityProvider implements EntityProvider {
     );
 
     /** [5]: Fetch the model catalog keys from the bridge and fetch the corresponding catalog entries. */
-    const catalogKeys = await fetchModelCatalogKeys(this.baseUrl);
+    let catalogKeys = await fetchModelCatalogKeys(this.baseUrl);
+    // If no models are registered yet, the catalogKeys array may be null, so handle it by setting it to be an emptyList
+    if (catalogKeys === null || catalogKeys === undefined) {
+      catalogKeys = [];
+    }
     let entityList: Entity[] = [];
 
     await Promise.all(

workspaces/ai-integrations/plugins/catalog-backend-module-model-catalog/src/providers/__snapshots__/ModelCatalogResourceEntityProvider.test.ts.snap

@@ -33,3 +33,14 @@ exports[`ModelCatalogResourceEntityProvider should connect and run should resolv
   ],
 ]
 `;
+
+exports[`ModelCatalogResourceEntityProvider should connect and run should resolve even if the keys returned are null 1`] = `
+[
+  [
+    {
+      "entities": [],
+      "type": "full",
+    },
+  ],
+]
+`;