❇️ Ozone user agent #3991
❇️ Ozone user agent #3991
Conversation
| "type": "string", | ||
| "description": "Name/identifier of the source (e.g., 'automod', 'ozone/workspace')" | ||
| }, | ||
| "extra": { |
There was a problem hiding this comment.
extra works for me, though I also wonder if something more neutral about the info's "extra-ness" like details could also be good.
| "name": { | ||
| "type": "string", | ||
| "description": "Name/identifier of the source (e.g., 'automod', 'ozone/workspace')" | ||
| }, |
There was a problem hiding this comment.
I assume also using an actual user-agent string (in this sense) would also be welcome.
| "userAgent": { | ||
| "type": "ref", | ||
| "ref": "tools.ozone.moderation.defs#userAgent" | ||
| } |
There was a problem hiding this comment.
My only confusion about this kind of usage is that there is also the user-agent header which will be present in these requests.
| @@ -1,5 +1,6 @@ | |||
| import { | |||
There was a problem hiding this comment.
May be worth a changeset for this dev-env change.
| userAgent: row.userAgent | ||
| ? { | ||
| name: row.userAgent.name, | ||
| extra: row.userAgent.extra as { [x: string]: unknown } | undefined, |
There was a problem hiding this comment.
Could this cast be addressed by updating the type in the moderation_event schema?
| await db.schema | ||
| .createIndex('moderation_event_user_agent_name_idx') | ||
| .on('moderation_event') | ||
| .expression(sql`("userAgent" ->> 'name')`) | ||
| .execute() |
There was a problem hiding this comment.
If many events end-up being created by the same system, with the same user agent name, even this index may not save us! Do we think that is likely? What is the most similar use case in queryEvents (where I assume this index is used) and how is it indexed?
This PR adds an optional
userAgentproperty to moderation events, allowing for better tracing of where events are coming from. The primary property of the userAgent object is just anamestring while it allows for any additional metadata passing via theextraobject.