You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "Jens-G (via GitHub)" <gi...@apache.org> on 2024/04/21 13:47:09 UTC
[PR] DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Jens-G opened a new pull request, #2963:
URL: https://github.com/apache/thrift/pull/2963
Describing the endpoint specifics for a Thrift API today is a purely textual exercise, which leaves the client end with the task to set up and stack together a proper protocol/transport stack. That sometimes even leads to headaches, e.g. if the server requires e.g. framed protocol which might not be obvious. The use of a generally accepted, machine-readable and extensible Thrift URI format to describe client bindings could streamline that process.
Details see https://github.com/Jens-G/thrift/blob/thrift-uri/doc/specs/thrift-uri.md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "fishy (via GitHub)" <gi...@apache.org>.
fishy commented on PR #2963:
URL: https://github.com/apache/thrift/pull/2963#issuecomment-2075935871
> > THeaderProtocol already supports the auto detection of: [...] framed or not
>
> * Assumed, I absolutely want to force the use of framed transport for some reasons, I would have to derive an own variant and handle that myself? Otherwise bad counterparts could by crafting a suitable THeader force me into unframed mode which I don't want. Correct? Intended?
The "auto detection" part in THeader spec is more for auto "backward" compatibility with non-THeader clients. e.g. if a client talking to THeader server does not use THeader at all, it still works if it uses one of TBinary or TCompact protocol, and with or without TFramedTransport. but if a client actually uses THeader frame is enforced (it cannot write/read any header without frame)
> * Same with HMAC. I can intercept a message, strip the HMAC stuff and then deliver some "improved" version of the message instead. Correct? Intended?
if we have a MITM to rewrite the message then yes HMAC can be stripped.
I get your point, this proposal does add additional enforcement not possible with THeader alone.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G commented on code in PR #2963:
URL: https://github.com/apache/thrift/pull/2963#discussion_r1576111621
##########
doc/specs/thrift-uri.md:
##########
@@ -0,0 +1,155 @@
+Thrift URIs
+====================================================================
+
+Last Modified: 2024-APR-21
+
+<!--
+--------------------------------------------------------------------
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+
+--------------------------------------------------------------------
+-->
+
+# Motivation and use case
+
+Describing the endpoint specifics for a Thrift API today is a purely text-adventure like exercise, which leaves the client side developer end with the tedious task to set up and put together a proper protocol/transport stack. That sometimes even leads to headaches, e.g. if the server requires e.g. framed protocol which might not be obvious. The use of a generally accepted, machine-readable and extensible Thrift URI format to describe client bindings could streamline that process.
Review Comment:
> So the only issues left are:
* Extensibility: How do I integrate my custom transport or protocol into the THeader system?
* How does THeader deal with multiplex?
> memory and buffered used in RPCs are pure implementation details and do not really affect the wire protocol
Kind of "for the sake of completeness" thing. They probably could be safely excluded.
> As referenced in https://www.ietf.org/rfc/rfc2396.txt, even though this is not how URI is defined, a common syntax used widely defines it as:
Yes I noticed. [RFC3986](https://www.ietf.org/rfc/rfc3986.txt) is more recent, but essentially tells the same story. Will be fixed soon.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G commented on PR #2963:
URL: https://github.com/apache/thrift/pull/2963#issuecomment-2080407445
@all Thanks for the feedback. I'm currently re-evaluating the entire design. I'll come up with an enhanced proposal later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G commented on PR #2963:
URL: https://github.com/apache/thrift/pull/2963#issuecomment-2075886247
> THeaderProtocol already supports the auto detection of: [...] framed or not
* Assumed, I absolutely want to force the use of framed transport for some reasons, I would have to derive an own variant and handle that myself? Otherwise bad counterparts could by crafting a suitable THeader force me into unframed mode which I don't want. Correct? Intended?
* Same with HMAC. I can intercept a message, strip the HMAC stuff and then deliver some "improved" version of the message instead. Correct? Intended?
* CLIENT_TYPE somehow reminds me of [something](https://en.wikipedia.org/wiki/Combinatorial_explosion).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G commented on code in PR #2963:
URL: https://github.com/apache/thrift/pull/2963#discussion_r1576111621
##########
doc/specs/thrift-uri.md:
##########
@@ -0,0 +1,155 @@
+Thrift URIs
+====================================================================
+
+Last Modified: 2024-APR-21
+
+<!--
+--------------------------------------------------------------------
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+
+--------------------------------------------------------------------
+-->
+
+# Motivation and use case
+
+Describing the endpoint specifics for a Thrift API today is a purely text-adventure like exercise, which leaves the client side developer end with the tedious task to set up and put together a proper protocol/transport stack. That sometimes even leads to headaches, e.g. if the server requires e.g. framed protocol which might not be obvious. The use of a generally accepted, machine-readable and extensible Thrift URI format to describe client bindings could streamline that process.
Review Comment:
> So the only issues left are:
* Extensibility: How do I integrate my custom transport or protocol into the THeader system?
* How does THeader deal with multiplex (I'm about to add that, not finsihed yet)?
> memory and buffered used in RPCs are pure implementation details and do not really affect the wire protocol
Kind of "for the sake of completeness" thing. They probably could be safely excluded.
> As referenced in https://www.ietf.org/rfc/rfc2396.txt, even though this is not how URI is defined, a common syntax used widely defines it as:
Yes I noticed. [RFC3986](https://www.ietf.org/rfc/rfc3986.txt) is more recent, but essentially tells the same story. Will be fixed soon.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "fishy (via GitHub)" <gi...@apache.org>.
fishy commented on code in PR #2963:
URL: https://github.com/apache/thrift/pull/2963#discussion_r1575038258
##########
doc/specs/thrift-uri.md:
##########
@@ -0,0 +1,155 @@
+Thrift URIs
+====================================================================
+
+Last Modified: 2024-APR-21
+
+<!--
+--------------------------------------------------------------------
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+
+--------------------------------------------------------------------
+-->
+
+# Motivation and use case
+
+Describing the endpoint specifics for a Thrift API today is a purely text-adventure like exercise, which leaves the client side developer end with the tedious task to set up and put together a proper protocol/transport stack. That sometimes even leads to headaches, e.g. if the server requires e.g. framed protocol which might not be obvious. The use of a generally accepted, machine-readable and extensible Thrift URI format to describe client bindings could streamline that process.
+
+# Thrift URI general format
+
+Lets look at the general format:
+
+ "thrift://" <protocol> "/" <transport> ["/" <layer>]* "?" <transport-specific-data>
+
+The *scheme* of all Thrift URIs is "thrift://". Immediately followimng parts are the protocol being used and the endpoint transport.
+
+Optionally, more path segments may be added, each one describing a particular layered transport, e.g. "framed".
+
+All query data (i.e. the part after the question mark) depend on the endpoint transport in the second segment, examples follow below. All data must be properly URL-encoded.
+
+# Predefined identifiers
+
+Each implementation shall register their implemented formats with the following keys internally:
+
+## Protocols
+|Code|Protocol|
+|-|-|
+|binary|Thrift Binary protocol|
+|compact|Thrift Compact protocol|
+|json|Standard Thrift JSON protocol|
+
+TODO: cover multiplex protocol
+
+## Endpoint Transports
+|Code|Transport|
+|-|-|
+|http|http(s) transport|
+|namedpipes|Named Pipes Transport|
+|pipes|Simple Pipes Transport (i.e. via STDIN,STDOUT)|
+|socket|Socket Transport|
+|tlssocket|TLS Sockets Transport|
+|file|File transport|
+|memory|Memory Buffer Transport|
+
+## Layered Transports
+|Code|Transport|
+|-|-|
+|framed|Framed transport|
+|buffered|Buffered transport|
+|zlib|ZLib transport|
+
+## TODO: multiplex protocol
+....
+
+
+# Extensibility
+
+Consistent with the open and extensible nature of Thrift, the registration mechanism outlined above is intentionally designed to be open to any user-defined protocols and transports. That way, future developments as well as proprietary developments can be covered by the same mechanism. It is also expected, that depending on the implemented set of features, different languages supported by Thrift might support a different set of Thrift URI components.
+
+
+# Transport specific data
+
+
+## http - http(s) transport
+
+The data part consists of the target URL. No other data are allowed.
+
+Examples:
+ * thrift://binary/http?https%3A%2F%2Fuser%3Apass%40example.com%2Fmyservice%3Farg%3Done%26arg%3Dtwo
+
+## namedpipes - Named Pipes Transport
+
+The data part consists of the target pipe, either name only or in full format:
+
+Examples:
+ * thrift://binary/namedpipes?mypipe
Review Comment:
As referenced in https://www.ietf.org/rfc/rfc2396.txt, even though this is not how URI is defined, a common syntax used widely defines it as:
```
<scheme>://<authority><path>?<query>
```
so this will be parsed into:
* `scheme`: `thrift`
* `authority`: `binary`
* `path`: `/namedpipes`
* `query`: `mypipe`
and the `authority` part can be misleading/confusing.
I haven't read that RFC fully carefully yet, but I _think_ that we can add another `/` to make `authority` part empty:
```
thrift:///binary/namedpipes?mypipe
```
or, if that doesn't work, then maybe we should try to define it similar to `mailto:`, without the `//` part followed by `:`.
##########
doc/specs/thrift-uri.md:
##########
@@ -0,0 +1,155 @@
+Thrift URIs
+====================================================================
+
+Last Modified: 2024-APR-21
+
+<!--
+--------------------------------------------------------------------
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+
+--------------------------------------------------------------------
+-->
+
+# Motivation and use case
+
+Describing the endpoint specifics for a Thrift API today is a purely text-adventure like exercise, which leaves the client side developer end with the tedious task to set up and put together a proper protocol/transport stack. That sometimes even leads to headaches, e.g. if the server requires e.g. framed protocol which might not be obvious. The use of a generally accepted, machine-readable and extensible Thrift URI format to describe client bindings could streamline that process.
Review Comment:
if we limit the scope of the issue to endpoints (e.g. limit to RPC part, and exclude pure serialization/deserialization use-cases), I would say the THeaderProtocol resolves the _majority_ of the problems here.
THeaderProtocol already supports the auto detection of:
* binary vs. compact
* framed or not
it also supports zlib (but only if it's enabled inside Header, it does not support raw zlib transport unlike raw framed/binary/compact)
So the only issues left are:
* json protocol is not covered (supported)
* the underlying, final, raw transport used (socket/sslsocket/file/pipes/namedpipes)
(I think memory and buffered used in RPCs are pure implementation details and do not really affect the wire protocol, but please correct me if I'm wrong)
so maybe we should shift focus to support THeader in more language implementations (it's currently only implemented in c++/py/go)?
when a server uses THeaderProtocol, any of the following client will be able to talk to it without issue:
* THeaderProtocol
* TBinaryProtocol
* TBinaryProtocol+TFramedTransport
* TCompactProtocol
* TCompactProtocol+TFramedTransport
(the final raw transport, e.g. one of socket/sslsocket/file/pipe/namedpipe, still need to be specified)
that won't resolve the json problem, obvious (I also don't think add json support to THeader is a good idea), but from my experience TJSONProtocol used in thrift RPC are usually more special cases (for example, only being combined with THTTPTransport) that it's _usually_ unambiguous and has much less chance for the client to use the wrong protocol/transport.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation [thrift]
Posted by "Jens-G (via GitHub)" <gi...@apache.org>.
Jens-G closed pull request #2963: THRIFT-5778 DRAFT/PROPOSAL: Thrift URI specification/implementation
URL: https://github.com/apache/thrift/pull/2963
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@thrift.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org