Michael Bromley 9a7b35259d chore: Move from Yarn v1.x to npm		1 tahun lalu
..
example-plugins	0ead892000 docs(core): Add more docs on ProductVariantPriceUpdateStrategy	1 tahun lalu
load-testing	fb0ea1326e fix(core): Fix DefaultSearchPlugin for non-default languages (#2515)	2 tahun lalu
scripts	09c7175f8b feat(core): Add `Facet.valueList` resolver for paginated values	2 tahun lalu
test-plugins	4ac6f649bf fix(dev-server): Update Keycloak test plugin	2 tahun lalu
.gitignore	81b46074a9 fix(core): Ensure deterministic sorting in case of duplicates (#2632)	2 tahun lalu
README.md	9a7b35259d chore: Move from Yarn v1.x to npm	1 tahun lalu
dev-config.ts	ddf8a15e95 Revert "WIP encrypted custom fields"	1 tahun lalu
docker-compose.yml	4ac6f649bf fix(dev-server): Update Keycloak test plugin	2 tahun lalu
file-logger.ts	8d49af31d9 chore(dev-server): Create SimpleFileLogger	6 tahun lalu
index-worker.ts	0441a0338a chore: Migrate from TSLint to ESLint	2 tahun lalu
index.ts	0441a0338a chore: Migrate from TSLint to ESLint	2 tahun lalu
memory-profiler.ts	0441a0338a chore: Migrate from TSLint to ESLint	2 tahun lalu
migration.ts	d509805f58 feat(core): Export database migration helpers	6 tahun lalu
package.json	9a7b35259d chore: Move from Yarn v1.x to npm	1 tahun lalu
populate-dev-server.ts	0441a0338a chore: Migrate from TSLint to ESLint	2 tahun lalu
tsconfig.json	1075dd79b6 feat(admin-ui): Add initial React support for UI extensions	2 tahun lalu

Vendure Dev Server

This package is not published to npm. It is used in development of the Vendure server and plugins.

Running

To run the server, run the start script. The database configuration can be specified by the DB=<type> environment variable:

DB=mysql npm run start
DB=postgres npm run start
DB=sqlite npm run start

The default if no db is specified is mysql.

Populating data

Test data can be populated by running the populate script. This uses the same sample data as is used by the Vendure CLI when running init, albeit with the additional step of populating some sample customer & address data too.

Specify the database as above to populate that database:

DB=sqlite npm run populate

Testing custom ui extension compilation

In order to compile ui extensions within this monorepo, you need to add the following entry to this package's package.json devDependencies:

 "@vendure/admin-ui": "./packages/admin-ui/package",

and then run npm install. Make sure you already built the admin-ui package first.

Load testing

This package also contains scripts for load testing the Vendure server. The load testing infrastructure and scripts are located in the ./load-testing directory.

Load testing is done with k6, and to run them you will need k6 installed and (in Windows) available in your PATH environment variable so that it can be run with the command k6.

The load tests assume the existence of the following tables in the database:

vendure-load-testing-1000
vendure-load-testing-10000
vendure-load-testing-100000

The npm scripts load-test:1k, load-test:10k and load-test:100k will populate their respective databases with test data and then run the k6 scripts against them.

Running individual scripts

An individual test script may be by specifying the script name as an argument:

npm run load-test:1k deep-query.js

pg_stat_statements

The following queries can be used when running load tests against postgres to analyze the queries:

SELECT 
  dbid,
  (total_time / 1000 / 60) as total, 
  (total_time/calls) as avg, 
  calls,
  query 
FROM pg_stat_statements 
WHERE dbid = <db_id>
ORDER BY total DESC 
LIMIT 100;

-- SELECT pg_stat_statements_reset();

Results

The results of the test are saved to the ./load-testing/results directory. Each test run creates two files:

load-test-<date>-<product-count>.json Contains a summary of all load tests run
load-test-<date>-<product-count>-<script-name>.csv Contains time-series data which can be used to create charts

Historical benchmark results with charts can be found in this Google Sheet

README.md