cozy-sharing 40.1.8 → 40.2.0

package/src/components/ShareAutosuggestWrapper.jsx

@@ -1,21 +1,27 @@
 import PropTypes from 'prop-types'
 import React from 'react'
 
-import { useQueryAll, isQueryLoading } from 'cozy-client'
+import { useClient, useQueryAll, isQueryLoading } from 'cozy-client'
+import { models } from 'cozy-client'
 import flag from 'cozy-flags'
 
 import ShareAutosuggest from './ShareAutosuggest'
-import { computeContactsAndGroups } from '../helpers/contacts'
+import { computeContactsAndGroups, suggestContacts } from '../helpers/contacts'
+import { useSharingContext } from '../hooks/useSharingContext'
+import { DOCTYPE_GROUPS } from '../models'
 import {
   buildReachableContactsQuery,
   buildContactGroupsQuery,
   buildUnreachableContactsWithGroupsQuery
 } from '../queries/queries'
 
+const ContactModel = models.contact
+
 /**
  * ShareAutosuggestWrapper is responsible for fetching contacts and groups.
  * We retrieve all the contacts that are reachable and the groups they belong to.
  * In order to display the total number of members in each group, we also retrieve the contacts that are not reachable.
+ * With contactsSuggestEnabled, the stack suggests the contacts and we only retrieve the group members.
  */
 const ShareAutosuggestWrapper = ({
   currentRecipients,
@@ -28,7 +34,12 @@ const ShareAutosuggestWrapper = ({
   autoFocus,
   endAdornment
 }) => {
-  const reachableContactsQuery = buildReachableContactsQuery()
+  const client = useClient()
+  const contactsSuggestEnabled = useSharingContext()?.contactsSuggestEnabled
+
+  const reachableContactsQuery = buildReachableContactsQuery({
+    inGroups: contactsSuggestEnabled
+  })
   const reachableContactsResult = useQueryAll(
     reachableContactsQuery.definition,
     reachableContactsQuery.options
@@ -59,7 +70,7 @@ const ShareAutosuggestWrapper = ({
       (isQueryLoading(unreachableContactsWithGroupsResult) ||
         unreachableContactsWithGroupsResult.hasMore))
 
-  const contactsAndGroups = computeContactsAndGroups({
+  const suggestedContactsAndGroups = computeContactsAndGroups({
     reachableContacts: reachableContactsResult.data || [],
     unreachableContactsWithGroups:
       unreachableContactsWithGroupsResult.data || [],
@@ -68,6 +79,24 @@ const ShareAutosuggestWrapper = ({
     pendingRecipients: recipients
   })
 
+  const contactsAndGroups = contactsSuggestEnabled
+    ? suggestedContactsAndGroups.filter(({ _type }) => _type === DOCTYPE_GROUPS)
+    : suggestedContactsAndGroups
+
+  // The stack matches the emails whatever their case
+  const normalizeEmail = email => email?.trim().toLowerCase()
+  const isRecipient = email =>
+    currentRecipients.some(r => normalizeEmail(r.email) === email) ||
+    recipients.some(
+      r => normalizeEmail(ContactModel.getPrimaryEmail(r)) === email
+    )
+
+  const fetchContacts = async q =>
+    (await suggestContacts(client, q)).filter(
+      contact =>
+        !isRecipient(normalizeEmail(ContactModel.getPrimaryEmail(contact)))
+    )
+
   return (
     <ShareAutosuggest
       loading={isLoading}
@@ -80,6 +109,7 @@ const ShareAutosuggestWrapper = ({
       placeholder={placeholder}
       autoFocus={autoFocus}
       endAdornment={endAdornment}
+      fetchContacts={contactsSuggestEnabled ? fetchContacts : undefined}
     />
   )
 }

package/src/components/ShareAutosuggestWrapper.spec.jsx

@@ -12,9 +12,12 @@ jest.mock('cozy-flags', () => ({
   default: jest.fn(() => null)
 }))
 
+let mockAutosuggestProps
 jest.mock('./ShareAutosuggest', () => ({
   __esModule: true,
-  default: ({ contactsAndGroups }) => {
+  default: props => {
+    mockAutosuggestProps = props
+    const { contactsAndGroups } = props
     return (
       <ul>
         {contactsAndGroups.map(contactOrGroup => {
@@ -39,8 +42,8 @@ jest.mock('./ShareAutosuggest', () => ({
 
 describe('ShareAutosuggestWrapper component', () => {
   const setup = (
-    { contacts, contactGroups, unreachableContact },
-    { currentRecipients, recipients } = {}
+    { contacts, contactGroups, unreachableContact, groupMembers },
+    { currentRecipients, recipients, contactsSuggestEnabled } = {}
   ) => {
     const mockClient = createMockClient({
       queries: {
@@ -55,11 +58,18 @@ describe('ShareAutosuggestWrapper component', () => {
         'io.cozy.contacts/unreachable-with-groups': {
           doctype: 'io.cozy.contacts',
           data: unreachableContact
+        },
+        'io.cozy.contacts/reachable-with-groups': {
+          doctype: 'io.cozy.contacts',
+          data: groupMembers
         }
       }
     })
     render(
-      <AppLike client={mockClient}>
+      <AppLike
+        client={mockClient}
+        sharingContextValue={{ contactsSuggestEnabled }}
+      >
         <ShareAutosuggestWrapper
           onPick={() => {}}
           onRemove={() => {}}
@@ -69,6 +79,7 @@ describe('ShareAutosuggestWrapper component', () => {
         />
       </AppLike>
     )
+    return mockClient
   }
 
   it('should include groups and contacts when are loaded', async () => {
@@ -219,7 +230,7 @@ describe('ShareAutosuggestWrapper component', () => {
   })
 
   it('should include unreachable members when flag sharing.show-recipient-groups is activated', async () => {
-    flag.mockReturnValue(true)
+    flag.mockImplementation(name => name === 'sharing.show-recipient-groups')
 
     const contacts = [
       {
@@ -294,4 +305,66 @@ describe('ShareAutosuggestWrapper component', () => {
       screen.getByText("The Night's Watch - 3 members")
     ).toBeInTheDocument()
   })
+
+  describe('with contactsSuggestEnabled', () => {
+    beforeEach(() => {
+      flag.mockReset()
+    })
+
+    it('should suggest only groups, with the count of their members', () => {
+      const groupMembers = [
+        {
+          id: '5a3b4ccf-c257',
+          _id: '5a3b4ccf-c257',
+          _type: 'io.cozy.contacts',
+          name: { givenName: 'Teagan', familyName: 'Wolf' },
+          relationships: {
+            groups: {
+              data: [{ _id: 'fe86af20-c6c5', _type: 'io.cozy.contacts.groups' }]
+            }
+          }
+        }
+      ]
+      const contactGroups = [
+        {
+          id: 'fe86af20-c6c5',
+          _id: 'fe86af20-c6c5',
+          _type: 'io.cozy.contacts.groups',
+          name: 'Friends'
+        }
+      ]
+
+      setup({ contactGroups, groupMembers }, { contactsSuggestEnabled: true })
+
+      expect(screen.getByText('Friends - 1 members')).toBeInTheDocument()
+      expect(screen.queryByText('Teagan Wolf')).not.toBeInTheDocument()
+    })
+
+    it('should fetch suggestions without the current and pending recipients, whatever the case of their email', async () => {
+      const suggestion = email => ({
+        type: 'io.cozy.contacts',
+        attributes: { fullname: email, email: [{ address: email }] }
+      })
+      const mockClient = setup(
+        { contactGroups: [], groupMembers: [] },
+        {
+          currentRecipients: [{ email: 'Current@Cozy.cc' }],
+          recipients: [{ email: 'pending@cozy.cc' }],
+          contactsSuggestEnabled: true
+        }
+      )
+      const fetchJSON = jest.fn().mockResolvedValue({
+        data: [
+          suggestion('current@cozy.cc'),
+          suggestion('PENDING@cozy.cc'),
+          suggestion('new@cozy.cc')
+        ]
+      })
+      jest.spyOn(mockClient, 'getStackClient').mockReturnValue({ fetchJSON })
+
+      const contacts = await mockAutosuggestProps.fetchContacts('coz')
+
+      expect(contacts.map(c => c.fullname)).toEqual(['new@cozy.cc'])
+    })
+  })
 })

package/src/components/ShareRestrictionModal/helpers.js

@@ -206,7 +206,8 @@ export const getLinkAccessOptions = ({
     verbs: editingRights === 'write' ? WRITE_PERMS : READ_ONLY_PERMS,
     expiresAt: expirationDate?.toISOString() || '',
     ttl: expirationDate ? makeTTL(expirationDate) : undefined,
-    password: passwordEnabled ? password : ''
+    // An empty field means "unchanged": undefined is left out of the request
+    password: passwordEnabled ? password || undefined : ''
   }
 }
 

package/src/components/ShareRestrictionModal/helpers.spec.js

@@ -124,7 +124,7 @@ describe('ShareRestrictionModal/helpers', () => {
       })
     })
 
-    it('should call updateDocumentPermissions with empty date & password if enabled without values', async () => {
+    it('should call updateDocumentPermissions with an empty date and keep the password if enabled without values', async () => {
       const updateDocumentPermissions = jest.fn()
       const file = { _id: '123' }
 
@@ -143,7 +143,7 @@ describe('ShareRestrictionModal/helpers', () => {
 
       expect(updateDocumentPermissions).toHaveBeenCalledWith(file, {
         expiresAt: '',
-        password: '',
+        password: undefined,
         verbs: ['GET']
       })
     })

package/src/helpers/contacts.js

@@ -2,13 +2,30 @@ import { models } from 'cozy-client'
 import flag from 'cozy-flags'
 
 import { validateEmail } from '../helpers/email'
+import { DOCTYPE_CONTACTS, DOCTYPE_GROUPS } from '../models'
 
 const ContactModel = models.contact
 
 // Return the contact object if present
 // Else check if a contact exist with this email address, if yes return it
 // if not create it
-export const getOrCreateFromArray = async (client, contacts, createContact) => {
+// With contactsSuggestEnabled, people are sent by email and the
+// stack finds or creates the contact: an org member's id is not on this instance
+export const getOrCreateFromArray = async (
+  client,
+  contacts,
+  createContact,
+  contactsSuggestEnabled
+) => {
+  if (contactsSuggestEnabled) {
+    return contacts.map(contact => {
+      if (contact._type === DOCTYPE_GROUPS) return contact
+      const email = ContactModel.getPrimaryEmail(contact)
+      if (validateEmail(email)) return { _type: DOCTYPE_CONTACTS, email }
+      return contact._id ? contact : undefined
+    })
+  }
+
   return await Promise.all(
     contacts.map(async contact => {
       if (contact.id) {
@@ -45,6 +62,19 @@ export const getOrCreateFromArray = async (client, contacts, createContact) => {
   )
 }
 
+// A suggestion without id has no contact document, and only a fullname,
+// which getDisplayName does not read
+export const suggestContacts = async (client, q) => {
+  const { data } = await client
+    .getStackClient()
+    .fetchJSON('GET', `/contacts/suggest?q=${encodeURIComponent(q)}`)
+  return data.map(({ id, type, attributes }) => ({
+    ...attributes,
+    ...(id ? { _id: id, id } : { displayName: attributes.fullname }),
+    _type: type
+  }))
+}
+
 export const getContactsFromGroupId = (contacts = [], groupId) => {
   return contacts.filter(contact => {
     return contact.relationships?.groups?.data?.some(

package/src/helpers/contacts.spec.js

@@ -1,6 +1,10 @@
 import flag from 'cozy-flags'
 
-import { computeContactsAndGroups, getOrCreateFromArray } from './contacts'
+import {
+  computeContactsAndGroups,
+  getOrCreateFromArray,
+  suggestContacts
+} from './contacts'
 
 jest.mock('cozy-flags', () => ({
   __esModule: true,
@@ -128,3 +132,100 @@ describe('computeContactsAndGroups', () => {
     expect(contactsAndGroups.map(c => c._id)).toEqual(['alice', 'bob'])
   })
 })
+
+describe('getOrCreateFromArray with contactsSuggestEnabled', () => {
+  it('should send people by email and keep groups, without creating contacts', async () => {
+    const createContact = jest.fn()
+    const group = { _id: 'group-1', _type: 'io.cozy.contacts.groups' }
+
+    const recipients = await getOrCreateFromArray(
+      mockClient,
+      [
+        {
+          _id: 'org-member-1',
+          _type: 'io.cozy.contacts',
+          email: [{ address: 'member@org.example', primary: true }],
+          meta: { kind: 'member' }
+        },
+        { email: 'unknown@friends.example' },
+        group
+      ],
+      createContact,
+      true
+    )
+
+    expect(recipients).toEqual([
+      { _type: 'io.cozy.contacts', email: 'member@org.example' },
+      { _type: 'io.cozy.contacts', email: 'unknown@friends.example' },
+      group
+    ])
+    expect(createContact).not.toHaveBeenCalled()
+  })
+
+  it('should keep a contact without email by id, and drop a recipient with neither', async () => {
+    const cozyOnlyContact = {
+      _id: 'contact-1',
+      _type: 'io.cozy.contacts',
+      cozy: [{ url: 'https://bob.example' }]
+    }
+
+    const recipients = await getOrCreateFromArray(
+      mockClient,
+      [cozyOnlyContact, { instance: 'https://alice.example' }],
+      jest.fn(),
+      true
+    )
+
+    expect(recipients).toEqual([cozyOnlyContact, undefined])
+  })
+})
+
+describe('suggestContacts', () => {
+  it('should map the suggestions of the stack to contacts', async () => {
+    const fetchJSON = jest.fn().mockResolvedValue({
+      data: [
+        {
+          type: 'io.cozy.contacts',
+          id: 'org-member-1',
+          attributes: {
+            fullname: 'Jean Dupont',
+            name: { givenName: 'Jean', familyName: 'Dupont' },
+            email: [{ address: 'jean@org.example', primary: true }]
+          },
+          meta: { kind: 'member' }
+        },
+        {
+          type: 'io.cozy.contacts',
+          attributes: {
+            fullname: 'Paul Dupuis',
+            email: [{ address: 'paul@friends.example', primary: true }]
+          }
+        }
+      ]
+    })
+    const client = { getStackClient: () => ({ fetchJSON }) }
+
+    const contacts = await suggestContacts(client, 'dup & co')
+
+    expect(fetchJSON).toHaveBeenCalledWith(
+      'GET',
+      '/contacts/suggest?q=dup%20%26%20co'
+    )
+    expect(contacts).toEqual([
+      {
+        _id: 'org-member-1',
+        id: 'org-member-1',
+        _type: 'io.cozy.contacts',
+        fullname: 'Jean Dupont',
+        name: { givenName: 'Jean', familyName: 'Dupont' },
+        email: [{ address: 'jean@org.example', primary: true }]
+      },
+      {
+        _type: 'io.cozy.contacts',
+        fullname: 'Paul Dupuis',
+        displayName: 'Paul Dupuis',
+        email: [{ address: 'paul@friends.example', primary: true }]
+      }
+    ])
+  })
+})

package/src/hooks/useResolveRecipients.js

@@ -2,6 +2,7 @@ import { useCallback } from 'react'
 
 import { useClient } from 'cozy-client'
 
+import { useSharingContext } from './useSharingContext'
 import { getOrCreateFromArray } from '../helpers/contacts'
 import { DOCTYPE_CONTACTS } from '../models'
 
@@ -14,6 +15,7 @@ import { DOCTYPE_CONTACTS } from '../models'
  */
 export const useResolveRecipients = () => {
   const client = useClient()
+  const contactsSuggestEnabled = useSharingContext()?.contactsSuggestEnabled
 
   return useCallback(
     async (
@@ -24,7 +26,8 @@ export const useResolveRecipients = () => {
       const contacts = await getOrCreateFromArray(
         client,
         pendingRecipients,
-        createContact
+        createContact,
+        contactsSuggestEnabled
       )
       const isReadOnly = selectedOption === 'readOnly'
 
@@ -33,6 +36,6 @@ export const useResolveRecipients = () => {
         readOnlyRecipients: isReadOnly ? contacts : []
       }
     },
-    [client]
+    [client, contactsSuggestEnabled]
   )
 }

package/src/hooks/useResolveRecipients.spec.js

@@ -13,6 +13,10 @@ jest.mock('../helpers/contacts', () => ({
   getOrCreateFromArray: jest.fn()
 }))
 
+jest.mock('./useSharingContext', () => ({
+  useSharingContext: () => ({ contactsSuggestEnabled: true })
+}))
+
 const contacts = [{ _id: 'alice' }, { _id: 'bob' }]
 
 describe('useResolveRecipients', () => {
@@ -48,7 +52,8 @@ describe('useResolveRecipients', () => {
     expect(getOrCreateFromArray).toHaveBeenCalledWith(
       mockClient,
       pendingRecipients,
-      expect.any(Function)
+      expect.any(Function),
+      true
     )
     expect(mockClient.create).toHaveBeenCalledWith('io.cozy.contacts', {
       email: [{ address: 'alice@cozy.cc' }]
@@ -64,7 +69,8 @@ describe('useResolveRecipients', () => {
     expect(getOrCreateFromArray).toHaveBeenCalledWith(
       mockClient,
       [],
-      createContact
+      createContact,
+      true
     )
   })
 })

package/src/queries/queries.js

@@ -16,7 +16,7 @@ export const buildSharingsByIdQuery = sharingId => ({
   }
 })
 
-export const buildReachableContactsQuery = () => ({
+export const buildReachableContactsQuery = ({ inGroups } = {}) => ({
   definition: Q(DOCTYPE_CONTACTS)
     .where({
       _id: {
@@ -42,12 +42,15 @@ export const buildReachableContactsQuery = () => ({
             }
           }
         }
-      ]
+      ],
+      ...(inGroups && { 'relationships.groups.data': { $exists: true } })
     })
     .indexFields(['_id'])
     .limitBy(1000),
   options: {
-    as: 'io.cozy.contacts/reachable'
+    as: inGroups
+      ? 'io.cozy.contacts/reachable-with-groups'
+      : 'io.cozy.contacts/reachable'
   }
 })