@colabo-utils/i-config

v0.1.7

Published

2 years ago

Provides config support for the Colabo.Space Ecosystem

Downloads

0High
0Medium
0Low

mprinc

Intro

Provides config support for the Colabo.Space Ecosystem

This is isomorphic puzzle and can be used both in backend and frontend system

How to use the puzzle

There are two phases of initialization of config:

INIT-1: load config data
INIT-2: init config puzzle with config data

They are separate because in some systems they should happen at separate places, at separate time

Backend

Init

Config file:

The best practice is to put it at <backend_app_folder>/config/global.js.

NOTE: it is important that this file is not imported, but required and that it is therefore JS (not TS, although it can be, if we still do not import it) because otherwise it would be bundled in a final file during building and we wouldn't be able to change the config after building project

The basic of the config file is:

'use strict';

// this is file is available to the rest of the system
// through the puzzle `@colabo-utils/i-config`
// please read `@colabo-utils/i-config/README.md` for more details

// NOTE: it is important that this file is not imported, but required
// and that it is therefore JS (not TS, although it can be, if we still do not import it)
// because otherwise it would be bundled in a final file during building
// and we wouldn't be able to change the config after building project

if (!global.hasOwnProperty('general')) {
	console.log("[config/global.js] Setting up global.general");
	global.general = {
		// active map
		// mapId: '5b96619b86f3cc8057216a03',
	};
}

if (!global.hasOwnProperty('puzzles')) {
	console.log("Setting up global.puzzles");
	global.puzzles = {
		// '@colabo-topiChat/b-talk': {
		// 	    saveTalkToMap: true,
		// 	    mapId: "5b96619b86f3cc8057216a03",
		// 	    iAmId: "1b96619b86f3cc8057216a05",
		// 	    nodeId: ""
		// }
	};
}

module.exports = global;

Initialization:

The best practice is to initialize it from the main backend file: <backend_app_folder>/index.ts:

// load the configuration file
let configFile = require('./config/global');
console.log("[Colabo.Space:index] configFile.paths: %s", JSON.stringify(configFile.paths));

// provide it to the config puzzle
let config = require('@colabo-utils/i-config');
let globalSet:any = configFile.globalSet;
config.init(globalSet);

Access the config data

Now you can access the config data at any part of the code as simply as (the example is from the backend puzzle: @colabo-topiChat/b-talk):

const MODULE_NAME:string = "@colabo-topiChat/b-talk";

import {GetPuzzle} from '@colabo-utils/i-config';
let puzzleConfig:any = GetPuzzle(MODULE_NAME);

console.log("[TopiChatTalk] mapId = ", puzzleConfig.mapId);

Angular - Frontend

In the frontend there is still problem with the INIT-1 phase. We cannot put it early enough to be sure that any later use of it will have it ready.

NOTE: the reason is that we want to provide it available on angular components declaration-time, not only at initialization/use time.

For example:

a file that has a service component is imported (declaration-time) at early phase, and
later service is instantiated and
even later it is used

Solutions that exist with pre-booting are working fine for cases 2 and 3, but not for 1

Init

Therefore, we need to setup INIT-1 phase through manual injection of config file (usually: <frontend_app_folder>/src/config/global.js). So far we are doing it by injecting it in the index.html file:

<head>
    <script src="config/global.js"></script>
</head>

The phase INIT-2 happens at the beginning of the polyfills.ts file:

console.log("polyfills.ts");

// let configFile = require('./config/global');
// import * as configFile from './config/global';
let globalSet = (<any>window).globalSet;
console.log("[polyfills.ts] globalSet.puzzles: %s", JSON.stringify(globalSet.puzzles));
// let config = require('@colabo-utils/i-config');
import * as config from '@colabo-utils/i-config';
config.init(globalSet);

Access the config data

Now you can access the config data at any part of the code as simply as (the example is from the frontend puzzle: @colabo-rima/rima_aaa, file rima-aaa.service.ts):

import * as config from '@colabo-utils/i-config';

console.log("[rima-aaa.service] config.GetGeneral('mapId'):", config.GetGeneral('mapId'));

Vue - Frontend

This is from angular frontend but seems valid

In the frontend there is still problem with the INIT-1 phase. We cannot put it early enough to be sure that any later use of it will have it ready.
NOTE: the reason is that we want to provide it available on vue components declaration-time, not only at initialization/use time.
For example:
1. a file that has a service component is imported (declaration-time) at early phase, and
2. later service is instantiated and
3. even later it is used
Solutions that exist with pre-booting are working fine for cases 2 and 3, but not for 1

Init

Therefore, we need to setup INIT-1 phase through manual injection of config file (usually: <frontend_app_folder>/src/config/global.ts). So far we are doing it by injecting its compiled version (for example /public/config/global.js) in the public/index.html file:

<body>
	<!-- import config before colabo-rima angular and app related libraries -->
	<script src="<%= BASE_URL %>config/global.js"></script>
</body>

The phase INIT-2 happens at the beginning of the main.ts file:

/** Colabo Config */

console.log("[main.ts] Importing config ...");

import { IColaboConfig } from "@colabo-utils/i-config";

// explicitly import or ...
// import { globalSet } from "./config/web_components__colabo_rima__global";
// ... or provide separately as a global variable `globalSet`
declare const globalSet: IColaboConfig;

console.log("[main.ts] imported config.");

// let configFile = require('./config/global');
// import * as configFile from './config/global';
// let globalSet = (<any>window).globalSet;

if (typeof globalSet === "undefined") {
	console.error("[main.ts] globalSet is undefined");
} else {
	console.log("[main.ts] globalSet.puzzles: %s", JSON.stringify(globalSet.puzzles));
}

import { init as configInit } from "@colabo-utils/i-config";

console.log("[main.ts] configuring ...");
configInit(globalSet);
console.log("[main.ts] configured");

Compile

Config file is in a TypeScript file (for example src/config/global.ts) which needs to be compiled separately into /public/config/global.js with src/config/tsconfig.json where there is "outDir": "../../public/config", directing the compiled version to the public folder.

cd /src/config
tsc

Unfortunatelly, when we import from other puzzles, currently (?) the current denominator of all files is used as a starting point in the outDir, which ends up with: /config/jobs/tickerai-zontik/tickerai-code/src/frontend/apps/tickerai/src/config/global.js and need to import it as <script src="<%= BASE_URL %>config/jobs/tickerai-zontik/tickerai-code/src/frontend/apps/tickerai/src/config/global.js"></script>

More info:

https://indepth.dev/posts/1164/configuring-typescript-compiler
https://github.com/Microsoft/TypeScript/issues/5134

Access the config data

Now you can access the config data at any part of the code as simply as (the example is from the frontend puzzle: @colabo-rima/rima_aaa, file rima-aaa.service.ts):

import { GetPuzzle } from "@colabo-utils/i-config";

export default class DebugConsoleComponent extends Vue {
	mounted(): void {
		// debugger;
		console.log("[DebugConsoleComponent mounted]");
		// eslint-disable-next-line @typescript-eslint/no-explicit-any
		const puzzleConfig: any = GetPuzzle(MODULE_NAME);
		console.log("[@colabo-dev/f-debug] puzzleConfig: ", JSON.stringify(puzzleConfig));
	}
	// ...

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Intro

How to use the puzzle

Backend

Init

Access the config data

Angular - Frontend

Init

Access the config data

Vue - Frontend

Init

Compile

Access the config data