Fix projects decorator #1547

MarcAstr0 · 2024-09-04T12:13:51Z

Description

After the changes introduced in #1469, it was found that read model projections where the join key was a nullable array gave a "TS1241: Unable to resolve signature of method decorator when called as an expression" compilation error. This happened in read models and entities like the following:

@Entity
export class MyEntity {
  public constructor(
    readonly id: UUID,
    readonly someListOfIds?: Array<string>
    // other properties
  ) {}
  // rest of the entity code
}

@ReadModel
export class SomeReadModel {
  @Projects(MyEntity, 'someListOfIds')
  public static projectMyEntity(
    entity: MyEntity,
    readModelId: UUID,
    currentReadModel?: SomeReadModel
  ): ProjectionResult<SomeReadModel> {
    // projection logic
  }
  
  // rest of the read model code
}

Changes

Modified ProjectionMethod type to appropriately handle this edge case.

Checks

Project Builds
Project passes tests and checks
Updated documentation accordingly

what-the-diff · 2024-09-04T12:14:11Z

PR Summary

Introduction of a New File
A new file named fix_projects_decorator_2024-09-04-11-50.json has been placed in the common/changes/@boostercloud/framework-core directory. This file contains updates about necessary tweaks made to the @boostercloud/framework-core to rectify issues with the Projects decorator.
Adjustment to ProjectionMethod Type
Changes were applied to the ProjectionMethod type in the projects.ts file located in packages/framework-core/src/decorators. The adjustment pertains to the condition for PropertyType<TEntity, TJoinKeyType>. Earlier, it specifically looked for an extension of UUID, but after the revision, it checks if it extends an array of any type. This allows for greater flexibility and adaptability in the system.

MarcAstr0 · 2024-09-04T12:14:15Z

/integration sha=ca27e4da9511f9daa8166e66be4319c2b5bf415d

github-actions · 2024-09-04T12:14:38Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T12:20:10Z

❌ Oh no! Integration tests have failed

github-actions · 2024-09-04T12:21:18Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T12:24:09Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-09-04T12:26:17Z

/integration sha=9332c5c99ccfbdadbf8601011b2837419ec4c07e

github-actions · 2024-09-04T12:26:36Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T12:29:24Z

❌ Oh no! Integration tests have failed

github-actions · 2024-09-04T13:08:43Z

❌ Oh no! Integration tests have failed

github-actions · 2024-09-04T13:23:02Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-09-04T13:26:44Z

/integration sha=ca27e4d

github-actions · 2024-09-04T13:27:08Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T13:30:00Z

❌ Oh no! Integration tests have failed

github-actions · 2024-09-04T14:04:04Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-09-04T14:18:13Z

/integration sha=f682cc0

github-actions · 2024-09-04T14:18:37Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T14:21:34Z

❌ Oh no! Integration tests have failed

This reverts commit f682cc0.

MarcAstr0 · 2024-09-04T14:28:09Z

/integration sha=9daf86b

github-actions · 2024-09-04T14:28:31Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T14:31:08Z

❌ Oh no! Integration tests have failed

This reverts commit 9daf86b.

MarcAstr0 · 2024-09-04T14:36:58Z

/integration sha=7b45ee1

github-actions · 2024-09-04T14:37:20Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T14:40:12Z

❌ Oh no! Integration tests have failed

github-actions · 2024-09-04T14:58:09Z

⌛ Integration tests are running...

Check their status here 👈

MarcAstr0 · 2024-09-04T15:00:22Z

/integration sha=ca27e4d

github-actions · 2024-09-04T15:00:44Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T15:00:57Z

❌ Oh no! Integration tests have failed

github-actions · 2024-09-04T15:03:47Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-09-04T15:04:41Z

/integration sha=ca27e4da9511f9daa8166e66be4319c2b5bf415d

github-actions · 2024-09-04T15:05:02Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T15:07:51Z

❌ Oh no! Integration tests have failed

MarcAstr0 · 2024-09-04T15:15:18Z

/integration sha=fbc2067ba64e8f0d10151954886e618d891aa9b8

github-actions · 2024-09-04T15:15:40Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-09-04T16:04:57Z

✅ Integration tests have finished successfully!

packages/framework-core/src/decorators/projects.ts

davidverdu

LGTM. I guess that you don't need other types different from string and UUID in the union, do you?

Castro, Mario added 3 commits September 4, 2024 07:49

Fix types for Projects decorator

b8f057a

pnpm-lock.yaml update

9332c5c

Add rush change file

ca27e4d

Modify path of integration test deps in GitHub Actions

f682cc0

Castro, Mario added 2 commits September 4, 2024 10:25

Revert "Modify path of integration test deps in GitHub Actions"

7b16551

This reverts commit f682cc0.

Debug integration test deps packing

9daf86b

Revert "Debug integration test deps packing"

7b45ee1

This reverts commit 9daf86b.

Merge remote-tracking branch 'origin/main' into fix_projects_decorator

fbc2067

MarcAstr0 requested review from gonzalogarciajaubert, alvaroloes and davidverdu September 4, 2024 16:10

MarcAstr0 marked this pull request as ready for review September 4, 2024 16:13

davidverdu reviewed Sep 4, 2024

View reviewed changes

packages/framework-core/src/decorators/projects.ts Outdated Show resolved Hide resolved

Refactor ProjectionMethod type

51dfedc

MarcAstr0 requested a review from davidverdu September 4, 2024 17:27

davidverdu approved these changes Sep 4, 2024

View reviewed changes

MarcAstr0 merged commit adf2902 into boostercloud:main Sep 4, 2024
6 checks passed

Fix projects decorator #1547

Fix projects decorator #1547

Conversation

MarcAstr0 commented Sep 4, 2024 • edited Loading

Description

Changes

Checks

what-the-diff bot commented Sep 4, 2024

PR Summary

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

MarcAstr0 commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Sep 4, 2024

davidverdu left a comment

Choose a reason for hiding this comment

MarcAstr0 commented Sep 4, 2024 •

edited

Loading