Feat/testing

.gitignore

@@ -110,3 +110,6 @@ dist
 # Jest
 jest_html_reporters.html
 reports
+
+# for MacOS Developers
+.DS_Store

config/default.json

@@ -44,7 +44,7 @@
       "host": "localhost",
       "port": 5432,
       "username": "postgres",
-      "password": "test1234",
+      "password": "postgres",
       "enableSslAuth": false,
       "sslPaths": {
         "ca": "",

config/test.json

@@ -1 +1,32 @@
-{}
+{
+  "db": {
+    "elastic": {
+      "node": "http://localhost:9200",
+      "auth": {
+        "username": "elastic",
+        "password": "changeme"
+      },
+      "requestTimeout": 60000,
+      "properties": {
+        "controlIndex": "geocoder_control_tests",
+        "nlpIndex": "geocoder_control_tests",
+        "size": 3
+      }
+    },
+    "postgresql": {
+      "type": "postgres",
+      "host": "localhost",
+      "port": 5432,
+      "username": "postgres",
+      "password": "postgres",
+      "enableSslAuth": false,
+      "sslPaths": {
+        "ca": "",
+        "key": "",
+        "cert": ""
+      },
+      "database": "postgres",
+      "schema": "geocoder_test"
+    }
+  }
+}

dataSource.ts

@@ -0,0 +1,13 @@
+import config from 'config';
+import { DataSource } from 'typeorm';
+import { createConnectionOptions } from './src/common/postgresql';
+import { PostgresDbConfig } from './src/common/interfaces';
+
+const connectionOptions = config.get<PostgresDbConfig>('db.postgresql');
+
+export const appDataSource = new DataSource({
+  ...createConnectionOptions(connectionOptions),
+  entities: ['src/**/DAL/*.ts'],
+  migrationsTableName: 'migrations_table',
+  migrations: ['db/migrations/*.ts'],
+});

devScripts/elasticsearchData.json

@@ -0,0 +1,145 @@
+[
+  {
+    "_id": "CONTROL.ITEMS",
+    "_score": 1,
+    "_source": {
+      "type": "Feature",
+      "id": 27,
+      "geometry": {
+        "coordinates": [
+          [
+            [98.96871358832425, 18.77187541003238],
+            [98.96711613001014, 18.772012912146167],
+            [98.9668257091372, 18.77957500633211],
+            [98.96517988589727, 18.783516234000658],
+            [98.96305002071, 18.786174113473763],
+            [98.96222710028087, 18.786036643850125],
+            [98.9615009529004, 18.784478609414165],
+            [98.96096850521184, 18.78324114944766],
+            [98.96058105300438, 18.74932410944021],
+            [98.96029062202649, 18.747169677704846],
+            [98.9619364723165, 18.74666541646775],
+            [98.96479250629358, 18.7514784826093],
+            [98.96401797557468, 18.75193687161918],
+            [98.96614791571238, 18.754412116891245],
+            [98.96639000300826, 18.75940841151673],
+            [98.96779381973744, 18.759133392649602],
+            [98.96798745662056, 18.76018763174328],
+            [98.96789063809456, 18.761746062357858],
+            [98.96905242991687, 18.763487833908357],
+            [98.96871358832425, 18.77187541003238]
+          ]
+        ],
+        "type": "Polygon"
+      },
+      "properties": {
+        "OBJECTID": 27,
+        "F_CODE": 2300,
+        "F_ATT": 602,
+        "VIEW_SCALE_50K_CONTROL": 604,
+        "NAME": null,
+        "GFID": "{93C8C8E2-6AAB-4A84-BBF0-5B10E6F90938}",
+        "OBJECT_COMMAND_NAME": "4805",
+        "SUB_TILE_NAME": null,
+        "TILE_NAME": "DEF",
+        "TILE_ID": "36, 7300, 3560",
+        "SUB_TILE_ID": "36",
+        "SHAPE.AREA": 2.65,
+        "SHAPE.LEN": 0.0044192097656775,
+        "LAYER_NAME": "CONTROL.ITEMS",
+        "ENTITY_HEB": "airport",
+        "TYPE": "ITEM"
+      }
+    }
+  },
+  {
+    "_id": "CONTROL.SUB_TILES",
+    "_score": 1,
+    "_source": {
+      "type": "Feature",
+      "id": 13668,
+      "geometry": {
+        "coordinates": [
+          [
+            [27.149158174343427, 35.63159611670335],
+            [27.149274355343437, 35.64061707270338],
+            [27.138786228343463, 35.640716597703374],
+            [27.13867103934342, 35.631695606703374],
+            [27.149158174343427, 35.63159611670335]
+          ]
+        ],
+        "type": "Polygon"
+      },
+      "properties": {
+        "OBJECTID": 13668,
+        "SUB_TILE_ID": "65",
+        "TILE_NAME": "GRC",
+        "NAME": "somePlace",
+        "ZON": 35,
+        "LAYER_NAME": "CONTROL.SUB_TILES",
+        "TYPE": "SUB_TILE"
+      }
+    }
+  },
+  {
+    "_id": "CONTROL.ROUTES",
+    "_score": 1,
+    "_source": {
+      "type": "Feature",
+      "id": 2,
+      "geometry": {
+        "coordinates": [
+          [13.448493352142947, 52.31016611400918],
+          [13.447219581381603, 52.313370282889224],
+          [13.448088381125075, 52.31631514453963],
+          [13.450458681234068, 52.31867376333767],
+          [13.451112278530388, 52.32227665244022],
+          [13.449728938644029, 52.32463678850752],
+          [13.445021899434977, 52.32863442881066],
+          [13.444723882330948, 52.340023400115086],
+          [13.446229682887974, 52.34532799609971]
+        ],
+        "type": "LineString"
+      },
+      "properties": {
+        "OBJECTID": 2,
+        "OBJECT_COMMAND_NAME": "route96",
+        "FIRST_GFID": null,
+        "SHAPE_Length": 4.1,
+        "F_CODE": 8754,
+        "F_ATT": 951,
+        "LAYER_NAME": "CONTROL.ROUTES",
+        "ENTITY_HEB": "route96",
+        "TYPE": "ROUTE"
+      }
+    }
+  },
+  {
+    "_id": "CONTROL.TILES",
+    "_score": 1,
+    "_source": {
+      "type": "Feature",
+      "id": 52,
+      "geometry": {
+        "coordinates": [
+          [
+            [12.539507865186607, 41.851751203650096],
+            [12.536787075186538, 41.94185043165008],
+            [12.42879133518656, 41.93952837265009],
+            [12.431625055186686, 41.84943698365008],
+            [12.539507865186607, 41.851751203650096]
+          ]
+        ],
+        "type": "Polygon"
+      },
+      "properties": {
+        "OBJECTID": 52,
+        "ZONE": "37",
+        "TILE_NAME": "RIT",
+        "TILE_ID": null,
+        "LAYER_NAME": "CONTROL.TILES",
+        "TYPE": "TILE"
+      }
+    }
+  }
+]

devScripts/importDataToElastic.ts

@@ -0,0 +1,20 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+import { Client } from '@elastic/elasticsearch';
+import config from '../config/test.json';
+import data from './elasticsearchData.json';
+
+const main = async (): Promise<void> => {
+  const client = new Client({ node: config.db.elastic.node as string });
+
+  for (const item of data) {
+    await client.index({
+      index: config.db.elastic.properties.controlIndex as string,
+      id: item._id as string,
+      body: item._source,
+    });
+  }
+};
+
+export default main;

devScripts/importToPostgres.ts

@@ -0,0 +1,45 @@
+import { DataSource } from 'typeorm';
+import { createConnectionOptions } from '../src/common/postgresql';
+import config from '../config/test.json';
+import { PostgresDbConfig } from '../src/common/interfaces';
+
+export default async function createDatabaseClient(): Promise<void> {
+  const connectionOptions = config.db.postgresql as PostgresDbConfig;
+  const connection = new DataSource({
+    ...createConnectionOptions(connectionOptions),
+  });
+
+  await connection.initialize();
+
+  await connection.query(`
+        CREATE TABLE IF NOT EXISTS ${config.db.postgresql.schema}.tile_lat_lon
+        (
+            pk integer NOT NULL,
+            tile_name text COLLATE pg_catalog."default",
+            zone text COLLATE pg_catalog."default",
+            min_x text COLLATE pg_catalog."default",
+            min_y text COLLATE pg_catalog."default",
+            ext_min_x integer,
+            ext_min_y integer,
+            ext_max_x integer,
+            ext_max_y integer,
+            CONSTRAINT tile_lat_lon_pkey PRIMARY KEY (pk)
+        )
+    `);
+
+  await connection.query(`
+    INSERT INTO ${config.db.postgresql.schema}.tile_lat_lon(
+            pk, tile_name, zone, min_x, min_y, ext_min_x, ext_min_y, ext_max_x, ext_max_y)
+            VALUES (1, 'BRN', '33', '360000', '5820000', 360000, 5820000, 370000, 5830000);
+    `);
+
+  await connection.query(`
+    INSERT INTO ${config.db.postgresql.schema}.tile_lat_lon(
+        pk, tile_name, zone, min_x, min_y, ext_min_x, ext_min_y, ext_max_x, ext_max_y)
+        VALUES (2, 'BMN', '32', '480000', '5880000', 480000, 5880000, 490000, 5890000);
+    `);
+
+  console.log('PGSQL: Table created and data inserted');
+
+  await connection.destroy();
+}

devScripts/index.ts

@@ -0,0 +1,10 @@
+import importDataToElastic from './importDataToElastic';
+import importToPostgres from './importToPostgres';
+
+importDataToElastic()
+  .then(() => console.log('Success import data to elastic'))
+  .catch(console.error);
+
+importToPostgres()
+  .then(() => console.log('Success import data to postgres'))
+  .catch(console.error);

openapi3.yaml

@@ -95,7 +95,7 @@ paths:
           content:
             application/json:
               schema:
-                oneOf:
+                anyOf:
                   - $ref: "#/components/schemas/tilesSchema"
                   - $ref: "#/components/schemas/routesSchema"
                   - $ref: "#/components/schemas/itemsSchema"
@@ -226,7 +226,7 @@ paths:
           content:
             application/json:
               schema:
-                oneOf:
+                anyOf:
                   - $ref: "#/components/schemas/routesSchema"
                   - $ref: "#/components/schemas/itemsSchema"
         400:
@@ -396,7 +396,12 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/tilesSchema"
+                type: object
+                properties:
+                  lat:
+                    type: number
+                  lon:
+                    type: number
         400:
           "$ref": "#/components/responses/BadRequest"
         401:
@@ -499,6 +504,9 @@ components:
           items:
             type: "object"
             properties:
+              type:
+                type: "string"
+                enum: ["Feature"]
               geometry:
                 $ref: "#/components/schemas/Geometry"
               properties:

package.json

@@ -21,7 +21,12 @@
     "start:dev": "npm run build && cd dist && node --enable-source-maps ./index.js",
     "assets:copy": "copyfiles -f ./config/* ./dist/config && copyfiles -f ./openapi3.yaml ./dist/ && copyfiles ./package.json dist",
     "clean": "rimraf dist",
-    "install": "npx husky install"
+    "install": "npx husky install",
+    "dev:scripts": "npx ts-node ./devScripts/index.ts",
+    "typeorm": "node --require ts-node/register ./node_modules/typeorm/cli.js -d dataSource.ts",
+    "migration:create": "npm run typeorm migration:generate",
+    "migration:run": "npm run typeorm migration:run",
+    "migration:revert": "npm run typeorm migration:revert"
   },
   "directories": {
     "test": "tests"

src/common/interfaces.ts

@@ -1,5 +1,6 @@
 import { ClientOptions } from '@elastic/elasticsearch';
 import { DataSourceOptions } from 'typeorm';
+import { Feature, FeatureCollection as GeoJSONFeatureCollection } from 'geojson';
 
 export interface IConfig {
   get: <T>(setting: string) => T;
@@ -31,3 +32,7 @@ export interface Geometry {
   type: string;
   coordinates: number[][][];
 }
+
+export interface FeatureCollection<T extends Feature> extends GeoJSONFeatureCollection {
+  features: T[];
+}

src/common/utils.ts

@@ -6,27 +6,23 @@ import { Tile } from '../tile/models/tile';
 import { Route } from '../route/models/route';
 import { FIELDS } from './constants';
 import { utmProjection, wgs84Projection } from './projections';
+import { FeatureCollection } from './interfaces';
 
-export const formatResponse = <T extends Item | Tile | Route>(
-  elasticResponse: estypes.SearchResponse<T>
-): {
-  type: string;
-  features: (T | undefined)[];
-} => ({
+export const formatResponse = <T extends Item | Tile | Route>(elasticResponse: estypes.SearchResponse<T>): FeatureCollection<T> => ({
   type: 'FeatureCollection',
   features: [
-    ...elasticResponse.hits.hits.map((item) => {
+    ...(elasticResponse.hits.hits.map((item) => {
       const source = item._source;
-      if (source) {
+      if (source?.properties) {
         Object.keys(source.properties).forEach((key) => {
           // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-          if (source.properties[key as keyof typeof source.properties] == null) {
+          if (source.properties !== null && source.properties[key as keyof typeof source.properties] == null) {
             delete source.properties[key as keyof typeof source.properties];
           }
         });
       }
       return source;
-    }),
+    }) as T[]),
   ],
 });