Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

fix(favorites): let users favorite channels they can view (#8777)

teo42295c45cb85
diff --git a/crates/favorites/AGENTS.md b/crates/favorites/AGENTS.md
index 9dc0764964..2efb32c0e5 100644
--- a/crates/favorites/AGENTS.md
+++ b/crates/favorites/AGENTS.md
@@ -42,6 +42,11 @@ hexagonal architecture pattern.
- `cargo test -p favorites --all-features` (`SQLX_OFFLINE` unset).
+## Gotchas
+
+- Authorize adds with `ports::FavoriteView`, not `ViewAccessLevel`: channels
+ resolve to channel roles, which `ViewAccessLevel` never accepts.
+
## Related
- Rules: `.agents/rules/rust/architecture.md`, `.agents/rules/rust/db.md`
diff --git a/crates/favorites/src/domain/mutation_service/test.rs b/crates/favorites/src/domain/mutation_service/test.rs
index 3206d2c01d..b5ee1bf6ec 100644
--- a/crates/favorites/src/domain/mutation_service/test.rs
+++ b/crates/favorites/src/domain/mutation_service/test.rs
@@ -1,10 +1,20 @@
use std::{collections::HashSet, sync::Mutex};
use chrono::Utc;
-use entity_access::domain::models::{EntityAccessReceipt, ViewAccessLevel};
+use cowlike::CowLike;
+use entity_access::domain::{
+ models::{
+ AccessError, AccessLevel, BotAccessScope, BotId, CallChannelInfo, Entity as AccessEntity,
+ EntityAccessReceipt, EntityPermission, ParticipantRole, RequiredPermission, TeamRole,
+ UserTeamInfo,
+ },
+ ports::EntityAccessService,
+};
+use macro_user_id::{lowercased::Lowercase, user_id::MacroUserId};
+use uuid::Uuid;
use super::*;
-use crate::domain::ports::FavoritesAuthorizer;
+use crate::domain::ports::{FavoriteView, FavoritesAuthorizer};
const USER_ID: &str = "macro|[email protected]";
@@ -31,7 +41,7 @@ impl FakeFavoritesService {
impl FavoritesService for FakeFavoritesService {
async fn add_favorite(
&self,
- receipt: &EntityAccessReceipt<ViewAccessLevel>,
+ receipt: &EntityAccessReceipt<FavoriteView>,
) -> Result<Favorite, FavoritesError> {
let entity = receipt.entity();
self.calls
@@ -133,7 +143,7 @@ impl FavoritesAuthorizer for FakeAuthorizer {
&self,
actor: &FavoritesMutationActor,
entity: &Entity<'static>,
- ) -> Result<EntityAccessReceipt<ViewAccessLevel>, FavoritesError> {
+ ) -> Result<EntityAccessReceipt<FavoriteView>, FavoritesError> {
self.calls
.lock()
.expect("calls lock poisoned")
@@ -147,7 +157,7 @@ impl FavoritesAuthorizer for FakeAuthorizer {
return Err(FavoritesError::Unauthorized);
}
Ok(
- EntityAccessReceipt::<ViewAccessLevel>::dangerously_assert_authenticated_user(
+ EntityAccessReceipt::<FavoriteView>::dangerously_assert_authenticated_user(
actor.user_id.clone(),
&entity.entity_id,
entity.entity_type,
@@ -156,6 +166,105 @@ impl FavoritesAuthorizer for FakeAuthorizer {
}
}
+/// Entity access that resolves every entity to one permission and mints
+/// receipts through the same requirement check as the real service.
+#[derive(Clone)]
+struct ResolvedAccess {
+ permission: EntityPermission,
+}
+
+impl EntityAccessService for ResolvedAccess {
+ async fn generate_entity_access_receipt<T: RequiredPermission>(
+ &self,
+ user_id: &MacroUserId<Lowercase<'_>>,
+ _user_org_id: Option<i64>,
+ entity_id: &str,
+ entity_type: EntityType,
+ ) -> Result<EntityAccessReceipt<T>, AccessError> {
+ EntityAccessReceipt::try_new_authenticated_user(
+ MacroUserIdStr(user_id.clone().into_owned()),
+ AccessEntity {
+ entity_id: entity_id.to_string(),
+ entity_type,
+ },
+ self.permission,
+ )
+ }
+ async fn generate_bot_entity_access_receipt<T: RequiredPermission>(
+ &self,
+ _: BotId,
+ _: BotAccessScope,
+ _: &str,
+ _: EntityType,
+ ) -> Result<EntityAccessReceipt<T>, AccessError> {
+ unreachable!()
+ }
+ async fn get_access_level(
+ &self,
+ _: Option<&MacroUserId<Lowercase<'_>>>,
+ _: &str,
+ _: EntityType,
+ ) -> Result<Option<AccessLevel>, AccessError> {
+ unreachable!()
+ }
+ async fn check_access(
+ &self,
+ _: Option<&MacroUserId<Lowercase<'_>>>,
+ _: &str,
+ _: EntityType,
+ _: AccessLevel,
+ ) -> Result<AccessLevel, AccessError> {
+ unreachable!()
+ }
+ async fn check_public_access(
+ &self,
+ _: &str,
+ _: EntityType,
+ _: AccessLevel,
+ ) -> Result<AccessLevel, AccessError> {
+ unreachable!()
+ }
+ async fn get_entity_permission(
+ &self,
+ _: Option<&MacroUserId<Lowercase<'_>>>,
+ _: &str,
+ _: EntityType,
+ _: Option<i64>,
+ ) -> Result<EntityPermission, AccessError> {
+ unreachable!()
+ }
+ async fn get_crm_entity_permission_with_team(
+ &self,
+ _: Option<&MacroUserId<Lowercase<'_>>>,
+ _: &str,
+ _: EntityType,
+ ) -> Result<(EntityPermission, Uuid, TeamRole), AccessError> {
+ unreachable!()
+ }
+ async fn get_users_by_entity(
+ &self,
+ _: &str,
+ _: EntityType,
+ ) -> Result<Vec<MacroUserIdStr<'static>>, AccessError> {
+ unreachable!()
+ }
+ async fn get_call_channel(&self, _: &Uuid) -> Result<Option<CallChannelInfo>, AccessError> {
+ unreachable!()
+ }
+ async fn get_call_channel_by_channel_id(
+ &self,
+ _: &Uuid,
+ ) -> Result<Option<CallChannelInfo>, AccessError> {
+ unreachable!()
+ }
+ async fn get_user_team(
+ &self,
+ _: &MacroUserId<Lowercase<'_>>,
+ ) -> Result<Option<UserTeamInfo>, AccessError> {
+ unreachable!()
+ }
+}
+
fn actor() -> FavoritesMutationActor {
FavoritesMutationActor {
user_id: MacroUserIdStr::parse_from_str(USER_ID).expect("valid user id"),
@@ -274,6 +383,48 @@ async fn every_supported_interactive_entity_can_be_added_and_removed() {
}
}
+#[tokio::test]
+async fn entity_access_authorizes_each_entity_kind_with_its_own_view_permission() {
+ for (entity_type, permission) in [
+ (
+ EntityType::Document,
+ EntityPermission::AccessLevel {
+ access_level: AccessLevel::View,
+ },
+ ),
+ (EntityType::Channel, EntityPermission::ChannelViewOnly),
+ (
+ EntityType::Channel,
+ EntityPermission::ChannelRole {
+ role: ParticipantRole::Member,
+ },
+ ),
+ ] {
+ let favorites = Arc::new(FakeFavoritesService::default());
+ let service = FavoritesMutationServiceImpl::new(
+ favorites.clone(),
+ Arc::new(ResolvedAccess { permission }),
+ );
+
+ let result = service
+ .set_favorite(
+ actor(),
+ entity_type.with_entity_string("entity-1".to_string()),
+ true,
+ )
+ .await;
+
+ assert!(
+ result.is_ok(),
+ "{entity_type:?} with {permission:?} should be favoritable, got {result:?}"
+ );
+ assert_eq!(
+ favorites.calls(),
+ vec![ServiceCall::Add(entity_type, "entity-1".to_string())]
+ );
+ }
+}
+
#[tokio::test]
async fn denied_contact_add_never_reaches_persistence() {
let favorites = Arc::new(FakeFavoritesService::default());
diff --git a/crates/favorites/src/domain/ports.rs b/crates/favorites/src/domain/ports.rs
index 53ccedefed..d6cf426a7d 100644
--- a/crates/favorites/src/domain/ports.rs
+++ b/crates/favorites/src/domain/ports.rs
@@ -3,7 +3,10 @@
use std::collections::HashSet;
use entity_access::domain::{
- models::{AccessError, EntityAccessReceipt, ViewAccessLevel},
+ models::{
+ AccessError, EntityAccessReceipt, EntityPermission, RequiredPermission, ViewAccessLevel,
+ ViewOnly,
+ },
ports::EntityAccessService,
};
use macro_user_id::user_id::MacroUserIdStr;
@@ -13,6 +16,17 @@ use crate::domain::models::{
Favorite, FavoriteFilter, FavoritesError, FavoritesMutationActor, SetFavoriteResult,
};
+/// Minimum permission to favorite an entity: view access to an item, or any
+/// channel permission. Channels never resolve to an item access level.
+#[derive(Debug, Clone, Copy)]
+pub struct FavoriteView;
+
+impl RequiredPermission for FavoriteView {
+ fn is_satisfied_by(permission: &EntityPermission) -> bool {
+ permission.satisfies::<ViewAccessLevel>() || permission.satisfies::<ViewOnly>()
+ }
+}
+
/// Outbound persistence port for favorites.
pub trait FavoritesRepo: Send + Sync + 'static {
/// The error type returned by repository operations.
@@ -76,7 +90,7 @@ pub trait FavoritesAuthorizer: Send + Sync + 'static {
&self,
actor: &FavoritesMutationActor,
entity: &Entity<'static>,
- ) -> impl Future<Output = Result<EntityAccessReceipt<ViewAccessLevel>, FavoritesError>> + Send;
+ ) -> impl Future<Output = Result<EntityAccessReceipt<FavoriteView>, FavoritesError>> + Send;
}
impl<A> FavoritesAuthorizer for A
@@ -87,8 +101,8 @@ where
&self,
actor: &FavoritesMutationActor,
entity: &Entity<'static>,
- ) -> Result<EntityAccessReceipt<ViewAccessLevel>, FavoritesError> {
- self.generate_entity_access_receipt::<ViewAccessLevel>(
+ ) -> Result<EntityAccessReceipt<FavoriteView>, FavoritesError> {
+ self.generate_entity_access_receipt::<FavoriteView>(
&actor.user_id,
actor.organization_id,
&entity.entity_id,
@@ -131,7 +145,7 @@ pub trait FavoritesService: Send + Sync + 'static {
/// Add an entity to the user's favorites (idempotent).
fn add_favorite(
&self,
- receipt: &EntityAccessReceipt<ViewAccessLevel>,
+ receipt: &EntityAccessReceipt<FavoriteView>,
) -> impl Future<Output = Result<Favorite, FavoritesError>> + Send;
/// Add an entity after a trusted caller has already established that the
diff --git a/crates/favorites/src/domain/service.rs b/crates/favorites/src/domain/service.rs
index 1ce539eb6a..ad5e48dcae 100644
--- a/crates/favorites/src/domain/service.rs
+++ b/crates/favorites/src/domain/service.rs
@@ -5,12 +5,12 @@ mod test;
use std::collections::HashSet;
-use entity_access::domain::models::{EntityAccessReceipt, ViewAccessLevel};
+use entity_access::domain::models::EntityAccessReceipt;
use macro_user_id::user_id::MacroUserIdStr;
use model_entity::Entity;
use crate::domain::models::{Favorite, FavoriteFilter, FavoritesError};
-use crate::domain::ports::{FavoritesRepo, FavoritesService};
+use crate::domain::ports::{FavoriteView, FavoritesRepo, FavoritesService};
/// Upper bound on favorites per user; keeps reorder payloads and sidebar
/// lists sane.
@@ -78,7 +78,7 @@ where
#[tracing::instrument(err, skip(self))]
async fn add_favorite(
&self,
- receipt: &EntityAccessReceipt<ViewAccessLevel>,
+ receipt: &EntityAccessReceipt<FavoriteView>,
) -> Result<Favorite, FavoritesError> {
let user_id = receipt
.get_authenticated_user()
diff --git a/crates/favorites/src/domain/service/test.rs b/crates/favorites/src/domain/service/test.rs
index 3a052de400..cd37737c3a 100644
--- a/crates/favorites/src/domain/service/test.rs
+++ b/crates/favorites/src/domain/service/test.rs
@@ -2,13 +2,13 @@ use std::collections::HashSet;
use std::sync::{Arc, Mutex};
use chrono::Utc;
-use entity_access::domain::models::{EntityAccessReceipt, ViewAccessLevel};
+use entity_access::domain::models::EntityAccessReceipt;
use macro_user_id::user_id::MacroUserIdStr;
use model_entity::{Entity, EntityType};
use super::{FavoritesServiceImpl, MAX_FAVORITES_PER_COLLECTION};
use crate::domain::models::{Favorite, FavoriteFilter, FavoritesError};
-use crate::domain::ports::{FavoritesRepo, FavoritesService};
+use crate::domain::ports::{FavoriteView, FavoritesRepo, FavoritesService};
const USER_ID: &str = "macro|[email protected]";
@@ -124,7 +124,7 @@ fn user_id() -> MacroUserIdStr<'static> {
fn authenticated_receipt(
entity_id: &str,
entity_type: EntityType,
-) -> EntityAccessReceipt<ViewAccessLevel> {
+) -> EntityAccessReceipt<FavoriteView> {
EntityAccessReceipt::dangerously_assert_authenticated_user(user_id(), entity_id, entity_type)
}
@@ -189,7 +189,7 @@ async fn add_favorite_with_established_access_forwards_user_and_entity() {
async fn add_favorite_rejects_internal_receipt_before_repository_calls() {
let repo = FakeFavoritesRepo::new(0);
let service = FavoritesServiceImpl::new(repo.clone());
- let receipt = EntityAccessReceipt::<ViewAccessLevel>::dangerously_assert_internal_user(
+ let receipt = EntityAccessReceipt::<FavoriteView>::dangerously_assert_internal_user(
"doc-123",
EntityType::Document,
);
diff --git a/crates/favorites/src/inbound/axum_router.rs b/crates/favorites/src/inbound/axum_router.rs
index 37153b45a9..e8c02024f8 100644
--- a/crates/favorites/src/inbound/axum_router.rs
+++ b/crates/favorites/src/inbound/axum_router.rs
@@ -14,8 +14,7 @@ use axum::{
};
use axum_extra::extract::Query;
use entity_access::{
- domain::{models::ViewAccessLevel, ports::EntityAccessService},
- inbound::axum_extractors::EntityBodyAccessLevelExtractor,
+ domain::ports::EntityAccessService, inbound::axum_extractors::EntityBodyAccessLevelExtractor,
};
use macro_authorization::{
MacroAuthorizationExtractor, MacroAuthorizationService, MacroAuthorizationState, UserOrInternal,
@@ -26,7 +25,7 @@ use serde::Deserialize;
use crate::domain::{
models::{Favorite, FavoriteFilter, FavoritesError, FavoritesList},
- ports::FavoritesService,
+ ports::{FavoriteView, FavoritesService},
};
/// Router state for favorites endpoints.
@@ -203,7 +202,7 @@ where
#[tracing::instrument(err, skip_all)]
pub async fn add_favorite_handler<S, AccessSvc, Auth>(
State(state): State<FavoritesRouterState<S, AccessSvc, Auth>>,
- access: EntityBodyAccessLevelExtractor<ViewAccessLevel, AccessSvc, AddFavoriteRequest, Auth>,
+ access: EntityBodyAccessLevelExtractor<FavoriteView, AccessSvc, AddFavoriteRequest, Auth>,
) -> Result<Json<Favorite>, FavoritesError>
where
S: FavoritesService,
diff --git a/crates/favorites/src/inbound/axum_router/test.rs b/crates/favorites/src/inbound/axum_router/test.rs
index f5b4982703..d947b8235d 100644
--- a/crates/favorites/src/inbound/axum_router/test.rs
+++ b/crates/favorites/src/inbound/axum_router/test.rs
@@ -79,7 +79,7 @@ fn collection() -> Vec<Favorite> {
impl FavoritesService for FakeFavoritesService {
async fn add_favorite(
&self,
- _receipt: &entity_access::domain::models::EntityAccessReceipt<ViewAccessLevel>,
+ _receipt: &entity_access::domain::models::EntityAccessReceipt<FavoriteView>,
) -> Result<Favorite, FavoritesError> {
unimplemented!("the list boundary does not add favorites")
}
diff --git a/services/document_storage_service/src/api/documents/initialize_starter_docs.rs b/services/document_storage_service/src/api/documents/initialize_starter_docs.rs
index a84cf87635..5b1cff5276 100644
--- a/services/document_storage_service/src/api/documents/initialize_starter_docs.rs
+++ b/services/document_storage_service/src/api/documents/initialize_starter_docs.rs
@@ -10,10 +10,10 @@ use documents_hex::domain::{
starter::seed_starter_documents,
};
use entity_access::domain::{
- models::{BotAccessScope, EditAccessLevel, ViewAccessLevel},
+ models::{BotAccessScope, EditAccessLevel},
ports::EntityAccessService,
};
-use favorites::domain::ports::FavoritesService;
+use favorites::domain::ports::{FavoriteView, FavoritesService};
use macro_authorization::{MacroAuthorizationExtractor, UserOrInternal};
use macro_user_id::user_id::MacroUserIdStr;
use model::document_storage_service_internal::{
@@ -378,7 +378,7 @@ pub async fn handler(
let favorite_result = async {
let how_to_guide_receipt = state
.entity_access_service
- .generate_entity_access_receipt::<ViewAccessLevel>(
+ .generate_entity_access_receipt::<FavoriteView>(
user_id,
organization_id,
&guide_id,