6 ms·
I'm not sure I get this, does the data type change depending on context? Is that what they mean?
by oblio 6y ago
I'm not sure I get this, does the data type change depending on context? Is that what they mean?
- golergka 6y ago> XYZ’s protocol is not just based on JSON, but it’s based on a particular technique known as polymorphic JSON. In this, a single field could have a different data type in different circumstances. For example, the resources field can be an array when requesting a single access token, or it can be an object when requesting multiple named access tokens. The difference in type indicates a difference in processing from the server. Within the resources array, each element can be either an object, representing a rich resource request description, or a string, representing a resource handle (scope). This is horrible.
- pwinnski 6y agoThis is definitely not a protocol dreamed up by, say, Java developers. Obviously it's doable in Java, but I'm hard-pressed to imagine a Java developer would think of such a thing.
- tasogare 6y agoThis is a few magnitude even more infuriating than a spec I have to work with at work, where some keys are required to be URI...
- mumblemumble 6y agoThe only time I've ever encountered an API that used it extensively, it was done by a company that does all their implementation in Java. My best guess at what happened, based on the shape of the API, is that they implemented it by taking their pre-existing domain model, which had a fairly deep subclassing hierarchy, liberally sprinkled some annotations from com.fasterxml.jackson.annotation, and dumped the result straight onto the wire. You could absolutely do an object-oriented codebase where two different subclasses have fields with the same name and different types, and, depending on how you structure your code, it might not be too painful. And it's fairly easy to imagine someone serializing a structure like that to JSON without ever meditating on the fact that JSON won't retain the all the type information. Ironically, the end result was an API that is nigh-impossible to consume from Java. I ended up writing a façade in Python. I've also seen little bits of this happen in the internal APIs at my current company. Also a Java shop, also a result of trying to directly connect an internal object model to the API. I've never seen it done in an API implemented in a dynamic or functional language.
- pwinnski 6y agoI hadn't considered the one-way nature of dumping Java classes to JSON. Mainly because I work with classes that are serialized both to and from JSON, rather than having Jackson annotations added much later. I can see it now. Horrifying! I'm sorry for your troubles.
- mumblemumble 6y agoMy take-away is this: Protocols should always be defined independently of any existing code. The code-first approach only works well when you're doing something self-contained. Which, an API, almost by definition, is not.
- pwinnski 6y agoI generally try to design APIs from a consumer perspective, and then usually I end up with something RESTful. Let the server do whatever it has to do, you know?
- golergka 6y agoI work in Typescript, which is arguably the best mainstream language suited to type such things, and still. This is insane.
- alyandon 6y agoLovely - I can't wait to see how horrible something like that is to implement in a language like Go.
- nullandvoid 6y agointerface{} to the rescue
- meddlepal 6y agoI hope you enjoy working with interface{} _sigh_
- CameronNemo 6y agoSounds like a golang problem. Rust can easily handle it with union types from what I have seen.
- dullgiulio 6y agoYou have to implement UnmarshalJSON. Between each attempt to deserialize into a possible struct, be careful to return on errors that are not JSON serialisation errors (for example caused by reading from the underlying Reader, etc.) It's ugly and verbose but there is no need to use empty interface.
- q3k 6y agoIt means sometimes you'll get: { foo: { bar: "baz" }} and other times you'll get { foo: "something else" } Good luck!
- maerF0x0 6y agoPolymorphic JSON is such a PITA for strongly typed languages. var data map[string]interface{} //.. switch t := data["foo"].(type) { case string: case interface{} } imagine that for every key...
- speedgoose 6y agoIn my humble opinion, Golang is pretty verbose in a bad way when it comes to JSON. Rust and the crate serde_json are also strongly typed and it's a lot better.
- q3k 6y agoHow would you express deserializing these 'polymorphic JSON' objects using serde/Rust?
- speedgoose 6y agoUsing a rust enum I guess.
- q3k 6y agoYou're right, this does seem to work [1]. I wasn't aware that serde would attempt to deserialize multiple enum variants until something matches. [1] - https://serde.rs/enum-representations.html#untagged https://serde.rs/enum-representations.html#untagged
- masklinn 6y agoYeah that's a rather common scheme out there so Serde does provide built-in support for this deserialisation. Probably better for deserialisation performances to use properly tagged enums, but if you don't have a choice Serde's got your back.
- mumblemumble 6y agoYeah, pretty much exactly that. The only time I've had to deal with it in the wild was a terrible experience. As a consumer, you couldn't make any decisions with confidence without first making a careful study of the documentation. For every. single. decision.