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

Serve static pages from app.yaml #6974

Merged
merged 22 commits into from
Jul 6, 2019
Merged
Show file tree
Hide file tree
Changes from 17 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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,7 @@

# Speed Improvement team.
/app.yaml @vojtechjelinek @seanlip
/app_dev.yaml @vojtechjelinek @seanlip
/core/templates/dev/head/base_components/ @jamesjay4199 @vojtechjelinek
/core/templates/dev/head/pages/Base.ts @vojtechjelinek @seanlip
/core/templates/dev/head/pages/base.html @vojtechjelinek @seanlip
Expand Down
66 changes: 62 additions & 4 deletions app.yaml → app_dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -137,20 +137,78 @@ handlers:
login: admin
script: main_mail.app
secure: always

# STATIC PAGES.
- url: /get_started
static_files: core/templates/dev/head/dist/get-started-page.mainpage.html
upload: core/templates/dev/head/dist/get-started-page.mainpage.html
http_headers:
Pragma: no-cache
Strict-Transport-Security: "max-age=31536000; includeSubDomains"
X-Content-Type-Options: "nosniff"
X-Frame-Options: "DENY"
X-Xss-Protection: "1; mode=block"
secure: always
expiration: "0"
- url: /splash
static_files: core/templates/dev/head/dist/splash-page.mainpage.html
upload: core/templates/dev/head/dist/splash-page.mainpage.html
http_headers:
Pragma: no-cache
Strict-Transport-Security: "max-age=31536000; includeSubDomains"
X-Content-Type-Options: "nosniff"
X-Frame-Options: "DENY"
X-Xss-Protection: "1; mode=block"
secure: always
expiration: "0"
- url: /splash?c=at0
static_files: core/templates/dev/head/dist/splash_at0.html
upload: core/templates/dev/head/dist/splash_at0.html
http_headers:
Pragma: no-cache
Strict-Transport-Security: "max-age=31536000; includeSubDomains"
X-Content-Type-Options: "nosniff"
X-Frame-Options: "DENY"
X-Xss-Protection: "1; mode=block"
secure: always
expiration: "0"
- url: /splash?c=at1
static_files: core/templates/dev/head/dist/splash_at1.html
upload: core/templates/dev/head/dist/splash_at1.html
http_headers:
Pragma: no-cache
Strict-Transport-Security: "max-age=31536000; includeSubDomains"
X-Content-Type-Options: "nosniff"
X-Frame-Options: "DENY"
X-Xss-Protection: "1; mode=block"
secure: always
expiration: "0"
- url: /teach
static_files: core/templates/dev/head/dist/teach-page.mainpage.html
upload: core/templates/dev/head/dist/teach-page.mainpage.html
http_headers:
Pragma: no-cache
Strict-Transport-Security: "max-age=31536000; includeSubDomains"
X-Content-Type-Options: "nosniff"
X-Frame-Options: "DENY"
X-Xss-Protection: "1; mode=block"
secure: always
expiration: "0"

- url: /.*
script: main.app
secure: always

libraries:
- name: jinja2
version: '2.6'
version: "2.6"
- name: PIL
version: '1.1.7'
version: "1.1.7"
# This is needed for sending requests to a mailgun HTTPS URL.
- name: ssl
version: '2.7.11'
version: "2.7.11"
- name: webapp2
version: '2.5.2'
version: "2.5.2"

env_variables:
PYTHONHTTPSVERIFY: 1
Expand Down
4 changes: 2 additions & 2 deletions core/controllers/base_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,9 +341,9 @@ def mock_get_current_time(unused_cls):
def test_redirect_oppia_test_server(self):
# The old demo server redirects to the new demo server.
self.get_html_response(
'https://oppiaserver.appspot.com/splash', expected_status_int=301)
'https://oppiaserver.appspot.com/about', expected_status_int=301)
self.get_html_response(
'https://oppiatestserver.appspot.com/splash')
'https://oppiatestserver.appspot.com/about')


class EscapingTests(test_utils.GenericTestBase):
Expand Down
46 changes: 0 additions & 46 deletions core/controllers/pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,6 @@
import feconf


class SplashPage(base.BaseHandler):
"""Landing page for Oppia."""

@acl_decorators.open_access
def get(self):
"""Handles GET requests."""
c_value = self.request.get('c')
if not c_value:
self.render_template('dist/splash-page.mainpage.html')
else:
try:
self.render_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,
# we pass any arguments along (except the c_value).
arguments = self.request.arguments()
query_suffix = '&'.join([
'%s=%s' % (arg_name, self.request.get(arg_name))
for arg_name in arguments if arg_name != 'c'])

target_url = feconf.SPLASH_URL
if query_suffix:
target_url += '?%s' % query_suffix
self.redirect(target_url)
return


class AboutPage(base.BaseHandler):
"""Page with information about Oppia."""

Expand All @@ -56,24 +28,6 @@ def get(self):
self.render_template('dist/about-page.mainpage.html')


class GetStartedPage(base.BaseHandler):
"""Page with information about how to get started using Oppia."""

@acl_decorators.open_access
def get(self):
"""Handles GET requests."""
self.render_template('dist/get-started-page.mainpage.html')


class TeachPage(base.BaseHandler):
"""Page with information about how to teach on Oppia."""

@acl_decorators.open_access
def get(self):
"""Handles GET requests."""
self.render_template('dist/teach-page.mainpage.html')


class ContactPage(base.BaseHandler):
"""Page with information about how to contact Oppia."""

Expand Down
13 changes: 0 additions & 13 deletions core/controllers/pages_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,6 @@ def test_about_page(self):
response.mustcontain(
'<about-page></about-page>')

def test_splash_page_with_valid_c_value(self):
response = self.get_html_response('/splash', params={'c': 'at0'})
self.assertIn(
'Create fun interactive quizzes that students can do at home.',
response.body)

def test_splash_page_with_invalid_c_value_redirects(self):
response = self.get_html_response(
'/splash?data=value', params={'c': 'invalid'},
expected_status_int=302)
self.assertTrue(
response.headers['Location'].endswith('/splash?data=value'))

def test_maintenance_page(self):
fake_urls = []
fake_urls.append(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<base-content>
<content>
<div class="oppia-static-header">
<h1 translate="I18N_GET_STARTED_PAGE_HEADING"></h1>
<h1 translate="I18N_GET_STARTED_PAGE_HEADING" class="protractor-test-get-started-page"></h1>
</div>
<background-banner></background-banner>
<div class="oppia-page-card oppia-static-content oppia-static-content-below-banner">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<body>
<base-content>
<content>
<splash-page></splash-page>
<splash-page class="protractor-test-splash-page"></splash-page>
</content>
</base-content>

Expand Down
2 changes: 1 addition & 1 deletion core/templates/dev/head/pages/splash-page/splash_at0.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<body>
<base-content>
<content>
<div ng-controller="Splash">
<div ng-controller="Splash" class="protractor-test-splash-page">
<div class="oppia-splash-section-one text-center">
<h1 class="oppia-splash-h1" style="max-width: 800px; font-size: 2.3em; line-height: 1.5em; padding-bottom: 0.5em;">Lesson plans aren't just for the schoolday</h1>

Expand Down
2 changes: 1 addition & 1 deletion core/templates/dev/head/pages/splash-page/splash_at1.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<body>
<base-content>
<content>
<div ng-controller="Splash">
<div ng-controller="Splash" class="protractor-test-splash-page">
<div class="oppia-splash-section-one text-center">
<h1 class="oppia-splash-h1" style="max-width: 800px; font-size: 2.3em; line-height: 1.5em; padding-bottom: 0.5em;">Tired of the same lesson plans?</h1>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<body>
<base-content>
<navbar-breadcrumb>
<ul class="nav navbar-nav oppia-navbar-breadcrumb">
<ul class="nav navbar-nav oppia-navbar-breadcrumb protractor-test-teach-page">
<li>
<span class="oppia-navbar-breadcrumb-separator"></span>
Teach with Oppia
Expand Down
26 changes: 26 additions & 0 deletions core/tests/protractor_desktop/navigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,32 @@ describe('Oppia static pages tour', function() {
waitFor.pageToFullyLoad();
});

it('visits the Get started page', function() {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@seanlip, the tests are here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

PTAL

Copy link
Member

Choose a reason for hiding this comment

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

Can you assert for something that should exist in the page (to make sure it's not serving a 404)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

browser.get('/get_started');
waitFor.pageToFullyLoad();
expect(element(by.css('.protractor-test-get-started-page'))).toBe(true);
});

it('visits the Teach page', function() {
browser.get('/teach');
waitFor.pageToFullyLoad();
expect(element(by.css('.protractor-test-teach-page'))).toBe(true);
});

it('visits the Splash pages', function() {
browser.get('/splash');
waitFor.pageToFullyLoad();
expect(element(by.css('.protractor-test-splash-page'))).toBe(true);

browser.get('/splash?c=at0');
waitFor.pageToFullyLoad();
expect(element(by.css('.protractor-test-splash-page'))).toBe(true);

browser.get('/splash?c=at1');
waitFor.pageToFullyLoad();
expect(element(by.css('.protractor-test-splash-page'))).toBe(true);
});

afterEach(function() {
general.checkForConsoleErrors([
// TODO (Jacob) Remove when
Expand Down
3 changes: 0 additions & 3 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,12 +179,9 @@ def ui_access_wrapper(self, *args, **kwargs):
get_redirect_route(r'/_ah/warmup', WarmupPage),
get_redirect_route(r'/', HomePageRedirectPage),

get_redirect_route(feconf.SPLASH_URL, pages.SplashPage),
get_redirect_route(r'/about', pages.AboutPage),
get_redirect_route(r'/get_started', pages.GetStartedPage),
get_redirect_route(r'/foundation', pages.FoundationRedirectPage),
get_redirect_route(r'/credits', pages.AboutRedirectPage),
get_redirect_route(r'/teach', pages.TeachPage),
get_redirect_route(r'/participate', pages.TeachRedirectPage),
get_redirect_route(r'/site_guidelines', pages.TeachRedirectPage),
get_redirect_route(r'/console_errors', pages.ConsoleErrorPage),
Expand Down
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 28 additions & 1 deletion scripts/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,20 @@
# hash).
# This is because these files don't need cache invalidation, are referenced
# from third party files or should not be moved to the build directory.
# Statically served pages from app.yaml should be here to since they don't
# need cache invalidation.
FILEPATHS_NOT_TO_RENAME = (
'*.py',
'third_party/generated/fonts/*',
'third_party/generated/js/third_party.min.js.map',
'third_party/generated/webfonts/*',
'*.bundle.js',
'*.bundle.js.map')
'*.bundle.js.map',
'*/dist/get-started-page.mainpage.html',
Copy link
Member

Choose a reason for hiding this comment

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

Update the comment to explain why these files are present.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

'*/dist/splash-page.mainpage.html',
'*/dist/splash_at0.html',
'*/dist/splash_at1.html',
'*/dist/teach-page.mainpage.html')

# Hashes for files with these paths should be provided to the frontend in
# JS hashes object.
Expand All @@ -122,6 +129,25 @@
HASH_BLOCK_SIZE = 2**20


def generate_app_yaml():
"""Generate app.yaml from app_dev.yaml."""
dev_file_prefix = 'core/templates/dev/head'
prod_file_prefix = 'build/templates/head'
content = '# THIS FILE IS AUTOGENERATED, DO NOT MODIFY\n'
with open('app_dev.yaml', 'r') as yaml_file:
content += yaml_file.read()
for file_path in FILEPATHS_NOT_TO_RENAME:
if '/dist/' in file_path:
content = content.replace(
dev_file_prefix + file_path[1:],
prod_file_prefix + file_path[1:])
content = content.replace('version: default', '')
if os.path.isfile('app.yaml'):
os.remove('app.yaml')
with open('app.yaml', 'w+') as prod_yaml_file:
prod_yaml_file.write(content)


def require_compiled_js_dir_to_be_valid():
"""Checks if COMPILED_JS_DIR matches the output directory used in
TSCONFIG_FILEPATH.
Expand Down Expand Up @@ -1302,6 +1328,7 @@ def build():
if options.prod_mode:
build_using_webpack()
minify_third_party_libs(THIRD_PARTY_GENERATED_DEV_DIR)
generate_app_yaml()
if not options.minify_third_party_libs_only:
generate_build_directory()

Expand Down
Loading