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(channels): grant channels comment access to shared PDFs (#7608)

Will Hutchinson81fde3a6f472
diff --git a/.sqlx/query-1ac95ce3231ecad2ab682a8c026c7c46856c031226d176cb9078869e66b394fa.json b/.sqlx/query-1ac95ce3231ecad2ab682a8c026c7c46856c031226d176cb9078869e66b394fa.json
new file mode 100644
index 0000000000..0ae4aa70d1
--- /dev/null
+++ b/.sqlx/query-1ac95ce3231ecad2ab682a8c026c7c46856c031226d176cb9078869e66b394fa.json
@@ -0,0 +1,35 @@
+{
+ "db_name": "PostgreSQL",
+ "query": "SELECT access_level AS \"access_level: AccessLevel\" FROM entity_access\n WHERE entity_id = $1 AND entity_type = 'document' AND source_id = $2\n AND source_type = 'channel' AND granted_from_project_id IS NULL",
+ "describe": {
+ "columns": [
+ {
+ "ordinal": 0,
+ "name": "access_level: AccessLevel",
+ "type_info": {
+ "Custom": {
+ "name": "\"AccessLevel\"",
+ "kind": {
+ "Enum": [
+ "view",
+ "comment",
+ "edit",
+ "owner"
+ ]
+ }
+ }
+ }
+ }
+ ],
+ "parameters": {
+ "Left": [
+ "Uuid",
+ "Text"
+ ]
+ },
+ "nullable": [
+ false
+ ]
+ },
+ "hash": "1ac95ce3231ecad2ab682a8c026c7c46856c031226d176cb9078869e66b394fa"
+}
diff --git a/.sqlx/query-200c23797d6058b842c1b2e3756c8ec605652b8a249332583fcf1494ea7bf2b3.json b/.sqlx/query-200c23797d6058b842c1b2e3756c8ec605652b8a249332583fcf1494ea7bf2b3.json
new file mode 100644
index 0000000000..a7489866a4
--- /dev/null
+++ b/.sqlx/query-200c23797d6058b842c1b2e3756c8ec605652b8a249332583fcf1494ea7bf2b3.json
@@ -0,0 +1,35 @@
+{
+ "db_name": "PostgreSQL",
+ "query": "SELECT csp.access_level AS \"access_level: AccessLevel\"\n FROM \"ChannelSharePermission\" csp\n JOIN \"DocumentPermission\" dp ON dp.\"sharePermissionId\" = csp.share_permission_id\n WHERE dp.\"documentId\" = $1 AND csp.channel_id = $2",
+ "describe": {
+ "columns": [
+ {
+ "ordinal": 0,
+ "name": "access_level: AccessLevel",
+ "type_info": {
+ "Custom": {
+ "name": "\"AccessLevel\"",
+ "kind": {
+ "Enum": [
+ "view",
+ "comment",
+ "edit",
+ "owner"
+ ]
+ }
+ }
+ }
+ }
+ ],
+ "parameters": {
+ "Left": [
+ "Text",
+ "Text"
+ ]
+ },
+ "nullable": [
+ false
+ ]
+ },
+ "hash": "200c23797d6058b842c1b2e3756c8ec605652b8a249332583fcf1494ea7bf2b3"
+}
diff --git a/Cargo.lock b/Cargo.lock
index 935affb647..d245ed70c7 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -3950,6 +3950,7 @@ dependencies = [
"mockall",
"model-entity",
"model-error-response",
+ "model_file_type",
"model_notifications",
"model_owner",
"models_pagination",
diff --git a/apps/web/src/lib/core/component/ForwardToChannel.test.tsx b/apps/web/src/lib/core/component/ForwardToChannel.test.tsx
index d89ea51a5c..61cebeced2 100644
--- a/apps/web/src/lib/core/component/ForwardToChannel.test.tsx
+++ b/apps/web/src/lib/core/component/ForwardToChannel.test.tsx
@@ -152,6 +152,19 @@ describe('forwarding with selected access', () => {
}
);
+ it('defaults pdf sharing to comment', async () => {
+ mocks.sendToChannel.mockResolvedValue({
+ channelId: 'channel-1',
+ navigateToChannel: vi.fn(),
+ });
+ const setChannelPermissions = vi.fn().mockResolvedValue(true);
+ const { submit } = mountForward(setChannelPermissions, 'pdf');
+
+ await submit();
+
+ expect(setChannelPermissions).toHaveBeenCalledWith('channel-1', 'comment');
+ });
+
it.each(['channel', 'user', 'group'] as const)(
'finishes sending to a %s before applying the selected access level',
async (target) => {
diff --git a/apps/web/src/lib/core/component/ForwardToChannel.tsx b/apps/web/src/lib/core/component/ForwardToChannel.tsx
index bf2c12989a..89ec47ab19 100644
--- a/apps/web/src/lib/core/component/ForwardToChannel.tsx
+++ b/apps/web/src/lib/core/component/ForwardToChannel.tsx
@@ -38,6 +38,7 @@ import {
onMount,
Show,
} from 'solid-js';
+import { match } from 'ts-pattern';
import { Permissions } from './SharePermissions';
import { toast } from './Toast/Toast';
import { ScrollIndicators } from './VerticalScrollIndicators';
@@ -262,7 +263,12 @@ export function ForwardToChannel(props: ForwardToChannelProps) {
: contextBlockBaseName;
const [submitAccessLevel, setSubmitAccessLevel] =
createSignal<AccessLevel | null>(
- props.initialAccessLevel ?? (blockBaseName === 'md' ? 'edit' : 'view')
+ props.initialAccessLevel ??
+ match(blockBaseName)
+ .returnType<AccessLevel>()
+ .with('md', () => 'edit')
+ .with('pdf', () => 'comment')
+ .otherwise(() => 'view')
);
createEffect(() => {
const channelPermissions_ = channelPermissions();
diff --git a/crates/channels/Cargo.toml b/crates/channels/Cargo.toml
index 21a2878fd3..05a4778bb8 100644
--- a/crates/channels/Cargo.toml
+++ b/crates/channels/Cargo.toml
@@ -126,6 +126,7 @@ macro_uuid = { path = "../macro_uuid", optional = true }
messages = { path = "../messages", features = ["broker"] }
model-entity = { path = "../model-entity", optional = true }
model-error-response = { path = "../model-error-response", optional = true }
+model_file_type = { path = "../model_file_type" }
model_notifications = { path = "../model_notifications", optional = true }
model_owner = { path = "../model_owner" }
models_pagination = { path = "../models_pagination" }
diff --git a/crates/channels/fixtures/reference_share_documents.sql b/crates/channels/fixtures/reference_share_documents.sql
new file mode 100644
index 0000000000..08d736e193
--- /dev/null
+++ b/crates/channels/fixtures/reference_share_documents.sql
@@ -0,0 +1,11 @@
+INSERT INTO macro_user (id, username, email, stripe_customer_id) VALUES
+ ('50000000-0000-0000-0000-000000000001', '[email protected]', '[email protected]', 'cus_owner');
+INSERT INTO "User" (id, email, name, macro_user_id) VALUES
+ ('macro|[email protected]', '[email protected]', 'Owner', '50000000-0000-0000-0000-000000000001');
+INSERT INTO "Document" (id, name, owner, "fileType") VALUES
+ ('20000000-0000-0000-0000-000000000001', 'Contract', 'macro|[email protected]', 'pdf'),
+ ('20000000-0000-0000-0000-000000000002', 'Notes', 'macro|[email protected]', 'md');
+INSERT INTO "SharePermission" (id) VALUES ('pdf'), ('md');
+INSERT INTO "DocumentPermission" ("documentId", "sharePermissionId") VALUES
+ ('20000000-0000-0000-0000-000000000001', 'pdf'),
+ ('20000000-0000-0000-0000-000000000002', 'md');
diff --git a/crates/channels/src/domain/ports.rs b/crates/channels/src/domain/ports.rs
index 569ef7c336..515d1ba32f 100644
--- a/crates/channels/src/domain/ports.rs
+++ b/crates/channels/src/domain/ports.rs
@@ -876,7 +876,8 @@ pub trait ChannelReferenceSharePermissions: Send + Sync + 'static {
/// Update channel share permissions according to the referenced entity's policy.
///
/// Implementations must not grant access for an item the actor cannot already view.
- /// Agent sessions require ownership and grant edit access; other references grant view.
+ /// Agent sessions require ownership and grant view access; PDFs grant comment access,
+ /// capped at the actor's own access; other references grant view.
fn update_channel_share_permissions_for_referenced_items(
&self,
actor: MacroUserIdStr<'static>,
diff --git a/crates/channels/src/domain/reference_sharing.rs b/crates/channels/src/domain/reference_sharing.rs
index a8c5252fc0..b830ae8b7c 100644
--- a/crates/channels/src/domain/reference_sharing.rs
+++ b/crates/channels/src/domain/reference_sharing.rs
@@ -2,6 +2,7 @@
use super::models::ReferencedShareItemType;
use entity_access::domain::models::AccessLevel;
+use model_file_type::FileType;
/// Only owners may share session references, and automatic sharing grants view
/// access. Sending a reference never grants control of an agent session.
@@ -9,8 +10,12 @@ use entity_access::domain::models::AccessLevel;
/// A calendar event is shareable only by someone holding it on their own
/// calendar: its owner or a linked account. A member who sees the event only
/// through an earlier channel share holds view access and cannot pass it on.
+///
+/// A PDF grants comment access so channel members can annotate it, capped at
+/// the sharer's own access. `file_type` is the referenced document's file type.
pub(crate) fn grant_level(
item_type: ReferencedShareItemType,
+ file_type: Option<FileType>,
access: Option<AccessLevel>,
) -> Option<AccessLevel> {
match (item_type, access) {
@@ -22,6 +27,9 @@ pub(crate) fn grant_level(
}
(ReferencedShareItemType::AgentSession | ReferencedShareItemType::CalendarEvent, _)
| (_, None) => None,
+ (ReferencedShareItemType::Document, Some(level)) if file_type == Some(FileType::Pdf) => {
+ Some(level.min(AccessLevel::Comment))
+ }
(_, Some(_)) => Some(AccessLevel::View),
}
}
diff --git a/crates/channels/src/domain/reference_sharing/test.rs b/crates/channels/src/domain/reference_sharing/test.rs
index 1310213ded..35e947b563 100644
--- a/crates/channels/src/domain/reference_sharing/test.rs
+++ b/crates/channels/src/domain/reference_sharing/test.rs
@@ -10,7 +10,7 @@ fn only_owner_can_share_session_view_with_channel() {
(Some(AccessLevel::Owner), Some(AccessLevel::View)),
] {
assert_eq!(
- grant_level(ReferencedShareItemType::AgentSession, access),
+ grant_level(ReferencedShareItemType::AgentSession, None, access),
expected
);
}
@@ -26,13 +26,47 @@ fn existing_reference_types_keep_view_sharing() {
ReferencedShareItemType::EmailThread,
ReferencedShareItemType::Call,
] {
- assert_eq!(grant_level(kind, None), None);
+ assert_eq!(grant_level(kind, None, None), None);
assert_eq!(
- grant_level(kind, Some(AccessLevel::View)),
+ grant_level(kind, None, Some(AccessLevel::View)),
Some(AccessLevel::View)
);
assert_eq!(
- grant_level(kind, Some(AccessLevel::Owner)),
+ grant_level(kind, None, Some(AccessLevel::Owner)),
+ Some(AccessLevel::View)
+ );
+ }
+}
+
+#[test]
+fn pdf_references_grant_comment_up_to_the_sharers_access() {
+ for (access, expected) in [
+ (None, None),
+ (Some(AccessLevel::View), Some(AccessLevel::View)),
+ (Some(AccessLevel::Comment), Some(AccessLevel::Comment)),
+ (Some(AccessLevel::Edit), Some(AccessLevel::Comment)),
+ (Some(AccessLevel::Owner), Some(AccessLevel::Comment)),
+ ] {
+ assert_eq!(
+ grant_level(
+ ReferencedShareItemType::Document,
+ Some(FileType::Pdf),
+ access
+ ),
+ expected
+ );
+ }
+}
+
+#[test]
+fn other_document_file_types_keep_view_sharing() {
+ for file_type in [FileType::Md, FileType::Docx, FileType::Png] {
+ assert_eq!(
+ grant_level(
+ ReferencedShareItemType::Document,
+ Some(file_type),
+ Some(AccessLevel::Owner)
+ ),
Some(AccessLevel::View)
);
}
@@ -48,7 +82,7 @@ fn only_calendar_holders_can_share_event_view_with_channel() {
(Some(AccessLevel::Owner), Some(AccessLevel::View)),
] {
assert_eq!(
- grant_level(ReferencedShareItemType::CalendarEvent, access),
+ grant_level(ReferencedShareItemType::CalendarEvent, None, access),
expected
);
}
diff --git a/crates/channels/src/outbound/pg_channel_reference_share_permissions.rs b/crates/channels/src/outbound/pg_channel_reference_share_permissions.rs
index 18b9dfec01..c6862abd7d 100644
--- a/crates/channels/src/outbound/pg_channel_reference_share_permissions.rs
+++ b/crates/channels/src/outbound/pg_channel_reference_share_permissions.rs
@@ -8,6 +8,7 @@ use crate::domain::{
use anyhow::Context;
use entity_access::domain::{models::EntityType, ports::EntityAccessService};
use macro_user_id::user_id::MacroUserIdStr;
+use model_file_type::FileType;
use models_permissions::share_permission::{
access_level::AccessLevel,
channel_share_permission::{UpdateChannelSharePermission, UpdateOperation},
@@ -59,15 +60,43 @@ where
)
.await
.context("failed to get user access level")?;
- if let Some(level) = grant_level(item.entity_type(), access) {
- ensure_referenced_item_visible_to_channel(&self.pool, channel_id, &item, level)
- .await?;
- }
+ share_referenced_item_with_channel(&self.pool, channel_id, &item, access).await?;
}
Ok(())
}
}
+async fn share_referenced_item_with_channel(
+ db: &PgPool,
+ channel_id: Uuid,
+ item: &ReferencedShareItem,
+ sharer_access: Option<AccessLevel>,
+) -> anyhow::Result<()> {
+ let file_type = match item.entity_type() {
+ ReferencedShareItemType::Document => get_document_file_type(db, item.entity_id()).await?,
+ _ => None,
+ };
+ if let Some(level) = grant_level(item.entity_type(), file_type, sharer_access) {
+ ensure_referenced_item_visible_to_channel(db, channel_id, item, level).await?;
+ }
+ Ok(())
+}
+
+async fn get_document_file_type(
+ db: &PgPool,
+ document_id: &str,
+) -> anyhow::Result<Option<FileType>> {
+ let file_type = sqlx::query_scalar!(
+ r#"SELECT "fileType" as "file_type?" FROM "Document" WHERE id = $1"#,
+ document_id,
+ )
+ .fetch_optional(db)
+ .await
+ .context("failed to get document file type")?
+ .flatten();
+ Ok(file_type.and_then(|file_type| file_type.parse().ok()))
+}
+
async fn ensure_referenced_item_visible_to_channel(
db: &PgPool,
channel_id: Uuid,
diff --git a/crates/channels/src/outbound/pg_channel_reference_share_permissions/test.rs b/crates/channels/src/outbound/pg_channel_reference_share_permissions/test.rs
index 2d3f1320f3..4a9df7c0a4 100644
--- a/crates/channels/src/outbound/pg_channel_reference_share_permissions/test.rs
+++ b/crates/channels/src/outbound/pg_channel_reference_share_permissions/test.rs
@@ -2,6 +2,116 @@ use super::*;
use entity_access_db_utils::{EntityAccessSourceType, insert_entity_access_row};
use macro_db_migrator::MACRO_DB_MIGRATIONS;
+const PDF_DOCUMENT_ID: &str = "20000000-0000-0000-0000-000000000001";
+const MD_DOCUMENT_ID: &str = "20000000-0000-0000-0000-000000000002";
+
+async fn document_channel_levels(
+ pool: &PgPool,
+ document_id: &str,
+ channel_id: Uuid,
+) -> (Option<AccessLevel>, Option<AccessLevel>) {
+ let share_level = sqlx::query_scalar!(
+ r#"SELECT csp.access_level AS "access_level: AccessLevel"
+ FROM "ChannelSharePermission" csp
+ JOIN "DocumentPermission" dp ON dp."sharePermissionId" = csp.share_permission_id
+ WHERE dp."documentId" = $1 AND csp.channel_id = $2"#,
+ document_id,
+ channel_id.to_string(),
+ )
+ .fetch_optional(pool)
+ .await
+ .unwrap();
+ let entity_access_level = sqlx::query_scalar!(
+ r#"SELECT access_level AS "access_level: AccessLevel" FROM entity_access
+ WHERE entity_id = $1 AND entity_type = 'document' AND source_id = $2
+ AND source_type = 'channel' AND granted_from_project_id IS NULL"#,
+ macro_uuid::string_to_uuid(document_id).unwrap(),
+ channel_id.to_string(),
+ )
+ .fetch_optional(pool)
+ .await
+ .unwrap();
+ (share_level, entity_access_level)
+}
+
+#[sqlx::test(
+ fixtures(path = "../../../fixtures", scripts("reference_share_documents")),
+ migrator = "MACRO_DB_MIGRATIONS"
+)]
+async fn pdf_references_grant_the_channel_comment_access(pool: PgPool) {
+ let item = ReferencedShareItem::from_raw(PDF_DOCUMENT_ID, "document").unwrap();
+ for sharer_access in [AccessLevel::Comment, AccessLevel::Edit, AccessLevel::Owner] {
+ let channel_id = Uuid::now_v7();
+ share_referenced_item_with_channel(&pool, channel_id, &item, Some(sharer_access))
+ .await
+ .unwrap();
+ assert_eq!(
+ document_channel_levels(&pool, PDF_DOCUMENT_ID, channel_id).await,
+ (Some(AccessLevel::Comment), Some(AccessLevel::Comment))
+ );
+ }
+}
+
+#[sqlx::test(
+ fixtures(path = "../../../fixtures", scripts("reference_share_documents")),
+ migrator = "MACRO_DB_MIGRATIONS"
+)]
+async fn pdf_references_never_grant_more_than_the_sharer_holds(pool: PgPool) {
+ let channel_id = Uuid::now_v7();
+ let item = ReferencedShareItem::from_raw(PDF_DOCUMENT_ID, "document").unwrap();
+ share_referenced_item_with_channel(&pool, channel_id, &item, Some(AccessLevel::View))
+ .await
+ .unwrap();
+ assert_eq!(
+ document_channel_levels(&pool, PDF_DOCUMENT_ID, channel_id).await,
+ (Some(AccessLevel::View), Some(AccessLevel::View))
+ );
+
+ let unshared_channel_id = Uuid::now_v7();
+ share_referenced_item_with_channel(&pool, unshared_channel_id, &item, None)
+ .await
+ .unwrap();
+ assert_eq!(
+ document_channel_levels(&pool, PDF_DOCUMENT_ID, unshared_channel_id).await,
+ (None, None)
+ );
+}
+
+#[sqlx::test(
+ fixtures(path = "../../../fixtures", scripts("reference_share_documents")),
+ migrator = "MACRO_DB_MIGRATIONS"
+)]
+async fn non_pdf_document_references_grant_the_channel_view_access(pool: PgPool) {
+ let channel_id = Uuid::now_v7();
+ let item = ReferencedShareItem::from_raw(MD_DOCUMENT_ID, "document").unwrap();
+ share_referenced_item_with_channel(&pool, channel_id, &item, Some(AccessLevel::Owner))
+ .await
+ .unwrap();
+ assert_eq!(
+ document_channel_levels(&pool, MD_DOCUMENT_ID, channel_id).await,
+ (Some(AccessLevel::View), Some(AccessLevel::View))
+ );
+}
+
+#[sqlx::test(
+ fixtures(path = "../../../fixtures", scripts("reference_share_documents")),
+ migrator = "MACRO_DB_MIGRATIONS"
+)]
+async fn pdf_references_keep_the_channel_access_the_owner_already_chose(pool: PgPool) {
+ let channel_id = Uuid::now_v7();
+ let item = ReferencedShareItem::from_raw(PDF_DOCUMENT_ID, "document").unwrap();
+ ensure_referenced_item_visible_to_channel(&pool, channel_id, &item, AccessLevel::View)
+ .await
+ .unwrap();
+ share_referenced_item_with_channel(&pool, channel_id, &item, Some(AccessLevel::Owner))
+ .await
+ .unwrap();
+ assert_eq!(
+ document_channel_levels(&pool, PDF_DOCUMENT_ID, channel_id).await,
+ (Some(AccessLevel::View), Some(AccessLevel::View))
+ );
+}
+
#[sqlx::test(migrator = "MACRO_DB_MIGRATIONS")]
async fn session_references_grant_view_and_preserve_existing_channel_access(pool: PgPool) {
let channel_id = Uuid::now_v7();
@@ -30,7 +140,8 @@ async fn session_references_grant_view_and_preserve_existing_channel_access(pool
.unwrap();
tx.commit().await.unwrap();
}
- let automatic_level = grant_level(item.entity_type(), Some(AccessLevel::Owner)).unwrap();
+ let automatic_level =
+ grant_level(item.entity_type(), None, Some(AccessLevel::Owner)).unwrap();
for _ in 0..2 {
ensure_referenced_item_visible_to_channel(&pool, channel_id, &item, automatic_level)
.await
@@ -55,7 +166,7 @@ async fn calendar_event_references_grant_the_channel_view_without_a_share_permis
let channel_id = Uuid::now_v7();
let event_id = Uuid::now_v7();
let item = ReferencedShareItem::from_raw(event_id.to_string(), "calendar_event").unwrap();
- let level = grant_level(item.entity_type(), Some(AccessLevel::Owner)).unwrap();
+ let level = grant_level(item.entity_type(), None, Some(AccessLevel::Owner)).unwrap();
for _ in 0..2 {
ensure_referenced_item_visible_to_channel(&pool, channel_id, &item, level)
.await
diff --git a/crates/integration_tests/local_e2e/tests/channel_mutations.rs b/crates/integration_tests/local_e2e/tests/channel_mutations.rs
index 5a40523fa1..c1acc754ea 100644
--- a/crates/integration_tests/local_e2e/tests/channel_mutations.rs
+++ b/crates/integration_tests/local_e2e/tests/channel_mutations.rs
@@ -752,8 +752,7 @@ async fn assert_document_attachment_share_permission_side_effect_contract(
)
.await?;
assert_db_attachment_count(&ctx.pool, &root.id, 1).await?;
- assert_db_document_channel_share_permission(&ctx.pool, &document.document_id, &channel.id)
- .await?;
+ assert_db_pdf_channel_share_permission(&ctx.pool, &document.document_id, &channel.id).await?;
for event in listeners
.wait_for_all(
@@ -1858,7 +1857,7 @@ async fn assert_db_attachment_count(
Ok(())
}
-async fn assert_db_document_channel_share_permission(
+async fn assert_db_pdf_channel_share_permission(
pool: &PgPool,
document_id: &str,
channel_id: &str,
@@ -1884,7 +1883,7 @@ async fn assert_db_document_channel_share_permission(
FROM "ChannelSharePermission"
WHERE "share_permission_id" = $1
AND "channel_id" = $2
- AND "access_level"::text = 'view'
+ AND "access_level"::text = 'comment'
)
"#,
)
@@ -1908,7 +1907,7 @@ async fn assert_db_document_channel_share_permission(
AND entity_type = 'document'
AND source_id = $2
AND source_type::text = 'channel'
- AND access_level::text = 'view'
+ AND access_level::text = 'comment'
AND granted_from_project_id IS NULL
)
"#,
@@ -1920,7 +1919,7 @@ async fn assert_db_document_channel_share_permission(
.context("failed to query document channel entity access row")?;
ensure!(
entity_access_exists,
- "document {document_id} did not receive view entity_access from channel {channel_id}"
+ "document {document_id} did not receive comment entity_access from channel {channel_id}"
);
Ok(())