Merge ~pushkarnk/ubuntu/+source/onionshare:werkzeug-3.0.1-compat into ubuntu/+source/onionshare:ubuntu/devel

[Pushkar Kulkarni]

While the next release of onionshare is awaited, I propose this patch to achieve API compatibility with the python3-werkzeug dependency (which is currently stuck in -proposed). All of the autopkgtests fail without this patch. This patch is derived out of and is a small subset of [1].

Built in PPA: https://launchpad.net/~pushkarnk/+archive/ubuntu/merges-ppa/+build/27656381

[1] https://github.com/onionshare/onionshare/pull/1677

[Pushkar Kulkarni (pushkarnk)]

$ autopkgtest --apt-upgrade --shell-fail --apt-pocket=proposed=src:python3-werkzeug --output-dir output-os ./onionshare ./onionshare-cli_2.6-5~ppa1_all.deb -- lxd autopkgtest/ubuntu/noble/amd64
...
...
...
autopkgtest [19:58:05]: @@@@@@@@@@@@@@@@@@@@ summary
onionshare-cli_help PASS (superficial)
share_files PASS
receive_files PASS
share_website PASS
chat_server PASS
onionshare_help PASS (superficial)

[Sergio Durigan Junior (sergiodj)]

Thanks for the MP.

Could you please add DEP-3 headers to the patch you're adding? It's really helpful, especially when we need to determine why a delta has been introduced.

Also, it would be great if you could submit this patch to Debian as well. This will benefit them and us. You can submit a Merge Request here: https://salsa.debian.org/pkg-privacy-team/onionshare

Thanks.

review: Needs Fixing

0d8707d... by Pushkar Kulkarni on 2024-01-23

Add DEP3 header to the patch

[Pushkar Kulkarni (pushkarnk)]

Thanks for the review comments.

Update:

 - Created a Debian bug report [1] and MR [2].
 - Added a DEP3 header to the patch in this MP.

[1] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1061360
[2] https://salsa.debian.org/pkg-privacy-team/onionshare/-/merge_requests/3

[Robie Basak (racb)]

Thank you for working on this!

Same comment about the Origin: dep3 header: I had to do some investigation to identify that it's upstream commit 9a19c471 that actually landed upstream, though in this case it looks unmodified from the commit provided in the PR. It would be helpful to link to this directly from the DEP3 headers (though a link to the upstream PR is also helpful!).

I can see that you've taken a subset of these changes and that's fine.

How are you validating that this is sufficient to get onionshare working correctly against the newer werkzeug? I see that this is a GUI app. Have you tried running it or are you relying on autopkgtests alone? If the latter and given the nature of the necessary changes, how are we sure that we haven't missed something?

review: Needs Information

24cb13e... by Pushkar Kulkarni on 2024-01-25

Update DEP3 header with upstream commit URL

[Pushkar Kulkarni (pushkarnk)]

> Thank you for working on this!
>

Thanks for the detailed review!

> Same comment about the Origin: dep3 header: I had to do some investigation to
> identify that it's upstream commit 9a19c471 that actually landed upstream,
> though in this case it looks unmodified from the commit provided in the PR. It
> would be helpful to link to this directly from the DEP3 headers (though a link
> to the upstream PR is also helpful!).
>

I've updated the DEP3 header with the commit link.

> I can see that you've taken a subset of these changes and that's fine.
>
> How are you validating that this is sufficient to get onionshare working
> correctly against the newer werkzeug? I see that this is a GUI app. Have you
> tried running it or are you relying on autopkgtests alone? If the latter and
> given the nature of the necessary changes, how are we sure that we haven't
> missed something?

No, I solely depended on the autopkgtests which run the upstream unit tests (I guess all of them, but I'd need some time to confirm that). This change goes into the cli component and is specific to change in the url API only. So, I didn't consider any further testing, though the thought crossed my mind!

That brings me to a question: while patching upstream packages is passing the upstream unit/regression test suite considered as a sufficient condition for submitting the patch?

[Pushkar Kulkarni (pushkarnk)]

I just realized that Debian merged the MR for onionshare [1].

[1] https://github.com/onionshare/onionshare/commit/9a19c47185289676e86f8bce1f0d54c941500da3

[Lukas Märdian (slyon)]

Removing ~ubuntu-sponsors and adding a "Dissaprove", as the relevant changes have been included in onionshare 2.6-6 https://launchpad.net/ubuntu/+source/onionshare/2.6-6 as sync'ed from experimental.

python-werkzeug 3.0 migrated in the meantime.

review: Disapprove

Unmerged commits

24cb13e... by Pushkar Kulkarni on 2024-01-25

Update DEP3 header with upstream commit URL

0d8707d... by Pushkar Kulkarni on 2024-01-23

Add DEP3 header to the patch

3b27927... by Pushkar Kulkarni on 2024-01-18

Update changelog

f77fe37... by Pushkar Kulkarni on 2024-01-18

Update maintainer

c8b4ed8... by Pushkar Kulkarni on 2024-01-18

Add patch for compatibility with werkzeug 3.0.1

diff --git a/debian/changelog b/debian/changelog
index 9715c6d..02de1e4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+onionshare (2.6-5ubuntu1) noble; urgency=medium
+
+  * d/patches: Add patch for compatibility with the werkzeug 3.0.1 API (LP: #2048769)
+
+ -- Pushkar Kulkarni <[e-mail]>  Thu, 18 Jan 2024 20:49:43 +0530
+
 onionshare (2.6-5) unstable; urgency=medium
 
   * Install desktp/appmetadata at expected places. (Closes: #1036691)
diff --git a/debian/control b/debian/control
index 01a6f26..e4ae94d 100644
--- a/debian/control
+++ b/debian/control
@@ -1,5 +1,6 @@
 Source: onionshare
-Maintainer: Debian Privacy Tools Maintainers <[e-mail]>
+Maintainer: Ubuntu Developers <[e-mail]>
+XSBC-Original-Maintainer: Debian Privacy Tools Maintainers <[e-mail]>
 Uploaders:
  anonym <[e-mail]>,
  Clément Hermann <[e-mail]>
diff --git a/debian/patches/series b/debian/patches/series
index b322fad..56536ac 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
 0001-Make-it-compatible-with-Flask-version-inside-Debian.patch
+werkzeug-3.0.1-compat.patch
diff --git a/debian/patches/werkzeug-3.0.1-compat.patch b/debian/patches/werkzeug-3.0.1-compat.patch
new file mode 100644
index 0000000..4d609bd
--- /dev/null
+++ b/debian/patches/werkzeug-3.0.1-compat.patch
@@ -0,0 +1,46 @@
+From: Pushkar Kulkarni <[e-mail]>
+Description: Adapt onionshare to the python-werkzeug 3.0.1 API
+  This patch cherry-picks a small part of an upstream pull-request,
+  something relevant to the werkzeug API compatibility only.
+Origin: upstream, https://github.com/onionshare/onionshare/commit/9a19c47185289676e86f8bce1f0d54c941500da3
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/onionshare/+bug/2048769 
+--- a/cli/onionshare_cli/web/send_base_mode.py
++++ b/cli/onionshare_cli/web/send_base_mode.py
+@@ -25,7 +25,7 @@
+ import gzip
+ from flask import Response, request
+ from unidecode import unidecode
+-from werkzeug.urls import url_quote
++from urllib.parse import quote
+ 
+ 
+ class SendBaseModeWeb:
+@@ -284,7 +284,7 @@
+         r.headers.set("Content-Length", filesize)
+         filename_dict = {
+             "filename": unidecode(basename),
+-            "filename*": "UTF-8''%s" % url_quote(basename),
++            "filename*": "UTF-8''%s" % quote(basename),
+         }
+         r.headers.set("Content-Disposition", "inline", **filename_dict)
+         (content_type, _) = mimetypes.guess_type(basename, strict=False)
+--- a/cli/onionshare_cli/web/share_mode.py
++++ b/cli/onionshare_cli/web/share_mode.py
+@@ -29,7 +29,7 @@
+ from flask import Response, request, render_template, make_response, abort
+ from unidecode import unidecode
+ from werkzeug.http import parse_date, http_date
+-from werkzeug.urls import url_quote
++from urllib.parse import quote
+ 
+ from .send_base_mode import SendBaseModeWeb
+ 
+@@ -233,7 +233,7 @@
+             r.headers.set("Content-Length", range_[1] - range_[0] + 1)
+             filename_dict = {
+                 "filename": unidecode(basename),
+-                "filename*": "UTF-8''%s" % url_quote(basename),
++                "filename*": "UTF-8''%s" % quote(basename),
+             }
+             r.headers.set("Content-Disposition", "attachment", **filename_dict)
+             # guess content type