Mojaloop Reporting Service

• Map SQL queries to HTTP routes in config/reports.json.
• The format is

  {
      "/route/to/serve/report/on": "SELECT some, data FROM some_table WHERE some_parameter = $P{url_query_string_param}",
      "/other/route": "SELECT more, stuff FROM another_table WHERE whatever = $P{some_different_param}",
      "/route/with/optional/param": "SELECT even, more, stuff FROM another_table WHERE whatever = $O{optional_param} OR $O{optional_param} IS NULL"
  }

• Make requests as follows:

  curl localhost:3000/route/to/serve/report/on?url_query_string_param=foobar
  

• At the time of writing, the value of optional parameters will be NULL where omitted. Therefore, it is up to the query author to supply a query that functions correctly when the supplied parameter is NULL. In this example, the query will succeed whether optional_param is equal to whatever or NULL.

  SELECT
      even, more, stuff
  FROM
      another_table
  WHERE
      whatever = $O{optional_param}
  OR
      $O{optional_param} IS NULL

Build

From the repo root:

docker build .

Run

Populate an environment file with the credentials of your Mojaloop instance:

cat <<EOF >./.my.env
DB_HOST="localhost"
DB_USER="central_ledger"
DB_PASSWORD="password"
DB_DATABASE="central_ledger"
EOF

Where $image is the image name from the build stage:

docker run -v $PWD/config:/opt/reports/config --env-file=./.my.env $image

TODO

• The initial implementation was developed with compatibility for Jaspersoft Studio queries in mind. Optionally use different templating engines. Parametrise this in the config. Perhaps a single default global templating engine, and then a per-report override.
• OpenAPI validation on requests and responses (optionally for reports)
• Streaming. The DB lib supports streaming, so does koa.
• Streams in the logger.
• Default values in query templates. This would be much better supported by using an existing, well-tested, proven templating engine and porting existing queries to said templating engine. (And perhaps phasing out support for the custom templates here). Also consider finding out whether Jaspersoft Studio uses an existing engine that we can replace our implementation with.