Merge pull request #163 from castore-dev/return-initialEventTimestamp-in-listAggregateIds-method

feature: return initialEventTimestamp in listAggregateIds method

Author: ThomasAribart

.github/actions/install-node-modules-and-package/action.yml

@@ -0,0 +1,54 @@
+name: Install Node Dependencies
+description: Install dependencies using yarn
+inputs:
+  typescript-version:
+    description: TS version to use
+    default: 'default'
+
+runs:
+  using: composite
+  steps:
+    - name: Use Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ env.NODE_VERSION }}
+
+    - name: Get yarn cache directory path
+      id: yarn-cache-dir-path
+      run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
+      shell: bash
+
+    - name: Sync yarn cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('./yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
+
+    - name: Sync node_modules cache
+      id: sync-node-modules-cache
+      uses: actions/cache@v3
+      with:
+        path: '**/node_modules'
+        key: ${{ runner.os }}-modules-${{ inputs.typescript-version }}-${{ hashFiles('./yarn.lock') }}
+
+    - name: Install node_modules
+      run: if [ '${{ steps.sync-node-modules-cache.outputs.cache-hit }}' != 'true' ]; then yarn install --immutable; fi
+      shell: bash
+
+    - name: Override TS with specified version
+      run: if [ '${{ inputs.typescript-version }}' != 'default' ] && [ '${{ steps.sync-node-modules-cache.outputs.cache-hit }}' != 'true' ]; then yarn add --dev typescript@${{ inputs.typescript-version }}; fi
+      shell: bash
+
+    - name: Sync packages cache
+      id: sync-packages-cache
+      uses: actions/cache@v3
+      with:
+        path: |
+          node_modules/@castore/**/dist
+        key: ts-${{ inputs.typescript-version }}-${{ hashFiles('./packages/**') }}-${{ hashFiles('./demo/**') }}
+
+    - name: Package
+      run: if [ '${{ steps.sync-packages-cache.outputs.cache-hit }}' != 'true' ]; then yarn package; fi
+      shell: bash

.github/workflows/draft-or-update-next-release.yml

@@ -8,7 +8,7 @@ on:
 
 env:
   CI: true
-  NODE_VERSION: 16
+  NODE_VERSION: 18
 
 jobs:
   prepare-deployment:

.github/workflows/label-pr.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   CI: true
-  NODE_VERSION: 16
+  NODE_VERSION: 18
 
 defaults:
   run:

.github/workflows/test-pr.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   CI: true
-  NODE_VERSION: 16
+  NODE_VERSION: 18
 
 defaults:
   run:
@@ -21,6 +21,24 @@ jobs:
     name: 🏗 Build Project
     runs-on: ubuntu-latest
     timeout-minutes: 30
+    strategy:
+      matrix:
+        typescript-version:
+          ['default', '~4.6.4', '~4.7.4', '~4.8.3', '~4.9.5', '~5.0.4']
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Install node_modules & package
+        uses: ./.github/actions/install-node-modules-and-package
+        with:
+          typescript-version: ${{ matrix.typescript-version }}
+
+  get-affected-packages:
+    name: 🔎 Get affected packages
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
     outputs:
       affected-packages: ${{ steps.get-affected-packages-paths.outputs.affected-packages }}
     steps:
@@ -30,36 +48,34 @@ jobs:
           # We need to fetch all branches and commits so that Nx affected has a base to compare against.
           fetch-depth: 0
 
-      - name: Install node_modules
-        uses: ./.github/actions/install-node-modules
-
-      - name: Package
-        uses: ./.github/actions/package
-
       - name: Get affected packages paths
         id: get-affected-packages-paths
         uses: ./.github/actions/get-affected-packages-paths
         with:
           base-branch: ${{ github.base_ref }}
 
   library-lint-and-tests:
-    name: 🎯 Run Tests
-    needs: build
+    name: 🎯 Run tests
+    needs: [build, get-affected-packages]
     runs-on: ubuntu-latest
-    if: join(fromJson(needs.build.outputs.affected-packages)) != ''
+    if: join(fromJson(needs.get-affected-packages.outputs.affected-packages)) != ''
     timeout-minutes: 30
     strategy:
       fail-fast: false
       matrix:
-        AFFECTED_LIB: ${{ fromJson(needs.build.outputs.affected-packages) }}
+        affected-package: ${{ fromJson(needs.get-affected-packages.outputs.affected-packages) }}
+        typescript-version:
+          ['default', '~4.6.4', '~4.7.4', '~4.8.3', '~4.9.5', '~5.0.4']
     steps:
       - uses: actions/checkout@v3
         with:
           ref: ${{ github.event.pull_request.head.sha }}
+
       - name: Run tests
         uses: ./.github/actions/lint-and-tests
         with:
-          path: ${{ matrix.AFFECTED_LIB }}
+          path: ${{ matrix.affected-package }}
+          typescript-version: ${{ matrix.typescript-version }}
 
   validate-pr:
     name: ✅ Validate the PR
@@ -73,6 +89,7 @@ jobs:
             echo "build failed"
             exit 1
           fi
+
       - name: Validate tests
         run: |
           if [[ ${{ needs.library-lint-and-tests.result }} = "failure" ]]; then

packages/core/src/eventStorageAdapter.ts

@@ -23,7 +23,10 @@ export type ListAggregateIdsOptions = {
 };
 
 export type ListAggregateIdsOutput = {
-  aggregateIds: string[];
+  aggregateIds: {
+    aggregateId: string;
+    initialEventTimestamp: string;
+  }[];
   nextPageToken?: string;
 };
 

packages/core/src/messaging/message.ts

@@ -4,6 +4,7 @@ import type { EventDetail } from '~/event/eventDetail';
 export type AggregateExistsMessage<EVENT_STORE_ID extends string = string> = {
   eventStoreId: EVENT_STORE_ID;
   aggregateId: string;
+  initialEventTimestamp: string;
 };
 
 export type NotificationMessage<

packages/event-storage-adapter-dynamodb/src/legacyAdapter.ts

@@ -399,7 +399,7 @@ export class LegacyDynamoDBEventStorageAdapter implements EventStorageAdapter {
       }
 
       const {
-        Items: unmarshalledInitialEvents = [],
+        Items: marshalledInitialEvents = [],
         LastEvaluatedKey: lastEvaluatedKey,
       } = await this.dynamoDBClient.send(
         new QueryCommand(aggregateIdsQueryCommandInput),
@@ -414,12 +414,12 @@ export class LegacyDynamoDBEventStorageAdapter implements EventStorageAdapter {
       };
 
       return {
-        aggregateIds: unmarshalledInitialEvents
+        aggregateIds: marshalledInitialEvents
           .map(item => unmarshall(item))
           .map(item => {
-            const { aggregateId } = item as Pick<EventDetail, 'aggregateId'>;
+            const { aggregateId, timestamp } = item as EventDetail;
 
-            return aggregateId;
+            return { aggregateId, initialEventTimestamp: timestamp };
           }),
         ...(lastEvaluatedKey !== undefined
           ? { nextPageToken: JSON.stringify(parsedNextPageToken) }

packages/event-storage-adapter-dynamodb/src/legacyAdapter.unit.test.ts

@@ -302,8 +302,11 @@ describe('LegacyDynamoDBEventStorageAdapter', () => {
       const secondAggregateIdMock = 'my-second-aggregate-id';
       const queryCommandOutputMock: QueryCommandOutput = {
         Items: [
-          marshall({ aggregateId }),
-          marshall({ aggregateId: secondAggregateIdMock }),
+          marshall({ aggregateId, timestamp: timestampA }),
+          marshall({
+            aggregateId: secondAggregateIdMock,
+            timestamp: timestampB,
+          }),
         ],
         $metadata: {},
       };
@@ -326,7 +329,13 @@ describe('LegacyDynamoDBEventStorageAdapter', () => {
       });
 
       // We have to serialize / deserialize because DynamoDB numbers are not regular numbers
-      expect(aggregateIds).toMatchObject([aggregateId, secondAggregateIdMock]);
+      expect(aggregateIds).toMatchObject([
+        { aggregateId, initialEventTimestamp: timestampA },
+        {
+          aggregateId: secondAggregateIdMock,
+          initialEventTimestamp: timestampB,
+        },
+      ]);
     });
 
     it('adds limit option', async () => {

packages/event-storage-adapter-dynamodb/src/singleTableAdapter.ts

@@ -414,7 +414,7 @@ export class DynamoDBSingleTableEventStorageAdapter
       }
 
       const {
-        Items: unmarshalledInitialEvents = [],
+        Items: marshalledInitialEvents = [],
         LastEvaluatedKey: lastEvaluatedKey,
       } = await this.dynamoDBClient.send(
         new QueryCommand(aggregateIdsQueryCommandInput),
@@ -429,12 +429,15 @@ export class DynamoDBSingleTableEventStorageAdapter
       };
 
       return {
-        aggregateIds: unmarshalledInitialEvents
+        aggregateIds: marshalledInitialEvents
           .map(item => unmarshall(item))
           .map(item => {
-            const { aggregateId } = item as Pick<EventDetail, 'aggregateId'>;
+            const { aggregateId, timestamp } = item as EventDetail;
 
-            return unprefixAggregateId(eventStoreId, aggregateId);
+            return {
+              aggregateId: unprefixAggregateId(eventStoreId, aggregateId),
+              initialEventTimestamp: timestamp,
+            };
           }),
         ...(lastEvaluatedKey !== undefined
           ? { nextPageToken: JSON.stringify(parsedNextPageToken) }

packages/event-storage-adapter-dynamodb/src/singleTableAdapter.unit.test.ts

@@ -294,9 +294,10 @@ describe('DynamoDBEventStorageAdapter', () => {
       const secondAggregateIdMock = 'my-second-aggregate-id';
       const queryCommandOutputMock: QueryCommandOutput = {
         Items: [
-          marshall({ aggregateId: prefixedAggregateId }),
+          marshall({ aggregateId: prefixedAggregateId, timestamp: timestampA }),
           marshall({
             aggregateId: prefixAggregateId(eventStoreId, secondAggregateIdMock),
+            timestamp: timestampB,
           }),
         ],
         $metadata: {},
@@ -323,7 +324,13 @@ describe('DynamoDBEventStorageAdapter', () => {
       });
 
       // We have to serialize / deserialize because DynamoDB numbers are not regular numbers
-      expect(aggregateIds).toMatchObject([aggregateId, secondAggregateIdMock]);
+      expect(aggregateIds).toMatchObject([
+        { aggregateId, initialEventTimestamp: timestampA },
+        {
+          aggregateId: secondAggregateIdMock,
+          initialEventTimestamp: timestampB,
+        },
+      ]);
     });
 
     it('adds limit option', async () => {