[OODT-1015] Workflow Manager V2 JAX-RS REST APIs #101

NGimhana · 2019-07-22T09:01:34Z

This PR address JIRA Issue OODT-1015. PR contains the implementation of the next version(V2) of JAXRS REST APIs for OODT-Workflow Manager. These APIs satisfies API characteristics like providing back-compatibility, allowing CORS headers, exception handling with proper payloads. (endpoint pattern: /jaxrs/v2/*)

IMS94 · 2019-08-25T04:33:12Z

webapp/wmservices/pom.xml

-		</dependency>
-	</dependencies>
-</project>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"


This file seems to be reformatted with tabs replaced with spaces and LF line endings replaced with CRLF. I reverted those and created the following pom. Please check that and update the PR accordingly.

<?xml version='1.0' encoding='UTF-8'?>  <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.apache.oodt</groupId> <artifactId>oodt-core</artifactId> <version>1.9-SNAPSHOT</version> <relativePath>../../core/pom.xml</relativePath> </parent> <artifactId>workflow-services</artifactId> <packaging>war</packaging> <name>CAS Workflow REST Services</name> <description> A set of REST-ful services for the Workflow Manager. </description> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <executions> <execution> <id>make-a-jar</id> <phase>compile</phase> <goals> <goal>jar</goal> </goals> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <executions> <execution> <phase>install</phase> <goals> <goal>install-file</goal> </goals> <configuration> <packaging>jar</packaging> <artifactId>${project.artifactId}</artifactId> <groupId>${project.groupId}</groupId> <version>${project.version}</version> <file> ${project.build.directory}/${project.artifactId}-${project.version}.jar </file> </configuration> </execution> </executions> </plugin> </plugins> </build> <dependencies> <dependency> <groupId>org.apache.oodt</groupId> <artifactId>cas-workflow</artifactId> <scope>compile</scope> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>servlet-api</artifactId> <scope>provided</scope> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-frontend-jaxrs</artifactId> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-rs-extension-providers</artifactId> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-local</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.apache.cxf</groupId> <artifactId>cxf-rt-transports-http-jetty</artifactId> </dependency> <dependency> <groupId>org.codehaus.jettison</groupId> <artifactId>jettison</artifactId> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <scope>test</scope> </dependency> </dependencies> </project>

Just an inquiry. What's the difference between LF and CRLF. Both are line endings, right?

CRLF (Carriage return line feed \r\n) is used by windows operating systems. LF (\n) is used by unix mostly. Windows will usually replace LF with CRLF when cloning repositories. This will cause git to consider the whole file as changed. In this file, I noticed that line endings have changed from LF to CRLF in your version. In future, if we want to see who changed a specific line, it will be you who will get annotated due to this, not the actual author.

IMS94 · 2019-08-25T04:36:09Z

webapp/wmservices/src/main/java/org/apache/oodt/cas/wmservices/resources/MetadataResource.java

+ */
+@XmlRootElement(name = "metadata")
+@XmlAccessorType(XmlAccessType.NONE)
+public class MetadataResource


Was this file taken from some other location? Like file manager services? If yes, we have some code duplication to address (we can do that later)

Yes. I took it from FM resources. Same functionality. What is the code duplication process?

Usually we need to have a common module to hold shared resource classes and both FM and WM should use it. We can do that later.

+1. Most of the exceptions, resources and exception mappers are same for all the web apps. We can port those to common module. say "webapp-common"

Yes. Something like that.

IMS94 · 2019-08-25T04:39:01Z

webapp/wmservices/src/main/java/org/apache/oodt/cas/wmservices/services/WMJaxrsServiceV2.java

+      WorkflowInstance workflowInstanceById = wmclient.getWorkflowInstanceById(workflowInstId);
+      WorkflowInstanceResource workflowResource =
+          new WorkflowInstanceResource(workflowInstanceById);
+      logger.debug("WorkFlowInstance ID : " + workflowInstId);


In SLF4J, we can write this as logger.debug("WorkFlowInstance ID : {}", workflowInstId);. No need to concatenate manually.

IMS94 · 2019-08-25T04:40:18Z

webapp/wmservices/src/main/java/org/apache/oodt/cas/wmservices/services/WMJaxrsServiceV2.java

+  @Path("workflowInst")
+  @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
+  public WorkflowInstanceResource getWorkflowInstanceById(
+      @QueryParam("workflowInstId") String workflowInstId) throws WebApplicationException {


Here, query param workflowInstId can be null since it is coming from the query params. Is that a valid scenario? If not, we should move that to a path param right?

webapp/wmservices/src/main/java/org/apache/oodt/cas/wmservices/services/WMJaxrsServiceV2.java

IMS94 · 2019-08-25T04:58:57Z

webapp/wmservices/src/main/webapp/META-INF/context.xml

@@ -10,12 +10,12 @@
 	OR CONDITIONS OF ANY KIND, either express or implied. See the License for 
 	the specific language governing permissions and limitations under the License. -->

-<Context path="/cas-wm-services" reloadable="true" crossContext="true">
+<Context crossContext="true" docBase="/path/to/cas-workflow-services.war" reloadable="true">


Seems like formatting only changes. docBase here can be left unchanged. See tomcat documentation on that. Is there any specific reason for the docBase change?

I used docBase to locate the WAR file in tomcat server. It's just as the FM web app.

That means, is this change necessary?

Yes, this makes sense to a third-party developer to understand the usage of context.xml.

Great. The changed version is missing the path attribute right?

Correct. path is replaced by docBase

In tomcat, AFAIK, path is the URL suffix while docBase is the path to war. I think we should need both?

IMS94 · 2019-08-25T05:05:41Z

webapp/wmservices/src/main/webapp/WEB-INF/web.xml

    <servlet-class>
      org.apache.oodt.cas.wmservices.servlets.WmServicesServlet
    </servlet-class>
+    <servlet-name>WmServicesServlet</servlet-name>


Just an inquiry. This was the old servlet definition right? Does that need any changes like this? I have removed some non-related formatting below.

<?xml version="1.0" encoding="UTF-8"?>  <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> <display-name>CAS Workflow Manager Services</display-name> <filter> <filter-class>org.apache.oodt.cas.wmservices.filters.CORSFilter</filter-class> <filter-name>CorsFilter</filter-name> </filter> <filter-mapping> <filter-name>CorsFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <servlet> <servlet-name>WmServicesServlet</servlet-name> <servlet-class> org.apache.oodt.cas.wmservices.servlets.WmServicesServlet </servlet-class> <init-param> <param-name>jaxrs.serviceClasses</param-name> <param-value> org.apache.oodt.cas.wmservices.resources.WorkflowResource </param-value> </init-param> <init-param> <param-name>jaxrs.scope</param-name> <param-value>prototype</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet> <init-param> <param-name>jaxrs.serviceClasses</param-name> <param-value> org.apache.oodt.cas.wmservices.services.WMJaxrsServiceV2 </param-value> </init-param> <init-param> <param-name>jaxrs.providers</param-name> <param-value> org.apache.oodt.cas.wmservices.exceptionmappers.NotFoundExceptionMapper, org.apache.oodt.cas.wmservices.exceptionmappers.BadRequestExceptionMapper, org.apache.oodt.cas.wmservices.exceptionmappers.InternalServerErrorExceptionMapper, org.apache.oodt.cas.wmservices.exceptionmappers.CasWorkflowExceptionMapper, </param-value> </init-param> <init-param> <param-name>jaxrs.extensions</param-name> <param-value> file=application/octet-stream json=application/json rdf=application/rdf+xml rss=application/rss+xml xml=application/xml zip=application/zip </param-value> </init-param> <init-param> <param-name>jaxrs.scope</param-name> <param-value>prototype</param-value> </init-param> <load-on-startup>1</load-on-startup> <servlet-class> org.apache.oodt.cas.wmservices.servlets.WmServicesServlet </servlet-class> <servlet-name>WmServicesServletV2</servlet-name> </servlet>  <servlet-mapping> <servlet-name>WmServicesServletV2</servlet-name> <url-pattern>/jaxrs/v2/*</url-pattern> </servlet-mapping> <servlet-mapping> <servlet-name>WmServicesServlet</servlet-name> <url-pattern>/service/*</url-pattern> </servlet-mapping> </web-app>

IMS94 · 2019-08-25T05:07:45Z

webapp/wmservices/src/main/webapp/WEB-INF/web.xml

+  <!-- CORS Header Filtering -->
+  <servlet-mapping>
+    <servlet-name>WmServicesServletV2</servlet-name>
+    <url-pattern>/jaxrs/v2/*</url-pattern>


Can we rename jaxrs/v2 to a meaningful name like wmservice/v2?

IMS94 · 2019-08-25T05:08:27Z

workflow/src/main/java/org/apache/oodt/cas/workflow/system/AvroRpcWorkflowManager.java

@@ -90,13 +90,13 @@ public AvroRpcWorkflowManager(int port){
            throw new IllegalStateException("Null engine");
        }

-        URL workflowManagerUrl = safeGetUrlFromString("http://" + getHostname() + ":" + port);
+        URL workflowManagerUrl = safeGetUrlFromString("http://localhost" + ":" + port);


This should not be changed

IMS94 · 2019-08-25T05:09:17Z

workflow/src/main/java/org/apache/oodt/cas/workflow/system/AvroRpcWorkflowManager.java

        if(workflowManagerUrl == null){
            throw new IllegalStateException("Null workflow manager URL");
        }

        logger.debug("Setting workflow engine url: {}", workflowManagerUrl.toString());
-        engine.setWorkflowManagerUrl(safeGetUrlFromString("http://" + getHostname() + ":" + port));
+        engine.setWorkflowManagerUrl(safeGetUrlFromString("http://localhost" + ":" + port));


This should not be changed.

IMS94 · 2019-08-25T05:10:13Z

@NGimhana I have added some review comments above. Can you check?

NGimhana · 2019-08-29T13:27:45Z

@IMS94 I did changes as you suggested. Extremely apologise for the code formatting issues. Accidently I have changed google style to another one.

IMS94 · 2019-09-21T07:31:41Z

@NGimhana Thanks for the PR. Merged.

NGimhana added 3 commits July 22, 2019 14:11

[OODT-1015] Workflow Manager V2 JAX-RS REST APIs

ad64036

Add REST APIs for Workflow pause,stop,resume,list

28aedff

Add REST API for Update workflow Instance State

78340c9

IMS94 suggested changes Aug 25, 2019

View reviewed changes

NGimhana added 4 commits August 27, 2019 13:23

Merge branch 'development' into OODT-1015-Temp-V1

61c24cb

Merge branch 'development' into OODT-1015-Temp-V1

ad399a8

Fix code style issues and some code improvements

2465d1d

Merge branch 'development' into OODT-1015-Temp-V1

389874f

IMS94 merged commit 389874f into apache:development Sep 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OODT-1015] Workflow Manager V2 JAX-RS REST APIs #101

[OODT-1015] Workflow Manager V2 JAX-RS REST APIs #101

NGimhana commented Jul 22, 2019

IMS94 Aug 25, 2019

NGimhana Aug 29, 2019 •

edited

Loading

IMS94 Sep 4, 2019

IMS94 Aug 25, 2019

NGimhana Aug 29, 2019

IMS94 Sep 4, 2019

NGimhana Sep 4, 2019

IMS94 Sep 5, 2019

IMS94 Aug 25, 2019

IMS94 Aug 25, 2019

IMS94 Aug 25, 2019

NGimhana Aug 29, 2019

IMS94 Sep 4, 2019

NGimhana Sep 4, 2019

IMS94 Sep 5, 2019

NGimhana Sep 8, 2019

IMS94 Sep 10, 2019

IMS94 Aug 25, 2019

IMS94 Aug 25, 2019

IMS94 Aug 25, 2019

IMS94 Aug 25, 2019

IMS94 commented Aug 25, 2019

NGimhana commented Aug 29, 2019 •

edited

Loading

IMS94 commented Sep 21, 2019

[OODT-1015] Workflow Manager V2 JAX-RS REST APIs #101

[OODT-1015] Workflow Manager V2 JAX-RS REST APIs #101

Conversation

NGimhana commented Jul 22, 2019

Choose a reason for hiding this comment

NGimhana Aug 29, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IMS94 commented Aug 25, 2019

NGimhana commented Aug 29, 2019 • edited Loading

IMS94 commented Sep 21, 2019

NGimhana Aug 29, 2019 •

edited

Loading

NGimhana commented Aug 29, 2019 •

edited

Loading