Skip to content

Conversation

@pdurbin
Copy link
Member

@pdurbin pdurbin commented Mar 5, 2025

See also discussion in Slack. We decided to leave the SQL script alone. It was added separately in #11304. The field it adds will be needed soon enough when a new PR comes in for the "display on create" feature.

Preview the guide changes here: https://dataverse-guide--11306.org.readthedocs.build/en/11306/api/native-api.html#update-collection-input-levels

@coveralls
Copy link

coveralls commented Mar 5, 2025

Coverage Status

coverage: 22.74% (+0.01%) from 22.727%
when pulling 2441ec8 on revert-11224-10476-display-on-create-field-option
into f5f2c72 on develop.

@github-actions

This comment has been minimized.

@pdurbin pdurbin marked this pull request as ready for review March 5, 2025 14:13
@pdurbin pdurbin added this to the 6.6 milestone Mar 5, 2025
@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project Mar 5, 2025
@sekmiller sekmiller self-assigned this Mar 5, 2025
@sekmiller sekmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Mar 5, 2025
- ``required``: Whether the field is required (boolean)
- ``include``: Whether the field is included (boolean)
- ``displayOnCreate`` (optional): Whether the field is displayed during dataset creation, even when not required (boolean)

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to delete all of the params here or just "displayOnCreate"?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, good point! @Saixel what do you think? Do you want to push any changes to this branch/PR? Or I can if you tell me about any changes you want.

I simply clicked the "revert" button and let GitHub do its thing. 😄

Copy link
Contributor

Choose a reason for hiding this comment

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

This is the only thing I noticed. I assumed that Phil just pressed the button. Otherwise I'm ready to approve.

Copy link
Member Author

@pdurbin pdurbin Mar 5, 2025

Choose a reason for hiding this comment

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

@sekmiller and I talked about it and agree that we should simply restore that "parameters" section minus the "display on create" parameter we're reverting. Done in 2441ec8.

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

@pdurbin @sekmiller I added this section to list the parameters, but the only one I added new was displayOnCreate so we can keep the others.

Copy link
Member Author

Choose a reason for hiding this comment

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

Perfect. Again, done in 2441ec8. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

I think everything is in order to proceed with the revert. But if you prefer we can wait for the approval of someone with more experience @pdurbin

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we're good. Thanks @Saixel

@pdurbin pdurbin requested a review from Saixel March 5, 2025 16:27
@github-actions
Copy link

github-actions bot commented Mar 5, 2025

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:revert-11224-10476-display-on-create-field-option
ghcr.io/gdcc/configbaker:revert-11224-10476-display-on-create-field-option

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

@Saixel Saixel requested a review from sekmiller March 5, 2025 18:04
Copy link
Contributor

@sekmiller sekmiller left a comment

Choose a reason for hiding this comment

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

ok by me

@github-project-automation github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Mar 5, 2025
@ofahimIQSS ofahimIQSS self-assigned this Mar 5, 2025
@ofahimIQSS ofahimIQSS moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Mar 5, 2025
@github-project-automation github-project-automation bot moved this from QA ✅ to Ready for QA ⏩ in IQSS Dataverse Project Mar 5, 2025
@ofahimIQSS
Copy link
Contributor

merging PR

@ofahimIQSS ofahimIQSS merged commit ab8110f into develop Mar 5, 2025
12 checks passed
@github-project-automation github-project-automation bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project Mar 5, 2025
@ofahimIQSS ofahimIQSS deleted the revert-11224-10476-display-on-create-field-option branch March 5, 2025 18:14
@ofahimIQSS ofahimIQSS removed their assignment Mar 5, 2025
@sekmiller sekmiller removed their assignment Mar 5, 2025
@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Mar 6, 2025
stevenwinship added a commit that referenced this pull request Mar 18, 2025
* title case

* fix links

* add cross links

* resolving conflict with the newly-merged flyway script #10909

* resolving a merge conflict with a flyway script that's been merged #10909

* bump sql script #10217

* use Title Case to match other fields #10217

* reword source name help text #10217

* always show source name help text #10217

* duplicate ui:define body

* Revert "10476 display on create field option"

* undo change to sql script

* adding replace file test

* update flyway name

* remove the need to pass the datafile version to the API

* restore "parameters" minus displayOnCreate #11306

* remove flyway merge issue

* update flyway

* fix for unrelated issue found in QA

* flyway change

* rename sql

* rename sql

* typo

* one more

* Merge develop without revert

* Restore displayOnCreate field option changes

* keep renaming the flyway script... #10909

* Add displayOnCreate option for dataset field types

- Added @column annotation for displayOnCreate field in DatasetFieldType
- Updated JsonPrinter to include displayOnCreate in display condition

* Update DataversesIT test to modify metadata block listing parameter

* Update native API documentation for displayOnCreate field option

- Clarify that required fields are always displayed regardless of displayOnCreate setting

* bug fix - only create cite once, not on refresh of cslOutput

* flyway number change

* flyway again

* Implement null support for displayOnCreate field option

- Change displayOnCreate to nullable Boolean in DatasetFieldType
- Update API and service methods to handle null displayOnCreate values
- Modify native API documentation to explain null displayOnCreate behavior
- Add null checks in MetadataBlockServiceBean queries

* fix: make displayOnCreate nullable in DatasetFieldType

- Modified JsonPrinter to handle null values for displayOnCreate
- Updated BriefJsonPrinter to use null-safe comparison

* setDisplayOnCreate astroInstrument back to false #10476

* Handle null displayOnCreate in MetadataBlock and JsonPrinter

- Update MetadataBlock to safely check displayOnCreate with null values
- Modify JsonPrinter to default displayOnCreate to false when null
- Ensure consistent null-safe handling of displayOnCreate across components

* move permission check out of loop

* rename api from /versions/list to /versionDifferences

* Refine displayOnCreate logic in JsonPrinter

* Update displayOnCreate method call in metadataFragment.xhtml

- Change method call from property access to method invocation for displayOnCreate
- Maintain consistent null-safe handling of displayOnCreate field option

* adding todo for future refactoring

* Add getter method for displayOnCreate in DatasetFieldType

- Implement a simple getter method for the displayOnCreate field
- Maintain consistency with existing setter method

* note second callback needed.

* fix create mode bug

* Update doc/release-notes/6.2025.2_update.md

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/release-notes/6.2025.2_update.md

Co-authored-by: Philip Durbin <[email protected]>

* Update doc/release-notes/6.2025.2_update.md

Co-authored-by: Omer Fahim <[email protected]>

* fixing datafile persistentId

* localhost and longer key

* use original cert/key names

* add comment

* test(mail): update test SSL certs for maildev to be RSA 2028 again

It is not necessary to use 4096 bit, as the error was about the wrong common name in the cert.

Detailed explanation:
Before, the cert presented to Jakarta Mail neither contained a commonName=localhost nor subjectAltName=localhost.
This worked before with Payara 6.2024.6 because Eclipse Angus Mail 1.0.0 was still in use (see list of managed dependencies on the 6.2024.6 BOM).
Certificate host identity check was introduced as default=on with Eclipse Angus Mail 1.1.0 (see their release notes).
Now that Payara 6.2025.2 is in use on develop, we upgraded to Eclipse Angus Mail 2.3.0, making the error appear.

* test(mail): update test SSL cert generation docs

Including an openssl.conf makes it much easier and less error prone to generate the certs.
Rewriting the necessary shell command steps in the test comment to document the process.

* test(mail): pin down port in TC waiting strategy

Without the explicit addition of which port to use for the HTTP based waiting strategy, someone may end up at random with the SMTP port being picked.

This will obviously fail and result in aborted tests, making results flaky. Pinning the port down should prevent this for good.

* extend size of deaccessionlink column

* stub out 6.6 release notes #11183

* Payara upgrade #11183

* upgrade Solr #11183

* move collection

* license enhancements

* range search

* datasets without files

* license enhancements

* anon preview url

* ontoportal

* ror

* bug fixes

* boolean

* more bugs

* don't use in any edit mode

* typos

* 3d objects

* delete files, citation

* search api fields for files

* signposting

* collection featured items

* dataset types linked to metadata blocks

* fix heading levels

* Improve metadata block field selection logic for display and required fields

- Modify MetadataBlockServiceBean to include required fields in query selection
- Update JsonPrinter to simplify field display logic for metadata blocks
- Ensure fields are correctly filtered based on display and required status

* harvesting

* locks and permalink

* 3 more

* #10476 add "override" test.

* remind those with text customizations to update properties files

See https://dataverse.zulipchat.com/#narrow/channel/378866-troubleshooting/topic/upgrade.20from.206.2E3.20to.206.2E4/near/504689559

* fix npe from breadcrumbs

* pass param if sent

* Fix input levels update preserving inherited metadata blocks

When updating input levels for a collection, preserve inherited metadata blocks
and existing input levels while allowing collection-specific configurations.

* unrelated - lower log level

* docker updates

* 3 more

* typo

* API updates

* make inputlevel displayOnCreate Boolean

* guides

* 6 more

* archival block, etalab

* PR #9013 was merged for 6.6 not 6.5

* fix header level for harvesting non-OIA-PMH

* move 6.6 and 5.13 mentions to changelog

* reharvest, guestbook bugs

* try separate transient doc, revert dsft doc to boolean

* missed classes from previous commit

* metrics and sorting fixes

* postgres

* source name harvesting

* Add displayOnCreate field to dataset schema and update field display logic

- Update dataset-schema.json to include a new "displayOnCreate"  field
- Modify DataverseServiceBean to set default displayOnCreate behavior

* merge issue

* samesite

* show role

* quick test fix

* API updates

* PID formatting

* remove assert temporarily

* external tools

* #10476 fix command test

* send feedback to contacts

* dft fix

* perms

* indexing cvoc

* API for classic download count

* move version note to 6.6 where it belongs #11068

* API Guide: don't interleave "notes" with "types" #11068

* optional version note

* remove scary line from optional version note

* make text under Cite Data not bold #11163

* csl

* delete snippet without adding to notes, too in the weeds

* harvest from datacite

* globus

* bearer tokens

* fix heading level

* html sanitize JSON CSL elements

* ORCID stuff

* how to re-harvest

* fix link

* #10476 update tests json printer

* fix null handling

* #10476 code/test cleanup

* Update 6.6-release-notes.md

Fixed some typos and made some changes to improve readability

* Update doc/sphinx-guides/source/admin/harvestclients.rst

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/sphinx-guides/source/admin/harvestclients.rst

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/sphinx-guides/source/admin/harvestclients.rst

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/sphinx-guides/source/user/find-use-data.rst

Co-authored-by: Omer Fahim <[email protected]>

* fix ORCIDs

* mention video talking about highlights

* #10476 fix DataversesIT

* remove duplicates from merge

* tweaks

* #11183 fix typo

* fix link to war file

* Update doc/release-notes/6.6-release-notes.md

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/release-notes/6.6-release-notes.md

Co-authored-by: Omer Fahim <[email protected]>

* typo: cheat

Co-authored-by: Omer Fahim <[email protected]>

* fix link to issue

* typos

* Remove default displayOnCreate setting for required fields in DataverseServiceBean

* fix 500 err

* unused @ejb, cleanup

* fixes

* add test for setting input level w/o optional displayOnCreate

* handle levels in printer for API calls

* display on create

* fix LocalDisplay logic

* typo

Co-authored-by: Omer Fahim <[email protected]>

* don't include when include is false

* fix ownerdv null case

* get level once, setlocaldisplayoncreate correctly

* Try order by id

* @GPortas edits

* add index

* updates per review

* comment tweak

* Release 6.6

* Update doc/sphinx-guides/source/versions.rst

Co-authored-by: Philip Durbin <[email protected]>

---------

Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Leonid Andreev <[email protected]>
Co-authored-by: Jim Myers <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Omer Fahim <[email protected]>
Co-authored-by: Alexis Guanche <[email protected]>
Co-authored-by: qqmyers <[email protected]>
Co-authored-by: Oliver Bertuch <[email protected]>
Co-authored-by: Stephen Kraffmiller <[email protected]>
Co-authored-by: Julian Gautier <[email protected]>
stevenwinship added a commit that referenced this pull request Mar 18, 2025
* fix links

* add cross links

* resolving conflict with the newly-merged flyway script #10909

* resolving a merge conflict with a flyway script that's been merged #10909

* bump sql script #10217

* use Title Case to match other fields #10217

* reword source name help text #10217

* always show source name help text #10217

* duplicate ui:define body

* Revert "10476 display on create field option"

* undo change to sql script

* adding replace file test

* update flyway name

* remove the need to pass the datafile version to the API

* restore "parameters" minus displayOnCreate #11306

* remove flyway merge issue

* update flyway

* fix for unrelated issue found in QA

* flyway change

* rename sql

* rename sql

* typo

* one more

* Merge develop without revert

* Restore displayOnCreate field option changes

* keep renaming the flyway script... #10909

* Add displayOnCreate option for dataset field types

- Added @column annotation for displayOnCreate field in DatasetFieldType
- Updated JsonPrinter to include displayOnCreate in display condition

* Update DataversesIT test to modify metadata block listing parameter

* Update native API documentation for displayOnCreate field option

- Clarify that required fields are always displayed regardless of displayOnCreate setting

* bug fix - only create cite once, not on refresh of cslOutput

* flyway number change

* flyway again

* Implement null support for displayOnCreate field option

- Change displayOnCreate to nullable Boolean in DatasetFieldType
- Update API and service methods to handle null displayOnCreate values
- Modify native API documentation to explain null displayOnCreate behavior
- Add null checks in MetadataBlockServiceBean queries

* fix: make displayOnCreate nullable in DatasetFieldType

- Modified JsonPrinter to handle null values for displayOnCreate
- Updated BriefJsonPrinter to use null-safe comparison

* setDisplayOnCreate astroInstrument back to false #10476

* Handle null displayOnCreate in MetadataBlock and JsonPrinter

- Update MetadataBlock to safely check displayOnCreate with null values
- Modify JsonPrinter to default displayOnCreate to false when null
- Ensure consistent null-safe handling of displayOnCreate across components

* move permission check out of loop

* rename api from /versions/list to /versionDifferences

* Refine displayOnCreate logic in JsonPrinter

* Update displayOnCreate method call in metadataFragment.xhtml

- Change method call from property access to method invocation for displayOnCreate
- Maintain consistent null-safe handling of displayOnCreate field option

* adding todo for future refactoring

* Add getter method for displayOnCreate in DatasetFieldType

- Implement a simple getter method for the displayOnCreate field
- Maintain consistency with existing setter method

* note second callback needed.

* fix create mode bug

* Update doc/release-notes/6.2025.2_update.md

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/release-notes/6.2025.2_update.md

Co-authored-by: Philip Durbin <[email protected]>

* Update doc/release-notes/6.2025.2_update.md

Co-authored-by: Omer Fahim <[email protected]>

* fixing datafile persistentId

* localhost and longer key

* use original cert/key names

* add comment

* test(mail): update test SSL certs for maildev to be RSA 2028 again

It is not necessary to use 4096 bit, as the error was about the wrong common name in the cert.

Detailed explanation:
Before, the cert presented to Jakarta Mail neither contained a commonName=localhost nor subjectAltName=localhost.
This worked before with Payara 6.2024.6 because Eclipse Angus Mail 1.0.0 was still in use (see list of managed dependencies on the 6.2024.6 BOM).
Certificate host identity check was introduced as default=on with Eclipse Angus Mail 1.1.0 (see their release notes).
Now that Payara 6.2025.2 is in use on develop, we upgraded to Eclipse Angus Mail 2.3.0, making the error appear.

* test(mail): update test SSL cert generation docs

Including an openssl.conf makes it much easier and less error prone to generate the certs.
Rewriting the necessary shell command steps in the test comment to document the process.

* test(mail): pin down port in TC waiting strategy

Without the explicit addition of which port to use for the HTTP based waiting strategy, someone may end up at random with the SMTP port being picked.

This will obviously fail and result in aborted tests, making results flaky. Pinning the port down should prevent this for good.

* extend size of deaccessionlink column

* stub out 6.6 release notes #11183

* Payara upgrade #11183

* upgrade Solr #11183

* move collection

* license enhancements

* range search

* datasets without files

* license enhancements

* anon preview url

* ontoportal

* ror

* bug fixes

* boolean

* more bugs

* don't use in any edit mode

* typos

* 3d objects

* delete files, citation

* search api fields for files

* signposting

* collection featured items

* dataset types linked to metadata blocks

* fix heading levels

* Improve metadata block field selection logic for display and required fields

- Modify MetadataBlockServiceBean to include required fields in query selection
- Update JsonPrinter to simplify field display logic for metadata blocks
- Ensure fields are correctly filtered based on display and required status

* harvesting

* locks and permalink

* 3 more

* #10476 add "override" test.

* remind those with text customizations to update properties files

See https://dataverse.zulipchat.com/#narrow/channel/378866-troubleshooting/topic/upgrade.20from.206.2E3.20to.206.2E4/near/504689559

* fix npe from breadcrumbs

* pass param if sent

* Fix input levels update preserving inherited metadata blocks

When updating input levels for a collection, preserve inherited metadata blocks
and existing input levels while allowing collection-specific configurations.

* unrelated - lower log level

* docker updates

* 3 more

* typo

* API updates

* make inputlevel displayOnCreate Boolean

* guides

* 6 more

* archival block, etalab

* PR #9013 was merged for 6.6 not 6.5

* fix header level for harvesting non-OIA-PMH

* move 6.6 and 5.13 mentions to changelog

* reharvest, guestbook bugs

* try separate transient doc, revert dsft doc to boolean

* missed classes from previous commit

* metrics and sorting fixes

* postgres

* source name harvesting

* Add displayOnCreate field to dataset schema and update field display logic

- Update dataset-schema.json to include a new "displayOnCreate"  field
- Modify DataverseServiceBean to set default displayOnCreate behavior

* merge issue

* samesite

* show role

* quick test fix

* API updates

* PID formatting

* remove assert temporarily

* external tools

* #10476 fix command test

* send feedback to contacts

* dft fix

* perms

* indexing cvoc

* API for classic download count

* move version note to 6.6 where it belongs #11068

* API Guide: don't interleave "notes" with "types" #11068

* optional version note

* remove scary line from optional version note

* make text under Cite Data not bold #11163

* csl

* delete snippet without adding to notes, too in the weeds

* harvest from datacite

* globus

* bearer tokens

* fix heading level

* html sanitize JSON CSL elements

* ORCID stuff

* how to re-harvest

* fix link

* #10476 update tests json printer

* fix null handling

* #10476 code/test cleanup

* Update 6.6-release-notes.md

Fixed some typos and made some changes to improve readability

* Update doc/sphinx-guides/source/admin/harvestclients.rst

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/sphinx-guides/source/admin/harvestclients.rst

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/sphinx-guides/source/admin/harvestclients.rst

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/sphinx-guides/source/user/find-use-data.rst

Co-authored-by: Omer Fahim <[email protected]>

* fix ORCIDs

* mention video talking about highlights

* #10476 fix DataversesIT

* remove duplicates from merge

* tweaks

* #11183 fix typo

* fix link to war file

* Update doc/release-notes/6.6-release-notes.md

Co-authored-by: Omer Fahim <[email protected]>

* Update doc/release-notes/6.6-release-notes.md

Co-authored-by: Omer Fahim <[email protected]>

* typo: cheat

Co-authored-by: Omer Fahim <[email protected]>

* fix link to issue

* typos

* Remove default displayOnCreate setting for required fields in DataverseServiceBean

* fix 500 err

* unused @ejb, cleanup

* fixes

* add test for setting input level w/o optional displayOnCreate

* handle levels in printer for API calls

* display on create

* fix LocalDisplay logic

* typo

Co-authored-by: Omer Fahim <[email protected]>

* don't include when include is false

* fix ownerdv null case

* get level once, setlocaldisplayoncreate correctly

* Try order by id

* @GPortas edits

* add index

* updates per review

* comment tweak

* Release 6.6

* Update doc/sphinx-guides/source/versions.rst

Co-authored-by: Philip Durbin <[email protected]>

* 6.6 release fix (#11353)

---------

Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Leonid Andreev <[email protected]>
Co-authored-by: Jim Myers <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Omer Fahim <[email protected]>
Co-authored-by: Alexis Guanche <[email protected]>
Co-authored-by: qqmyers <[email protected]>
Co-authored-by: Oliver Bertuch <[email protected]>
Co-authored-by: Stephen Kraffmiller <[email protected]>
Co-authored-by: Julian Gautier <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

CI Failing on Develop Branch in Jenkins

6 participants