@golemio/rush-hour-aggregation 1.0.0 → 1.0.1

package/README.md

@@ -1,47 +1,87 @@
-[![pipeline status](https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregator/module/badges/master/pipeline.svg)](https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregator/module/commits/master)
-[![coverage report](https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregator/module/badges/master/coverage.svg)](https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregator/module/commits/master)
+<div align="center">
+<p>
+    <a href="https://operatorict.cz">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/core/-/raw/development/.assets/oict_logo.png" alt="oict" width="100px" height="100px" />
+    </a>
+    <a href="https://golemio.cz">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/core/-/raw/development/.assets/golemio_logo.png" alt="golemio" width="100px" height="100px" />
+    </a>
+</p>
+
+<h1>@golemio/rush-hour-aggregation</h1>
+
+<p>
+    <a href="https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregation/commits/master">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregation/badges/master/pipeline.svg" alt="pipeline">
+    </a>
+    <a href="https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregation/commits/master">
+        <img src="https://gitlab.com/operator-ict/golemio/code/modules/rush-hour-aggregation/badges/master/coverage.svg" alt="coverage">
+    </a>
+    <a href="./LICENSE">
+        <img src="https://img.shields.io/npm/l/@golemio/rush-hour-aggregation" alt="license">
+    </a>
+</p>
+
+<p>
+    <a href="#installation">Installation</a> · <a href="./docs">Documentation</a> · <a href="https://operator-ict.gitlab.io/golemio/code/modules/rush-hour-aggregation">TypeDoc</a>
+</p>
+</div>
+
+This module is intended for use with Golemio services. Refer [here](https://gitlab.com/operator-ict/golemio/code/modules/core/-/blob/development/README.md) for further information on usage, local development and more.
+
+## Installation
+
+The APIs may be unstable. Therefore, we recommend to install this module as an exact version.
+
+```bash
+# Latest version
+yarn add --exact @golemio/rush-hour-aggregation@latest
+
+# Development version
+yarn add --exact @golemio/rush-hour-aggregation@dev
+```
 
-# @golemio/rush-hour-aggregation
+## Description
 
-The module aggregates traffic data for Praha Zasekana project. It takes different traffic dataset avaiable in a golemio dataplatform and creates time series data for traffic jams, incidents or reconstructions.
+This module aggregates traffic data for Praha Zasekana project. It takes different traffic dataset avaiable in a golemio dataplatform and creates time series data for traffic jams, incidents or reconstructions.
 
-[Rabin Praha Zasekana](https://praha-zasekana-backend.rabin.golemio.cz/app)
+[Rabin Praha Zasekana](https://praha-zasekana-backend.rabin.golemio.cz/app)  
 [Backend repo Praha Zasekana](https://gitlab.com/operator-ict/golemio/code/praha-zasekana)
 
-Developed by http://operatorict.cz
+## Datasources
 
-# Datasources
-- Waze
-- SDDŘ
-- FCD
-- NDIC
+-   Waze
+-   SDDŘ
+-   FCD
+-   NDIC
 
-# Current setup
+## Current setup
 
 Every 5 minutes worker starts and for each of the datasource aggregation is run and timeseries data are updated.
 
-# Aggregation of older data
+## Aggregation of older data
 
 It is possible to insert or update historic data by creation of manual message in RabbitMQ.
 E.g. to insert data for Fcd for first month in 2022 use following message:
 
 ```json
 {
-"from":"2020-01-01T00:00:00Z",
-"to":"2020-01-31T23:59:59Z",
-"type":"fcd"
+    "from": "2020-01-01T00:00:00Z",
+    "to": "2020-01-31T23:59:59Z",
+    "type": "fcd"
 }
 ```
 
-# Message building blocks
+## Message building blocks
+
 Message has to be in json format and supports following fields:
 
-*from* - Required date time setting when the aggregation has to start. It is formatted in ISO 8601 preferably UTC format with Z at the end
+_from_ - Required date time setting when the aggregation has to start. It is formatted in ISO 8601 preferably UTC format with Z at the end
 
-*to* - Required date time setting when the aggregation has is ending. It is formatted in ISO 8601 preferably UTC format with Z at the end
+_to_ - Required date time setting when the aggregation has is ending. It is formatted in ISO 8601 preferably UTC format with Z at the end
 
-*type* - Required setting which aggregation should be run. Possible values: WAZEJ, WAZER, SDDR, FCD, NDIC. (Case insensitive)
+_type_ - Required setting which aggregation should be run. Possible values: WAZEJ, WAZER, SDDR, FCD, NDIC. (Case insensitive)
 
-*updateOnDuplicate* - Optional setting for situation when upgrade of already aggregated data is required. Possible values "true", "false". Default value is false. (Note: automatic 5 minute updates have the setting to true)
+_updateOnDuplicate_ - Optional setting for situation when upgrade of already aggregated data is required. Possible values "true", "false". Default value is false. (Note: automatic 5 minute updates have the setting to true)
 
 To initiate automatic 5 minute aggregation manually it is possible to send empty message.

package/db/migrations/postgresql/20220505053742-addMaterialViews.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var dbm;
+var type;
+var seed;
+var fs = require('fs');
+var path = require('path');
+var Promise;
+
+/**
+  * We receive the dbmigrate dependency from dbmigrate initially.
+  * This enables us to not have to rely on NODE_PATH.
+  */
+exports.setup = function(options, seedLink) {
+  dbm = options.dbmigrate;
+  type = dbm.dataType;
+  seed = seedLink;
+  Promise = options.Promise;
+};
+
+exports.up = function(db) {
+  var filePath = path.join(__dirname, 'sqls', '20220505053742-addMaterialViews-up.sql');
+  return new Promise( function( resolve, reject ) {
+    fs.readFile(filePath, {encoding: 'utf-8'}, function(err,data){
+      if (err) return reject(err);
+      console.log('received data: ' + data);
+
+      resolve(data);
+    });
+  })
+  .then(function(data) {
+    return db.runSql(data);
+  });
+};
+
+exports.down = function(db) {
+  var filePath = path.join(__dirname, 'sqls', '20220505053742-addMaterialViews-down.sql');
+  return new Promise( function( resolve, reject ) {
+    fs.readFile(filePath, {encoding: 'utf-8'}, function(err,data){
+      if (err) return reject(err);
+      console.log('received data: ' + data);
+
+      resolve(data);
+    });
+  })
+  .then(function(data) {
+    return db.runSql(data);
+  });
+};
+
+exports._meta = {
+  "version": 1
+};

package/db/migrations/postgresql/sqls/20220505053742-addMaterialViews-down.sql

@@ -0,0 +1,10 @@
+DROP MATERIALIZED VIEW IF EXISTS waze_reconstructions_snapshots_history;
+DROP MATERIALIZED VIEW IF EXISTS waze_reconstructions_snapshots_latest;
+DROP MATERIALIZED VIEW IF EXISTS waze_jams_snapshots_history;
+DROP MATERIALIZED VIEW IF EXISTS waze_jams_snapshots_latest;
+DROP MATERIALIZED VIEW IF EXISTS tsk_std_last_30min_snapshots_history;
+DROP MATERIALIZED VIEW IF EXISTS tsk_std_last_30min_snapshots_latest;
+DROP MATERIALIZED VIEW IF EXISTS ndic_events_full_snapshots_history;
+DROP MATERIALIZED VIEW IF EXISTS ndic_events_full_snapshots_latest;
+DROP MATERIALIZED VIEW IF EXISTS fcd_events_snapshots_history;
+DROP MATERIALIZED VIEW IF EXISTS fcd_events_snapshots_latest;