Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,16 @@ def __init__(self):

self.properties = {"responseheaderdictionary" : { "type": "dict"} }

# A copy of the SetHeader properties of the first Pipeline found to
# have any, for code that reads them. Processing does not use it.
self.setheader_properties = {}

# The SetHeader properties of each Pipeline the element processes
# for, keyed by the Pipeline, as each Pipeline holds its own
# elements. Each value is what get_setheader_properties_pipeline
# returns for that Pipeline. The element already holds each Pipeline
# it is added to in pipelines, so the keys keep none alive longer.
self._setheader_properties_by_pipeline = {}

self.exclude_from_messages = True

Expand All @@ -69,10 +78,25 @@ def process_internal(self, flowdata):

"""

if not self.setheader_properties:
self.setheader_properties = self.get_setheader_properties_pipeline(flowdata.pipeline)

response_headers = self.get_response_header_value(flowdata, self.setheader_properties)
# An empty list is built again on the next request, because a cloud
# engine has no properties until the cloud service answers. Requests
# that build a list at the same time build the same one, so either
# may be kept.
pipeline = flowdata.pipeline
setheader_properties = self._setheader_properties_by_pipeline.get(
pipeline)
if not setheader_properties:
setheader_properties = self.get_setheader_properties_pipeline(
pipeline)
self._setheader_properties_by_pipeline[pipeline] = (
setheader_properties)
if setheader_properties and not self.setheader_properties:
self.setheader_properties = {
datakey: list(names)
for datakey, names in setheader_properties.items()}

response_headers = self.get_response_header_value(
flowdata, setheader_properties)

data = ElementDataDictionary(self, {"responseheaderdictionary": response_headers})

Expand Down
97 changes: 97 additions & 0 deletions pipeline/fiftyone_pipeline_core/tests/test_setheader.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
from fiftyone_pipeline_core.messages import Messages
from fiftyone_pipeline_core.web import *
from fiftyone_pipeline_core.aspectproperty_value import AspectPropertyValue
from fiftyone_pipeline_core.elementdata_dictionary import ElementDataDictionary
from fiftyone_pipeline_core.flowelement import FlowElement
from fiftyone_pipeline_core.pipeline import Pipeline
from fiftyone_pipeline_core.setheaderelement import SetHeaderElement

from .classes.testpipeline import TestPipeline
Expand Down Expand Up @@ -140,3 +143,97 @@ class Pipeline(object):
self.assertEqual(
{"device": ["SetHeaderBrowserAccept-CH"]},
SetHeaderElement().get_setheader_properties_pipeline(Pipeline()))


# An element with one property for a response header, whose value is the
# header's value.
class HeaderSourceElement(FlowElement):

def __init__(self, datakey, property_name, value):
super(HeaderSourceElement, self).__init__()
self.datakey = datakey
self.property_name = property_name
self.value = value
self.properties = {
property_name: {"name": property_name, "type": "string"}}

def process_internal(self, flowdata):
flowdata.set_element_data(ElementDataDictionary(
self,
{self.property_name: AspectPropertyValue(value=self.value)}))


def response_headers(pipeline):
flowdata = pipeline.create_flowdata()
flowdata.process()
return flowdata["set-headers"]["responseheaderdictionary"]


BROWSER_HEADERS = {"Accept-CH": Constants.ACCEPTCH_BROWSER_VALUE}
PLATFORM_HEADERS = {"Critical-CH": Constants.ACCEPTCH_PLATFORM_VALUE}


# The multi-pipeline elements specification says an element that keeps
# state for the Pipeline it is in keeps that state for each Pipeline it is
# added to. One Set Headers Element is shared by two Pipelines whose other
# elements give different SetHeader properties.
class SetHeaderMultiPipelineTests(unittest.TestCase):

def setUp(self):
self.set_headers = set_headers = SetHeaderElement()
# The Pipelines share an element, so neither closes its elements.
self.pipelines = {
"browser": Pipeline(
[HeaderSourceElement(
"browser", "SetHeaderBrowserAccept-CH",
Constants.ACCEPTCH_BROWSER_VALUE),
set_headers],
auto_close_elements=False),
"platform": Pipeline(
[HeaderSourceElement(
"platform", "SetHeaderPlatformCritical-CH",
Constants.ACCEPTCH_PLATFORM_VALUE),
set_headers],
auto_close_elements=False)}
self.expected = {
"browser": BROWSER_HEADERS, "platform": PLATFORM_HEADERS}

# Each Pipeline gives the headers of its own elements, whichever
# processes first, and keeps doing so after the other has processed.
@parameterized.expand([
("browser_first", ["browser", "platform"]),
("platform_first", ["platform", "browser"])])
def test_each_pipeline_gives_its_own_headers(self, _, order):
for name in order + order:
self.assertEqual(
self.expected[name], response_headers(self.pipelines[name]),
name)

# setheader_properties holds the SetHeader properties of the first
# Pipeline that processed, as a dict of data key to property names, for
# code that reads it.
def test_setheader_properties_holds_the_first_pipelines_properties(self):
response_headers(self.pipelines["browser"])
response_headers(self.pipelines["platform"])
self.assertEqual(
{"browser": ["SetHeaderBrowserAccept-CH"]},
self.set_headers.setheader_properties)

def test_one_pipeline_gives_the_same_headers_on_every_request(self):
for _ in range(3):
self.assertEqual(
BROWSER_HEADERS, response_headers(self.pipelines["browser"]))

# A cloud engine has no properties until the cloud service has
# answered, so a Pipeline whose SetHeader properties are not known on
# its first request gives the headers once they are.
def test_headers_are_given_once_the_properties_are_known(self):
source = HeaderSourceElement(
"browser", "SetHeaderBrowserAccept-CH",
Constants.ACCEPTCH_BROWSER_VALUE)
properties = source.properties
source.properties = {}
pipeline = Pipeline([source, SetHeaderElement()])
self.assertEqual({}, response_headers(pipeline))
source.properties = properties
self.assertEqual(BROWSER_HEADERS, response_headers(pipeline))
Loading