Calculated fields

[MarcAstr0]

Description

Due to the changes introduced in version 2.11.0, this PR introduces the @CalculatedField decorator for read model fields, which are calculated using getters using other properties of the read model. e.g.,

@ReadModel({
  authorize: 'all',
})
export class PersonReadModel {
  public constructor(
    readonly id: UUID,
    readonly firstName: string,
    readonly lastName: string
  ) {}

  @CalculatedField(['firstName', 'lastName'])
  public get fullName(): Promise<string> {
    return Promise.resolve(`${this.firstName} ${this.lastName}`)
  }
}

This decorator receives a list of the read model's properties as an input parameter. The calculated field uses these properties to calculate its value. The decorator ensures that these properties are fetched from the database so that the calculated field is calculated correctly, even if the user did not explicitly request these dependencies.

Changes

• Add the CalculatedField decorator to the framework-core package, which stores the calculated fields and their dependencies in the read model's metadata.
• Modify the search method in the BoosterReadModelsReader class so it handles calculated fields accordingly.
• Add necessary helper methods for working with the calculated fields and instantiating the read model class.
• Fix broken code in the cli package due to updated Node types.
• Updated documentation.

Checks

• [x] Project Builds
• [x] Project passes tests and checks
• [x] Updated documentation accordingly

[MarcAstr0]

/integration sha=c9dcfc3c4768ff9098f4d1d766f91e7018c85046

[what-the-diff[bot]]

PR Summary

• Changes in the Package framework-common-helpers

  • A new function createInstanceWithCalculatedProperties was added to enhance read model classes, enabling them to include calculated properties in their responses.
  • Functions to build and process properties maps were also added, assisting in controlling which properties to include in responses.
  • A checker function isPromise was introduced to verify if an object is a promise.

• Modifications in the Package framework-core

  • The booster-read-models-reader.ts file now incorporates the createInstanceWithCalculatedProperties function. A new function createReadModelInstancesWithCalculatedProperties was included to enhance read model instances with the calculated properties.
  • The search function was modified for optimized performance when calculated fields dependencies exist.
  • A new decorator CalculatedField was introduced in read-model.ts to mark a property as a calculated field with dependencies.

• Updates in Test Cases

  • New test cases were added to verify the functionality of the createReadModelInstancesWithCalculatedProperties function and the CalculatedField decorator.
  • Existing test cases were updated to accommodate the new dependencies property in the fields metadata.

• Additions in the Integration Tests

  • A new test case was introduced to test the process of projecting calculated fields in read model query.

• Changes in the framework-integration-tests Project

  • The CartMyAddress command file was added.
  • The CalculatedField decorator was used in cart-read-model.ts for several methods.
  • A new dependencies property was added to the PropertyMetadata interface to hold the dependencies of the calculated fields.

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=e815183

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=7d65cb3

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=008414c64635315ceda16888eaf39c0d73161b9e

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=ebf97f1536d507ec8127efa618913017a17875bd

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=3b899a6bc06d65be4f1f2bf59f3becb67abe995e

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=3b899a6bc06d65be4f1f2bf59f3becb67abe995e

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=3b899a6bc06d65be4f1f2bf59f3becb67abe995e

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[github-actions[bot]]

:x: Oh no! Integration tests have failed

[MarcAstr0]

/integration sha=3b899a6bc06d65be4f1f2bf59f3becb67abe995e

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:white_check_mark: Integration tests have finished successfully!

[MarcAstr0]

/integration sha=85ea3c15ed9f3acf080593bec19df41e4bff93fe

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:white_check_mark: Integration tests have finished successfully!

[MarcAstr0]

/integration sha=56633030c1307dc0adf1bc187387e69731cbc387

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈

[github-actions[bot]]

:white_check_mark: Integration tests have finished successfully!

[MarcAstr0]

/integration sha=2077b2cb598e6b6259ef8e2d1b6756e8cead1f53

[github-actions[bot]]

:hourglass: Integration tests are running...

Check their status here 👈