Skip to content

Conversation

@g-saracca
Copy link
Contributor

@g-saracca g-saracca commented May 2, 2025

What this PR does / why we need it:

Integrate the js-dataverse GetApplicationTermsOfUse use case.
After a successful OIDC login from the SPA, an account linking / complete information screen is displayed. At that point, we need to display the Installation Terms Of Use.

Image

Which issue(s) this PR closes:

Special notes for your reviewer:

⚠️ The js-dataverse package is using a PR version, after IQSS/dataverse-client-javascript#296 is merged we need to update package version to use alpha.

Suggestions on how to test this:

Step 1: Run the Development Environment

  1. Execute npm i.
  2. Navigate with cd packages/design-system && npm i && npm run build.
  3. Return with cd ../../.
  4. Ensure you have a .env file similar to .env.example
  5. Navigate with cd dev-env.
  6. Before running next step, be sure have a fresh unstable dataverse image.
  7. Start the environment using ./run-env.sh unstable.
  8. To verify the environment, visit http://localhost:8000/ and check your local Dataverse installation.

Step 2: Test the feature

  1. Got to the SPA and click the Log In button.
  2. Sign in with a user from the keycloak instance
    email: [email protected]
    pass: user
  3. You should be redirected to the Account - Sign Up page. Under General Terms of Use you should see the default message when installation terms of use are not set which is "There are no Terms of Use for this Dataverse Installation". Don't close this page.
  4. Now lets update the applications terms:
  • Create a tou.html file in your desktop with something like: <p>Be nice to each other</p>
  • now run curl -X PUT http://localhost:8000/api/admin/settings/:ApplicationTermsOfUse --upload-file ~/Desktop/tou.html and you should receive a response like: {"status":"OK","data":{":ApplicationTermsOfUse":"<p>Be nice to each other</p>\n"}}
  1. Now reload the Account - Sign Up page and you should see the new General Terms of Use displayed.

@github-actions github-actions bot added FY25 Sprint 22 FY25 Sprint 22 (2025-04-23 - 2025-05-07) GREI Re-arch GREI re-architecture-related SPA.Q2.7 Implement installation terms of use in account linking labels May 2, 2025
@g-saracca g-saracca added Size: 3 A percentage of a sprint. 2.1 hours. Original size: 3 labels May 2, 2025
@g-saracca g-saracca moved this to Ready for Review ⏩ in IQSS Dataverse Project May 2, 2025
@coveralls
Copy link

coveralls commented May 2, 2025

Coverage Status

coverage: 97.525% (+0.2%) from 97.303%
when pulling 8c7c9a1 on feat/674-integrate-get-application-terms-of-use-in-account-linking
into 0dc79ca on develop.

@ChengShi-1 ChengShi-1 self-assigned this May 5, 2025
@ChengShi-1 ChengShi-1 moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project May 5, 2025
@ChengShi-1 ChengShi-1 self-requested a review May 5, 2025 20:34
@g-saracca
Copy link
Contributor Author

@ChengShi-1 changes applied 👍🏼

Copy link
Contributor

@ChengShi-1 ChengShi-1 left a comment

Choose a reason for hiding this comment

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

Good!

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project May 6, 2025
@ChengShi-1 ChengShi-1 removed their assignment May 6, 2025
@g-saracca
Copy link
Contributor Author

@ChengShi-1 please approve UI Reviews and UI test 🙏🏼

@ofahimIQSS
Copy link
Contributor

looks good, merging

@ofahimIQSS ofahimIQSS merged commit 3a622af into develop May 6, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project May 6, 2025
@ofahimIQSS ofahimIQSS deleted the feat/674-integrate-get-application-terms-of-use-in-account-linking branch May 6, 2025 20:56
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY25 Sprint 22 FY25 Sprint 22 (2025-04-23 - 2025-05-07) GREI Re-arch GREI re-architecture-related Original size: 3 Size: 3 A percentage of a sprint. 2.1 hours. SPA.Q2.7 Implement installation terms of use in account linking

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Show Application Terms of Use in Account - Sign Up page.

5 participants