Manage guestbook page integration by ChengShi-1 · Pull Request #992 · IQSS/dataverse-frontend

ChengShi-1 · 2026-05-12T18:53:26Z

What this PR does / why we need it:

manage dataset guestbook table, with name, created date, usage, responses and action columns
create guestbook
include guestbooks from parent collection
edit actions: disable/enable, preview, copy, edit(not included), download, view responses(not included), delete(not included)

Which issue(s) this PR closes:

Closes Feature Request: Manage Guestbook integration #991

Special notes for your reviewer:

use js-dataverse IQSS/dataverse-client-javascript#449

Suggestions on how to test this:

In collection page Edit => Dataset Guestbook, then you arrive the Manage Guestbook Page,
If there is no guestbook, it should show text to guide users and a Create Guestbook button.
If there is one or more guestbook, it should show a table with info just like JSF.

all information in the table are shown, including guestbook name, created, usage, responses
create button works
Download All Responses button works
action buttons: enable/disable, view, download should work, (other action buttons are not implemented yet)
create a sub collection, toggle the checkbox "include guestbooks from parent collection", which should show or not show a list of guestbooks from parent collections
If the guestbook is disable, this guestbook cannot be chosen in Dataset -> Edit terms and guestbook -> guestbook tab (a list of available guestbooks will hide the disabled guestbook)
Create Dataset Guestbook should successfully submit and create with what you filled

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Create Dataset Guestbook

Is there a release notes or changelog update needed for this change?:

Yes

Additional documentation:

coveralls · 2026-05-12T19:30:02Z

coverage: 97.287% (-0.1%) from 97.389% — ManageGuestbook into develop

ekraffmiller

I've suggested some name changes to match the Guestbook js-dataverse use cases, will review again after checkbox logic is updated :)

ekraffmiller · 2026-06-10T18:32:09Z

          "position": "Cargo"
        }
+      },
+      "customQuestions": {


It looks like the Spanish translation is missing some keys that are in the English translation

ekraffmiller · 2026-06-10T18:36:13Z

+    guestbookId: number,
+    enabled: boolean
+  ) => Promise<void>
+  downloadGuestbookResponsesByDataverseId: (dataverseId: number | string) => Promise<string>


Update to use collectionId

Suggested change

downloadGuestbookResponsesByDataverseId: (dataverseId: number | string) => Promise<string>

downloadGuestbookResponsesByCollectionId: (collectionId: number | string) => Promise<string>

ekraffmiller · 2026-06-10T18:37:32Z

+  ) => Promise<void>
+  downloadGuestbookResponsesByDataverseId: (dataverseId: number | string) => Promise<string>
+  downloadGuestbookResponsesOfAGuestbook: (
+    dataverseId: number | string,


Suggested change

dataverseId: number | string,

collectionId: number | string,

ekraffmiller · 2026-06-10T18:38:30Z

+
+export function downloadGuestbookResponsesByDataverseId(
+  guestbookRepository: GuestbookRepository,
+  dataverseId: number | string


Suggested change

dataverseId: number | string

collectionId: number | string

ekraffmiller · 2026-06-10T18:39:13Z

+
+export function downloadGuestbookResponsesOfAGuestbook(
+  guestbookRepository: GuestbookRepository,
+  dataverseId: number | string,


Suggested change

dataverseId: number | string,

collectionId: number | string,

ekraffmiller · 2026-06-10T18:42:08Z

+  downloadGuestbookResponsesByDataverseId(dataverseId: number | string): Promise<string> {
+    return downloadGuestbookResponsesByDataverseId.execute(dataverseId)
+  }
+
+  downloadGuestbookResponsesOfAGuestbook(
+    dataverseId: number | string,
+    guestbookId: number
+  ): Promise<string> {
+    return downloadGuestbookResponsesOfAGuestbook.execute(dataverseId, guestbookId)


Suggested change

downloadGuestbookResponsesByDataverseId(dataverseId: number | string): Promise<string> {

return downloadGuestbookResponsesByDataverseId.execute(dataverseId)

}

downloadGuestbookResponsesOfAGuestbook(

dataverseId: number | string,

guestbookId: number

): Promise<string> {

return downloadGuestbookResponsesOfAGuestbook.execute(dataverseId, guestbookId)

downloadGuestbookResponsesByCollectionId(collectionId: number | string): Promise<string> {

return downloadGuestbookResponsesByCollectionId.execute(collectionId)

}

downloadGuestbookResponsesOfAGuestbook(

collectionId: number | string,

guestbookId: number

): Promise<string> {

return downloadGuestbookResponsesOfAGuestbook.execute(collectionId, guestbookId)

ekraffmiller · 2026-06-10T18:47:10Z

        answers.push({
          id: resolveAnswerId(fieldName, question, guestbook),
-          value
+          value: question.type === 'textarea' ? value.split(/\r?\n/) : value


When the API is updated to take either a string or an array, we won't have to do this extra logic of converting the string to an array, but good to keep for now.

ekraffmiller · 2026-06-10T18:51:48Z

+    }
+  ])
+  const guestbooksGuideUrl =
+    'https://guides.dataverse.org/en/6.9/user/dataverse-management.html#dataset-guestbooks'


Suggested change

'https://guides.dataverse.org/en/6.9/user/dataverse-management.html#dataset-guestbooks'

'https://guides.dataverse.org/en/latest/user/dataverse-management.html#dataset-guestbooks'

ekraffmiller · 2026-06-10T19:12:54Z

+
+  const generalInfoUrl = `/spa${RouteWithParams.EDIT_COLLECTION(collectionId)}`
+  const guestbooksGuideUrl =
+    'https://guides.dataverse.org/en/6.9/user/dataverse-management.html#dataset-guestbooks'


Suggested change

'https://guides.dataverse.org/en/6.9/user/dataverse-management.html#dataset-guestbooks'

'https://guides.dataverse.org/en/latest/user/dataverse-management.html#dataset-guestbooks'

ekraffmiller · 2026-06-10T19:15:25Z

+    })
+  const rootCollectionNames = collection?.hierarchy?.toArray().map((node) => node.name) ?? []
+
+  const currentDataverseId = Number(collection?.id) || 1


Suggested change

const currentDataverseId = Number(collection?.id) || 1

const currentCollectionId = Number(collection?.id) || 1

…ases

ChengShi-1 · 2026-06-11T15:30:56Z

Hi @ekraffmiller 👋 Thanks for your review! I’ve just made some changes based on the feedback.

While working on the changes for this PR, I noticed that we were also missing an API for deleting a guestbook. I've created an issue in Dataverse for this IQSS/dataverse#12453.

Also, in another issue IQSS/dataverse#12451, I added a comment about an additional requirement: including inherited guestbooks in the GetDataset API response. (Maybe it's better to create another issue for this? )

ekraffmiller · 2026-06-12T14:05:48Z

Hi @ekraffmiller 👋 Thanks for your review! I’ve just made some changes based on the feedback.

While working on the changes for this PR, I noticed that we were also missing an API for deleting a guestbook. I've created an issue in Dataverse for this IQSS/dataverse#12453.

Also, in another issue IQSS/dataverse#12451, I added a comment about an additional requirement: including inherited guestbooks in the GetDataset API response. (Maybe it's better to create another issue for this? )

Hi @ChengShi-1, thanks for adding the issue for delete API, good catch. For the other issue, I don't think we need an API change. In the Edit Guestbook section on the Dataset Page, The list of Guestbooks comes from getGuestbooksByCollectionId, not from GetDataset. So since IQSS/dataverse#12451 adds a parameter to get inherited guestbooks, we can use that, unless I'm missing something?

ChengShi-1 · 2026-06-12T15:14:08Z

Hi @ekraffmiller 👋 Thanks for your review! I’ve just made some changes based on the feedback.
While working on the changes for this PR, I noticed that we were also missing an API for deleting a guestbook. I've created an issue in Dataverse for this IQSS/dataverse#12453.
Also, in another issue IQSS/dataverse#12451, I added a comment about an additional requirement: including inherited guestbooks in the GetDataset API response. (Maybe it's better to create another issue for this? )

Hi @ChengShi-1, thanks for adding the issue for delete API, good catch. For the other issue, I don't think we need an API change. In the Edit Guestbook section on the Dataset Page, The list of Guestbooks comes from getGuestbooksByCollectionId, not from GetDataset. So since IQSS/dataverse#12451 adds a parameter to get inherited guestbooks, we can use that, unless I'm missing something?
Hi @ekraffmiller ,
That API I mean is slightly different: on the Dataset Edit Guestbook page, we need to know whether the dataset’s parent collection has “Include Guestbooks from Parent Collections” enabled(the status of the checkbox shown in the screenshotbelow), so we know what value to pass as includeInherited when calling getGuestbooksByCollectionId.

Right now the frontend can only infer that with something like Boolean(dataset?.parentCollectionNode?.parent), in EditGuestbook.tsx which only tells us that a parent collection exists. It does not tell us whether inherited guestbooks are actually enabled for this dataset’s collection.
So I don’t think we need GetDataset to return the inherited guestbooks themselves, but we do need some API field exposing that setting. For example, it could also be something lie includeInheritedGuestbooks: boolean on the collection metadata, or on dataset.parentCollectionNode in GetDataset.

ekraffmiller · 2026-06-12T15:43:51Z

Right now the frontend can only infer that with something like Boolean(dataset?.parentCollectionNode?.parent), in EditGuestbook.tsx which only tells us that a parent collection exists. It does not tell us whether inherited guestbooks are actually enabled for this dataset’s collection. So I don’t think we need GetDataset to return the inherited guestbooks themselves, but we do need some API field exposing that setting. For example, it could also be something lie includeInheritedGuestbooks: boolean on the collection metadata, or on dataset.parentCollectionNode in GetDataset.

Ok, I see what you mean! So yes, we need to save that in the Collection object. In the Dataverse backend, the field is "guestbookRoot". So we need an API specifically for getting/setting this value, or update the Collection object to include this field, and use the get/update collection use cases to manage it. I think it's worth adding a new issue to address this. Thanks for catching this!

ChengShi-1 · 2026-06-12T16:50:02Z

Right now the frontend can only infer that with something like Boolean(dataset?.parentCollectionNode?.parent), in EditGuestbook.tsx which only tells us that a parent collection exists. It does not tell us whether inherited guestbooks are actually enabled for this dataset’s collection. So I don’t think we need GetDataset to return the inherited guestbooks themselves, but we do need some API field exposing that setting. For example, it could also be something lie includeInheritedGuestbooks: boolean on the collection metadata, or on dataset.parentCollectionNode in GetDataset.

Ok, I see what you mean! So yes, we need to save that in the Collection object. In the Dataverse backend, the field is "guestbookRoot". So we need an API specifically for getting/setting this value, or update the Collection object to include this field, and use the get/update collection use cases to manage it. I think it's worth adding a new issue to address this. Thanks for catching this!

Thanks, it's really helpful! I just created an issue to track this: IQSS/dataverse#12459

ChengShi-1 added 4 commits February 27, 2026 14:47

feat: Manage and Create Guestbook

42bae2e

feat: collection page

ca3da34

Merge Conflicts

0b92757

feat: create guestbook integration

9121485

github-actions Bot added FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) GREI Re-arch GREI re-architecture-related SPA labels May 12, 2026

ChengShi-1 added 2 commits May 19, 2026 11:23

action buttons of guestbook table

94b9ed2

feat: get usage and responses count and changelog update

fa08491

ChengShi-1 added the Size: 10 A percentage of a sprint. 7 hours. label May 19, 2026

ChengShi-1 added this to IQSS Dataverse Project May 19, 2026

ChengShi-1 marked this pull request as ready for review May 19, 2026 17:09

ChengShi-1 moved this to Ready for Review ⏩ in IQSS Dataverse Project May 19, 2026

cmbz added the FY26 Sprint 24 FY26 Sprint 24 (2026-05-20 - 2026-06-03) label May 21, 2026

ChengShi-1 mentioned this pull request Jun 1, 2026

Manage Dataset Templates Integration #908

Merged

cmbz added the FY26 Sprint 25 FY26 Sprint 25 (2026-06-03 - 2026-06-17) label Jun 3, 2026

ChengShi-1 added 3 commits June 8, 2026 19:35

Merge branch 'develop' into ManageGuestbook

56d3dd9

fix

92c0d16

improve test coverage

aee49b2

ekraffmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Jun 9, 2026

ekraffmiller self-assigned this Jun 9, 2026

ekraffmiller reviewed Jun 10, 2026

View reviewed changes

ekraffmiller assigned ChengShi-1 and unassigned ekraffmiller Jun 10, 2026

ChengShi-1 added 2 commits June 11, 2026 05:06

feat: add logic about inherited parent guestboos, and fix some edge c…

a9971bb

…ases

fix: manage guestbook page

c324f70

ChengShi-1 assigned ekraffmiller Jun 11, 2026

ChengShi-1 mentioned this pull request Jun 12, 2026

Edit Guestbook and Guestbook Responses Integration #1002

Open

2 tasks

ChengShi-1 mentioned this pull request Jun 12, 2026

Expose Collection guestbookRoot setting through API IQSS/dataverse#12459

Open

	downloadGuestbookResponsesByDataverseId: (dataverseId: number \| string) => Promise<string>
	downloadGuestbookResponsesByCollectionId: (collectionId: number \| string) => Promise<string>

	'https://guides.dataverse.org/en/6.9/user/dataverse-management.html#dataset-guestbooks'
	'https://guides.dataverse.org/en/latest/user/dataverse-management.html#dataset-guestbooks'

	const currentDataverseId = Number(collection?.id) \|\| 1
	const currentCollectionId = Number(collection?.id) \|\| 1

Conversation

ChengShi-1 commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes or changelog update needed for this change?:

Additional documentation:

Uh oh!

coveralls commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ekraffmiller left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChengShi-1 commented Jun 11, 2026

Uh oh!

ekraffmiller commented Jun 12, 2026

Uh oh!

ChengShi-1 commented Jun 12, 2026

Uh oh!

ekraffmiller commented Jun 12, 2026

Uh oh!

ChengShi-1 commented Jun 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ChengShi-1 commented May 12, 2026 •

edited

Loading

coveralls commented May 12, 2026 •

edited

Loading