refactoring the examples folder + rhai version of forbid anonymous op…

Cargo.toml

@@ -4,22 +4,23 @@ members = [
     "apollo-router",
     "apollo-router-benchmarks",
     "apollo-router-scaffold",
-    "examples/add-timestamp-header",
-    "examples/async-auth",
-    "examples/cookies-to-headers",
-    "examples/embedded",
-    "examples/context",
-    "examples/forbid-anonymous-operations",
-    "examples/hello-world",
-    "examples/status-code-propagation",
-    "examples/op-name-to-header",
-    "examples/rhai-logging",
-    "examples/rhai-data-response-mutate",
-    "examples/rhai-error-response-mutate",
-    "examples/rhai-subgraph-request-log",
-    "examples/rhai-surrogate-cache-key",
-    "examples/supergraph_sdl",
-    "examples/jwt-auth",
+    "examples/add-timestamp-header/rhai",
+    "examples/async-auth/rust",
+    "examples/cookies-to-headers/rhai",
+    "examples/embedded/rust",
+    "examples/context/rust",
+    "examples/forbid-anonymous-operations/rust",
+    "examples/forbid-anonymous-operations/rhai",
+    "examples/hello-world/rust",
+    "examples/status-code-propagation/rust",
+    "examples/op-name-to-header/rhai",
+    "examples/logging/rhai",
+    "examples/data-response-mutate/rhai",
+    "examples/error-response-mutate/rhai",
+    "examples/subgraph-request-log/rhai",
+    "examples/surrogate-cache-key/rhai",
+    "examples/supergraph-sdl/rust",
+    "examples/jwt-auth/rust",
     "fuzz",
     "xtask",
 ]

apollo-router/src/configuration/snapshots/apollo_router__configuration__tests__schema_generation.snap

@@ -679,10 +679,21 @@ expression: "&schema"
                   "format": "double"
                 },
                 {
-                  "type": "string",
-                  "enum": [
-                    "always_on",
-                    "always_off"
+                  "oneOf": [
+                    {
+                      "description": "Always sample",
+                      "type": "string",
+                      "enum": [
+                        "always_on"
+                      ]
+                    },
+                    {
+                      "description": "Never sample",
+                      "type": "string",
+                      "enum": [
+                        "always_off"
+                      ]
+                    }
                   ]
                 }
               ],
@@ -1958,10 +1969,21 @@ expression: "&schema"
                       "format": "double"
                     },
                     {
-                      "type": "string",
-                      "enum": [
-                        "always_on",
-                        "always_off"
+                      "oneOf": [
+                        {
+                          "description": "Always sample",
+                          "type": "string",
+                          "enum": [
+                            "always_on"
+                          ]
+                        },
+                        {
+                          "description": "Never sample",
+                          "type": "string",
+                          "enum": [
+                            "always_off"
+                          ]
+                        }
                       ]
                     }
                   ],
@@ -2028,11 +2050,28 @@ expression: "&schema"
           "properties": {
             "compression": {
               "description": "Enable compression for subgraphs (available compressions are deflate, br, gzip)",
-              "type": "string",
-              "enum": [
-                "gzip",
-                "deflate",
-                "br"
+              "oneOf": [
+                {
+                  "description": "gzip",
+                  "type": "string",
+                  "enum": [
+                    "gzip"
+                  ]
+                },
+                {
+                  "description": "deflate",
+                  "type": "string",
+                  "enum": [
+                    "deflate"
+                  ]
+                },
+                {
+                  "description": "brotli",
+                  "type": "string",
+                  "enum": [
+                    "br"
+                  ]
+                }
               ],
               "nullable": true
             },
@@ -2120,11 +2159,28 @@ expression: "&schema"
             "properties": {
               "compression": {
                 "description": "Enable compression for subgraphs (available compressions are deflate, br, gzip)",
-                "type": "string",
-                "enum": [
-                  "gzip",
-                  "deflate",
-                  "br"
+                "oneOf": [
+                  {
+                    "description": "gzip",
+                    "type": "string",
+                    "enum": [
+                      "gzip"
+                    ]
+                  },
+                  {
+                    "description": "deflate",
+                    "type": "string",
+                    "enum": [
+                      "deflate"
+                    ]
+                  },
+                  {
+                    "description": "brotli",
+                    "type": "string",
+                    "enum": [
+                      "br"
+                    ]
+                  }
                 ],
                 "nullable": true
               },

examples/README.md

@@ -1,41 +1,50 @@
 # Examples
 
-This directory contains many examples on how to use and extend the Apollo Router.
+This directory contains many examples on how to use and extend the Apollo Router. Each folder may contain `rhai` and/or `rust`, which dictates the kind of plugin it is. For example, [the forbid anonymous operations example](./forbid-anonymous-operations/) has both a Rhai and Rust version available, whereas [the logging example](./logging) is only demonstrated in Rhai. For those without a subfolder, it is intended to be a config-only example, such as the [telemetry samples](./telemetry).
 
 Make sure to look at the docs for:
 
 ## Yaml configuration ([documentation](https://www.apollographql.com/docs/router/configuration/overview))
+
 Built in functionality in the Apollo Router.
 
-* [Header manipulation](./header-manipulation)
-* [Telemetry](./telemetry)
-* [Forbid mutations](./forbid_mutations)
-* [Unix sockets](./unix-sockets)
+- [Header manipulation](./header-manipulation)
+- [Telemetry](./telemetry)
+- [Forbid mutations](./forbid-mutations)
+- [Unix sockets](./unix-sockets)
 
 ## Customization ([documentation](https://www.apollographql.com/docs/router/customizations/overview))
+
 Extending the functionality of the Apollo Router.
 
 ### Rhai
+
 Scripting support.
-* [Time request and add to header](./add-timestamp-header)
-* [Cookies to headers](./cookies-to-headers)
-* [Operation Name to headers](./op-name-to-header)
-* [Logging](./rhai-logging)
-* [Response data modification](./rhai-data-response-mutate)
-* [Response errors modification](./rhai-error-response-mutate)
-* [Subgraph request logging](./rhai-subgraph-request-log)
-* [Surrogate cache key creation](./rhai-surrogate-cache-key)
+
+- [Time request and add to header](./add-timestamp-header/rhai)
+- [Cookies to headers](./cookies-to-headers/rhai)
+- [Forbid anonymous operations](./forbid-anonymous-operations/rhai)
+- [Operation Name to headers](./op-name-to-header/rhai)
+- [Logging](./logging/rhai)
+- [Response data modification](./data-response-mutate/rhai)
+- [Response errors modification](./error-response-mutate/rhai)
+- [Subgraph request logging](./subgraph-request-log/rhai)
+- [Surrogate cache key creation](./surrogate-cache-key/rhai)
 
 ### Native Rust Plugins
+
 Writing your own plugins in rust!
-* [Hello world](./hello-world)
-* [Context](./context)
-* [Async auth](./async-auth)
-* [Jwt auth](./jwt-auth)
-* [Forbid mutations](./forbid_mutations)
-* [Status code propagation](./status-code-propagation)
+
+- [Hello world](./hello-world/rust)
+- [Context](./context/rust)
+- [Async auth](./async-auth/rust)
+- [Jwt auth](./jwt-auth/rust)
+- [Forbid mutations](./forbid-mutations/rust)
+- [Status code propagation](./status-code-propagation/rust)
+- [Forbid anonymous operations](./forbid-anonymous-operations/rust)
 
 ### Advanced usage
+
 Customize the router for embedding in a different web server.
-* [Embedded](./embedded)
 
+- [Embedded](./embedded/rust)

examples/add-timestamp-header/Cargo.toml → examples/add-timestamp-header/rhai/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
 anyhow = "1"
-apollo-router = { path = "../../apollo-router" }
+apollo-router = { path = "../../../apollo-router" }
 futures = "0.3"
 http = "0.2"
 serde_json = "1"

examples/add-timestamp-header/rhai/README.md

@@ -0,0 +1,9 @@
+# Rhai script
+
+Demonstrates header and context manipulation via Rhai script.
+
+Usage:
+
+```bash
+cargo run -- -s ../../graphql/supergraph.graphql -c ./router.yaml
+```

examples/add-timestamp-header/src/main.rs → examples/add-timestamp-header/rhai/src/main.rs

@@ -5,7 +5,7 @@
 
 use anyhow::Result;
 
-// `cargo run -- -s ../graphql/supergraph.graphql -c ./router.yaml`
+// `cargo run -- -s ../../graphql/supergraph.graphql -c ./router.yaml`
 fn main() -> Result<()> {
     apollo_router::main()
 }

examples/async-auth/Cargo.toml → examples/async-auth/rust/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
 anyhow = "1"
-apollo-router = { path = "../../apollo-router" }
+apollo-router = { path = "../../../apollo-router" }
 async-trait = "0.1"
 futures = "0.3"
 http = "0.2"

examples/async-auth/README.md → examples/async-auth/rust/README.md

@@ -1,14 +1,16 @@
 # Async authentication
+
 Demonstrates use of `checkpoint_async` to perform authentication that depends on an asynchronous call.
 
 ## Usage
+
 ```bash
-cargo run -- -s ../graphql/supergraph.graphql -c ./router.yaml
+cargo run -- -s ../../graphql/supergraph.graphql -c ./router.yaml
 ```
 
 ## Implementation
 
-In this example a file is read to check for an ID, but it could be any async call, for example to an external 
+In this example a file is read to check for an ID, but it could be any async call, for example to an external
 authentication server.
 
 `checkpoint` and `checkpoint_async` allow you to halt request and return immediately. This is particularly useful for authentication.
@@ -19,7 +21,7 @@ authentication server.
         service: router::BoxService,
     ) -> router::BoxService {
         ServiceBuilder::new()
-            .checkpoint_async(...) // Authentication happens here 
+            .checkpoint_async(...) // Authentication happens here
             .buffer(20_000) // Required, see note below
             .service(service)
             .boxed()
@@ -28,4 +30,3 @@ authentication server.
 
 Note that layers that require a service to be moved across an `await` point, e.g. `checkpoint_async` or `filter_async`
 must be followed by a call to buffer, as they require the downstream service to be `Clone`.
-

examples/async-auth/src/main.rs → examples/async-auth/rust/src/main.rs

@@ -32,7 +32,7 @@ mod allow_client_id_from_file;
 
 use anyhow::Result;
 
-// `cargo run -- -s ../graphql/supergraph.graphql -c ./router.yaml`
+// `cargo run -- -s ../../graphql/supergraph.graphql -c ./router.yaml`
 fn main() -> Result<()> {
     apollo_router::main()
 }

examples/context/Cargo.toml → examples/context/rust/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
 anyhow = "1"
-apollo-router = { path = "../../apollo-router" }
+apollo-router = { path = "../../../apollo-router" }
 async-trait = "0.1"
 futures = "0.3"
 http = "0.2"

examples/context/README.md → examples/context/rust/README.md

@@ -3,15 +3,18 @@
 Demonstrate use of context to pass information between request lifecycle stages.
 
 ## Usage
+
 ```bash
-cargo run -- -s ../graphql/supergraph.graphql -c ./router.yaml
+cargo run -- -s ../../graphql/supergraph.graphql -c ./router.yaml
 ```
 
 ## Implementation
+
 Context can be used to pass information between services. It's useful for storing things like authentication data or
 collecting cache control information.
 
 The request lifecycle looks like this:
+
 ```mermaid
 sequenceDiagram
     actor Client
@@ -22,41 +25,45 @@ sequenceDiagram
 
     Client->>SupergraphService: request
     SupergraphService->>QueryPlannerService: plan
-    QueryPlannerService-->>SupergraphService: 
+    QueryPlannerService-->>SupergraphService:
     SupergraphService->>ExecutionService: execute
     ExecutionService-)SubgraphService(s): sub-request
-    SubgraphService(s)--)ExecutionService: 
+    SubgraphService(s)--)ExecutionService:
     ExecutionService-)SubgraphService(s): sub-request
-    SubgraphService(s)--)ExecutionService: 
+    SubgraphService(s)--)ExecutionService:
     ExecutionService-)SubgraphService(s): sub-request
-    SubgraphService(s)--)ExecutionService: 
+    SubgraphService(s)--)ExecutionService:
     ExecutionService-->>SupergraphService: response
     SupergraphService-->>Client: response
 ```
 
 For each request a single instance of `Context` is created and maintained .
 
 In this example we:
+
 1. Place some information in context at the incoming request of the router service. (world!)
 2. Pick up and print it out at subgraph request. (Hello world!)
 3. For each subgraph response merge some information into the `Context`. (response_count)
 4. Pick up and print it out at router response. (response_count)
 
 Context can store anything that is `Serde` compatible. For instance, all simple types or a custom type.
+
 ```rust
 # Insert
 context.insert("key1", 1)?;
 ```
 
 Serialization and deserialization happen automatically. You may sometimes need to specify the type in the case
 where the rust compiler cannot figure it out by itself.
+
 ```rust
 # Get
 let value : u32 = context.get("key1")?;
 ```
 
 Upserts are guaranteed to happen serially. This is useful at the subgraph service where multiple requests are happening
 in parallel.
+
 ```rust
 # Upsert
 context.upsert("present", |v| v + 1, || 0)?;

examples/context/src/main.rs → examples/context/rust/src/main.rs

@@ -12,7 +12,7 @@ use anyhow::Result;
 // you can use the plugin by adding it to `router.yaml`
 mod context_data;
 
-// `cargo run -- -s ../graphql/supergraph.graphql -c ./router.yaml`
+// `cargo run -- -s ../../graphql/supergraph.graphql -c ./router.yaml`
 fn main() -> Result<()> {
     apollo_router::main()
 }