idrinth-api-bench / issues Goto Github PK

This is the issue repository for a typescript framework meant to performance test anything even remotely rest-like and related tools

Home Page: https://idrinth-api-ben.ch/

License: MIT License

api benchmark benchmarking rest rest-api-test framework performance-metrics performance-monitoring performance-testing load-testing testing

issues's Introduction

idrinth-api-bench

This is the central issue repository for the organisation. We appreciate any help in finding or fixing issues, so feel free to open any if you find oddities or errors!

If you want to contribute, have a look at the labels; they tell both the size and difficulty of a task, as well as what repository to change code in.

Branch naming

We use the-one as our central branch since it barely won a community vote. It was picked as a reference to the one ring - this is the branch to rule them all.

Socials

Please follow my socials to be updated on the project:

Support

Commercial support and training is provided via Björn Büttner.

Privacy and Compliance

The @idrinth-api-bench framework and its CLI do not collect any kind of information about its users or the APIs being tested. All data is local to the device you run it on or the database server you configure it to dump data in.

The diverse other tools collect the minimum of information necessary and never share it with the outside world except as configured by you.

issues's People

Contributors

Stargazers

Watchers

Forkers

rizkisahat996 davidsaintanna savvy-itch stradex selmy44 madina0801 aabse elenaexposito codesak asin-junior-honore avijit-ap mohamedsy1 gauravkdeshmukh adityabhate anukratimehta aceppaluni kofta999 stephviz 5asim sagarsaud51 pas4nd rishikeshk07 hbrehman boioboi16 sharlibeicon jeevikasirwani itsmacr8 ishubhamsharma7 ayushkatoch98 shikhar13012001 kirilcycle brinabre owais34 gapesasi martincarapia mjfwebb akhil0203 jiatonglii22 tiwariparth marikadeveloper sourcery-ai-experiments latif-essam hussainnaqvee arnabnandy7 matin-mortazavi bjoern-buettner hamza-asif99 kapiper mightyoctopus ofthewildfire gurbeer-sokhi rohit-tech-universe esraasoffar

issues's Issues

support encoding as part of application/json content type

create the option of untracked single requests before, after and between checks

before, beforeTask, beforeEach, afterEach, afterTask, after

This may need a redesign of the provided task list

extract strings to language file

Context
easy of translation and simpler usage

Project
File: -

Move css to sass for easier structuring

https://create-react-app.dev/docs/adding-a-sass-stylesheet/

add a progress bar

for example https://www.npmjs.com/package/progress to show the amount of processed requests

add footer

Describe the solution you'd like
A small footer with a nav to legal pages(currently imprint) and a copyright notice(Björn Büttner and contributors)

Create an access token middleware based on common patterns

Add variance to result

clean up executor, extract on message

Context
reduces readability currenlty

Project
File:src/executor

The website title is wrong

Describe the bug
The website is currently for readme, it should be for api-bench

Expected behavior
Replace the title with @idrinth/api-bench to match the project name

Screenshots
m.

add translations for the texts and headings

Describe the solution you'd like
Use the provided library to make all texts language dependent. By default they should be english.

a less painful addition of middlewares to tasks

provide a way, that doesn't need the full path to the middleware, resolutions should be:

#abc -> local/src/middlewares/abc.ts|local/dist/middlewares/abc.js
^abc -> root/src/middlewares/abc.ts|root/dist/middlewares/abc.js
$modulename/abc -> modulepath/src/middlewares/abc.ts|modulepath/dist/middlewares/abc.js

this locks down the structure of implementations to have middlewares at src/middlewares/*.ts or dist/middlewares/*.js if the short syntax is used

Provide completely separated "threads"

For people who require different logins, the current worker based solution may be insufficient.
There should be an optional way of running in completely separated environments by starting subtasks as their own node process.

There are general styles made page specific by .home etc.

Remove page specific styling or extract it into their own css file in their folder

response in result must be optional

Context
it's set to undefined on error

imprint is nailed to the side of the screen

add padding as on other pages

formatting of switch case

Context
it's indented on too far to the left

Project
File: src/helpers/function-analyser.ts

graphql support

Most likely a factory function or class would be a good solution here

unit tests to a coverage of 70%

rename functions in calculator.ts

Context
better readability

Project
File: src/worker/calculator.ts

Use describe to group tests

Context
tests are hareder to read currently

Project
File: test/logger

Replace external link content with icon

from https://www.svgrepo.com/svg/510970/external-link for example.

If you use that add an attribution to the imprint.

Add syntax highlighting

Describe the solution you'd like
use a syntacx highlighter to highlight the typescript and javascript codes.

extract constants

Context
improve readability by not having them take up the top of files

mobile title has linebreak & logo is missing

please reformat that header line to fit properly for mobile devices

the headers are different per site

Describe the bug
On the main page the headings are positioned left off the text, on other pages above the text.

Expected behavior
The style of heading positions is the same across the site.

npm link is not pointing to the package

Describe the bug
the npm link points to the starting pag of npmjs.

Add contributing to website

see https://github.com/Idrinth/api-bench/blob/master/CONTRIBUTING.md for content

encode middleware doesn't set content-type

rename FinishedRun

Context
doesn't match the desired kebab case

Add stdev to result

Add tests for the website

Context
Right now issues in the website's code are hard to find.

Project
File: website/src/**/*.tsx

Add imprint to the website

Context
For legal reasons in germany we need an imprint, mine can be taken from https://bjoern-buettner.me/imprint/en

Project
File: website/src/pages/imprint

line 22 user agent helper wrong

Context
modules misstyped, not functional

Add link to project github to website

put it into the main menu and make it clear, that it leads to a seperate page

Add middleware: JSON validator

Describe the solution you'd like
validate content-type and content.

after jobs do not call validators

Fix node 15 unittests

Likely a configuration issue, since they run fine locally.

Logo missing

Describe the bug
we don't have a logo yet.

Add load testing option

Is your feature request related to a problem? Please describe.
Sometimes you may want to test out the limits of your rest api. Currently you would need to manually adjust the threads used and restart the test run.

Describe the solution you'd like
Provide a cli and config option to automatically increment threads after a successful run. The report the results as usual, with the thread count being added to the id of the specific run.

rename short names in runner.ts

Context
readability

Project
File: src/worker/runner.ts

create additional examples

simple login/logout
access token based example(what public api to use?)
session based auth example(what public project to use?)
own validator added example
example project?

soap support

Most likely a factory based on wsdl is the only requirement here, https://github.com/rajbandi/wsdl-js seems to have done some of the required work already.