Add EventStore Hosting and Client integrations #277

fredimachado · 2024-11-21T08:03:51Z

Closes #236

This pull request includes several updates to the Aspire CommunityToolkit including new projects for EventStore Hosting and Client integrations, a simple "bank account" example project, tests and updates to dependencies.

Project Additions and Updates:

Added new EventStore projects to the solution, including Aspire.CommunityToolkit.Hosting.EventStore, Aspire.CommunityToolkit.EventStore, and their respective test and example projects.

Dependency Updates:

Added new dependencies in Directory.Packages.props, including AspNetCore.HealthChecks.EventStore.gRPC, EventStore.Client.Extensions.OpenTelemetry, and EventStore.Client.Grpc.Streams. (Directory.Packages.props) [1]

Code Ownership:

Updated the CODEOWNERS file to include new EventStore projects and assigned ownership to @fredimachado. (CODEOWNERS)

New Example Project:

Added a simple "bank account" example project for EventStore service. (examples/eventstore/Aspire.CommunityToolkit.Hosting.EventStore.ApiService) [1]

PR Checklist

Other information

Docs PR: dotnet/docs-aspire#2143

aaronpowell

I don't see tests for the client integration, only the hosting, I assume that they are still to come

CODEOWNERS

src/CommunityToolkit.Aspire.Hosting.EventStore/EventStoreBuilderExtensions.cs

src/CommunityToolkit.Aspire.Hosting.EventStore/README.md

tests/CommunityToolkit.Aspire.Hosting.EventStore.Tests/AppHostTests.cs

tests/CommunityToolkit.Aspire.Hosting.EventStore.Tests/EventStorePublicApiTests.cs

fredimachado · 2024-11-22T12:06:44Z

I don't see tests for the client integration, only the hosting, I assume that they are still to come

Addressed in this commit: 8fc728b

aaronpowell

Looks really good @fredimachado

I've kicked off a build, once it's clean we can look to merge it in.

You should also have an invite to the contributor team (which will sort out the CODEOWNERS)

src/CommunityToolkit.Aspire.EventStore/AspireEventStoreExtensions.cs

src/CommunityToolkit.Aspire.Hosting.EventStore/EventStoreBuilderExtensions.cs

tests/CommunityToolkit.Aspire.EventStore.Tests/ConformanceTests.cs

Alirexaa

Besides of suggested change totally LGTM.

Alirexaa

I reviewed tests and did not see tests around persistence and health check functionality.

Could you add these tests?
there are some examples at
https://github.com/CommunityToolkit/Aspire/blob/main/tests/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchFunctionalTests.cs

fredimachado · 2024-11-25T08:28:24Z

I reviewed tests and did not see tests around persistence and health check functionality.

Could you add these tests? there are some examples at https://github.com/CommunityToolkit/Aspire/blob/main/tests/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchFunctionalTests.cs

I thought AppHostTests would also count as persistence tests, since it uses the example API to append and then read events from EventStore.

Alirexaa · 2024-11-25T09:16:46Z

I reviewed tests and did not see tests around persistence and health check functionality.
Could you add these tests? there are some examples at https://github.com/CommunityToolkit/Aspire/blob/main/tests/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchFunctionalTests.cs

I thought AppHostTests would also count as persistence tests, since it uses the example API to append and then read events from EventStore.

AppHost does not stop across tests. So it's not enough for all cases.

fredimachado · 2024-11-25T10:13:27Z

I reviewed tests and did not see tests around persistence and health check functionality.
Could you add these tests? there are some examples at https://github.com/CommunityToolkit/Aspire/blob/main/tests/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchFunctionalTests.cs

I thought AppHostTests would also count as persistence tests, since it uses the example API to append and then read events from EventStore.

AppHost does not stop across tests. So it's not enough for all cases.

All good. I added the functional tests based on the Meilisearch ones. d78ff8f

aaronpowell

I'm happy with how it's looking with the extra tests, but I'll defer to @Alirexaa for final say

fredimachado · 2024-11-25T22:45:46Z

@Alirexaa I removed the Log volume/mount since it's probably not going to be used often, and we can always use WithVolume extension method in the ResourceBuilder to manually add the log volume if necessary.

fredimachado · 2024-11-25T23:09:23Z

@aaronpowell I noticed the SWA example test is stuck during the build's Test step.
I noticed some packages have vulnerabilities, not sure if it has something to do with that. Windows Tests are runnng fine though.

Run npm install -g @azure/static-web-apps-cli
(node:3792) ExperimentalWarning: CommonJS module /opt/hostedtoolcache/node/23.3.0/x64/lib/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /opt/hostedtoolcache/node/23.3.0/x64/lib/node_modules/npm/node_modules/supports-color/index.js using require().
Support for loading ES Module in require() is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
npm warn deprecated [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
npm warn deprecated [email protected]: Glob versions prior to v9 are no longer supported
npm warn deprecated [email protected]: Rimraf versions prior to v4 are no longer supported

changed 345 packages in 15s

72 packages are looking for funding
  run `npm fund` for details
(node:3822) ExperimentalWarning: CommonJS module /opt/hostedtoolcache/node/23.3.0/x64/lib/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /opt/hostedtoolcache/node/23.3.0/x64/lib/node_modules/npm/node_modules/supports-color/index.js using require().
Support for loading ES Module in require() is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)

added 199 packages, and audited [20](https://github.com/CommunityToolkit/Aspire/actions/runs/12020126580/job/33508109977?pr=277#step:18:21)0 packages in 3s

42 packages are looking for funding
  run `npm fund` for details

2 vulnerabilities (1 moderate, 1 high)

To address all issues, run:
  npm audit fix

Run `npm audit` for details.

aaronpowell · 2024-11-27T23:56:26Z

It looks like we have a test that is hanging and causing the Linux runner to time out after several hours.

Assuming that these tests pass locally, this is going to be a fun one to try and resolve 🤣. Comparing the test results artifacts between Windows and Linux the only missing TRX file is the CommunityToolkit.Aspire.Hosting.EventStore.Tests, which suggests that the problematic tests are in that project.

The most likely candidates for the issue is going to be the tests in the EventStoreFunctionalTests.cs file. When I've seen this problem in the past it is related to the test waiting for something to complete that never completes but is still running "successfully" so a timeout on the async method doesn't work.

Here's the steps I'd go through to try and resolve it:

Add a Skip attribute to all tests in that file and push
1.1. If the runner still times out, also skip the test that use the example project - basically all tests that use Docker since they don't run on Windows
Add one test back per push until you find the test that causes the runner to not exit

Once you know what test is the problematic one, we'll be able to help diagnose the underlying problem.

fredimachado · 2024-11-27T23:58:40Z

All good, thanks for the suggestions. I'll try it.

aaronpowell · 2024-11-28T00:00:02Z

All good, thanks for the suggestions. I'll try it.

Unfortunately, this isn't the first time I've seen runners hang 🤣

aaronpowell · 2024-11-28T01:17:26Z

Well, looks like we found where the tests are that are the problem

fredimachado · 2024-11-28T08:00:39Z

It seems the we had to change permissions for the data bind mount to work on the Ubuntu build.
cc @aaronpowell @Alirexaa

aaronpowell · 2024-11-29T00:44:22Z

It seems the we had to change permissions for the data bind mount to work on the Ubuntu build. cc @aaronpowell @Alirexaa

That's interesting, wonder why...

aaronpowell · 2024-11-29T00:45:34Z

Just waiting for another review from @Alirexaa and it should be good to go

Alirexaa

@fredimachado Please take a look at my comments.
Otherwise LGTM

Alirexaa · 2024-11-29T07:44:42Z

tests/CommunityToolkit.Aspire.Hosting.EventStore.Tests/EventStoreFunctionalTests.cs

@@ -120,16 +131,18 @@ public async Task WithDataShouldPersistStateBetweenUsages(bool useVolume)
            }
            else
            {
+                //EventStore shutdown can be slightly delayed, so second instance might fail to start when using the same bind mount before shutdown.
+                await Task.Delay(TimeSpan.FromSeconds(5));


This could incur flakiness.

Related dotnet/aspire#4878

Alirexaa · 2024-11-29T07:51:28Z

tests/CommunityToolkit.Aspire.Hosting.EventStore.Tests/EventStoreFunctionalTests.cs

@@ -191,7 +204,7 @@ public async Task VerifyWaitForEventStoreBlocksDependentResources()
        var resource = builder.AddEventStore("resource")
                              .WithHealthCheck("blocking_check");

-        var dependentResource = builder.AddEventStore("dependentresource")
+        var dependentResource = builder.AddContainer("nginx", "mcr.microsoft.com/cbl-mariner/base/nginx", "1.22")


Is this a light (meaning small image size and fast startup) container image?
If it is we could use this image for dependent resources in health check tests like this test to speed up our tests.

Exactly, I used this specifically because it's lightweight and fast to start.
I've seen usages of this image for the same purpose in the main Aspire repo.

Alirexaa · 2024-11-29T07:59:18Z

@aaronpowell, CodeQL is blocking me to merge PR.

aaronpowell · 2024-11-29T08:06:33Z

@aaronpowell, CodeQL is blocking me to merge PR.

Grr, I need to find out why that happens

fredimachado · 2024-11-29T08:17:59Z

Thanks @aaronpowell and @Alirexaa for your support.

fredimachado mentioned this pull request Nov 21, 2024

CommunityToolkit docs for EventStore integration dotnet/docs-aspire#2143

Merged

aaronpowell requested changes Nov 22, 2024

View reviewed changes

fredimachado force-pushed the eventstore-integration branch from c91cf2c to 1302216 Compare November 23, 2024 23:13

fredimachado requested a review from aaronpowell November 23, 2024 23:13

aaronpowell approved these changes Nov 24, 2024

View reviewed changes

Alirexaa reviewed Nov 25, 2024

View reviewed changes

src/CommunityToolkit.Aspire.EventStore/AspireEventStoreExtensions.cs Outdated Show resolved Hide resolved

src/CommunityToolkit.Aspire.Hosting.EventStore/EventStoreBuilderExtensions.cs Outdated Show resolved Hide resolved

fredimachado requested review from Alirexaa and aaronpowell November 25, 2024 07:40

Alirexaa reviewed Nov 25, 2024

View reviewed changes

tests/CommunityToolkit.Aspire.EventStore.Tests/ConformanceTests.cs Outdated Show resolved Hide resolved

Alirexaa approved these changes Nov 25, 2024

View reviewed changes

Alirexaa requested changes Nov 25, 2024

View reviewed changes

fredimachado requested a review from Alirexaa November 25, 2024 10:12

aaronpowell approved these changes Nov 25, 2024

View reviewed changes

fredimachado added 9 commits November 25, 2024 22:17

Add EventStore Hosting and Client integrations

f543c2b

Update CODEOWNERS

5da0502

Address PR feedback

259b29b

Add client integration tests

bb12675

Update AddEventStoreTests.cs

6843bd9

Add HealthCheckTimeout setting

a8b8066

Remove HealthCheckTimeout from Conformance tests

ebd5908

Remove Atom Pub over HTTP as support is deprecated

8998861

Add Functional tests

2daf3c8

fredimachado force-pushed the eventstore-integration branch from d78ff8f to 2daf3c8 Compare November 25, 2024 11:17

Log volume and mount can be added manually

1d93d6c

aaronpowell and others added 2 commits November 28, 2024 10:28

Merge branch 'main' into eventstore-integration

7cad08f

Remove unused const

d0c35a0

Update EventStoreFunctionalTests.cs

8553d6f

fredimachado added 14 commits November 28, 2024 12:56

Update EventStoreFunctionalTests.cs

6a1b859

Update EventStoreFunctionalTests.cs

9fc57ec

Wait for resource to be healthy

90fceff

Update EventStoreFunctionalTests.cs

58f537c

Update EventStoreFunctionalTests.cs

61d2676

Fix typo

396fe02

Use Cts

20e91bf

Update EventStoreFunctionalTests.cs

cdae698

Check last test

282d122

Update EventStoreFunctionalTests.cs

8011a92

Trying all tests

30f10e9

Update EventStoreFunctionalTests.cs

0ff0242

Update EventStoreFunctionalTests.cs

d9c770b

Update EventStoreFunctionalTests.cs

f0d33f8

Alirexaa approved these changes Nov 29, 2024

View reviewed changes

aaronpowell merged commit ea964f7 into CommunityToolkit:main Nov 29, 2024
8 checks passed

fredimachado mentioned this pull request Nov 29, 2024

Update EventStore docs dotnet/docs-aspire#2166

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add EventStore Hosting and Client integrations #277

Add EventStore Hosting and Client integrations #277

fredimachado commented Nov 21, 2024 •

edited

Loading

aaronpowell left a comment

fredimachado commented Nov 22, 2024

aaronpowell left a comment

Alirexaa left a comment

Alirexaa left a comment •

edited

Loading

fredimachado commented Nov 25, 2024

Alirexaa commented Nov 25, 2024

fredimachado commented Nov 25, 2024

aaronpowell left a comment

fredimachado commented Nov 25, 2024

fredimachado commented Nov 25, 2024

aaronpowell commented Nov 27, 2024

fredimachado commented Nov 27, 2024

aaronpowell commented Nov 28, 2024

aaronpowell commented Nov 28, 2024

fredimachado commented Nov 28, 2024 •

edited

Loading

aaronpowell commented Nov 29, 2024

aaronpowell commented Nov 29, 2024

Alirexaa left a comment

Alirexaa Nov 29, 2024

Alirexaa Nov 29, 2024

fredimachado Nov 29, 2024

Alirexaa commented Nov 29, 2024

aaronpowell commented Nov 29, 2024

fredimachado commented Nov 29, 2024

Add EventStore Hosting and Client integrations #277

Add EventStore Hosting and Client integrations #277

Conversation

fredimachado commented Nov 21, 2024 • edited Loading

Project Additions and Updates:

Dependency Updates:

Code Ownership:

New Example Project:

PR Checklist

Other information

aaronpowell left a comment

Choose a reason for hiding this comment

fredimachado commented Nov 22, 2024

aaronpowell left a comment

Choose a reason for hiding this comment

Alirexaa left a comment

Choose a reason for hiding this comment

Alirexaa left a comment • edited Loading

Choose a reason for hiding this comment

fredimachado commented Nov 25, 2024

Alirexaa commented Nov 25, 2024

fredimachado commented Nov 25, 2024

aaronpowell left a comment

Choose a reason for hiding this comment

fredimachado commented Nov 25, 2024

fredimachado commented Nov 25, 2024

aaronpowell commented Nov 27, 2024

fredimachado commented Nov 27, 2024

aaronpowell commented Nov 28, 2024

aaronpowell commented Nov 28, 2024

fredimachado commented Nov 28, 2024 • edited Loading

aaronpowell commented Nov 29, 2024

aaronpowell commented Nov 29, 2024

Alirexaa left a comment

Choose a reason for hiding this comment

Alirexaa Nov 29, 2024

Choose a reason for hiding this comment

Alirexaa Nov 29, 2024

Choose a reason for hiding this comment

fredimachado Nov 29, 2024

Choose a reason for hiding this comment

Alirexaa commented Nov 29, 2024

aaronpowell commented Nov 29, 2024

fredimachado commented Nov 29, 2024

fredimachado commented Nov 21, 2024 •

edited

Loading

Alirexaa left a comment •

edited

Loading

fredimachado commented Nov 28, 2024 •

edited

Loading