Allow querying browser sessions

crates/graphql/Cargo.toml

@@ -11,7 +11,6 @@ chrono = "0.4.22"
 serde = { version = "1.0.147", features = ["derive"] }
 sqlx = { version = "0.6.2", features = ["runtime-tokio-rustls", "postgres"] }
 tokio = { version = "1.21.2", features = ["time"] }
-tokio-stream = "0.1.11"
 ulid = "1.0.0"
 
 mas-axum-utils = { path = "../axum-utils" }

crates/graphql/schema.graphql

@@ -11,6 +11,35 @@ type BrowserSession {
 	createdAt: DateTime!
 }
 
+type BrowserSessionConnection {
+	"""
+	Information to aid in pagination.
+	"""
+	pageInfo: PageInfo!
+	"""
+	A list of edges.
+	"""
+	edges: [BrowserSessionEdge!]!
+	"""
+	A list of nodes.
+	"""
+	nodes: [BrowserSession!]!
+}
+
+"""
+An edge in a connection.
+"""
+type BrowserSessionEdge {
+	"""
+	A cursor for use in pagination
+	"""
+	cursor: String!
+	"""
+	The item at the end of the edge
+	"""
+	node: BrowserSession!
+}
+
 """
 Implement the DateTime<Utc> scalar
 
@@ -21,13 +50,6 @@ scalar DateTime
 
 
 
-type Mutation {
-	"""
-	A dummy mutation so that the mutation object is not empty
-	"""
-	hello: Boolean!
-}
-
 """
 Information about pagination in a connection
 """
@@ -51,22 +73,22 @@ type PageInfo {
 }
 
 type Query {
-	currentSession: BrowserSession
+	"""
+	Get the current logged in browser session
+	"""
+	currentBrowserSession: BrowserSession
+	"""
+	Get the current logged in user
+	"""
 	currentUser: User
 }
 
 
-type Subscription {
-	"""
-	A dump subscription to try out the websocket
-	"""
-	integers(step: Int! = 1): Int!
-}
-
 type User {
 	id: ID!
 	username: String!
 	primaryEmail: UserEmail
+	browserSessions(after: String, before: String, first: Int, last: Int): BrowserSessionConnection!
 	emails(after: String, before: String, first: Int, last: Int): UserEmailConnection!
 }
 
@@ -109,7 +131,5 @@ type UserEmailEdge {
 
 schema {
 	query: Query
-	mutation: Mutation
-	subscription: Subscription
 }
 

crates/graphql/src/lib.rs

@@ -22,23 +22,20 @@
 #![warn(clippy::pedantic)]
 #![allow(clippy::module_name_repetitions, clippy::missing_errors_doc)]
 
-use std::time::Duration;
-
-use async_graphql::Context;
+use async_graphql::{Context, EmptyMutation, EmptySubscription};
 use mas_axum_utils::SessionInfo;
 use sqlx::PgPool;
-use tokio_stream::{Stream, StreamExt};
 
 use self::model::{BrowserSession, User};
 
 mod model;
 
-pub type Schema = async_graphql::Schema<Query, Mutation, Subscription>;
-pub type SchemaBuilder = async_graphql::SchemaBuilder<Query, Mutation, Subscription>;
+pub type Schema = async_graphql::Schema<Query, EmptyMutation, EmptySubscription>;
+pub type SchemaBuilder = async_graphql::SchemaBuilder<Query, EmptyMutation, EmptySubscription>;
 
 #[must_use]
 pub fn schema_builder() -> SchemaBuilder {
-    async_graphql::Schema::build(Query::new(), Mutation::new(), Subscription::new())
+    async_graphql::Schema::build(Query::new(), EmptyMutation, EmptySubscription)
 }
 
 #[derive(Default)]
@@ -55,7 +52,8 @@ impl Query {
 
 #[async_graphql::Object]
 impl Query {
-    async fn current_session(
+    /// Get the current logged in browser session
+    async fn current_browser_session(
         &self,
         ctx: &Context<'_>,
     ) -> Result<Option<BrowserSession>, async_graphql::Error> {
@@ -67,6 +65,7 @@ impl Query {
         Ok(session.map(BrowserSession::from))
     }
 
+    /// Get the current logged in user
     async fn current_user(&self, ctx: &Context<'_>) -> Result<Option<User>, async_graphql::Error> {
         let database = ctx.data::<PgPool>()?;
         let session_info = ctx.data::<SessionInfo>()?;
@@ -76,48 +75,3 @@ impl Query {
         Ok(session.map(User::from))
     }
 }
-
-#[derive(Default)]
-pub struct Mutation {
-    _private: (),
-}
-
-impl Mutation {
-    #[must_use]
-    pub fn new() -> Self {
-        Self::default()
-    }
-}
-
-#[async_graphql::Object]
-impl Mutation {
-    /// A dummy mutation so that the mutation object is not empty
-    async fn hello(&self) -> bool {
-        true
-    }
-}
-
-#[derive(Default)]
-pub struct Subscription {
-    _private: (),
-}
-
-impl Subscription {
-    #[must_use]
-    pub fn new() -> Self {
-        Self::default()
-    }
-}
-
-#[async_graphql::Subscription]
-impl Subscription {
-    /// A dump subscription to try out the websocket
-    async fn integers(&self, #[graphql(default = 1)] step: i32) -> impl Stream<Item = i32> {
-        let mut value = 0;
-        tokio_stream::wrappers::IntervalStream::new(tokio::time::interval(Duration::from_secs(1)))
-            .map(move |_| {
-                value += step;
-                value
-            })
-    }
-}

crates/graphql/src/model.rs

@@ -12,184 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use async_graphql::{
-    connection::{query, Connection, Edge, OpaqueCursor},
-    Context, Object, ID,
+mod browser_sessions;
+mod cursor;
+mod users;
+
+pub use self::{
+    browser_sessions::{Authentication, BrowserSession},
+    cursor::{Cursor, NodeCursor, NodeType},
+    users::{User, UserEmail},
 };
-use chrono::{DateTime, Utc};
-use mas_storage::PostgresqlBackend;
-use serde::{Deserialize, Serialize};
-use sqlx::PgPool;
-use ulid::Ulid;
-
-#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone, Copy)]
-#[serde(rename = "snake_case")]
-enum NodeType {
-    User,
-    UserEmail,
-    BrowserSession,
-}
-
-#[derive(Serialize, Deserialize, PartialEq, Eq)]
-struct NodeCursor(NodeType, Ulid);
-
-impl NodeCursor {
-    fn extract_for_type(&self, node_type: NodeType) -> Result<Ulid, async_graphql::Error> {
-        if self.0 == node_type {
-            Ok(self.1)
-        } else {
-            Err(async_graphql::Error::new("invalid cursor"))
-        }
-    }
-}
-
-type Cursor = OpaqueCursor<NodeCursor>;
-
-pub struct BrowserSession(mas_data_model::BrowserSession<PostgresqlBackend>);
-
-impl From<mas_data_model::BrowserSession<PostgresqlBackend>> for BrowserSession {
-    fn from(v: mas_data_model::BrowserSession<PostgresqlBackend>) -> Self {
-        Self(v)
-    }
-}
-
-#[Object]
-impl BrowserSession {
-    async fn id(&self) -> ID {
-        ID(self.0.data.to_string())
-    }
-
-    async fn user(&self) -> User {
-        User(self.0.user.clone())
-    }
-
-    async fn last_authentication(&self) -> Option<Authentication> {
-        self.0.last_authentication.clone().map(Authentication)
-    }
-
-    async fn created_at(&self) -> DateTime<Utc> {
-        self.0.created_at
-    }
-}
-
-pub struct User(mas_data_model::User<PostgresqlBackend>);
-
-impl From<mas_data_model::User<PostgresqlBackend>> for User {
-    fn from(v: mas_data_model::User<PostgresqlBackend>) -> Self {
-        Self(v)
-    }
-}
-
-impl From<mas_data_model::BrowserSession<PostgresqlBackend>> for User {
-    fn from(v: mas_data_model::BrowserSession<PostgresqlBackend>) -> Self {
-        Self(v.user)
-    }
-}
-
-#[Object]
-impl User {
-    async fn id(&self) -> ID {
-        ID(self.0.data.to_string())
-    }
-
-    async fn username(&self) -> &str {
-        &self.0.username
-    }
-
-    async fn primary_email(&self) -> Option<UserEmail> {
-        self.0.primary_email.clone().map(UserEmail)
-    }
-
-    async fn emails(
-        &self,
-        ctx: &Context<'_>,
-        after: Option<String>,
-        before: Option<String>,
-        first: Option<i32>,
-        last: Option<i32>,
-    ) -> Result<Connection<Cursor, UserEmail, UserEmailsPagination>, async_graphql::Error> {
-        let database = ctx.data::<PgPool>()?;
-
-        query(
-            after,
-            before,
-            first,
-            last,
-            |after, before, first, last| async move {
-                let mut conn = database.acquire().await?;
-                let after_id = after
-                    .map(|x: OpaqueCursor<NodeCursor>| x.extract_for_type(NodeType::UserEmail))
-                    .transpose()?;
-                let before_id = before
-                    .map(|x: OpaqueCursor<NodeCursor>| x.extract_for_type(NodeType::UserEmail))
-                    .transpose()?;
-
-                let (has_previous_page, has_next_page, edges) =
-                    mas_storage::user::get_paginated_user_emails(
-                        &mut conn, &self.0, before_id, after_id, first, last,
-                    )
-                    .await?;
-
-                let mut connection = Connection::with_additional_fields(
-                    has_previous_page,
-                    has_next_page,
-                    UserEmailsPagination(self.0.clone()),
-                );
-                connection.edges.extend(edges.into_iter().map(|u| {
-                    Edge::new(
-                        OpaqueCursor(NodeCursor(NodeType::UserEmail, u.data)),
-                        UserEmail(u),
-                    )
-                }));
-
-                Ok::<_, async_graphql::Error>(connection)
-            },
-        )
-        .await
-    }
-}
-
-pub struct Authentication(mas_data_model::Authentication<PostgresqlBackend>);
-
-#[Object]
-impl Authentication {
-    async fn id(&self) -> ID {
-        ID(self.0.data.to_string())
-    }
-
-    async fn created_at(&self) -> DateTime<Utc> {
-        self.0.created_at
-    }
-}
-
-pub struct UserEmail(mas_data_model::UserEmail<PostgresqlBackend>);
-
-#[Object]
-impl UserEmail {
-    async fn id(&self) -> ID {
-        ID(self.0.data.to_string())
-    }
-
-    async fn email(&self) -> &str {
-        &self.0.email
-    }
-
-    async fn created_at(&self) -> DateTime<Utc> {
-        self.0.created_at
-    }
-
-    async fn confirmed_at(&self) -> Option<DateTime<Utc>> {
-        self.0.confirmed_at
-    }
-}
-
-pub struct UserEmailsPagination(mas_data_model::User<PostgresqlBackend>);
-
-#[Object]
-impl UserEmailsPagination {
-    async fn total_count(&self, ctx: &Context<'_>) -> Result<i64, async_graphql::Error> {
-        let mut conn = ctx.data::<PgPool>()?.acquire().await?;
-        let count = mas_storage::user::count_user_emails(&mut conn, &self.0).await?;
-        Ok(count)
-    }
-}

crates/graphql/src/model/browser_sessions.rs

@@ -0,0 +1,59 @@
+// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use async_graphql::{Object, ID};
+use chrono::{DateTime, Utc};
+use mas_storage::PostgresqlBackend;
+
+use super::User;
+
+pub struct BrowserSession(pub mas_data_model::BrowserSession<PostgresqlBackend>);
+
+impl From<mas_data_model::BrowserSession<PostgresqlBackend>> for BrowserSession {
+    fn from(v: mas_data_model::BrowserSession<PostgresqlBackend>) -> Self {
+        Self(v)
+    }
+}
+
+#[Object]
+impl BrowserSession {
+    async fn id(&self) -> ID {
+        ID(self.0.data.to_string())
+    }
+
+    async fn user(&self) -> User {
+        User(self.0.user.clone())
+    }
+
+    async fn last_authentication(&self) -> Option<Authentication> {
+        self.0.last_authentication.clone().map(Authentication)
+    }
+
+    async fn created_at(&self) -> DateTime<Utc> {
+        self.0.created_at
+    }
+}
+
+pub struct Authentication(pub mas_data_model::Authentication<PostgresqlBackend>);
+
+#[Object]
+impl Authentication {
+    async fn id(&self) -> ID {
+        ID(self.0.data.to_string())
+    }
+
+    async fn created_at(&self) -> DateTime<Utc> {
+        self.0.created_at
+    }
+}

crates/graphql/src/model/cursor.rs

@@ -0,0 +1,39 @@
+// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use async_graphql::connection::OpaqueCursor;
+use serde::{Deserialize, Serialize};
+use ulid::Ulid;
+
+#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone, Copy)]
+#[serde(rename = "snake_case")]
+pub enum NodeType {
+    UserEmail,
+    BrowserSession,
+}
+
+#[derive(Serialize, Deserialize, PartialEq, Eq)]
+pub struct NodeCursor(pub NodeType, pub Ulid);
+
+impl NodeCursor {
+    pub fn extract_for_type(&self, node_type: NodeType) -> Result<Ulid, async_graphql::Error> {
+        if self.0 == node_type {
+            Ok(self.1)
+        } else {
+            Err(async_graphql::Error::new("invalid cursor"))
+        }
+    }
+}
+
+pub type Cursor = OpaqueCursor<NodeCursor>;

crates/graphql/src/model/users.rs

@@ -0,0 +1,176 @@
+// Copyright 2022 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use async_graphql::{
+    connection::{query, Connection, Edge, OpaqueCursor},
+    Context, Object, ID,
+};
+use chrono::{DateTime, Utc};
+use mas_storage::PostgresqlBackend;
+use sqlx::PgPool;
+
+use super::{BrowserSession, Cursor, NodeCursor, NodeType};
+
+pub struct User(pub mas_data_model::User<PostgresqlBackend>);
+
+impl From<mas_data_model::User<PostgresqlBackend>> for User {
+    fn from(v: mas_data_model::User<PostgresqlBackend>) -> Self {
+        Self(v)
+    }
+}
+
+impl From<mas_data_model::BrowserSession<PostgresqlBackend>> for User {
+    fn from(v: mas_data_model::BrowserSession<PostgresqlBackend>) -> Self {
+        Self(v.user)
+    }
+}
+
+#[Object]
+impl User {
+    async fn id(&self) -> ID {
+        ID(self.0.data.to_string())
+    }
+
+    async fn username(&self) -> &str {
+        &self.0.username
+    }
+
+    async fn primary_email(&self) -> Option<UserEmail> {
+        self.0.primary_email.clone().map(UserEmail)
+    }
+
+    async fn browser_sessions(
+        &self,
+        ctx: &Context<'_>,
+        after: Option<String>,
+        before: Option<String>,
+        first: Option<i32>,
+        last: Option<i32>,
+    ) -> Result<Connection<Cursor, BrowserSession>, async_graphql::Error> {
+        let database = ctx.data::<PgPool>()?;
+
+        query(
+            after,
+            before,
+            first,
+            last,
+            |after, before, first, last| async move {
+                let mut conn = database.acquire().await?;
+                let after_id = after
+                    .map(|x: OpaqueCursor<NodeCursor>| x.extract_for_type(NodeType::UserEmail))
+                    .transpose()?;
+                let before_id = before
+                    .map(|x: OpaqueCursor<NodeCursor>| x.extract_for_type(NodeType::UserEmail))
+                    .transpose()?;
+
+                let (has_previous_page, has_next_page, edges) =
+                    mas_storage::user::get_paginated_user_sessions(
+                        &mut conn, &self.0, before_id, after_id, first, last,
+                    )
+                    .await?;
+
+                let mut connection = Connection::new(has_previous_page, has_next_page);
+                connection.edges.extend(edges.into_iter().map(|u| {
+                    Edge::new(
+                        OpaqueCursor(NodeCursor(NodeType::BrowserSession, u.data)),
+                        BrowserSession(u),
+                    )
+                }));
+
+                Ok::<_, async_graphql::Error>(connection)
+            },
+        )
+        .await
+    }
+
+    async fn emails(
+        &self,
+        ctx: &Context<'_>,
+        after: Option<String>,
+        before: Option<String>,
+        first: Option<i32>,
+        last: Option<i32>,
+    ) -> Result<Connection<Cursor, UserEmail, UserEmailsPagination>, async_graphql::Error> {
+        let database = ctx.data::<PgPool>()?;
+
+        query(
+            after,
+            before,
+            first,
+            last,
+            |after, before, first, last| async move {
+                let mut conn = database.acquire().await?;
+                let after_id = after
+                    .map(|x: OpaqueCursor<NodeCursor>| x.extract_for_type(NodeType::UserEmail))
+                    .transpose()?;
+                let before_id = before
+                    .map(|x: OpaqueCursor<NodeCursor>| x.extract_for_type(NodeType::UserEmail))
+                    .transpose()?;
+
+                let (has_previous_page, has_next_page, edges) =
+                    mas_storage::user::get_paginated_user_emails(
+                        &mut conn, &self.0, before_id, after_id, first, last,
+                    )
+                    .await?;
+
+                let mut connection = Connection::with_additional_fields(
+                    has_previous_page,
+                    has_next_page,
+                    UserEmailsPagination(self.0.clone()),
+                );
+                connection.edges.extend(edges.into_iter().map(|u| {
+                    Edge::new(
+                        OpaqueCursor(NodeCursor(NodeType::UserEmail, u.data)),
+                        UserEmail(u),
+                    )
+                }));
+
+                Ok::<_, async_graphql::Error>(connection)
+            },
+        )
+        .await
+    }
+}
+
+pub struct UserEmail(mas_data_model::UserEmail<PostgresqlBackend>);
+
+#[Object]
+impl UserEmail {
+    async fn id(&self) -> ID {
+        ID(self.0.data.to_string())
+    }
+
+    async fn email(&self) -> &str {
+        &self.0.email
+    }
+
+    async fn created_at(&self) -> DateTime<Utc> {
+        self.0.created_at
+    }
+
+    async fn confirmed_at(&self) -> Option<DateTime<Utc>> {
+        self.0.confirmed_at
+    }
+}
+
+pub struct UserEmailsPagination(mas_data_model::User<PostgresqlBackend>);
+
+#[Object]
+impl UserEmailsPagination {
+    async fn total_count(&self, ctx: &Context<'_>) -> Result<i64, async_graphql::Error> {
+        let mut conn = ctx.data::<PgPool>()?.acquire().await?;
+        let count = mas_storage::user::count_user_emails(&mut conn, &self.0).await?;
+        Ok(count)
+    }
+}