Calculated fields #1539

MarcAstr0 · 2024-07-03T18:56:08Z

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

Project Builds
Project passes tests and checks
Updated documentation accordingly

MarcAstr0 · 2024-07-03T18:56:43Z

/integration sha=c9dcfc3c4768ff9098f4d1d766f91e7018c85046

what-the-diff · 2024-07-03T18:56:46Z

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 · 2024-07-03T18:57:03Z

⌛ Integration tests are running...

Check their status here 👈

packages/framework-common-helpers/src/instances.ts

+      const isArray = part.endsWith('[]')
+      const key = isArray ? part.slice(0, -2) : part
+      if (!current[key]) {
+        current[key] = isArray ? { __isArray: true, __children: {} } : {}


github-actions · 2024-07-03T19:09:27Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-03T19:19:16Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-03T19:43:54Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-03T20:08:08Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-03T21:14:21Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-03T23:34:09Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-04T12:09:40Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-07-04T12:29:14Z

/integration sha=e815183

github-actions · 2024-07-04T12:29:36Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-04T12:41:06Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-07-04T12:45:31Z

/integration sha=7d65cb3

github-actions · 2024-07-04T12:45:53Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-04T12:58:43Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-04T14:35:17Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-04T18:18:01Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-04T21:27:42Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-05T00:53:56Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-05T11:13:53Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-05T12:04:25Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-07-05T12:16:37Z

/integration sha=008414c64635315ceda16888eaf39c0d73161b9e

github-actions · 2024-07-08T14:55:10Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-08T16:33:34Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-08T17:37:38Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-07-08T18:09:37Z

/integration sha=3b899a6bc06d65be4f1f2bf59f3becb67abe995e

github-actions · 2024-07-08T18:10:03Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-08T18:57:55Z

✅ Integration tests have finished successfully!

MarcAstr0 · 2024-07-08T19:42:23Z

/integration sha=85ea3c15ed9f3acf080593bec19df41e4bff93fe

github-actions · 2024-07-08T19:42:43Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-08T20:29:14Z

✅ Integration tests have finished successfully!

MarcAstr0 · 2024-07-09T16:19:20Z

/integration sha=56633030c1307dc0adf1bc187387e69731cbc387

github-actions · 2024-07-09T16:19:41Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-09T17:09:05Z

✅ Integration tests have finished successfully!

alvaroloes

Amazing job! Just a small comment about UX

packages/framework-core/src/decorators/read-model.ts

packages/framework-integration-tests/src/read-models/cart-read-model.ts

MarcAstr0 · 2024-07-19T13:11:15Z

/integration sha=2077b2cb598e6b6259ef8e2d1b6756e8cead1f53

github-actions · 2024-07-19T13:11:37Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-19T14:02:11Z

❌ Oh no! Integration tests have failed

github-actions · 2024-07-19T15:00:10Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-07-19T15:48:06Z

✅ Integration tests have finished successfully!

Castro, Mario added 3 commits June 24, 2024 14:34

Add CalculatedField decorator

5622f48

Add dependencies to select

0bb3040

Refactor instance creation methods

c9dcfc3

github-advanced-security bot found potential problems Jul 3, 2024

View reviewed changes

Castro, Mario added 2 commits July 5, 2024 08:15

Temporarily change Azure region for integration tests

083ce53

Revert "Temporarily change Azure region for integration tests"

008414c

MarcAstr0 force-pushed the calculated_fields branch from 7d65cb3 to 008414c Compare July 5, 2024 12:16

Castro, Mario added 3 commits July 8, 2024 15:03

Update documentation

18fc9f3

Add rush change file

a484d3c

Fix CodeQL scan warning

85ea3c1

MarcAstr0 requested review from javiertoledo, gonzalogarciajaubert, charlietfe and alvaroloes July 8, 2024 19:41

MarcAstr0 marked this pull request as ready for review July 8, 2024 19:41

Refactor processProperties method to properly support undefined values

5663303

alvaroloes reviewed Jul 19, 2024

View reviewed changes

packages/framework-core/src/decorators/read-model.ts Show resolved Hide resolved

packages/framework-integration-tests/src/read-models/cart-read-model.ts Outdated Show resolved Hide resolved

alvaroloes approved these changes Jul 19, 2024

View reviewed changes

Refactor CalculatedField decorator options

2077b2c

MarcAstr0 merged commit 177b038 into boostercloud:main Jul 19, 2024
6 checks passed

Calculated fields #1539

Calculated fields #1539

Conversation

MarcAstr0 commented Jul 3, 2024 • edited Loading

Description

Changes

Checks

MarcAstr0 commented Jul 3, 2024

what-the-diff bot commented Jul 3, 2024

PR Summary

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 3, 2024

github-actions bot commented Jul 4, 2024

MarcAstr0 commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

MarcAstr0 commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 5, 2024

github-actions bot commented Jul 5, 2024

github-actions bot commented Jul 5, 2024

MarcAstr0 commented Jul 5, 2024

github-actions bot commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

MarcAstr0 commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

MarcAstr0 commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

github-actions bot commented Jul 8, 2024

MarcAstr0 commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

alvaroloes left a comment

Choose a reason for hiding this comment

MarcAstr0 commented Jul 19, 2024

github-actions bot commented Jul 19, 2024

github-actions bot commented Jul 19, 2024

github-actions bot commented Jul 19, 2024

github-actions bot commented Jul 19, 2024

MarcAstr0 commented Jul 3, 2024 •

edited

Loading