Compare commits
139 Commits
Author | SHA1 | Date | |
---|---|---|---|
37e1ee7970 | |||
bd0bb3acf5 | |||
f60497474e | |||
1d84cefa84 | |||
6792acd533 | |||
9397d89cf5 | |||
37cf4a91f4 | |||
52db86c929 | |||
e8f09c1b7a | |||
79edea873f | |||
97666a623d | |||
ef61ea9ad7 | |||
9c1504ef02 | |||
e8f2e04d1c | |||
e12aa7e961 | |||
857b7cd010 | |||
e100dea160 | |||
e8e87fcdba | |||
0d18b11721 | |||
eaaefddbe3 | |||
8c6946ddb6 | |||
3a7ebcdd80 | |||
ec2afbfd55 | |||
89feeca735 | |||
c4261765ec | |||
33fe6bcd41 | |||
1baf1c318c | |||
051aba3299 | |||
7998d79b13 | |||
6838a8729a | |||
67f4e33ca0 | |||
8a8277ae9f | |||
ff9cb9132c | |||
f4ce784a59 | |||
b34be4dcba | |||
6cc69efe2d | |||
8c30f294bc | |||
228eb791b7 | |||
057476ae66 | |||
cb80e4dc2e | |||
8410e09a4d | |||
eb04abddbf | |||
57809d9b53 | |||
bee5231d47 | |||
df45287026 | |||
b5b6ca81cf | |||
dc80e3b48d | |||
043d795013 | |||
29c0c8dc23 | |||
8157f2a56b | |||
2f528d1812 | |||
139c71a451 | |||
4678e44d16 | |||
af9f590349 | |||
d43ad80784 | |||
b1017121ea | |||
a8a91b4db2 | |||
67c4b06c4d | |||
7693b52066 | |||
30a02ae48b | |||
241182ed2e | |||
3d82038ec3 | |||
300d62ed12 | |||
a5e849aa17 | |||
83807d7c5c | |||
39d3a0f2f8 | |||
904a48d414 | |||
e2acb28756 | |||
92e4379bd2 | |||
e0ce732ee1 | |||
98be0f036c | |||
54fca17142 | |||
1a7634e8db | |||
8830b825ac | |||
123324bf43 | |||
4761ff31cf | |||
430c3ea13a | |||
6dd3782b0d | |||
06aa721247 | |||
f728c56016 | |||
f512acdfaa | |||
331a098851 | |||
a8053a6e20 | |||
a62f3eb750 | |||
4b53044e8f | |||
2db2c80130 | |||
8b23eaf194 | |||
a03c54001f | |||
7bc404ba21 | |||
ac2a1559b0 | |||
57b37cb327 | |||
8b17e814cc | |||
f4b8cde347 | |||
3189d4d274 | |||
c2d134a6ea | |||
7552dc1e9f | |||
fe91459510 | |||
0e0ffb7634 | |||
37bb052774 | |||
3c7683d40e | |||
c19f27e873 | |||
c1a03fec0f | |||
8b650c5ea7 | |||
4fc6e327ec | |||
7991baf2bf | |||
d033780015 | |||
eae46e6461 | |||
785acfaba4 | |||
5a4dceb75d | |||
a17834a8f0 | |||
01765fa50f | |||
547c159dc4 | |||
046d7d646d | |||
f6985bd7b2 | |||
241e44e19d | |||
99561166e2 | |||
0e95774f30 | |||
011af15866 | |||
77a13786d1 | |||
d0e4c1c44a | |||
1c8d6bf96e | |||
95c5fb7e83 | |||
2165a8f677 | |||
aa52ceeeca | |||
78e57394c9 | |||
5f9f670546 | |||
4cac5c1b1c | |||
8d6c8494c4 | |||
3fb7375a42 | |||
c64a72ea9d | |||
c8c481fda0 | |||
bafa94c6ac | |||
a28c96356f | |||
bc7069e72c | |||
5ba41150be | |||
317a9f2189 | |||
850032bd03 | |||
c009cd337d | |||
76cb8a36fc |
19
.gitignore
vendored
19
.gitignore
vendored
@ -1,5 +1,22 @@
|
|||||||
.nogit/
|
.nogit/
|
||||||
node_modules/
|
|
||||||
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_web/
|
||||||
|
dist_serve/
|
||||||
|
dist_ts_web/
|
||||||
|
|
||||||
|
# custom
|
@ -1,95 +1,119 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .yarn/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: "$CI_BUILD_STAGE"
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- trigger
|
- metadata
|
||||||
- pages
|
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
mirror:
|
mirror:
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
snyk:
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci command yarn global add snyk
|
- npmci npm prepare
|
||||||
- npmci command yarn install --ignore-scripts
|
- npmci command npm install -g snyk
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command snyk test
|
- npmci command snyk test
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
testLEGACY:
|
# ====================
|
||||||
stage: test
|
# test stage
|
||||||
script:
|
# ====================
|
||||||
- npmci node install legacy
|
|
||||||
- npmci npm install
|
testStable:
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
testLTS:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci node install lts
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
testBuild:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci node install lts
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
allow_failure: true
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: trigger
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: hosttoday/ht-docker-dbase:npmci
|
||||||
stage: pages
|
services:
|
||||||
|
- docker:stable-dind
|
||||||
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command yarn global add npmpage
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
- npmci command npmpage
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- notpriv
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
|
allow_failure: true
|
||||||
|
4
.snyk
Normal file
4
.snyk
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||||
|
version: v1.13.5
|
||||||
|
ignore: {}
|
||||||
|
patch: {}
|
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "current file",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"${relativeFile}"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "test.ts",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"test/test.ts"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
1
dist/index.d.ts
vendored
1
dist/index.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export * from './smartuniverse.classes.smartuniverse';
|
|
7
dist/index.js
vendored
7
dist/index.js
vendored
@ -1,7 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
__export(require("./smartuniverse.classes.smartuniverse"));
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDJEQUFzRCJ9
|
|
11
dist/smartuniverse.classes.smartuniverse.d.ts
vendored
11
dist/smartuniverse.classes.smartuniverse.d.ts
vendored
@ -1,11 +0,0 @@
|
|||||||
export interface ISmartUniverseConstructorOptions {
|
|
||||||
port: number | string;
|
|
||||||
}
|
|
||||||
export declare class SmartUniverse {
|
|
||||||
private options;
|
|
||||||
private universeVersionStore;
|
|
||||||
private readonly universeVersion;
|
|
||||||
private smartexpressServer;
|
|
||||||
constructor(optionsArg: ISmartUniverseConstructorOptions);
|
|
||||||
init(): Promise<void>;
|
|
||||||
}
|
|
45
dist/smartuniverse.classes.smartuniverse.js
vendored
45
dist/smartuniverse.classes.smartuniverse.js
vendored
@ -1,45 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
||||||
return new (P || (P = Promise))(function (resolve, reject) {
|
|
||||||
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
||||||
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
||||||
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
|
|
||||||
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
||||||
});
|
|
||||||
};
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const plugins = require("./smartuniverse.plugins");
|
|
||||||
const smartexpress_1 = require("smartexpress");
|
|
||||||
const paths = require("./smartuniverse.paths");
|
|
||||||
class SmartUniverse {
|
|
||||||
get universeVersion() {
|
|
||||||
if (this.universeVersionStore) {
|
|
||||||
return this.universeVersionStore;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
const packageJson = plugins.smartfile.fs.toObjectSync(paths.packageJson);
|
|
||||||
this.universeVersionStore = packageJson.version;
|
|
||||||
return this.universeVersionStore;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
constructor(optionsArg) {
|
|
||||||
this.options = optionsArg;
|
|
||||||
}
|
|
||||||
init() {
|
|
||||||
return __awaiter(this, void 0, void 0, function* () {
|
|
||||||
this.smartexpressServer = new plugins.smartexpress.Server({
|
|
||||||
cors: true,
|
|
||||||
defaultAnswer: `smartuniverse server ${this.universeVersion}`,
|
|
||||||
forceSsl: false,
|
|
||||||
port: this.options.port
|
|
||||||
});
|
|
||||||
const addRoute = new smartexpress_1.Route(this.smartexpressServer, 'addMessage');
|
|
||||||
const addHandler = new smartexpress_1.Handler('PUT', requestBody => {
|
|
||||||
return 'hi';
|
|
||||||
});
|
|
||||||
// await this.smartexpressServer.addRoute()
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.SmartUniverse = SmartUniverse;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnR1bml2ZXJzZS5jbGFzc2VzLnNtYXJ0dW5pdmVyc2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHVuaXZlcnNlLmNsYXNzZXMuc21hcnR1bml2ZXJzZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQUEsbURBQW1EO0FBRW5ELCtDQUFzRDtBQUV0RCwrQ0FBK0M7QUFNL0M7SUFHRSxJQUFZLGVBQWU7UUFDekIsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLG9CQUFvQixDQUFDLENBQUMsQ0FBQztZQUM5QixNQUFNLENBQUMsSUFBSSxDQUFDLG9CQUFvQixDQUFDO1FBQ25DLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE1BQU0sV0FBVyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUM7WUFDekUsSUFBSSxDQUFDLG9CQUFvQixHQUFHLFdBQVcsQ0FBQyxPQUFPLENBQUM7WUFDaEQsTUFBTSxDQUFDLElBQUksQ0FBQyxvQkFBb0IsQ0FBQztRQUNuQyxDQUFDO0lBQ0gsQ0FBQztJQUVELFlBQVksVUFBNEM7UUFDdEQsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUM7SUFDNUIsQ0FBQztJQUVZLElBQUk7O1lBQ2YsSUFBSSxDQUFDLGtCQUFrQixHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUM7Z0JBQ3hELElBQUksRUFBRSxJQUFJO2dCQUNWLGFBQWEsRUFBRSx3QkFBd0IsSUFBSSxDQUFDLGVBQWUsRUFBRTtnQkFDN0QsUUFBUSxFQUFFLEtBQUs7Z0JBQ2YsSUFBSSxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSTthQUN4QixDQUFDLENBQUM7WUFFSCxNQUFNLFFBQVEsR0FBRyxJQUFJLG9CQUFLLENBQUMsSUFBSSxDQUFDLGtCQUFrQixFQUFFLFlBQVksQ0FBQyxDQUFDO1lBQ2xFLE1BQU0sVUFBVSxHQUFHLElBQUksc0JBQU8sQ0FBQyxLQUFLLEVBQUUsV0FBVyxDQUFDLEVBQUU7Z0JBQ2xELE1BQU0sQ0FBQyxJQUFJLENBQUM7WUFDZCxDQUFDLENBQUMsQ0FBQztZQUNILDJDQUEyQztRQUM3QyxDQUFDO0tBQUE7Q0FDRjtBQS9CRCxzQ0ErQkMifQ==
|
|
1
dist/smartuniverse.cli.d.ts
vendored
1
dist/smartuniverse.cli.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export {};
|
|
12
dist/smartuniverse.cli.js
vendored
12
dist/smartuniverse.cli.js
vendored
@ -1,12 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const plugins = require("./smartuniverse.plugins");
|
|
||||||
const index_1 = require("./index");
|
|
||||||
process.env.CLI = 'true';
|
|
||||||
const universeCli = new plugins.smartcli.Smartcli();
|
|
||||||
universeCli.standardTask().then(argvArg => {
|
|
||||||
const standardUniverse = new index_1.SmartUniverse({
|
|
||||||
port: 8765
|
|
||||||
});
|
|
||||||
});
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnR1bml2ZXJzZS5jbGkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHVuaXZlcnNlLmNsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLG1EQUFtRDtBQUVuRCxtQ0FBd0M7QUFFeEMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEdBQUcsTUFBTSxDQUFDO0FBRXpCLE1BQU0sV0FBVyxHQUFHLElBQUksT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FBQztBQUVwRCxXQUFXLENBQUMsWUFBWSxFQUFFLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxFQUFFO0lBQ3hDLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxxQkFBYSxDQUFDO1FBQ3pDLElBQUksRUFBRSxJQUFJO0tBQ1gsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDLENBQUMifQ==
|
|
1
dist/smartuniverse.paths.d.ts
vendored
1
dist/smartuniverse.paths.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export declare const packageJson: string;
|
|
5
dist/smartuniverse.paths.js
vendored
5
dist/smartuniverse.paths.js
vendored
@ -1,5 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const plugins = require("./smartuniverse.plugins");
|
|
||||||
exports.packageJson = plugins.path.join(__dirname, '../package.json');
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnR1bml2ZXJzZS5wYXRocy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0dW5pdmVyc2UucGF0aHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxtREFBbUQ7QUFFdEMsUUFBQSxXQUFXLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLGlCQUFpQixDQUFDLENBQUMifQ==
|
|
5
dist/smartuniverse.plugins.d.ts
vendored
5
dist/smartuniverse.plugins.d.ts
vendored
@ -1,5 +0,0 @@
|
|||||||
import * as path from 'path';
|
|
||||||
import * as smartcli from 'smartcli';
|
|
||||||
import * as smartexpress from 'smartexpress';
|
|
||||||
import * as smartfile from 'smartfile';
|
|
||||||
export { path, smartcli, smartexpress, smartfile };
|
|
11
dist/smartuniverse.plugins.js
vendored
11
dist/smartuniverse.plugins.js
vendored
@ -1,11 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const path = require("path");
|
|
||||||
exports.path = path;
|
|
||||||
const smartcli = require("smartcli");
|
|
||||||
exports.smartcli = smartcli;
|
|
||||||
const smartexpress = require("smartexpress");
|
|
||||||
exports.smartexpress = smartexpress;
|
|
||||||
const smartfile = require("smartfile");
|
|
||||||
exports.smartfile = smartfile;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnR1bml2ZXJzZS5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnR1bml2ZXJzZS5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsNkJBQTZCO0FBS3BCLG9CQUFJO0FBSmIscUNBQXFDO0FBSXRCLDRCQUFRO0FBSHZCLDZDQUE2QztBQUdwQixvQ0FBWTtBQUZyQyx1Q0FBdUM7QUFFQSw4QkFBUyJ9
|
|
19
license
Normal file
19
license
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
@ -1,7 +1,17 @@
|
|||||||
{
|
{
|
||||||
|
"gitzone": {
|
||||||
|
"module": {
|
||||||
|
"githost": "gitlab.com",
|
||||||
|
"gitscope": "pushrocks",
|
||||||
|
"gitrepo": "smartuniverse",
|
||||||
|
"shortDescription": "messaging service for micro services",
|
||||||
|
"npmPackagename": "@pushrocks/smartuniverse",
|
||||||
|
"license": "MIT",
|
||||||
|
"projectDomain": "push.rocks"
|
||||||
|
}
|
||||||
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [
|
"npmGlobalTools": [],
|
||||||
"npmts"
|
"npmAccessLevel": "public"
|
||||||
]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
3063
package-lock.json
generated
Normal file
3063
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
47
package.json
47
package.json
@ -1,21 +1,52 @@
|
|||||||
{
|
{
|
||||||
"name": "smartuniverse",
|
"name": "@pushrocks/smartuniverse",
|
||||||
"version": "1.0.2",
|
"version": "1.0.70",
|
||||||
|
"private": false,
|
||||||
"description": "messaging service for your micro services",
|
"description": "messaging service for your micro services",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)",
|
"test": "(tstest test/)",
|
||||||
|
"testManual": "(tsrun test/test.ts)",
|
||||||
|
"build": "(tsbuild)",
|
||||||
"format": "(gitzone format)"
|
"format": "(gitzone format)"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"tapbundle": "^2.0.0"
|
"@gitzone/tsbuild": "^2.1.17",
|
||||||
|
"@gitzone/tstest": "^1.0.24",
|
||||||
|
"@pushrocks/tapbundle": "^3.0.13",
|
||||||
|
"@types/node": "^12.7.3",
|
||||||
|
"tslint": "^5.19.0",
|
||||||
|
"tslint-config-prettier": "^1.18.0"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"rxjs": "*"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"smartcli": "^2.0.12",
|
"@pushrocks/lik": "^3.0.11",
|
||||||
"smartexpress": "^1.0.19",
|
"@pushrocks/smartdelay": "^2.0.3",
|
||||||
"smartfile": "^4.2.28"
|
"@pushrocks/smartexpress": "^3.0.40",
|
||||||
}
|
"@pushrocks/smartfile": "^7.0.4",
|
||||||
|
"@pushrocks/smarthash": "^2.0.6",
|
||||||
|
"@pushrocks/smartlog": "^2.0.19",
|
||||||
|
"@pushrocks/smartpromise": "^3.0.2",
|
||||||
|
"@pushrocks/smartrequest": "^1.1.23",
|
||||||
|
"@pushrocks/smartrx": "^2.0.3",
|
||||||
|
"@pushrocks/smartsocket": "^1.1.46",
|
||||||
|
"@pushrocks/smarttime": "^3.0.12",
|
||||||
|
"@pushrocks/smartunique": "^3.0.1"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/*",
|
||||||
|
"ts_web/*",
|
||||||
|
"dist/*",
|
||||||
|
"dist_web/*",
|
||||||
|
"dist_ts_web/*",
|
||||||
|
"assets/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
55
readme.md
Normal file
55
readme.md
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
# @pushrocks/smartuniverse
|
||||||
|
messaging service for micro services
|
||||||
|
|
||||||
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
[](https://gitlab.com/pushrocks/smartuniverse/commits/master)
|
||||||
|
[](https://gitlab.com/pushrocks/smartuniverse/commits/master)
|
||||||
|
[](https://www.npmjs.com/package/@pushrocks/smartuniverse)
|
||||||
|
[](https://snyk.io/test/npm/@pushrocks/smartuniverse)
|
||||||
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
[](https://prettier.io/)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
### What is smartuniverse all about?
|
||||||
|
|
||||||
|
Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
|
||||||
|
|
||||||
|
### Server side
|
||||||
|
|
||||||
|
every universe has a server that manages messages.
|
||||||
|
Think Kafka, but without Kafka.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as smartuniverse from '@pushrocks/smartuniverse';
|
||||||
|
|
||||||
|
const myUniverse = new smartuniverse.Universe({
|
||||||
|
messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
|
||||||
|
});
|
||||||
|
|
||||||
|
// create as many channels as you like
|
||||||
|
myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
|
||||||
|
myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
|
||||||
|
|
||||||
|
myUniverse.start(8765); // start the server and provide the port on which to listen on
|
||||||
|
```
|
||||||
|
|
||||||
|
### Client side
|
||||||
|
|
||||||
|
All your microservices represents clients in the universe that may talk to each other using the universe server.
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
82
test/test.ts
82
test/test.ts
@ -1,12 +1,84 @@
|
|||||||
import { expect, tap } from 'tapbundle';
|
// tslint:disable-next-line:no-implicit-dependencies
|
||||||
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import * as smartuniverse from '../ts/index';
|
import * as smartuniverse from '../ts/index';
|
||||||
|
|
||||||
let testSmartUniverse: smartuniverse.SmartUniverse;
|
import { Observable } from 'rxjs';
|
||||||
|
|
||||||
|
let testUniverse: smartuniverse.Universe;
|
||||||
|
let testClientUniverse: smartuniverse.ClientUniverse;
|
||||||
|
let testClientUniverse2: smartuniverse.ClientUniverse;
|
||||||
|
let testClientChannel: smartuniverse.ClientUniverseChannel;
|
||||||
|
|
||||||
|
const testServerData = {
|
||||||
|
serverAddress: 'http://localhost:8765'
|
||||||
|
};
|
||||||
|
|
||||||
|
const testChannelData = {
|
||||||
|
channelName: 'awesomeTestChannel',
|
||||||
|
channelPass: 'awesomeChannelPass'
|
||||||
|
};
|
||||||
|
|
||||||
tap.test('first test', async () => {
|
tap.test('first test', async () => {
|
||||||
testSmartUniverse = new smartuniverse.SmartUniverse({
|
testUniverse = new smartuniverse.Universe({
|
||||||
port: 8765
|
messageExpiryInMilliseconds: 1000
|
||||||
})
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('add a message to the SmartUniverse', async () => {
|
||||||
|
await testUniverse.start(8765);
|
||||||
|
});
|
||||||
|
|
||||||
|
// testing message handling
|
||||||
|
tap.test('create smartuniverse client', async () => {
|
||||||
|
testClientUniverse = new smartuniverse.ClientUniverse({
|
||||||
|
serverAddress: testServerData.serverAddress
|
||||||
|
});
|
||||||
|
expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should add a channel to the universe', async () => {
|
||||||
|
testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should add the same channel to the client universe in the same way', async () => {
|
||||||
|
testClientUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should start the ClientUniverse', async () => {
|
||||||
|
await testClientUniverse.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get a observable correctly', async () => {
|
||||||
|
testClientChannel = testClientUniverse.getChannel(testChannelData.channelName);
|
||||||
|
expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should send a message correctly', async () => {
|
||||||
|
await testClientUniverse.getChannel(testChannelData.channelName).sendMessage({
|
||||||
|
messageText: 'hello'
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('universe should contain the sent message', async () => {
|
||||||
|
expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('a second client should be able to subscibe', async () => {
|
||||||
|
testClientUniverse2 = new smartuniverse.ClientUniverse({
|
||||||
|
serverAddress: testServerData.serverAddress
|
||||||
|
});
|
||||||
|
|
||||||
|
testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should receive a message correctly', async () => {});
|
||||||
|
|
||||||
|
tap.test('should disconnect the client correctly', async () => {
|
||||||
|
testClientUniverse.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should end the server correctly', async tools => {
|
||||||
|
await testUniverse.stopServer();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
13
ts/index.ts
13
ts/index.ts
@ -1 +1,12 @@
|
|||||||
export * from './smartuniverse.classes.smartuniverse';
|
// Client classes
|
||||||
|
export * from './smartuniverse.classes.clientuniverse';
|
||||||
|
export * from './smartuniverse.classes.clientuniversechannel';
|
||||||
|
export * from './smartuniverse.classes.clientuniversemessage';
|
||||||
|
|
||||||
|
// Server classes
|
||||||
|
export * from './smartuniverse.classes.universe';
|
||||||
|
export * from './smartuniverse.classes.universecache';
|
||||||
|
export * from './smartuniverse.classes.universechannel';
|
||||||
|
export * from './smartuniverse.classes.universemessage';
|
||||||
|
|
||||||
|
export * from './interfaces';
|
||||||
|
15
ts/interfaces/http.interfaces.ts
Normal file
15
ts/interfaces/http.interfaces.ts
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
export interface IServerGetMessagesRequestBody {
|
||||||
|
channel: string;
|
||||||
|
topic?: string;
|
||||||
|
youngerThan: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the interface for a standard request
|
||||||
|
*/
|
||||||
|
export interface IServerPutMessageRequestBody {
|
||||||
|
channel: string;
|
||||||
|
passphrase: string;
|
||||||
|
message: string;
|
||||||
|
payload: any;
|
||||||
|
}
|
4
ts/interfaces/index.ts
Normal file
4
ts/interfaces/index.ts
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
export * from './http.interfaces';
|
||||||
|
export * from './universechannel.interfaces';
|
||||||
|
export * from './universemessage.interfaces';
|
||||||
|
export * from './universeactions.interfaces';
|
17
ts/interfaces/universeactions.interfaces.ts
Normal file
17
ts/interfaces/universeactions.interfaces.ts
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
export type IServerCallActions =
|
||||||
|
| 'channelSubscription'
|
||||||
|
| 'processMessage'
|
||||||
|
| 'channelUnsubscribe'
|
||||||
|
| 'terminateConnection';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the interface for a subscription
|
||||||
|
*/
|
||||||
|
export interface IServerCallSubscribeActionPayload {
|
||||||
|
name: string;
|
||||||
|
passphrase: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IServerUnsubscribeActionPayload {
|
||||||
|
name: string;
|
||||||
|
}
|
1
ts/interfaces/universechannel.interfaces.ts
Normal file
1
ts/interfaces/universechannel.interfaces.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export interface IUniverseChannel {}
|
18
ts/interfaces/universemessage.interfaces.ts
Normal file
18
ts/interfaces/universemessage.interfaces.ts
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
export interface IMessageCreator {
|
||||||
|
messageText: string;
|
||||||
|
payload?: string | number | any;
|
||||||
|
payloadStringType?: 'Buffer' | 'string' | 'object';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
export interface IUniverseMessage extends IMessageCreator {
|
||||||
|
id: string;
|
||||||
|
/**
|
||||||
|
* time of creation
|
||||||
|
*/
|
||||||
|
timestamp: number;
|
||||||
|
passphrase: string;
|
||||||
|
targetChannelName: string;
|
||||||
|
}
|
138
ts/smartuniverse.classes.clientuniverse.ts
Normal file
138
ts/smartuniverse.classes.clientuniverse.ts
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
|
||||||
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
|
import { Observable } from 'rxjs';
|
||||||
|
import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
|
||||||
|
import * as url from 'url';
|
||||||
|
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
|
import { ClientUniverseChannel, ClientUniverseMessage } from './';
|
||||||
|
import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache';
|
||||||
|
|
||||||
|
export interface IClientOptions {
|
||||||
|
serverAddress: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* this class is for client side only!!!
|
||||||
|
* allows connecting to a universe server
|
||||||
|
*/
|
||||||
|
export class ClientUniverse {
|
||||||
|
public options;
|
||||||
|
public smartsocketClient: plugins.smartsocket.SmartsocketClient;
|
||||||
|
public observableIntake: plugins.smartrx.ObservableIntake<ClientUniverseMessage>;
|
||||||
|
public clientUniverseCache = new ClientUniverseCache();
|
||||||
|
|
||||||
|
constructor(optionsArg: IClientOptions) {
|
||||||
|
this.options = optionsArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a channel to the channelcache
|
||||||
|
* TODO: verify channel before adding it to the channel cache
|
||||||
|
*/
|
||||||
|
public addChannel(channelNameArg: string, passphraseArg: string) {
|
||||||
|
const existingChannel = this.getChannel(channelNameArg);
|
||||||
|
|
||||||
|
if (existingChannel) {
|
||||||
|
throw new Error('channel exists');
|
||||||
|
}
|
||||||
|
|
||||||
|
// lets create the channel
|
||||||
|
const clientUniverseChannel = ClientUniverseChannel.createClientUniverseChannel(
|
||||||
|
this,
|
||||||
|
channelNameArg,
|
||||||
|
passphraseArg
|
||||||
|
);
|
||||||
|
return clientUniverseChannel;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets a channel from the channelcache
|
||||||
|
* @param channelName
|
||||||
|
* @param passphraseArg
|
||||||
|
*/
|
||||||
|
public getChannel(channelName: string): ClientUniverseChannel {
|
||||||
|
const clientUniverseChannel = this.clientUniverseCache.channelMap.find(channel => {
|
||||||
|
return channel.name === channelName;
|
||||||
|
});
|
||||||
|
return clientUniverseChannel;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* remove a a achannel
|
||||||
|
* @param messageArg
|
||||||
|
*/
|
||||||
|
public removeChannel(channelNameArg, notifyServer = true) {
|
||||||
|
const clientUniverseChannel = this.clientUniverseCache.channelMap.findOneAndRemove(
|
||||||
|
channelItemArg => {
|
||||||
|
return channelItemArg.name === channelNameArg;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async start() {
|
||||||
|
await this.checkConnection();
|
||||||
|
}
|
||||||
|
|
||||||
|
public stop() {
|
||||||
|
this.smartsocketClient.disconnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* checks the connection towards a universe server
|
||||||
|
* since password validation is done through other means, a connection should always be possible
|
||||||
|
*/
|
||||||
|
public async checkConnection(): Promise<void> {
|
||||||
|
if (!this.smartsocketClient && !this.observableIntake) {
|
||||||
|
const parsedURL = url.parse(this.options.serverAddress);
|
||||||
|
const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
|
||||||
|
alias: 'universeclient',
|
||||||
|
password: 'UniverseClient',
|
||||||
|
port: parseInt(parsedURL.port, 10),
|
||||||
|
role: 'UniverseClient',
|
||||||
|
url: parsedURL.protocol + '//' + parsedURL.hostname
|
||||||
|
};
|
||||||
|
this.smartsocketClient = new SmartsocketClient(socketConfig);
|
||||||
|
this.observableIntake = new plugins.smartrx.ObservableIntake();
|
||||||
|
|
||||||
|
// lets define some basic actions
|
||||||
|
|
||||||
|
/**
|
||||||
|
* should handle a forced unsubscription by the server
|
||||||
|
*/
|
||||||
|
const socketFunctionUnsubscribe = new plugins.smartsocket.SocketFunction({
|
||||||
|
funcName: 'unsubscribe',
|
||||||
|
allowedRoles: [],
|
||||||
|
funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {
|
||||||
|
throw new Error('TODO');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* handles message reception
|
||||||
|
*/
|
||||||
|
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
|
||||||
|
funcName: 'processMessage',
|
||||||
|
allowedRoles: [],
|
||||||
|
funcDef: async (messageDescriptorArg: interfaces.IUniverseMessage) => {
|
||||||
|
plugins.smartlog.defaultLogger.log('info', 'Got message from server');
|
||||||
|
this.observableIntake.push(
|
||||||
|
ClientUniverseMessage.createMessageFromMessageDescriptor(messageDescriptorArg)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// add functions
|
||||||
|
this.smartsocketClient.addSocketFunction(socketFunctionUnsubscribe);
|
||||||
|
this.smartsocketClient.addSocketFunction(socketFunctionProcessMessage);
|
||||||
|
|
||||||
|
await this.smartsocketClient.connect();
|
||||||
|
plugins.smartlog.defaultLogger.log('info', 'universe client connected successfully');
|
||||||
|
await this.clientUniverseCache.channelMap.forEach(async clientUniverseChannelArg => {
|
||||||
|
await clientUniverseChannelArg.subscribe();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
11
ts/smartuniverse.classes.clientuniversecache.ts
Normal file
11
ts/smartuniverse.classes.clientuniversecache.ts
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
import { ClientUniverseChannel } from './smartuniverse.classes.clientuniversechannel';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a cache for clients
|
||||||
|
* keeps track of which messages have already been received
|
||||||
|
* good for deduplication in mesh environments
|
||||||
|
*/
|
||||||
|
export class ClientUniverseCache {
|
||||||
|
public channelMap = new plugins.lik.Objectmap<ClientUniverseChannel>();
|
||||||
|
}
|
83
ts/smartuniverse.classes.clientuniversechannel.ts
Normal file
83
ts/smartuniverse.classes.clientuniversechannel.ts
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
|
import { ClientUniverse } from './';
|
||||||
|
|
||||||
|
export class ClientUniverseChannel implements interfaces.IUniverseChannel {
|
||||||
|
// ======
|
||||||
|
// STATIC
|
||||||
|
// ======
|
||||||
|
/**
|
||||||
|
* creates a channel and adds it to the cache of clientUniverseArg
|
||||||
|
* @param clientUniverseArg
|
||||||
|
* @param channelNameArg
|
||||||
|
* @param passphraseArg
|
||||||
|
*/
|
||||||
|
public static createClientUniverseChannel(
|
||||||
|
clientUniverseArg: ClientUniverse,
|
||||||
|
channelNameArg: string,
|
||||||
|
passphraseArg: string
|
||||||
|
): ClientUniverseChannel {
|
||||||
|
const clientChannel = new ClientUniverseChannel(
|
||||||
|
clientUniverseArg,
|
||||||
|
channelNameArg,
|
||||||
|
passphraseArg
|
||||||
|
);
|
||||||
|
clientUniverseArg.clientUniverseCache.channelMap.add(clientChannel);
|
||||||
|
return clientChannel;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ========
|
||||||
|
// INSTANCE
|
||||||
|
// ========
|
||||||
|
|
||||||
|
// properties
|
||||||
|
public name: string;
|
||||||
|
public passphrase: string;
|
||||||
|
|
||||||
|
// refs
|
||||||
|
public clientUniverseRef: ClientUniverse;
|
||||||
|
|
||||||
|
constructor(clientUniverseArg: ClientUniverse, nameArg: string, passphraseArg: string) {
|
||||||
|
this.clientUniverseRef = clientUniverseArg;
|
||||||
|
this.name = nameArg;
|
||||||
|
this.passphrase = passphraseArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* subscribes to a channel
|
||||||
|
* tells the universe about this instances interest into a channel
|
||||||
|
*/
|
||||||
|
public async subscribe() {
|
||||||
|
const serverCallActionName: interfaces.IServerCallActions = 'channelSubscription';
|
||||||
|
const serverCallActionPayload: interfaces.IServerCallSubscribeActionPayload = {
|
||||||
|
name: this.name,
|
||||||
|
passphrase: this.passphrase
|
||||||
|
};
|
||||||
|
await this.clientUniverseRef.smartsocketClient.serverCall(
|
||||||
|
serverCallActionName,
|
||||||
|
serverCallActionPayload
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sends a message towards the server
|
||||||
|
* @param messageArg
|
||||||
|
*/
|
||||||
|
public async sendMessage(messageArg: interfaces.IMessageCreator) {
|
||||||
|
await this.clientUniverseRef.checkConnection();
|
||||||
|
const universeMessageToSend: interfaces.IUniverseMessage = {
|
||||||
|
id: plugins.smartunique.shortId(),
|
||||||
|
timestamp: Date.now(),
|
||||||
|
passphrase: this.passphrase,
|
||||||
|
targetChannelName: this.name,
|
||||||
|
messageText: messageArg.messageText,
|
||||||
|
payload: messageArg.payload,
|
||||||
|
payloadStringType: messageArg.payloadStringType
|
||||||
|
};
|
||||||
|
await this.clientUniverseRef.smartsocketClient.serverCall(
|
||||||
|
'processMessage',
|
||||||
|
universeMessageToSend
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
39
ts/smartuniverse.classes.clientuniversemessage.ts
Normal file
39
ts/smartuniverse.classes.clientuniversemessage.ts
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
|
export class ClientUniverseMessage implements interfaces.IUniverseMessage {
|
||||||
|
// ======
|
||||||
|
// STATIC
|
||||||
|
// ======
|
||||||
|
public static createMessageFromMessageDescriptor(messageDescriptor: interfaces.IUniverseMessage) {
|
||||||
|
const clientuniverseMessage = new ClientUniverseMessage(messageDescriptor);
|
||||||
|
return clientuniverseMessage;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ========
|
||||||
|
// INSTANCE
|
||||||
|
// ========
|
||||||
|
|
||||||
|
// properties
|
||||||
|
public id: string;
|
||||||
|
|
||||||
|
public timestamp: number;
|
||||||
|
public smartTimestamp: plugins.smarttime.TimeStamp;
|
||||||
|
public messageText: string;
|
||||||
|
public passphrase: string;
|
||||||
|
public payload: any;
|
||||||
|
public payloadStringType;
|
||||||
|
public targetChannelName: string;
|
||||||
|
|
||||||
|
constructor(messageArg: interfaces.IUniverseMessage) {
|
||||||
|
for (const key of Object.keys(messageArg)) {
|
||||||
|
this[key] = messageArg[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets json for payload
|
||||||
|
*/
|
||||||
|
getAsJsonForPayload() {}
|
||||||
|
}
|
@ -1,42 +0,0 @@
|
|||||||
import * as plugins from './smartuniverse.plugins';
|
|
||||||
|
|
||||||
import { Handler, Route, Server } from 'smartexpress';
|
|
||||||
|
|
||||||
import * as paths from './smartuniverse.paths';
|
|
||||||
|
|
||||||
export interface ISmartUniverseConstructorOptions {
|
|
||||||
port: number | string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class SmartUniverse {
|
|
||||||
private options: ISmartUniverseConstructorOptions;
|
|
||||||
private universeVersionStore: string;
|
|
||||||
private get universeVersion() {
|
|
||||||
if (this.universeVersionStore) {
|
|
||||||
return this.universeVersionStore;
|
|
||||||
} else {
|
|
||||||
const packageJson = plugins.smartfile.fs.toObjectSync(paths.packageJson);
|
|
||||||
this.universeVersionStore = packageJson.version;
|
|
||||||
return this.universeVersionStore;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
private smartexpressServer: plugins.smartexpress.Server;
|
|
||||||
constructor(optionsArg: ISmartUniverseConstructorOptions) {
|
|
||||||
this.options = optionsArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async init() {
|
|
||||||
this.smartexpressServer = new plugins.smartexpress.Server({
|
|
||||||
cors: true,
|
|
||||||
defaultAnswer: `smartuniverse server ${this.universeVersion}`,
|
|
||||||
forceSsl: false,
|
|
||||||
port: this.options.port
|
|
||||||
});
|
|
||||||
|
|
||||||
const addRoute = new Route(this.smartexpressServer, 'addMessage');
|
|
||||||
const addHandler = new Handler('PUT', requestBody => {
|
|
||||||
return 'hi';
|
|
||||||
});
|
|
||||||
// await this.smartexpressServer.addRoute()
|
|
||||||
}
|
|
||||||
}
|
|
183
ts/smartuniverse.classes.universe.ts
Normal file
183
ts/smartuniverse.classes.universe.ts
Normal file
@ -0,0 +1,183 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
|
||||||
|
import { Handler, Route, Server } from '@pushrocks/smartexpress';
|
||||||
|
import { UniverseCache, UniverseChannel, UniverseMessage } from './';
|
||||||
|
|
||||||
|
import * as paths from './smartuniverse.paths';
|
||||||
|
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||||
|
|
||||||
|
export interface ISmartUniverseConstructorOptions {
|
||||||
|
messageExpiryInMilliseconds: number;
|
||||||
|
externalServer?: plugins.smartexpress.Server;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* main class that setups a Universe
|
||||||
|
*/
|
||||||
|
export class Universe {
|
||||||
|
// subinstances
|
||||||
|
public universeCache: UniverseCache;
|
||||||
|
|
||||||
|
// options
|
||||||
|
private options: ISmartUniverseConstructorOptions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the smartexpress server used
|
||||||
|
*/
|
||||||
|
private smartexpressServer: plugins.smartexpress.Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the smartsocket used
|
||||||
|
*/
|
||||||
|
private smartsocket: plugins.smartsocket.Smartsocket;
|
||||||
|
|
||||||
|
constructor(optionsArg: ISmartUniverseConstructorOptions) {
|
||||||
|
this.options = optionsArg;
|
||||||
|
this.universeCache = new UniverseCache(this, this.options.messageExpiryInMilliseconds);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stores the version of the universe server running
|
||||||
|
* this is done since the version is exposed through the api and multiple fs actions are avoided this way.
|
||||||
|
*/
|
||||||
|
private universeVersionStore: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the currently running version of smartuniverse
|
||||||
|
*/
|
||||||
|
public getUniverseVersion() {
|
||||||
|
if (this.universeVersionStore) {
|
||||||
|
return this.universeVersionStore;
|
||||||
|
} else {
|
||||||
|
const packageJson = plugins.smartfile.fs.toObjectSync(paths.packageJson);
|
||||||
|
this.universeVersionStore = packageJson.version;
|
||||||
|
return this.universeVersionStore;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a channel to the Universe
|
||||||
|
*/
|
||||||
|
public addChannel(nameArg: string, passphraseArg: string) {
|
||||||
|
const newChannel = UniverseChannel.createChannel(this, nameArg, passphraseArg);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* initiates a server
|
||||||
|
*/
|
||||||
|
public async start(portArg: number) {
|
||||||
|
// lets create the base smartexpress server
|
||||||
|
if (!this.options.externalServer) {
|
||||||
|
this.smartexpressServer = new plugins.smartexpress.Server({
|
||||||
|
cors: true,
|
||||||
|
defaultAnswer: async () => {
|
||||||
|
return `smartuniverse server ${this.getUniverseVersion()}`;
|
||||||
|
},
|
||||||
|
forceSsl: false,
|
||||||
|
port: portArg
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
console.log('Universe is using externally supplied server');
|
||||||
|
this.smartexpressServer = this.options.externalServer;
|
||||||
|
}
|
||||||
|
|
||||||
|
// add websocket upgrade
|
||||||
|
this.smartsocket = new plugins.smartsocket.Smartsocket({});
|
||||||
|
|
||||||
|
// add a role for the clients
|
||||||
|
const ClientRole = new plugins.smartsocket.SocketRole({
|
||||||
|
name: 'UniverseClient',
|
||||||
|
passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
|
||||||
|
});
|
||||||
|
|
||||||
|
// add the role to smartsocket
|
||||||
|
this.smartsocket.addSocketRoles([ClientRole]);
|
||||||
|
|
||||||
|
const socketFunctionSubscription = new plugins.smartsocket.SocketFunction({
|
||||||
|
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||||
|
funcName: 'channelSubscription',
|
||||||
|
funcDef: async (
|
||||||
|
dataArg: interfaces.IServerCallSubscribeActionPayload,
|
||||||
|
socketConnectionArg
|
||||||
|
) => {
|
||||||
|
// run in "this context" of this class
|
||||||
|
await (async () => {
|
||||||
|
const universeConnection = new UniverseConnection({
|
||||||
|
socketConnection: socketConnectionArg,
|
||||||
|
authenticationRequests: [dataArg]
|
||||||
|
});
|
||||||
|
await UniverseConnection.addConnectionToCache(this, universeConnection);
|
||||||
|
return {
|
||||||
|
'subscription status': 'success'
|
||||||
|
};
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const socketFunctionProcessMessage = new plugins.smartsocket.SocketFunction({
|
||||||
|
allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
|
||||||
|
funcName: 'processMessage',
|
||||||
|
funcDef: async (dataArg: interfaces.IUniverseMessage, socketConnectionArg) => {
|
||||||
|
// run in "this" context of this class
|
||||||
|
await (async () => {
|
||||||
|
const universeConnection = UniverseConnection.findUniverseConnectionBySocketConnection(
|
||||||
|
this.universeCache,
|
||||||
|
socketConnectionArg
|
||||||
|
);
|
||||||
|
if (universeConnection) {
|
||||||
|
plugins.smartlog.defaultLogger.log(
|
||||||
|
'ok',
|
||||||
|
'found UniverseConnection for socket for incoming message'
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
plugins.smartlog.defaultLogger.log(
|
||||||
|
'warn',
|
||||||
|
'found no Authorized channel for incoming message'
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
error: 'You need to authenticate for a channel'
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const unauthenticatedMessage = UniverseMessage.createMessageFromPayload(
|
||||||
|
socketConnectionArg,
|
||||||
|
dataArg
|
||||||
|
);
|
||||||
|
const foundChannel = await UniverseChannel.authorizeAMessageForAChannel(
|
||||||
|
this.universeCache,
|
||||||
|
unauthenticatedMessage
|
||||||
|
);
|
||||||
|
if (foundChannel && unauthenticatedMessage.authenticated) {
|
||||||
|
const authenticatedMessage = unauthenticatedMessage;
|
||||||
|
await this.universeCache.addMessage(authenticatedMessage);
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// add socket functions
|
||||||
|
this.smartsocket.addSocketFunction(socketFunctionSubscription);
|
||||||
|
this.smartsocket.addSocketFunction(socketFunctionProcessMessage);
|
||||||
|
|
||||||
|
// start the server
|
||||||
|
if (!this.options.externalServer) {
|
||||||
|
await this.smartexpressServer.start();
|
||||||
|
}
|
||||||
|
|
||||||
|
// add smartsocket to the running smartexpress app
|
||||||
|
await this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer);
|
||||||
|
await this.smartsocket.start();
|
||||||
|
plugins.smartlog.defaultLogger.log('success', 'started universe');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stop everything
|
||||||
|
*/
|
||||||
|
public async stopServer() {
|
||||||
|
await this.smartsocket.stop();
|
||||||
|
if (!this.options.externalServer) {
|
||||||
|
await this.smartexpressServer.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
80
ts/smartuniverse.classes.universecache.ts
Normal file
80
ts/smartuniverse.classes.universecache.ts
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
|
||||||
|
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||||
|
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||||
|
|
||||||
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
|
|
||||||
|
import { Observable, from } from 'rxjs';
|
||||||
|
import { filter } from 'rxjs/operators';
|
||||||
|
import { rxjs } from '@pushrocks/smartrx';
|
||||||
|
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||||
|
import { Universe } from './smartuniverse.classes.universe';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* universe store handles the creation, storage and retrieval of messages.
|
||||||
|
*/
|
||||||
|
export class UniverseCache {
|
||||||
|
// ========
|
||||||
|
// INSTANCE
|
||||||
|
// ========
|
||||||
|
public standardMessageExpiry: number;
|
||||||
|
public destructionTime: number = 60000;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stores messages for this instance
|
||||||
|
*/
|
||||||
|
public messageMap = new Objectmap<UniverseMessage>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stores the channels that are available within the universe
|
||||||
|
*/
|
||||||
|
public channelMap = new Objectmap<UniverseChannel>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stores all connections
|
||||||
|
*/
|
||||||
|
public connectionMap = new plugins.lik.Objectmap<UniverseConnection>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* allows messages to be processed in a blacklist mode for further analysis
|
||||||
|
*/
|
||||||
|
public blackListChannel: UniverseChannel;
|
||||||
|
|
||||||
|
public universeRef: Universe;
|
||||||
|
|
||||||
|
constructor(universeArg: Universe, standardMessageExpiryArg: number) {
|
||||||
|
this.universeRef = universeArg;
|
||||||
|
this.standardMessageExpiry = standardMessageExpiryArg;
|
||||||
|
this.blackListChannel = new UniverseChannel(this.universeRef, 'blacklist', 'nada');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* add a message to the UniverseCache
|
||||||
|
* @param messageArg
|
||||||
|
* @param attachedPayloadArg
|
||||||
|
*/
|
||||||
|
public async addMessage(messageArg: UniverseMessage) {
|
||||||
|
messageArg.setUniverseCache(this);
|
||||||
|
UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
|
||||||
|
this.messageMap.add(messageArg);
|
||||||
|
messageArg.universeChannelList.forEach(universeChannel => {
|
||||||
|
universeChannel.pushToClients(messageArg);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a message from the UniverseCache
|
||||||
|
*/
|
||||||
|
public readMessagesYoungerThan(
|
||||||
|
unixTimeArg?: number,
|
||||||
|
channelName?: string
|
||||||
|
): Observable<UniverseMessage> {
|
||||||
|
const messageObservable = from(this.messageMap.getArray()).pipe(
|
||||||
|
filter(messageArg => {
|
||||||
|
return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
|
||||||
|
})
|
||||||
|
);
|
||||||
|
return messageObservable;
|
||||||
|
}
|
||||||
|
}
|
142
ts/smartuniverse.classes.universechannel.ts
Normal file
142
ts/smartuniverse.classes.universechannel.ts
Normal file
@ -0,0 +1,142 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
|
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||||
|
import { UniverseMessage } from './smartuniverse.classes.universemessage';
|
||||||
|
import { UniverseConnection } from './smartuniverse.classes.universeconnection';
|
||||||
|
import { Universe } from './smartuniverse.classes.universe';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* enables messages to stay within a certain scope.
|
||||||
|
*/
|
||||||
|
export class UniverseChannel {
|
||||||
|
// ======
|
||||||
|
// STATIC
|
||||||
|
// ======
|
||||||
|
|
||||||
|
/**
|
||||||
|
* creates new channels
|
||||||
|
* @param channelArg the name of the topic
|
||||||
|
* @param passphraseArg the secret thats used for a certain topic.
|
||||||
|
*/
|
||||||
|
public static createChannel(
|
||||||
|
universeArg: Universe,
|
||||||
|
channelNameArg: string,
|
||||||
|
passphraseArg: string
|
||||||
|
) {
|
||||||
|
const newChannel = new UniverseChannel(universeArg, channelNameArg, passphraseArg);
|
||||||
|
universeArg.universeCache.channelMap.add(newChannel);
|
||||||
|
return newChannel;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* returns boolean wether certain channel exists
|
||||||
|
*/
|
||||||
|
public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
|
||||||
|
const channel = universeCacheArg.channelMap.find(channelArg => {
|
||||||
|
return channelArg.name === channelNameArg;
|
||||||
|
});
|
||||||
|
if (channel) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a static message authorization function that takes the UniverseCache
|
||||||
|
* (where messages and channels are stored and their lifetime is managed)
|
||||||
|
* and the universemessage to find a fitting channel for the message
|
||||||
|
* @param universeCacheArg
|
||||||
|
* @param universeMessageArg
|
||||||
|
*/
|
||||||
|
public static authorizeAMessageForAChannel(
|
||||||
|
universeCacheArg: UniverseCache,
|
||||||
|
universeMessageArg: UniverseMessage
|
||||||
|
): UniverseChannel {
|
||||||
|
const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
|
||||||
|
const result = universeChannel.authenticate(universeMessageArg);
|
||||||
|
return result;
|
||||||
|
});
|
||||||
|
if (foundChannel) {
|
||||||
|
universeMessageArg.authenticated = true;
|
||||||
|
universeMessageArg.universeChannelList.add(foundChannel);
|
||||||
|
plugins.smartlog.defaultLogger.log('ok', 'message authorized');
|
||||||
|
return foundChannel;
|
||||||
|
} else {
|
||||||
|
universeMessageArg.authenticated = false;
|
||||||
|
universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
|
||||||
|
plugins.smartlog.defaultLogger.log('warn', 'message not valid');
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static getUniverseChannelByName(universeRef: Universe, universeChannelName: string) {
|
||||||
|
return universeRef.universeCache.channelMap.find(channelArg => {
|
||||||
|
return channelArg.name === universeChannelName;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// ========
|
||||||
|
// INSTANCE
|
||||||
|
// ========
|
||||||
|
/**
|
||||||
|
* the name of the channel
|
||||||
|
*/
|
||||||
|
public name: string;
|
||||||
|
public universeRef: Universe;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the passphrase for the channel
|
||||||
|
*/
|
||||||
|
public passphrase: string;
|
||||||
|
|
||||||
|
constructor(universeArg: Universe, channelNameArg: string, passphraseArg: string) {
|
||||||
|
this.universeRef = universeArg;
|
||||||
|
this.name = channelNameArg;
|
||||||
|
this.passphrase = passphraseArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* authenticates a client on the server side by matching
|
||||||
|
* # the messages channelName against the unverseChannel's name
|
||||||
|
* # the messages password against the universeChannel's password
|
||||||
|
*/
|
||||||
|
public authenticate(universeMessageArg: UniverseMessage): boolean {
|
||||||
|
return (
|
||||||
|
this.name === universeMessageArg.targetChannelName &&
|
||||||
|
this.passphrase === universeMessageArg.passphrase
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* pushes a message to clients
|
||||||
|
* @param messageArg
|
||||||
|
*/
|
||||||
|
public async pushToClients(messageArg: UniverseMessage) {
|
||||||
|
const universeConnectionsWithChannelAccess: UniverseConnection[] = [];
|
||||||
|
this.universeRef.universeCache.connectionMap.forEach(async socketConnection => {
|
||||||
|
if (socketConnection.authenticatedChannels.includes(this)) {
|
||||||
|
universeConnectionsWithChannelAccess.push(socketConnection);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
for (const universeConnection of universeConnectionsWithChannelAccess) {
|
||||||
|
const smartsocket = universeConnection.socketConnection
|
||||||
|
.smartsocketRef as plugins.smartsocket.Smartsocket;
|
||||||
|
const universeMessageToSend: interfaces.IUniverseMessage = {
|
||||||
|
id: messageArg.id,
|
||||||
|
timestamp: messageArg.timestamp,
|
||||||
|
passphrase: messageArg.passphrase,
|
||||||
|
targetChannelName: this.name,
|
||||||
|
messageText: messageArg.messageText,
|
||||||
|
payload: messageArg.payload,
|
||||||
|
payloadStringType: messageArg.payloadStringType
|
||||||
|
};
|
||||||
|
smartsocket.clientCall(
|
||||||
|
'processMessage',
|
||||||
|
universeMessageToSend,
|
||||||
|
universeConnection.socketConnection
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
121
ts/smartuniverse.classes.universeconnection.ts
Normal file
121
ts/smartuniverse.classes.universeconnection.ts
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||||
|
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||||
|
import { Universe } from './smartuniverse.classes.universe';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* represents a connection to the universe
|
||||||
|
*/
|
||||||
|
export class UniverseConnection {
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param universeConnectionArg
|
||||||
|
*/
|
||||||
|
public static async addConnectionToCache(
|
||||||
|
universeRef: Universe,
|
||||||
|
universeConnectionArg: UniverseConnection
|
||||||
|
) {
|
||||||
|
let universeConnection = universeConnectionArg;
|
||||||
|
universeConnection = await UniverseConnection.deduplicateUniverseConnection(
|
||||||
|
universeRef.universeCache,
|
||||||
|
universeConnection
|
||||||
|
);
|
||||||
|
universeConnection = await UniverseConnection.authenticateAuthenticationRequests(
|
||||||
|
universeRef,
|
||||||
|
universeConnection
|
||||||
|
);
|
||||||
|
universeRef.universeCache.connectionMap.add(universeConnection);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* deduplicates UniverseConnections
|
||||||
|
*/
|
||||||
|
public static async deduplicateUniverseConnection(
|
||||||
|
universeCache: UniverseCache,
|
||||||
|
universeConnectionArg: UniverseConnection
|
||||||
|
): Promise<UniverseConnection> {
|
||||||
|
let connectionToReturn: UniverseConnection;
|
||||||
|
universeCache.connectionMap.forEach(async existingConnection => {
|
||||||
|
if (existingConnection.socketConnection === universeConnectionArg.socketConnection) {
|
||||||
|
connectionToReturn = await this.mergeUniverseConnections(
|
||||||
|
existingConnection,
|
||||||
|
universeConnectionArg
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
if (!connectionToReturn) {
|
||||||
|
connectionToReturn = universeConnectionArg;
|
||||||
|
}
|
||||||
|
return connectionToReturn;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* authenticate AuthenticationRequests
|
||||||
|
*/
|
||||||
|
public static async authenticateAuthenticationRequests(
|
||||||
|
universeRef: Universe,
|
||||||
|
universeConnectionArg: UniverseConnection
|
||||||
|
): Promise<UniverseConnection> {
|
||||||
|
for (const authenticationRequest of universeConnectionArg.authenticationRequests) {
|
||||||
|
const universeChannelToAuthenticateAgainst = UniverseChannel.getUniverseChannelByName(
|
||||||
|
universeRef,
|
||||||
|
authenticationRequest.name
|
||||||
|
);
|
||||||
|
if (universeChannelToAuthenticateAgainst.passphrase === authenticationRequest.passphrase) {
|
||||||
|
universeConnectionArg.authenticatedChannels.push(universeChannelToAuthenticateAgainst);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return universeConnectionArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* merges two UniverseConnections
|
||||||
|
*/
|
||||||
|
public static mergeUniverseConnections(
|
||||||
|
connectionArg1: UniverseConnection,
|
||||||
|
connectionArg2: UniverseConnection
|
||||||
|
) {
|
||||||
|
return connectionArg1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* finds a UniverseConnection by providing a socket connection
|
||||||
|
*/
|
||||||
|
public static findUniverseConnectionBySocketConnection(
|
||||||
|
universeCache: UniverseCache,
|
||||||
|
socketConnectionArg: plugins.smartsocket.SocketConnection
|
||||||
|
): UniverseConnection {
|
||||||
|
const universeConnection = universeCache.connectionMap.find(universeConnectionArg => {
|
||||||
|
return universeConnectionArg.socketConnection === socketConnectionArg;
|
||||||
|
});
|
||||||
|
return universeConnection;
|
||||||
|
}
|
||||||
|
|
||||||
|
public terminatedDeferred = plugins.smartpromise.defer();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the socketClient to ping
|
||||||
|
*/
|
||||||
|
public socketConnection: plugins.smartsocket.SocketConnection;
|
||||||
|
public authenticationRequests: interfaces.IServerCallSubscribeActionPayload[] = [];
|
||||||
|
public subscribedChannels: UniverseChannel[] = [];
|
||||||
|
public authenticatedChannels: UniverseChannel[] = [];
|
||||||
|
public failedToJoinChannels: UniverseChannel[] = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* terminates the connection
|
||||||
|
*/
|
||||||
|
public terminateConnection() {
|
||||||
|
this.socketConnection.socket.disconnect();
|
||||||
|
this.terminatedDeferred.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
constructor(optionsArg: {
|
||||||
|
socketConnection: plugins.smartsocket.SocketConnection;
|
||||||
|
authenticationRequests: interfaces.IServerCallSubscribeActionPayload[];
|
||||||
|
}) {
|
||||||
|
this.authenticationRequests = optionsArg.authenticationRequests;
|
||||||
|
this.socketConnection = optionsArg.socketConnection;
|
||||||
|
}
|
||||||
|
}
|
108
ts/smartuniverse.classes.universemessage.ts
Normal file
108
ts/smartuniverse.classes.universemessage.ts
Normal file
@ -0,0 +1,108 @@
|
|||||||
|
import * as plugins from './smartuniverse.plugins';
|
||||||
|
import * as interfaces from './interfaces';
|
||||||
|
|
||||||
|
import { Objectmap } from '@pushrocks/lik';
|
||||||
|
|
||||||
|
import { Timer, TimeStamp } from '@pushrocks/smarttime';
|
||||||
|
import { Universe } from './smartuniverse.classes.universe';
|
||||||
|
import { UniverseChannel } from './smartuniverse.classes.universechannel';
|
||||||
|
import { UniverseCache } from './smartuniverse.classes.universecache';
|
||||||
|
import { SocketConnection } from '@pushrocks/smartsocket';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* represents a message within a universe
|
||||||
|
* acts as a container to save message states like authentication status
|
||||||
|
*/
|
||||||
|
export class UniverseMessage implements interfaces.IUniverseMessage {
|
||||||
|
public static createMessageFromPayload(
|
||||||
|
socketConnectionArg: SocketConnection,
|
||||||
|
dataArg: interfaces.IUniverseMessage
|
||||||
|
) {
|
||||||
|
const universeMessageInstance = new UniverseMessage(dataArg);
|
||||||
|
universeMessageInstance.socketConnection = socketConnectionArg;
|
||||||
|
return universeMessageInstance;
|
||||||
|
}
|
||||||
|
|
||||||
|
public id: string;
|
||||||
|
public timestamp: number;
|
||||||
|
public smartTimestamp: TimeStamp;
|
||||||
|
public messageText: string;
|
||||||
|
public passphrase: string;
|
||||||
|
public payload: any;
|
||||||
|
public payloadStringType;
|
||||||
|
public targetChannelName: string;
|
||||||
|
public socketConnection: SocketConnection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the UniverseCache the message is attached to
|
||||||
|
*/
|
||||||
|
public universeCache: UniverseCache;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* enables unprotected grouping of messages for efficiency purposes.
|
||||||
|
*/
|
||||||
|
public universeChannelList = new Objectmap<UniverseChannel>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* wether the message is authenticated
|
||||||
|
*/
|
||||||
|
public authenticated: boolean = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* a destruction timer for this message
|
||||||
|
*/
|
||||||
|
public destructionTimer: Timer; // a timer to take care of message destruction
|
||||||
|
|
||||||
|
/**
|
||||||
|
* the constructor to create a universe message
|
||||||
|
* @param messageArg
|
||||||
|
* @param attachedPayloadArg
|
||||||
|
*/
|
||||||
|
constructor(messageDescriptor: interfaces.IUniverseMessage) {
|
||||||
|
this.smartTimestamp = new TimeStamp(this.timestamp);
|
||||||
|
this.messageText = messageDescriptor.messageText;
|
||||||
|
this.targetChannelName = messageDescriptor.targetChannelName;
|
||||||
|
this.passphrase = messageDescriptor.passphrase;
|
||||||
|
this.payload = messageDescriptor.payload;
|
||||||
|
// prevent memory issues
|
||||||
|
this.fallBackDestruction();
|
||||||
|
}
|
||||||
|
|
||||||
|
public setUniverseCache(universeCacheArg: UniverseCache) {
|
||||||
|
this.universeCache = universeCacheArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
public setTargetChannel() {}
|
||||||
|
|
||||||
|
public setDestructionTimer(selfdestructAfterArg: number) {
|
||||||
|
if (selfdestructAfterArg) {
|
||||||
|
this.destructionTimer = new Timer(selfdestructAfterArg);
|
||||||
|
this.destructionTimer.start();
|
||||||
|
|
||||||
|
// set up self destruction by removing this from the parent messageCache
|
||||||
|
this.destructionTimer.completed.then(async () => {
|
||||||
|
this.universeCache.messageMap.remove(this);
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
this.fallBackDestruction();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* handles bad messages for further analysis
|
||||||
|
*/
|
||||||
|
public handleAsBadMessage() {
|
||||||
|
plugins.smartlog.defaultLogger.log('warn', 'received a bad message');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* prevents memory leaks if channels have no default
|
||||||
|
*/
|
||||||
|
private fallBackDestruction() {
|
||||||
|
plugins.smartdelay.delayFor(1000).then(() => {
|
||||||
|
if (!this.destructionTimer) {
|
||||||
|
this.setDestructionTimer(6000);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
@ -1,13 +0,0 @@
|
|||||||
import * as plugins from './smartuniverse.plugins';
|
|
||||||
|
|
||||||
import { SmartUniverse } from './index';
|
|
||||||
|
|
||||||
process.env.CLI = 'true';
|
|
||||||
|
|
||||||
const universeCli = new plugins.smartcli.Smartcli();
|
|
||||||
|
|
||||||
universeCli.standardTask().then(argvArg => {
|
|
||||||
const standardUniverse = new SmartUniverse({
|
|
||||||
port: 8765
|
|
||||||
});
|
|
||||||
});
|
|
@ -1,6 +1,33 @@
|
|||||||
|
// node native
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
import * as smartcli from 'smartcli';
|
|
||||||
import * as smartexpress from 'smartexpress';
|
|
||||||
import * as smartfile from 'smartfile';
|
|
||||||
|
|
||||||
export { path, smartcli, smartexpress, smartfile };
|
export { path };
|
||||||
|
|
||||||
|
// pushrocks scope
|
||||||
|
import * as lik from '@pushrocks/lik';
|
||||||
|
import * as smarthash from '@pushrocks/smarthash';
|
||||||
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
|
import * as smartexpress from '@pushrocks/smartexpress';
|
||||||
|
import * as smartfile from '@pushrocks/smartfile';
|
||||||
|
import * as smartlog from '@pushrocks/smartlog';
|
||||||
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
import * as smartrequest from '@pushrocks/smartrequest';
|
||||||
|
import * as smartrx from '@pushrocks/smartrx';
|
||||||
|
import * as smartsocket from '@pushrocks/smartsocket';
|
||||||
|
import * as smarttime from '@pushrocks/smarttime';
|
||||||
|
import * as smartunique from '@pushrocks/smartunique';
|
||||||
|
|
||||||
|
export {
|
||||||
|
lik,
|
||||||
|
smarthash,
|
||||||
|
smartdelay,
|
||||||
|
smartexpress,
|
||||||
|
smartfile,
|
||||||
|
smartlog,
|
||||||
|
smartpromise,
|
||||||
|
smartrx,
|
||||||
|
smartrequest,
|
||||||
|
smartsocket,
|
||||||
|
smarttime,
|
||||||
|
smartunique
|
||||||
|
};
|
||||||
|
19
tslint.json
19
tslint.json
@ -1,6 +1,17 @@
|
|||||||
{
|
{
|
||||||
"extends": [
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
"tslint:latest",
|
"rules": {
|
||||||
"tslint-config-prettier"
|
"semicolon": [true, "always"],
|
||||||
]
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
}
|
}
|
Reference in New Issue
Block a user