Add rust target with reqwest (Kong#328)

* Create initial rust files

Create initial rust files to support the target. Create all of the demo
fixture files for the different request types.

These also require specific `Cargo.toml` dependencies with some features,
but I've tried to keep them fully qualified where possible. I'm not sure
yet how best to show adding dependencies to a project to enable these
features.

* Start work on reqwest client

Start working on the reqwest conversion client after adding targets.

* Complete Adding Rust as target

Completed adding Rust as a target. All of the fixtures have been tested
in a separate Rust project to verify that they build and successfully
run against the Har test endpoint.

All tests are running and passing, except for the snapshot that verifies
all available targets, not sure where to update that.

* Run linter

Ran the linter defined in `package.json`

All tests except snapshot for targets passing.

* Update snapshot to fix available targets test

Update the available targets test to fix the snapshot.

* lint

---------

Co-authored-by: Filipe Freire <livrofubia@gmail.com>

Author: Benjscho

.github/workflows/build.yml

@@ -15,7 +15,7 @@ on:
 jobs:
   scan:
     permissions:
-      packages: write 
+      packages: write
       contents: write # publish sbom to GH releases/tag assets
     runs-on: ubuntu-latest
     steps:
@@ -74,14 +74,14 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0 
+          fetch-depth: 0
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 20.9.0
           registry-url: 'https://registry.npmjs.org'
-    
+
       - name: Install
         run: npm ci
 
@@ -92,4 +92,3 @@ jobs:
         run: npm publish --no-git-checks --provenance --tag ${{ github.sha }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-

.github/workflows/release.yml

@@ -52,7 +52,7 @@ jobs:
         id: core_tag_and_release
         with:
           tag: v${{ env.TAG }}
-          name: "httpsnippet v${{ env.TAG }} 📦"
+          name: 'httpsnippet v${{ env.TAG }} 📦'
           generateReleaseNotes: true
           prerelease: false
-          draft: false
+          draft: false

.github/workflows/sast.yml

@@ -4,10 +4,9 @@ on:
   pull_request: {}
   push:
     branches:
-    - master
+      - master
   workflow_dispatch: {}
 
-
 jobs:
   semgrep:
     name: Semgrep SAST

SECURITY.md

@@ -7,7 +7,7 @@ At HTTPSnippet, we take security issues very seriously. If you believe you have
 ## How to Report
 
 1. **Do not publicly disclose the vulnerability**: Please do not create a GitHub issue or post the vulnerability on public forums. Instead, contact us directly at [vulnerability@konghq.com](mailto:vulnerability@konghq.com).
-2. **Provide detailed information**: When reporting a vulnerability, please include as much information as possible to help us understand and reproduce the issue. This may include:
+1. **Provide detailed information**: When reporting a vulnerability, please include as much information as possible to help us understand and reproduce the issue. This may include:
    - Description of the vulnerability
    - Steps to reproduce the issue
    - Potential impact

package-lock.json

@@ -30,6 +30,7 @@
     "request",
     "requests",
     "ruby",
+    "rust",
     "shell",
     "snippet",
     "swift",
@@ -72,8 +73,8 @@
     "eslint-plugin-jest": "^26.1.3",
     "eslint-plugin-jest-formatting": "^3.1.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
-    "markdownlint-cli2": "^0.5.1",
     "jest": "^27.5.1",
+    "markdownlint-cli2": "^0.5.1",
     "prettier": "^2.6.2",
     "ts-jest": "^27.1.4",
     "type-fest": "^2.12.2",

package.json

@@ -322,6 +322,20 @@ Array [
     "key": "ruby",
     "title": "Ruby",
   },
+  Object {
+    "clients": Array [
+      Object {
+        "description": "reqwest HTTP library",
+        "key": "reqwest",
+        "link": "https://docs.rs/reqwest/latest/reqwest/",
+        "title": "reqwest",
+      },
+    ],
+    "default": "reqwest",
+    "extname": ".rs",
+    "key": "rust",
+    "title": "Rust",
+  },
   Object {
     "clients": Array [
       Object {

src/helpers/__snapshots__/utils.test.ts.snap

@@ -56,6 +56,18 @@ export class CodeBuilder {
     this.code.push(newLine);
   };
 
+  /**
+   * Add the line to the end of the last line. Creates a new line
+   * if no lines exist yet.
+   */
+  pushToLast = (line: string) => {
+    if (!this.code) {
+      this.push(line);
+    }
+    const updatedLine = `${this.code[this.code.length - 1]}${line}`;
+    this.code[this.code.length - 1] = updatedLine;
+  };
+
   /**
    * Add an empty line at the end of current lines
    */

src/helpers/code-builder.ts

@@ -1,34 +1,26 @@
 import { escapeString } from './escape';
 
-describe('Escape methods', () => {
+describe('escape methods', () => {
   describe('escapeString', () => {
     it('does nothing to a safe string', () => {
-      expect(
-        escapeString("hello world")
-      ).toBe("hello world");
+      expect(escapeString('hello world')).toBe('hello world');
     });
 
     it('escapes double quotes by default', () => {
-      expect(
-        escapeString('"hello world"')
-      ).toBe('\\"hello world\\"');
+      expect(escapeString('"hello world"')).toBe('\\"hello world\\"');
     });
 
     it('escapes newlines by default', () => {
-      expect(
-        escapeString('hello\r\nworld')
-      ).toBe('hello\\r\\nworld');
+      expect(escapeString('hello\r\nworld')).toBe('hello\\r\\nworld');
     });
 
     it('escapes backslashes', () => {
-      expect(
-        escapeString('hello\\world')
-      ).toBe('hello\\\\world');
+      expect(escapeString('hello\\world')).toBe('hello\\\\world');
     });
 
     it('escapes unrepresentable characters', () => {
       expect(
-        escapeString('hello \u0000') // 0 = ASCII 'null' character
+        escapeString('hello \u0000'), // 0 = ASCII 'null' character
       ).toBe('hello \\u0000');
     });
   });

src/helpers/escape.test.ts

@@ -31,47 +31,42 @@ export interface EscapeOptions {
  * for the complete original algorithm.
  */
 export function escapeString(rawValue: any, options: EscapeOptions = {}) {
-  const {
-    delimiter = '"',
-    escapeChar = '\\',
-    escapeNewlines = true
-  } = options;
+  const { delimiter = '"', escapeChar = '\\', escapeNewlines = true } = options;
 
   const stringValue = rawValue.toString();
 
-  return [...stringValue].map((c) => {
-    if (c === '\b') {
-      return escapeChar + 'b';
-    } else if (c === '\t') {
-      return escapeChar + 't';
-    } else if (c === '\n') {
-      if (escapeNewlines) {
-        return escapeChar + 'n';
-      } else {
+  return [...stringValue]
+    .map(c => {
+      if (c === '\b') {
+        return `${escapeChar}b`;
+      } else if (c === '\t') {
+        return `${escapeChar}t`;
+      } else if (c === '\n') {
+        if (escapeNewlines) {
+          return `${escapeChar}n`;
+        }
         return c; // Don't just continue, or this is caught by < \u0020
-      }
-    } else if (c === '\f') {
-      return escapeChar + 'f';
-    } else if (c === '\r') {
-      if (escapeNewlines) {
-        return escapeChar + 'r';
-      } else {
+      } else if (c === '\f') {
+        return `${escapeChar}f`;
+      } else if (c === '\r') {
+        if (escapeNewlines) {
+          return `${escapeChar}r`;
+        }
         return c; // Don't just continue, or this is caught by < \u0020
+      } else if (c === escapeChar) {
+        return escapeChar + escapeChar;
+      } else if (c === delimiter) {
+        return escapeChar + delimiter;
+      } else if (c < '\u0020' || c > '\u007E') {
+        // Delegate the trickier non-ASCII cases to the normal algorithm. Some of these
+        // are escaped as \uXXXX, whilst others are represented literally. Since we're
+        // using this primarily for header values that are generally (though not 100%
+        // strictly?) ASCII-only, this should almost never happen.
+        return JSON.stringify(c).slice(1, -1);
       }
-    } else if (c === escapeChar) {
-      return escapeChar + escapeChar;
-    } else if (c === delimiter) {
-      return escapeChar + delimiter;
-    } else if (c < '\u0020' || c > '\u007E') {
-      // Delegate the trickier non-ASCII cases to the normal algorithm. Some of these
-      // are escaped as \uXXXX, whilst others are represented literally. Since we're
-      // using this primarily for header values that are generally (though not 100%
-      // strictly?) ASCII-only, this should almost never happen.
-      return JSON.stringify(c).slice(1, -1);
-    } else {
       return c;
-    }
-  }).join('');
+    })
+    .join('');
 }
 
 /**
@@ -81,8 +76,7 @@ export function escapeString(rawValue: any, options: EscapeOptions = {}) {
  *
  * If value is not a string, it will be stringified with .toString() first.
  */
-export const escapeForSingleQuotes = (value: any) =>
-  escapeString(value, { delimiter: "'" });
+export const escapeForSingleQuotes = (value: any) => escapeString(value, { delimiter: "'" });
 
 /**
  * Make a string value safe to insert literally into a snippet within double quotes,
@@ -91,5 +85,4 @@ export const escapeForSingleQuotes = (value: any) =>
  *
  * If value is not a string, it will be stringified with .toString() first.
  */
-export const escapeForDoubleQuotes = (value: any) =>
-  escapeString(value, { delimiter: '"' });
+export const escapeForDoubleQuotes = (value: any) => escapeString(value, { delimiter: '"' });