Menu App - REST webapp using Dropwizard and Guice

Introduction

Menu App is a backend system which aims to provide a basic menu component to be consumed by any client using REST as a HTTP communication interface with the outside world. It's a prototype of a micro service web app using the Dropwizard framework and Guice for DI. And also it's a template for a better separation of concerns for a web app.

The chosen arquitecture is a N-Tier layout from JavaEE apps: Presentation - Business - ORM, and is divided into the next modules: api, core, protocol, and client.

On Presentation tier we have the protocol module which defines the data layout the api delivers to any client, and the api module which defines the exposed resources for client communication.

On Business tier we have the core module which defines the domain components and the interactions between them and with the ORM tier.

On ORM tier we also have the core module which additionally defines the repositories and daos, which in essence is the mapping between domain components and persisted entities.

Modules

The api project is the application by it self. It's a standalone executable jar which serves REST calls with JSON-like responses under a Jetty embedded container. This project defines every resources' URL the system exposes. Built using Maven shade plugin to generate an uber jar which facilitates the distribution of the app since no dependencies must be installed at destination.
The protocol project provides the mapping between the requests and responses with those components the api can understand. The mapping is via representational elements so we avoid messing up the business components with annotations and/or conversion logic. Here you define your custom parsers and what data you expect to receive/send for every REST call. Also you can put any validation you want whether at receiving a request or at generating a response. Currently the project uses org.hibernate.validator.*, javax.validation.*, and custom annotated validations.
The core project exposes the Service layer, and handles the communication downwards to the persistence layer of data via a Repository layer. The Service layer only interacts with the many repositories in order to create, read, update, and delete data (CRUD). It contains stateless services which are managed by the DI api (Guice). The Repository layer aims to separate the entities the business understands and the different ways they are persisted. The Repository layer uses DAO components to interact with the underlying persistence backend.
The client project is aimed to be used by third party components. It communicates with the core system without dealing with a presentation layer. It interacts directly with the business layer avoiding performance penalty due to conversion between presentational objects to business entities.
The utils project aims to collect common and handy functions. It runs its own test suite to keep everything healthy.

Technologies

Java 8
Dropwizard 1.3.11
Dropwizard-Guicey 4.2.2 which comes with Guice 4.1.0
Dropwizard-Couchbase 0.9.1
CouchbaseMock test server
Swagger v1.5.21 integrated by Dropwizard-Swagger v1.3.9-1
Java Microbenchmark Harness
Maven 3.6.0

Build the application and setup the Eclipse projects

You can compile using next maven profiles: dev (default), test, stage, or prod. Each of them presents different configurations according the target environment you are going to generate/deploy to. Pay attention that prod profile truncates the filtered resource so it fails fast on execution. You must provide your own production ready config file. See next section.

Note: if you don't have git in your %PATH% (or $PATH) environment variable then use -Dmaven.buildNumber.skip=true.

cd menuapp
mvn clean install
mvn eclipse:eclipse -DdownloadSources=true -DdownloadJavadocs=true

Or just import the project and its modules as Maven Projects in Eclipse.

Overriding properties

On validate phase there is an ant task which checks if a file named local.overrider.properties exists. It is created the first time you compile the project using maven. The file local.overrider.properties is very handy in a sense that it allows you to add overriding properties to those already defined in other properties files. Only works with the dev profile, leaving unchanged the properties from profiles test, stage, and prod. This file is not committed into CVS, it's already marked as ignored.

Build and run CouchbaseMock Test Server

This project comes with the CouchbaseMock Test Server which serves as a simple Couchbase DB. See the project at CouchbaseMock for further details.

You must first generate the package and then execute the server:

cd CouchbaseMock-master
mvn clean package
java -jar target/CouchbaseMock-1.4.3.jar -h localhost -p 8091 -b default::couchbase

Above command starts the Couchbase Test Server with default bucket, no password, and couchbase as bucket type. Test everything is OK connecting to http://localhost:8091/pools/default/buckets.

For command line options use:

java -jar target/CouchbaseMock-1.4.3.jar -? or --help

Execution in any environment

Run Couchbase

You need first to start the CouchbaseMock test server. See above.

Execution

Remember you can use maven profiles adding -P<profile.name>. The default one is dev profile.

Note: if you don't have git in your %PATH% (or $PATH) environment variable then use -Dmaven.buildNumber.skip=true.

cd menuapp
mvn clean install
cd api
java -jar target/api-1.0.0-SNAPSHOT.jar server -

Listening requests on port 8080 as defined by profiles dev (default), test, or stage.

Note: last argument - is expected by the custom implementation of ConfigurationSourceProvider I developed. This way the app initializes with a server-config.yml file located at the jar root.

Production environment

For production environment you must build with -Pprod profile and then provide your own production ready server-config.yml file. For example:

Note: if you don't have git in your %PATH% (or $PATH) environment variable then use -Dmaven.buildNumber.skip=true.

cd menuapp
mvn clean install -Pprod
cd api
java -jar target/api-1.0.0-SNAPSHOT.jar server /etc/server-config-prod.yml

Debug using Eclipse

Run Couchbase

You need first to start the CouchbaseMock test server. See above.

Debug

First compile/install the api project so target folder is created with the filtered resources. This is important since dropwizard expects a config file.

Note: if you don't have git in your %PATH% (or $PATH) environment variable then use -Dmaven.buildNumber.skip=true.

cd api
mvn clean install

Then open Eclipse and open the class MenuAppApplication.java. Go to Run -> Debug Configurations -> create a Java Application and in Arguments tab add server -. Finally hit Apply and then Debug.

Build info for Continuous Integration

By default when compiling any project there is a maven plugin named buildnumber-maven-plugin which gets revision number, current branch, build time, and use that info on filtering resources phase. Currently only the api projects use the build info provided by the plugin. So you can call http://localhost:8080/buildinfo and be responded with revision id and branch name information of the last change made in the project, as well as the build time.

During development, some settings of this plugin are disabled in order to speed up compilation. Nevertheless you can completely turn it off using -Dmaven.buildNumber.skip=true

Conversely, when using a CI software use the next command in order to always retrieve latest code and avoid compilation if local changes has been made:

mvn clean install -Dmaven.buildNumber.doCheck=true -Dmaven.buildNumber.doUpdate=true

Swagger for API Documentation

Accessing REST API documentation

Once the Menu App is deployed you can visit http://localhost:8080/swagger to access API documentation.

Disable Swagger on production

On production environment you need to add swagger.enabled=false in your production server-config.yml file.

Example URLs using GET method

http://localhost:8080/buildinfo

http://localhost:8080/profile

http://localhost:8080/user/1/menu

http://localhost:8080/user/1/menu/2

The app loads a set of dummy menus, which are created at class PreloadedMenuDao. This class is managed as a bean, and is injected into the menu repository which is also injected into the menu service. The dependency injection is all setup in the api module. Take a look at org.fabri1983.menuapp.api.provide package.

Example URLs using POST method

Note: add Content-Type:application/json and Accept:application/json,text in your REST Client plugin at header section.

POST http://localhost:8080/user/login
{
  "userName": "johnz",
  "userPassHashed": "123AARtiy56DDdcsK98d9gi",
  "location": {
    "latitude": 15546568450,
    "longitude": 85345243570
  }
}

POST http://localhost:8080/user/1/menu/group
{
  "maxResults": 10,
  "priceFrom": 150,
  "priceTo":  850,
  "currency": "DEFAULT_USD"
}

POST http://localhost:8080/user/1/menu/filter
{
  "maxResults": 10,
  "maxPrice": 100,
  "currency": "DEFAULT_USD"
}

POST http://localhost:8080/user/1/menu/filter
{
  "maxResults": 10,
  "maxPrice": 100,
  "currency": "DEFAULT_USD",
  "hourFrom": "20:00:00",
  "hourTo": "23:00:00",
  "availableDays": [
      "Friday",
      "Saturday",
      "Sunday"
  ],
  "availableDateFrom": "2016-03-01T00:00:00",
  "availableDateTo": "2016-04-01T23:59:59"
}

POST http://localhost:8080/user/1/rate/menu/1
{
  "rating": 1,
  "description": "The description of the rating isn't stored yet"
}

Segregate configurations

Dropwizard expects one configuration file as program argument. MenuApp uses its own server-config.yml shipped within the generated jar when you pass argument -, or your own config file when passing its location instead.

This means that all configuration exists in one file, may be small/med/big depending the size of the app, hence all kind of settings are exposed throughout the application and so the configuration is a whitebox: anybody can see its content. The MenuAppConfiguration class, although it exposes all the settings to whoever injects the MenuAppConfiguration class, is used by Dropwizard's bootstrap phase to load the config file and also makes use of some neat feature that guicey provides.

So if you want to limit the visibility of those settings per resource, service, repository, or any other component then dropwizard-guicey gives you the pattern Has Feature. In this pattern the MenuAppConfiguration class implements interfaces such as HasBuildInfoFeature and HasMenuQueryFeature, and guicey integration handles the binding with the injection points on those components using @Inject. This way the components only see the settings they matter, and nothing more. Of course is up to you to avoid inject the MenuAppConfiguration elsewhere :).

Example:

    @Override
    void initialize (Bootstrap<MenuAppConfiguration> bootstrap) {
        bootstrap.addBundle(GuiceBundle.<MenuAppConfiguration>builder()
                    .bindConfigurationInterfaces()
					...
        ...
	}

    public interface HasBuildInfoFeature {
        BuildInfoConfig getBuildInfoConfig ();
    }

    public class MenuAppConfiguration extends Configuration 
									implements HasBuildInfoFeature, HasMenuQueryFeature {
		@Valid @NotNull
		private BuildInfoConfig buildInfoConfig;
		...
		
		@Override
		public BuildInfoConfig getBuildInfoConfig () {
			return buildInfoConfig;
		}
		...
	}

	public class BuildInfoConfig {

		@NotEmpty
		private String buildInfo;
		@NotEmpty
		private String buildProfile;
		
		public String getBuildInfo () {
			return buildInfo;
		}
		
		public String getBuildProfile () {
			return buildProfile;
		}
	}

And finally your resource class only injects the settings it really matters which in this case is BuildInfoFeature, instead of the entire MenuAppConfiguration object.

	@Path("")
	@Produces(MediaType.TEXT_PLAIN)
	public class InfoResource {

		private BuildInfoConfig buildInfoConfig;
		
		@Inject
		public InfoResource (HasBuildInfoFeature hasBuildInfoFeature) {
			this.buildInfoConfig = hasBuildInfoFeature.getBuildInfoConfig();
		}
        ...
    }

JMH: Java Microbenchmarking Harness

By the moment only project core is using JMH on test phase. I'm not sure this is the correct approach since the guys from JMH explicitly recommend to create a separated jar with a main class executing the entire benchmark. In my approach every ...Benchmark class extends from JMHLauncherJUnit and executes a JMH instance.

Execution

This also runs the normal JUnit tests.

mvn test -Dbenchmark.suite="**/BenchmarkTestsSuite.class"

TODO list

Analyze possible duplication of resources injection. Next message appears twice in console: io.dropwizard.server.SimpleServerFactory: Registering jersey handler with root path prefix
Investigate the use of Transactions (UnitOfWork) with Dropwizard.
Define exceptions and handle them in Service layer to provide upper layers human readable messages. Then according the type of exception use the correct HTTP return code.
Use of Optional<T> to hide null manipulation.
When a service needs several execution steps, use Chain of Responsibility with a chain builder or alike to improve readability.
For currency conversion use Strategy pattern, so I can provide an algorithm for any currency conversion. The conversion method uses Visitor pattern.
Unit test the services, parsers, converters, etc. Test the use of Guice's dependency injection.
Move Test utils to parent pom and generate a test-jar.
Revisit the list of FIXMEs and TODOs.
Complete Swagger documentation: add documentation in resource and protocol classes.
Checkout this complete parent pom.xml example: https://github.com/jcabi/jcabi-parent/blob/master/pom.xml.
Checkout these interesting answers related to JUnit and Mockito: http://stackoverflow.com/questions/15494926/initialising-mock-objects-mockito

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Menu App - REST webapp using Dropwizard and Guice

Introduction

Modules

Technologies

Build the application and setup the Eclipse projects

Overriding properties

Build and run CouchbaseMock Test Server

Execution in any environment

Run Couchbase

Execution

Production environment

Debug using Eclipse

Run Couchbase

Debug

Build info for Continuous Integration

Swagger for API Documentation

Accessing REST API documentation

Disable Swagger on production

Example URLs using GET method

Example URLs using POST method

Segregate configurations

JMH: Java Microbenchmarking Harness

Execution

TODO list

Files

README.md

Latest commit

History

README.md

File metadata and controls

Menu App - REST webapp using Dropwizard and Guice

Introduction

Modules

Technologies

Build the application and setup the Eclipse projects

Overriding properties

Build and run CouchbaseMock Test Server

Execution in any environment

Run Couchbase

Execution

Production environment

Debug using Eclipse

Run Couchbase

Debug

Build info for Continuous Integration

Swagger for API Documentation

Accessing REST API documentation

Disable Swagger on production

Example URLs using GET method

Example URLs using POST method

Segregate configurations

JMH: Java Microbenchmarking Harness

Execution

TODO list