Streaming resolution

[clehner]

DID Core includes two functions for resolving a DID: resolve and resolveStream. They return a DID document (abstract representation), or a DID document stream (concrete representation), respectively, along with document metadata and resolution metadata structures. More info: w3c/did-core#380 (comment)

DID Resolution defines the resolve method in Resolving a DID. It also defines a DID Resolution Result data structure for the result of the resolve method. But there is no mention of streams. Should resolveStream be defined here too?

If resolveStream is defined, should there be a corresponding resolution data structure and/or HTTP(S) binding?

Currently, if a client or proxy wants to call resolveStream with a HTTP(S) DID resolver, they would have to call resolve, decode the JSON resolution result, and re-encode the document as a JSON byte stream (unless their JSON parser provides pointers into the original data). This would be not very stream-friendly: the caller would probably have to buffer the resolution result before returning the metadata and stream, even if using a streaming JSON parser, since the "didDocument" value may arrive before the "didResolutionMetadata" and "didDocumentMetadata" values. A HTTP(S) binding for resolveStream could provide a nicer streaming interface. For example, resolution metadata and document metadata could be encoded in HTTP response headers, and the document stream provided in the HTTP body. Or,
the body could contain a delimited concatenation or multipart encoding of the encoded resolution metadata and document metadata followed by the document stream. Perhaps the DID Resolution Result data structure could be reused, with the "didDocument" omitted for the DID document provided subsequently as a stream.

[peacekeeper]

Hello @clehner sorry for the late response, you bring up some very good points here. The DID Resolution spec is unfortunately lagging behind a bit and we need to update it to reflect the latest version of DID Core.

The idea behind the two functions was not so much that resolveStream() could be used for "streaming" in the sense that you could process parts before receiving the whole content. Maybe there are use cases for that, not sure, but the main idea of the two functions was that resolve() would return the DID document's abstract data model, and resolveStream() would return a concrete representation.

I think I would like to propose to rename resolveStream() to resolveRepresentation() to make this clearer.

Then when we get into the HTTP(S) binding, I think it would be logical to say that this applies to the resolveRepresentation() function, since you always get a concrete representation of the DID document via HTTP(S). We can update the DID Resolution spec accordingly.

What do you think about the above?

[clehner]

@peacekeeper That makes sense.

[peacekeeper]

I think this can be closed, since resolveStream() has been renamed to resolveRepresentation() long ago.

[peacekeeper]

Closing, per discussion on today's DID WG meeting.

[pchampin]

This was discussed during the did meeting on 10 October 2024.

View the transcript

DID Resolution Issue/PR Processing

burn: Contact the chairs if anyone would suggest an improvement

markus_sabadello: let's start with new issues

<markus_sabadello> https://github.com/w3c/did-resolution/issues?q=is%3Aopen+is%3Aissue+label%3Apending-close

markus_sabadello: first with pending close issues

burn: note that, in the agenda email, we listed these issues.
… We'll be using this process until the end of the thursday meeting to object to the close.

<TallTed> I strongly recommend such searches be ordered by "least recently updated" to keep the churn active, e.g., https://github.com/w3c/did-resolution/issues?q=is%3Aopen+is%3Aissue+label%3Apending-close+sort%3Aupdated-asc

burn: the point is, we'll review these quickly today, but the expectation is that you are too look for these in the agenda and speak up or comment in the issue if you have an objection
… so we will not be spending time unless there is a concern (as a general rule)

<markus_sabadello> w3c/did-resolution#57

markus_sabadello: Proposal to rename one of the resolution functions
… Resolve and ResolveStream
… This issue is a proposal to rename ResolveStream. That's already happened. I posted a comment 2 weeks ago. No further discussion

burn: any objections to closing?

markus_sabadello: I'll close them after the call

<markus_sabadello> w3c/did-resolution#30

markus_sabadello: Issue 30, several years old. Has to do with dereferencing discussion at TPAC
… "The result of dereference can be a DID document, but it can also be something else"
… Looking at this issue after a long time, I think the current specification addresses this. I see 3 thumbs up to that comment.
… So, if no objections, we'll be closing this.

<markus_sabadello> w3c/did-resolution#29

markus_sabadello: also several years old, about the definition of the term did resolver.
… In the current specification, both terms are defined formally in terminology section. Also two thumbs up.
… Any objections?

<markus_sabadello> w3c/did-resolution#21

markus_sabadello: Issue 21 about removing the term DID Reference from DID core to DID Resolution.
… I think this is now obsolete. We don't use that term in any spec.
… Same discussion was also in did-core, which was closed. So I think this one can be as well.
… Any objections?

<markus_sabadello> w3c/did-resolution#11

markus_sabadello: All methods must have a name of at least three characters.
… This seems like a DID Core issue, not in DID Resolution
… Similar issue in DID-core, which has also been closed.
… For all of these issues, it seems straightforward to close them.
… Since they are older issues, we may not be getting engagement from the initial poster, but unless there are objections, seems like we should close

decentralgabe: If we mark it pending close and give it a week, that would address the older participants

burn: requirements vary from group to group. In past groups, we've made the point to actively reach out by email and ask for engagement. Then you can comment that in the issue.
… so ping in the issue, then email, then document that email in the issue.
… That let's us show we've done what we can to address the concerns of the original poster
… For these, I think we're good, but going forward that's a nice improvement to our process

burn: you have 10 more minutes if you like

<markus_sabadello> https://github.com/w3c/did-resolution/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22

markus_sabadello: one other thing. A few issues are tagged as "Good First Issue"
… Two of them have been assigned. One has not.
… These are a good way to contribute, especially if you might not be familiar with deeper technical issues.
… We'll try to find more like that and encourage PRs
… A few that might be ready to close

<markus_sabadello> w3c/did-resolution#23

markus_sabadello: Issue 23 is about result of dereferencing

<manu> JoeAndrieu: Looking at the backlog. There is an opportunity here to make a distinction -- how we talk about a DID with and without a trailing slash... but I don't know if that helps us. I need to look at this in more detail, it's five years old, we can close it, if problem still exists, we can raise a new issue again.

<manu> markus_sabadello: I think this might be obsolete by now?

<manu> JoeAndrieu: Yeah, sounds like it might be.

<manu> markus_sabadello: We will have until next call to look at it or raise a new issue if this comes back.

<manu> JoeAndrieu: Sounds good to me.

manu: I'm wondering what is the ... I'm fine with closing it. I'm wondering where did we land?
… the response from a resolver is a resolution result, which might contain a did document?
… Is that where we landed?

markus_sabadello: that's right the resolution response might contain a did document, but dereferencing might return something else

manu: i think it's already addressed (as opposed to an older issue that isn't valid)

markus_sabadello: this was from when we didn't have a did resolution result, we were just returning DID documents
… That has been addressed

<JoeAndrieu> +1

manu: +1

markus_sabadello: also to be aware of, from discussions at TPAC, when we talked about path, query, and fragment parts.
… we talked about different patterns in the past and how much of that should be in the resolution spec itself or in did core, or in both.
… If people come up with certain features that use the path or query string, how does that fit in and where does it get specified?

<markus_sabadello> w3c/did-resolution#85

markus_sabadello: There are two open issues for new DID parameters with certain functionality

<markus_sabadello> w3c/did-resolution#90

markus_sabadello: The first introduces version-type the second XYZ as parameters
… Please comment about where these should go and whether or not it should be did-method-specific or standardized across methods

burn: ok, you have about another 5 minutes if you'd like

markus_sabadello: ok. I'm wondering if we can merge that pull request

<markus_sabadello> w3c/did-resolution#89

markus_sabadello: or if anyone has new thoughts about the discussion we had about primary resource and secondary resource
… there is an open PR where I tried to improve the headings
… to help with that. I'm wondering if people have opinions.
… I would actually prefer not to merge because it makes the headings longer
… But the algorithm talks about dereferencing the primary resource and secondary resource
… This PR adds explanation to the headings

manu: I think it is unfortunate that the initial wording was primary and secondary resource, as that is so abstract it is confusing.
… +1 to comment about section titles get hard

<TallTed> +1 to manu's suggestion

manu: maybe we can call it derereferencing a DID? or a #fragment
… +1 to not merge this, but maybe we can have did document and fragment as the terms

markus_sabadello: there is something that right now is called a primary resource.
… there needs to be a name for what you get when you dereference the did document
… For example, dereferencing the DID URL resource may be a better phrase

manu: yes. that was my thinking. Name the types of things you can dereference.
… A use case where you get a DID Document. A case where you dereference a fragment in a resource. And a third case where it's neither of those.
… Related Resource? (Not suggesting that, but if we name it, it will help)

markus_sabadello: this needs to be extensible. we can't imaging all the things they dereference to.
… but i think we can use better terms than Primary & Secondary. I'll try to do that.

<manu> JoeAndrieu: I would like to try my hand at writing this PR, don't know when I'm going to get to it, but want to help.

---