Feature/pdct 1542 change bulk import tool to not allow non strings as metadata

[annaCPR]

Description

• add validation to the bulk import endpoint which checks that all metadata values are strings

Please include:

• a summary of the changes
• links to any related issue/ticket
• any additional relevant motivation and context
• details of any dependency updates that are required for this change

Proposed version

Please select the option below that is most relevant from the list below. This
will be used to generate the next tag version name during auto-tagging.

• Skip auto-tagging
• Patch
• Minor version
• Major version

Visit the Semver website to understand the
difference between MAJOR, MINOR, and PATCH versions.

Notes:

• If none of these options are selected, auto-tagging will fail
• Where multiple options are selected, the most senior option ticked will be
  used -- e.g. Major > Minor > Patch
• If you are selecting the version in the list above using the textbox, make
  sure your selected option is marked [x] with no spaces in between the
  brackets and the x

Type of change

Please select the option(s) below that are most relevant:

• Bug fix
• New feature
• Breaking change
• GitHub workflow update
• Documentation update
• Remove legacy code
• Dependency update

How Has This Been Tested?

Please describe the tests that you added to verify your changes.

Reviewer Checklist

• DB_CLIENT DEPENDENCY IS ON THE LATEST VERSION
• The PR represents a single feature (small drive-by fixes are also ok)
• The PR includes tests that are sufficient for the level of risk
• The code is sufficiently commented, particularly in hard-to-understand areas
• Any required documentation updates have been made
• Any TODOs added are captured in future tickets
• No FIXMEs remain

[linear]

PDCT-1542 Change bulk import tool to not allow non-strings as metadata

[jamesgorrie]

This is great. There is a suggestion though that we use a parser, which might work better at scale, and also allows us to define the type of Metadata.

[jamesgorrie]

Instead of writing our own parser, we could use Pydantic's parser? e.g.

from pydantic import BaseModel, RootModel, ValidationError
from typing import Dict, Union, List

Metadata = RootModel[Dict[str, Union[str, List[str]]]]

if __name__ == "__main__":
    good_json = '{"name": "John", "age": "30", "list": ["item1", "item2"]}'
    bad_json = '{"name": "John", "age": 30, "list": ["item1", "item2"]}'

    try: 
        print(Metadata.model_validate_json(good_json))
        print("Successful") # reaches here
    except ValidationError as e:
        print(e)
        print("Failed")

    try: 
        print(Metadata.model_validate_json(bad_json))
        print("Successful")
    except ValidationError as e:
        print(e)
        print("Failed") # reaches here with a nice descriptive error