Allow define projection fields in read model queries #1481

gonzalojaubert · 2023-10-25T08:27:07Z

Add the select method to project which fields you want to get in your read model query:

@Command({
  authorize: 'all',
})
export class GetProductsCount {
  public constructor(readonly filters: Record<string, any>) {}

  public static async handle(): Promise<unknown> {
    const searcher = Booster.readModel(ProductReadModel)
            .filter({
              sku: { contains: 'toy' },
              or: [
                {
                  description: { contains: 'fancy' },
                },
                {
                  description: { contains: 'great' },
                },
              ],
            })
            .select(['sku', 'description'])
            .skipInstance(true)
    const result = await searcher.search()
    return { count: result.length }
  }
}

The searcher result using skipInstance will generate an array of objects with the sku and description fields of the ProductReadModel read model. If you don't use skipInstance the result will be an array of ProductReadModel instances.

Note: Using skipInstance will skip any Read Models migrations that need to be applied to the result. If you need to apply migrations to the result, don't use skipInstance.

sweep-ai · 2023-10-25T08:28:12Z

Apply Sweep Rules to your PR?

Apply: All docstrings and comments should be up to date.
Apply: Do not include large chunks of commented-out code.
Apply: Ensure that error logs use traceback during exceptions.
Apply: Remove debug logs and print statements from production code.
Apply: All the business logic in the 'src' folder for each package should have the corresponding unit tests in the 'test' folder in the same package.
Apply: Avoid 'any' types when possible.
Apply: If there's a simpler way to express a type, it should be used.

ghost · 2023-10-25T08:28:22Z

👇 Click on the image for a new way to code review

Legend

gonzalogarciajaubert · 2023-10-25T10:17:54Z

/integration sha=f759db3f44bbb758e31468a56d2c31972865b216

github-actions · 2023-10-25T10:18:22Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2023-10-25T11:03:49Z

❌ Oh no! Integration tests have failed

github-actions · 2023-10-25T11:31:33Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2023-10-25T12:15:16Z

✅ Integration tests have finished successfully!

…on_fields_in_read_model_queries

MarcAstr0 · 2024-03-22T16:49:30Z

/integration sha=ed4d1caa659a52b4745a5362cbe025848d193f75

github-actions · 2024-03-22T16:49:52Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-03-22T17:33:36Z

✅ Integration tests have finished successfully!

…on_fields_in_read_model_queries # Conflicts: # common/config/rush/pnpm-lock.yaml # packages/framework-provider-local/src/services/read-model-registry.ts

…on_fields_in_read_model_queries

MarcAstr0 · 2024-04-12T16:05:59Z

/integration sha=fec44b84904d33b0a6617c5163dfd1b452d2adc0

github-actions · 2024-04-12T16:06:22Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-04-12T16:56:59Z

✅ Integration tests have finished successfully!

…on_fields_in_read_model_queries # Conflicts: # common/config/rush/pnpm-lock.yaml

packages/framework-types/src/searcher.ts

MarcAstr0 · 2024-05-22T22:29:17Z

/integration sha=afd9d2be3ee9124c77b9b696aac6a73927921454

github-actions · 2024-05-22T22:29:36Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-05-22T23:17:48Z

✅ Integration tests have finished successfully!

alvaroloes

What an great work @MarcAstr0 🥇 🥇🥇

packages/framework-core/src/services/graphql/graphql-generator.ts

packages/framework-integration-tests/package.json

packages/framework-provider-azure/src/helpers/query-helper.ts

website/docs/03_architecture/06_read-model.mdx

packages/framework-provider-local/src/services/read-model-registry.ts

+        if (part.endsWith('[]')) {
+          const arrayField = part.slice(0, -2)
+          if (!currentLevel[arrayField]) {
+            currentLevel[arrayField] = {}


packages/framework-provider-local/src/services/read-model-registry.ts

+            }
+          } else {
+            if (!currentLevel[part]) {
+              currentLevel[part] = {}


MarcAstr0 · 2024-05-28T04:08:53Z

/integration sha=8726201

github-actions · 2024-05-28T04:09:13Z

⌛ Integration tests are running...

Check their status here 👈

…operties of the read model

github-actions · 2024-05-28T04:57:01Z

✅ Integration tests have finished successfully!

MarcAstr0 · 2024-05-28T13:31:12Z

/integration sha=c4b7ca6c3c63ec64f2c0da97a408b21c8cbb1655

github-actions · 2024-05-28T13:31:34Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-05-28T14:22:05Z

✅ Integration tests have finished successfully!

packages/framework-provider-local/src/services/read-model-registry.ts

This reverts commit caa9de0.

MarcAstr0 · 2024-05-29T13:36:55Z

/integration sha=e38a5b6

github-actions · 2024-05-29T13:37:17Z

⌛ Integration tests are running...

Check their status here 👈

github-actions · 2024-05-29T14:25:36Z

✅ Integration tests have finished successfully!

alvaroloes

💯 Thanks for all the clarifications

packages/framework-provider-local/src/services/read-model-registry.ts

Allow define projection fields in read model queries

f759db3

rush change

7bfd4c8

gonzalogarciajaubert marked this pull request as draft October 26, 2023 13:52

Castro, Mario added 2 commits March 21, 2024 15:53

Merge remote-tracking branch 'origin/main' into allow_define_projecti…

9cee23e

…on_fields_in_read_model_queries

Update pnmp-lock.yaml after rebasing

ed4d1ca

Castro, Mario added 4 commits March 22, 2024 16:27

Merge remote-tracking branch 'origin/main' into allow_define_projecti…

03dc926

…on_fields_in_read_model_queries # Conflicts: # common/config/rush/pnpm-lock.yaml # packages/framework-provider-local/src/services/read-model-registry.ts

Merge remote-tracking branch 'origin/main' into allow_define_projecti…

898c0f4

…on_fields_in_read_model_queries

Merge remote-tracking branch 'origin/main' into allow_define_projecti…

3c33c14

…on_fields_in_read_model_queries

Update pnpm-lock.yaml after merge

fec44b8

MarcAstr0 marked this pull request as ready for review April 15, 2024 14:19

MarcAstr0 requested review from javiertoledo, charlietfe, alvaroloes and NickSeagull April 15, 2024 14:20

Castro, Mario added 2 commits April 16, 2024 10:04

Merge remote-tracking branch 'origin/main' into allow_define_projecti…

b66b4e7

…on_fields_in_read_model_queries # Conflicts: # common/config/rush/pnpm-lock.yaml

Update pnpm-lock.yaml after merge

ae6a361

alvaroloes reviewed Apr 22, 2024

View reviewed changes

packages/framework-types/src/searcher.ts Outdated Show resolved Hide resolved

NickSeagull removed their request for review May 21, 2024 09:21

Fix integration test execution for local provider

afd9d2b

alvaroloes reviewed May 27, 2024

View reviewed changes

github-advanced-security bot found potential problems May 28, 2024

View reviewed changes

Add support for selecting fields in arrays which are not top-level pr…

34ddffa

…operties of the read model

MarcAstr0 force-pushed the allow_define_projection_fields_in_read_model_queries branch from 8726201 to 34ddffa Compare May 28, 2024 12:02

Castro, Mario added 2 commits May 28, 2024 09:08

Remove unnecessary console.error

f498f42

Update docs

c4b7ca6

MarcAstr0 requested a review from alvaroloes May 28, 2024 13:26

Castro, Mario added 2 commits May 28, 2024 10:59

Add documentation to new helper functions

acf2ae2

Fix prototype-polluting assignment warning

caa9de0

github-advanced-security bot found potential problems May 29, 2024

View reviewed changes

packages/framework-provider-local/src/services/read-model-registry.ts Fixed Show fixed Hide fixed

packages/framework-provider-local/src/services/read-model-registry.ts Fixed Show fixed Hide fixed

Castro, Mario added 2 commits May 29, 2024 09:29

Revert "Fix prototype-polluting assignment warning"

c511853

This reverts commit caa9de0.

Fix prototype-polluting assignment warning

e38a5b6

alvaroloes approved these changes May 30, 2024

View reviewed changes

packages/framework-provider-local/src/services/read-model-registry.ts Show resolved Hide resolved

Add clarification comment

3e806b3

MarcAstr0 merged commit f747847 into boostercloud:main May 30, 2024
6 checks passed

MarcAstr0 mentioned this pull request Jun 5, 2024

Add global event handler #1404

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow define projection fields in read model queries #1481

Allow define projection fields in read model queries #1481

gonzalojaubert commented Oct 25, 2023 •

edited

Loading

sweep-ai bot commented Oct 25, 2023

ghost commented Oct 25, 2023 •

edited by ghost

Loading

Legend

gonzalogarciajaubert commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

MarcAstr0 commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

MarcAstr0 commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

MarcAstr0 commented May 22, 2024

github-actions bot commented May 22, 2024

github-actions bot commented May 22, 2024

alvaroloes left a comment

MarcAstr0 commented May 28, 2024

github-actions bot commented May 28, 2024

github-actions bot commented May 28, 2024

MarcAstr0 commented May 28, 2024

github-actions bot commented May 28, 2024

github-actions bot commented May 28, 2024

MarcAstr0 commented May 29, 2024

github-actions bot commented May 29, 2024

github-actions bot commented May 29, 2024

alvaroloes left a comment

Allow define projection fields in read model queries #1481

Allow define projection fields in read model queries #1481

Conversation

gonzalojaubert commented Oct 25, 2023 • edited Loading

sweep-ai bot commented Oct 25, 2023

Apply Sweep Rules to your PR?

ghost commented Oct 25, 2023 • edited by ghost Loading

Legend

gonzalogarciajaubert commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

github-actions bot commented Oct 25, 2023

MarcAstr0 commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

MarcAstr0 commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

MarcAstr0 commented May 22, 2024

github-actions bot commented May 22, 2024

github-actions bot commented May 22, 2024

alvaroloes left a comment

Choose a reason for hiding this comment

MarcAstr0 commented May 28, 2024

github-actions bot commented May 28, 2024

github-actions bot commented May 28, 2024

MarcAstr0 commented May 28, 2024

github-actions bot commented May 28, 2024

github-actions bot commented May 28, 2024

MarcAstr0 commented May 29, 2024

github-actions bot commented May 29, 2024

github-actions bot commented May 29, 2024

alvaroloes left a comment

Choose a reason for hiding this comment

gonzalojaubert commented Oct 25, 2023 •

edited

Loading

ghost commented Oct 25, 2023 •

edited by ghost

Loading