Merge lp:~leonardr/launchpad/understand-mod-compress into lp:launchpad

[Leonard Richardson]

This branch installs a new version of lazr.restful into Launchpad (the one defined by https://code.edge.launchpad.net/~leonardr/lazr.restful/understand-mod-compress) and adds tests to ensure that Launchpad's web service will correctly handle incoming ETags that were silently modified by mod_compress on the way out.

[Aaron Bentley (abentley)]

In the doc, the header should have two blank lines above it.

Since the difference between "foo-gzip" and "foo"-gzip is subtle, please provide the two forms side-by-side, e.g:
mod_compress may turn '"foo"' into '"foo"-gzip'

You use "info" where you mean "into".

Other than that, this looks fine.

review: Approve

=== modified file 'lib/canonical/launchpad/pagetests/webservice/conditional-write.txt'
--- lib/canonical/launchpad/pagetests/webservice/conditional-write.txt	2010-03-17 14:46:16 +0000
+++ lib/canonical/launchpad/pagetests/webservice/conditional-write.txt	2010-05-19 17:49:32 +0000
@@ -101,3 +101,39 @@
 resource, the later one still gets a 412 error. If an unwritable field
 changes, a conditional read will fail, but a conditional write will
 succeed, even though the ETags don't match exactly.
+
+
+It's okay if mod_compress modifies outgoing ETags
+=================================================
+
+Here's another way non-identical ETags may be treated as the
+same. Apache's mod_compress modifies outgoing ETags when it compresses
+the representations. Launchpad's web service will treat an ETag
+modified by mod_compress as though it were the original ETag.
+
+  >>> etag = webservice.get(url).jsonBody()['http_etag']
+
+  >>> headers = {'If-None-Match': etag}
+  >>> print webservice.get(url, headers=headers)
+  HTTP/1.1 304 Not Modified
+  ...
+
+Some versions of mod_compress turn '"foo"' into '"foo"-gzip', and some
+versions turn it into '"foo-gzip"'. We treat all three forms the same.
+
+  >>> headers = {'If-None-Match': etag + "-gzip"}
+  >>> print webservice.get(url, headers=headers)
+  HTTP/1.1 304 Not Modified
+  ...
+
+  >>> headers = {'If-None-Match': etag[:-1] + "-gzip" + etag[-1]}
+  >>> print webservice.get(url, headers=headers)
+  HTTP/1.1 304 Not Modified
+  ...
+
+Any other modification to the ETag is treated as a distinct ETag.
+
+  >>> headers = {'If-None-Match': etag + "-not-gzip"}
+  >>> print webservice.get(url, headers=headers)
+  HTTP/1.1 200 Ok
+  ...

=== modified file 'lib/canonical/launchpad/rest/configuration.py'
--- lib/canonical/launchpad/rest/configuration.py	2010-03-11 20:53:58 +0000
+++ lib/canonical/launchpad/rest/configuration.py	2010-05-19 17:49:32 +0000
@@ -26,7 +26,7 @@
     active_versions = ["beta", "1.0", "devel"]
     last_version_with_mutator_named_operations = "beta"
     view_permission = "launchpad.View"
-    set_hop_by_hop_headers = True
+    compensate_for_mod_compress_etag_modification = True
 
     service_description = """The Launchpad web service allows automated
         clients to access most of the functionality available on the

=== modified file 'lib/lp/bugs/stories/webservice/xx-bug.txt'
--- lib/lp/bugs/stories/webservice/xx-bug.txt	2010-04-29 17:49:19 +0000
+++ lib/lp/bugs/stories/webservice/xx-bug.txt	2010-05-19 17:49:32 +0000
@@ -271,7 +271,7 @@
   ...     content='This is a new message added through the webservice API.')
   HTTP/1.1 201 Created...
   Content-Length: 0
-  Content-Type: text/plain
+  ...
   Location: http://api.launchpad.dev/beta/firefox/+bug/5/comments/1
   ...
 
@@ -290,7 +290,7 @@
   ...     content='This is a new message with no subject.')
   HTTP/1.1 201 Created...
   Content-Length: 0
-  Content-Type: text/plain
+  ...
   Location: http://api.launchpad.dev/beta/firefox/+bug/5/comments/2
   ...
 
@@ -1071,7 +1071,6 @@
   >>> print response
   HTTP/1.1 400 Bad Request...
   Content-Length: 47
-  Content-Type: text/plain
   ...
   <BLANKLINE>
   url: You tried to modify a read-only attribute.
@@ -1087,7 +1086,7 @@
   >>> print response
   HTTP/1.1 201 Created...
   Content-Length: 0
-  Content-Type: text/plain
+  ...
   Location: http://.../bugs/1/+watch/13
   ...
 
@@ -1150,7 +1149,7 @@
   >>> print response
   HTTP/1.1 301 Moved Permanently...
   Content-Length: 0
-  Content-Type: text/plain
+  ...
   Location: http://.../bugs/bugtrackers/bob
   ...
 
@@ -1160,7 +1159,7 @@
   >>> print webservice.get(bug_tracker['self_link'])
   HTTP/1.1 404 Not Found...
   Content-Length: ...
-  Content-Type: text/plain
+  ...
   X-Lazr-Oopsid: OOPS-...
   <BLANKLINE>
   Object: <...BugTrackerSet object at ...>, name: u'mozilla.org'
@@ -1233,7 +1232,7 @@
   >>> print response
   HTTP/1.1 201 Created...
   Content-Length: 0
-  Content-Type: text/plain
+  ...
   Location: http://.../bugs/1/+attachment/1
   ...
 

=== modified file 'versions.cfg'
--- versions.cfg	2010-05-10 21:46:36 +0000
+++ versions.cfg	2010-05-19 17:49:32 +0000
@@ -28,7 +28,7 @@
 lazr.delegates = 1.1.0
 lazr.enum = 1.1.2
 lazr.lifecycle = 1.1
-lazr.restful = 0.9.25
+lazr.restful = 0.9.26
 lazr.restfulclient = 0.9.14
 lazr.smtptest = 1.1
 lazr.testing = 0.1.1