feat(trpc): add serve target to run a local trpc server

Add a new target 'serve' which uses the standalone tRPC adapter to run a local server.

re #49

Author: cogwirrel

packages/nx-plugin/src/trpc/backend/__snapshots__/generator.spec.ts.snap

@@ -1,12 +1,12 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`trpc backend generator > should generate backend and schema projects 1`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/index.ts 1`] = `
 "export type { AppRouter } from './router.js';
 export type { Context } from './init.js';
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 2`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/init.ts 1`] = `
 "import { initTRPC } from '@trpc/server';
 import {
   createErrorPlugin,
@@ -28,7 +28,28 @@ export const publicProcedure = t.procedure
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 3`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/local-server.ts 1`] = `
+"import { createHTTPServer } from '@trpc/server/adapters/standalone';
+import { appRouter } from './router.js';
+
+const PORT = 2022;
+
+createHTTPServer({
+  router: appRouter,
+  createContext() {
+    return {
+      event: {} as any,
+      context: {} as any,
+      info: {} as any,
+    };
+  },
+}).listen(PORT);
+
+console.log(\`Local TRPC server listening on port \${PORT}\`);
+"
+`;
+
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/middleware/error.ts 1`] = `
 "import { initTRPC, TRPCError } from '@trpc/server';
 
 export const createErrorPlugin = () => {
@@ -58,7 +79,7 @@ export const createErrorPlugin = () => {
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 4`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/middleware/index.ts 1`] = `
 "import { CreateAWSLambdaContextOptions } from '@trpc/server/adapters/aws-lambda';
 import type { APIGatewayProxyEventV2WithIAMAuthorizer } from 'aws-lambda';
 import { ILoggerContext } from './logger.js';
@@ -78,7 +99,7 @@ export type IMiddlewareContext =
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 5`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/middleware/logger.ts 1`] = `
 "import { initTRPC } from '@trpc/server';
 import { Logger } from '@aws-lambda-powertools/logger';
 
@@ -108,7 +129,7 @@ export const createLoggerPlugin = () => {
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 6`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/middleware/metrics.ts 1`] = `
 "import { initTRPC } from '@trpc/server';
 import { Metrics, MetricUnit } from '@aws-lambda-powertools/metrics';
 
@@ -148,7 +169,7 @@ export const createMetricsPlugin = () => {
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 7`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/middleware/tracer.ts 1`] = `
 "import { initTRPC } from '@trpc/server';
 import { Tracer } from '@aws-lambda-powertools/tracer';
 import { Subsegment } from 'aws-xray-sdk-core';
@@ -196,7 +217,7 @@ export const createTracerPlugin = () => {
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 8`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/procedures/echo.ts 1`] = `
 "import { publicProcedure } from '../init.js';
 import { EchoInputSchema, EchoOutputSchema } from ':proj/test-api-schema';
 
@@ -207,7 +228,7 @@ export const echo = publicProcedure
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 9`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/backend/src/router.ts 1`] = `
 "import {
   awsLambdaRequestHandler,
   CreateAWSLambdaContextOptions,
@@ -218,7 +239,7 @@ import { APIGatewayProxyEventV2WithIAMAuthorizer } from 'aws-lambda';
 
 export const router = t.router;
 
-const appRouter = router({
+export const appRouter = router({
   echo,
 });
 
@@ -233,12 +254,12 @@ export type AppRouter = typeof appRouter;
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 10`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/schema/src/index.ts 1`] = `
 "export * from './procedures/echo.js';
 "
 `;
 
-exports[`trpc backend generator > should generate backend and schema projects 11`] = `
+exports[`trpc backend generator > should generate backend and schema projects > apps/test-api/schema/src/procedures/echo.ts 1`] = `
 "import { z } from 'zod';
 
 export const EchoInputSchema = z.object({

packages/nx-plugin/src/trpc/backend/files/backend/README.md.template

@@ -28,6 +28,6 @@ You can also automatiaclly fix some lint errors by running the following command
 
 ## Useful links
 
-- [Trpc reference docs](TODO)
+- [tRPC reference docs](https://trpc.io/docs/)
 - [Learn more about NX](https://nx.dev/getting-started/intro)
 

packages/nx-plugin/src/trpc/backend/files/backend/src/local-server.ts.template

@@ -0,0 +1,17 @@
+import { createHTTPServer } from '@trpc/server/adapters/standalone';
+import { appRouter } from './router.js';
+
+const PORT = 2022;
+
+createHTTPServer({
+  router: appRouter,
+  createContext() {
+    return {
+      event: {} as any,
+      context: {} as any,
+      info: {} as any,
+    };
+  },
+}).listen(PORT);
+
+console.log(`Local TRPC server listening on port ${PORT}`);

packages/nx-plugin/src/trpc/backend/files/backend/src/router.ts.template

@@ -8,7 +8,7 @@ import { APIGatewayProxyEventV2WithIAMAuthorizer } from 'aws-lambda';
 
 export const router = t.router;
 
-const appRouter = router({
+export const appRouter = router({
   echo,
 });
 

packages/nx-plugin/src/trpc/backend/generator.spec.ts

@@ -2,7 +2,7 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Tree } from '@nx/devkit';
+import { getProjects, readProjectConfiguration, Tree } from '@nx/devkit';
 import { trpcBackendGenerator } from './generator';
 import {
   createTreeUsingTsSolutionSetup,
@@ -114,4 +114,22 @@ describe('trpc backend generator', () => {
       tree.read('packages/common/constructs/src/core/index.ts', 'utf-8'),
     ).toContain('./trpc-api.js');
   });
+
+  it('should add a task for starting a local server', async () => {
+    await trpcBackendGenerator(tree, {
+      apiName: 'TestApi',
+      directory: 'apps',
+      unitTestRunner: 'vitest',
+      bundler: 'vite',
+    });
+    const projectConfig = readProjectConfiguration(
+      tree,
+      '@proj/test-api-backend',
+    );
+    expect(projectConfig.targets).toHaveProperty('serve');
+    expect(projectConfig.targets!.serve!.executor).toBe('nx:run-commands');
+    expect(projectConfig.targets!.serve!.options!.commands).toEqual([
+      'tsx src/local-server.ts',
+    ]);
+  });
 });

packages/nx-plugin/src/trpc/backend/generator.ts

@@ -160,16 +160,28 @@ export async function trpcBackendGenerator(
       );
     }
   }
+
   updateJson(
     tree,
     joinPathFragments(backendRoot, 'project.json'),
     (config: ProjectConfiguration) => {
       config.metadata = {
         apiName: options.apiName,
       } as unknown;
+      config.targets = {
+        ...config.targets,
+        serve: {
+          executor: 'nx:run-commands',
+          options: {
+            commands: ['tsx src/local-server.ts'],
+            cwd: backendRoot,
+          },
+        },
+      };
       return config;
     },
   );
+
   generateFiles(
     tree,
     joinPathFragments(__dirname, 'files', 'backend'),
@@ -200,7 +212,7 @@ export async function trpcBackendGenerator(
       '@aws-lambda-powertools/tracer',
       '@trpc/server',
     ]),
-    withVersions(['@types/aws-lambda']),
+    withVersions(['@types/aws-lambda', 'tsx']),
   );
   tree.delete(joinPathFragments(backendRoot, 'package.json'));
   tree.delete(joinPathFragments(schemaRoot, 'package.json'));

packages/nx-plugin/src/utils/test.ts

@@ -18,12 +18,13 @@ export const createTreeUsingTsSolutionSetup = (): Tree => {
   return tree;
 };
 
+/**
+ * Snapshot all files within a directory in the given tree
+ */
 export const snapshotTreeDir = (tree: Tree, dir: string) => {
   if (tree.isFile(dir)) {
-    console.log('is file', dir);
-    expect(tree.read(dir, 'utf-8')).toMatchSnapshot();
+    expect(tree.read(dir, 'utf-8')).toMatchSnapshot(dir);
   } else {
-    console.log('is dir', dir);
     tree
       .children(dir)
       .forEach((subDir) =>