feat(models): adds benchmark model generator

[stefanblaginov]

Changes

Adds a Concerto benchmark model generator. This API allows you to generate models of varying sizes which can be used to test the performance of your Concerto-handling code.

Generate a model up to a specified number of declarations and properties

You can generate a model up to a specified number of declarations and properties using:

const benchmarkModelGenerator = new BenchmarkModelGenerator();
const generated = benchmarkModelGenerator.generateConcertoModels({
    nDeclarations: 5, // Number of declarations in the model
    nProperties: 5, // Number of properties per declaration
});

Generate a model up to a specified size in bytes

You can generate a model up to a specified size in bytes, however you would need to specify how that model should grow.

Grow model by number of declarations

If you'd like to grow it by number of declarations, you will need to specify the number of properties that you wish the model to have (defaults to 1):

const benchmarkModelGenerator = new BenchmarkModelGenerator();
const generated = benchmarkModelGenerator.generateConcertoModels({
    generateUpToSize: 10000, // Target upper limit of growth in bytes
    growBy: 'declarations', // Element type by which the model should grow
    nProperties: 5, // Number of properties per declaration
});

Grow model by number of properties

If you'd like to grow it by number of properties, you will need to specify the number of declarations that you wish the model to have (defaults to 1):

const benchmarkModelGenerator = new BenchmarkModelGenerator();
const generated = benchmarkModelGenerator.generateConcertoModels({
    generateUpToSize: 10000, // Target upper limit of growth in bytes
    growBy: 'properties', // Element type by which the model should grow
    nProperties: 5, // Number of declarations in the model
});

The expected response will include an array of generated models (currently containing only a single model) and a metadata object with information about the generated model e.g:

{
  models: [
    {
      '$class': '[email protected]',
      decorators: [],
      namespace: '[email protected]',
      imports: [],
      declarations: [
        ...
      ]
    }
  ],
  metadata: {
    requestedModelSizeInBytes: 10000,
    humanReadableRequestedModelSize: '9.77 KiB',
    generatedModelSizeInBytes: 9952,
    humanReadableGeneratedModelSize: '9.72 KiB',
    declarationsN: 5,
    propertiesNInSmallestDeclaration: 15,
    propertiesNInLargestDeclaration: 16
  }
}

As you can see from the above example model, the generator will try its best to reach the upper generateUpToSize reqested size, but may fall short by a few bytes.

Author Checklist

• Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
• Vital features and changes captured in unit and/or integration tests
• Commits messages follow AP format
• Extend the documentation, if necessary
• Merging to main from fork:branchname

[coveralls]

coverage: 98.736%. first build
when pulling 2ea743f on stefanblaginov:stefanblaginov/benchmark-model-generator
into 16d9d5a on accordproject:main.

[mttrbrts]

total_available_size would be a tighter fit

[stefanblaginov]

Addressed ✅

[stefanblaginov]

@mttrbrts can you please advise me on the best way to polyfill v8. I'm getting the following error in the pipeline:

[webpack-cli] Failed to load '/home/runner/work/concerto-codegen/concerto-codegen/webpack.config.js' config
[webpack-cli] Error: Cannot find module 'node:v8/'

This seems to be an option: https://www.npmjs.com/package/node-polyfill-webpack-plugin, however it's an extra dependency.

[jamieshorten]

@mttrbrts can you please advise me on the best way to polyfill v8. I'm getting the following error in the pipeline:

[webpack-cli] Failed to load '/home/runner/work/concerto-codegen/concerto-codegen/webpack.config.js' config
[webpack-cli] Error: Cannot find module 'node:v8/'

This seems to be an option: https://www.npmjs.com/package/node-polyfill-webpack-plugin, however it's an extra dependency.

node-polyfill-webpack-plugin is probably what you want. It basically adds the Node pollyfills that were in Webpack 4 and earlier to Webpack 5+.

[stefanblaginov]

@mttrbrts can you please advise me on the best way to polyfill v8. I'm getting the following error in the pipeline:

[webpack-cli] Failed to load '/home/runner/work/concerto-codegen/concerto-codegen/webpack.config.js' config
[webpack-cli] Error: Cannot find module 'node:v8/'

This seems to be an option: https://www.npmjs.com/package/node-polyfill-webpack-plugin, however it's an extra dependency.

node-polyfill-webpack-plugin is probably what you want. It basically adds the Node pollyfills that were in Webpack 4 and earlier to Webpack 5+.

Unfortunately it doesn't polyfill the v8 engine.

[stefanblaginov]

@mttrbrts can you please advise me on the best way to polyfill v8. I'm getting the following error in the pipeline:

[webpack-cli] Failed to load '/home/runner/work/concerto-codegen/concerto-codegen/webpack.config.js' config
[webpack-cli] Error: Cannot find module 'node:v8/'

This seems to be an option: https://www.npmjs.com/package/node-polyfill-webpack-plugin, however it's an extra dependency.

node-polyfill-webpack-plugin is probably what you want. It basically adds the Node pollyfills that were in Webpack 4 and earlier to Webpack 5+.

Unfortunately it doesn't polyfill the v8 engine.

Addressed by limiting model size to 100 MiB.