[feature]: Refactor common-db and common logic (#2772)

* on windows setup first replace the root controller.js with the current content

- to allow ESM and avoid additional fixer run

* added todo

* swapped the logic of common packages

- common-db is now the package for the database packages
- common is now the general package

* fix the exports

* refactor zipFiles

* fix import

* move constants to non-db package to allow subpath export

* more refactoring

* next fix

* next fix

* more fixes

* more fixes

* fix

* more refactor and added example to for types usage

* also allow console to be passed as logger

* fix import

* adapter-core to latest as peerDep

* rm peer should be fine now without

* lint

Author: foxriver76

package-lock.json

@@ -3,13 +3,19 @@ import fs from 'fs-extra';
 import os from 'node:os';
 import jwt from 'jsonwebtoken';
 import { EventEmitter } from 'node:events';
-import { tools, EXIT_CODES, password, logger } from '@iobroker/js-controller-common';
 import pidUsage from 'pidusage';
 import deepClone from 'deep-clone';
 import { PluginHandler } from '@iobroker/plugin-base';
 import semver from 'semver';
 import path from 'node:path';
-import { getObjectsConstructor, getStatesConstructor } from '@iobroker/js-controller-common-db';
+import {
+    getObjectsConstructor,
+    getStatesConstructor,
+    tools,
+    EXIT_CODES,
+    password,
+    logger
+} from '@iobroker/js-controller-common';
 import {
     decryptArray,
     encryptArray,
@@ -127,7 +133,7 @@ import type {
     InternalStopParameters
 } from '@/lib/_Types.js';
 import { UserInterfaceMessagingController } from '@/lib/adapter/userInterfaceMessagingController.js';
-import { SYSTEM_ADAPTER_PREFIX } from '@iobroker/js-controller-common/constants';
+import { SYSTEM_ADAPTER_PREFIX } from '@iobroker/js-controller-common-db/constants';
 import type { CommandResult } from '@alcalzone/pak';
 
 import * as url from 'node:url';
@@ -847,8 +853,8 @@ export class AdapterClass extends EventEmitter {
             this._options.compactInstance !== undefined
                 ? this._options.compactInstance
                 : this._options.instance !== undefined
-                ? this._options.instance
-                : this._config.instance || 0,
+                  ? this._options.instance
+                  : this._config.instance || 0,
             10
         );
 
@@ -2270,27 +2276,24 @@ export class AdapterClass extends EventEmitter {
 
             // Even if the developer forgets to call the unload callback, we need to stop the process.
             // Therefore, wait a short while and then force the unload procedure
-            setTimeout(
-                () => {
-                    if (this.#states) {
-                        finishUnload();
+            setTimeout(() => {
+                if (this.#states) {
+                    finishUnload();
 
-                        // Give 1 second to write the value
-                        setTimeout(() => {
-                            if (!isPause) {
-                                this._logger.info(`${this.namespaceLog} terminating with timeout`);
-                            }
-                            this.terminate(exitCode);
-                        }, 1_000);
-                    } else {
+                    // Give 1 second to write the value
+                    setTimeout(() => {
                         if (!isPause) {
-                            this._logger.info(`${this.namespaceLog} terminating`);
+                            this._logger.info(`${this.namespaceLog} terminating with timeout`);
                         }
                         this.terminate(exitCode);
+                    }, 1_000);
+                } else {
+                    if (!isPause) {
+                        this._logger.info(`${this.namespaceLog} terminating`);
                     }
-                },
-                this.common?.stopTimeout || 500
-            );
+                    this.terminate(exitCode);
+                }
+            }, this.common?.stopTimeout || 500);
         }
     }
 
@@ -7004,8 +7007,8 @@ export class AdapterClass extends EventEmitter {
                 ? this.isFloatComma === undefined
                     ? '.,'
                     : this.isFloatComma
-                    ? '.,'
-                    : ',.'
+                      ? '.,'
+                      : ',.'
                 : _format;
 
         if (typeof value !== 'number') {
@@ -11612,8 +11615,8 @@ export class AdapterClass extends EventEmitter {
                 this.version = this.pack?.version
                     ? this.pack.version
                     : this.ioPack?.common
-                    ? this.ioPack.common.version
-                    : 'unknown';
+                      ? this.ioPack.common.version
+                      : 'unknown';
                 // display if it's a non-official version - only if installedFrom is explicitly given and differs it's not npm
                 const isNpmVersion =
                     !this.ioPack ||

packages/adapter/src/lib/adapter/adapter.ts

@@ -5,7 +5,7 @@ import {
     decrypt,
     appNameLowerCase,
     getRootDir
-} from '@iobroker/js-controller-common/tools';
+} from '@iobroker/js-controller-common-db/tools';
 import { SUPPORTED_FEATURES, type SupportedFeature } from '@/lib/adapter/constants.js';
 import path from 'node:path';
 import fs from 'fs-extra';

packages/adapter/src/lib/adapter/utils.ts

@@ -5,7 +5,11 @@ import { spawn } from 'node:child_process';
 import deepClone from 'deep-clone';
 import { setTimeout as wait } from 'node:timers/promises';
 
-import { isLocalStatesDbServer, isLocalObjectsDbServer } from '@iobroker/js-controller-common-db';
+import {
+    isLocalStatesDbServer,
+    isLocalObjectsDbServer,
+    getInstancesOrderedByStartPrio
+} from '@iobroker/js-controller-common';
 import { tools, EXIT_CODES } from '@iobroker/js-controller-common';
 import * as CLI from '@/lib/cli/messages.js';
 import { CLICommand } from '@/lib/cli/cliCommand.js';
@@ -94,7 +98,7 @@ export class CLIProcess extends CLICommand {
         dbConnect(async params => {
             const { objects } = params;
             // Enumerate all adapter instances
-            const instances = await tools.getInstancesOrderedByStartPrio(objects, console);
+            const instances = await getInstancesOrderedByStartPrio(objects, console);
             // Create a promise for each. setInstanceEnabled only starts/stops when necessary
             const instancePromises = instances
                 .filter(obj => obj.common.enabled !== enabled)

packages/cli/src/lib/cli/cliProcess.ts

@@ -4,7 +4,7 @@ import { EXIT_CODES } from '@iobroker/js-controller-common';
 import deepClone from 'deep-clone';
 import { isDeepStrictEqual } from 'node:util';
 import Debug from 'debug';
-import { objectsDbHasServer, isLocalObjectsDbServer, isLocalStatesDbServer } from '@iobroker/js-controller-common-db';
+import { objectsDbHasServer, isLocalObjectsDbServer, isLocalStatesDbServer } from '@iobroker/js-controller-common';
 import path from 'node:path';
 import yargs from 'yargs/yargs';
 import * as CLITools from '@/lib/cli/cliTools.js';
@@ -735,7 +735,7 @@ async function processCommand(
                         }
 
                         if (migrated) {
-                            const { NotificationHandler } = await import('@iobroker/js-controller-common-db');
+                            const { NotificationHandler } = await import('@iobroker/js-controller-common');
 
                             const hostname = tools.getHostName();
 

packages/cli/src/lib/setup.ts

@@ -5,7 +5,7 @@ import {
     getStatesConstructor,
     objectsDbHasServer,
     statesDbHasServer
-} from '@iobroker/js-controller-common-db';
+} from '@iobroker/js-controller-common';
 import { EXIT_CODES } from '@iobroker/js-controller-common';
 import { tools } from '@iobroker/js-controller-common';
 import { setTimeout as wait } from 'node:timers/promises';

packages/cli/src/lib/setup/dbConnection.ts

@@ -22,7 +22,7 @@ import type { Client as ObjectsRedisClient } from '@iobroker/db-objects-redis';
 import type { ProcessExitCallback } from '@/lib/_Types.js';
 import { IoBrokerError } from '@/lib/setup/customError.js';
 import type { CommandResult } from '@alcalzone/pak';
-import { SYSTEM_ADAPTER_PREFIX } from '@iobroker/js-controller-common/constants';
+import { SYSTEM_ADAPTER_PREFIX } from '@iobroker/js-controller-common-db/constants';
 import { createRequire } from 'node:module';
 
 // eslint-disable-next-line unicorn/prefer-module
@@ -906,8 +906,8 @@ export class Install {
             options.enabled === true || options.enabled === false
                 ? options.enabled
                 : instanceObj.common.enabled === true || instanceObj.common.enabled === false
-                ? instanceObj.common.enabled
-                : false;
+                  ? instanceObj.common.enabled
+                  : false;
 
         if (options.port) {
             instanceObj.native = instanceObj.native || {};

packages/cli/src/lib/setup/setupInstall.ts

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
 import path from 'node:path';
 import { tools } from '@iobroker/js-controller-common';
-import { isLocalObjectsDbServer, isLocalStatesDbServer } from '@iobroker/js-controller-common-db';
+import { isLocalObjectsDbServer, isLocalStatesDbServer } from '@iobroker/js-controller-common';
 import type { Client as ObjectsRedisClient } from '@iobroker/db-objects-redis';
 import { MHClient, type BrowseResultEntry } from './multihostClient.js';
 import readline from 'node:readline';

packages/cli/src/lib/setup/setupMultihost.ts

@@ -1,4 +1,4 @@
-import { execAsync, type InternalLogger } from '@iobroker/js-controller-common/tools';
+import { execAsync, type InternalLogger } from '@iobroker/js-controller-common-db/tools';
 
 enum LOG_LEVELS {
     silly = 5,

packages/cli/src/lib/setup/setupPacketManager.ts

@@ -21,16 +21,16 @@ import {
     objectsDbHasServer,
     performObjectsInterview,
     performStatesInterview
-} from '@iobroker/js-controller-common-db';
+} from '@iobroker/js-controller-common';
 import { resetDbConnect, dbConnectAsync } from '@/lib/setup/dbConnection.js';
 import { BackupRestore } from '@/lib/setup/setupBackup.js';
 import crypto from 'node:crypto';
 import deepClone from 'deep-clone';
 import * as pluginInfos from '@/lib/setup/pluginInfos.js';
 import rl from 'readline-sync';
-import { FORBIDDEN_CHARS, getHostObject } from '@iobroker/js-controller-common/tools';
+import { FORBIDDEN_CHARS, getHostObject } from '@iobroker/js-controller-common-db/tools';
 import os from 'node:os';
-import { SYSTEM_ADAPTER_PREFIX, SYSTEM_HOST_PREFIX } from '@iobroker/js-controller-common/constants';
+import { SYSTEM_ADAPTER_PREFIX, SYSTEM_HOST_PREFIX } from '@iobroker/js-controller-common-db/constants';
 import { Upload } from '@/lib/setup/setupUpload.js';
 import { createRequire } from 'node:module';
 import * as url from 'node:url';
@@ -962,8 +962,8 @@ Please DO NOT copy files manually into ioBroker storage directories!`
             const defaultSentinelName = originalConfig.states.sentinelName
                 ? originalConfig.states.sentinelName
                 : oSentinelName && oPort === sPort
-                ? oSentinelName
-                : 'mymaster';
+                  ? oSentinelName
+                  : 'mymaster';
             sSentinelName = rl.question(`States Redis Sentinel Master Name [${defaultSentinelName}]: `, {
                 defaultInput: defaultSentinelName
             });