[Entity Store][API] Fix snake case on CRUD API List response

[kubasobon]

Summary

Closes #241120

A quick fix for entity.attibutes, entity.behaviors, and entity.lifecycle entries being returned with ECS formatting. Now they are lower snake case, as expected.

[romulets]

looks fine. This setup (that I implemented) still doesn't sit right me........ argh.

Anyway, looks good!

[tiansivive]

Hey! Thanks for all the work here!

I see one potential issue regarding key collisions.
I don't expect it to happen, bur since we're converting stuff now, I can imagine a scenario where we encounter something like:

{
  entity: {
    attributes: { Field: "blah", field: "something else" }
  }
}

And we might lose data?
Do you think this could be a problem? should we have some collision detection safety guard?

Secondly, I'm always a bit uneasy about allowing code with disabled eslint and ts rules. I think we can slightly change the code to a more declarative approach that removes the need for the continue statements, as well as simplifies all the checks:

// just override the entity field with the normalized fields
records.foreach(record => { 
  const result = buildNormalizedFields(record.entity, ['behaviors', 'lifecycle', 'attributes'])
  record.entity = { ...record.entity, ...result } 
})

function normalizeEntityFields(
  obj: Record<string, unknown>,
  properties: string[]
) {
  // only use properties whose val is an object, skip them if undefined or some other type
  const hasObjVal = (p: string) => obj[p] !== null && typeof obj[p] === "object" && !Array.isArray(obj[p])
  const entries = properties
        .filter(hasObjVal)
        .map(p => [p, toLowercaseKeys(obj[p] as Record<string, unknown>)])
  return Object.fromEntries(entries)
}

function toLowercaseKeys(
  obj: Record<string, unknown>
): Record<string, unknown> {
  // iterate to rebuild the sub object with the lowercase keys.
  // No need for checking if it appears in the old sub or to `delete` 
  return Object.fromEntries(Object.entries(obj).map(([k, v]) => [k.toLowerCase(), v]))
}

(this doesn't cover the key collision issue tho)

[kubasobon]

@tiansivive All very good remarks! Thank you for going over it and teaching me something about TS in the process.
As for the collisions - we're not worried about them because the keys themselves, while not being ECS, are very precisely defined and managed by our own code, not the user.

[tiansivive]

Alright!
If key collisions aren't expected to be an issue then I think we're all good!

Awesome stuff ✅

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: aafe525

Metrics [docs]

✅ unchanged

History

• 💛 Build #374162 was flaky f92c26c
• 💛 Build #374076 was flaky eedca2b
• 💔 Build #374032 failed 1dad5fb
• 💔 Build #373644 failed 67f01aa
• 💛 Build #373114 was flaky e79fc04
• 💔 Build #372983 failed 1faa5a7

cc @kubasobon