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.

Sign up for GitHub

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

Serve static pages from app.yaml #6974

Merged
merged 22 commits into from
Jul 6, 2019
Merged

Serve static pages from app.yaml #6974

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
0bc53bb
create render template method
jameesjohn Jun 19, 2019
df266a2
address review comments
jameesjohn Jun 21, 2019
8b63d34
Merge branch 'develop' of https://github.com/oppia/oppia into static-…
jameesjohn Jun 21, 2019
9106197
address review comments
jameesjohn Jun 21, 2019
6d2cdb9
fix error due to merge
jameesjohn Jun 21, 2019
77fc41d
address review comments
jameesjohn Jun 22, 2019
e3f24b7
serve statics files from app.yaml
jameesjohn Jun 23, 2019
fff201a
address review comments
jameesjohn Jun 24, 2019
9baa459
more on review comments and test issue
jameesjohn Jun 24, 2019
3458a6b
Merge branch 'develop' of https://github.com/oppia/oppia into static-…
jameesjohn Jun 29, 2019
6df30d8
add hases to files in app.yaml
jameesjohn Jun 29, 2019
a209b4e
Merge branch 'develop' of https://github.com/oppia/oppia into static-…
jameesjohn Jul 2, 2019
7ccbf19
create dev app.yaml and prod app.yaml as well as write tests for the …
jameesjohn Jul 3, 2019
04bd338
address review comments and revert package-lock.json
jameesjohn Jul 3, 2019
f27d23b
address review comments
jameesjohn Jul 4, 2019
c6617b5
revert change in constants
jameesjohn Jul 4, 2019
81922b9
remove app.yaml
jameesjohn Jul 4, 2019
9104bca
work on failing e2e tests
jameesjohn Jul 5, 2019
abddd81
fix lint issues
jameesjohn Jul 5, 2019
33c6f79
revert package-lock.json
jameesjohn Jul 5, 2019
d99be7c
Merge branch 'develop' of https://github.com/oppia/oppia into static-…
jameesjohn Jul 6, 2019
bd7eca5
remove other variants of splash page
jameesjohn Jul 6, 2019
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
65 changes: 48 additions & 17 deletions core/controllers/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import utils

from google.appengine.api import users
from google.appengine.ext.webapp import template
jameesjohn marked this conversation as resolved.
Show resolved Hide resolved
import webapp2

app_identity_services = models.Registry.import_app_identity_services()
Expand Down Expand Up @@ -282,6 +283,52 @@ def render_downloadable_file(self, values, filename, content_type):
'attachment; filename=%s' % filename)
self.response.write(values)

def prepare_headers(self, iframe_restriction):
"""Prepares the headers for a HTML response.
Args:
iframe_restriction: str or None. Possible values are
'DENY' and 'SAMEORIGIN':

DENY: Strictly prevents the template to load in an iframe.
SAMEORIGIN: The template can only be displayed in a frame
on the same origin as the page itself.
"""
self.response.cache_control.no_cache = True
self.response.cache_control.must_revalidate = True
self.response.headers['Strict-Transport-Security'] = (
'max-age=31536000; includeSubDomains')
self.response.headers['X-Content-Type-Options'] = 'nosniff'
self.response.headers['X-Xss-Protection'] = '1; mode=block'

if iframe_restriction is not None:
if iframe_restriction in ['SAMEORIGIN', 'DENY']:
self.response.headers['X-Frame-Options'] = str(
iframe_restriction)
else:
raise Exception(
'Invalid X-Frame-Options: %s' % iframe_restriction)

self.response.expires = 'Mon, 01 Jan 1990 00:00:00 GMT'
self.response.pragma = 'no-cache'
vojtechjelinek marked this conversation as resolved.
Show resolved Hide resolved


jameesjohn marked this conversation as resolved.
Show resolved Hide resolved
def render_static_template(self, filepath, iframe_restriction='DENY'):
"""Prepares a Jinja-less HTML response to be sent to the client.
Args:
filepath: str. The template filepath.
iframe_restriction: str or None. Possible values are
'DENY' and 'SAMEORIGIN':

DENY: Strictly prevents the template to load in an iframe.
SAMEORIGIN: The template can only be displayed in a frame
on the same origin as the page itself.
"""
self.prepare_headers(iframe_restriction)

path = os.path.join(
feconf.FRONTEND_TEMPLATES_DIR, filepath)
self.response.write(template.render(path, None))
Copy link
Member

Choose a reason for hiding this comment

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

Just wondering ... what does template.render do? Does it have any unnecessary overhead? Is there a reference link you can point to that says "this is the preferred way to serve static files"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think this is "the preferred way" to serve static files, but this is what was in the documentation and I expect that since it comes bundled with webapp, then it should have been optimized for the purpose.
https://webapp2.readthedocs.io/en/latest/tutorials/gettingstarted/templates.html

Copy link
Member

Choose a reason for hiding this comment

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

template.render is similar to rendering with jinja, but it uses Django templating instead, so I'm not sure it's what you want to do here if your aim is to serve the files statically.

If you do want to serve a file statically, then typically that is done in app.yaml -- see https://cloud.google.com/appengine/docs/standard/python/config/appref

Copy link
Member

Choose a reason for hiding this comment

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

(You might also want to try the three ways -- jinja render, django template.render, and app.yaml static rendering -- and compare their times.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

app.yaml - 42ms
Jinja render - 147ms
template.render - 119ms

So we should go with app.yaml, but how about the headers?


def render_template(self, filepath, iframe_restriction='DENY'):
"""Prepares an HTML response to be sent to the client.

Expand Down Expand Up @@ -331,23 +378,7 @@ def render_template(self, filepath, iframe_restriction='DENY'):
values['csrf_token'] = CsrfTokenManager.create_csrf_token(
self.user_id)

self.response.cache_control.no_cache = True
self.response.cache_control.must_revalidate = True
self.response.headers['Strict-Transport-Security'] = (
'max-age=31536000; includeSubDomains')
self.response.headers['X-Content-Type-Options'] = 'nosniff'
self.response.headers['X-Xss-Protection'] = '1; mode=block'

if iframe_restriction is not None:
if iframe_restriction in ['SAMEORIGIN', 'DENY']:
self.response.headers['X-Frame-Options'] = str(
iframe_restriction)
else:
raise Exception(
'Invalid X-Frame-Options: %s' % iframe_restriction)

self.response.expires = 'Mon, 01 Jan 1990 00:00:00 GMT'
self.response.pragma = 'no-cache'
self.prepare_headers(iframe_restriction)

self.response.write(
self.jinja2_env.get_template(filepath).render(**values))
Expand Down
8 changes: 4 additions & 4 deletions core/controllers/pages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ def get(self):
"""Handles GET requests."""
c_value = self.request.get('c')
if not c_value:
self.render_template('dist/splash-page.mainpage.html')
self.render_static_template('dist/splash-page.mainpage.html')
else:
try:
self.render_template('dist/splash_%s.html' % c_value)
self.render_static_template('dist/splash_%s.html' % c_value)
except Exception:
# Old c values may have been deprecated, in which case we
# revert to the default splash page URL. When redirecting,
Expand Down Expand Up @@ -62,7 +62,7 @@ class GetStartedPage(base.BaseHandler):
@acl_decorators.open_access
def get(self):
"""Handles GET requests."""
self.render_template('dist/get-started-page.mainpage.html')
self.render_static_template('dist/get-started-page.mainpage.html')


class TeachPage(base.BaseHandler):
Expand All @@ -71,7 +71,7 @@ class TeachPage(base.BaseHandler):
@acl_decorators.open_access
def get(self):
"""Handles GET requests."""
self.render_template('dist/teach-page.mainpage.html')
self.render_static_template('dist/teach-page.mainpage.html')


class ContactPage(base.BaseHandler):
Expand Down