Merge pull request #114 from ngrok/ryno/policy-support

Add support for Traffic Policy

.prettierignore

@@ -1,6 +1,7 @@
 # Ignore artifacts:
 *.css
 *.json
+!__test__/policy.json
 *.html
 *.md
 *.vue

Cargo.toml

@@ -18,7 +18,7 @@ mio = { version = "=0.8.6" }
 # Default enable napi4 feature, see https://nodejs.org/api/n-api.html#node-api-version-matrix
 napi = { version = "2.12.1", default-features = false, features = ["napi4", "tokio_rt"] }
 napi-derive = "2.12.1"
-ngrok = { version = "0.14.0-pre.8" }
+ngrok = { version = "0.14.0-pre.11" }
 parking_lot = "0.12.1"
 regex = "1.9.5"
 rustls-pemfile = "1.0.1"

__test__/connect.spec.mjs

@@ -7,6 +7,7 @@ import axiosRetry from "axios-retry";
 import * as fs from "fs";
 import * as http from "http";
 import * as retry from "./retry-config.mjs";
+import * as path from "path";
 
 axiosRetry(axios, retry.retryConfig);
 const expected = "Hello";
@@ -208,3 +209,21 @@ test.serial("forward bad domain", async (t) => {
   );
   t.is("ERR_NGROK_326", error.errorCode, error.message);
 });
+
+test("policy", async (t) => {
+  const policy = fs.readFileSync(path.resolve("__test__", "policy.json"), "utf8");
+
+  const httpServer = await makeHttp();
+  const listener = await ngrok.forward({
+    addr: httpServer.listenTo,
+    authtoken: process.env["NGROK_AUTHTOKEN"],
+    proto: "http",
+    policy: policy,
+  });
+  const url = listener.url();
+
+  t.truthy(url);
+  t.truthy(url.startsWith("https://"), url);
+  const response = await validateShutdown(t, httpServer, url);
+  t.is("bar", response.headers["foo"]);
+});

__test__/online.spec.mjs

@@ -9,6 +9,7 @@ import * as fs from "fs";
 import * as http from "http";
 import * as net from "net";
 import * as retry from "./retry-config.mjs";
+import * as path from "path";
 
 axiosRetry(axios, retry.retryConfig);
 const expected = "Hello";
@@ -516,3 +517,12 @@ test("listener invalid domain", async (t) => {
   );
   t.is("ERR_NGROK_326", error.errorCode);
 });
+
+test("policy", async (t) => {
+  const policy = fs.readFileSync(path.resolve("__test__", "policy.json"), "utf8");
+
+  const [httpServer, session] = await makeHttpAndSession();
+  const listener = await session.httpEndpoint().policy(policy).listen();
+  const response = await forwardValidateShutdown(t, httpServer, listener, listener.url());
+  t.is("bar", response.headers["foo"]);
+});

__test__/policy.json

@@ -0,0 +1,18 @@
+{
+  "outbound": [
+    {
+      "name": "test_out",
+      "expressions": ["req.Method == 'GET'"],
+      "actions": [
+        {
+          "type": "add-headers",
+          "config": {
+            "headers": {
+              "foo": "bar"
+            }
+          }
+        }
+      ]
+    }
+  ]
+}

src/config.rs

@@ -203,6 +203,8 @@ pub struct Config {
     /// 'closed' - connection is lost, 'connected' - reconnected
     #[napi(ts_type = "(status: string) => void")]
     pub on_status_change: Option<bool>,
+    /// The Traffic Policy to use for this endpoint.
+    pub policy: Option<String>,
     /// The port for the listener to forward to.
     /// Only used if addr is not defined.
     pub port: Option<u32>,

src/connect.rs

@@ -92,6 +92,11 @@ macro_rules! config_common {
         plumb_vec!($builder, $config, deny_cidr);
         plumb!($builder, $config, proxy_proto);
         plumb!($builder, $config, forwards_to);
+
+        // returns a Result, so we can't use the macro
+        if let Some(ref v) = $config.policy {
+            $builder.policy(v.clone())?;
+        }
     };
 }
 

src/listener_builder.rs

@@ -163,6 +163,14 @@ macro_rules! make_listener_builder {
                 builder.forwards_to(forwards_to);
                 self
             }
+            #[napi]
+            pub fn policy(&mut self, policy: String) -> Result<&Self> {
+                let mut builder = self.listener_builder.lock();
+                match builder.policy(policy.as_str()) {
+                    Ok(_) => Ok(self),
+                    Err(e) => Err(napi_err(format!("Error parsing policy, {e}"))),
+                }
+            }
         }
     };