puristajs/purista

A typescript framework for building backend services and api in modern, modular and scalable way with event-driven patterns

purista's Issues

[TASK] Add examples

Add some basic example to repository

migrate to mono repo

Migrate to mono repo or add multiple repositories - tbd

fix: AMQP bridge ack handling

Add proper ack handling into AMQP event bridge

[BUG] Fix logger

The logger types and logger function input are not correct.
They should match Pino, Bunyan and so on

update to vuepress 2

As current stable vuepress version is based on vue 2 and the dep. packages are outdated with security warnings up to high risk:
Update vuepress version to next (vue 3) and within this update use some different theme with more options

[TASK] Check if https://github.com/purista might be an option

Any chances to get the https://github.com/purista for this Open-source typescript backend framework as there seems to be no activity and unused?

Would be cool to get it - so if there is a option - pls contact me
@Purista

[TASK] evaluate bun

Evaluate if purists is working on https://bun.sh

[TASK] evaluate Deno

Evaluate purista on https://deno.land

[BUG] routing issues: wrong 404 handling

Currently the flow for handling handlers & middleware are logical invalid, when there is no matching route found.

At the moment, all onBefore and all onAfter handlers are executed - no matter if a route is found.
This results in most cases in 500 error response, instead of 404.

The expectation is, that if there is no matching route, only 404 handlers are executed.

[BUG] openapi3-ts dependency missing

Installing the package and running the HTTP service is failing because module openapi3-ts is missing as dependency package

[TASK] Add duplication check on service builder

Add check so service builder to prevent, that two or more functions/subscriptions are registered with same name

[BUG] OpenApi does not reflect multiple path parameter

Currently, multiple path parameter are not reflected in generated api documentation

Create Website

Add documentation

[TASK] remove extra handling from UnhandledError

Describe the things which needs to be done

remove handling of Errors between 400-500.
Unhandled errors should always result in 500 with fixed message

[TASK] make messages and service info immutable

Describe the things which needs to be done

Freeze message objects and service info before send / on receiving and try to make them read only

feat: Allow multiple auth methods

In openApi documentation you can add multiple auth methods.
Provide a way to define which auth methods are the default ones and so on.

ex.

/public needs none

/assets -> needs API-Key

/authenticate -> needs API-Key and Basic Auth

/restricted -> needs API-Key and Bearer

[FEATURE-REQUEST] use promise.race instead timer interval

currently time outs are handled via interval.
Improve this to have a per-request timeout promise

[BUG] not working under windows os

The server is starting correctly but calling one of the endpoints is always returning 500 error.

console log:

2022-05-01 14:53:26.956  ERROR [httpServerService   HttpServerService.routerHandler] all handlers done, but no response send - now throwing to jump into error handlers
2022-05-01 14:53:26.957  ERROR [httpServerService   HttpServerService.routerHandler] route handler error
 Error  No response send to client
details:
{
  errorCode: 500,
  data: undefined
}
error stack:
• HttpServerService.impl.ts:221 routerHandler
    node_modules\@purista\core\src\http-server\HttpServerService.impl.ts:221:15

Looks like there is an issue with routing on windows environments and the 500 is related to issue #16
The service command function seems to not being called.
Maybe because on windows \ is used, but on linux/macOS / for path names.

Needs to be reproduced and fixed on windows environment.

[BUG] set content type in FunctionDefinitionBuilder and default to application/json

Improve FunctionDefinitionBuilder by adding content type (defaults to application/json) with the option to set different content type.
Improve responseToJsonMiddleware and openApiHandler to not use hardcoded types

[FEATURE-REQUEST] Add traceId to error response and log traceId and correlationId

As enhancement: Automatically log traceId and correlationId.

Add traceId to error response as optional, to be able to give it to client for better support/error findings

add change log file

[FEATURE-REQUEST] Add response content type option to http server

Currently, you can set a content type other than application/json, but this for input and output.

As an example - if you've file uploads, you might have as request content type multipart/form-data, but you like to respond with application/json

[FEATURE-REQUEST] Add authorization method to openapi

allow users to define authorization method for openapi

[FEATURE-REQUEST] add /healthz endpoint to httpServer

Add a /healthz endpoint to httpServer

[FEATURE-REQUEST] Improve error handling - differentiate between handled and unhandled

Differentiate in service function responses between HandledError and UnhandledError

This allows use cases where we want to track system issues, while skipping other issues like invalid inputs.
This allows to investigate a system over time to find unhandled errors for improving security ans stability.

[TASK] Add config getter for service

Describe the things which needs to be done

To be able to create automated deploy config, a getter for service definitions (functions & subscriptions) is needed

feat: Add drain and stop functions to bridges

Add drain and stop functions to event bridges to be able to shut down properly.

[BUG] HttpServer onError hook does not return

if the onError hook is triggered, it will never return

[TASK] run unsubscribeService in parallel

Describe the things which needs to be done

Run unsubscribe calls in parallel to improve performance

[FEATURE-REQUEST] Add hooks

Add hooks:

• beforeInvokeRequest
• beforeInvokeResponse
• beforeInputValidation
• afterInputValidation
• beforeOutputValidation
• afterOutputValidation

Reason:
to be able to transform payload before validation for example because of migrations or to be able to add a permission layer.

Also bug tracking, additional tracking etc will be possible here

[FEATURE-REQUEST] Subscriptions should be able to return values and emit events

As of now, subscriptions can listen for events/messages and do some computation.
Currently, they are not able to return results and emitting of custom events needs to be done programmatically.

But it might make sense to add the possibility, that subscriptions can return values.
If they return values, they should be able to automatically emit the output as custom event.

Here, subscriptions should have:

• optional output validation and type
• event name definition

[TASK] Make guard hooks run in parallel

Describe the things which needs to be done

We can use promise.all to execute multiple guards in parallel

[FEATURE-REQUEST] Add input transformer functions to subscriptions

Currently, command functions are able to have transform functions for in and output.
Subscriptions also consume the same input as command functions in many cases. Because of this, they also may need to transform the input before executing the actual subscription function

[Improvement] Unify ErrorStatus and SuccessStatus

It makes no sense to have ErrorStatus wrapper.
There the HTTP Status from node http should be used.

[TASK] allow custom event/message types

Currently only the required set of message types is implemented.
Something like CommandRequest or CommandResponse

To be able to support proper event souring it is necessary to add custom message types.

This means it must be possible to return the custom event type in command functions and subscriptions must be able to subscribe on custom events.

[FEATURE-REQUEST] Move test helper into own package

As there will be dependencies like sinon it will be the preferred way to move the testing helpers out into own package

[TASK] make subscription id reproducible

Describe the things which needs to be done

Currently subscription id is a unique, random id but it should be some fixed reproducible id.

Otherwise multiple instance can't subscribe to same queue

[FEATURE] Add AMQP (rabbitMQ) eventbridge

breaking change: move service info sending from service into event bridge

Service info messages should be handled by event bridge as it depends on the underlaying event bridge service if this message is needed.
For example in server less lambda functions, this event should not be send each time a service functions is invoked.

[FEATURE-REQUEST] add EventBridge status check

It makes sense to have a unified function like isOk or isConnected to the EventBridge interface to enable things like /healthz endpoints.

feat: Evaluation of kubeMQ as message broker

KubeMQ provides some interesting features and a small footprint.
There, it makes sense to evaluate it as message broker for purista.

https://kubemq.io

[FEATURE-REQUEST] add before response hook in http server

It is useful to have some possibility to inject some function before response is sent.

As an example, you might want to set cookies based on function response

[FEATURE-REQUEST] Timed out invoke should send a info message

Currently, timeouts are done in calling sender Service.
If a invocation timed out the invoke promise is rejected with UnhandledError Gateway Timeout.

This is fine for the service itself, but nobody outside this service get informed about it.
So it's not possible to track via observer-subscriptions.

There, a info-error message should be send

feat: AMQP bridge allow subscription on custom topics

Provide a option to register subscriptions as kind of an adapter for queues, other than the ones PURISTA is using, to provide the possibility to integrate it with other systems.
Also, a option to send messages which are not matching the PURISTA message schema are making sense here.

[FEATURE-REQUEST] Failing subscription should emit a info message

If a subscription function is failing/throwing, a info message should be send over event bridge to be able to track this in some way.

[TASK] Add unit tests

[BUG] log traceId and service name + version

traceId, service name + version should be logged.
tracedId should be passed all the way down and back in response

[FEATURE-REQUEST] Implement OpenTelemetry into core

As the main focus is providing a framework which handles traceability out of the box it would make sense to highly integrate OpenTelemetry function into core.

[TASK] Rename FunctionDefinitionBuilder to CommandDefinitionBuilder

To improve naming and code readability, FunctionDefinitionBuilder should be renamed to CommandDefinitionBuilder to have proper naming.
The documentation should also reflect this more. Moving from service function to service command makes more sense.