Tracking for Release v0.17.0

.github/workflows/build_and_test.yml

@@ -97,6 +97,7 @@ jobs:
         with:
           cache-all-crates: "true"
           prefix-key: "macos"
+      - uses: taiki-e/install-action@nextest
       - name: Run WASM tests with Safari, Firefox, Chrome
         run: |
           rustup target add wasm32-unknown-unknown
@@ -126,6 +127,7 @@ jobs:
         with:
           cache-all-crates: "true"
           prefix-key: "macos"
+      - uses: taiki-e/install-action@nextest
       - name: Run WASM tests with Safari, Firefox, Chrome
         run: |
           rustup target add wasm32-unknown-unknown

CONTRIBUTING.md

@@ -10,3 +10,7 @@ ever since [we streamlined the process of doing so](https://github.com/polyphony
 
 If you'd like to contribute new functionality, check out [The 'Meta'-issues.](https://github.com/polyphony-chat/chorus/issues?q=is%3Aissue+label%3A%22Type%3A+Meta%22+) They contain a comprehensive list of all features which are yet missing for full Discord.com compatibility.
 Please feel free to open an Issue with the idea you have, or a Pull Request.
+
+## Merging
+
+All pull requests opened into the `dev` branch should be merged via the "Squash and Merge" option to keep the commit history small. Merging into the `main` branch should be done via a regular merge commit. This way, GitHub will correctly attribute contributors and count statistics for the insights tab.

src/api/auth/login.rs

@@ -30,15 +30,25 @@ impl Instance {
         // We do not have a user yet, and the UserRateLimits will not be affected by a login
         // request (since login is an instance wide limit), which is why we are just cloning the
         // instances' limits to pass them on as user_rate_limits later.
+<<<<<<< HEAD
         let mut user = ChorusUser::shell(Arc::new(RwLock::new(self.clone())), "None").await;
 
         let login_result = chorus_request
             .deserialize_response::<LoginResult>(&mut user)
             .await?;
         user.set_token(&login_result.token);
+=======
+        let mut user =
+            ChorusUser::shell(Arc::new(RwLock::new(self.clone())), "None".to_string()).await;
+
+        let login_result = chorus_request
+            .deserialize_response::<LoginResult>(&mut user)
+            .await?;
+        user.set_token(login_result.token);
+>>>>>>> 03f1e7d (Refactor / fix login and register (#495))
         user.settings = login_result.settings;
 
-        let object = User::get(&mut user, None).await?;
+        let object = User::get_current(&mut user).await?;
         *user.object.write().unwrap() = object;
 
         let mut identify = GatewayIdentifyPayload::common();

src/api/auth/mod.rs

@@ -22,10 +22,16 @@
 
 impl Instance {
     /// Logs into an existing account on the spacebar server, using only a token.
+<<<<<<< HEAD
     pub async fn login_with_token(&mut self, token: &str) -> ChorusResult<ChorusUser> {
         let mut user = ChorusUser::shell(Arc::new(RwLock::new(self.clone())), token).await;
+=======
+    pub async fn login_with_token(&mut self, token: String) -> ChorusResult<ChorusUser> {
+        let mut user =
+            ChorusUser::shell(Arc::new(RwLock::new(self.clone())), token).await;
+>>>>>>> 03f1e7d (Refactor / fix login and register (#495))
 
-        let object = User::get(&mut user, None).await?;
+        let object = User::get_current(&mut user).await?;
         let settings = User::get_settings(&mut user).await?;
 
         *user.object.write().unwrap() = object;

src/api/auth/register.rs

@@ -37,13 +37,23 @@ impl Instance {
         // We do not have a user yet, and the UserRateLimits will not be affected by a login
         // request (since register is an instance wide limit), which is why we are just cloning
         // the instances' limits to pass them on as user_rate_limits later.
+<<<<<<< HEAD
         let mut user = ChorusUser::shell(Arc::new(RwLock::new(self.clone())), "None").await;
 
+=======
+        let mut user =
+            ChorusUser::shell(Arc::new(RwLock::new(self.clone())), "None".to_string()).await;
+
+>>>>>>> 03f1e7d (Refactor / fix login and register (#495))
         let token = chorus_request
             .deserialize_response::<Token>(&mut user)
             .await?
             .token;
+<<<<<<< HEAD
         user.set_token(&token);
+=======
+        user.set_token(token); 
+>>>>>>> 03f1e7d (Refactor / fix login and register (#495))
 
         let object = User::get(&mut user, None).await?;
         let settings = User::get_settings(&mut user).await?;

src/api/instance.rs

@@ -0,0 +1,104 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+//! Contains miscellaneous api routes, such as /version and /ping
+use serde_json::from_str;
+
+use crate::errors::{ChorusError, ChorusResult};
+use crate::instance::Instance;
+use crate::types::{GeneralConfiguration, PingReturn, VersionReturn};
+
+impl Instance {
+    /// Pings the instance, also fetches instance info.
+    ///
+    /// See: [PingReturn]
+    ///
+    /// # Notes
+    /// This is a Spacebar only endpoint.
+    ///
+    /// # Reference
+    /// See <https://docs.spacebar.chat/routes/#get-/ping/>
+    pub async fn ping(&self) -> ChorusResult<PingReturn> {
+        let endpoint_url = format!("{}/ping", self.urls.api.clone());
+
+        let request = match self.client.get(&endpoint_url).send().await {
+            Ok(result) => result,
+            Err(e) => {
+                return Err(ChorusError::RequestFailed {
+                    url: endpoint_url,
+                    error: e.to_string(),
+                });
+            }
+        };
+
+        if !request.status().as_str().starts_with('2') {
+            return Err(ChorusError::ReceivedErrorCode {
+                error_code: request.status().as_u16(),
+                error: request.text().await.unwrap(),
+            });
+        }
+
+        let response_text = match request.text().await {
+            Ok(string) => string,
+            Err(e) => {
+                return Err(ChorusError::InvalidResponse {
+                    error: format!(
+                        "Error while trying to process the HTTP response into a String: {}",
+                        e
+                    ),
+                });
+            }
+        };
+
+        match from_str::<PingReturn>(&response_text) {
+			Ok(return_value) => Ok(return_value),
+			Err(e) => Err(ChorusError::InvalidResponse { error: format!("Error while trying to deserialize the JSON response into requested type T: {}. JSON Response: {}",
+                        e, response_text) })
+		  }
+    }
+
+    /// Fetches the instance's software implementation and version.
+    ///
+    /// See: [VersionReturn]
+    ///
+    /// # Notes
+    /// This is a Symfonia only endpoint. (For now, we hope that spacebar will adopt it as well)
+    pub async fn get_version(&self) -> ChorusResult<VersionReturn> {
+        let endpoint_url = format!("{}/version", self.urls.api.clone());
+
+        let request = match self.client.get(&endpoint_url).send().await {
+            Ok(result) => result,
+            Err(e) => {
+                return Err(ChorusError::RequestFailed {
+                    url: endpoint_url,
+                    error: e.to_string(),
+                });
+            }
+        };
+
+        if !request.status().as_str().starts_with('2') {
+            return Err(ChorusError::ReceivedErrorCode {
+                error_code: request.status().as_u16(),
+                error: request.text().await.unwrap(),
+            });
+        }
+
+        let response_text = match request.text().await {
+            Ok(string) => string,
+            Err(e) => {
+                return Err(ChorusError::InvalidResponse {
+                    error: format!(
+                        "Error while trying to process the HTTP response into a String: {}",
+                        e
+                    ),
+                });
+            }
+        };
+
+        match from_str::<VersionReturn>(&response_text) {
+			Ok(return_value) => Ok(return_value),
+			Err(e) => Err(ChorusError::InvalidResponse { error: format!("Error while trying to deserialize the JSON response into requested type T: {}. JSON Response: {}", e, response_text) })
+		  }
+    }
+}

src/api/mod.rs

@@ -10,10 +10,12 @@ pub use guilds::*;
 pub use invites::*;
 pub use policies::instance::instance::*;
 pub use users::*;
+pub use instance::*;
 
 pub mod auth;
 pub mod channels;
 pub mod guilds;
 pub mod invites;
 pub mod policies;
 pub mod users;
+pub mod instance;

src/api/policies/instance/instance.rs

@@ -17,7 +17,7 @@ impl Instance {
     /// # Reference
     /// See <https://docs.spacebar.chat/routes/#get-/policies/instance/>
     pub async fn general_configuration_schema(&self) -> ChorusResult<GeneralConfiguration> {
-        let endpoint_url = self.urls.api.clone() + "/policies/instance";
+        let endpoint_url = self.urls.api.clone() + "/policies/instance/";
         let request = match self.client.get(&endpoint_url).send().await {
             Ok(result) => result,
             Err(e) => {
@@ -35,7 +35,28 @@ impl Instance {
             });
         }
 
-        let body = request.text().await.unwrap();
-        Ok(from_str::<GeneralConfiguration>(&body).unwrap())
+        let response_text = match request.text().await {
+            Ok(string) => string,
+            Err(e) => {
+                return Err(ChorusError::InvalidResponse {
+                    error: format!(
+                        "Error while trying to process the HTTP response into a String: {}",
+                        e
+                    ),
+                });
+            }
+        };
+
+        match from_str::<GeneralConfiguration>(&response_text) {
+            Ok(object) => Ok(object),
+            Err(e) => {
+                Err(ChorusError::InvalidResponse {
+                    error: format!(
+                        "Error while trying to deserialize the JSON response into requested type T: {}. JSON Response: {}",
+                        e, response_text
+                    ),
+                })
+            }
+        }
     }
 }