IQSS / IQSS/dataverse

Dataset page is not refreshed (and therefore not locked) when a PrePublish Workflow is activated (version 5.14)

Open
#10,163 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Bug
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

What steps does it take to reproduce the issue?

  • add workflow: curl -XPOST --header "Content-Type:application/json" --header "X-Dataverse-key:<API-key>" --data "@workflow.json" http://localhost:8080/api/admin/workflows with attached workflow.json

  • set workflow as default for PrePublish: curl -XPUT http://localhost:8080/api/admin/workflows/default/PrePublishDataset --data "<workflow-id>"

  • create dataset

  • publish dataset

When does this issue occur?
When a dataset is published with a PrePublish workflow enabled, the page does not refresh. The behaviour is independent of the workflow configuration and shows up even when the workflow does only contains log steps and no pause or http request.

Which page(s) does it occurs on?
Dataset page

What happens?
After clicking the publish button (and the continue button) the page is not refreshed and therefore neither locked (during a longer workflow with http requests to external services or pause steps) nor updated when the dataset is finally published. In the background, the workflow runs as expected and the dataset is published after the successful workflow run. This is just not visible to the user, unless she manually refreshes the page. The page looks therefore exactly the same as before publishing.

To whom does it occur (all users, curators, superusers)?
Tested with superuser accounts

What did you expect to happen?
I would expect a lock of the dataset during the workflow and a success message after finalizing the workflow and the publication of the dataset with the change of the tag from "Draft" to "Version 1.0".

Which version of Dataverse are you using?
Version 5.14. The refreshing of the page worked well with version 5.12.1.

Any related open or closed issues to this bug report?
#7716

Screenshots:

Before clicking on publish:
BeforePublish

Directly after publishing:
AfterPublish

After manual refresh (with a workflow with http step, not the one configured by workflow.json):
AfterManualRefresh
Dataset is locked as expected

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue from the dataset page by configuring a PrePublish workflow with the documented curl commands, then create and publish a dataset. Compare the page state during the workflow and after publication with a manual refresh; done means the page refreshes, shows the dataset lock while needed, and changes the tag from Draft to Version 1.0 after successful publication.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
full-stack
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.