Re: Draft v1 Update for Resumable Uploads

gs-lists-ietf-http-wg@gluelogic.com Sun, 19 June 2022 06:03 UTC

Return-Path: <ietf-http-wg-request+bounce-httpbisa-archive-bis2juki=lists.ie@listhub.w3.org>
X-Original-To: ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com
Delivered-To: ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 24AC8C157B54 for <ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com>; Sat, 18 Jun 2022 23:03:41 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.661
X-Spam-Level:
X-Spam-Status: No, score=-2.661 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, MAILING_LIST_MULTI=-1, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_MSPIKE_H2=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id pae3q8KgFKUa for <ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com>; Sat, 18 Jun 2022 23:03:37 -0700 (PDT)
Received: from lyra.w3.org (lyra.w3.org [128.30.52.18]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 13FEBC147920 for <httpbisa-archive-bis2Juki@lists.ietf.org>; Sat, 18 Jun 2022 23:03:36 -0700 (PDT)
Received: from lists by lyra.w3.org with local (Exim 4.92) (envelope-from <ietf-http-wg-request@listhub.w3.org>) id 1o2nyr-0000XE-7Z for ietf-http-wg-dist@listhub.w3.org; Sun, 19 Jun 2022 06:00:17 +0000
Resent-Date: Sun, 19 Jun 2022 06:00:17 +0000
Resent-Message-Id: <E1o2nyr-0000XE-7Z@lyra.w3.org>
Received: from mimas.w3.org ([128.30.52.79]) by lyra.w3.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from <gs-lists-ietf-http-wg@gluelogic.com>) id 1o2nyp-0000WT-L1 for ietf-http-wg@listhub.w3.org; Sun, 19 Jun 2022 06:00:15 +0000
Received: from smtp1.atof.net ([52.86.233.228]) by mimas.w3.org with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (Exim 4.94.2) (envelope-from <gs-lists-ietf-http-wg@gluelogic.com>) id 1o2nyo-000d6R-Kc for ietf-http-wg@w3.org; Sun, 19 Jun 2022 06:00:15 +0000
X-Spam-Language: en
X-Spam-Relay-Country:
X-Spam-DCC: B=; R=smtp1.atof.net 1102; Body=1 Fuz1=1 Fuz2=1
X-Spam-RBL:
X-Spam-PYZOR: Reported 0 times.
Date: Sun, 19 Jun 2022 01:59:52 -0400
From: gs-lists-ietf-http-wg@gluelogic.com
To: Guoye Zhang <guoye_zhang@apple.com>
Cc: ietf-http-wg@w3.org
Message-ID: <Yq67WGkb0LtJIAP9@xps13>
References: <BED5A5BC-3F7F-47E2-815E-DC0483328DFD@apple.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <BED5A5BC-3F7F-47E2-815E-DC0483328DFD@apple.com>
Received-SPF: pass client-ip=52.86.233.228; envelope-from=gs-lists-ietf-http-wg@gluelogic.com; helo=smtp1.atof.net
X-W3C-Hub-Spam-Status: No, score=-6.2
X-W3C-Hub-Spam-Report: BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, W3C_AA=-1, W3C_WL=-1
X-W3C-Scan-Sig: mimas.w3.org 1o2nyo-000d6R-Kc 32d4e1ff3355527f468b790c7d3d2465
X-Original-To: ietf-http-wg@w3.org
Subject: Re: Draft v1 Update for Resumable Uploads
Archived-At: <https://www.w3.org/mid/Yq67WGkb0LtJIAP9@xps13>
Resent-From: ietf-http-wg@w3.org
X-Mailing-List: <ietf-http-wg@w3.org> archive/latest/40160
X-Loop: ietf-http-wg@w3.org
Resent-Sender: ietf-http-wg-request@w3.org
Precedence: list
List-Id: <ietf-http-wg.w3.org>
List-Help: <https://www.w3.org/Mail/>
List-Post: <mailto:ietf-http-wg@w3.org>
List-Unsubscribe: <mailto:ietf-http-wg-request@w3.org?subject=unsubscribe>

On Thu, Jun 16, 2022 at 02:30:59PM -0700, Guoye Zhang wrote:
> Our previous resumable upload draft generated a lot of discussions.

At least in my case, I attempted to be polite after you submitted a
draft without first doing a survey of existing RFCs.  You admitted no
knowledge of WebDAV RFCs, which I deemed a large oversight considering
the nature of the tus-v2 protocol.

> I’m glad to announce that we have a new draft ready to address many feedbacks that suggested adopting the PATCH method.

The draft abstract begins with unsubstantiated claims to justify itself,
and I believe that almost all of those claims are also misleading.

"HTTP clients often encounter interrupted data transfers as a result of canceled requests or dropped connections. [...] it is often desirable to issue subsequent requests that transfer only the remainder of the representation."

The multiple uses of "often" are misrepresentations, IMHO.

A large percentage of HTTP requests are GET/HEAD and have no body.
A sizable percentage (if not more) of HTTP POST requests are small,
e.g. using POST as an alternative to GET along with XSRF tokens.

What data do you have to support the claims in the draft Abstract?
What percentage of requests have request bodies, and further have
request bodies that are sufficiently large that it is excessively
wasteful to resend the entire representation? (and when safe to do so!)

For high-quality wired networks, interrupted data transfers are less
common, though more possible over long-distance links.  For wireless
and mobile, interruptions may be more common, e.g. while uploading
pictures and videos.

Now, it is true that non-idempotent requests such as POST and PUT
are not generically safe to automatically retry upon failure.

If you are trying to come up with a generic solution to recover a
non-idempotent request, that should be more explicit and better scoped
in the draft than potentially extending multiple existing HTTP request
methods.  Such a goal would require specifying that a server not start
processing the upload in any non-idempotent way until the upload was
complete.  Other requirements might also be necessary.



Using WebDAV HTTP methods for upload:

I see two categories of targets for large uploads:
1. uploading to a target where the target is a resource
2. uploading to a target where the target is an endpoint
   (e.g. script which may process the upload)

The first is already possible using WebDAV (explained below, yet again).
The second can be implemented by an application, and IMHO should not
require any changes to HTTP servers and proxies.  More specifically,
tus-v2 should not require new resource management by HTTP servers and
proxies, instead delegating that management to specific user
applications.  Additionally, the second item might be implemented using
a similar WebDAV solution as the first:

RFC 9110 HTTP Semantics
14.5. Partial PUT
https://httpwg.org/specs/rfc9110.html#partial.PUT
notes that Partial PUT may be implemented by an HTTP server for some
resources.

lighttpd 1.4.65+ allows Partial PUT safely with config:
  webdav.opts += ("partial-put-copy-modify" => "enable")
This includes extending files.  (This is safe in earlier versions of
lighttpd, too, but only if the targets are uniquely named so as to
not possibly be in the process of being downloaded by other clients,
i.e. temporary files.)

Using lighttpd mod_webdav and the WebDAV protocol, a client can
incrementally upload to a temporary file, and then rename the file when
the upload is complete.  The client could also DELETE the temporary file
to cancel.

A client uploading to an endpoint might upload the request body to an
alternate location on the same server, and when the upload is complete,
send a request to the endpoint with a request header containing the path
to the completed upload of the request body.

Here is an example set of pseudo-HTTP requests, uploading a file in
256k chunks, and recovering from a disconnect:


LOCK /file.XXXXXX HTTP/1.1

201 Created
ETag: "aaaaaa"


PUT /file.XXXXXX HTTP/1.1
Content-Range: bytes 0-262143/262144
If-Match: "aaaaaa"

204 No Content
ETag: "bbbbbb"


PUT /file.XXXXXX HTTP/1.1
Content-Range: bytes 262144-524287/524288
If-Match: "bbbbbb"

<disconnect>


# (recovery resynchronization if disconnect occurs)

HEAD /file.XXXXXX HTTP/1.1

200 OK
Content-Length: 262144
ETag: "bbbbbb"


PUT /file.XXXXXX HTTP/1.1
Content-Range: bytes 262144-524287/524288
If-Match: "bbbbbb"

204 No Content
ETag: "cccccc"


# (... further PUT to append additional blocks ...)


# side-effect of MOVE does equivalent of UNLOCK /file.XXXXXX in lighttpd

MOVE /file.XXXXXX HTTP/1.1
Destination: /file

201 Created


> 2. Media types
>
> PATCH currently doesn’t define a media type. We went through the list of media types but couldn’t find the appropriate category for the Upload Appending Procedure. It is a generic byte-appending operation that can modify any types of media, so we don’t think it fits into an application media type.

If tus-v2 is going to use PATCH:
Why is tus-v2 not handled as PATCH with media-type application/tus-v2?
tus-v2 is an application protocol.  Content-Type: application/tus-v2
along with tus-v2 request headers would indicate how the request body is
treated by PATCH implementations, if they support application/tus-v2.


> 3. 1xx intermediate response
> 
> We surveyed the most popular HTTP libraries in many languages, and nearly all of them consider 1xx responses an internal signaling mechanism so they don’t expose the ability for applications to handle them. (We are also guilty of this as maintainers of URLSession API on Apple platforms.) If we use 1xx response for any critical information, it would prevent nearly all tus-v1 adopters to switch to this new protocol until it’s natively supported in HTTP libraries.

Multiple 1xx HTTP responses may be sent by an HTTP server before sending
the final HTTP response.  Not all existing HTTP servers support this,
and there may be security and resource implications.  lighttpd 1.4.56
and later forward 1xx responses from a backend to the client, but can be
configured to ignore 1xx responses (besides 101 Switching Protocols)
from backends if site security policy dictates.  In short, an
application behind lighttpd could send an additional "100 Continue"
with Upload-Token response header.

Client HTTP libraries already need to be extended to support tus-v2,
so would access to 1xx response headers be unworkable where a new 104
HTTP status would succeed?  If client HTTP libraries do not have a
callback or some other interface for applications to receive HTTP 1xx
intermediate responses, that would need to be added for tus-v2 feature
detection, wouldn't it?

> We think having just the feature detection part using 1xx response is a good balance, both eliminating any extra round trips for HTTP libraries implementing this protocol and allowing application adopters to ignore it.

For a sufficiently large upload, clients should send
  Expect: 100-continue
and the extra round-trip should be lost in the noise.
Also, there are many reasons for Expect: 100-continue,
among others: including verifying authn/authz, and upload size limits
(i.e. if the server will reject a very large Content-Length)
before beginning a large upload.

If the client also sent a hypothetical
  Upload-Token: .
then the origin server supporting resumable uploads could respond with
  100 Continue
  Upload-Token: /uri/path/to/file.XXXXXX
to indicate that it is storing the request body as a resource at that
location, and the client may query and extend it using WebDAV HTTP
methods should a disconnection occur.  There could be additional
headers which convey policy information such as how long the
Upload-Token is valid, i.e. how long the server may store the temporary
resource before deleting it.  To avoid clients abusing this temporary
storage and sharing the link with others, it may be advisable to limit
access to the upload path to HEAD, PUT (partial PUT), PATCH, OPTIONS,
and perhaps PROPFIND methods, and to reject GET, QUERY, and all other
methods.

If 100 Continue is not desirable for some reason, would it be possible to
repurpose the WebDAV RFC 2518 response status 102 Processing?
(removed in RFC 4918)
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
Why is a new status needed?  (104 Upload Resumption Supported)


I used "Upload-Token" above as that is in the tus draft, but it could be
named something else.  Also, the token could be an encrypted unique
identifier, and the client could query/resume a disconnected request by
providing the identifier to the endpoint along with request headers to
indicate resumed upload, e.g. the tus resumable uploads protocol but
application-specific, without the need for HTTP servers or proxies to
know about this optional protocol which has application-specific policy
for resource management of resumable uploads.


> there isn’t a straightforward to mechanically change the URI to distinguish between attempts.

Content-Location?


> Looking forward to continuing the discussions and refinements of the draft.

The draft fails to indicate why existing, standard WebDAV HTTP methods
are not sufficient.  I believe they are sufficient and have given
examples above.  The draft makes no mention of partial PUT and its
potential shortcomings compared to PATCH.  The draft does not
distinguish between uploading a resource -- for which WebDAV methods
are already a viable solution -- and uploading to an endpoint -- for
which WebDAV HTTP methods may be a viable solution.

I urge IETF reviewers to strongly recommend that the optional tus-v2
protocol be implementable by clients and server-side applications
without requiring new support beyond existing standards (e.g. 1xx
informational responses and WebDAV) from HTTP servers and proxies.

Thank you, Glenn