add custom JSON marshaling for DefaultMetadata

[akuzni2]

Added a custom MarshalJSON method to DefaultMetadata. This ensures that if the Data field contains JSON, it is not double-encoded, while non-JSON data is marshaled as-is.

[changeset-bot]

🦋 Changeset detected

Latest commit: 6ad0a2b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
chainlink-deployments-framework	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[graham-chainlink]

You got a lint error

[graham-chainlink]

Then unmarshaling would not work right since the Json can't be converted back to a string unless we implement Unmarshaljson too? Let me check with @giogam to understand this a bit more.

[akuzni2]

That's a good point - we'd need to implement that

[giogam]

Hey @akuzni2! Can you provide more context on why this is necessary? The Data field is intended to store a JSON-encoded string representing a domain-specific metadata type, so there shouldn’t be a need to store non-JSON data.

[akuzni2]

@giogam

there shouldn’t be a need to store non-JSON data.

This is I believe the intent as well.

Without correct serialization JSON is double escaped.

       {
          "contractMetadataStore": {
            "records": [
              {
                "address": "0x1234",
                "chainSelector": 3478487238524512106,
                "metadata": {
                  "data": "{\"content\":{\"metadata\":{\"deployBlock\":150906864},\"view\":{\"field1\":[\"0x1234567890abcdef\"],\"field2\":{\"key1\":\"value1\"}}}}"
                }
              }
            ]
          },
        }

With this custom serializer in this PR

       {
          "contractMetadataStore": {
            "records": [
              {
                "address": "0x1234",
                "chainSelector": 3478487238524512106,
                "metadata": {
                  "data": {
                    "content": {
                      "metadata": {
                        "deployBlock": 150906864
                      },
                      "view": {
                        "field1": [
                          "0x1234567890abcdef"
                        ],
                        "field2": {
                          "key1": "value1"
                        }
                      }
                    }
                  }
                }
              }
            ]
          },
        }   

Isn't this the intended format if the whole output should be serialized to JSON?

The double escaping is happening now because ToDefault does a cast string(data)

chainlink-deployments-framework/datastore/transform.go

Line 49 in 6968d63

Data: string(jsonData),

if the Data field of DefaultMetadata is really intended to be JSON - we should change this to Go's json.RawMessage which will handle the double encoding for us.

So theres 2 choices:

1. custom serialization (implemented in PR)
2. break the data-type and hope no one is using it directly and go and update it everywhere

[graham-chainlink]

Thanks Alex, I will leave this to @giogam as he has a lot more context on the design of datastore.

[giogam]

Closing this, as we ended up taking a different approach.
Refer to the following PRs for more details:

• SPIKE: feat(datastore): replace generics metadata with any [DO NOT MERGE] #124
• feat(datastore): removes Clone requirement for custom metadata types #141
• feat(datastore) remove generics from the top level api #149
• feat(datastore): removes EnvMetadataKey implementation #118