Expose instantiated resources from ComponentsManager

lib/ComponentsManager.ts

@@ -1,5 +1,6 @@
 import * as fs from 'fs';
 import type { Resource, RdfObjectLoader } from 'rdf-object';
+import { stringToTerm } from 'rdf-string';
 import type { Logger } from 'winston';
 import type { IConfigConstructorPool } from './construction/IConfigConstructorPool';
 import type { IConstructionSettings } from './construction/IConstructionSettings';
@@ -61,6 +62,16 @@ export class ComponentsManager<Instance> {
     }
   }
 
+  /**
+   * Retrieve a list of all instantiated Resources.
+   */
+  public getInstantiatedResources(): Resource[] {
+    const instances = this.configConstructorPool.getInstanceRegistry();
+    return Object.keys(instances)
+      .map(key => stringToTerm(key))
+      .map(term => this.configRegistry.getInstantiatedResource(term));
+  }
+
   /**
    * Create an `componentsjs-error-state.json` file to represent the application state in the current working directory.
    * @param error The error that causes this error state to be created.

lib/construction/ConfigConstructorPool.ts

@@ -1,4 +1,5 @@
 import type { Resource, RdfObjectLoader } from 'rdf-object';
+import { termToString } from 'rdf-string';
 import type { IModuleState } from '../loading/ModuleStateBuilder';
 import type { IConfigPreprocessor } from '../preprocess/IConfigPreprocessor';
 import { ErrorResourcesContext } from '../util/ErrorResourcesContext';
@@ -40,7 +41,8 @@ export class ConfigConstructorPool<Instance> implements IConfigConstructorPool<I
     // Check if this resource is required as argument in its own chain,
     // if so, return a dummy value, to avoid infinite recursion.
     const resourceBlacklist = settings.resourceBlacklist || {};
-    if (resourceBlacklist[configResource.value]) {
+    const configResourceId = termToString(configResource.term);
+    if (resourceBlacklist[configResourceId]) {
       return Promise.reject(new ErrorResourcesContext(`Circular dependency was detected on ${configResource.value}`, { config: configResource }));
     }
 
@@ -51,28 +53,28 @@ export class ConfigConstructorPool<Instance> implements IConfigConstructorPool<I
     }
 
     // Instantiate only once
-    if (!(configResource.value in this.instances)) {
+    if (!(configResourceId in this.instances)) {
       // The blacklist avoids infinite recursion for self-referencing configs
       const subBlackList: Record<string, boolean> = { ...resourceBlacklist };
-      subBlackList[configResource.value] = true;
+      subBlackList[configResourceId] = true;
 
       // Prepare instance parameters
       let rawConfig: Resource;
       try {
         rawConfig = this.getRawConfig(configResource);
       } catch (syncError: unknown) {
-        this.instances[configResource.value] = Promise.reject(syncError);
-        return this.instances[configResource.value];
+        this.instances[configResourceId] = Promise.reject(syncError);
+        return this.instances[configResourceId];
       }
       const subSettings = { ...settings, resourceBlacklist: subBlackList };
 
       // Invoke instance creation
-      this.instances[configResource.value] = this.configConstructor.createInstance(
+      this.instances[configResourceId] = this.configConstructor.createInstance(
         rawConfig,
         subSettings,
       );
     }
-    return this.instances[configResource.value];
+    return this.instances[configResourceId];
   }
 
   /**
@@ -128,6 +130,13 @@ export class ConfigConstructorPool<Instance> implements IConfigConstructorPool<I
       throw new ErrorResourcesContext(`Invalid config: ${field} "${config.property[field].value}" must be a ${type}, but got ${config.property[field].type}`, { config });
     }
   }
+
+  /**
+   * Returns the instance registry.
+   */
+  public getInstanceRegistry(): Record<string, Promise<any>> {
+    return this.instances;
+  }
 }
 
 export interface IInstancePoolOptions<Instance> {

lib/construction/IConfigConstructorPool.ts

@@ -16,4 +16,10 @@ export interface IConfigConstructorPool<Instance> {
     settings: IConstructionSettings,
   ) => Promise<Instance>;
 
+  /**
+   * Return the instance regsitry.
+   * This is a hash from registered id to a Promise of the Instance.
+   */
+  getInstanceRegistry: () => Record<string, Promise<Instance>>;
+
 }

lib/loading/ConfigRegistry.ts

@@ -1,6 +1,7 @@
 import type { Readable } from 'stream';
 import type * as RDF from '@rdfjs/types';
-import type { RdfObjectLoader } from 'rdf-object';
+import type { RdfObjectLoader, Resource } from 'rdf-object';
+import { termToString } from 'rdf-string';
 import type { Logger } from 'winston';
 import { RdfParser } from '../rdf/RdfParser';
 import type { IModuleState } from './ModuleStateBuilder';
@@ -65,6 +66,14 @@ export class ConfigRegistry {
       configResource.property[key] = this.objectLoader.createCompactedResource(`"${params[key]}"`);
     }
   }
+
+  /**
+   * Get the instantiated Resource that was registered to the given term.
+   * @param term The term of the Resource that was instantiated
+   */
+  public getInstantiatedResource(term: RDF.Term): Resource {
+    return this.objectLoader.resources[termToString(term)];
+  }
 }
 
 export interface IConfigLoaderRegistryOptions {

package.json

@@ -43,15 +43,16 @@
     "rdf-object": "^1.13.1",
     "rdf-parse": "^2.0.0",
     "rdf-quad": "^1.5.0",
+    "rdf-string": "^1.6.0",
     "rdf-terms": "^1.7.0",
     "semver": "^7.3.2",
     "winston": "^3.3.3"
   },
   "devDependencies": {
     "@rubensworks/eslint-config": "^1.0.1",
+    "@types/jest": "^27.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
-    "@types/jest": "^27.0.0",
     "eslint": "^7.12.1",
     "eslint-config-es": "3.25.3",
     "eslint-import-resolver-typescript": "^2.3.0",

test/unit/construction/ConfigConstructorPool-test.ts

@@ -273,6 +273,7 @@ describe('ConfigConstructorPool', () => {
             'ex:myComponentInstance': true,
           },
         });
+        await expect(pool.getInstanceRegistry()['ex:myComponentInstance']).resolves.toBe('INSTANCE0');
       });
 
       it('should create different instances by different id', async() => {
@@ -285,6 +286,8 @@ describe('ConfigConstructorPool', () => {
           types: 'ex:Component',
         }), creationSettings);
         expect(instance1).not.toBe(instance2);
+        await expect(pool.getInstanceRegistry()['ex:myComponentInstance1']).resolves.toBe('INSTANCE0');
+        await expect(pool.getInstanceRegistry()['ex:myComponentInstance2']).resolves.toBe('INSTANCE1');
       });
 
       it('should return the same instances by equal id', async() => {

test/unit/loading/ComponentsManager-test.ts

@@ -59,6 +59,9 @@ describe('ComponentsManager', () => {
     dumpErrorState = false;
     configConstructorPool = <any> {
       instantiate: jest.fn(() => 'INSTANCE'),
+      getInstanceRegistry: jest.fn(() => ({
+        'http://example.org/myconfig': 'INSTANCE',
+      })),
     };
     componentsManager = new ComponentsManager({
       moduleState,
@@ -133,6 +136,13 @@ describe('ComponentsManager', () => {
     });
   });
 
+  describe('getInstantiatedResources', () => {
+    it('should return an array of instantiated Resources', async() => {
+      await componentsManager.configRegistry.register(`${__dirname}/../../assets/config.jsonld`);
+      expect(componentsManager.getInstantiatedResources()).toHaveLength(1);
+    });
+  });
+
   describe('generateErrorLog', () => {
     it('should export the context for an ErrorResourcesContext', () => {
       componentsManager = new ComponentsManager({

test/unit/loading/ConfigRegistry-test.ts

@@ -1,5 +1,6 @@
 import * as fs from 'fs';
 import { RdfObjectLoader } from 'rdf-object';
+import { stringToTerm } from 'rdf-string';
 import type { Logger } from 'winston';
 import { ConfigRegistry } from '../../../lib/loading/ConfigRegistry';
 import type { IModuleState } from '../../../lib/loading/ModuleStateBuilder';
@@ -62,4 +63,12 @@ describe('ConfigRegistry', () => {
       });
     });
   });
+
+  describe('getInstantiatedResource', () => {
+    it('can return an instantiated Resource', async() => {
+      await configRegistry.register(`${__dirname}/../../assets/config.jsonld`);
+      expect(configRegistry.getInstantiatedResource(stringToTerm('http://example.org/myconfig')).property.type.value)
+        .toBe('http://example.org/HelloWorldModule#SayHelloComponent');
+    });
+  });
 });