feat(devbox): adding gateway config to devbox (#701)

Author: dines-rl

.github/workflows/sdk-coverage.yml

@@ -71,115 +71,132 @@ jobs:
           script: |
             const fs = require('fs');
             const testsPassed = '${{ steps.tests.outcome }}' === 'success';
-
-            // Build workflow run URL
             const runUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;
-
-            let comment = '';
-
+            const COMMENT_MARKER = '<!-- sdk-coverage-report -->';
+            
+            let lines = [COMMENT_MARKER];
+            
             if (!testsPassed) {
-              // Try to parse failed tests from the log
-              let failedTests = '';
+              let failedTests = [];
               try {
                 const testOutput = fs.readFileSync('test-output.log', 'utf8');
-                
-                // Extract failed test names using regex
                 const failedMatches = testOutput.match(/● (.+?)(?:\n|$)/g);
-                if (failedMatches && failedMatches.length > 0) {
-                  const failedTestList = failedMatches
-                    .map(match => match.replace('● ', '').trim())
-                    .filter(test => test.length > 0)
-                    .slice(0, 10) // Limit to first 10 failures
-                    .map(test => `- ${test}`)
-                    .join('\n');
-                  
-                  if (failedTestList) {
-                    failedTests = `\n\n**Failed Tests:**\n${failedTestList}`;
-                    if (failedMatches.length > 10) {
-                      failedTests += `\n- ... and ${failedMatches.length - 10} more`;
-                    }
-                  }
+                if (failedMatches) {
+                  failedTests = failedMatches
+                    .map(m => m.replace('● ', '').trim())
+                    .filter(t => t.length > 0)
+                    .slice(0, 10);
                 }
-              } catch (error) {
-                console.log('Could not read test output:', error.message);
-              }
-
-              comment = `## ❌ Object Smoke Tests Failed
-              
-              ### Test Results
-              ❌ Some smoke tests failed
-              ${failedTests}
+              } catch (e) {}
               
-              **Please fix the failing tests before checking coverage.**
-              
-              [📋 View full test logs](${runUrl})`;
+              lines.push('## ❌ Object Smoke Tests Failed');
+              lines.push('');
+              lines.push('### Test Results');
+              lines.push('❌ Some smoke tests failed');
+              if (failedTests.length > 0) {
+                lines.push('');
+                lines.push('**Failed Tests:**');
+                failedTests.forEach(t => lines.push(`- ${t}`));
+              }
+              lines.push('');
+              lines.push('**Please fix the failing tests before checking coverage.**');
+              lines.push('');
+              lines.push(`[📋 View full test logs](${runUrl})`);
             } else {
               let coverageSummary = null;
               try {
                 coverageSummary = JSON.parse(fs.readFileSync('coverage-objects/coverage-summary.json', 'utf8'));
-              } catch (error) {
-                console.log('Coverage summary not found:', error.message);
-                comment = `## ⚠️ Coverage Data Missing
-                
-                ### Test Results
-                ✅ All smoke tests passed
+              } catch (e) {}
+              
+              if (!coverageSummary) {
+                lines.push('## ⚠️ Coverage Data Missing');
+                lines.push('');
+                lines.push('### Test Results');
+                lines.push('✅ All smoke tests passed');
+                lines.push('');
+                lines.push('### Coverage Results');
+                lines.push('⚠️ Coverage data could not be read');
+                lines.push('');
+                lines.push(`[📋 View workflow logs](${runUrl})`);
+              } else {
+                const total = coverageSummary.total;
+                const funcs = total.functions.pct;
+                const lns = total.lines.pct;
+                const branches = total.branches.pct;
+                const stmts = total.statements.pct;
+                const coveragePassed = funcs === 100;
+                const statusEmoji = coveragePassed ? '✅' : '⚠️';
                 
-                ### Coverage Results
-                ⚠️ Coverage data could not be read
+                lines.push(`## ${statusEmoji} Object Smoke Tests & Coverage Report`);
+                lines.push('');
+                lines.push('### Test Results');
+                lines.push('✅ All smoke tests passed');
+                lines.push('');
+                lines.push('### Coverage Results');
+                lines.push('| Metric | Coverage | Required | Status |');
+                lines.push('|--------|----------|----------|--------|');
+                lines.push(`| **Functions** | **${funcs}%** | **100%** | ${coveragePassed ? '✅' : '❌'} |`);
+                lines.push(`| Lines | ${lns}% | - | ℹ️ |`);
+                lines.push(`| Branches | ${branches}% | - | ℹ️ |`);
+                lines.push(`| Statements | ${stmts}% | - | ℹ️ |`);
+                lines.push('');
+                lines.push('**Coverage Requirement:** 100% function coverage (all public methods must be called in smoke tests)');
+                lines.push('');
+                lines.push(coveragePassed 
+                  ? '✅ All tests passed and all object methods are covered!' 
+                  : '⚠️ Some object methods are not covered in smoke tests. Please add tests that call all public methods.');
+                lines.push('');
+                lines.push('<details>');
+                lines.push('<summary>View detailed coverage report</summary>');
+                lines.push('');
+                lines.push('| File | Functions | Lines | Branches |');
+                lines.push('|------|-----------|-------|----------|');
                 
-                [📋 View workflow logs](${runUrl})`;
+                for (const [filePath, data] of Object.entries(coverageSummary)) {
+                  if (filePath === 'total') continue;
+                  const shortPath = filePath.replace(/^.*?src\//, 'src/');
+                  const funcPct = data.functions.pct;
+                  const linesPct = data.lines.pct;
+                  const branchesPct = data.branches.pct;
+                  const funcStatus = funcPct === 100 ? '✅' : '❌';
+                  lines.push(`| ${shortPath} | ${funcStatus} ${funcPct}% | ${linesPct}% | ${branchesPct}% |`);
+                }
                 
-                github.rest.issues.createComment({
-                  issue_number: context.issue.number,
-                  owner: context.repo.owner,
-                  repo: context.repo.repo,
-                  body: comment
-                });
-                return;
+                lines.push('');
+                lines.push('</details>');
+                lines.push('');
+                lines.push(`[📋 View workflow run](${runUrl})`);
               }
-
-              const total = coverageSummary.total;
-              const functions = total.functions.pct;
-              const lines = total.lines.pct;
-              const branches = total.branches.pct;
-              const statements = total.statements.pct;
-
-              const coveragePassed = functions === 100;
-              const allPassed = testsPassed && coveragePassed;
-              const statusEmoji = allPassed ? '✅' : '⚠️';
-
-              comment = `## ${statusEmoji} Object Smoke Tests & Coverage Report
-
-              ### Test Results
-              ✅ All smoke tests passed
-
-              ### Coverage Results
-              | Metric | Coverage | Required | Status |
-              |--------|----------|----------|--------|
-              | **Functions** | **${functions}%** | **100%** | ${coveragePassed ? '✅' : '❌'} |
-              | Lines | ${lines}% | - | ℹ️ |
-              | Branches | ${branches}% | - | ℹ️ |
-              | Statements | ${statements}% | - | ℹ️ |
-
-              **Coverage Requirement:** 100% function coverage (all public methods must be called in smoke tests)
-
-              ${coveragePassed 
-                ? '✅ All tests passed and all object methods are covered!' 
-                : '⚠️ Some object methods are not covered in smoke tests. Please add tests that call all public methods.'}
-
-              <details>
-              <summary>View detailed coverage report</summary>
-
-              Coverage reports are available in the workflow artifacts. Lines/branches/statements coverage is tracked but not required to be 100%.
-
-              </details>
-              
-              [📋 View workflow run](${runUrl})`;
             }
-
-            github.rest.issues.createComment({
-              issue_number: context.issue.number,
+            
+            const comment = lines.join('\n');
+            
+            const { data: comments } = await github.rest.issues.listComments({
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: comment
+              issue_number: context.issue.number
             });
+            
+            const existingComment = comments.find(c => c.body.includes(COMMENT_MARKER));
+            
+            if (existingComment) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: existingComment.id,
+                body: comment
+              });
+            } else {
+              await github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: comment
+              });
+            }
+
+      - name: Fail if tests failed
+        if: steps.tests.outcome != 'success'
+        run: |
+          echo "Smoke tests failed. See PR comment for details."
+          exit 1

src/sdk.ts

@@ -8,6 +8,7 @@ import { StorageObject } from './sdk/storage-object';
 import { Agent } from './sdk/agent';
 import { Scorer } from './sdk/scorer';
 import { NetworkPolicy } from './sdk/network-policy';
+import { GatewayConfig } from './sdk/gateway-config';
 import { Scenario } from './sdk/scenario';
 
 // Import types used in this file
@@ -22,6 +23,7 @@ import type { ObjectCreateParams, ObjectListParams } from './resources/objects';
 import type { AgentCreateParams, AgentListParams } from './resources/agents';
 import type { ScorerCreateParams, ScorerListParams } from './resources/scenarios/scorers';
 import type { NetworkPolicyCreateParams, NetworkPolicyListParams } from './resources/network-policies';
+import type { GatewayConfigCreateParams, GatewayConfigListParams } from './resources/gateway-configs';
 import type { ScenarioListParams } from './resources/scenarios/scenarios';
 import { PollingOptions } from './lib/polling';
 import * as Shared from './resources/shared';
@@ -284,6 +286,15 @@ export class RunloopSDK {
    */
   public readonly networkPolicy: NetworkPolicyOps;
 
+  /**
+   * **Gateway Config Operations** - {@link GatewayConfigOps} for creating and accessing {@link GatewayConfig} class instances.
+   *
+   * Gateway configs define how to proxy API requests through the credential gateway. They specify
+   * the target endpoint and how credentials should be applied. Use with devboxes to securely
+   * proxy requests to external APIs without exposing API keys.
+   */
+  public readonly gatewayConfig: GatewayConfigOps;
+
   /**
    * **Scenario Operations** - {@link ScenarioOps} for accessing {@link Scenario} class instances.
    *
@@ -305,6 +316,7 @@ export class RunloopSDK {
     this.agent = new AgentOps(this.api);
     this.scorer = new ScorerOps(this.api);
     this.networkPolicy = new NetworkPolicyOps(this.api);
+    this.gatewayConfig = new GatewayConfigOps(this.api);
     this.scenario = new ScenarioOps(this.api);
   }
 }
@@ -1508,6 +1520,117 @@ export class NetworkPolicyOps {
   }
 }
 
+/**
+ * Gateway Config SDK interface for managing gateway configurations.
+ *
+ * @category Gateway Config
+ *
+ * @remarks
+ * ## Overview
+ *
+ * The `GatewayConfigOps` class provides a high-level abstraction for managing gateway configurations,
+ * which define how to proxy API requests through the credential gateway. Gateway configs specify
+ * the target endpoint and how credentials should be applied, enabling secure API proxying without
+ * exposing API keys.
+ *
+ * ## Usage
+ *
+ * This interface is accessed via {@link RunloopSDK.gatewayConfig}. You should construct
+ * a {@link RunloopSDK} instance and use it from there:
+ *
+ * @example
+ * ```typescript
+ * const runloop = new RunloopSDK();
+ * const gatewayConfig = await runloop.gatewayConfig.create({
+ *   name: 'my-api-gateway',
+ *   endpoint: 'https://api.example.com',
+ *   auth_mechanism: { type: 'bearer' },
+ * });
+ *
+ * // Use with a devbox
+ * const devbox = await runloop.devbox.create({
+ *   name: 'my-devbox',
+ *   gateways: {
+ *     'MY_API': {
+ *       gateway: gatewayConfig.id,
+ *       secret: 'my-api-key-secret',
+ *     },
+ *   },
+ * });
+ * ```
+ */
+export class GatewayConfigOps {
+  /**
+   * @private
+   */
+  constructor(private client: RunloopAPI) {}
+
+  /**
+   * Create a new gateway config.
+   *
+   * @example
+   * ```typescript
+   * const runloop = new RunloopSDK();
+   * const gatewayConfig = await runloop.gatewayConfig.create({
+   *   name: 'my-gateway',
+   *   endpoint: 'https://api.example.com',
+   *   auth_mechanism: { type: 'header', key: 'x-api-key' },
+   *   description: 'Gateway for My API',
+   * });
+   * ```
+   *
+   * @param {GatewayConfigCreateParams} params - Parameters for creating the gateway config.
+   * @param {Core.RequestOptions} [options] - Request options.
+   * @returns {Promise<GatewayConfig>} A {@link GatewayConfig} instance.
+   */
+  async create(params: GatewayConfigCreateParams, options?: Core.RequestOptions): Promise<GatewayConfig> {
+    return GatewayConfig.create(this.client, params, options);
+  }
+
+  /**
+   * Get a gateway config object by its ID.
+   *
+   * @example
+   * ```typescript
+   * const runloop = new RunloopSDK();
+   * const gatewayConfig = runloop.gatewayConfig.fromId('gwc_1234567890');
+   * const info = await gatewayConfig.getInfo();
+   * console.log(`Gateway Config name: ${info.name}`);
+   * ```
+   *
+   * @param {string} id - The ID of the gateway config.
+   * @returns {GatewayConfig} A {@link GatewayConfig} instance.
+   */
+  fromId(id: string): GatewayConfig {
+    return GatewayConfig.fromId(this.client, id);
+  }
+
+  /**
+   * List gateway configs with optional filters (paginated).
+   *
+   * @example
+   * ```typescript
+   * const runloop = new RunloopSDK();
+   * const configs = await runloop.gatewayConfig.list({ limit: 10 });
+   * console.log(configs.map((c) => c.id));
+   * ```
+   *
+   * @param {GatewayConfigListParams} [params] - Optional filter parameters.
+   * @param {Core.RequestOptions} [options] - Request options.
+   * @returns {Promise<GatewayConfig[]>} An array of {@link GatewayConfig} instances.
+   */
+  async list(params?: GatewayConfigListParams, options?: Core.RequestOptions): Promise<GatewayConfig[]> {
+    const result = await this.client.gatewayConfigs.list(params, options);
+    const configs: GatewayConfig[] = [];
+
+    for await (const config of result) {
+      configs.push(GatewayConfig.fromId(this.client, config.id));
+    }
+
+    return configs;
+  }
+}
+
 /**
  * Scenario SDK interface for managing scenarios.
  *
@@ -1630,6 +1753,7 @@ export declare namespace RunloopSDK {
     AgentOps as AgentOps,
     ScorerOps as ScorerOps,
     NetworkPolicyOps as NetworkPolicyOps,
+    GatewayConfigOps as GatewayConfigOps,
     ScenarioOps as ScenarioOps,
     Devbox as Devbox,
     Blueprint as Blueprint,
@@ -1638,6 +1762,7 @@ export declare namespace RunloopSDK {
     Agent as Agent,
     Scorer as Scorer,
     NetworkPolicy as NetworkPolicy,
+    GatewayConfig as GatewayConfig,
     Scenario as Scenario,
   };
 }