Merge branch 'main' into connector-api2

Author: horned-sphere

.github/dependabot.yml

@@ -5,5 +5,14 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
-#    ignore:
-#      - dependency-name: ""
+    reviewers:
+      - "SirCipher"
+      - "horned-sphere"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 0
+    reviewers:
+      - "SirCipher"
+      - "horned-sphere"

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
 
 name: Continuous integration
 env:
-  latest_version: "1.79.0"
+  latest_version: "1.80.0"
 
 jobs:
   test:
@@ -142,3 +142,19 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
+
+  build_uis:
+    name: Build Example Application UIs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - path: "stocks_simulated/ui"
+            cmd: "npm install && npm run build"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Build UI
+        run: |
+          cd ${PWD}/example_apps/${{ matrix.path }}/
+          ${{ matrix.cmd }}

Cargo.toml

@@ -40,8 +40,9 @@ members = [
     "example_apps/join_value",
     "example_apps/aggregations",
     "example_apps/time_series",
-    "example_apps/devguide/2_2/*",
-    "example_apps/devguide/2_3/*",
+    "example_apps/devguide",
+    "example_apps/ripple",
+    "example_apps/stocks_simulated",
 ]
 
 [workspace.package]
@@ -144,7 +145,7 @@ webpki = "0.22"
 webpki-roots = "0.26.3"
 tokio-rustls = "0.26"
 rustls-pemfile = "2.1.2"
-trust-dns-resolver = "0.23.2"
+hickory-resolver = "0.24.1"
 clap = "4.1"
 crossbeam-queue = { version = "0.3" }
 crossbeam-channel = { version = "0.5" }
@@ -163,7 +164,7 @@ regex = "1.3.6"
 fnv = "1.0.7"
 cursive = { default-features = false, version = "0.20" }
 duration-str = "0.11.2"
-quick-xml = "0.34.0"
+quick-xml = "0.36.0"
 csv = "1.2"
 serde-xml-rs = "0.6"
 axum = "0.7.5"

README.md

@@ -1,5 +1,3 @@
-[![Build Status](https://dev.azure.com/swimai-build/swim-rust/_apis/build/status/swimos.swim-rust?branchName=main)](https://dev.azure.com/swimai-build/swim-rust/_build/latest?definitionId=1&branchName=main)
-[![codecov](https://codecov.io/gh/swimos/swim-rust/branch/main/graph/badge.svg?token=IVWBLXCGW8)](https://codecov.io/gh/swimos/swim-rust)
 <a href="https://www.swimos.org"><img src="https://docs.swimos.org/readme/marlin-blue.svg" align="left"></a>
 <br><br><br><br>
 
@@ -19,18 +17,43 @@ will also allow the subscriber to request changes to the state (for lane kinds t
 operate over a web-socket connection and are multiplexed, meaning that links to multiple lanes on the same
 host can share a single web-socket connection.
 
+[![SwimOS Crates.io Version][swimos-badge]][swimos-crate]
+[![SwimOS Client Crates.io Version][swimos-client-badge]][swimos-client-crate]
+[![SwimOS Form Crates.io Version][swimos-form-badge]][swimos-form-crate]
+
+[swimos-badge]: https://img.shields.io/crates/v/swimos?label=swimos
+
+[swimos-crate]: https://crates.io/crates/swimos
+
+[swimos-form-badge]: https://img.shields.io/crates/v/swimos?label=swimos_form
+
+[swimos-form-crate]: https://crates.io/crates/swimos_form
+
+[swimos-client-badge]: https://img.shields.io/crates/v/swimos?label=swimos_client
+
+[swimos-client-crate]: https://crates.io/crates/swimos_client
+
+[Website](https://swimos.org/) | [Developer Guide](https://www.swimos.org/server/rust/developer-guide/) | [Server API Docs](https://docs.rs/swimos/latest/swimos/) | [Client API Docs](https://docs.rs/swimos_client/latest/swimos_client/)
+
 ## Usage Guides
 
 [Implementing Swim Agents in Rust](docs/agent.md)
 
 [Building a Swim Server Application](docs/server.md)
 
+[Reference Documentation](https://www.swimos.org/server/rust/)
+
 ## Examples
 
 The following example application runs a SwimOS server that hosts a single agent route where each agent instance
 has single lane, called `lane`. Each time a changes is made to the lane, it will be printed on the console by the
 server.
 
+```toml
+[dependencies]
+swimos = { version = "0.1.0", features = ["server", "agent"] }
+```
+
 ```rust
 use swimos::{
     agent::{
@@ -46,7 +69,6 @@ use swimos::{
 
 #[tokio::main]
 pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    
     // An agent route consists of the agent definition and a lifecycle.
     let model = AgentModel::new(ExampleAgent::default, ExampleLifecycle.into_lifecycle());
 
@@ -80,7 +102,6 @@ struct ExampleLifecycle;
 // annotated event handlers methods in the block.
 #[lifecycle(ExampleAgent)]
 impl ExampleLifecycle {
-    
     #[on_event(lane)]
     fn lane_event(
         &self,
@@ -94,18 +115,24 @@ impl ExampleLifecycle {
             })
         })
     }
-
 }
 ```
 
-For example, if a Swim client sends an update, with the value `5`, to the agent at the URI `/examples/name` for the 
-lane `lane`, an instance of `ExampleAgent`, using `ExampleLifecycle`, will be started by the server. The value of the 
+For example, if a Swim client sends an update, with the value `5`, to the agent at the URI `/examples/name` for the
+lane `lane`, an instance of `ExampleAgent`, using `ExampleLifecycle`, will be started by the server. The value of the
 lane will then be set to `5` and the following will be printed on the console:
 
 ```
 Received value: 5 for 'lane' on agent at URI: /examples/name.
 ```
 
+A number of example applications are available in the [example_apps](example_apps) directory which demonstrate
+individual features as well as more comprehensive applications.
+
 ## Development
 
-See the [development guide](DEVELOPMENT.md).
+See the [development guide](DEVELOPMENT.md).
+
+## License
+
+This project is licensed under the [Apache 2.0 License](LICENSE).

api/formats/swimos_msgpack/src/lib.rs

@@ -17,10 +17,10 @@
 //! Provides a MessagesPack backend for the Swim serialization system. This consists of two parts:
 //!
 //! - A function [`read_from_msg_pack`] that will attempt to deserialize any type that implements
-//!  [`swimos_form::read::StructuralReadable`] from a buffer containing MessagePack data.
+//!   [`swimos_form::read::StructuralReadable`] from a buffer containing MessagePack data.
 //! - The type [`MsgPackInterpreter`] that implements [`swimos_form::write::StructuralWriter`]
-//! allowing any type that implements [`swimos_form::write::StructuralWritable`] to be
-//! serialized as MessagePack.
+//!   allowing any type that implements [`swimos_form::write::StructuralWritable`] to be
+//!   serialized as MessagePack.
 //!
 //! # Examples
 //!

api/formats/swimos_msgpack/src/writer/mod.rs

@@ -42,11 +42,11 @@ mod tests;
 /// MessagePack string and bin values. Records have the following encoding.
 ///
 /// - Attributes are written as MessagePack map where the keys are strings. If there are no
-/// attributes an empty map value is still required.
+///   attributes an empty map value is still required.
 /// - The items in the body follow the attributes immediately. If the body consists entirely of
-/// slots it is written as a map. If the body consists of all value items or a mix of value items
-/// and slots it is written as an array. When a slot occurs in an array body it is written as
-/// an array of size two.
+///   slots it is written as a map. If the body consists of all value items or a mix of value items
+///   and slots it is written as an array. When a slot occurs in an array body it is written as
+///   an array of size two.
 ///
 /// # Type Parameters
 ///

api/formats/swimos_recon/src/comparator/mod.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/comparator/tests.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/hasher/mod.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

api/formats/swimos_recon/src/hasher/tests.rs

@@ -1,4 +1,4 @@
-// Copyright 2015-2022 Swim Inc.
+// Copyright 2015-2024 Swim Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.