@golemio/fcd 1.2.4 → 1.2.5-dev.1262829891

package/docs/implementation_documentation.md

@@ -0,0 +1,103 @@
+# Implementační dokumentace modulu *fcd*
+
+## Záměr
+
+modul slouzi k ukladaci a retenci FCD dat
+
+
+## Vstupní data
+
+### Data nám jsou posílána
+
+Mame vystavene 2 endpointy viz [openApi spec](./openapi-input.yaml)
+
+## Zpracování dat / transformace
+
+Vsechny tabulky jsou ve schematu `fcd`
+
+### *FCDWorker*
+
+Fcd modul ma jen jednoho workera ktery se stara o ukladani dat a retenci dat
+
+#### _task: RegionsDataRetentionTask_
+
+Vola proceduru `regions_data_retention` s parametrem 2880 -> tzn smaze data stare vice jak 2 dny
+
+- vstupní rabbitmq fronta
+  - nazev: dataplatform.fcd.regionsDataRetention
+  - parametry: zadne
+  - TTL: 59
+- (volitelně) závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - zadne
+- datové zdroje
+  - zadne
+- transformace
+  - zadne
+- (volitelně) obohacení dat
+  - zadne
+- data modely
+  - zadne
+
+
+#### _task: SaveFloatingCarDataTask_
+
+uklada data do tabulky `fcd_traff_params_part`
+
+- vstupní rabbitmq fronta
+  - nazev: dataplatform.fcd.saveFloatingCarData
+  - [parametry](./assets/schemas/floating_car_data_schema.xml)
+- (volitelně) závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - zadne
+- datové zdroje
+  - zadne
+- transformace
+  - [FloatingCarDataTransformation](../src/integration-engine//transformations/FloatingCarDataTransformation.ts)
+- (volitelně) obohacení dat
+  - zadne
+- data modely
+  - [FloatingCarDataRepository](../src/integration-engine/repositories/fcd/FloatingCarDataRepository.ts)
+
+
+#### _task: SaveRegionsDataTask_
+
+uklada data do tabulky `fcd_traff_params_regions`
+- vstupní rabbitmq fronta
+  - název: dataplatform.fcd.saveRegionsData
+  - [parametry](./assets/schemas/floating_car_data_schema.xml)
+- (volitelně) závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - zadne
+- datové zdroje
+  - zadne
+- transformace
+  - [FloatingCarDataTransformation](../src/integration-engine//transformations/FloatingCarDataTransformation.ts)
+- (volitelně) obohacení dat
+  - zadne
+- data modely
+  - [FloatingCarDataRegionsRepository](../src/integration-engine/repositories/fcd/FloatingCarDataRegionsRepository.ts)
+
+
+## Uložení dat
+
+-   typ databáze
+  -   PSQL
+-   databázové schéma
+    -   [fcd schema](./assets/db_schema.png)
+        -   `fcd_traff_params_part`: Obsahuje fcd data z Hlavního města Praha a Středočeského kraje. Historická data se zachovávají.
+        -   `fcd_traff_params_regions`: Obsahuje fcd data z krajů: Liberecký, Královehradecký, Pardubický, Vysočina, Jihočeský, Plzeňský, Karlovarský, Ústecký. Integrační engine pouští pravidelnou retenci dat(`regions_data_retention`).
+
+## Output API
+
+### Obecné
+
+- OpenAPI dokumentace
+  - [openapi-output](./openapi-output.yaml)
+- veřejné / neveřejné endpointy
+  - api je veřejné nebo neveřejné, případně seznam veřejných a neveřejných endpointů
+
+
+#### _/v2/fcd/info_
+
+- zdrojové tabulky
+  - je pouzit view `v_traffic_params_all` kde jste spojene tabulky `fcd_traff_params_regions` a `fcd_traff_params_part`
+  - pri zadosti o osmPath je pouzit view `v_traffic_params_all_with_osm_path`/`v_traffic_params_last_hour_osm_path` kde je pripojena tabulka `traffic.rsd_tmc_osm_mapping` pro ziskani `osm_path`
+- zobrazi data viz [openapi](./openapi-output.yaml)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/fcd",
-    "version": "1.2.4",
+    "version": "1.2.5-dev.1262829891",
     "description": "Golemio Floating Car Data Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -38,10 +38,10 @@
         "@commitlint/cli": "^11.0.0",
         "@commitlint/config-conventional": "^11.0.0",
         "@golemio/cli": "1.5.0",
-        "@golemio/core": "1.9.15",
+        "@golemio/core": "1.9.16",
         "@golemio/db-common": "1.1.3",
         "@golemio/eslint-config": "1.1.1",
-        "@golemio/traffic-common": "1.0.5",
+        "@golemio/traffic-common": "1.0.6",
         "@types/body-parser-xml": "^1.1.0",
         "@types/chai": "4.2.3",
         "@types/chai-as-promised": "7.1.2",

package/dist/integration-engine/FCDWorker.d.ts

@@ -1,13 +0,0 @@
-import { BaseWorker } from "@golemio/core/dist/integration-engine";
-export declare class FCDWorker extends BaseWorker {
-    private readonly queuePrefix;
-    private floatingCarDataTransformation;
-    private floatingCarDataModel;
-    private floatingCarDataRegionsModel;
-    private lteCze90PointsChecker;
-    private DATA_RETENTION_IN_MINUTES;
-    constructor();
-    saveFloatingCarData: (msg: any) => Promise<void>;
-    saveRegionsData: (msg: any) => Promise<void>;
-    regionsDataRetention: (msg: any) => Promise<void>;
-}

package/dist/integration-engine/FCDWorker.js

@@ -1,71 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FCDWorker = void 0;
-const FloatingCarDataTransformation_1 = require("./transformations/FloatingCarDataTransformation");
-const _sch_1 = require("../schema-definitions");
-const integration_engine_1 = require("@golemio/core/dist/integration-engine");
-const golemio_errors_1 = require("@golemio/core/dist/shared/golemio-errors");
-const golemio_validator_1 = require("@golemio/core/dist/shared/golemio-validator");
-const sequelize_1 = require("@golemio/core/dist/shared/sequelize");
-const LteCze90PointsChecker_1 = require("./helpers/LteCze90PointsChecker");
-class FCDWorker extends integration_engine_1.BaseWorker {
-    constructor() {
-        super();
-        this.DATA_RETENTION_IN_MINUTES = 2880; // 2 days
-        this.saveFloatingCarData = (msg) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const data = JSON.parse(msg.content.toString());
-                const transformedData = yield this.floatingCarDataTransformation.transform(data);
-                yield this.floatingCarDataModel.save(transformedData);
-            }
-            catch (error) {
-                throw new golemio_errors_1.GeneralError("Error while processing Floating Car Data data.", "FCDWorker", error, 422);
-            }
-        });
-        this.saveRegionsData = (msg) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const data = JSON.parse(msg.content.toString());
-                const transformedData = yield this.floatingCarDataTransformation.transform(data);
-                yield this.lteCze90PointsChecker.initialize();
-                const filteredData = transformedData.filter((element) => this.lteCze90PointsChecker.shouldSave(element.source_identification));
-                yield this.floatingCarDataRegionsModel.save(filteredData);
-            }
-            catch (error) {
-                throw new golemio_errors_1.GeneralError("Error while processing Floating Car Data for regions.", "FCDWorker", error, 422);
-            }
-        });
-        this.regionsDataRetention = (msg) => __awaiter(this, void 0, void 0, function* () {
-            const sequelize = integration_engine_1.PostgresConnector.getConnection();
-            yield sequelize.query(`CALL ${_sch_1.FCD.pgSchema}.regions_data_retention(${this.DATA_RETENTION_IN_MINUTES});`, {
-                plain: true,
-                type: sequelize_1.QueryTypes.SELECT,
-            });
-        });
-        this.queuePrefix = integration_engine_1.config.RABBIT_EXCHANGE_NAME + "." + _sch_1.FCD.name.toLowerCase();
-        this.floatingCarDataTransformation = new FloatingCarDataTransformation_1.FloatingCarDataTransformation();
-        this.floatingCarDataModel = new integration_engine_1.PostgresModel(_sch_1.FCD.fcd_info.name + "Model", {
-            outputSequelizeAttributes: _sch_1.FCD.fcd_info.outputSequelizeAttributes,
-            pgSchema: _sch_1.FCD.pgSchema,
-            pgTableName: _sch_1.FCD.fcd_info.pgTableName,
-            savingType: "insertOnly",
-        }, new golemio_validator_1.JSONSchemaValidator(_sch_1.FCD.fcd_info.name + "PgModelValidator", _sch_1.FCD.fcd_info.outputSchema));
-        this.floatingCarDataRegionsModel = new integration_engine_1.PostgresModel(_sch_1.FCD.fcd_info.name + "Model", {
-            outputSequelizeAttributes: _sch_1.FCD.fcd_info.outputSequelizeAttributes,
-            pgSchema: _sch_1.FCD.pgSchema,
-            pgTableName: "fcd_traff_params_regions",
-            savingType: "insertOnly",
-        }, new golemio_validator_1.JSONSchemaValidator(_sch_1.FCD.fcd_info.name + "PgModelValidator", _sch_1.FCD.fcd_info.outputSchema));
-        this.lteCze90PointsChecker = new LteCze90PointsChecker_1.LteCze90PointsChecker();
-    }
-}
-exports.FCDWorker = FCDWorker;
-//# sourceMappingURL=FCDWorker.js.map

package/dist/integration-engine/FCDWorker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FCDWorker.js","sourceRoot":"","sources":["../../src/integration-engine/FCDWorker.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mGAAkG;AAClG,gDAA2B;AAC3B,8EAA6G;AAC7G,6EAAwE;AACxE,mFAAkF;AAClF,mEAAiE;AACjE,2EAAwE;AAExE,MAAa,SAAU,SAAQ,+BAAU;IASrC;QACI,KAAK,EAAE,CAAC;QAHJ,8BAAyB,GAAG,IAAI,CAAC,CAAC,SAAS;QA+B5C,wBAAmB,GAAG,CAAO,GAAQ,EAAiB,EAAE;YAC3D,IAAI;gBACA,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAChD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;aACzD;YAAC,OAAO,KAAK,EAAE;gBACZ,MAAM,IAAI,6BAAY,CAAC,gDAAgD,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;aACrG;QACL,CAAC,CAAA,CAAC;QAEK,oBAAe,GAAG,CAAO,GAAQ,EAAiB,EAAE;YACvD,IAAI;gBACA,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAChD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,CAAC;gBAC9C,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CACpD,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,OAAO,CAAC,qBAAqB,CAAC,CACvE,CAAC;gBAEF,MAAM,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7D;YAAC,OAAO,KAAK,EAAE;gBACZ,MAAM,IAAI,6BAAY,CAAC,uDAAuD,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;aAC5G;QACL,CAAC,CAAA,CAAC;QAEK,yBAAoB,GAAG,CAAO,GAAQ,EAAiB,EAAE;YAC5D,MAAM,SAAS,GAAG,sCAAiB,CAAC,aAAa,EAAE,CAAC;YACpD,MAAM,SAAS,CAAC,KAAK,CAAC,QAAQ,UAAG,CAAC,QAAQ,2BAA2B,IAAI,CAAC,yBAAyB,IAAI,EAAE;gBACrG,KAAK,EAAE,IAAI;gBACX,IAAI,EAAE,sBAAU,CAAC,MAAM;aAC1B,CAAC,CAAC;QACP,CAAC,CAAA,CAAC;QAzDE,IAAI,CAAC,WAAW,GAAG,2BAAM,CAAC,oBAAoB,GAAG,GAAG,GAAG,UAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAE9E,IAAI,CAAC,6BAA6B,GAAG,IAAI,6DAA6B,EAAE,CAAC;QACzE,IAAI,CAAC,oBAAoB,GAAG,IAAI,kCAAa,CACzC,UAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,OAAO,EAC3B;YACI,yBAAyB,EAAE,UAAG,CAAC,QAAQ,CAAC,yBAAyB;YACjE,QAAQ,EAAE,UAAG,CAAC,QAAQ;YACtB,WAAW,EAAE,UAAG,CAAC,QAAQ,CAAC,WAAW;YACrC,UAAU,EAAE,YAAY;SAC3B,EACD,IAAI,uCAAmB,CAAC,UAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,kBAAkB,EAAE,UAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAC7F,CAAC;QACF,IAAI,CAAC,2BAA2B,GAAG,IAAI,kCAAa,CAChD,UAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,OAAO,EAC3B;YACI,yBAAyB,EAAE,UAAG,CAAC,QAAQ,CAAC,yBAAyB;YACjE,QAAQ,EAAE,UAAG,CAAC,QAAQ;YACtB,WAAW,EAAE,0BAA0B;YACvC,UAAU,EAAE,YAAY;SAC3B,EACD,IAAI,uCAAmB,CAAC,UAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,kBAAkB,EAAE,UAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,CAC7F,CAAC;QACF,IAAI,CAAC,qBAAqB,GAAG,IAAI,6CAAqB,EAAE,CAAC;IAC7D,CAAC;CAkCJ;AAtED,8BAsEC"}

package/dist/integration-engine/queueDefinitions.d.ts

@@ -1,3 +0,0 @@
-import { IQueueDefinition } from "@golemio/core/dist/integration-engine";
-declare const queueDefinitions: IQueueDefinition[];
-export { queueDefinitions };

package/dist/integration-engine/queueDefinitions.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.queueDefinitions = void 0;
-const integration_engine_1 = require("@golemio/core/dist/integration-engine");
-const _sch_1 = require("../schema-definitions");
-const FCDWorker_1 = require("./FCDWorker");
-const queueDefinitions = [
-    {
-        name: _sch_1.FCD.name,
-        queuePrefix: integration_engine_1.config.RABBIT_EXCHANGE_NAME + "." + _sch_1.FCD.name.toLowerCase(),
-        queues: [
-            {
-                name: "saveFloatingCarData",
-                options: {
-                    deadLetterExchange: integration_engine_1.config.RABBIT_EXCHANGE_NAME,
-                    deadLetterRoutingKey: "dead",
-                    messageTtl: 59 * 60 * 1000, // 59 minutes
-                },
-                worker: FCDWorker_1.FCDWorker,
-                workerMethod: "saveFloatingCarData",
-            },
-            {
-                name: "saveRegionsData",
-                options: {
-                    deadLetterExchange: integration_engine_1.config.RABBIT_EXCHANGE_NAME,
-                    deadLetterRoutingKey: "dead",
-                    messageTtl: 59 * 60 * 1000, // 59 minutes
-                },
-                worker: FCDWorker_1.FCDWorker,
-                workerMethod: "saveRegionsData",
-            },
-            {
-                name: "regionsDataRetention",
-                options: {
-                    deadLetterExchange: integration_engine_1.config.RABBIT_EXCHANGE_NAME,
-                    deadLetterRoutingKey: "dead",
-                    messageTtl: 59 * 60 * 1000, // 59 minutes
-                },
-                worker: FCDWorker_1.FCDWorker,
-                workerMethod: "regionsDataRetention",
-            },
-        ],
-    },
-];
-exports.queueDefinitions = queueDefinitions;
-//# sourceMappingURL=queueDefinitions.js.map

package/dist/integration-engine/queueDefinitions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"queueDefinitions.js","sourceRoot":"","sources":["../../src/integration-engine/queueDefinitions.ts"],"names":[],"mappings":";;;AAAA,8EAAiF;AACjF,gDAA2B;AAC3B,2CAA0C;AAE1C,MAAM,gBAAgB,GAAuB;IACzC;QACI,IAAI,EAAE,UAAG,CAAC,IAAI;QACd,WAAW,EAAE,2BAAM,CAAC,oBAAoB,GAAG,GAAG,GAAG,UAAG,CAAC,IAAI,CAAC,WAAW,EAAE;QACvE,MAAM,EAAE;YACJ;gBACI,IAAI,EAAE,qBAAqB;gBAC3B,OAAO,EAAE;oBACL,kBAAkB,EAAE,2BAAM,CAAC,oBAAoB;oBAC/C,oBAAoB,EAAE,MAAM;oBAC5B,UAAU,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,aAAa;iBAC5C;gBACD,MAAM,EAAE,qBAAS;gBACjB,YAAY,EAAE,qBAAqB;aACtC;YACD;gBACI,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE;oBACL,kBAAkB,EAAE,2BAAM,CAAC,oBAAoB;oBAC/C,oBAAoB,EAAE,MAAM;oBAC5B,UAAU,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,aAAa;iBAC5C;gBACD,MAAM,EAAE,qBAAS;gBACjB,YAAY,EAAE,iBAAiB;aAClC;YACD;gBACI,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE;oBACL,kBAAkB,EAAE,2BAAM,CAAC,oBAAoB;oBAC/C,oBAAoB,EAAE,MAAM;oBAC5B,UAAU,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,aAAa;iBAC5C;gBACD,MAAM,EAAE,qBAAS;gBACjB,YAAY,EAAE,sBAAsB;aACvC;SACJ;KACJ;CACJ,CAAC;AAEO,4CAAgB"}

package/dist/integration-engine/transformations/FloatingCarDataInterface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FloatingCarDataInterface.js","sourceRoot":"","sources":["../../../src/integration-engine/transformations/FloatingCarDataInterface.ts"],"names":[],"mappings":""}

package/dist/output-gateway/transformations/getLocationPointsFromTsString.d.ts

@@ -1,2 +0,0 @@
-import { LocationConfigOptions } from "@golemio/traffic-common/dist/output-gateway";
-export declare function getLocationPointsFromTsString(location: string): LocationConfigOptions;

package/dist/output-gateway/transformations/getLocationPointsFromTsString.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocationPointsFromTsString = void 0;
-const golemio_errors_1 = require("@golemio/core/dist/shared/golemio-errors");
-function getLocationPointsFromTsString(location) {
-    const regex = /((?<=TS)(.*?)(?=T))|((?<=\dT)(.*?)(?=$))/g;
-    const pointsArr = location.match(regex);
-    if ((pointsArr === null || pointsArr === void 0 ? void 0 : pointsArr.length) == 2 && pointsArr[0] && pointsArr[1]) {
-        return {
-            ltStart: Number(pointsArr[0]),
-            ltEnd: Number(pointsArr[1]),
-        };
-    }
-    else {
-        throw new golemio_errors_1.GeneralError("Unable to parse RsdTmcOsmMappingModelOptions from the location", "FCDRouter", location, 500);
-    }
-}
-exports.getLocationPointsFromTsString = getLocationPointsFromTsString;
-//# sourceMappingURL=getLocationPointsFromTsString.js.map

package/dist/output-gateway/transformations/getLocationPointsFromTsString.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getLocationPointsFromTsString.js","sourceRoot":"","sources":["../../../src/output-gateway/transformations/getLocationPointsFromTsString.ts"],"names":[],"mappings":";;;AAAA,6EAAwE;AAGxE,SAAgB,6BAA6B,CAAC,QAAgB;IAC1D,MAAM,KAAK,GAAG,2CAA2C,CAAC;IAC1D,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,KAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE;QACxD,OAAO;YACH,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC9B,CAAC;KACL;SAAM;QACH,MAAM,IAAI,6BAAY,CAAC,gEAAgE,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;KACxH;AACL,CAAC;AAXD,sEAWC"}