oppia · seanlip · Jul 23, 2016 · Jul 2, 2016 · Jul 3, 2016 · Jul 3, 2016
@@ -14,3 +14,8 @@ venv/
 .DS_Store
 .idea
 .vagrant/*
+
+# Oppia uses cache slugs for various resources and we need separate resource
+# directories for dev and prod. Resource directories for prod are generated
+# via build.py and should not be committed to the repo.
+build/*
diff --git a/.jscsrc b/.jscsrc
@@ -11,8 +11,10 @@
         "extensions/interactions/LogicProof/static/js/generatedParser.js",
         "integrations/**",
         "integrations_dev/**",
-        "static/scripts/**",
-        "third_party/**"
+        "assets/scripts/**",
+        "third_party/**",
+        "build/**",
+        "**.min.js"
     ],
     "fileExtensions": [".js"],
     "extract": ["*.html"],

diff --git a/app.yaml b/app.yaml
@@ -15,34 +15,36 @@ inbound_services:
 
 handlers:
 - url: /favicon.ico
-  static_files: static/images/favicon.ico
-  upload: static/images/favicon.ico
+  static_files: assets/common/favicon.ico
+  upload: assets/common/favicon.ico
   secure: always
   http_headers:
     Cache-Control: 'public, max-age=2592000'
     Vary: Accept-Encoding
-- url: /images
-  static_dir: static/images
+- url: /robots.txt
+  static_files: assets/common/robots.txt
+  upload: assets/common/robots.txt
   secure: always
   http_headers:
-    Cache-Control: 'public, max-age=600'
-- url: /static/pages
-  static_dir: static/pages
+    Cache-Control: 'public, max-age=2592000'
+    Vary: Accept-Encoding
+- url: /build
+  static_dir: build
   secure: always
   http_headers:
-    Cache-Control: 'public, max-age=600'
-- url: /robots.txt
-  static_files: static/pages/robots.txt
-  upload: static/pages/robots.txt
+    Cache-Control: 'public, max-age=2592000'
+- url: /assets/common
+  static_dir: assets/common
   secure: always
   http_headers:
-    Cache-Control: 'public, max-age=2592000'
-    Vary: Accept-Encoding
-- url: /scripts
-  static_dir: static/scripts
+    # WARNING TO DEVELOPERS: Files in this folder may be stale for
+    # up to 10 mins after a code release.
+    Cache-Control: 'public, max-age=600'
+- url: /assets
+  static_dir: assets
   secure: always
   http_headers:
-    Cache-Control: 'no-cache'
+    Cache-Control: 'public, max-age=60'
 - url: /css
   # NB: not minified. TODO(sll): fix.
   static_dir: core/templates/dev/head/css
@@ -53,11 +55,6 @@ handlers:
   http_headers:
     Cache-Control: 'public, max-age=2592000'
     Vary: Accept-Encoding
-- url: /i18n
-  static_dir: i18n
-  secure: always
-  http_headers:
-    Cache-Control: 'no-cache'
 - url: /third_party/generated
   static_dir: third_party/generated
   secure: always

@@ -13,7 +13,7 @@ them. To load the examples manually you need to:
 - In a browser window, open each of the HTML files in this folder, and ensure
   that they do the correct thing. Use URLs of the following form:
 
-      http://localhost:8181/scripts/embedding_tests_dev_0.0.1.html
+      http://localhost:8181/assets/scripts/embedding_tests_dev_0.0.1.html
 
 
 The features supported in each version of the embedding script are as follows:

@@ -0,0 +1,18 @@
+<h2>v0.0.0</h2>
+<p>For instructions: see the README file in /static/dev/scripts.</p>
+
+<h3>Standard embedding of the latest version</h3>
+<oppia oppia-id="0"></oppia>
+<script src="http://localhost:8181/assets/scripts/oppia-player-0.0.0.js"></script>
+
+<h3>Standard embedding of version 1 of the exploration</h3>
+<oppia oppia-id="0" exploration-version="1"></oppia>
+<script src="http://localhost:8181/assets/scripts/oppia-player-0.0.1.js"></script>
+
+<h3>ERROR: No oppia id specified</h3>
+<oppia></oppia>
+<script src="http://localhost:8181/assets/scripts/oppia-player-0.0.0.js"></script>
+
+<h3>ERROR: 404 error</h3>
+<oppia oppia-id="fake_id"></oppia>
+<script src="http://localhost:8181/assets/scripts/oppia-player-0.0.0.js"></script>
@@ -1,13 +1,13 @@
 <h2>v0.0.1 (unminified)</h2>
-<p>For instructions: see the README file in /static/scripts.</p>
+<p>For instructions: see the README file in /assets/scripts.</p>
 <p>
   NB: When you complete an exploration the text "Exploration completed" should
   appear in the paragraph below it. This checks that events are being sent from
   the Oppia iframe to the containing page.
 </p>
 
-<script src="/scripts/oppia-player-0.0.1.js"></script>
-<script src="/scripts/embedding_tests.js"></script>
+<script src="/assets/scripts/oppia-player-0.0.1.js"></script>
+<script src="/assets/scripts/embedding_tests.js"></script>
 
 <div class="protractor-test-standard">
   <h3>Standard embedding of the latest version</h3>
@@ -32,4 +32,4 @@ <h3>ERROR: 404 error</h3>
 <div class="protractor-test-invalid-id-deferred">
   <h3>ERROR: 404 error with deferred loading</h3>
   <oppia oppia-id="fake_id" autoload="false"></oppia>
-</div>
+</div>
@@ -1,13 +1,13 @@
 <h2>v0.0.1 (minified)</h2>
-<p>For instructions: see the README file in /static/scripts.</p>
+<p>For instructions: see the README file in /assets/scripts.</p>
 <p>
   NB: When you complete an exploration the text "Exploration completed" should
   appear in the paragraph below it. This checks that events are being sent from
   the Oppia iframe to the containing page.
 </p>
 
-<script src="/scripts/oppia-player-0.0.1.js"></script>
-<script src="/scripts/embedding_tests.js"></script>
+<script src="/assets/scripts/oppia-player-0.0.1.js"></script>
+<script src="/assets/scripts/embedding_tests.js"></script>
 
 <div class="protractor-test-standard">
   <h3>Standard embedding of the latest version</h3>

@@ -0,0 +1,10 @@
+<h2>v0.0.1 (unminified)</h2>
+<p>For instructions: see the README file in /assets/scripts.</p>
+
+<script src="/assets/scripts/oppia-player-0.0.1.js"></script>
+<script src="/assets/scripts/embedding_tests.js"></script>
+
+<div class="protractor-test-embedded-exploration">
+  <h3>Standard embedding of the latest version</h3>
+  <oppia oppia-id="12"></oppia>
+</div>
@@ -1,5 +1,5 @@
 <h2>v0.0.1 (minified) from the JSDelivr CDN</h2>
-<p>For instructions: see the README file in /static/scripts.</p>
+<p>For instructions: see the README file in /assets/scripts.</p>
 <p>
   NB: This set of tests depends on an external file hosted on the JSDelivr CDN.
   They will not work if you are offline.
@@ -10,8 +10,8 @@ <h2>v0.0.1 (minified) from the JSDelivr CDN</h2>
   the Oppia iframe to the containing page.
 </p>
 
-<script src="/scripts/oppia-player-0.0.1.js"></script>
-<script src="/scripts/embedding_tests.js"></script>
+<script src="/assets/scripts/oppia-player-0.0.1.js"></script>
+<script src="/assets/scripts/embedding_tests.js"></script>
 
 <div class="protractor-test-standard">
   <h3>Standard embedding of the latest version</h3>
@@ -36,4 +36,4 @@ <h3>ERROR: 404 error</h3>
 <div class="protractor-test-invalid-id-deferred">
   <h3>ERROR: 404 error with deferred loading</h3>
   <oppia oppia-id="fake_id" autoload="false"></oppia>
-</div>
+</div>
diff --git a/cache_slug.yaml b/cache_slug.yaml
@@ -0,0 +1,5 @@
+# Cache slug is a prefix that is attached to static resource paths such as
+# images, scripts and css. It should only contain alphanumeric characters.
+# It will be automatically updated when deploy.py is run.
+cache_slug:
+  default
@@ -300,6 +300,7 @@ def render_template(
         values.update({
             'ALL_CATEGORIES': feconf.ALL_CATEGORIES,
             'ALL_LANGUAGE_CODES': feconf.ALL_LANGUAGE_CODES,
+            'ASSET_DIR_PREFIX': utils.get_asset_dir_prefix(),
             'BEFORE_END_HEAD_TAG_HOOK': jinja2.utils.Markup(
                 BEFORE_END_HEAD_TAG_HOOK.value),
             'CAN_SEND_ANALYTICS_EVENTS': feconf.CAN_SEND_ANALYTICS_EVENTS,
@@ -313,7 +314,8 @@ def render_template(
                 rights_manager.ACTIVITY_STATUS_PUBLIC),
             'ACTIVITY_STATUS_PUBLICIZED': (
                 rights_manager.ACTIVITY_STATUS_PUBLICIZED),
-            'FULL_URL': '%s://%s/%s' % (scheme, netloc, path),
+            # The 'path' variable starts with a forward slash.
+            'FULL_URL': '%s://%s%s' % (scheme, netloc, path),
             'INVALID_NAME_CHARS': feconf.INVALID_NAME_CHARS,
             # TODO(sll): Consider including the obj_editor html directly as
             # part of the base HTML template?
@@ -375,6 +377,7 @@ def render_template(
 
         self.response.expires = 'Mon, 01 Jan 1990 00:00:00 GMT'
         self.response.pragma = 'no-cache'
+
         self.response.write(self.jinja2_env.get_template(
             filename).render(**values))
 

@@ -237,15 +237,18 @@ class I18nDictsTest(test_utils.GenericTestBase):
 
     def _extract_keys_from_json_file(self, filename):
         return sorted(json.loads(utils.get_file_contents(
-            os.path.join(os.getcwd(), 'i18n', filename)
+            os.path.join(os.getcwd(), self.get_static_asset_filepath(),
+                         'assets', 'i18n', filename)
         )).keys())
 
     def test_i18n_keys(self):
         """Tests that all JSON files in i18n.js have the same set of keys."""
         master_key_list = self._extract_keys_from_json_file('en.json')
         self.assertGreater(len(master_key_list), 0)
 
-        filenames = os.listdir(os.path.join(os.getcwd(), 'i18n'))
+        filenames = os.listdir(
+            os.path.join(os.getcwd(), self.get_static_asset_filepath(),
+                         'assets', 'i18n'))
         for filename in filenames:
             if filename == 'en.json':
                 continue

@@ -195,12 +195,12 @@ def test_thumbnail_icons_exist_for_each_category(self):
         # Test that an icon exists for each default category.
         for category in all_categories:
             utils.get_file_contents(os.path.join(
-                'static', 'images', 'subjects',
-                '%s.svg' % category.replace(' ', '')))
+                self.get_static_asset_filepath(), 'assets', 'images',
+                'subjects', '%s.svg' % category.replace(' ', '')))
 
         # Test that the default icon exists.
         utils.get_file_contents(os.path.join(
-            'static', 'images', 'subjects',
+            self.get_static_asset_filepath(), 'assets', 'images', 'subjects',
             '%s.svg' % feconf.DEFAULT_THUMBNAIL_ICON))
 
 

@@ -21,6 +21,7 @@
 
 from extensions.dependencies import dependencies_config
 import feconf
+import jinja_utils
 import utils
 
 
@@ -54,6 +55,12 @@ def get_deps_html_and_angular_modules(cls, dependency_ids):
         """
         html = '\n'.join([
             cls.get_dependency_html(dep) for dep in set(dependency_ids)])
+        # Html content for interactions is loaded using get_dependency_html
+        # method. This content is then interpolated using Jinja. Interactions
+        # such as logicproof contain jinja like variables that need to be
+        # interpolated. LogicProof contains a cache slug variable that is
+        # interpolated using interpolate_cache_slug method.
+        html = jinja_utils.interpolate_cache_slug(html)
         angular_modules_for_each_dep = [
             cls.get_angular_modules(dep) for dep in set(dependency_ids)]
         deduplicated_angular_modules = list(set(list(

@@ -196,7 +196,8 @@ def test_get_displayable_exp_summary_dicts_matching_ids(self):
             'status': 'public',
             'tags': [],
             'thumbnail_bg_color': '#a33f40',
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'title': u'Exploration 2 Albert title',
         }
         self.assertIn('last_updated_msec', displayable_summaries[0])
@@ -278,7 +279,8 @@ def test_get_library_groups(self):
             'tags': [],
             'title':  u'The Lazy Magician',
             'thumbnail_bg_color': '#d0982a',
-            'thumbnail_icon_url': '/images/subjects/Algorithms.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Algorithms.svg'),
         }
         expected_group = {
             'categories': ['Algorithms', 'Computing', 'Programming'],
@@ -354,7 +356,8 @@ def test_for_featured_explorations(self):
             'thumbnail_bg_color': '#a33f40',
             'community_owned': False,
             'tags': [],
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'language_code': feconf.DEFAULT_LANGUAGE_CODE,
             'id': self.EXP_ID_2,
             'category': 'A category',
@@ -640,7 +643,8 @@ def test_at_most_eight_top_rated_explorations(self):
             'thumbnail_bg_color': '#a33f40',
             'community_owned': False,
             'tags': [],
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'language_code': feconf.DEFAULT_LANGUAGE_CODE,
             'id': self.EXP_ID_3,
             'category': u'A category',
@@ -677,7 +681,8 @@ def test_only_explorations_with_ratings_are_returned(self):
             'thumbnail_bg_color': '#a33f40',
             'community_owned': False,
             'tags': [],
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'language_code': feconf.DEFAULT_LANGUAGE_CODE,
             'id': self.EXP_ID_2,
             'category': u'A category',
@@ -758,7 +763,8 @@ def test_for_recently_published_explorations(self):
             'thumbnail_bg_color': '#a33f40',
             'community_owned': False,
             'tags': [],
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'language_code': feconf.DEFAULT_LANGUAGE_CODE,
             'id': self.EXP_ID_1,
             'category': u'A category',
@@ -772,7 +778,8 @@ def test_for_recently_published_explorations(self):
             'thumbnail_bg_color': '#a33f40',
             'community_owned': False,
             'tags': [],
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'language_code': feconf.DEFAULT_LANGUAGE_CODE,
             'id': self.EXP_ID_2,
             'category': u'A category',
@@ -786,7 +793,8 @@ def test_for_recently_published_explorations(self):
             'thumbnail_bg_color': '#a33f40',
             'community_owned': False,
             'tags': [],
-            'thumbnail_icon_url': '/images/subjects/Lightbulb.svg',
+            'thumbnail_icon_url': self.get_static_asset_url(
+                '/images/subjects/Lightbulb.svg'),
             'language_code': feconf.DEFAULT_LANGUAGE_CODE,
             'id': self.EXP_ID_3,
             'category': u'A category',

@@ -143,7 +143,8 @@ def test_get_user_id_from_username(self):
     def test_fetch_gravatar_success(self):
         user_email = 'user@example.com'
         expected_gravatar_filepath = os.path.join(
-            'static', 'images', 'avatar', 'gravatar_example.png')
+            self.get_static_asset_filepath(), 'assets', 'images', 'avatar',
+            'gravatar_example.png')
         with open(expected_gravatar_filepath, 'r') as f:
             gravatar = f.read()
         with self.urlfetch_mock(content=gravatar):
@@ -198,7 +199,8 @@ def log_mock(message):
 
     def test_default_identicon_data_url(self):
         identicon_filepath = os.path.join(
-            'static', 'images', 'avatar', 'user_blue_72px.png')
+            self.get_static_asset_filepath(), 'assets', 'images', 'avatar',
+            'user_blue_72px.png')
         identicon_data_url = utils.convert_png_to_data_url(
             identicon_filepath)
         self.assertEqual(