laogong5i0-2 / conforma-server

(完整的后台系统，含docker，数据库配置，自动化部署)Conforma application manager (IRIMS) back-end

Conforma — server

Install dependencies:
yarn install

Note: In order to install the expression-evaluator package, you'll need to authenticate with the Github package registry. See instructions for this here

Initialise database:
yarn database_init

Needs:

• psql command-line tool to be installed, and a super-user named postgres -- here for instructions.
  Creates a database named tmf_app_manager and populates it with minimal data.)
• need to have both graphile (with postgres user) and server running (easiest way is to do yarn dev_pg, see below)

To run in dev mode:
yarn dev

To launch Postgraphile server (in a new Terminal process):
yarn pg

To launch Postgraphile server as graphile_user (in a new Terminal process), this will enforce row level permissions:
yarn pg_permissions

To launch in dev mode with Postgraphile server:
yarn dev_pg

To launch in dev mode with Postgraphile server and graphile_user:
yarn dev_pg_permissions

To build (compiles all .ts files to .js in build folder):
yarn build

To build and run compiled files:
yarn start

In dev mode, uses nodemon to monitor changes, and ts-node to compile typescript files on the fly.

Note: Plugins (in ./plugins) are standalone packages and must be compiled individually. However, they should come pre-compiled and are copied to the build folder when building the server app.
To automatically re-compile all plugins:
yarn build_plugins.

This repo has the following functionality implemented in basic form:

• Fastify server with endpoints for:
  • File upload (and register in database)
  • File download (by database ID)
• Triggers and Actions, including:
  • Register plugins on startup
  • Run actions in response to Database triggers
  • Create scheduled actions (using node-schedule)
• evaluateExpression module

Development

• main branch - only has features which have been released (on a demo-tag)
• develop - to be used for development (to create a feature-branch before making a new PR) and selected as base for PRs

The organisation-team will transfer approved changes from develop into the main periodically once all new features are stable and tested.

Docker

To build image: cd Docker -> ./dockerise.sh (you can edit Docker/dockerise.sh to change build prefs)

To run image: cd Docker -> ./run.sh (you can edit Docker/run.sh to change run prefs)

See comments in above scripts and documentation folder for more details

Snapshots

Can take snapshot of current DB state via yarn take_snapshot, optional snapshot name can be provided as a parameter (defaults to current)

Load snapshot with yarn use_snapshot, optional snapshot name can be provided as a parameter (defaults to current)

Single file GraphQL mutation set of snapshotted data can be found in ./database/snapshot/{snapshot name}.graphql

See snapshot documentation for more details

Database migration

Whenever the server runs, the current version is compared against the version the database was last saved with, and runs migration code if necessary. However, in development, you may wish to ensure the database is migrated to the latest changes before a new version has been released -- to do this please run yarn migrate

See migration documentation for more details

Triggers and Actions

TODO: UPDATE

In order to see Triggers and Actions working, you'll need to run the createSchema.sql then insertData.sql scripts in the database folder.

The application with ID = 3 (Company registration: Company C) has one Action associated with it, the Console logger. All it does is write a message to the console, and you can see the details on the template_action table.

To cause a Trigger to initiate the Action, change the trigger field on the application:
UPDATE application SET trigger = 'ON_APPLICATION_SUBMIT' WHERE id = 3

You should see the message printed to the console.

Also, check the action_plugin table to see a couple of extra dummy plugins that automatically get registered on startup.

See Triggers and Actions documentation for in-depth explanation

evaluateExpression

Documented in the Query-Syntax.md in the documentation folder.

Code is in the modules folder.

To test (using Jest), must be running graphile as postgres user (i.e. yarn pg not yarn pg_permmissions) :
yarn test

Documentation

Developer documentation available in documentation folder -- intended for publication to this repo's wiki. See the documentation's own README for more information.

Link to documentation wiki