Compare commits

...

6 Commits

Author SHA1 Message Date
1266a814c6 2.0.9 2022-10-26 11:00:07 +02:00
25a7397548 fix(core): update 2022-10-26 11:00:06 +02:00
5009bec70c 2.0.8 2022-10-26 10:55:09 +02:00
d8d7b135f7 fix(core): update 2022-10-26 10:55:08 +02:00
9738d88ec7 2.0.7 2022-10-26 10:54:37 +02:00
9d7f433685 fix(core): update 2022-10-26 10:54:36 +02:00
8 changed files with 103 additions and 122 deletions

View File

@@ -12,29 +12,25 @@ stages:
- release
- metadata
before_script:
- pnpm install -g pnpm
- pnpm install -g @shipzone/npmci
- npmci npm prepare
# ====================
# security stage
# ====================
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
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
- npmci command npm config set registry https://registry.npmjs.org
- npmci command pnpm audit --audit-level=high --prod
tags:
- lossless
- docker
allow_failure: true
@@ -42,11 +38,10 @@ auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
- npmci command pnpm audit --audit-level=high --dev
tags:
- lossless
- docker
allow_failure: true
@@ -57,7 +52,6 @@ auditDevDependencies:
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
@@ -68,7 +62,6 @@ testStable:
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
@@ -97,10 +90,9 @@ codequality:
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci command npm install -g typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
@@ -120,11 +112,9 @@ trigger:
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command tsdoc
- npmci command npm run buildDocs
tags:
- lossless
- docker

24
.vscode/launch.json vendored
View File

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

View File

@@ -1,6 +1,6 @@
{
"name": "@apiglobal/typedsocket",
"version": "2.0.6",
"version": "2.0.9",
"private": false,
"description": "a typedrequest extension supporting websockets",
"main": "dist_ts/index.js",
@@ -10,7 +10,8 @@
"license": "MIT",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web --allowimplicitany)"
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.63",
@@ -25,7 +26,7 @@
"@apiglobal/typedrequest": "^2.0.8",
"@apiglobal/typedrequest-interfaces": "^1.0.15",
"@pushrocks/isohash": "^2.0.0",
"@pushrocks/smartjson": "^5.0.2",
"@pushrocks/smartjson": "^5.0.3",
"@pushrocks/smartsocket": "^2.0.7",
"@pushrocks/smartstring": "^4.0.2"
},

18
pnpm-lock.yaml generated
View File

@@ -9,7 +9,7 @@ specifiers:
'@gitzone/tstest': ^1.0.72
'@pushrocks/isohash': ^2.0.0
'@pushrocks/smartenv': ^5.0.2
'@pushrocks/smartjson': ^5.0.2
'@pushrocks/smartjson': ^5.0.3
'@pushrocks/smartsocket': ^2.0.7
'@pushrocks/smartstring': ^4.0.2
'@pushrocks/tapbundle': ^5.0.4
@@ -19,7 +19,7 @@ dependencies:
'@apiglobal/typedrequest': 2.0.12
'@apiglobal/typedrequest-interfaces': 1.0.15
'@pushrocks/isohash': 2.0.0
'@pushrocks/smartjson': 5.0.2
'@pushrocks/smartjson': 5.0.3
'@pushrocks/smartsocket': 2.0.7
'@pushrocks/smartstring': 4.0.5
@@ -468,7 +468,7 @@ packages:
'@pushrocks/smartdelay': 2.0.13
'@pushrocks/smartfile-interfaces': 1.0.7
'@pushrocks/smarthash': 3.0.1
'@pushrocks/smartjson': 5.0.2
'@pushrocks/smartjson': 5.0.3
'@pushrocks/smartmime': 1.0.5
'@pushrocks/smartpath': 5.0.5
'@pushrocks/smartpromise': 3.1.7
@@ -495,7 +495,7 @@ packages:
/@pushrocks/smarthash/3.0.1:
resolution: {integrity: sha512-S9BiLsxTJB4KOXiiqcdp9QHc8srctHQxoWqDNVw7mGJbU6KuCHbFW6NUcEe2us5z389dGNEbbPMy7+0mAdTXVA==}
dependencies:
'@pushrocks/smartjson': 5.0.2
'@pushrocks/smartjson': 5.0.3
'@pushrocks/smartpromise': 3.1.7
'@types/through2': 2.0.36
through2: 4.0.2
@@ -509,8 +509,8 @@ packages:
fast-json-stable-stringify: 2.1.0
lodash.clonedeep: 4.5.0
/@pushrocks/smartjson/5.0.2:
resolution: {integrity: sha512-zYy4jaZhBA0JUnheDinARS82fpQZrwLZZWTBHK40UJ4q2n/a/CvFvNDaN81I1PODubV6dsRF4M0JjLk2VJ5XMA==}
/@pushrocks/smartjson/5.0.3:
resolution: {integrity: sha512-QaRRRDNwgocFR/UiFbXJ8g9gw0UbBKgKz93R9+qms+EbWXHtSiB8VDbSKg2Xvi2FMnf/Df+FMXQKnU9yH+ex+g==}
dependencies:
'@pushrocks/smartstring': 4.0.5
'@types/buffer-json': 2.0.1
@@ -671,7 +671,7 @@ packages:
'@pushrocks/smartdelay': 2.0.13
'@pushrocks/smartenv': 5.0.3
'@pushrocks/smartexpress': 4.0.21
'@pushrocks/smartjson': 5.0.2
'@pushrocks/smartjson': 5.0.3
'@pushrocks/smartlog': 3.0.1
'@pushrocks/smartpromise': 3.1.7
'@pushrocks/smartrx': 2.0.27
@@ -783,7 +783,7 @@ packages:
'@adobe/helix-fetch': 3.1.2
'@pushrocks/smartdelay': 2.0.13
'@pushrocks/smartenv': 5.0.3
'@pushrocks/smartjson': 5.0.2
'@pushrocks/smartjson': 5.0.3
'@pushrocks/smartpromise': 3.1.7
'@pushrocks/webstore': 2.0.5
transitivePeerDependencies:
@@ -795,7 +795,7 @@ packages:
'@apiglobal/typedrequest-interfaces': 1.0.15
'@pushrocks/lik': 6.0.0
'@pushrocks/smartenv': 5.0.3
'@pushrocks/smartjson': 5.0.2
'@pushrocks/smartjson': 5.0.3
'@pushrocks/smartpromise': 3.1.7
'@pushrocks/smartrx': 2.0.27
fake-indexeddb: 4.0.0

View File

@@ -4,17 +4,18 @@ import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
import * as typedsocket from '../ts/index.js';
interface IRequest_Client_Server extends typedrequestInterfaces.implementsTR<
typedrequestInterfaces.ITypedRequest,
IRequest_Client_Server
> {
interface IRequest_Client_Server
extends typedrequestInterfaces.implementsTR<
typedrequestInterfaces.ITypedRequest,
IRequest_Client_Server
> {
method: 'sayhi';
request: {
greeting: string;
};
response: {
answer: string
}
answer: string;
};
}
let testTypedSocketServer: typedsocket.TypedSocket;
@@ -23,45 +24,52 @@ let testTypedSocketClient: typedsocket.TypedSocket;
const testTypedRouter = new typedrequest.TypedRouter();
tap.test('should add some handlers', async () => {
testTypedRouter.addTypedHandler<IRequest_Client_Server>(new typedrequest.TypedHandler('sayhi', async requestData => {
return {
answer: `ok, got it : ${requestData.greeting}`
}
}));
})
testTypedRouter.addTypedHandler<IRequest_Client_Server>(
new typedrequest.TypedHandler('sayhi', async (requestData) => {
return {
answer: `ok, got it : ${requestData.greeting}`,
};
})
);
});
tap.test('should create Server and Client', async (tools) => {
testTypedSocketServer = await typedsocket.TypedSocket.createServer(testTypedRouter);
testTypedSocketClient = await typedsocket.TypedSocket.createClient(testTypedRouter, 'http://localhost:3000');
testTypedSocketClient = await typedsocket.TypedSocket.createClient(
testTypedRouter,
'http://localhost:3000'
);
console.log('test: waiting 5 seconds');
await tools.delayFor(5000);
await testTypedSocketServer.stop();
// lets create another server
testTypedSocketServer = await typedsocket.TypedSocket.createServer(testTypedRouter);
// lets see if auto reconnect works
console.log('test: waiting 21 seconds for reconnect');
await tools.delayFor(21000);
});
tap.test('should process messages from both sides', async () => {
const myServerSideTypedRequest = testTypedSocketServer.createTypedRequest<IRequest_Client_Server>('sayhi');
const myClientSideTypedRequest = testTypedSocketClient.createTypedRequest<IRequest_Client_Server>('sayhi');
const myServerSideTypedRequest =
testTypedSocketServer.createTypedRequest<IRequest_Client_Server>('sayhi');
const myClientSideTypedRequest =
testTypedSocketClient.createTypedRequest<IRequest_Client_Server>('sayhi');
const response = await myClientSideTypedRequest.fire({
greeting: 'that is a greeting from the client'
greeting: 'that is a greeting from the client',
});
console.log(response);
const response2 = await myServerSideTypedRequest.fire({
greeting: 'that is a greeting from the server'
greeting: 'that is a greeting from the server',
});
console.log(response2);
})
});
tap.test('should disconnect', async (tools) => {
await testTypedSocketClient.stop();
await testTypedSocketServer.stop();
tools.delayFor(1000).then(() => process.exit(0));
})
});
tap.start();

View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@apiglobal/typedsocket',
version: '2.0.6',
version: '2.0.9',
description: 'a typedrequest extension supporting websockets'
}

View File

@@ -11,7 +11,7 @@ export class TypedSocket {
* creates a typedsocket server
* note: this will fail in browser environments as server libs are not bundled.
*/
public static async createServer (
public static async createServer(
typedrouterArg: plugins.typedrequest.TypedRouter,
smartexpressServerArg?: any
): Promise<TypedSocket> {
@@ -34,7 +34,7 @@ export class TypedSocket {
const typedsocket = new TypedSocket(
'server',
typedrouterArg,
async <T extends plugins.typedrequestInterfaces.ITypedRequest> (
async <T extends plugins.typedrequestInterfaces.ITypedRequest>(
dataArg: T,
targetConnectionArg?: plugins.smartsocket.SocketConnection
): Promise<T> => {
@@ -43,16 +43,18 @@ export class TypedSocket {
console.log(
'Since no targetConnection was supplied and there is only one active one present, choosing that one automatically'
);
targetConnectionArg = smartsocketServer.socketConnections.getArray()[ 0 ];
targetConnectionArg = smartsocketServer.socketConnections.getArray()[0];
} else {
throw new Error('you need to specify the wanted targetConnection. Currently no target is selectable automatically.');
throw new Error(
'you need to specify the wanted targetConnection. Currently no target is selectable automatically.'
);
}
}
const response: T = await smartsocketServer.clientCall(
const response: T = (await smartsocketServer.clientCall(
'processMessage',
dataArg,
targetConnectionArg
) as any;
)) as any;
return response;
},
smartsocketServer
@@ -62,7 +64,7 @@ export class TypedSocket {
return typedsocket;
}
public static async createClient (
public static async createClient(
typedrouterArg: plugins.typedrequest.TypedRouter,
serverUrlArg: string,
aliasArg = 'clientArg'
@@ -74,8 +76,8 @@ export class TypedSocket {
port: domain.port || 3000,
url: `${domain.nodeParsedUrl.protocol}//${domain.nodeParsedUrl.hostname}`,
autoReconnect: true,
}
console.log(`starting typedsocket with the following settings:`)
};
console.log(`starting typedsocket with the following settings:`);
console.log(socketOptions);
const smartsocketClient = new plugins.smartsocket.SmartsocketClient(socketOptions);
smartsocketClient.addSocketFunction(
@@ -89,8 +91,8 @@ export class TypedSocket {
const typedsocket = new TypedSocket(
'client',
typedrouterArg,
async <T extends plugins.typedrequestInterfaces.ITypedRequest> (dataArg: T): Promise<T> => {
const response: T = (smartsocketClient.serverCall('processMessage', dataArg) as any) as T;
async <T extends plugins.typedrequestInterfaces.ITypedRequest>(dataArg: T): Promise<T> => {
const response: T = smartsocketClient.serverCall('processMessage', dataArg) as any as T;
return response;
},
smartsocketClient
@@ -109,7 +111,9 @@ export class TypedSocket {
typedRequestPostObject: plugins.typedrequestInterfaces.ITypedRequest,
socketConnectionArg?: plugins.smartsocket.SocketConnection
) => Promise<plugins.typedrequestInterfaces.ITypedRequest>);
private socketServerOrClient: plugins.smartsocket.Smartsocket | plugins.smartsocket.SmartsocketClient;
private socketServerOrClient:
| plugins.smartsocket.Smartsocket
| plugins.smartsocket.SmartsocketClient;
constructor(
sideArg: TTypedSocketSide,
typedrouterArg: plugins.typedrequest.TypedRouter,
@@ -122,19 +126,22 @@ export class TypedSocket {
this.socketServerOrClient = socketServerOrClientArg;
}
public addTag (keyArg: string, payloadArg: any) {
if (this.side === 'client' && this.socketServerOrClient instanceof plugins.smartsocket.SmartsocketClient) {
public addTag(keyArg: string, payloadArg: any) {
if (
this.side === 'client' &&
this.socketServerOrClient instanceof plugins.smartsocket.SmartsocketClient
) {
this.socketServerOrClient.socketConnection.addTag({
id: keyArg,
payload: payloadArg
})
payload: payloadArg,
});
} else {
throw new Error('tagging is only supported on clients');
}
}
public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> (
methodName: T[ 'method' ],
public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest>(
methodName: T['method'],
targetConnection?: plugins.smartsocket.SocketConnection
): plugins.typedrequest.TypedRequest<T> {
const typedrequest = new plugins.typedrequest.TypedRequest<T>(
@@ -152,9 +159,9 @@ export class TypedSocket {
/**
* returns all matching target connection
* @param asyncFindFuncArg
* @returns
* @returns
*/
public async findAllTargetConnections (
public async findAllTargetConnections(
asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
) {
if (this.socketServerOrClient instanceof plugins.smartsocket.Smartsocket) {
@@ -173,35 +180,36 @@ export class TypedSocket {
/**
* returns a single target connection by returning the first one of all matching ones
* @param asyncFindFuncArg
* @returns
* @returns
*/
public async findTargetConnection (
public async findTargetConnection(
asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
) {
const allMatching = await this.findAllTargetConnections(asyncFindFuncArg);
return allMatching[ 0 ];
return allMatching[0];
}
public async findAllTargetConnectionsByTag (keyArg: string, payloadArg?: any) {
return this.findAllTargetConnections(async socketConnectionArg => {
public async findAllTargetConnectionsByTag(keyArg: string, payloadArg?: any) {
return this.findAllTargetConnections(async (socketConnectionArg) => {
let result: boolean;
if (!payloadArg) {
result = !!(await socketConnectionArg.getTagById(keyArg));
} else {
result = !!(
plugins.smartjson.stringify((await socketConnectionArg.getTagById(keyArg))?.payload) === plugins.smartjson.stringify(payloadArg)
plugins.smartjson.stringify((await socketConnectionArg.getTagById(keyArg))?.payload) ===
plugins.smartjson.stringify(payloadArg)
);
}
return result;
})
});
}
public async findTargetConnectionByTag (keyArg: string, payloadArg?: any) {
const allResults = await this.findAllTargetConnectionsByTag(keyArg, payloadArg)
return allResults[ 0 ];
public async findTargetConnectionByTag(keyArg: string, payloadArg?: any) {
const allResults = await this.findAllTargetConnectionsByTag(keyArg, payloadArg);
return allResults[0];
}
public async stop () {
await this.socketServerOrClient.stop()
public async stop() {
await this.socketServerOrClient.stop();
}
}

View File

@@ -2,10 +2,7 @@
import * as typedrequest from '@apiglobal/typedrequest';
import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
export {
typedrequest,
typedrequestInterfaces,
}
export { typedrequest, typedrequestInterfaces };
// @pushrocks scope
import * as isohash from '@pushrocks/isohash';
@@ -13,9 +10,4 @@ import * as smartjson from '@pushrocks/smartjson';
import * as smartsocket from '@pushrocks/smartsocket';
import * as smartstring from '@pushrocks/smartstring';
export {
isohash,
smartjson,
smartsocket,
smartstring
}
export { isohash, smartjson, smartsocket, smartstring };