test: add e2e test for dungeon adventure tutorial (module 1 to 3)

Author: cogwirrel

.github/workflows/ci.yml

@@ -44,12 +44,17 @@ jobs:
           name: build-artifact
           path: dist
   smoke_tests:
-    name: Smoke Tests - ${{matrix.package_manager}}
+    name: Smoke Tests - ${{matrix.smoke_test}}
     runs-on: codebuild-nx-plugin-for-aws-runner-${{ github.run_id }}-${{ github.run_attempt }}
     needs: build
     strategy:
       matrix:
-        package_manager: [npm, yarn, pnpm, bun]
+        smoke_test:
+          - npm
+          - yarn
+          - pnpm
+          - bun
+          - dungeon-adventure
     steps:
       - uses: actions/checkout@v4
         with:
@@ -60,8 +65,8 @@ jobs:
           name: build-artifact
           path: dist
       - uses: ./.github/actions/init-monorepo
-      - name: Smoke Test - ${{ matrix.package_manager }}
-        run: pnpm nx run @aws/nx-plugin-e2e:test -t "smoke test - ${{ matrix.package_manager }}"
+      - name: Smoke Test - ${{ matrix.smoke_test }}
+        run: pnpm nx run @aws/nx-plugin-e2e:test -t "smoke test - ${{ matrix.smoke_test }}"
   release:
     name: Release
     needs: [build, smoke_tests]

.github/workflows/pr.yml

@@ -44,12 +44,17 @@ jobs:
           name: build-artifact
           path: dist
   smoke_tests:
-    name: Smoke Tests - ${{matrix.package_manager}}
+    name: Smoke Tests - ${{matrix.smoke_test}}
     runs-on: codebuild-nx-plugin-for-aws-runner-${{ github.run_id }}-${{ github.run_attempt }}
     needs: build
     strategy:
       matrix:
-        package_manager: [npm, yarn, pnpm, bun]
+        smoke_test:
+          - npm
+          - yarn
+          - pnpm
+          - bun
+          - dungeon-adventure
     steps:
       - uses: actions/checkout@v4
         with:
@@ -60,5 +65,5 @@ jobs:
           name: build-artifact
           path: dist
       - uses: ./.github/actions/init-monorepo
-      - name: Smoke Test - ${{ matrix.package_manager }}
-        run: pnpm nx run @aws/nx-plugin-e2e:test -t "smoke test - ${{ matrix.package_manager }}"
+      - name: Smoke Test - ${{ matrix.smoke_test }}
+        run: pnpm nx run @aws/nx-plugin-e2e:test -t "smoke test - ${{ matrix.smoke_test }}"

docs/src/components/create-nx-workspace-command.astro

@@ -1,7 +1,8 @@
 ---
 import PackageManagerCommand from './package-manager-command.astro';
+import { buildCreateNxWorkspaceCommand } from '../../../e2e/src/utils';
 
 const { workspace } = Astro.props;
-const buildCommand = (pm) => `npx create-nx-workspace@~21.0.3 ${workspace} --pm=${pm} --preset=ts --ci=skip --formatter=prettier`;
+const buildCommand = (pm) => buildCreateNxWorkspaceCommand(pm, workspace);
 ---
 <PackageManagerCommand buildCommand={buildCommand} />

docs/src/components/diff.astro

@@ -0,0 +1,14 @@
+---
+import { Code } from '@astrojs/starlight/components';
+import { diffLines } from 'diff';
+
+const { before, after, lang } = Astro.props;
+
+const diff = diffLines(before, after, { newlineIsToken: false })
+  .map(change => {
+    const prefix = change.added ? '+' : change.removed ? '-' : '';
+    return change.value.slice(0, -1).split('\n').map(line => `${prefix}${line}`).join('\n') + '\n';
+  }).join('');
+
+---
+<Code lang="diff" code={diff} {...(lang ? { meta: `lang="${lang}"`} : {})} />

docs/src/components/e2e-code.astro

@@ -0,0 +1,8 @@
+---
+import { Code } from '@astrojs/starlight/components';
+const e2eFiles = Object.entries(import.meta.glob('../../../e2e/src/files/**/*.template', { eager: true, query: '?raw' }));
+
+const { path, ...props } = Astro.props;
+const code = e2eFiles.find(([file, content]) => file.endsWith(path))[1].default;
+---
+<Code {...props} code={code} />

docs/src/components/e2e-diff.astro

@@ -0,0 +1,9 @@
+---
+import Diff from './diff.astro';
+
+const e2eFiles = Object.entries(import.meta.glob('../../../e2e/src/files/**/*.template', { eager: true, query: '?raw' }));
+const { before, after, lang } = Astro.props;
+const beforeContent = e2eFiles.find(([file, content]) => file.endsWith(before))[1].default;
+const afterContent = e2eFiles.find(([file, content]) => file.endsWith(after))[1].default;
+---
+<Diff before={beforeContent} after={afterContent} lang={lang} />

docs/src/content/docs/en/get_started/tutorials/dungeon-game/1.mdx

@@ -11,6 +11,8 @@ import RunGenerator from '@components/run-generator.astro';
 import NxCommands from '@components/nx-commands.astro';
 import InstallCommand from '@components/install-command.astro';
 import CreateNxWorkspaceCommand from '@components/create-nx-workspace-command.astro';
+import E2EDiff from '@components/e2e-diff.astro';
+
 import dungeonAdventureArchitecturePng from '@assets/dungeon-game-architecture.png'
 import dungeonAdventureErPng from '@assets/dungeon-adventure-er.png'
 import baselineWebsitePng from '@assets/baseline-website.png'
@@ -137,7 +139,7 @@ import {
 } from '@trpc/server/adapters/aws-lambda';
 import { echo } from './procedures/echo.js';
 import { t } from './init.js';
-import { APIGatewayProxyEventV2WithIAMAuthorizer } from 'aws-lambda';
+import { APIGatewayProxyEvent } from 'aws-lambda';
 
 export const router = t.router;
 
@@ -148,8 +150,14 @@ export const appRouter = router({
 export const handler = awsLambdaRequestHandler({
   router: appRouter,
   createContext: (
-    ctx: CreateAWSLambdaContextOptions<APIGatewayProxyEventV2WithIAMAuthorizer>,
+    ctx: CreateAWSLambdaContextOptions<APIGatewayProxyEvent>,
   ) => ctx,
+  responseMeta: () => ({
+    headers: {
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': '*',
+    },
+  }),
 });
 
 export type AppRouter = typeof appRouter;
@@ -1015,41 +1023,8 @@ This is where we will instantiate our CDK constructs to build our dungeon advent
 
 Let's make an update to our `packages/infra/src/stacks/application-stack.ts` to instantiate some of our already generated constructs:
 
-```diff lang="ts"
-+import {
-+  GameApi,
-+  GameUI,
-+  StoryApi,
-+  UserIdentity,
-+} from ':dungeon-adventure/common-constructs';
-import * as cdk from 'aws-cdk-lib';
-import { Construct } from 'constructs';
-
-export class ApplicationStack extends cdk.Stack {
-  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
-    super(scope, id, props);
-
--    // The code that defines your stack goes here
-+    const userIdentity = new UserIdentity(this, 'UserIdentity');
-+
-+    const gameApi = new GameApi(this, 'GameApi', {
-+      integrations: GameApi.defaultIntegrations(this).build(),
-+    });
-+    const storyApi = new StoryApi(this, 'StoryApi', {
-+      integrations: StoryApi.defaultIntegrations(this).build(),
-+    });
-+
-+    // grant our authenticated role access to invoke our APIs
-+    [storyApi, gameApi].forEach((api) =>
-+      api.grantInvokeAccess(userIdentity.identityPool.authenticatedRole),
-+    );
-+
-+    // Ensure this is instantiated last so our runtime-config.json can be automatically configured
-+    new GameUI(this, 'GameUI');
-  }
-}
 
-```
+<E2EDiff before="dungeon-adventure/1/application-stack.ts.original.template" after="dungeon-adventure/1/application-stack.ts.template" lang="ts" />
 
 Notice here that we supply default integrations for our two APIs. By default, each operation in our API is mapped to an individual lambda function to handle that operation.