published-resource-producer v1.1.1

published-resource-producer

Producer service generating diff files to sync data about published resources to external applications. Diff files generated since a specific timestamp can be fetched by a consuming service

The service is based on another implementation which can be found here.

Tutorials

Add the service to a stack

Add the service to your docker-compose.yml:

  published-resource-producer:
    image: lblod/lblod/published-resource-producer
    volumes:
      - ./data/files:/share

The produced diff files will be written to a subfolder ./deltas of the mounted volume ./data/files.

Next, configure the delta-notifier in ./config/delta/rules.js to send delta messages for changes on the published resources:

export default [
  {
    match: {
      predicate: {
        type: 'uri',
        value: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type'
      },
      object: {
        type: 'uri',
        value: 'http://mu.semte.ch/vocabularies/ext/signing/PublishedResource'
      }
    },
    callback: {
      url: 'http://published-resource-producer/delta',
      method: 'POST'
    },
    options: {
      resourceFormat: 'v0.0.1',
      gracePeriod: 1000,
      ignoreFromSelf: true
    }
  },
  // Other delta listeners
];

Finally add the following dispatcher rules in ./config/dispatcher/dispatcher.ex to make the endpoint to list produced diff files available for the consuming service.

  get "/sync/published-resource/files/*path" do
    Proxy.forward conn, path, "http://published-resource-producer/files/"
  end

The service assumes a file service hosting the files mounted in /share is already available in the stack for the consumer to download the diff files.

Restart the updated services

docker-compose restart delta-notifier dispatcher

Create the newly added service

docker-compose up -d

Reference

Configuration

Environment variables

The following enviroment variables can be optionally configured:

• LOG_INCOMING_DELTA (default: "false"): log the delta message as received from the delta-notifier to the console.
• LOG_OUTGOING_DELTA (default: "false"): log the resulting delta message that will be written to the diff file to the console.
• LOG_DELTA_ENRICH (default: "false"): verbose log output during the enrich of the incoming delta to the resulting delta. Only useful for debugging purposes.
• RELATIVE_FILE_PATH (default: "deltas"): relative path of the delta files compared to the root folder of the file service that will host the files.
• FILE_GRAPH (default: "http://mu.semte.ch/application"): graph on which the file data should be saved in the database.

API

POST /delta

Endpoint that receives delta's from the delta-notifier. The delta's are enriched with all the data relative to the published resource. The resulting delta's are written to files that can be retrieved via the GET /files endpoint.

GET /files?since=

Get a list of diff files generated since the request timestamp. The list is ordered by creation date, oldest first. This is also the order in which the files must be consumed.

Example response:

{
  "data": [
    {
      "type": "files",
      "id": "3be63fd0-c030-11ea-a482-b30a6eeb477f",
      "attributes": {
        "name": "delta-2020-07-07T08:59:58.409Z.json",
        "created": "2020-07-07T08:59:58.413Z"
      }
    },
    {
      "type": "files",
      "id": "3fd04b40-c030-11ea-a482-b30a6eeb477f",
      "attributes": {
        "name": "delta-2020-07-07T09:00:04.977Z.json",
        "created": "2020-07-07T09:00:04.980Z"
      }
    }
  ]
}

File format

The generated delta files follow the delta-notifier v0.0.1 format.

Model

Diff files

The generated diff files are written to the store according to the model of the file service. The virtual file is enriched with the following properties: