Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add legacy GCF Python 3.7 behavior #77

Merged
merged 3 commits into from
Aug 17, 2020
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
13 changes: 13 additions & 0 deletions src/functions_framework/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,19 @@ def create_app(target=None, source=None, signature_type=None):
app = flask.Flask(target, template_folder=template_folder)
app.config["MAX_CONTENT_LENGTH"] = MAX_CONTENT_LENGTH

# 6. Handle legacy GCF Python 3.7 behavior
if os.environ.get("ENTRY_POINT"):
os.environ["FUNCTION_TRIGGER_TYPE"] = signature_type
os.environ["FUNCTION_NAME"] = os.environ.get("K_SERVICE", target)
Comment on lines +179 to +180
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this raises some questions about how the environment variables should be handled in the 3.7 buildpack runtime. This has the effect of setting some of them, which is good... but why these? Should we be setting all of them?

Furthermore, should we set FUNCTION_TRIGGER_TYPE and FUNCTION_NAME for 3.8 as well? It would make it easier for users to migrate from 3.7 to 3.8.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The remaining env vars don't have an equivalent in newer GCF runtimes, so they have to be set outside of the functions framework/buildpack.

For the second question, there was precedent in the nodejs8 -> nodejs10 transition, where the older env vars were dropped. To prevent carrying on the tech debt I think they should not be available in Python 3.8.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take this discussion elsewhere 🙂

app.make_response_original = app.make_response

def handle_none(rv):
if rv is None:
rv = "OK"
return app.make_response_original(rv)

app.make_response = handle_none

# Extract the target function from the source file
try:
function = getattr(source_module, target)
Expand Down
40 changes: 40 additions & 0 deletions tests/test_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import pathlib
import re
import time
Expand Down Expand Up @@ -455,3 +456,42 @@ def test_class_in_main_is_in_right_module():
resp = client.get("/")

assert resp.status_code == 200


def test_function_returns_none():
source = TEST_FUNCTIONS_DIR / "returns_none" / "main.py"
target = "function"

client = create_app(target, source).test_client()
resp = client.get("/")

assert resp.status_code == 500


def test_legacy_function_check_env(monkeypatch):
source = TEST_FUNCTIONS_DIR / "http_check_env" / "main.py"
target = "function"

monkeypatch.setenv("ENTRY_POINT", target)

client = create_app(target, source).test_client()
resp = client.post("/", json={"mode": "FUNCTION_TRIGGER_TYPE"})
assert resp.status_code == 200
assert resp.data == b"http"

resp = client.post("/", json={"mode": "FUNCTION_NAME"})
assert resp.status_code == 200
assert resp.data.decode("utf-8") == target


def test_legacy_function_returns_none(monkeypatch):
source = TEST_FUNCTIONS_DIR / "returns_none" / "main.py"
target = "function"

monkeypatch.setenv("ENTRY_POINT", target)

client = create_app(target, source).test_client()
resp = client.get("/")

assert resp.status_code == 200
assert resp.data == b"OK"
27 changes: 27 additions & 0 deletions tests/test_functions/returns_none/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright 2020 Google 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.


def function(request):
"""Test HTTP function when using legacy GCF behavior.

The function returns None, which should be a 200 response.

Args:
request: The HTTP request which triggered this function.

Returns:
None.
"""
return None