@kapeta/local-cluster-service 0.19.7 → 0.20.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.20.0](https://github.com/kapetacom/local-cluster-service/compare/v0.19.7...v0.20.0) (2023-09-10)
+
+
+### Features
+
+* Add support for block instance default configuration ([#73](https://github.com/kapetacom/local-cluster-service/issues/73)) ([7ea0f94](https://github.com/kapetacom/local-cluster-service/commit/7ea0f94a3167f14453e6c45aab7501181bff7398))
+
 ## [0.19.7](https://github.com/kapetacom/local-cluster-service/compare/v0.19.6...v0.19.7) (2023-09-10)
 
 

package/dist/cjs/src/config/routes.js

@@ -12,7 +12,6 @@ const cors_1 = require("../middleware/cors");
 const kapeta_1 = require("../middleware/kapeta");
 const stringBody_1 = require("../middleware/stringBody");
 const router = (0, express_promise_router_1.default)();
-const SYSTEM_ID = '$plan';
 router.use('/', cors_1.corsHandler);
 router.use('/', kapeta_1.kapetaHeaders);
 router.use('/', stringBody_1.stringBody);
@@ -54,7 +53,7 @@ router.put('/instance', async (req, res) => {
  * Returns the full configuration for a plan
  */
 router.get('/system', (req, res) => {
-    const config = configManager_1.configManager.getConfigForSection(req.kapeta.systemId, SYSTEM_ID);
+    const config = configManager_1.configManager.getConfigForSection(req.kapeta.systemId, configManager_1.SYSTEM_ID);
     res.send(config);
 });
 /**
@@ -65,7 +64,7 @@ router.put('/system', (req, res) => {
     if (!config) {
         config = {};
     }
-    configManager_1.configManager.setConfigForSection(req.kapeta.systemId, SYSTEM_ID, config);
+    configManager_1.configManager.setConfigForSection(req.kapeta.systemId, configManager_1.SYSTEM_ID, config);
     res.status(202).send({ ok: true });
 });
 /**

package/dist/cjs/src/configManager.d.ts

@@ -1,3 +1,4 @@
+export declare const SYSTEM_ID = "$plan";
 type AnyMap = {
     [key: string]: any;
 };

package/dist/cjs/src/configManager.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configManager = void 0;
+exports.configManager = exports.SYSTEM_ID = void 0;
 const storageService_1 = require("./storageService");
 const assetManager_1 = require("./assetManager");
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
 const utils_1 = require("./utils/utils");
+exports.SYSTEM_ID = '$plan';
 class ConfigManager {
     _config;
     constructor() {

package/dist/cjs/src/instanceManager.js

@@ -390,11 +390,12 @@ class InstanceManager {
                 }
             }
             const instanceConfig = await configManager_1.configManager.getConfigForSection(systemId, instanceId);
+            const resolvedConfig = (0, utils_1.getResolvedConfiguration)(blockSpec.configuration, instanceConfig, blockInstance.defaultConfiguration);
             const task = taskManager_1.taskManager.add(`instance:start:${systemId}:${instanceId}`, async () => {
                 const runner = new BlockInstanceRunner_1.BlockInstanceRunner(systemId);
                 const startTime = Date.now();
                 try {
-                    const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
+                    const processInfo = await runner.start(blockRef, instanceId, resolvedConfig);
                     instance.status = types_1.InstanceStatus.STARTING;
                     return this.saveInternalInstance({
                         ...instance,

package/dist/cjs/src/utils/utils.d.ts

@@ -1,3 +1,5 @@
+import { EntityList } from '@kapeta/schemas';
+import { AnyMap } from '../types';
 export declare function getBlockInstanceContainerName(systemId: string, instanceId: string): string;
 export declare function normalizeKapetaUri(uri: string): string;
 export declare function readYML(path: string): any;
@@ -5,3 +7,4 @@ export declare function isWindows(): boolean;
 export declare function isMac(): boolean;
 export declare function isLinux(): boolean;
 export declare function getBindHost(preferredHost?: string): string;
+export declare function getResolvedConfiguration(entities?: EntityList, config?: AnyMap, globalConfiguration?: AnyMap): AnyMap;

package/dist/cjs/src/utils/utils.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBindHost = exports.isLinux = exports.isMac = exports.isWindows = exports.readYML = exports.normalizeKapetaUri = exports.getBlockInstanceContainerName = void 0;
+exports.getResolvedConfiguration = exports.getBindHost = exports.isLinux = exports.isMac = exports.isWindows = exports.readYML = exports.normalizeKapetaUri = exports.getBlockInstanceContainerName = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const yaml_1 = __importDefault(require("yaml"));
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
 const md5_1 = __importDefault(require("md5"));
+const lodash_1 = __importDefault(require("lodash"));
 function getBlockInstanceContainerName(systemId, instanceId) {
     return `kapeta-block-instance-${(0, md5_1.default)(systemId + instanceId)}`;
 }
@@ -51,3 +52,26 @@ function getBindHost(preferredHost = '127.0.0.1') {
     return isLinux() ? '0.0.0.0' : preferredHost;
 }
 exports.getBindHost = getBindHost;
+function getResolvedConfiguration(entities, config, globalConfiguration) {
+    if (!entities || !globalConfiguration) {
+        return config || {};
+    }
+    const mergedConfig = config ? lodash_1.default.cloneDeep(config) : {};
+    entities.types?.forEach((type) => {
+        if (!type.properties) {
+            return;
+        }
+        Object.entries(type.properties).forEach(([propertyName, property]) => {
+            if (!property.global) {
+                return;
+            }
+            const configPath = type.name + '.' + propertyName;
+            const defaultValue = globalConfiguration ? lodash_1.default.get(globalConfiguration, configPath) : undefined;
+            if (!lodash_1.default.has(mergedConfig, configPath)) {
+                lodash_1.default.set(mergedConfig, configPath, defaultValue);
+            }
+        });
+    });
+    return mergedConfig;
+}
+exports.getResolvedConfiguration = getResolvedConfiguration;

package/dist/esm/src/config/routes.js

@@ -12,7 +12,6 @@ const cors_1 = require("../middleware/cors");
 const kapeta_1 = require("../middleware/kapeta");
 const stringBody_1 = require("../middleware/stringBody");
 const router = (0, express_promise_router_1.default)();
-const SYSTEM_ID = '$plan';
 router.use('/', cors_1.corsHandler);
 router.use('/', kapeta_1.kapetaHeaders);
 router.use('/', stringBody_1.stringBody);
@@ -54,7 +53,7 @@ router.put('/instance', async (req, res) => {
  * Returns the full configuration for a plan
  */
 router.get('/system', (req, res) => {
-    const config = configManager_1.configManager.getConfigForSection(req.kapeta.systemId, SYSTEM_ID);
+    const config = configManager_1.configManager.getConfigForSection(req.kapeta.systemId, configManager_1.SYSTEM_ID);
     res.send(config);
 });
 /**
@@ -65,7 +64,7 @@ router.put('/system', (req, res) => {
     if (!config) {
         config = {};
     }
-    configManager_1.configManager.setConfigForSection(req.kapeta.systemId, SYSTEM_ID, config);
+    configManager_1.configManager.setConfigForSection(req.kapeta.systemId, configManager_1.SYSTEM_ID, config);
     res.status(202).send({ ok: true });
 });
 /**

package/dist/esm/src/configManager.d.ts

@@ -1,3 +1,4 @@
+export declare const SYSTEM_ID = "$plan";
 type AnyMap = {
     [key: string]: any;
 };

package/dist/esm/src/configManager.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configManager = void 0;
+exports.configManager = exports.SYSTEM_ID = void 0;
 const storageService_1 = require("./storageService");
 const assetManager_1 = require("./assetManager");
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
 const utils_1 = require("./utils/utils");
+exports.SYSTEM_ID = '$plan';
 class ConfigManager {
     _config;
     constructor() {

package/dist/esm/src/instanceManager.js

@@ -390,11 +390,12 @@ class InstanceManager {
                 }
             }
             const instanceConfig = await configManager_1.configManager.getConfigForSection(systemId, instanceId);
+            const resolvedConfig = (0, utils_1.getResolvedConfiguration)(blockSpec.configuration, instanceConfig, blockInstance.defaultConfiguration);
             const task = taskManager_1.taskManager.add(`instance:start:${systemId}:${instanceId}`, async () => {
                 const runner = new BlockInstanceRunner_1.BlockInstanceRunner(systemId);
                 const startTime = Date.now();
                 try {
-                    const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
+                    const processInfo = await runner.start(blockRef, instanceId, resolvedConfig);
                     instance.status = types_1.InstanceStatus.STARTING;
                     return this.saveInternalInstance({
                         ...instance,

package/dist/esm/src/utils/utils.d.ts

@@ -1,3 +1,5 @@
+import { EntityList } from '@kapeta/schemas';
+import { AnyMap } from '../types';
 export declare function getBlockInstanceContainerName(systemId: string, instanceId: string): string;
 export declare function normalizeKapetaUri(uri: string): string;
 export declare function readYML(path: string): any;
@@ -5,3 +7,4 @@ export declare function isWindows(): boolean;
 export declare function isMac(): boolean;
 export declare function isLinux(): boolean;
 export declare function getBindHost(preferredHost?: string): string;
+export declare function getResolvedConfiguration(entities?: EntityList, config?: AnyMap, globalConfiguration?: AnyMap): AnyMap;

package/dist/esm/src/utils/utils.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBindHost = exports.isLinux = exports.isMac = exports.isWindows = exports.readYML = exports.normalizeKapetaUri = exports.getBlockInstanceContainerName = void 0;
+exports.getResolvedConfiguration = exports.getBindHost = exports.isLinux = exports.isMac = exports.isWindows = exports.readYML = exports.normalizeKapetaUri = exports.getBlockInstanceContainerName = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const yaml_1 = __importDefault(require("yaml"));
 const nodejs_utils_1 = require("@kapeta/nodejs-utils");
 const md5_1 = __importDefault(require("md5"));
+const lodash_1 = __importDefault(require("lodash"));
 function getBlockInstanceContainerName(systemId, instanceId) {
     return `kapeta-block-instance-${(0, md5_1.default)(systemId + instanceId)}`;
 }
@@ -51,3 +52,26 @@ function getBindHost(preferredHost = '127.0.0.1') {
     return isLinux() ? '0.0.0.0' : preferredHost;
 }
 exports.getBindHost = getBindHost;
+function getResolvedConfiguration(entities, config, globalConfiguration) {
+    if (!entities || !globalConfiguration) {
+        return config || {};
+    }
+    const mergedConfig = config ? lodash_1.default.cloneDeep(config) : {};
+    entities.types?.forEach((type) => {
+        if (!type.properties) {
+            return;
+        }
+        Object.entries(type.properties).forEach(([propertyName, property]) => {
+            if (!property.global) {
+                return;
+            }
+            const configPath = type.name + '.' + propertyName;
+            const defaultValue = globalConfiguration ? lodash_1.default.get(globalConfiguration, configPath) : undefined;
+            if (!lodash_1.default.has(mergedConfig, configPath)) {
+                lodash_1.default.set(mergedConfig, configPath, defaultValue);
+            }
+        });
+    });
+    return mergedConfig;
+}
+exports.getResolvedConfiguration = getResolvedConfiguration;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kapeta/local-cluster-service",
-    "version": "0.19.7",
+    "version": "0.20.0",
     "description": "Manages configuration, ports and service discovery for locally running Kapeta systems",
     "type": "commonjs",
     "exports": {

package/src/config/routes.ts

@@ -1,17 +1,15 @@
 import Router from 'express-promise-router';
-import { configManager } from '../configManager';
+import { configManager, SYSTEM_ID } from '../configManager';
 import { serviceManager } from '../serviceManager';
 import { operatorManager } from '../operatorManager';
 import { instanceManager } from '../instanceManager';
-import { StringBodyRequest } from '../middleware/stringBody';
 import { corsHandler } from '../middleware/cors';
 import { kapetaHeaders, KapetaRequest } from '../middleware/kapeta';
 import { stringBody } from '../middleware/stringBody';
-import { EnvironmentType, KapetaBodyRequest } from '../types';
+import { KapetaBodyRequest } from '../types';
 import { Response } from 'express';
 
 const router = Router();
-const SYSTEM_ID = '$plan';
 
 router.use('/', corsHandler);
 router.use('/', kapetaHeaders);

package/src/configManager.ts

@@ -5,6 +5,7 @@ import { assetManager } from './assetManager';
 import { parseKapetaUri } from '@kapeta/nodejs-utils';
 import { normalizeKapetaUri } from './utils/utils';
 
+export const SYSTEM_ID = '$plan';
 type AnyMap = { [key: string]: any };
 
 interface MatchedIdentity {

package/src/instanceManager.ts

@@ -15,7 +15,7 @@ import {
 import { configManager } from './configManager';
 import { DesiredInstanceStatus, InstanceInfo, InstanceOwner, InstanceStatus, InstanceType, LogEntry } from './types';
 import { BlockDefinitionSpec, BlockInstance, Plan } from '@kapeta/schemas';
-import { getBlockInstanceContainerName, normalizeKapetaUri } from './utils/utils';
+import { getBlockInstanceContainerName, getResolvedConfiguration, normalizeKapetaUri } from './utils/utils';
 import { KIND_OPERATOR, operatorManager } from './operatorManager';
 import { parseKapetaUri } from '@kapeta/nodejs-utils';
 import { definitionsManager } from './definitionsManager';
@@ -497,13 +497,18 @@ export class InstanceManager {
             }
 
             const instanceConfig = await configManager.getConfigForSection(systemId, instanceId);
+            const resolvedConfig = getResolvedConfiguration(
+                blockSpec.configuration,
+                instanceConfig,
+                blockInstance.defaultConfiguration
+            );
             const task = taskManager.add(
                 `instance:start:${systemId}:${instanceId}`,
                 async () => {
                     const runner = new BlockInstanceRunner(systemId);
                     const startTime = Date.now();
                     try {
-                        const processInfo = await runner.start(blockRef, instanceId, instanceConfig);
+                        const processInfo = await runner.start(blockRef, instanceId, resolvedConfig);
 
                         instance.status = InstanceStatus.STARTING;
 

package/src/utils/utils.ts

@@ -2,6 +2,9 @@ import FS from 'node:fs';
 import YAML from 'yaml';
 import { parseKapetaUri } from '@kapeta/nodejs-utils';
 import md5 from 'md5';
+import { EntityList } from '@kapeta/schemas';
+import _ from 'lodash';
+import { AnyMap } from '../types';
 
 export function getBlockInstanceContainerName(systemId: string, instanceId: string) {
     return `kapeta-block-instance-${md5(systemId + instanceId)}`;
@@ -47,3 +50,29 @@ export function getBindHost(preferredHost = '127.0.0.1') {
     // TODO: This might pose a security risk - so we should authenticate all requests using a shared secret/nonce that we pass around.
     return isLinux() ? '0.0.0.0' : preferredHost;
 }
+
+export function getResolvedConfiguration(entities?: EntityList, config?: AnyMap, globalConfiguration?: AnyMap): AnyMap {
+    if (!entities || !globalConfiguration) {
+        return config || {};
+    }
+
+    const mergedConfig = config ? _.cloneDeep(config) : {};
+    entities.types?.forEach((type) => {
+        if (!type.properties) {
+            return;
+        }
+        Object.entries(type.properties).forEach(([propertyName, property]) => {
+            if (!property.global) {
+                return;
+            }
+
+            const configPath = type.name + '.' + propertyName;
+            const defaultValue = globalConfiguration ? _.get(globalConfiguration, configPath) : undefined;
+            if (!_.has(mergedConfig, configPath)) {
+                _.set(mergedConfig, configPath, defaultValue);
+            }
+        });
+    });
+
+    return mergedConfig;
+}