EventGridEvent ctor parameters are ordered inconsistently from other SDK languages

[joshfree]

The Event Grid C# SDK's EventGridEvent public constructor has its parameters ordered differently from other language SDKs. We should probably address this inconsistency in an upcoming beta release:

EventGridEvent.cs#L26

public EventGridEvent(object data, string subject, string eventType, string dataVersion)

EventGridEvent.java#L51

public EventGridEvent(String subject, String eventType, Object data, String dataVersion) {

https://docs.microsoft.com/en-us/azure/event-grid/event-schema#event-properties
JSON schema ordering: subject, eventType, [data], [dataVersion]

[JoshLove-msft]

/cc @rakshith91 @ellismg - what are Python/JS doing here?

[ellismg]

@JoshLove-msft

For JavaScript, we don't actually have an EventGridEvent or CloudEvent type that you construct. Instead, we have defined an interface that says what required and optional properties an object must have to be passed to our sendEvent method. Developers can construct such objects that fit that interface however they see fit, including using the object literal notation, i.e.:

sendEvent({ data: {}, subject: "some subject", eventType: "sample", dataVersion: "1.0");

In this case, the order of the keys in the object is uninteresting, the above is identical to:

sendEvent(subject: "some subject", eventType: "sample", { data: {}, dataVersion: "1.0");

[JoshLove-msft]

@rakshith91 I assume Python is similar to JS here?

[rakshith91]

@JoshLove-msft Python with it's kwargs has this:

EventGridEvent( subject, event_type, **kwargs)

[JoshLove-msft]

We will update to move the data parameter right before the dataVersion parameter. This will also make things more consistent with the CloudEvent ctor.

[rakshith91]

@JoshLove-msft
It was discussed in the cross language consistency meeting to use this order -

def __init__(self, data, subject, event_type, data_version, **kwargs):

[JoshLove-msft]

@JoshLove-msft
It was discussed in the cross language consistency meeting to use this order -

def __init__(self, data, subject, event_type, data_version, **kwargs):

I think this was before @YijunXieMS pointed out the inconsistency between the CloudEvent and EventGridEvent ctors. Can we discuss again tomorrow?

[rakshith91]

makes sense - agree with the inconsistency in both the Events - sure