oxidecomputer · davepacheco · Jan 19, 2023 · Jan 9, 2023 · Jan 9, 2023 · Jan 9, 2023
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -17,6 +17,19 @@ https://github.com/oxidecomputer/dropshot/compare/v0.8.0\...HEAD[Full list of co
 
 === Breaking Changes
 
+// XXX-dap TODO need update here
+// Extractor -> {Shared,Exclusive}Extractor
+// type signature of from_request() changed
+//   both: accept &RequestContext instead of Arc
+//   now: no other change.  future: exclusive one will get a hyper::Request
+// exclusive extractors must appear last in the argument list
+
+// XXX-dap TODO more updates for RawRequest extractor
+// also update crate-level docs and other places we talk about TypedBody, etc.
+// maybe add an example?
+
+// XXX-dap TODO need update for removal of Arc around RequestContext
+
 * https://github.com/oxidecomputer/dropshot/pull/504[#504] Dropshot allows TLS configuration to be supplied either by path or as bytes. For compatibility, the `AsFile` variant of `ConfigTls` contains the `cert_file` and `key_file` fields, and may be used similarly to the old variant.
 * https://github.com/oxidecomputer/dropshot/pull/502[#502] Dropshot exposes a `refresh_tls` method to update the TLS certificates being used by a running server. If you previously tried to access `DropshotState.tls`, you can access the `DropshotState.using_tls()` method instead.
 * https://github.com/oxidecomputer/dropshot/pull/540[#540] `ConfigDropshot` now uses a [`camino::Utf8PathBuf`](https://docs.rs/camino/1.1.1/camino/struct.Utf8PathBuf.html) for its file path. There is no change to the configuration format itself, just its representation in Rust.

diff --git a/dropshot/examples/basic.rs b/dropshot/examples/basic.rs
@@ -83,7 +83,7 @@ struct CounterValue {
     path = "/counter",
 }]
 async fn example_api_get_counter(
-    rqctx: Arc<RequestContext<ExampleContext>>,
+    rqctx: RequestContext<ExampleContext>,
 ) -> Result<HttpResponseOk<CounterValue>, HttpError> {
     let api_context = rqctx.context();
 
@@ -99,7 +99,7 @@ async fn example_api_get_counter(
     path = "/counter",
 }]
 async fn example_api_put_counter(
-    rqctx: Arc<RequestContext<ExampleContext>>,
+    rqctx: RequestContext<ExampleContext>,
     update: TypedBody<CounterValue>,
 ) -> Result<HttpResponseUpdatedNoContent, HttpError> {
     let api_context = rqctx.context();

diff --git a/dropshot/examples/file_server.rs b/dropshot/examples/file_server.rs
@@ -76,7 +76,7 @@ struct AllPath {
     unpublished = true,
 }]
 async fn static_content(
-    rqctx: Arc<RequestContext<FileServerContext>>,
+    rqctx: RequestContext<FileServerContext>,
     path: Path<AllPath>,
 ) -> Result<Response<Body>, HttpError> {
     let path = path.into_inner().path;

diff --git a/dropshot/examples/https.rs b/dropshot/examples/https.rs
@@ -127,7 +127,7 @@ struct CounterValue {
     path = "/counter",
 }]
 async fn example_api_get_counter(
-    rqctx: Arc<RequestContext<ExampleContext>>,
+    rqctx: RequestContext<ExampleContext>,
 ) -> Result<HttpResponseOk<CounterValue>, HttpError> {
     let api_context = rqctx.context();
 
@@ -143,7 +143,7 @@ async fn example_api_get_counter(
     path = "/counter",
 }]
 async fn example_api_put_counter(
-    rqctx: Arc<RequestContext<ExampleContext>>,
+    rqctx: RequestContext<ExampleContext>,
     update: TypedBody<CounterValue>,
 ) -> Result<HttpResponseUpdatedNoContent, HttpError> {
     let api_context = rqctx.context();

diff --git a/dropshot/examples/index.rs b/dropshot/examples/index.rs
@@ -66,7 +66,7 @@ struct AllPath {
     unpublished = true,
 }]
 async fn index(
-    _rqctx: Arc<RequestContext<()>>,
+    _rqctx: RequestContext<()>,
     path: Path<AllPath>,
 ) -> Result<Response<Body>, HttpError> {
     Ok(Response::builder()

diff --git a/dropshot/examples/module-basic.rs b/dropshot/examples/module-basic.rs
@@ -89,7 +89,7 @@ pub mod routes {
           path = "/counter",
       }]
     pub async fn example_api_get_counter(
-        rqctx: Arc<RequestContext<ExampleContext>>,
+        rqctx: RequestContext<ExampleContext>,
     ) -> Result<HttpResponseOk<CounterValue>, HttpError> {
         let api_context = rqctx.context();
 
@@ -105,7 +105,7 @@ pub mod routes {
           path = "/counter",
       }]
     pub async fn example_api_put_counter(
-        rqctx: Arc<RequestContext<ExampleContext>>,
+        rqctx: RequestContext<ExampleContext>,
         update: TypedBody<CounterValue>,
     ) -> Result<HttpResponseUpdatedNoContent, HttpError> {
         let api_context = rqctx.context();

diff --git a/dropshot/examples/module-shared-context.rs b/dropshot/examples/module-shared-context.rs
@@ -101,7 +101,7 @@ pub struct CounterValue {
       path = "/counter",
   }]
 pub async fn example_api_get_counter(
-    rqctx: Arc<RequestContext<Arc<ExampleContext>>>,
+    rqctx: RequestContext<Arc<ExampleContext>>,
 ) -> Result<HttpResponseOk<CounterValue>, HttpError> {
     let api_context = rqctx.context();
 

diff --git a/dropshot/examples/multiple-servers.rs b/dropshot/examples/multiple-servers.rs
@@ -258,7 +258,7 @@ struct ServerDescription {
     path = "/servers",
 }]
 async fn api_get_servers(
-    rqctx: Arc<RequestContext<MultiServerContext>>,
+    rqctx: RequestContext<MultiServerContext>,
 ) -> Result<HttpResponseOk<Vec<ServerDescription>>, HttpError> {
     let api_context = rqctx.context();
 
@@ -285,7 +285,7 @@ struct PathName {
     path = "/servers/{name}",
 }]
 async fn api_start_server(
-    rqctx: Arc<RequestContext<MultiServerContext>>,
+    rqctx: RequestContext<MultiServerContext>,
     path: Path<PathName>,
     body: TypedBody<SocketAddr>,
 ) -> Result<HttpResponseCreated<ServerDescription>, HttpError> {
@@ -313,7 +313,7 @@ async fn api_start_server(
     path = "/servers/{name}",
 }]
 async fn api_stop_server(
-    rqctx: Arc<RequestContext<MultiServerContext>>,
+    rqctx: RequestContext<MultiServerContext>,
     path: Path<PathName>,
 ) -> Result<HttpResponseDeleted, HttpError> {
     let api_context = rqctx.context();

diff --git a/dropshot/examples/pagination-basic.rs b/dropshot/examples/pagination-basic.rs
@@ -69,7 +69,7 @@ struct ProjectPage {
     path = "/projects"
 }]
 async fn example_list_projects(
-    rqctx: Arc<RequestContext<BTreeMap<String, Project>>>,
+    rqctx: RequestContext<BTreeMap<String, Project>>,
     query: Query<PaginationParams<EmptyScanParams, ProjectPage>>,
 ) -> Result<HttpResponseOk<ResultsPage<Project>>, HttpError> {
     let pag_params = query.into_inner();

diff --git a/dropshot/examples/pagination-multiple-resources.rs b/dropshot/examples/pagination-multiple-resources.rs
@@ -158,7 +158,7 @@ fn scan_params(p: &WhichPage<ExScanParams, ExPageSelector>) -> ExScanParams {
     path = "/projects"
 }]
 async fn example_list_projects(
-    rqctx: Arc<RequestContext<DataCollection>>,
+    rqctx: RequestContext<DataCollection>,
     query: Query<PaginationParams<ExScanParams, ExPageSelector>>,
 ) -> Result<HttpResponseOk<ResultsPage<Project>>, HttpError> {
     let pag_params = query.into_inner();
@@ -184,7 +184,7 @@ async fn example_list_projects(
     path = "/disks"
 }]
 async fn example_list_disks(
-    rqctx: Arc<RequestContext<DataCollection>>,
+    rqctx: RequestContext<DataCollection>,
     query: Query<PaginationParams<ExScanParams, ExPageSelector>>,
 ) -> Result<HttpResponseOk<ResultsPage<Disk>>, HttpError> {
     let pag_params = query.into_inner();
@@ -210,7 +210,7 @@ async fn example_list_disks(
     path = "/instances"
 }]
 async fn example_list_instances(
-    rqctx: Arc<RequestContext<DataCollection>>,
+    rqctx: RequestContext<DataCollection>,
     query: Query<PaginationParams<ExScanParams, ExPageSelector>>,
 ) -> Result<HttpResponseOk<ResultsPage<Instance>>, HttpError> {
     let pag_params = query.into_inner();

diff --git a/dropshot/examples/pagination-multiple-sorts.rs b/dropshot/examples/pagination-multiple-sorts.rs
@@ -221,7 +221,7 @@ fn page_selector_for(
     path = "/projects"
 }]
 async fn example_list_projects(
-    rqctx: Arc<RequestContext<ProjectCollection>>,
+    rqctx: RequestContext<ProjectCollection>,
     query: Query<PaginationParams<ProjectScanParams, ProjectScanPageSelector>>,
 ) -> Result<HttpResponseOk<ResultsPage<Project>>, HttpError> {
     let pag_params = query.into_inner();

diff --git a/dropshot/examples/petstore.rs b/dropshot/examples/petstore.rs
@@ -71,7 +71,7 @@ struct PathParams {
 }]
 /// Get the pet with the specified ID
 async fn get_pet_by_id(
-    rqctx: Arc<RequestContext<()>>,
+    rqctx: RequestContext<()>,
     path_params: Path<PathParams>,
 ) -> Result<HttpResponseOk<Pet>, HttpError> {
     let pet = Pet {
@@ -94,7 +94,7 @@ async fn get_pet_by_id(
 }]
 /// Add a new pet to the store
 async fn update_pet_with_form(
-    rqctx: Arc<RequestContext<()>>,
+    rqctx: RequestContext<()>,
     body: TypedBody<Pet>,
 ) -> Result<HttpResponseOk<()>, HttpError> {
     unimplemented!()
@@ -125,7 +125,7 @@ struct FindByTagsPageSelector {
 }]
 /// Find pets by tags
 async fn find_pets_by_tags(
-    rqctx: Arc<RequestContext<()>>,
+    rqctx: RequestContext<()>,
     query: Query<
         PaginationParams<FindByTagsScanParams, FindByTagsPageSelector>,
     >,

diff --git a/dropshot/examples/request-headers.rs b/dropshot/examples/request-headers.rs
@@ -4,8 +4,8 @@
 //!
 //! The headers accessed here will not be recorded as inputs in the OpenAPI
 //! spec.  This is not currently supported out-of-the-box with Dropshot, but it
-//! could be done by implementing you're own `Extractor` that pulls the headers
-//! out, similar to what's done here.
+//! could be done by implementing you're own `SharedExtractor` that pulls the
+//! headers out, similar to what's done here.
 //!
 //! This example is based on the "basic.rs" one.  See that one for more detailed
 //! comments on the common code.
@@ -46,11 +46,10 @@ async fn main() -> Result<(), String> {
     path = "/header-example-generic",
 }]
 async fn example_api_get_header_generic(
-    rqctx: Arc<RequestContext<()>>,
+    rqctx: RequestContext<()>,
 ) -> Result<HttpResponseOk<String>, HttpError> {
-    let request = rqctx.request.lock().await;
     // Note that clients can provide multiple values for a header.  See
     // http::HeaderMap for ways to get all of them.
-    let header = request.headers().get("demo-header");
+    let header = rqctx.request.headers().get("demo-header");
     Ok(HttpResponseOk(format!("value for header: {:?}", header)))
 }
diff --git a/dropshot/examples/schema-with-example.rs b/dropshot/examples/schema-with-example.rs
@@ -66,7 +66,7 @@ fn main() -> Result<(), String> {
 }]
 /// Get a foo
 async fn get_foo(
-    _rqctx: Arc<RequestContext<()>>,
+    _rqctx: RequestContext<()>,
 ) -> Result<HttpResponseOk<Foo>, HttpError> {
     let foo = foo_example();
     Ok(HttpResponseOk(foo))

diff --git a/dropshot/examples/self-referential.rs b/dropshot/examples/self-referential.rs
@@ -85,7 +85,7 @@ struct CounterValue {
     path = "/counter",
 }]
 async fn example_api_get_counter(
-    rqctx: Arc<RequestContext<Arc<ExampleContext>>>,
+    rqctx: RequestContext<Arc<ExampleContext>>,
 ) -> Result<HttpResponseOk<CounterValue>, HttpError> {
     let api_context = rqctx.context();
 

diff --git a/dropshot/examples/websocket.rs b/dropshot/examples/websocket.rs
@@ -61,7 +61,7 @@ struct QueryParams {
     path = "/counter",
 }]
 async fn example_api_websocket_counter(
-    _rqctx: Arc<RequestContext<()>>,
+    _rqctx: RequestContext<()>,
     upgraded: WebsocketConnection,
     qp: Query<QueryParams>,
 ) -> dropshot::WebsocketChannelResult {

diff --git a/dropshot/examples/well-tagged.rs b/dropshot/examples/well-tagged.rs
@@ -19,7 +19,7 @@ use dropshot::{
     tags = ["simpsons"],
 }]
 async fn get_homerism(
-    _rqctx: Arc<RequestContext<()>>,
+    _rqctx: RequestContext<()>,
 ) -> Result<HttpResponseOk<String>, HttpError> {
     unimplemented!()
 }
@@ -30,7 +30,7 @@ async fn get_homerism(
     tags = ["simpsons"],
 }]
 async fn get_barneyism(
-    _rqctx: Arc<RequestContext<()>>,
+    _rqctx: RequestContext<()>,
 ) -> Result<HttpResponseOk<String>, HttpError> {
     unimplemented!()
 }
@@ -41,7 +41,7 @@ async fn get_barneyism(
     tags = ["futurama"],
 }]
 async fn get_fryism(
-    _rqctx: Arc<RequestContext<()>>,
+    _rqctx: RequestContext<()>,
 ) -> Result<HttpResponseOk<String>, HttpError> {
     unimplemented!()
 }