Use ServiceLoader to load Ops/OpCollections

gselzer · ctrueden · commit 140fdeb98261 · 2021-11-19T20:36:27.000-06:00
diff --git a/scijava/scijava-ops-engine/pom.xml b/scijava/scijava-ops-engine/pom.xml
@@ -136,6 +136,11 @@
 			<artifactId>scijava-ops-discovery</artifactId>
 			<version>${project.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.scijava</groupId>
+			<artifactId>scijava-ops-serviceloader</artifactId>
+			<version>${project.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.scijava</groupId>
 			<artifactId>scijava-struct</artifactId>
diff --git a/scijava/scijava-ops-engine/src/main/java/module-info.java b/scijava/scijava-ops-engine/src/main/java/module-info.java
@@ -38,11 +38,13 @@
 	requires org.scijava.struct;
 	requires org.scijava.ops.api;
 	requires org.scijava.ops.discovery;
+	requires org.scijava.ops.serviceloader;
 	requires org.scijava.ops.spi;
 	requires org.scijava.types;
 	requires javassist;
 	requires java.compiler;
 	requires therapi.runtime.javadoc;
 
 	uses javax.annotation.processing.Processor;
+	provides org.scijava.ops.spi.OpCollection with org.scijava.ops.engine.copy.CopyOpCollection;
 }
diff --git a/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/copy/CopyOpCollection.java b/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/copy/CopyOpCollection.java
@@ -4,10 +4,8 @@
 import org.scijava.function.Computers;
 import org.scijava.ops.spi.OpCollection;
 import org.scijava.ops.spi.OpField;
-import org.scijava.plugin.Plugin;
 
-@Plugin(type = OpCollection.class)
-public class CopyOpCollection <T>{
+public class CopyOpCollection <T> implements OpCollection{
 
 	@OpField(names = "cp, copy", priority = Priority.LOW, params = "array, arrayCopy")
 	public static final Computers.Arity1<double[], double[]> copyPrimitiveDoubleArray = (from, to) -> {
diff --git a/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/DefaultOpService.java b/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/DefaultOpService.java
@@ -42,6 +42,7 @@
 import org.scijava.ops.discovery.Discoverer;
 import org.scijava.ops.engine.OpHistoryService;
 import org.scijava.ops.engine.OpService;
+import org.scijava.ops.serviceloader.ServiceLoaderDiscoverer;
 import org.scijava.plugin.Plugin;
 import org.scijava.plugin.PluginInfo;
 import org.scijava.plugin.PluginService;
@@ -90,11 +91,12 @@ private synchronized void initEnv() {
 		LogService log = context().getService(LogService.class);
 		TypeService types = context().getService(TypeService.class);
 		OpHistoryService history = context().getService(OpHistoryService.class);
-		Discoverer d = new PluginBasedDiscoverer(context());
+		Discoverer d1 = new PluginBasedDiscoverer(context());
+		Discoverer d2 = new ServiceLoaderDiscoverer();
 		List<OpInfoGenerator> infoGenerators = Arrays.asList(
-			new ClassOpInfoGenerator(d),
-			new OpCollectionInfoGenerator(d));
-		env = new DefaultOpEnvironment(types, log, history, infoGenerators, d);
+			new PluginBasedClassOpInfoGenerator(d1, d2),
+			new OpCollectionInfoGenerator(d1, d2));
+		env = new DefaultOpEnvironment(types, log, history, infoGenerators, d1, d2);
 	}
 }
 
diff --git a/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/OpClassBasedClassOpInfoGenerator.java b/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/OpClassBasedClassOpInfoGenerator.java
@@ -0,0 +1,39 @@
+
+package org.scijava.ops.engine.impl;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.scijava.ops.api.OpInfo;
+import org.scijava.ops.api.OpInfoGenerator;
+import org.scijava.ops.api.OpUtils;
+import org.scijava.ops.discovery.Discoverer;
+import org.scijava.ops.engine.matcher.impl.OpClassInfo;
+import org.scijava.ops.spi.Op;
+import org.scijava.ops.spi.OpClass;
+import org.scijava.plugin.Plugin;
+
+public class OpClassBasedClassOpInfoGenerator implements OpInfoGenerator {
+
+	private final List<Discoverer> discoverers;
+
+	public OpClassBasedClassOpInfoGenerator(Discoverer... d) {
+		this.discoverers = Arrays.asList(d);
+	}
+
+	@Override
+	public List<OpInfo> generateInfos() {
+		List<OpInfo> infos = discoverers.stream() //
+			.flatMap(d -> d.implementingClasses(Op.class).stream()) //
+			.filter(cls -> cls.getAnnotation(OpClass.class) != null) //
+			.map(cls -> {
+				OpClass p = cls.getAnnotation(OpClass.class);
+				String[] parsedOpNames = OpUtils.parseOpNames(p.names());
+				return new OpClassInfo(cls, parsedOpNames);
+			}) //
+			.collect(Collectors.toList());
+		return infos;
+	}
+
+}
diff --git a/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/OpCollectionInfoGenerator.java b/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/OpCollectionInfoGenerator.java
@@ -34,7 +34,6 @@ public OpCollectionInfoGenerator(Discoverer... d) {
 	public List<OpInfo> generateInfos() {
 		List<OpInfo> infos = discoverers.stream() //
 			.flatMap(d -> d.implementingClasses(OpCollection.class).stream()) //
-			.filter(cls -> cls.getAnnotation(Plugin.class) != null) //
 			.map(cls -> {
 			try {
 				List<OpInfo> collectionInfos = new ArrayList<>();
diff --git a/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/PluginBasedClassOpInfoGenerator.java b/scijava/scijava-ops-engine/src/main/java/org/scijava/ops/engine/impl/PluginBasedClassOpInfoGenerator.java
@@ -13,11 +13,11 @@
 import org.scijava.ops.spi.Op;
 import org.scijava.plugin.Plugin;
 
-public class ClassOpInfoGenerator implements OpInfoGenerator {
+public class PluginBasedClassOpInfoGenerator implements OpInfoGenerator {
 
 	private final List<Discoverer> discoverers;
 
-	public ClassOpInfoGenerator(Discoverer... d) {
+	public PluginBasedClassOpInfoGenerator(Discoverer... d) {
 		this.discoverers = Arrays.asList(d);
 	}
 
diff --git a/scijava/scijava-ops-engine/src/test/java/org/scijava/ops/engine/copy/CopyOpCollectionTest.java b/scijava/scijava-ops-engine/src/test/java/org/scijava/ops/engine/copy/CopyOpCollectionTest.java
@@ -0,0 +1,47 @@
+/*
+ * #%L
+ * SciJava Operations: a framework for reusable algorithms.
+ * %%
+ * Copyright (C) 2016 - 2019 SciJava Ops developers.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava.ops.engine.copy;
+
+import org.junit.Assert;
+import org.junit.Test;
+import org.scijava.ops.engine.AbstractTestEnvironment;
+
+public class CopyOpCollectionTest extends AbstractTestEnvironment {
+
+	@Test
+	public void testCopyOp() {
+		double[] input = {1, 2, 3};
+		double[] output = {4, 5, 6};
+		ops.op("cp").input(input).output(output).compute();
+		
+		Assert.assertArrayEquals(input, output, 0.);
+	}
+
+}
diff --git a/scijava/scijava-ops-engine/templates/main/java/module-info.vm b/scijava/scijava-ops-engine/templates/main/java/module-info.vm
@@ -27,11 +27,13 @@ module org.scijava.ops.engine {
 	requires org.scijava.struct;
 	requires org.scijava.ops.api;
 	requires org.scijava.ops.discovery;
+	requires org.scijava.ops.serviceloader;
 	requires org.scijava.ops.spi;
 	requires org.scijava.types;
 	requires javassist;
 	requires java.compiler;
 	requires therapi.runtime.javadoc;
 
 	uses javax.annotation.processing.Processor;
+	provides org.scijava.ops.spi.OpCollection with org.scijava.ops.engine.copy.CopyOpCollection;
 }
diff --git a/scijava/scijava-ops-serviceloader/src/main/java/module-info.java b/scijava/scijava-ops-serviceloader/src/main/java/module-info.java
@@ -7,6 +7,12 @@
 	requires org.scijava.ops.discovery;
 
 	uses org.scijava.ops.spi.Op;
-	provides org.scijava.ops.spi.Op with org.scijava.ops.serviceloader.ServiceBasedAdder;
+	uses org.scijava.ops.spi.OpCollection;
+
+	provides org.scijava.ops.spi.Op with
+			org.scijava.ops.serviceloader.ServiceBasedAdder;
+
+	provides org.scijava.ops.spi.OpCollection with
+			org.scijava.ops.serviceloader.ServiceBasedMultipliers;
 
 }
diff --git a/scijava/scijava-ops-serviceloader/src/main/java/org/scijava/ops/serviceloader/ServiceBasedMultipliers.java b/scijava/scijava-ops-serviceloader/src/main/java/org/scijava/ops/serviceloader/ServiceBasedMultipliers.java
@@ -0,0 +1,15 @@
+
+package org.scijava.ops.serviceloader;
+
+import java.util.function.BiFunction;
+
+import org.scijava.ops.spi.OpCollection;
+import org.scijava.ops.spi.OpField;
+
+public class ServiceBasedMultipliers implements OpCollection {
+
+	@OpField(names = "math.multiply")
+	public final BiFunction<Number, Number, Double> fieldMultiplier = (in1,
+		in2) -> in1.doubleValue() * in2.doubleValue();
+
+}
diff --git a/scijava/scijava-ops-serviceloader/src/main/java/org/scijava/ops/serviceloader/ServiceLoaderDiscoverer.java b/scijava/scijava-ops-serviceloader/src/main/java/org/scijava/ops/serviceloader/ServiceLoaderDiscoverer.java
@@ -1,6 +1,9 @@
+
 package org.scijava.ops.serviceloader;
 
+import java.util.Collections;
 import java.util.List;
+import java.util.ServiceConfigurationError;
 import java.util.ServiceLoader;
 import java.util.stream.Collectors;
 
@@ -11,9 +14,15 @@ public class ServiceLoaderDiscoverer implements Discoverer {
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T> List<Class<T>> implementingClasses(Class<T> c) {
-		ServiceLoader<T> loader = ServiceLoader.load(c);
-		return loader.stream().map(p -> (Class<T>) p.get().getClass()) //
+		// TODO: can we first check that THIS module uses c?
+		try {
+			ServiceLoader<T> loader = ServiceLoader.load(c);
+			return loader.stream().map(p -> (Class<T>) p.get().getClass()) //
 				.collect(Collectors.toList());
+		}
+		catch (ServiceConfigurationError e) {
+			return Collections.emptyList();
+		}
 	}
 
 }
diff --git a/scijava/scijava-ops-serviceloader/src/test/java/org/scijava/ops/serviceloader/ServiceLoaderDiscovererTest.java b/scijava/scijava-ops-serviceloader/src/test/java/org/scijava/ops/serviceloader/ServiceLoaderDiscovererTest.java
@@ -6,17 +6,24 @@
 import org.junit.Test;
 import org.scijava.ops.discovery.Discoverer;
 import org.scijava.ops.spi.Op;
+import org.scijava.ops.spi.OpCollection;
 
 public class ServiceLoaderDiscovererTest {
 
 	@Test
-	public void testServiceLoader() {
+	public void testServiceLoaderWithOps() {
 		Discoverer d = new ServiceLoaderDiscoverer();
 		List<Class<Op>> implementingClasses = d.implementingClasses(Op.class);
 		Assert.assertTrue(implementingClasses.contains(ServiceBasedAdder.class));
 		Assert.assertEquals(implementingClasses.size(), 1);
 	}
-	
 
+	@Test
+	public void testServiceLoaderWithOpCollections() {
+		Discoverer d = new ServiceLoaderDiscoverer();
+		List<Class<OpCollection>> implementingClasses = d.implementingClasses(OpCollection.class);
+		Assert.assertTrue(implementingClasses.contains(ServiceBasedMultipliers.class));
+		Assert.assertEquals(implementingClasses.size(), 1);
+	}
 }
 
