Run and debug Pipes locally

Prepare the environment

Prerequisites:

• Gradle >= 4.6
• npm
• quasar cli
• java

Environment setup

Run the following commands:

git clone https://github.com/marklogic-community/pipes.git
cd pipes
npm install
npm install -g @quasar/cli

Running from source

This process is meant for local development, i.e. changes are immediately reflected.

In one terminal/command prompt, run:

cd java-middle-tier
gradle runLocal

Then in a separate terminal/command prompt, run:

cd java-middle-tier
gradle runQuasarDev

If you don't want to use the default settings for the application you can provide an application-local.properties file in the folder 'java-middle-tier/src/main/resources'

Here you can override properties, it can contain the following:

server.port=[portnr for the UI]
server.servlet.session.timeout=60m
customModulesRoot=[location where you can store custom user functions]
mlDhfRoot=[location of your DHF project]

To use this properties file you can specify the profile on the terminal command:

cd java-middle-tier
gradle runLocal --args='--spring.profiles.active=local'

Build the jar

To build a jar with version information in the filename (aka "dev version"), run

cd pipes/java-middle-tier
gradle buildDevPipes

Resulting jar would be found at java-middle-tier/build/libs/

Tracing events (Pipes modules running on MarkLogic)

Add these trace events to get more logging for Pipes specific modules in MarkLogic:

pipes-vpp and pipes-vpp-details => all logs for the vppBackendService

pipes-graphHelper and pipes-graphHelper-details => all logs for the pipes-graphHelper module

pipes-coreFuntions => all logs for the coreFunctions module

pipes-core and pipes-core-details => all logs for the core module