Skip to content

Comments

Add API to get tool launch url for SPA#11760

Merged
ofahimIQSS merged 32 commits intoIQSS:developfrom
GlobalDataverseCommunityConsortium:SPA-_api_to_getToolLaunchUrl
Sep 10, 2025
Merged

Add API to get tool launch url for SPA#11760
ofahimIQSS merged 32 commits intoIQSS:developfrom
GlobalDataverseCommunityConsortium:SPA-_api_to_getToolLaunchUrl

Conversation

@qqmyers
Copy link
Member

@qqmyers qqmyers commented Aug 21, 2025

What this PR does / why we need it: Per discussion with @g-saracca , the back-end was missing an api call to generate the initial (possibly signed) URL for launching an external tool. This PR adds api calls for dataset and file level tools, mirroring what is done in the DatasetPage and FilePage (with more checks for valid dvobject, user, permissions, etc. since those haven't been checked in the page init.)

Which issue(s) this PR closes:

  • Closes #

Special notes for your reviewer: The API calls use POST since, in the case of non-public datasets/files, the code generates URLs that include a callback token containing a signed Url which could be accessed via Cross Site Scripting if GET was used.

FWIW: The /admin/test API test started failing despite there being no changes to it. I eventually discovered that the problem was the api never handled api tokens correctly but this didn't matter until the new test added tools that required authentication. I updated the calls to use our standard authentication mechanism.

Suggestions on how to test this: Can call the APIs directly, but this is basically what's done in the IT tests.

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

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

Additional documentation: api docs included.

HTML preview:

@qqmyers qqmyers moved this to Ready for Triage in IQSS Dataverse Project Aug 21, 2025
@qqmyers qqmyers added the Size: 3 A percentage of a sprint. 2.1 hours. label Aug 21, 2025
@ofahimIQSS ofahimIQSS requested a review from pdurbin August 26, 2025 15:10
@ofahimIQSS ofahimIQSS moved this from Ready for Triage to Ready for Review ⏩ in IQSS Dataverse Project Aug 26, 2025
@pdurbin pdurbin self-assigned this Aug 26, 2025
@pdurbin pdurbin moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Aug 26, 2025
@qqmyers qqmyers added this to the 6.8 milestone Aug 27, 2025
@cmbz cmbz added the FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) label Aug 28, 2025
@g-saracca g-saracca added the SPA These changes are required for the Dataverse SPA label Aug 28, 2025
@coveralls
Copy link

coveralls commented Sep 3, 2025

Coverage Status

coverage: 23.522% (+0.07%) from 23.456%
when pulling 2b9bab9 on GlobalDataverseCommunityConsortium:SPA-_api_to_getToolLaunchUrl
into 2e65650 on IQSS:develop.

@qqmyers qqmyers removed their assignment Sep 8, 2025
}

}

Copy link
Member

@pdurbin pdurbin Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I mentioned in standup, tests haven't passed since Sep 3.

I just clicked "build now" to kick off https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-11760/20/

However, we're concerned there's some problem downloading Solr. @ofahimIQSS said he'll be creating an issue. Update, here it is (thanks!):

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't re-test at all but I see "meetsRequirements" in there now, which is great.

I'm going to go ahead and approve this so that manual QA can begin but @ofahimIQSS before merging, please make sure that API tests are passing. This might require that we first fix the problems in the issue you opened:

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Sep 8, 2025
@pdurbin pdurbin removed their assignment Sep 8, 2025
@ofahimIQSS ofahimIQSS self-assigned this Sep 8, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Sep 8, 2025
@ofahimIQSS
Copy link
Contributor

looks good, tests are passing and nothing found during regression.

@ofahimIQSS ofahimIQSS merged commit b01ffe4 into IQSS:develop Sep 10, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Sep 10, 2025
@ofahimIQSS ofahimIQSS removed their assignment Sep 10, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q3.2025.10 External Tools SPA SPA These changes are required for the Dataverse SPA

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

6 participants