Add end-to-end tests for email login/logout and global settings access control

- Implemented E2E tests for email login and logout functionality, covering both admin and regular user scenarios.
- Verified session management and cookie handling during login/logout processes.
- Added tests to ensure proper rejection of invalid login attempts.
- Created E2E tests for global settings access control, differentiating between admin and regular user permissions.
- Included tests for CRUD operations on settings, ensuring proper access control and response validation.
- Established global setup and teardown scripts for consistent test environment initialization and cleanup.
- Enhanced test context management for sharing state across tests.
- Updated TypeScript configuration to include test files and improve module resolution.
- Optimized router behavior to reduce unnecessary API calls during navigation.
- Improved user feedback in setup success messages.

Author: JasonKrik

.gitignore

@@ -56,6 +56,9 @@ fastly-events.log
 deploystack.db
 services/backend/persistent_data/*
 
+# Test files
+services/backend/tests/.test-context.json
+
 ._*.ts
 ._*.vue
 ._*.md

package-lock.json

@@ -9,11 +9,12 @@
     "dev:backend": "cd services/backend && npm run dev",
     "build:frontend": "cd services/frontend && npm run lint",
     "build:backend": "cd services/backend && npm run lint",
-    "lint:md": "npx markdownlint-cli2 '**/*.md' '#node_modules' '#**/node_modules/**' '#.github' '#**/CHANGELOG.md'",
+    "lint:md": "npx markdownlint-cli2 '**/*.md' '#node_modules' '#**/node_modules/**' '#.github' '#**/CHANGELOG.md' '#**/._*'",
     "lint:frontend": "cd services/frontend && npm run lint",
     "lint:backend": "cd services/backend && npm run lint",
     "release:backend": "cd services/backend && npm run release",
-    "release:frontend": "cd services/frontend && npm run release"    
+    "release:frontend": "cd services/frontend && npm run release",
+    "test:backend": "cd services/backend && npm run test"
   },
   "devDependencies": {
     "markdownlint-cli2": "^0.18.1"

package.json

@@ -47,7 +47,31 @@ The request body should be:
 
 Replace the `connectionString` with your actual PostgreSQL connection URI.
 
-**Important:** After the initial database setup via this API, you **must restart the backend server** for the changes to take full effect and for the application to connect to the newly configured database.
+**Note:** The database setup is now complete in a single API call. After successful setup, all database-dependent services (global settings, plugins, etc.) are automatically initialized and ready to use immediately. No server restart is required.
+
+#### API Response
+
+The setup endpoint returns a JSON response indicating the success status and whether a restart is required:
+
+**Successful Setup (No Restart Required):**
+
+```json
+{
+  "message": "Database setup successful. All services have been initialized and are ready to use.",
+  "restart_required": false
+}
+```
+
+**Successful Setup (Restart Required - Fallback):**
+
+```json
+{
+  "message": "Database setup successful, but some services may require a server restart to function properly.",
+  "restart_required": true
+}
+```
+
+In most cases, the setup will complete successfully without requiring a restart. The `restart_required: true` response is a fallback for edge cases where the automatic re-initialization fails.
 
 ### Database Configuration File
 
@@ -181,6 +205,19 @@ You can inspect the SQLite database directly using various tools:
 
 ## Troubleshooting
 
+### Database Setup Issues
+
+- **Setup fails with re-initialization error**: If the setup endpoint returns `restart_required: true`, you can manually restart the server to complete the setup process
+- **Database already configured**: If you get a 409 error, the database has already been set up. Use the status endpoint to check the current configuration
+- **Services not working after setup**: Check the server logs for any initialization errors. In rare cases, a manual restart may be needed
+
+### Migration Issues
+
 - If you get a "table already exists" error, check if you've already applied the migration
 - For complex schema changes, you may need to create multiple migrations
 - To reset the database, delete the `services/backend/persistent_data/database/deploystack.db` file and restart the server
+
+### Plugin Issues
+
+- **Plugins not working after setup**: Plugins with database extensions should automatically receive database access after setup. Check server logs for plugin re-initialization messages
+- **Plugin database tables missing**: Ensure plugins are properly loaded before database setup, or restart the server if tables are missing

services/backend/DB.md

@@ -15,8 +15,8 @@ ALTER TABLE `authUser` ADD `role_id` text REFERENCES roles(id);
 
 -- Insert default roles
 INSERT INTO `roles` (`id`, `name`, `description`, `permissions`, `is_system_role`, `created_at`, `updated_at`) VALUES 
-('global_admin', 'Global Administrator', 'Full system access with user management capabilities', '["users.list","users.view","users.edit","users.delete","users.create","roles.manage","system.admin"]', 1, strftime('%s', 'now') * 1000, strftime('%s', 'now') * 1000),
-('global_user', 'Global User', 'Standard user with basic profile access', '["profile.view","profile.edit"]', 1, strftime('%s', 'now') * 1000, strftime('%s', 'now') * 1000);
+('global_admin', 'Global Administrator', 'Full system access with user management capabilities', '["users.list","users.view","users.edit","users.delete","users.create","roles.manage","system.admin","settings.view","settings.edit","settings.delete","teams.create","teams.view","teams.edit","teams.delete","teams.manage","team.members.view","team.members.manage"]', 1, strftime('%s', 'now') * 1000, strftime('%s', 'now') * 1000),
+('global_user', 'Global User', 'Standard user with basic profile access', '["profile.view","profile.edit","teams.create","teams.view","teams.edit","teams.delete","team.members.view"]', 1, strftime('%s', 'now') * 1000, strftime('%s', 'now') * 1000);
 --> statement-breakpoint
 
 -- Update existing users to have global_user role (all users since role_id starts as NULL)

services/backend/drizzle/migrations_sqlite/0003_huge_prism.sql

@@ -0,0 +1,19 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/tests/**/*.test.ts'],
+  moduleNameMapper: {
+    '^@src/(.*)$': '<rootDir>/src/$1',
+  },
+  globalSetup: '<rootDir>/tests/globalSetup.ts',
+  globalTeardown: '<rootDir>/tests/globalTeardown.ts',
+  transform: {
+    '^.+\\.ts$': ['ts-jest', {
+      useESM: false,
+    }],
+  },
+  // Run tests sequentially to ensure proper order
+  maxWorkers: 1,
+  // Use custom test sequencer to ensure correct order
+  testSequencer: '<rootDir>/tests/testSequencer.js',
+};

services/backend/jest.config.js

@@ -8,7 +8,8 @@
     "lint": "eslint --config eslint.config.ts 'src/**/*.ts' --fix",
     "db:generate": "drizzle-kit generate",
     "db:up": "drizzle-kit up",
-    "release": "release-it --config=.release-it.js"
+    "release": "release-it --config=.release-it.js",
+    "test": "jest"
   },
   "dependencies": {
     "@fastify/cookie": "^11.0.2",
@@ -32,13 +33,24 @@
     "@eslint/js": "^9.27.0",
     "@release-it/conventional-changelog": "^10.0.1",
     "@types/better-sqlite3": "^7.6.13",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29.5.14",
+    "@types/supertest": "^6.0.3",
     "@typescript-eslint/eslint-plugin": "^8.33.0",
     "@typescript-eslint/parser": "^8.33.0",
     "drizzle-kit": "^0.31.1",
     "eslint": "^9.27.0",
+    "fs-extra": "^11.3.0",
+    "jest": "^29.7.0",
     "release-it": "^19.0.2",
+    "supertest": "^7.1.1",
+    "ts-jest": "^29.3.4",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.33.0"
+  },
+  "overrides": {
+    "glob": "^10.0.0",
+    "inflight": "npm:@isaacs/inflight@^1.0.6"
   }
 }

services/backend/package.json

@@ -7,6 +7,18 @@ import path from 'node:path';
 const CONFIG_DIR = path.join(__dirname, '..', '..', 'persistent_data');
 const CONFIG_FILE_PATH = path.join(CONFIG_DIR, 'db.selection.json');
 
+// Helper function to check if we're in test mode
+function isTestMode(): boolean {
+  return process.env.NODE_ENV === 'test';
+}
+
+// Helper function for conditional logging
+function logInfo(message: string): void {
+  if (!isTestMode()) {
+    console.log(message);
+  }
+}
+
 export interface SQLiteConfig {
   type: 'sqlite';
   dbPath: string; // Relative to services/backend directory
@@ -44,7 +56,7 @@ export async function saveDbConfig(config: DbConfig): Promise<void> {
     await fs.mkdir(CONFIG_DIR, { recursive: true }); // Ensure directory exists
     const data = JSON.stringify(config, null, 2);
     await fs.writeFile(CONFIG_FILE_PATH, data, 'utf-8');
-    console.log(`[INFO] Database configuration saved to ${CONFIG_FILE_PATH}`);
+    logInfo(`[INFO] Database configuration saved to ${CONFIG_FILE_PATH}`);
   } catch (error) {
     console.error('[ERROR] Failed to save database configuration:', error);
     throw error; // Re-throw to indicate failure
@@ -58,11 +70,11 @@ export async function saveDbConfig(config: DbConfig): Promise<void> {
 export async function deleteDbConfig(): Promise<void> {
   try {
     await fs.unlink(CONFIG_FILE_PATH);
-    console.log(`[INFO] Database configuration deleted from ${CONFIG_FILE_PATH}`);
+    logInfo(`[INFO] Database configuration deleted from ${CONFIG_FILE_PATH}`);
   } catch (error) {
     // @ts-expect-error - error.code
     if (error.code === 'ENOENT') {
-      console.log('[INFO] Database configuration file not found, nothing to delete.');
+      logInfo('[INFO] Database configuration file not found, nothing to delete.');
       return;
     }
     console.error('[ERROR] Failed to delete database configuration:', error);

services/backend/src/db/config.ts

@@ -29,6 +29,18 @@ let isDbConfigured = false;
 
 const MIGRATIONS_TABLE_NAME = '__drizzle_migrations';
 
+// Helper function to check if we're in test mode
+function isTestMode(): boolean {
+  return process.env.NODE_ENV === 'test';
+}
+
+// Helper function for conditional logging
+function logInfo(message: string): void {
+  if (!isTestMode()) {
+    console.log(message);
+  }
+}
+
 function getColumnBuilder(type: 'text' | 'integer' | 'timestamp') {
   if (type === 'text') return sqliteText;
   if (type === 'integer') return sqliteInteger;
@@ -89,11 +101,11 @@ async function applyMigrations() {
   try {
     await fs.access(migrationsPath);
   } catch {
-    console.log(`[INFO] Migrations directory not found at: ${migrationsPath}, skipping migrations.`);
+    logInfo(`[INFO] Migrations directory not found at: ${migrationsPath}, skipping migrations.`);
     return;
   }
 
-  console.log(`[INFO] Checking for new migrations in ${migrationsPath}...`);
+  logInfo(`[INFO] Checking for new migrations in ${migrationsPath}...`);
   await ensureMigrationsTable();
 
   let appliedMigrations: { name: string }[] = [];
@@ -108,7 +120,7 @@ async function applyMigrations() {
 
   for (const file of migrationFiles) {
     if (!appliedMigrationNames.includes(file)) {
-      console.log(`[INFO] Applying migration: ${file}`);
+      logInfo(`[INFO] Applying migration: ${file}`);
       const migrationFilePath = path.join(migrationsPath, file);
       const sqlContent = await fs.readFile(migrationFilePath, 'utf8');
       const statements = sqlContent.split('--> statement-breakpoint');
@@ -122,21 +134,21 @@ async function applyMigrations() {
         }
         sqliteConn.prepare(`INSERT INTO ${MIGRATIONS_TABLE_NAME} (migration_name) VALUES (?)`).run(file);
         sqliteConn.exec('COMMIT');
-        console.log(`[INFO] Applied migration: ${file}`);
+        logInfo(`[INFO] Applied migration: ${file}`);
       } catch (error) {
         const typedError = error as Error;
         console.error(`[ERROR] Failed to apply migration ${file}:`, typedError.message, typedError.stack);
         throw error;
       }
     } else {
-      console.log(`[INFO] Migration already applied: ${file}`);
+      logInfo(`[INFO] Migration already applied: ${file}`);
     }
   }
 }
 
 export async function initializeDatabase(): Promise<boolean> {
   if (isDbInitialized) {
-    console.log('[INFO] Database already initialized.');
+    logInfo('[INFO] Database already initialized.');
     return true;
   }
 
@@ -170,8 +182,8 @@ export async function initializeDatabase(): Promise<boolean> {
   const sqliteConn = new SqliteDriver(absoluteDbPath); // Use constructor
   dbConnection = sqliteConn;
   dbInstance = drizzleSqliteAdapter(sqliteConn, { schema: dbSchema, logger: false });
-  console.log(`[INFO] Connected to SQLite database at: ${absoluteDbPath}`);
-  if (!dbExists) console.log(`[INFO] SQLite database created at: ${absoluteDbPath}`);
+  logInfo(`[INFO] Connected to SQLite database at: ${absoluteDbPath}`);
+  if (!dbExists) logInfo(`[INFO] SQLite database created at: ${absoluteDbPath}`);
 
   if (dbInstance) { // Ensure dbInstance is not null
     await applyMigrations();
@@ -180,7 +192,7 @@ export async function initializeDatabase(): Promise<boolean> {
   }
 
   isDbInitialized = true;
-  console.log('[INFO] Database initialized successfully.');
+  logInfo('[INFO] Database initialized successfully.');
   return true;
 }
 
@@ -195,7 +207,7 @@ export async function setupNewDatabase(config: DbConfig): Promise<boolean> {
     await saveDbConfig(config);
     currentDbConfig = config; 
     isDbConfigured = true;
-    console.log(`[INFO] Database configuration saved: ${config.type}`);
+    logInfo(`[INFO] Database configuration saved: ${config.type}`);
   }
 
   isDbInitialized = false; 
@@ -251,15 +263,15 @@ export function getDbStatus() {
 // Function to force schema regeneration (useful for development)
 export function regenerateSchema(): void {
   if (currentDbConfig) {
-    console.log('[INFO] Forcing schema regeneration...');
+    logInfo('[INFO] Forcing schema regeneration...');
     dbSchema = generateSchema();
 
     // Recreate the database instance with new schema
     if (dbConnection) {
       dbInstance = drizzleSqliteAdapter(dbConnection as SqliteDriver.Database, { schema: dbSchema, logger: false });
     }
 
-    console.log('[INFO] Schema regenerated successfully.');
+    logInfo('[INFO] Schema regenerated successfully.');
   }
 }
 
@@ -286,7 +298,7 @@ export function registerPluginTables(plugins: Plugin[]) {
 }
 
 export async function createPluginTables(plugins: Plugin[]) { // db param not used
-  console.log('[INFO] Attempting to create plugin tables (Note: Better handled by migrations)...');
+  logInfo('[INFO] Attempting to create plugin tables (Note: Better handled by migrations)...');
   if (!currentDbConfig) {
       console.error("[ERROR] Cannot create plugin tables: DB config unknown.");
       return;
@@ -300,7 +312,7 @@ export async function createPluginTables(plugins: Plugin[]) { // db param not us
     for (const [defName] of Object.entries(ext.tableDefinitions)) {
       const fullTableName = `${plugin.meta.id}_${defName}`;
       if (dbSchema && dbSchema[fullTableName]) {
-        console.log(`[INFO] Table ${fullTableName} already defined in schema. Creation should be handled by migrations.`);
+        logInfo(`[INFO] Table ${fullTableName} already defined in schema. Creation should be handled by migrations.`);
       } else {
           console.warn(`[WARN] Table definition for ${fullTableName} not found in generated schema. Skipping creation.`);
       }
@@ -312,7 +324,7 @@ export async function initializePluginDatabases(db: AnyDatabase, plugins: Plugin
   for (const plugin of plugins) {
     const ext = plugin.databaseExtension as DatabaseExtensionWithTables | undefined; // Cast here
     if (ext?.onDatabaseInit) {
-      console.log(`[INFO] Initializing database for plugin: ${plugin.meta.id}`);
+      logInfo(`[INFO] Initializing database for plugin: ${plugin.meta.id}`);
       await ext.onDatabaseInit(db); // db is AnyDatabase, should be compatible
     }
   }

services/backend/src/db/index.ts

@@ -1,6 +1,8 @@
 import fs from 'fs';
 import path from 'path';
 import { GlobalSettingsService } from '../services/globalSettingsService';
+import { getDb, getSchema } from '../db';
+import { eq } from 'drizzle-orm';
 import type { 
   GlobalSettingsModule, 
   GlobalSettingDefinition, 
@@ -177,13 +179,18 @@ export class GlobalSettingsInitService {
    */
   private static async groupExists(groupId: string): Promise<boolean> {
     try {
-      const { getDb, getSchema } = await import('../db');
-      const { eq } = await import('drizzle-orm');
       const db = getDb();
       const schema = getSchema();
+      
+      // Check if database is available
+      if (!db) {
+        console.warn(`Database not available during group existence check for: ${groupId}`);
+        return false;
+      }
+      
       const globalSettingGroupsTable = schema.globalSettingGroups;
-
       if (!globalSettingGroupsTable) {
+        console.warn(`GlobalSettingGroups table not found in schema for group: ${groupId}`);
         return false;
       }
 
@@ -196,7 +203,7 @@ export class GlobalSettingsInitService {
 
       return results.length > 0;
     } catch (error) {
-      console.error(`Error checking if group exists: ${groupId}`, error);
+      console.warn(`Error checking if group exists: ${groupId}`, error instanceof Error ? error.message : 'Unknown error');
       return false;
     }
   }
@@ -206,11 +213,15 @@ export class GlobalSettingsInitService {
    */
   private static async createGroup(group: GlobalSettingGroup): Promise<void> {
     try {
-      const { getDb, getSchema } = await import('../db');
       const db = getDb();
       const schema = getSchema();
+      
+      // Check if database is available
+      if (!db) {
+        throw new Error(`Database not available during group creation for: ${group.id}`);
+      }
+      
       const globalSettingGroupsTable = schema.globalSettingGroups;
-
       if (!globalSettingGroupsTable) {
         throw new Error('GlobalSettingGroups table not found in schema');
       }