Merge branch 'master' into better-doc

Author: MartinKolarik

.github/workflows/ci.yml

@@ -26,6 +26,23 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+
+      - name: Shutdown Ubuntu MySQL
+        run: sudo service mysql stop
+
+      - name: Setup MariaDB
+        uses: getong/mariadb-action@v1.1
+        with:
+          mariadb version: '10.11.5'
+          mysql user: 'directus'
+          mysql password: 'password'
+          mysql database: 'directus'
+
+      - name: Init MariaDB
+        run: |
+          sleep 5
+          mysql -u directus -ppassword --database=directus --protocol=tcp < config/init.sql
+
       - uses: actions/setup-node@v3
         with:
           node-version: 18.x

.mocharc.json

@@ -1,6 +1,6 @@
 {
 	"exit": true,
-	"timeout": 5000,
+	"timeout": 10000,
 	"check-leaks": true,
 	"file": [
 		"test/setup.ts"

CONTRIBUTING.md

@@ -10,16 +10,16 @@ Hi! We're really excited that you're interested in contributing! Before submitti
 
 ## Project setup
 
-In order to run the Globalping API locally you will need Node.js 18 and Redis with [RedisJSON](https://oss.redis.com/redisjson/) module (included in docker-compose.yml file). You will also need to run a development instance of the [Globalping Probe](https://github.com/jsdelivr/globalping-probe) at the same time when testing.
+In order to run the Globalping API locally you will need Node.js 18 and Redis with [RedisJSON](https://oss.redis.com/redisjson/) module and MariaDB. All of them are included in docker-compose.yml file. You will also need to run a development instance of the [Globalping Probe](https://github.com/jsdelivr/globalping-probe) at the same time when testing.
 
 The API uses 3000 port by default. This can be overridden by `PORT` environment variable.
 
 You can run the project by following these steps:
 
 1. Clone this repository.
-2. `docker-compose up -d` - Run Redis
+2. `docker-compose up -d` - Run Redis and MariaDB
 3. `npm install`
-4. Run `npm run dev`
+4. Run `npm run start:dev`
 
 Once the API is live, you can spin up a probe instance by running as described at https://github.com/jsdelivr/globalping-probe/blob/master/CONTRIBUTING.md.
 
@@ -40,5 +40,7 @@ Most IDEs have plugins integrating the used linter (eslint), including support f
 
 ### Environment variables
 
-- `NEW_RELIC_LICENSE_KEY={value}` environment variable should be used in production to send APM metrics to new relic
-- `NEW_RELIC_APP_NAME={value}` environment variable should be used in production to send APM mentrics to new relic
+- `NEW_RELIC_LICENSE_KEY={value}` used in production to send APM metrics to new relic
+- `NEW_RELIC_APP_NAME={value}` used in production to send APM mentrics to new relic
+- `NEW_RELIC_ENABLED=false` useid in development to disable newrelic monitoring
+- `FAKE_PROBE_IP={api|probe}` used in development to either use a random fake ip from the API or a fake ip from Probe

config/default.cjs

@@ -11,6 +11,10 @@ module.exports = {
 			tls: false,
 		},
 	},
+	db: {
+		type: 'mysql',
+		connection: 'mysql://directus:password@localhost:3306/directus',
+	},
 	admin: {
 		key: '',
 	},

config/init.sql

@@ -0,0 +1,15 @@
+CREATE DATABASE IF NOT EXISTS directus;
+USE directus;
+
+CREATE TABLE IF NOT EXISTS adopted_probes (
+  id INT(10) UNSIGNED AUTO_INCREMENT PRIMARY KEY,
+  user_created CHAR(36),
+  date_created TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+  user_updated CHAR(36),
+  date_updated TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+  userId VARCHAR(255) NOT NULL,
+  ip VARCHAR(255) NOT NULL,
+  uuid VARCHAR(255),
+  lastSyncDate DATE
+);
+INSERT IGNORE INTO adopted_probes (id, userId, ip) VALUES ('1', '6191378', '79.205.97.254');

docker-compose.yml

@@ -8,3 +8,14 @@ services:
     volumes:
       - ./config/redis.conf:/usr/local/etc/redis/redis.conf
     command: /usr/local/etc/redis/redis.conf
+
+  mariadb:
+    image: mariadb:10.11.5
+    environment:
+    - MARIADB_RANDOM_ROOT_PASSWORD=1
+    - MARIADB_USER=directus
+    - MARIADB_PASSWORD=password
+    ports:
+      - "3306:3306"
+    volumes:
+      - ./config/init.sql:/docker-entrypoint-initdb.d/init.sql

knexfile.js

@@ -0,0 +1,23 @@
+import _ from 'lodash';
+import config from 'config';
+
+const dbConfig = config.get('db');
+
+/**
+ * @typedef {import('knex').Knex.Config} KnexConfig
+ * @type {{ [key: string]: KnexConfig }}
+ */
+export default _.merge({}, ...[ 'development', 'production', 'staging', 'test' ].map((environment) => {
+	return {
+		[environment]: {
+			client: dbConfig.type,
+			connection: dbConfig.connection,
+			pool: {
+				min: 0,
+				max: 10,
+				propagateCreateError: false,
+			},
+			acquireConnectionTimeout: 10000,
+		},
+	};
+}));