coverage: 22.724% (-0.01%) from 22.736%
when pulling 4625a3a on 10476-display-on-create-field-option
into 2210d16 on develop.

Please address the merge conflicts along with the review comments. Thanks

This PR has a merge conflict.

@stevenwinship @ofahimIQSS I have added all the adjustments and the test.
I have also finished resolving the conflicts.
Let me know if any adjustments are needed!

This PR has branch conflicts - can you please resolve. Thanks!

no issues found during testing - merging PR

Flyway script added in this PR:

• Create V6.5.0.6.sql (displayOnCreate) #11304

Hey team! I executed the tests related to the displayOnCreate functionality and found some discrepancies between the reported errors (#11298) and what I am currently seeing.

Originally Reported Failed Tests:

1. DatasetTypesIT.testLinkInstrumentToAstro:

   • Error: data[0].name expected "citation" but is "astrophysics"

2. DatasetTypesIT.testUpdateDatasetTypeLinksWithMetadataBlocks:

   • Error: data[0].name expected "citation" but is null

3. DataversesIT.testListMetadataBlocks:

   • Error: data[0].fields.size() expected 10 but is 5

4. DataversesIT.testUpdateInputLevelDisplayOnCreate:

   • Error: data.size() expected 1 but is 0

5. MetadataBlocksIT.testListMetadataBlocks:

   • Error: data[0].displayName expected "Citation Metadata" but is null

Failed Tests We Are Currently Seeing:

1. DatasetTypesIT.testLinkInstrumentToAstro:

   • Error: data[1].fields.astroInstrument.displayOnCreate expected true but is null
   • Context: The test expects the astroInstrument field in the astrophysics metadata block to have displayOnCreate set to true, but it's returning null. Looking at the astrophysics.tsv file, we can see that this field is defined with displayoncreate=FALSE. The test seems to expect this to be true, but the implementation is respecting the value from the TSV file.

2. DatasetTypesIT.testUpdateDatasetTypeLinksWithMetadataBlocks and DataversesIT.testListMetadataBlocks:

   • Error: data[0].fields.size() expected 10 but is 5
   • Context: Both tests expect 10 fields in the metadata block, but only 5 are being returned. Looking at the response, we can see that only the following Required by Dataverse fields are present:
     • title
     • author
     • datasetContact
     • dsDescription
     • subject
   • The implementation is currently only returning fields that have displayOnCreate=true. This is happening because the query in MetadataBlockServiceBean.listMetadataBlocksDisplayedOnCreate() is filtering fields based on this property. We need to confirm if:
     a) The endpoint should return all fields of the block, regardless of their displayOnCreate value
     b) Or if it should only return fields with displayOnCreate=true (current behavior)
   • If the endpoint should return all fields, we need to identify which additional fields should be included in the response
   • If the current behavior is correct, we need to update the tests to expect only the fields with displayOnCreate=true

3. DataversesIT.testUpdateInputLevelDisplayOnCreate:

   • Error: data.size() expected 1 but is 0
   • Context: The test expects at least one metadata block to be returned when querying with displayOnCreate=true, but no blocks are being returned. This suggests that either:
     a) No blocks have any fields with displayOnCreate=true
     b) The filtering logic in MetadataBlockServiceBean.listMetadataBlocksDisplayedOnCreate() is not working as expected
     c) The test's expectations about which blocks should be returned need to be adjusted

4. MetadataBlocksIT.testListMetadataBlocks:

   • Error: data.size() expected 1 but is 2
   • Context: The test expects only one metadata block to be returned, but we're getting two blocks:
     • citation (with fields)
     • geospatial (with empty fields)
   • The implementation is returning all metadata blocks, but the test seems to expect only blocks with displayOnCreate=true or with specific criteria.

Identified Discrepancies:

1. The errors related to the order and presence of the "citation" block are not reproducing
2. The errors we are seeing are more related to:
   • The size of fields in metadata blocks
   • The displayOnCreate property of the astroInstrument field
   • The total number of metadata blocks being returned

Questions:

1. Regarding astroInstrument.displayOnCreate:

   • Should this field be displayed on create by default?
   • Should we modify the astrophysics.tsv file to set displayoncreate=TRUE?
   • Or should the test be updated to expect FALSE?

2. Regarding the number of fields (5 vs 10):

   • Is the current filtering of fields intentional?
   • Should we include all fields regardless of their properties?
   • Are there specific criteria that determine which fields should be included?

3. Regarding testUpdateInputLevelDisplayOnCreate:

   • What is the expected behavior when no blocks have displayOnCreate=true?
   • Should we modify the filtering logic or update the test expectations?

4. Regarding testListMetadataBlocks:

   • Should we return all metadata blocks or only those with specific criteria?
   • What determines which blocks should be included in the response?

1. Should we modify the astrophysics.tsv file to set displayoncreate=TRUE?

No, it's being changed in the database by this line:

// displayOnCreate will only be true for fields that are set this way in the database.
// We set it here so we can make assertions below.
UtilIT.setDisplayOnCreate("astroInstrument", true);