This is the code repository for the Tracking Dependencies Beyond the Build Stage article.
- Uses DayPilot Pro for JavaScript - you may need to request and deploy a trial version in order to see the front-end part, which is actually optional.
- This project builds on the Using JavaScript/HTML5 Scheduler in Spring Boot (Open-Source) tutorial by DayPilot.
It is to demonstrate how a reliable information about dependenceis can be provided at runtime.
This project uses Maven for building, but nothing stops you to do the same with another framework.
At build time, the list of dependencies is collected using the Apache Maven Dependency Plugin where the output type is graphml. This format is directly readable by the powerful yEd diagram editor if you are interested in rendering it as a graph (some manual work would be needed though). The resulting XML file is stored in the classpath, thus making it available at runtime.
In terms of configuration, you only need to add the plugin to the pom.xml file:
org.apache.maven.plugins
maven-dependency-plugin
compile
tree
graphml
src/main/resources/${project.name}-dependency-tree.xml
This applies to each of the project's modules, if any. The information is aggregated at runtime, so you'll be presented the list of dependencies across all modules. Since the dependencies have their own dependencies, the resulting graph is a tree in XML format. We are interested in managing dependencies, so only the direct (top level) nodes are retrieved from the tree and then aggregated.
An API is provided to expose a list of the manageable dependencies to the front-end.
This API is designed for use with DayPilot Pro for JavaScript, but could be implemented otherwise too. An example initial screen is shown below.
The size of the visible time window is configurable - in this case it is 1 year from the current date. You can use the calendar icon to set the start date of the time window.
Apart from the list of dependencies, it is possible to define a list of scheduled events for each of them. You can add events using the mouse and then drag or resize them (change start / end time) the same way. There is a context menu for each event, assigned to the right mouse button.
For the demo, event data is only kept in-memory. If you need persistent data, you can implement the provided interface otherwise.
Recall, to see the dependencies in the browser, you need to provide your own copy of DayPilot Pro for JavaScript, place and refer to it in the project source tree as shown below. In your case, the version can be different though, you'll get it when downloading the trial.
Use mvn clean package from the root of the project. The executable .jar file is stored in the target sub-directory. Running it starts a local Web server - watch the console for the port - the context path is /demo. For example, the URL to navigate could be http://localhost:8080/demo/dependency-management.html. In addition, you can explore the API at http://localhost:8080/demo/swagger-ui/index.html.
Enjoy!
- Same as the origin.