Neo4j: support plugins other than Apoc

Add withPlugins method to Neo4jContainer for setting up plugins included in the docker image. Previously only withApoc was provided for setting up Apoc-plugin. Now withApoc uses the same plugin list under-the-hood.

Availability of specific plugins may depend on what version of Neo4j image is used.

Author: stscoundrel

packages/modules/neo4j/src/index.ts

@@ -1 +1 @@
-export { Neo4jContainer, StartedNeo4jContainer } from "./neo4j-container";
+export { Neo4jContainer, Neo4jPlugin, StartedNeo4jContainer } from "./neo4j-container";

packages/modules/neo4j/src/neo4j-container.test.ts

@@ -1,5 +1,5 @@
 import neo4j from "neo4j-driver";
-import { Neo4jContainer } from "./neo4j-container";
+import { Neo4jContainer, Neo4jPlugin } from "./neo4j-container";
 
 describe("Neo4jContainer", { timeout: 180_000 }, () => {
   // createNode {
@@ -83,4 +83,34 @@ describe("Neo4jContainer", { timeout: 180_000 }, () => {
     await container.stop();
   });
   // }
+
+  // plugins list {
+  it("should work with plugin list", async () => {
+    const container = await new Neo4jContainer("neo4j:5.26.5")
+      .withPlugins([Neo4jPlugin.APOC_EXTENDED, Neo4jPlugin.GRAPH_DATA_SCIENCE])
+      .withStartupTimeout(120_000)
+      .start();
+    const driver = neo4j.driver(
+      container.getBoltUri(),
+      neo4j.auth.basic(container.getUsername(), container.getPassword())
+    );
+
+    const session = driver.session();
+
+    // Monitor methods are only available in extended Apoc.
+    const result = await session.run("CALL apoc.monitor.ids()");
+    expect(result.records[0].get("nodeIds")).toEqual({ high: 0, low: 0 });
+
+    // Insert one node.
+    await session.run("CREATE (a:Person {name: $name}) RETURN a", { name: "Some dude" });
+
+    // Monitor result should reflect increase in data.
+    const result2 = await session.run("CALL apoc.monitor.ids()");
+    expect(result2.records[0].get("nodeIds")).toEqual({ high: 0, low: 1 });
+
+    await session.close();
+    await driver.close();
+    await container.stop();
+  });
+  // }
 });

packages/modules/neo4j/src/neo4j-container.ts

@@ -4,10 +4,21 @@ const BOLT_PORT = 7687;
 const HTTP_PORT = 7474;
 const USERNAME = "neo4j";
 
+export enum Neo4jPlugin {
+  APOC = "apoc",
+  APOC_EXTENDED = "apoc-extended",
+  BLOOM = "bloom",
+  GEN_AI = "genai",
+  GRAPHQL = "graphql",
+  GRAPH_ALGORITHMS = "graph-algorithms",
+  GRAPH_DATA_SCIENCE = "graph-data-science",
+  NEO_SEMANTICS = "n10s",
+}
+
 export class Neo4jContainer extends GenericContainer {
   private password = "pass123!@#WORD";
-  private apoc = false;
   private ttl?: number;
+  private plugins: Neo4jPlugin[] = [];
 
   constructor(image = "neo4j:4.4.12") {
     super(image);
@@ -23,11 +34,12 @@ export class Neo4jContainer extends GenericContainer {
   }
 
   public withApoc(): this {
-    this.apoc = true;
-    this.withEnvironment({
-      NEO4JLABS_PLUGINS: '["apoc"]',
-      NEO4J_dbms_security_procedures_unrestricted: "apoc.*",
-    });
+    this.plugins.push(Neo4jPlugin.APOC);
+    return this;
+  }
+
+  public withPlugins(plugins: Neo4jPlugin[]): this {
+    this.plugins = plugins;
     return this;
   }
 
@@ -44,10 +56,29 @@ export class Neo4jContainer extends GenericContainer {
         NEO4J_apoc_ttl_schedule: this.ttl.toString(),
       });
     }
-    if (this.apoc) {
+
+    if (this.plugins.length > 0) {
+      const whitelists: string[] = [];
+
+      this.plugins.forEach((plugin) => {
+        if (plugin === Neo4jPlugin.APOC || plugin === Neo4jPlugin.APOC_EXTENDED) {
+          whitelists.push("apoc.*");
+        }
+
+        if (plugin === Neo4jPlugin.GRAPH_DATA_SCIENCE) {
+          whitelists.push("gds.*");
+        }
+
+        if (plugin === Neo4jPlugin.BLOOM) {
+          whitelists.push("bloom.*");
+        }
+      });
+
       this.withEnvironment({
-        NEO4JLABS_PLUGINS: '["apoc"]',
-        NEO4J_dbms_security_procedures_unrestricted: "apoc.*",
+        NEO4JLABS_PLUGINS: JSON.stringify(this.plugins), // Older variant for older images.
+        NEO4J_PLUGINS: JSON.stringify(this.plugins),
+        NEO4J_dbms_security_procedures_unrestricted: whitelists.join(","),
+        NEO4J_dbms_security_procedures_whitelist: whitelists.join(","),
       });
     }
     return new StartedNeo4jContainer(await super.start(), this.password);