feat: support grpc plugins with ts and bun (#2293)

Author: SkArchon

.github/workflows/cli-ci.yaml

@@ -34,6 +34,9 @@ jobs:
       - name: Generate code
         run: pnpm buf generate --template buf.ts.gen.yaml
 
+      - name: Generate router templates
+        run: pnpm --filter ./cli compile-templates
+
       - name: Check if git is not dirty after generating files
         run: git diff --no-ext-diff --exit-code
 

.github/workflows/router-ci.yaml

@@ -49,6 +49,11 @@ jobs:
       - name: Install tools
         run: make setup-build-tools
 
+      - name: Install Bun For Plugin Building
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 1.2.15
+
       - name: Generate code
         run: make generate-go
 
@@ -127,6 +132,11 @@ jobs:
       - name: Install tools
         run: make setup-build-tools
 
+      - name: Install Bun For Plugin Building
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 1.2.15
+
       - name: Generate code
         run: make generate-go
 
@@ -299,6 +309,12 @@ jobs:
             router-tests/go.sum
       - name: Install tools
         run: make setup-build-tools
+
+      - name: Install Bun For Plugin Building
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: 1.2.15
+
       - name: Install dependencies
         working-directory: ./router-tests
         run: go mod download

cli/package.json

@@ -19,6 +19,9 @@
     "url": "https://github.com/wundergraph/cosmo"
   },
   "scripts": {
+    "compile-templates": "tsx scripts/compile-templates.ts && prettier --write src/commands/router/commands/plugin/templates/*.ts",
+    "prebuild": "npm run compile-templates",
+    "prebuild:bun": "bun run compile-templates",
     "build": "rm -rf dist && tsc",
     "build:bun": "bun build --compile --production --outfile wgc src/index.ts",
     "wgc": "tsx --env-file .env src/index.ts",

cli/scripts/compile-templates.ts

@@ -0,0 +1,103 @@
+import { readFileSync, writeFileSync, readdirSync } from 'node:fs';
+import { join, basename } from 'node:path';
+
+interface TemplateMap {
+  [key: string]: string;
+}
+
+// Convert file names to camelCase property names
+function fileNameToPropertyName(fileName: string): string {
+  // Remove .template extension
+  let name = fileName.replace('.template', '');
+
+  // Handle special cases for dotfiles
+  if (name.startsWith('.')) {
+    name = name.slice(1); // Remove the dot
+  }
+
+  // Convert to camelCase
+  // Split by dots, dashes, underscores, and spaces
+  const parts = name.split(/[ ._-]/);
+
+  return parts
+    .map((part, index) => {
+      // Normalize all-caps words (like README -> Readme)
+      if (part === part.toUpperCase() && part.length > 1) {
+        part = part.charAt(0) + part.slice(1).toLowerCase();
+      }
+
+      if (index === 0) {
+        // First part: lowercase first char, preserve rest
+        return part.charAt(0).toLowerCase() + part.slice(1);
+      }
+      // Subsequent parts: uppercase first char, preserve rest
+      return part.charAt(0).toUpperCase() + part.slice(1);
+    })
+    .join('');
+}
+
+function compileTemplates(dir: string, outputFile: string, comment?: string) {
+  const files = readdirSync(dir).filter((f) => f.endsWith('.template'));
+
+  if (files.length === 0) {
+    console.log(`No templates found in ${dir}`);
+    return;
+  }
+
+  const templates: TemplateMap = {};
+
+  for (const file of files) {
+    const filePath = join(dir, file);
+    const content = readFileSync(filePath, 'utf8');
+
+    // Convert file name to property name
+    const key = fileNameToPropertyName(file);
+    templates[key] = content;
+  }
+
+  // Generate TypeScript file
+  const lines: string[] = [];
+
+  if (comment) {
+    lines.push(`// ${comment}`);
+  }
+  lines.push('// This file is auto-generated. Do not edit manually.');
+  lines.push('/* eslint-disable no-template-curly-in-string */');
+  lines.push('');
+
+  // Create const declarations
+  for (const [key, content] of Object.entries(templates)) {
+    lines.push(`const ${key} = ${JSON.stringify(content)};`);
+    lines.push('');
+  }
+
+  // Export default object
+  lines.push('export default {');
+  for (const key of Object.keys(templates)) {
+    lines.push(`  ${key},`);
+  }
+  lines.push('};');
+  lines.push('');
+
+  writeFileSync(outputFile, lines.join('\n'), 'utf8');
+  console.log(`Generated ${outputFile} with ${files.length} templates`);
+}
+
+// Compile all template subdirectories, generating <templates>/<folder>.ts in the templates root
+const templatesDir = 'src/commands/router/commands/plugin/templates';
+
+const entries = readdirSync(templatesDir, { withFileTypes: true });
+const subdirs = entries.filter((e: any) => e.isDirectory());
+
+if (subdirs.length === 0) {
+  console.log(`No template subdirectories found in ${templatesDir}`);
+} else {
+  for (const dirent of subdirs) {
+    const dirName = dirent.name;
+    const dirPath = join(templatesDir, dirName);
+    const outFile = join(templatesDir, `${dirName}.ts`);
+    const comment = `Templates for ${dirName} (templating is done by pupa)`;
+    compileTemplates(dirPath, outFile, comment);
+  }
+  console.log('All templates compiled successfully');
+}

cli/src/commands/grpc-service/commands/generate.ts

@@ -3,6 +3,7 @@ import {
   compileGraphQLToMapping,
   compileGraphQLToProto,
   ProtoLock,
+  ProtoOption,
   validateGraphQLSDL,
 } from '@wundergraph/protographic';
 import { Command, program } from 'commander';
@@ -11,6 +12,7 @@ import Spinner, { type Ora } from 'ora';
 import { resolve } from 'pathe';
 import { BaseCommandOptions } from '../../../core/types/types.js';
 import { renderResultTree, renderValidationResults } from '../../router/commands/plugin/helper.js';
+import { getGoModulePathProtoOption } from '../../router/commands/plugin/toolchain.js';
 
 type CLIOptions = {
   input: string;
@@ -135,11 +137,17 @@ async function generateProtoAndMapping({
   // Continue with generation if validation passed (no errors)
   spinner.text = 'Generating mapping and proto files...';
   const mapping = compileGraphQLToMapping(schema, serviceName);
+
+  const protoOptions: ProtoOption[] = [];
+  if (goPackage) {
+    protoOptions.push(getGoModulePathProtoOption(goPackage!));
+  }
+
   const proto = compileGraphQLToProto(schema, {
     serviceName,
     packageName,
-    goPackage,
     lockData,
+    protoOptions,
   });
 
   return {

cli/src/commands/router/commands/plugin/commands/build.ts

@@ -3,16 +3,22 @@ import os from 'node:os';
 import { Command, program } from 'commander';
 import { resolve } from 'pathe';
 import Spinner from 'ora';
+import { ProtoOption } from '@wundergraph/protographic';
 import { BaseCommandOptions } from '../../../../../core/types/types.js';
 import { renderResultTree } from '../helper.js';
 import {
-  buildBinaries,
+  buildGoBinaries,
   checkAndInstallTools,
   generateGRPCCode,
   generateProtoAndMapping,
-  HOST_PLATFORM,
+  getLanguage,
   installGoDependencies,
+  installTsDependencies,
+  typeCheckTs,
+  buildTsBinaries,
   normalizePlatforms,
+  validateAndGetGoModulePath,
+  getGoModulePathProtoOption,
 } from '../toolchain.js';
 
 export default (opts: BaseCommandOptions) => {
@@ -21,54 +27,81 @@ export default (opts: BaseCommandOptions) => {
   command.argument('[directory]', 'Directory of the plugin', '.');
   command.option('--generate-only', 'Generate only the proto and mapping files, do not compile the plugin');
   command.option('--debug', 'Build the binary with debug information', false);
-  command.option('--platform [platforms...]', 'Platform-architecture combinations (e.g., darwin-arm64 linux-amd64)', [
-    HOST_PLATFORM,
-  ]);
+  command.option(
+    '--platform [platforms...]',
+    'Platform-architecture combinations (e.g., darwin-arm64 linux-amd64)',
+    [],
+  );
   command.option('--all-platforms', 'Build for all supported platforms', false);
   command.option('--skip-tools-installation', 'Skip tool installation', false);
   command.option(
     '--force-tools-installation',
     'Force tools installation regardless of version check or confirmation',
     false,
   );
-  command.option(
-    '--go-module-path <path>',
-    'Go module path to use for the plugin',
-    'github.com/wundergraph/cosmo/plugin',
-  );
+  command.option('--go-module-path <path>', 'Go module path to use for the plugin');
 
   command.action(async (directory, options) => {
     const startTime = performance.now();
     const pluginDir = resolve(directory);
     const spinner = Spinner();
     const pluginName = path.basename(pluginDir);
-    const goModulePath = options.goModulePath;
+
+    const language = getLanguage(pluginDir);
+    if (!language) {
+      renderResultTree(spinner, 'Plugin language detection failed!', false, pluginName, {
+        output: pluginDir,
+      });
+      program.error('');
+    }
+
+    const protoOptions: ProtoOption[] = [];
     let platforms: string[] = [];
 
     try {
       // Check and install tools if needed
       if (!options.skipToolsInstallation) {
-        await checkAndInstallTools(options.forceToolsInstallation);
+        await checkAndInstallTools(options.forceToolsInstallation, language);
       }
 
-      // Normalize platform list
-      platforms = normalizePlatforms(options.platform, options.allPlatforms);
-
       // Start the main build process
       spinner.start('Building plugin...');
 
+      const goModulePath = validateAndGetGoModulePath(language, options.goModulePath);
+
+      switch (language) {
+        case 'ts': {
+          await installTsDependencies(pluginDir, spinner);
+          break;
+        }
+        case 'go': {
+          protoOptions.push(getGoModulePathProtoOption(goModulePath!));
+          break;
+        }
+      }
+
+      // Normalize platform list
+      platforms = normalizePlatforms(options.platform, options.allPlatforms, language);
+
       // Generate proto and mapping files
-      await generateProtoAndMapping(pluginDir, goModulePath, spinner);
+      await generateProtoAndMapping(pluginDir, protoOptions, spinner);
 
       // Generate gRPC code
-      await generateGRPCCode(pluginDir, spinner);
+      await generateGRPCCode(pluginDir, spinner, language);
 
       if (!options.generateOnly) {
-        // Install Go dependencies
-        await installGoDependencies(pluginDir, spinner);
-
-        // Build binaries for all platforms
-        await buildBinaries(pluginDir, platforms, options.debug, spinner);
+        switch (language) {
+          case 'go': {
+            await installGoDependencies(pluginDir, spinner);
+            await buildGoBinaries(pluginDir, platforms, options.debug, spinner);
+            break;
+          }
+          case 'ts': {
+            await typeCheckTs(pluginDir, spinner);
+            await buildTsBinaries(pluginDir, platforms, options.debug, spinner);
+            break;
+          }
+        }
       }
 
       // Calculate and format elapsed time
@@ -79,24 +112,24 @@ export default (opts: BaseCommandOptions) => {
 
       renderResultTree(spinner, 'Plugin built successfully!', true, pluginName, {
         output: pluginDir,
-        'go module': goModulePath,
         platforms: platforms.join(', '),
         env: `${os.platform()} ${os.arch()}`,
         build: options.debug ? 'debug' : 'release',
         type: options.generateOnly ? 'generate-only' : 'full',
         time: formattedTime,
+        protoOptions: protoOptions.map(({ name, constant }) => `${name}=${constant}`).join(','),
       });
     } catch (error: any) {
-      renderResultTree(spinner, 'Plugin build failed!', false, pluginName, {
+      const details: Record<string, any> = {
         output: pluginDir,
-        'go module': goModulePath,
         platforms: platforms.join(', '),
         env: `${os.platform()} ${os.arch()}`,
         build: options.debug ? 'debug' : 'release',
         type: options.generateOnly ? 'generate-only' : 'full',
         error: error.message,
-      });
-
+        protoOptions: protoOptions.map(({ name, constant }) => `${name}=${constant}`).join(','),
+      };
+      renderResultTree(spinner, 'Plugin build failed!', false, pluginName, details);
       program.error('');
     }
   });