You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by cw...@apache.org on 2018/09/17 19:23:31 UTC

svn commit: r1841133 - in /uima/uima-ducc/trunk/uima-ducc-pullservice/src: main/java/org/apache/uima/ducc/ps/service/ main/java/org/apache/uima/ducc/ps/service/builders/ main/java/org/apache/uima/ducc/ps/service/main/ main/java/org/apache/uima/ducc/ps/...

Author: cwiklik
Date: Mon Sep 17 19:23:30 2018
New Revision: 1841133

URL: http://svn.apache.org/viewvc?rev=1841133&view=rev
Log:
UIMA-5866 by default the pull service should wait when client has tasks. Add a new JUnit test to cover this scenario.

Added:
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultNoTaskAvailableStrategy.java
Modified:
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/ServiceConfiguration.java
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/builders/PullServiceStepBuilder.java
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/PullService.java
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/ServiceWrapper.java
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultServiceProtocolHandler.java
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/Client.java
    uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/service/wrapper/JUnitServiceWrapperTestCase.java

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/ServiceConfiguration.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/ServiceConfiguration.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/ServiceConfiguration.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/ServiceConfiguration.java Mon Sep 17 19:23:30 2018
@@ -33,7 +33,6 @@ public class ServiceConfiguration {
 	private String analysisEngineDescriptorPath;
 	private String serviceType;
 	private String jpType;
-//	private String assignedJmxPort;
 	private String customRegistryClass;
 	private String customProcessorClass;
 	private String serviceJmxConnectURL;
@@ -47,6 +46,7 @@ public class ServiceConfiguration {
 	private String aeOverrides;
 	private String maxErrors;
 	private String errorWindowSize;
+	private int waitTimeWhenNoTaskGiven = 0;
 	private ClassLoader sysCL=null;
     private String processType;
     
@@ -56,6 +56,9 @@ public class ServiceConfiguration {
 	public void setProcessType(String processType) {
 		this.processType = processType;
 	}
+	public int getWaitTime() {
+		return this.waitTimeWhenNoTaskGiven;
+	}
 	public String getMaxErrors() {
 		return maxErrors;
 	}
@@ -242,9 +245,11 @@ public class ServiceConfiguration {
 		serviceType = System.getProperty("ducc.deploy.service.type");
 	    maxErrors = System.getProperty("ducc.deploy.JpErrorThreshold");
 	    errorWindowSize = System.getProperty("ducc.deploy.JpErrorWindowSize");
-		
+	    if ( System.getProperty("ducc.process.thread.sleep.time") != null ) {
+	    	waitTimeWhenNoTaskGiven =
+	    			Integer.valueOf(System.getProperty("ducc.process.thread.sleep.time"));
+	    }
 		jpType = System.getProperty("ducc.deploy.JpType");
-//		assignedJmxPort = System.getProperty("ducc.jmx.port");
 		serviceJmxConnectURL = System.getProperty("ducc.jmx.port");
 		customRegistryClass = System.getProperty("ducc.deploy.registry.class");
 		customProcessorClass = System.getProperty("ducc.deploy.custom.processor.class");

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/builders/PullServiceStepBuilder.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/builders/PullServiceStepBuilder.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/builders/PullServiceStepBuilder.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/builders/PullServiceStepBuilder.java Mon Sep 17 19:23:30 2018
@@ -50,6 +50,7 @@ public final class PullServiceStepBuilde
 		private int scaleout = 1;
 		private String serviceType;
 		private String clientURL;
+		private int waitTimeInMillis;
 		
 		@Override
 		public IService build() {
@@ -61,6 +62,7 @@ public final class PullServiceStepBuilde
 			}
 			 
 			service.setScaleout(scaleout);
+			service.setWaitTime(waitTimeInMillis);
 			if ( registryClient == null ) {
 				service.setClientURL(clientURL);	
 			} else {
@@ -83,6 +85,11 @@ public final class PullServiceStepBuilde
 			return this;
 		}
 		@Override
+		public OptionalsStep withWaitOnNoTask(int waitTimeInMillis) {
+			this.waitTimeInMillis = waitTimeInMillis;
+			return this;
+		}
+		@Override
 		public BuildStep withOptionalsDone() {
 			return this;
 		}
@@ -114,6 +121,7 @@ public final class PullServiceStepBuilde
 	public interface OptionalsStep {
 		public OptionalsStep withScaleout(int scaleout);
 		public OptionalsStep withType(String type);
+		public OptionalsStep withWaitOnNoTask(int waitTimeInMillis);
 		public BuildStep withOptionalsDone();
 	}
 	public interface BuildStep {

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/PullService.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/PullService.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/PullService.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/PullService.java Mon Sep 17 19:23:30 2018
@@ -34,6 +34,7 @@ import java.util.concurrent.locks.Reentr
 import org.apache.uima.UIMAFramework;
 import org.apache.uima.ducc.ps.ServiceThreadFactory;
 import org.apache.uima.ducc.ps.service.IService;
+import org.apache.uima.ducc.ps.service.builders.PullServiceStepBuilder.OptionalsStep;
 //import org.apache.uima.ducc.ps.service.ServiceConfiguration;
 import org.apache.uima.ducc.ps.service.errors.IServiceErrorHandler;
 import org.apache.uima.ducc.ps.service.errors.ServiceException;
@@ -41,6 +42,7 @@ import org.apache.uima.ducc.ps.service.e
 import org.apache.uima.ducc.ps.service.monitor.IServiceMonitor;
 import org.apache.uima.ducc.ps.service.processor.IServiceProcessor;
 import org.apache.uima.ducc.ps.service.protocol.IServiceProtocolHandler;
+import org.apache.uima.ducc.ps.service.protocol.builtin.DefaultNoTaskAvailableStrategy;
 import org.apache.uima.ducc.ps.service.protocol.builtin.DefaultServiceProtocolHandler;
 import org.apache.uima.ducc.ps.service.protocol.builtin.NoWaitStrategy;
 import org.apache.uima.ducc.ps.service.registry.DefaultRegistryClient;
@@ -59,7 +61,9 @@ public class PullService implements ISer
 	private ScheduledThreadPoolExecutor threadPool ;
 	// how many processing threads
 	private int scaleout=1;
-
+	// amount of time to wait when client has no tasks to give
+	private int waitTimeInMillis=0;  
+	
 	// application assigned service label
 	private String type;
 	private volatile boolean initialized = false;
@@ -107,6 +111,9 @@ public class PullService implements ISer
 	public String getType() {
 		return type;
 	}
+	public void setWaitTime(int waitTimeInMillis) {
+		this.waitTimeInMillis = waitTimeInMillis;
+	}
 	public void setScaleout(int scaleout) {
 		this.scaleout = scaleout;
 		this.threadsReady = new CountDownLatch(scaleout);
@@ -183,7 +190,7 @@ public class PullService implements ISer
 	        protocolHandler =
 					   new DefaultServiceProtocolHandler.Builder()
 					   .withProcessor(serviceProcessor)
-					   .withNoTaskStrategy(new NoWaitStrategy())
+					   .withNoTaskStrategy(new DefaultNoTaskAvailableStrategy(waitTimeInMillis))
 					   .withService(this)
 					   .withTransport(transport)
 					   .withDoneLatch(stopLatch)

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/ServiceWrapper.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/ServiceWrapper.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/ServiceWrapper.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/main/ServiceWrapper.java Mon Sep 17 19:23:30 2018
@@ -171,6 +171,7 @@ public class ServiceWrapper implements A
 					.withRegistry(getRegistryClient())
 					.withType(serviceConfiguration.getServiceType())
 					.withScaleout(Integer.valueOf(serviceConfiguration.getThreadCount()))
+					.withWaitOnNoTask(serviceConfiguration.getWaitTime())
 					.withOptionalsDone().build();
 
 		} else {
@@ -179,6 +180,7 @@ public class ServiceWrapper implements A
 					.withClientURL(serviceConfiguration.getClientURL())
 					.withType(serviceConfiguration.getServiceType())
 					.withScaleout(Integer.valueOf(serviceConfiguration.getThreadCount()))
+					.withWaitOnNoTask(serviceConfiguration.getWaitTime())
 					.withOptionalsDone().build();
 
 		}

Added: uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultNoTaskAvailableStrategy.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultNoTaskAvailableStrategy.java?rev=1841133&view=auto
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultNoTaskAvailableStrategy.java (added)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultNoTaskAvailableStrategy.java Mon Sep 17 19:23:30 2018
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+*/
+
+package org.apache.uima.ducc.ps.service.protocol.builtin;
+
+import org.apache.uima.ducc.ps.service.protocol.INoTaskAvailableStrategy;
+
+public class DefaultNoTaskAvailableStrategy implements INoTaskAvailableStrategy {
+	private int waitTime = 60000;   // default
+	private static final Object monitor = new Object();
+	
+	public DefaultNoTaskAvailableStrategy(int waitTime) {
+		// if wait time not specified use default
+		if ( waitTime > 0 ) {
+			this.waitTime = waitTime;
+		}
+	}
+	@Override
+	public void handleNoTaskSupplied() {
+		synchronized(monitor) {
+			// wait only it wait time > 0. No indefinite wait supported
+			if ( waitTime > 0 ) {
+				try {
+					System.out.println("DefaultNoTaskAvailableStrategy.handleNoTaskSupplied() waiting for:"+waitTime);
+					monitor.wait(waitTime);
+				} catch( InterruptedException e) {
+				}
+			}
+		}
+	}
+}

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultServiceProtocolHandler.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultServiceProtocolHandler.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultServiceProtocolHandler.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/main/java/org/apache/uima/ducc/ps/service/protocol/builtin/DefaultServiceProtocolHandler.java Mon Sep 17 19:23:30 2018
@@ -226,6 +226,7 @@ public class DefaultServiceProtocolHandl
 					break;
 				}
 				if (transaction.getMetaTask() == null || transaction.getMetaTask().getUserSpaceTask() == null ) {
+					System.out.println("------------- No Task --------------");
 					// the client has no tasks to give. 
 					noTaskStrategy.handleNoTaskSupplied();
 					continue;

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/Client.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/Client.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/Client.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/Client.java Mon Sep 17 19:23:30 2018
@@ -154,7 +154,11 @@ public class Client {
 						System.out.println("---- Driver handling GET Request -- Thread:"+Thread.currentThread().getId());
 						imt.setMetaTask(getMetaMetaCas());
 						imt.getMetaTask().setAppData("CorrelationID-"+correlationIdCounter.incrementAndGet());
-						imt.getMetaTask().setUserSpaceTask(getSerializedCAS());
+						if ( System.getProperty("simulate.no.work") == null) {
+							imt.getMetaTask().setUserSpaceTask(getSerializedCAS());
+						} else {
+							imt.getMetaTask().setUserSpaceTask(null);
+						}
 					//	handleMetaCasTransationGet(trans, taskConsumer);
 						break;
 					case Ack:

Modified: uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/service/wrapper/JUnitServiceWrapperTestCase.java
URL: http://svn.apache.org/viewvc/uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/service/wrapper/JUnitServiceWrapperTestCase.java?rev=1841133&r1=1841132&r2=1841133&view=diff
==============================================================================
--- uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/service/wrapper/JUnitServiceWrapperTestCase.java (original)
+++ uima/uima-ducc/trunk/uima-ducc-pullservice/src/test/java/org/apache/uima/ducc/ps/service/wrapper/JUnitServiceWrapperTestCase.java Mon Sep 17 19:23:30 2018
@@ -34,7 +34,19 @@ public class JUnitServiceWrapperTestCase
 		// sending READY to a monitor
 		System.setProperty("ducc.service.init.delay", "3000");
 	}
-
+	
+	
+	@Test
+	public void testPullServiceWrapperNoTask() throws Exception {
+		// make client return null task in response to GET
+		System.setProperty("simulate.no.work", "true");
+		//System.setProperty("ducc.process.thread.sleep.time", "2000");
+		try {
+			testPullServiceWrapper();
+		} finally {
+			System.getProperties().remove("simulate.no.work");
+		}
+	}
 	@Test
 	public void testPullServiceWrapper() throws Exception {
 		System.out.println("-------------------------- testPullServiceWrapper ----------------------");;
@@ -58,7 +70,7 @@ public class JUnitServiceWrapperTestCase
 
 			Timer fTimer = new Timer("testPullService Timer");
 			// after 5secs stop the pull service
-			fTimer.schedule(new MyTimerTask(service, fTimer), 5000);
+			fTimer.schedule(new MyTimerTask(service, fTimer), 10000);
 				
 			service.initialize(new String[] {analysisEngineDescriptor});