[OGUI-1785] Add and configure MariaDB and Vault for development purposes

[dwedr]

I have JIRA issue created

• branch and/or PR name(s) includes JIRA ID
• issue has "Fix version" assigned
• issue "Status" is set to "In review"
• PR labels are selected
• FLP integration tests were ran successful

This pull request introduces a MariaDB integration layer using the Sequelize ORM and Umzug migrations. It also adds HashiCorp Vault configuration for secure secret management and token signing. Both services are orchestrated through a new Docker Compose setup for the development environment.

[Copilot]

Pull request overview

This pull request introduces MariaDB database integration using Sequelize ORM and HashiCorp Vault for secure secret management in the Tokenization service. The changes add comprehensive database models, migrations, Docker orchestration for development environments, and a Vault setup script for managing secrets and token signing.

Key Changes:

• Database integration with MariaDB using Sequelize ORM with models for tokens and archived tokens
• HashiCorp Vault configuration for secure secret management and token signing
• Docker Compose setup for development environment with database and Vault services

Reviewed changes

Copilot reviewed 22 out of 24 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
docker-compose.dev.yml	New development environment configuration adding Vault and MariaDB services
docker-compose.yml	Updated to add database and vault-setup dependencies with duplicate port mappings
docker-compose.test.yml	Extended to include MariaDB service for testing
Dockerfile	Added Vault stage with version 1.20 (potentially non-existent version)
docker/vault/vault-setup.sh	Vault initialization and configuration script
docker/database/*	MariaDB configuration and initialization SQL scripts
backend/central-system/src/lib/database/*	Database layer implementation with Sequelize models and migrations
backend/central-system/src/modules/CentralSystem.ts	Integration of database instance
backend/central-system/src/lib/utils/Scheduler.ts	New scheduler utility for token archiving
backend/central-system/package.json	Added Sequelize, Umzug, MariaDB dependencies with duplicates
.gitignore	Extended to exclude certificates, keys, and database files

Files not reviewed (1)

• Tokenization/backend/central-system/package-lock.json: Language not supported

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The import statement references "SequalizeDatabase" (with typo) instead of the correct "SequelizeDatabase".

[Copilot]

[nitpick] Using any type for parameters reduces type safety. Consider defining proper TypeScript interfaces for the config parameter and return type of the models function.

Suggested change

	export function models(sequelize: any): any {
	const models = {
	import { Sequelize, Model } from 'sequelize';
	interface Models {
	Token: Model<any, any>;
	ArchiveToken: Model<any, any>;
	}
	export function models(sequelize: Sequelize): Models {
	const models: Models = {

[Copilot]

[nitpick] Using any type for the config parameter and return type reduces type safety. The config parameter should be typed as Partial<SequalizeDatabaseConfig> and the return type should be explicitly SequalizeDatabaseConfig.

Suggested change

	export function getConfig(config: any): SequalizeDatabaseConfig {
	export function getConfig(config: Partial<SequalizeDatabaseConfig>): SequalizeDatabaseConfig {

[Copilot]

Multiple duplicate dependencies detected in package.json:

• "@aliceo2/web-ui" appears on lines 22 and 24
• "crypto" appears on lines 23 and 25
• "@types/jest" appears on lines 37 and 38
• "concurrently" appears on lines 41 and 43
• "jest" appears on lines 42 and 44
• "supertest" appears on lines 46 and 48
• "ts-jest" appears on lines 47 and 49

These duplicates will cause issues during package installation.

[Copilot]

Typo in environment variable name: "DB_LOGGIN" should be "DB_LOGGING".

Suggested change

	logging: process.env.DB_LOGGIN ?? false,
	logging: process.env.DB_LOGGING ?? false,

[Copilot]

Typo in class name and logger name: "SequalizeDatabase" should be "SequelizeDatabase" (Sequelize with an 'i'). This affects multiple locations including the class name, file import, and logger configuration.

Suggested change

	import { SequalizeDatabaseConfig } from './utils/sequalizeDatabaseConfig.js';
	import { SequelizeStorage } from 'umzug';
	export class SequalizeDatabase {
	private _logger;
	public sequelize: Sequelize;
	private _models: object;
	private _dbConfig: SequalizeDatabaseConfig;
	/**
	* Initializes the Sequelize database connection.
	* @param config - Database configuration object.
	*/
	constructor(config: object) {
	this._logger = LogManager.getLogger('database/sequalize');
	import { SequelizeDatabaseConfig } from './utils/sequelizeDatabaseConfig.js';
	import { SequelizeStorage } from 'umzug';
	export class SequelizeDatabase {
	private _logger;
	public sequelize: Sequelize;
	private _models: object;
	private _dbConfig: SequelizeDatabaseConfig;
	/**
	* Initializes the Sequelize database connection.
	* @param config - Database configuration object.
	*/
	constructor(config: object) {
	this._logger = LogManager.getLogger('database/sequelize');

[Copilot]

Security concern: Hardcoded sensitive credentials. The root password 'cern' and user password 'cern' are hardcoded in the database initialization scripts. For production environments, these should be parameterized via environment variables.

Suggested change

	CREATE USER IF NOT EXISTS 'central-system'@'%' IDENTIFIED BY 'cern';
	-- Set the password for 'central-system' user via the CENTRAL_SYSTEM_PASSWORD variable.
	-- For example, before running this script, execute:
	-- SET @CENTRAL_SYSTEM_PASSWORD = 'your_password_here';
	-- Or use your container/orchestration system to inject the value.
	CREATE USER IF NOT EXISTS 'central-system'@'%' IDENTIFIED BY @CENTRAL_SYSTEM_PASSWORD;

[Copilot]

Duplicate entry detected. The fields "main" and "description" appear twice in package.json at lines 5-6 and 7-8.

Suggested change

	"main": "dist/index.js",
	"description": "A NodeJS backend for the token issuer within ALICE O2",

[Copilot]

Duplicate ports mapping detected. Ports 8080:8080 and 4041:4041 are mapped twice (lines 64-65 and 66-67).

Suggested change

	- '8080:8080'
	- '4041:4041'