Compare commits

..

40 Commits

Author SHA1 Message Date
ed2b74d436 3.0.3 2023-07-12 19:21:37 +02:00
0caf48a734 fix(core): update 2023-07-12 19:21:36 +02:00
c4d6402fd9 switch to new org scheme 2023-07-11 00:57:32 +02:00
83bc0c512b switch to new org scheme 2023-07-10 02:56:58 +02:00
102e8faf92 3.0.2 2022-10-26 15:22:54 +02:00
87da0f1169 fix(core): update 2022-10-26 15:22:54 +02:00
b53c49ca28 3.0.1 2022-07-26 21:03:40 +02:00
47bde8b4f8 fix(core): update 2022-07-26 21:03:39 +02:00
d71de485d6 3.0.0 2022-06-26 10:35:35 +02:00
964666902f BREAKING CHANGE(core): switch to esm 2022-06-26 10:35:35 +02:00
d5d6d7bf79 2.0.44 2021-07-21 02:25:22 +02:00
02d10dd08c fix(core): update 2021-07-21 02:25:22 +02:00
4062157544 2.0.43 2021-07-21 01:48:20 +02:00
a673844fb3 fix(core): update 2021-07-21 01:48:20 +02:00
53248a3a3d 2.0.42 2021-07-20 21:30:59 +02:00
0043a553a7 fix(core): update 2021-07-20 21:30:59 +02:00
13981404f3 2.0.41 2021-07-20 21:23:05 +02:00
db951d1877 fix(core): update 2021-07-20 21:23:05 +02:00
26c84b3a04 2.0.40 2021-07-06 19:26:36 +02:00
b3d8cf68f1 fix(core): update 2021-07-06 19:26:35 +02:00
60ae0fed4e 2.0.39 2020-09-08 12:57:25 +00:00
a03e821c02 fix(core): update 2020-09-08 12:57:24 +00:00
592178f066 2.0.38 2020-09-07 23:51:41 +00:00
260af690ff fix(core): update 2020-09-07 23:51:40 +00:00
7bd12e7a01 2.0.37 2020-09-07 21:30:02 +00:00
f8a49e033d fix(core): update 2020-09-07 21:30:02 +00:00
3066503a70 2.0.36 2020-08-02 23:47:20 +00:00
cf899609be fix(core): update 2020-08-02 23:47:19 +00:00
7be0e70754 2.0.35 2020-06-11 14:41:12 +00:00
8b0ceb759d fix(core): update 2020-06-11 14:41:11 +00:00
7b5cfb2c95 2.0.34 2020-06-11 14:28:04 +00:00
a4a5b18849 fix(core): update 2020-06-11 14:28:03 +00:00
47583bd955 2.0.33 2020-06-11 13:50:36 +00:00
018bc7054a fix(core): update 2020-06-11 13:50:35 +00:00
5ca4cb9964 2.0.32 2020-06-11 13:23:08 +00:00
27bb9a789c fix(core): update 2020-06-11 13:23:07 +00:00
5f7e68d5b7 2.0.31 2020-06-11 13:20:50 +00:00
da0edc478c fix(core): update 2020-06-11 13:20:49 +00:00
d2be068597 2.0.30 2020-06-11 10:47:06 +00:00
4113a9a211 fix(core): update 2020-06-11 10:47:05 +00:00
17 changed files with 4772 additions and 4579 deletions

View File

@ -12,6 +12,9 @@ stages:
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
@ -19,23 +22,36 @@ mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- lossless - lossless
- docker - docker
- notpriv - notpriv
audit: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install --ignore-scripts - npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high - npmci command npm audit --audit-level=high --only=dev
tags: tags:
- lossless
- docker - docker
- notpriv allow_failure: true
# ==================== # ====================
# test stage # test stage
@ -50,9 +66,7 @@ testStable:
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- priv
testBuild: testBuild:
stage: test stage: test
@ -63,9 +77,7 @@ testBuild:
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- notpriv
release: release:
stage: release stage: release
@ -85,11 +97,12 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g typescript
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless - lossless
- docker - docker
@ -109,11 +122,10 @@ trigger:
pages: pages:
stage: metadata stage: metadata
script: script:
- npmci node install lts - npmci node install stable
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command npm run buildDocs
tags: tags:
- lossless - lossless
- docker - docker

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${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"
} }
] ]
} }

View File

@ -15,7 +15,7 @@
"properties": { "properties": {
"projectType": { "projectType": {
"type": "string", "type": "string",
"enum": ["website", "element", "service", "npm"] "enum": ["website", "element", "service", "npm", "wcc"]
} }
} }
} }

View File

@ -3,10 +3,10 @@
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartlog", "gitrepo": "smartlog",
"shortDescription": "minimalistic distributed and extensible logging tool", "description": "minimalistic distributed and extensible logging tool",
"npmPackagename": "@pushrocks/smartlog", "npmPackagename": "@push.rocks/smartlog",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks"
} }

4463
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/smartlog", "name": "@push.rocks/smartlog",
"version": "2.0.29", "version": "3.0.3",
"private": false, "private": false,
"description": "minimalistic distributed and extensible logging tool", "description": "minimalistic distributed and extensible logging tool",
"keywords": [ "keywords": [
@ -18,21 +18,20 @@
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild --web && tsbundle npm)", "build": "(tsbuild --web && tsbundle npm)",
"format": "(gitzone format)" "format": "(gitzone format)",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.24", "@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsrun": "^1.2.12", "@gitzone/tsbundle": "^2.0.6",
"@gitzone/tstest": "^1.0.33", "@gitzone/tsrun": "^1.2.17",
"@pushrocks/tapbundle": "^3.2.1", "@gitzone/tstest": "^1.0.72",
"@types/node": "^14.0.13", "@push.rocks/tapbundle": "^5.0.4",
"tslint": "^6.1.2", "@types/node": "^18.6.1"
"tslint-config-prettier": "^1.18.0"
}, },
"dependencies": { "dependencies": {
"@gitzone/tsbundle": "^1.0.69", "@push.rocks/isounique": "^1.0.4",
"@pushrocks/isounique": "^1.0.4", "@push.rocks/smartlog-interfaces": "^3.0.0"
"@pushrocks/smartlog-interfaces": "^2.0.19"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -45,5 +44,9 @@
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
] ],
"browserslist": [
"last 1 chrome versions"
],
"type": "module"
} }

4606
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

48
test/test.browser.ts Normal file
View File

@ -0,0 +1,48 @@
import { expect, tap } from '@push.rocks/tapbundle';
import * as smartlog from '../ts/index.js';
let testConsoleLog: smartlog.ConsoleLog;
let testSmartLog: smartlog.Smartlog;
tap.test('should produce a valid ConsoleLog instance', async () => {
testConsoleLog = new smartlog.ConsoleLog();
testConsoleLog.log('ok', 'this is ok');
});
tap.test('should produce instance of Smartlog', async () => {
testSmartLog = new smartlog.Smartlog({
logContext: {
environment: 'test',
runtime: 'node',
zone: 'gitzone',
company: 'Lossless GmbH',
companyunit: 'Lossless Cloud',
containerName: 'testing',
},
});
});
tap.test('should enable console logging', async () => {
testSmartLog.enableConsole({
captureAll: true,
});
console.log('this is a normal log that should be captured');
console.log(new Error('hi there'));
testSmartLog.log('info', 'this should only be printed once');
});
tap.test('should be able to log things', async () => {
testSmartLog.log('silly', 'hi');
});
tap.test('should create a log group', async () => {
const logGroup = testSmartLog.createLogGroup('some cool transaction');
logGroup.log('info', 'this is logged from a log group');
});
tap.test('should catch error', async () => {
console.error(new Error('hey'));
// throw new Error('hey');
});
tap.start();

View File

@ -1,5 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as smartlog from '../ts/index'; import * as smartlog from '../ts/index.js';
let testConsoleLog: smartlog.ConsoleLog; let testConsoleLog: smartlog.ConsoleLog;
let testSmartLog: smartlog.Smartlog; let testSmartLog: smartlog.Smartlog;
@ -17,14 +17,14 @@ tap.test('should produce instance of Smartlog', async () => {
zone: 'gitzone', zone: 'gitzone',
company: 'Lossless GmbH', company: 'Lossless GmbH',
companyunit: 'Lossless Cloud', companyunit: 'Lossless Cloud',
containerName: 'testing' containerName: 'testing',
} },
}); });
}); });
tap.test('should enable console logging', async () => { tap.test('should enable console logging', async () => {
testSmartLog.enableConsole({ testSmartLog.enableConsole({
captureAll: true captureAll: true,
}); });
console.log('this is a normal log that should be captured'); console.log('this is a normal log that should be captured');
console.log(new Error('hi there')); console.log(new Error('hi there'));
@ -40,4 +40,9 @@ tap.test('should create a log group', async () => {
logGroup.log('info', 'this is logged from a log group'); logGroup.log('info', 'this is logged from a log group');
}); });
tap.test('should catch error', async () => {
console.error(new Error('hey'));
// throw new Error('hey');
});
tap.start(); tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartlog',
version: '3.0.3',
description: 'minimalistic distributed and extensible logging tool'
}

View File

@ -1,6 +1,6 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
import { ConsoleLog } from './smartlog.classes.consolelog'; import { ConsoleLog } from './smartlog.classes.consolelog.js';
import { LogGroup } from './smartlog.classes.loggroup'; import { LogGroup } from './smartlog.classes.loggroup.js';
import { Smartlog } from './smartlog.classes.smartlog'; import { Smartlog } from './smartlog.classes.smartlog.js';
export { ConsoleLog, LogGroup, Smartlog }; export { ConsoleLog, LogGroup, Smartlog };

View File

@ -1,10 +1,15 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
/** /**
* a console log optimized for smartlog * a console log optimized for smartlog
*/ */
export class ConsoleLog { export class ConsoleLog {
public log(logLevelArg: plugins.smartlogInterfaces.TLogLevel, logMessageArg: string) { public log(
logLevelArg: plugins.smartlogInterfaces.TLogLevel,
logMessageArg: string,
dataArg?: any,
correlationArg?: plugins.smartlogInterfaces.ILogCorrelation
) {
console.log(`__# ${logLevelArg}: ${logMessageArg}`); console.log(`__# ${logLevelArg}: ${logMessageArg}`);
} }
} }

View File

@ -1,5 +1,5 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
import { Smartlog } from './smartlog.classes.smartlog'; import { Smartlog } from './smartlog.classes.smartlog.js';
export class LogGroup { export class LogGroup {
public smartlogRef: Smartlog; public smartlogRef: Smartlog;
@ -21,7 +21,7 @@ export class LogGroup {
type: 'none', type: 'none',
group: this.groupId, group: this.groupId,
instance: this.smartlogRef.uniInstanceId, instance: this.smartlogRef.uniInstanceId,
transaction: this.transactionId transaction: this.transactionId,
}); });
} }
} }

View File

@ -1,21 +1,19 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
import { ILogDestination, ILogPackage } from '@pushrocks/smartlog-interfaces';
export class LogRouter { export class LogRouter {
/** /**
* all log destinations * all log destinations
*/ */
private logDestinations: ILogDestination[] = []; private logDestinations: plugins.smartlogInterfaces.ILogDestination[] = [];
constructor() {} constructor() {}
public addLogDestination(logDestination: ILogDestination) { public addLogDestination(logDestination: plugins.smartlogInterfaces.ILogDestination) {
this.logDestinations.push(logDestination); this.logDestinations.push(logDestination);
} }
// routes the log according to added logDestinations // routes the log according to added logDestinations
public async routeLog(logPackageArg: ILogPackage) { public async routeLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
for (const logDestination of this.logDestinations) { for (const logDestination of this.logDestinations) {
await logDestination.handleLog(logPackageArg); await logDestination.handleLog(logPackageArg);
} }

View File

@ -1,7 +1,7 @@
import * as plugins from './smartlog.plugins'; import * as plugins from './smartlog.plugins.js';
import { LogRouter } from './smartlog.classes.logrouter'; import { LogRouter } from './smartlog.classes.logrouter.js';
import { LogGroup } from '.'; import { LogGroup } from './smartlog.classes.loggroup.js';
export interface ISmartlogContructorOptions { export interface ISmartlogContructorOptions {
logContext: plugins.smartlogInterfaces.ILogContext; logContext: plugins.smartlogInterfaces.ILogContext;
@ -9,8 +9,8 @@ export interface ISmartlogContructorOptions {
} }
export class Smartlog implements plugins.smartlogInterfaces.ILogDestination { export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
private logContext: plugins.smartlogInterfaces.ILogContext; public logContext: plugins.smartlogInterfaces.ILogContext;
private minimumLogLevel: plugins.smartlogInterfaces.TLogLevel; public minimumLogLevel: plugins.smartlogInterfaces.TLogLevel;
public uniInstanceId: string = plugins.isounique.uni(); public uniInstanceId: string = plugins.isounique.uni();
@ -24,7 +24,7 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
constructor(optionsArg: ISmartlogContructorOptions) { constructor(optionsArg: ISmartlogContructorOptions) {
this.logContext = optionsArg.logContext; this.logContext = optionsArg.logContext;
this.minimumLogLevel = optionsArg.minimumLogLevel; this.minimumLogLevel = optionsArg.minimumLogLevel || 'silly';
} }
// ============ // ============
@ -35,26 +35,32 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
* enables console logging * enables console logging
*/ */
public enableConsole(optionsArg?: { captureAll: boolean }) { public enableConsole(optionsArg?: { captureAll: boolean }) {
if (process && optionsArg && optionsArg.captureAll) { if (globalThis.process && optionsArg && optionsArg.captureAll) {
const process = globalThis.process;
const write = process.stdout.write; const write = process.stdout.write;
/* import * as fs from 'fs'; process.stdout.write = (...args: any) => {
const fileStream = fs.createWriteStream(plugins.path.join(paths.nogitDir, 'output.txt'), { const logString: string = args[0];
flags: 'a+' if (!logString || typeof logString.startsWith !== 'function') {
}); */ // lets continue as planned
process.stdout.write = (...args) => { } else if (!logString.startsWith('LOG') && typeof logString === 'string') {
if (!args[0].startsWith('LOG')) { switch (true) {
this.log('info', args[0]); case logString.substr(0, 20).includes('Error:'):
return; this.log('error', logString);
break;
default:
this.log('info', logString);
}
return true;
} }
// fileStream.write(args[0]); // fileStream.write(args[0]);
write.apply(process.stdout, args); write.apply(process.stdout, args);
return true; return true;
}; };
process.stderr.write = (...args) => { process.stderr.write = (...args: any) => {
if (!args[0].startsWith('LOG')) { if (!args[0].startsWith('LOG')) {
this.log('info', args[0]); this.log('error', args[0]);
return; return true;
} }
// fileStream.write(args[0]); // fileStream.write(args[0]);
write.apply(process.stderr, args); write.apply(process.stderr, args);
@ -84,9 +90,9 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
...{ ...{
id: plugins.isounique.uni(), id: plugins.isounique.uni(),
type: 'none', type: 'none',
instance: this.uniInstanceId instance: this.uniInstanceId,
}, },
...correlationArg ...correlationArg,
}; };
if (this.consoleEnabled) { if (this.consoleEnabled) {
@ -99,7 +105,7 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
context: this.logContext, context: this.logContext,
level: logLevelArg, level: logLevelArg,
correlation: correlationArg, correlation: correlationArg,
message: logMessageArg message: logMessageArg,
}; };
if (logDataArg) { if (logDataArg) {
logPackage.data = logDataArg; logPackage.data = logDataArg;
@ -113,7 +119,7 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
logDataArg?: any, logDataArg?: any,
correlationArg: plugins.smartlogInterfaces.ILogCorrelation = { correlationArg: plugins.smartlogInterfaces.ILogCorrelation = {
id: plugins.isounique.uni(), id: plugins.isounique.uni(),
type: 'none' type: 'none',
} }
) { ) {
if (this.consoleEnabled) { if (this.consoleEnabled) {
@ -125,12 +131,12 @@ export class Smartlog implements plugins.smartlogInterfaces.ILogDestination {
context: this.logContext, context: this.logContext,
level: logLevelArg, level: logLevelArg,
message: logMessageArg, message: logMessageArg,
correlation: correlationArg correlation: correlationArg,
}); });
} }
public handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) { public async handleLog(logPackageArg: plugins.smartlogInterfaces.ILogPackage) {
this.logRouter.routeLog(logPackageArg); await this.logRouter.routeLog(logPackageArg);
} }
private safeConsoleLog(logLine: string) { private safeConsoleLog(logLine: string) {

View File

@ -1,4 +1,4 @@
import * as isounique from '@pushrocks/isounique'; import * as isounique from '@push.rocks/isounique';
import * as smartlogInterfaces from '@pushrocks/smartlog-interfaces'; import * as smartlogInterfaces from '@push.rocks/smartlog-interfaces';
export { isounique, smartlogInterfaces }; export { isounique, smartlogInterfaces };

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}