feat: update sendfeedback api and add testcase

Author: ChengShi-1

docs/useCases.md

@@ -1370,7 +1370,7 @@ _See [use case](../src/info/domain/useCases/GetZipDownloadLimit.ts) implementati
 
 #### Send Feedback to Object Contacts
 
-Returns a [Contact](../src/contactInfo/domain/models/Contact.ts) object, which contains contact return information, showing toEmail, fromEmail, subject, body.
+Returns a [Contact](../src/contactInfo/domain/models/Contact.ts) object, which contains contact return information, showing fromEmail, subject, body.
 
 ##### Example call:
 
@@ -1379,9 +1379,25 @@ import { submitContactInfo } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 
-submitContactInfo.execute((contact: ContactDTO)).then( => {
-/* ... */
-})
+const contactDTO: ContactDTO = {
+  targedId: 1
+  subject: 'Data Question',
+  body: 'Please help me understand your data. Thank you!',
+  fromEmail: '[email protected]'
+}
+
+submitContactInfo.execute(contactDTO)
 
 /* ... */
 ```
+
+_See [use case](../src/info/domain/useCases/submitContactInfo.ts) implementation_.
+
+The above example would submit feedback to all contacts of a object where the object targetId = 1.
+
+In ContactDTO, it takes the following information:
+
+- **targetId**: the numeric identifier of the collection, dataset, or datafile. Persistent ids and collection aliases are not supported. (Optional)
+- **subject**: the email subject line
+- **body**: the email body to send
+- **fromEmail**: the email to list in the reply-to field.

src/contactInfo/domain/dtos/ContactDTO.ts

@@ -1,5 +1,5 @@
 export interface ContactDTO {
-  targetId: number
+  targetId?: number
   subject: string
   body: string
   fromEmail: string

src/contactInfo/domain/models/Contact.ts

@@ -1,6 +1,5 @@
 export interface Contact {
   fromEmail: string
-  toEmail: string
   body: string
   subject: string
 }

src/contactInfo/infra/repositories/ContactRepository.ts

@@ -5,12 +5,11 @@ import { ContactDTO } from '../../domain/dtos/ContactDTO'
 
 export class ContactRepository extends ApiRepository implements IContactRepository {
   public async submitContactInfo(contactDTO: ContactDTO): Promise<Contact[]> {
-    return this.doPost(`/admin/feedback`, contactDTO)
+    return this.doPost(`/sendfeedback`, contactDTO)
       .then((response) => {
         const responseData = response.data
         const contact: Contact[] = responseData.data.map((item: Contact) => ({
           fromEmail: item.fromEmail,
-          toEmail: item.toEmail,
           subject: item.subject,
           body: item.body
         }))

test/functional/contact/SubmitContactInfo.test.ts

@@ -1,4 +1,4 @@
-import { ApiConfig, submitContactInfo, ContactDTO, WriteError } from '../../../src'
+import { ApiConfig, submitContactInfo, ContactDTO, WriteError, Contact } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 
@@ -11,25 +11,44 @@ describe('submitContactInfo', () => {
     )
   })
 
-  test('should return success result on repository success', async () => {
+  test('should return Contact result successfully', async () => {
     const contactDTO: ContactDTO = {
       targetId: 1,
       subject: 'Data Question',
       body: 'Please help me understand your data. Thank you!',
-      fromEmail: '1314@gmail.com'
+      fromEmail: 'example@gmail.com'
     }
 
-    let contactInfo
+    let contactInfo: Contact[] = []
     try {
       contactInfo = await submitContactInfo.execute(contactDTO)
     } catch (error) {
       throw new Error('Contact info should be submitted')
     } finally {
       expect(contactInfo).toBeDefined()
-      expect(contactInfo[0].fromEmail).toEqual('[email protected]')
+      expect(contactInfo[0].fromEmail).toEqual('[email protected]')
+      expect(contactInfo[0].subject).toEqual(expect.any(String))
+      expect(contactInfo[0].body).toEqual(expect.any(String))
+    }
+  })
+
+  test('should return a Contact when targetId is not provided', async () => {
+    const contactDTO: ContactDTO = {
+      subject: 'General Inquiry',
+      body: 'I have a general question.',
+      fromEmail: '[email protected]'
+    }
+
+    let contactInfo: Contact[] = []
+    try {
+      contactInfo = await submitContactInfo.execute(contactDTO)
+    } catch (error) {
+      throw new Error('Contact info should be submitted even if target id is missing')
+    } finally {
+      expect(contactInfo).toBeDefined()
+      expect(contactInfo[0].fromEmail).toEqual('[email protected]')
       expect(contactInfo[0].subject).toEqual(expect.any(String))
       expect(contactInfo[0].body).toEqual(expect.any(String))
-      expect(contactInfo[0].toEmail).toEqual(expect.any(String))
     }
   })
 
@@ -38,7 +57,7 @@ describe('submitContactInfo', () => {
       targetId: 0,
       subject: '',
       body: '',
-      fromEmail: '1314@gmail.com'
+      fromEmail: 'example@gmail.com'
     }
     const expectedError = new WriteError(`[400] Feedback target object not found`)
     await expect(submitContactInfo.execute(contactDTO)).rejects.toThrow(expectedError)

test/integration/contact/ContactRepository.test.ts

@@ -1,5 +1,5 @@
 import { ContactRepository } from '../../../src/contactInfo/infra/repositories/ContactRepository'
-import { ApiConfig, ContactDTO, WriteError } from '../../../src'
+import { ApiConfig, Contact, ContactDTO, WriteError } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
 
@@ -16,7 +16,7 @@ describe('submitContactInfo', () => {
     targetId: 1,
     subject: 'Data Question',
     body: 'Please help me understand your data. Thank you!',
-    fromEmail: '1314@gmail.com'
+    fromEmail: 'example@gmail.com'
   }
 
   const sut: ContactRepository = new ContactRepository()
@@ -28,7 +28,23 @@ describe('submitContactInfo', () => {
     expect(contactInfo[0].fromEmail).toEqual(testContactDTO.fromEmail)
     expect(contactInfo[0].subject).toEqual(expect.any(String))
     expect(contactInfo[0].body).toEqual(expect.any(String))
-    expect(contactInfo[0].toEmail).toEqual(expect.any(String))
+  })
+
+  test('should return a Contact when targetId is not provided', async () => {
+    const contactDTOWithoutTargetId: Partial<ContactDTO> = {
+      subject: 'General Inquiry',
+      body: 'I have a general question.',
+      fromEmail: '[email protected]'
+    }
+
+    const contactInfo: Contact[] = await sut.submitContactInfo(
+      contactDTOWithoutTargetId as ContactDTO
+    )
+
+    expect(contactInfo).toBeDefined()
+    expect(contactInfo[0].fromEmail).toEqual(contactDTOWithoutTargetId.fromEmail)
+    expect(contactInfo[0].subject).toEqual(expect.any(String))
+    expect(contactInfo[0].body).toEqual(expect.any(String))
   })
 
   test('should return error if the target id is unexisted', async () => {

test/unit/contact/SubmitContactInfo.test.ts

@@ -1,10 +1,11 @@
 import { WriteError, Contact, ContactDTO } from '../../../src'
 import { SubmitContactInfo } from '../../../src/contactInfo/domain/useCases/SubmitContactInfo'
 import { IContactRepository } from '../../../src/contactInfo/domain/repositories/IContactRepository'
+import { TestConstants } from '../../testHelpers/TestConstants'
 
 describe('execute submit information to contacts', () => {
   test('should return a Contact when repository call is successful', async () => {
-    const fromEmail = '1314@gmail.com'
+    const fromEmail = 'example@gmail.com'
 
     const contactDTO: ContactDTO = {
       targetId: 6,
@@ -14,8 +15,7 @@ describe('execute submit information to contacts', () => {
     }
 
     const collectionAlias = 'collection-1'
-    const collectionEmail = '[email protected],[email protected]'
-    const baseUrl = 'http://localhost:8080/dataverse/'
+    const baseUrl = TestConstants.TEST_API_URL + '/dataverse/'
     const bodyMessage =
       'You have just been sent the following message from ' +
       fromEmail +
@@ -42,7 +42,6 @@ describe('execute submit information to contacts', () => {
     const expectedResponse: Contact[] = [
       {
         fromEmail: contactDTO.fromEmail,
-        toEmail: collectionEmail,
         subject: 'Root contact: ' + contactDTO.subject,
         body: bodyMessage
       }
@@ -57,7 +56,37 @@ describe('execute submit information to contacts', () => {
     expect(contactRepositoryStub.submitContactInfo).toHaveBeenCalledWith(contactDTO)
   })
 
-  test('should return error result on error response', async () => {
+  test('should return a Contact when targetId is not provided', async () => {
+    const fromEmail = '[email protected]'
+
+    const contactDTO: ContactDTO = {
+      subject: 'Data Question',
+      body: 'Please help me understand your data. Thank you!',
+      fromEmail: fromEmail
+    }
+
+    const bodyMessage =
+      'Root Support,\n\nThe following message was sent from  ' +
+      fromEmail +
+      '.\n\n---\n\nPlease help me understand your data. Thank you!\n\n---\n\nMessage sent from Support contact form.'
+    const expectedResponse: Contact[] = [
+      {
+        fromEmail: contactDTO.fromEmail,
+        subject: 'Root Support Request: ' + contactDTO.subject,
+        body: bodyMessage
+      }
+    ]
+
+    const contactRepositoryStub = <IContactRepository>{}
+
+    contactRepositoryStub.submitContactInfo = jest.fn().mockResolvedValue(expectedResponse)
+    const sut = new SubmitContactInfo(contactRepositoryStub)
+    const actual = await sut.execute(contactDTO)
+    expect(actual).toEqual(expectedResponse)
+    expect(contactRepositoryStub.submitContactInfo).toHaveBeenCalledWith(contactDTO)
+  })
+
+  test('should return error result once there is a invalid targetId', async () => {
     const contactDTO: ContactDTO = {
       targetId: 0,
       subject: '',