feat(docs,emmet-expressjs): add e2e api specification #29

thiagomini · 2024-03-02T14:24:14Z

Closes #26

Hey @oskardudycz , I haven't added the ES db yet because I'm unsure how to replace the inMemoryStore(). However, I believe this draft may suffice as an initial discussion for that issue. It took me some time to figure out how everything worked and glued together, but I feel I'm understanding the architecture better now 😅

One thing I'd like to ask / discuss is the no-unsafe-assignement rule that we're using here and it's complaining all over the place - is this intended? Honestly, in many cases it doesn't make sense, look at this example:

The getInMemoryEventStore() function has a defined return value, yet this rule is complaining 🤔

Anyway, let me know what you think about this initial implementation!

closes event-driven-io#26

thiagomini · 2024-03-02T14:24:44Z

docs/snippets/gettingStarted/webApi/apiBDD.e2e.spec.ts

+  let shoppingCartId: string;
+
+  beforeEach(() => {
+    clientId = randomUUID();


Notice that we don't need the uuid() library to generate uuid v4 - it's already supported by node's native "crypto" module

Ah, cool. For those needs, this will be sufficient. Happy to remove the dependency on uuid package!

thiagomini · 2024-03-02T14:25:28Z

docs/snippets/gettingStarted/webApi/apiBDD.e2e.spec.ts

+          .send(productItem),
+      )
+        .when((request) =>
+          request.get(`/clients/${clientId}/shopping-carts/current`).send(),


I've created this temporary workaround get method - I thought that it would be good to do this and in the future we just need to change the underlying implementation detail to use projections

Yes, sounds good to me, I like the idea. Thanks to that, we'll have the full coverage.

thiagomini · 2024-03-02T14:25:41Z

docs/snippets/gettingStarted/webApi/shoppingCart.ts

@@ -52,6 +52,7 @@ export enum ShoppingCartStatus {
  Pending = 'Pending',
  Confirmed = 'Confirmed',
  Canceled = 'Canceled',
+  Opened = 'Opened',


This was necessary so I could check for it in the e2e test

thiagomini · 2024-03-02T14:26:32Z

packages/emmett-expressjs/src/e2e/decider/applicationLogicWithOC.int.spec.ts

@@ -44,7 +44,6 @@ describe('Application logic with optimistic concurrency', () => {

    if (!current.id) {
      assert.fail();
-      return;


when we call assert.fail(), node automatically throws an assertion error, so this line was unreachable

ah, didn't know that. Thanks for the hint!

thiagomini · 2024-03-02T14:32:27Z

packages/emmett-expressjs/src/testing/apiSpecification.ts

@@ -59,9 +61,9 @@ export const expectNewEvents = <EventType extends Event = Event>(
 };

 export const expectResponse =
-  (
+  <Body = unknown>(


A small addition to the expectResponse matcher so we can optionally type the body

Makes perfect sense to me, thanks for doing that! 🫡

oskardudycz · 2024-03-04T15:24:23Z

docs/snippets/gettingStarted/webApi/simpleApi.ts

+            clientId: assertNotEmptyString(request.params.clientId),
+            id: shoppingCartId,
+            productItems,
+            status: result?.state.status,


SUGGESTION: I think that instead of using ? here, you could return NotFound status if result is null

oskardudycz · 2024-03-04T15:24:56Z

docs/snippets/gettingStarted/webApi/simpleApi.ts

@@ -139,6 +141,40 @@ export const shoppingCartApi =
        return NoContent();
      }),
    );
+
+    // Get Shopping Cart
+    router.get(


FIX: @thiagomini, for now I'd prefer to keep the sample outside of the complete-api region as the example in the getting started is (for now) focused on business logic and writing. I'm planning to introduce the read model side as the next step. Would you mind moving this endpoint outside the region?

oskardudycz · 2024-03-04T15:25:12Z

docs/snippets/gettingStarted/webApi/simpleApi.ts

@@ -139,6 +141,40 @@ export const shoppingCartApi =
        return NoContent();
      }),
    );
+
+    // Get Shopping Cart
+    router.get(


HINT: The method as a test method is okay as it is. You could consider providing the customised evolve method that would already build the desired read model without the need to do the additional mapping. But that's a nice to have if you wanted to play more with event sourcing. This would be a dedicated ShoppingCartDetails type with is own evolve function.

This is the only change I didn't apply, @oskardudycz - I'd like to dedicate a separate issue to that, so I can focus on creating that projection

Fine by me 🙂

oskardudycz · 2024-03-04T15:27:53Z

packages/emmett-expressjs/src/testing/apiSpecification.ts

@@ -151,6 +161,50 @@ export const ApiSpecification = {
  },
 };

+export const ApiE2ESpecification = {


CONCERN: @thiagomini, maybe we could break those specifications into separate files? Thoughts?

Sure, I can do that!

oskardudycz · 2024-03-04T15:28:47Z

packages/emmett-expressjs/src/testing/apiSpecification.ts

@@ -151,6 +161,50 @@ export const ApiSpecification = {
  },
 };

+export const ApiE2ESpecification = {


Ah, and it looks good to me, just as I imagined it 👍

- Updated http responses to allow returning problem without options (e.g. NotFound) - Fixed path to ESDB package in tsconfig

oskardudycz · 2024-03-04T16:01:45Z

Regarding the lint errors, in my case for VSCode restarting the ESLint server fixes issue (and it's a "known issue" on their side, see https://discord.com/channels/1211601942984532018/1211601943433060433/1213043016512573480 :|). For ts, it's not but might be that's mishap on my side configuring paths. I'll try to look into that.

oskardudycz

@thiagomini it looks good to me even as it is. Check my comments, if you'd like to apply some of them. I added the EventStoreDB config for e2e tests, see details in my commit 🙂

- Move ApiE2ESpecification to its own file - Move common test setup functions to utils file - Fixed typos "succeded" -> "succeeded" - Changed api to return not found when shopping cart does not exist

…hiagomini/emmett into feat/add-request-based-arrange-section

…sed-arrange-section

oskardudycz · 2024-03-05T12:17:20Z

packages/emmett-expressjs/src/testing/apiSpecification.ts

                } else if (Array.isArray(verify)) {
                  const [first, ...rest] = verify;

                  if (typeof first === 'function') {
-                    const succeded = first(response);
+                    const succeeded = first(response);


@thiagomini, thanks for fixing my typos! 😅

Sure, no problem haha I only got them because I have the "Code Spell Cheker" extension in my VSCode

…o#29) * feat(docs,emmet-expressjs): add e2e api specification closes event-driven-io#26 * Configured E2E tests for using ESDB - Updated http responses to allow returning problem without options (e.g. NotFound) - Fixed path to ESDB package in tsconfig * refactor(docs,emmett-expressjs): apply review changes - Move ApiE2ESpecification to its own file - Move common test setup functions to utils file - Fixed typos "succeded" -> "succeeded" - Changed api to return not found when shopping cart does not exist * fix(emmett-expressjs): fix import statement --------- Co-authored-by: Oskar Dudycz <oskar.dudycz@gmail.com>

* feat: prepare base fastify template feat: add some defaults plugins feat: start working on tests feat: working with types feat: finished test feat: finished test feat: update package * feat: general server options * Fix martendb.io link in README.md * feat(docs,emmet-expressjs): add e2e api specification (#29) * feat(docs,emmet-expressjs): add e2e api specification closes #26 * Configured E2E tests for using ESDB - Updated http responses to allow returning problem without options (e.g. NotFound) - Fixed path to ESDB package in tsconfig * refactor(docs,emmett-expressjs): apply review changes - Move ApiE2ESpecification to its own file - Move common test setup functions to utils file - Fixed typos "succeded" -> "succeeded" - Changed api to return not found when shopping cart does not exist * fix(emmett-expressjs): fix import statement --------- Co-authored-by: Oskar Dudycz <oskar.dudycz@gmail.com> * fix: remove default middlewares to extend developers expirience * Fixed fastify API tests and typing around plugins Fixed also linter errors --------- Co-authored-by: futpib <futpib@gmail.com> Co-authored-by: Thiago Valentim <51245643+thiagomini@users.noreply.github.com> Co-authored-by: Oskar Dudycz <oskar.dudycz@gmail.com>

feat(docs,emmet-expressjs): add e2e api specification

c0c3050

closes event-driven-io#26

thiagomini commented Mar 2, 2024

View reviewed changes

oskardudycz reviewed Mar 4, 2024

View reviewed changes

Configured E2E tests for using ESDB

b9915d9

- Updated http responses to allow returning problem without options (e.g. NotFound) - Fixed path to ESDB package in tsconfig

oskardudycz marked this pull request as ready for review March 4, 2024 16:00

oskardudycz approved these changes Mar 4, 2024

View reviewed changes

thiagomini added 4 commits March 5, 2024 09:10

refactor(docs,emmett-expressjs): apply review changes

ce5ce81

- Move ApiE2ESpecification to its own file - Move common test setup functions to utils file - Fixed typos "succeded" -> "succeeded" - Changed api to return not found when shopping cart does not exist

Merge branch 'feat/add-request-based-arrange-section' of github.com:t…

38b9067

…hiagomini/emmett into feat/add-request-based-arrange-section

Merge remote-tracking branch 'upstream/main' into feat/add-request-ba…

c4b9a76

…sed-arrange-section

fix(emmett-expressjs): fix import statement

65b79ad

oskardudycz reviewed Mar 5, 2024

View reviewed changes

oskardudycz added enhancement New feature or request testing WebApi labels Mar 5, 2024

oskardudycz added this to the 0.4.0 milestone Mar 5, 2024

oskardudycz merged commit d649d83 into event-driven-io:main Mar 5, 2024
1 check passed

oskardudycz modified the milestones: 0.4.0, 0.5.0 Mar 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs,emmet-expressjs): add e2e api specification #29

feat(docs,emmet-expressjs): add e2e api specification #29

thiagomini commented Mar 2, 2024

thiagomini Mar 2, 2024

oskardudycz Mar 4, 2024

thiagomini Mar 2, 2024 •

edited

oskardudycz Mar 4, 2024

thiagomini Mar 2, 2024

thiagomini Mar 2, 2024

oskardudycz Mar 4, 2024

thiagomini Mar 2, 2024

oskardudycz Mar 4, 2024

oskardudycz Mar 4, 2024

oskardudycz Mar 4, 2024

oskardudycz Mar 4, 2024

thiagomini Mar 5, 2024

oskardudycz Mar 5, 2024

oskardudycz Mar 4, 2024

thiagomini Mar 5, 2024

oskardudycz Mar 4, 2024

oskardudycz commented Mar 4, 2024

oskardudycz left a comment

oskardudycz Mar 5, 2024

thiagomini Mar 5, 2024

feat(docs,emmet-expressjs): add e2e api specification #29

feat(docs,emmet-expressjs): add e2e api specification #29

Conversation

thiagomini commented Mar 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thiagomini Mar 2, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oskardudycz commented Mar 4, 2024

oskardudycz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thiagomini Mar 2, 2024 •

edited