8825c9c74a
Enhance internally logged messages to report referer and user-agent.
Pass the referering URL and METHOD between internal servers (when
known), and set the user-agent to be the server type (obj-server,
container-server, proxy-server, obj-updater, obj-replicator,
container-updater, direct-client, etc.) with the process PID. In
conjunction with the transaction ID, it helps to track down which PID
from a given system was responsible for initiating the request and
what that server was working on to make this request.
This has been helpful in tracking down interactions between object,
container and account servers.
We also take things a bit further performaing a bit of refactoring to
consolidate calls to transfer_headers() now that we have a helper
method for constructing them.
Finally we performed further changes to avoid header key duplication
due to string literal header key values and the various objects
representing headers for requests and responses. See below for more
details.
====
Header Keys
There seems to be a bit of a problem with the case of the various
string literals used for header keys and the interchangable way
standard Python dictionaries, HeaderKeyDict() and HeaderEnvironProxy()
objects are used.
If one is not careful, a header object of some sort (one that does not
normalize its keys, and that is not necessarily a dictionary) can be
constructed containing header keys which differ only by the case of
their string literals. E.g.:
{ 'x-trans-id': '1234', 'X-Trans-Id': '5678' }
Such an object, when passed to http_connect() will result in an
on-the-wire header where the key values are merged together, comma
separated, that looks something like:
HTTP_X_TRANS_ID: 1234,5678
For some headers in some contexts, this is behavior is desirable. For
example, one can also use a list of tuples which enumerate the multiple
values a single header should have.
However, in almost all of the contexts used in the code base, this is
not desirable.
This behavior arises from a combination of factors:
1. Header strings are not constants and different lower-case and
title-case header strings values are used interchangably in the
code at times
It might be worth the effort to make a pass through the code to
stop using string literals and use constants instead, but there
are plusses and minuses to doing that, so this was not attempted
in this effort
2. HeaderEnvironProxy() objects report their keys in ".title()"
case, but normalize all other key references to the form
expected by the Request class's environ field
swob.Request.headers fields are HeaderEnvironProxy() objects.
3. HeaderKeyDict() objects report their keys in ".lower()" case,
and normalize all other key references to ".lower()" case
swob.Response.headers fields are HeaderKeyDict() objects.
Depending on which object is used and how it is used, one can end up
with such a mismatch.
This commit takes the following steps as a (PROPOSED) solution:
1. Change HeaderKeyDict() to normalize using ".title()" case to
match HeaderEnvironProxy()
2. Replace standard python dictionary objects with HeaderKeyDict()
objects where possible
This gives us an object that normalizes key references to avoid
fixing the code to normalize the string literals.
3. Fix up a few places to use title case string literals to match
the new defaults
Change-Id: Ied56a1df83ffac793ee85e796424d7d20f18f469
Signed-off-by: Peter Portante <peter.portante@redhat.com>
59 lines
1.8 KiB
Python
59 lines
1.8 KiB
Python
# Copyright (c) 2010-2012 OpenStack, LLC.
|
|
#
|
|
# Licensed 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.
|
|
|
|
# TODO: Tests
|
|
|
|
import unittest
|
|
import os
|
|
|
|
from swift.common import direct_client
|
|
|
|
|
|
class TestDirectClient(unittest.TestCase):
|
|
|
|
def test_quote(self):
|
|
res = direct_client.quote('123')
|
|
assert res == '123'
|
|
res = direct_client.quote('1&2&/3')
|
|
assert res == '1%262%26/3'
|
|
res = direct_client.quote('1&2&3', safe='&')
|
|
assert res == '1&2&3'
|
|
|
|
def test_gen_headers(self):
|
|
hdrs = direct_client.gen_headers()
|
|
assert 'user-agent' in hdrs
|
|
assert hdrs['user-agent'] == 'direct-client %s' % os.getpid()
|
|
assert len(hdrs.keys()) == 1
|
|
|
|
hdrs = direct_client.gen_headers(add_ts=True)
|
|
assert 'user-agent' in hdrs
|
|
assert 'x-timestamp' in hdrs
|
|
assert len(hdrs.keys()) == 2
|
|
|
|
hdrs = direct_client.gen_headers(hdrs_in={'foo-bar': '47'})
|
|
assert 'user-agent' in hdrs
|
|
assert 'foo-bar' in hdrs
|
|
assert hdrs['foo-bar'] == '47'
|
|
assert len(hdrs.keys()) == 2
|
|
|
|
hdrs = direct_client.gen_headers(hdrs_in={'user-agent': '47'})
|
|
assert 'user-agent' in hdrs
|
|
assert hdrs['user-agent'] == 'direct-client %s' % os.getpid()
|
|
assert len(hdrs.keys()) == 1
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|