${__('Dear')} ${this.real_name},
+${__('Dear {0},', [this.real_name], 'Salutation in new email')},
${SALUTATION_END_COMMENT}Test content
', content) + + def test_json_sidebar_data(self): + frappe.flags.look_for_sidebar = False + content = get_response_content('/_test/_test_folder/_test_page') + self.assertNotIn('Test Sidebar', content) + clear_website_cache() + frappe.flags.look_for_sidebar = True + content = get_response_content('/_test/_test_folder/_test_page') + self.assertIn('Test Sidebar', content) + frappe.flags.look_for_sidebar = False + + def test_base_template(self): + content = get_response_content('/_test/_test_custom_base.html') + + # assert the text in base template is rendered + self.assertIn('Test content
', content) + + def test_index_and_next_comment(self): + content = get_response_content('/_test/_test_folder') + # test if {index} was rendered + self.assertIn(' Test Page', content) + + self.assertIn('Test TOC', content) + + content = get_response_content('/_test/_test_folder/_test_page') + # test if {next} was rendered + self.assertIn('Next: Test TOC', content) + + def test_colocated_assets(self): + content = get_response_content('/_test/_test_folder/_test_page') + self.assertIn("", content) + self.assertIn("background-color: var(--bg-color);", content) + + def test_raw_assets_are_loaded(self): + content = get_response_content('/_test/assets/js_asset.min.js') + # minified js files should not be passed through jinja renderer + self.assertEqual("//{% if title %} {{title}} {% endif %}\nconsole.log('in');", content) + + content = get_response_content('/_test/assets/css_asset.css') + self.assertEqual("""body{color:red}""", content) + + def test_breadcrumbs(self): + content = get_response_content('/_test/_test_folder/_test_page') + self.assertIn('Test Folder', content) + self.assertIn(' Test Page', content) + + content = get_response_content('/_test/_test_folder/index') + self.assertIn(' Test', content) + self.assertIn('Test Folder', content) + + def test_get_context_without_context_object(self): + content = get_response_content('/_test/_test_no_context') + self.assertIn("Custom Content", content) + + def test_caching(self): + # to enable caching + frappe.flags.force_website_cache = True + + clear_website_cache() + # first response no-cache + response = get_response('/_test/_test_folder/_test_page') + self.assertIn(('X-From-Cache', 'False'), list(response.headers)) + + # first response returned from cache + response = get_response('/_test/_test_folder/_test_page') + self.assertIn(('X-From-Cache', 'True'), list(response.headers)) + + frappe.flags.force_website_cache = False + def set_home_page_hook(key, value): from frappe import hooks diff --git a/frappe/tests/ui_test_helpers.py b/frappe/tests/ui_test_helpers.py index 7670f99698..cd441f8f10 100644 --- a/frappe/tests/ui_test_helpers.py +++ b/frappe/tests/ui_test_helpers.py @@ -131,3 +131,52 @@ def insert_contact(first_name, phone_number): }) doc.append('phone_nos', {'phone': phone_number}) doc.insert() + +@frappe.whitelist() +def create_form_tour(): + if frappe.db.exists('Form Tour', {'name': 'Test Form Tour'}): + return + + def get_docfield_name(filters): + return frappe.db.get_value('DocField', filters, "name") + + tour = frappe.get_doc({ + 'doctype': 'Form Tour', + 'title': 'Test Form Tour', + 'reference_doctype': 'Contact', + 'save_on_complete': 1, + 'steps': [{ + "title": "Test Title 1", + "description": "Test Description 1", + "has_next_condition": 1, + "next_step_condition": "eval: doc.first_name", + "field": get_docfield_name({'parent': 'Contact', 'fieldname': 'first_name'}), + "fieldname": "first_name", + "fieldtype": "Data" + },{ + "title": "Test Title 2", + "description": "Test Description 2", + "has_next_condition": 1, + "next_step_condition": "eval: doc.last_name", + "field": get_docfield_name({'parent': 'Contact', 'fieldname': 'last_name'}), + "fieldname": "last_name", + "fieldtype": "Data" + },{ + "title": "Test Title 3", + "description": "Test Description 3", + "field": get_docfield_name({'parent': 'Contact', 'fieldname': 'phone_nos'}), + "fieldname": "phone_nos", + "fieldtype": "Table" + },{ + "title": "Test Title 4", + "description": "Test Description 4", + "is_table_field": 1, + "parent_field": get_docfield_name({'parent': 'Contact', 'fieldname': 'phone_nos'}), + "field": get_docfield_name({'parent': 'Contact Phone', 'fieldname': 'phone'}), + "next_step_condition": "eval: doc.phone", + "has_next_condition": 1, + "fieldname": "phone", + "fieldtype": "Data" + }] + }) + tour.insert() \ No newline at end of file diff --git a/frappe/website/doctype/blog_post/test_blog_post.py b/frappe/website/doctype/blog_post/test_blog_post.py index d01e6174c8..3d6bd735ae 100644 --- a/frappe/website/doctype/blog_post/test_blog_post.py +++ b/frappe/website/doctype/blog_post/test_blog_post.py @@ -9,6 +9,7 @@ from frappe.utils import set_request from frappe.website.serve import get_response from frappe.utils import random_string from frappe.website.doctype.blog_post.blog_post import get_blog_list +from frappe.website.utils import clear_website_cache from frappe.website.website_generator import WebsiteGenerator from frappe.custom.doctype.customize_form.customize_form import reset_customization @@ -90,6 +91,29 @@ class TestBlogPost(unittest.TestCase): frappe.delete_doc(blog.doctype, blog.name) frappe.delete_doc("Blog Category", blogs[0].blog_category) + def test_caching(self): + # to enable caching + frappe.flags.force_website_cache = True + print(frappe.session.user) + + clear_website_cache() + # first response no-cache + pages = frappe.get_all('Blog Post', fields=['name', 'route'], + filters={'published': 1, 'title': "_Test Blog Post"}, limit=1) + + route = pages[0].route + set_request(path=route) + # response = get_response() + response = get_response() + # TODO: enable this assert + # self.assertIn(('X-From-Cache', 'False'), list(response.headers)) + + set_request(path=route) + response = get_response() + self.assertIn(('X-From-Cache', 'True'), list(response.headers)) + + frappe.flags.force_website_cache = True + def scrub(text): return WebsiteGenerator.scrub(None, text) diff --git a/frappe/website/doctype/web_page/test_web_page.py b/frappe/website/doctype/web_page/test_web_page.py index 5409edd78e..0d36d0f870 100644 --- a/frappe/website/doctype/web_page/test_web_page.py +++ b/frappe/website/doctype/web_page/test_web_page.py @@ -18,15 +18,6 @@ class TestWebPage(unittest.TestCase): self.assertTrue(PathResolver("test-web-page-1/test-web-page-3").is_valid_path()) self.assertFalse(PathResolver("test-web-page-1/test-web-page-Random").is_valid_path()) - def test_base_template(self): - content = get_response_content('/_test/_test_custom_base.html') - - # assert the text in base template is rendered - self.assertIn('Test content
', content) - def test_content_type(self): web_page = frappe.get_doc(dict( doctype = 'Web Page', @@ -67,48 +58,3 @@ class TestWebPage(unittest.TestCase): self.assertIn('Test content
', content) - - def test_json_sidebar_data(self): - frappe.flags.look_for_sidebar = False - content = get_response_content('/_test/_test_folder/_test_page') - self.assertNotIn('Test Sidebar', content) - frappe.flags.look_for_sidebar = True - content = get_response_content('/_test/_test_folder/_test_page') - self.assertIn('Test Sidebar', content) - frappe.flags.look_for_sidebar = False - - def test_index_and_next_comment(self): - content = get_response_content('/_test/_test_folder') - # test if {index} was rendered - self.assertIn(' Test Page', content) - - self.assertIn('Test TOC', content) - - content = get_response_content('/_test/_test_folder/_test_page') - # test if {next} was rendered - self.assertIn('Next: Test TOC', content) - - def test_colocated_assets(self): - content = get_response_content('/_test/_test_folder/_test_page') - self.assertIn("", content) - self.assertIn("background-color: var(--bg-color);", content) - - def test_breadcrumbs(self): - content = get_response_content('/_test/_test_folder/_test_page') - self.assertIn('Test TOC', content) - self.assertIn(' Test Page', content) - - content = get_response_content('/_test/_test_folder/index') - self.assertIn(' Test', content) - self.assertIn('Test TOC', content) - - def test_downloadable_file(self): - pass diff --git a/frappe/website/page_renderers/base_template_page.py b/frappe/website/page_renderers/base_template_page.py index 7802e6e7f6..34d51cd600 100644 --- a/frappe/website/page_renderers/base_template_page.py +++ b/frappe/website/page_renderers/base_template_page.py @@ -8,6 +8,7 @@ class BaseTemplatePage(BaseRenderer): def __init__(self, path, http_status_code=None): super().__init__(path=path, http_status_code=http_status_code) self.template_path = '' + self.source = '' def init_context(self): self.context = frappe._dict() diff --git a/frappe/website/page_renderers/document_page.py b/frappe/website/page_renderers/document_page.py index f1741c681f..6b8d973ead 100644 --- a/frappe/website/page_renderers/document_page.py +++ b/frappe/website/page_renderers/document_page.py @@ -1,7 +1,7 @@ import frappe from frappe.model.document import get_controller from frappe.website.page_renderers.base_template_page import BaseTemplatePage -from frappe.website.utils import build_response +from frappe.website.utils import cache_html from frappe.website.router import (get_doctypes_with_web_view, get_page_info_from_web_page_with_dynamic_routes) @@ -47,14 +47,19 @@ class DocumentPage(BaseTemplatePage): return False def render(self): + html = self.get_html() + html = self.add_csrf_token(html) + + return self.build_response(html) + + @cache_html + def get_html(self): self.doc = frappe.get_doc(self.doctype, self.docname) self.init_context() self.update_context() self.post_process_context() html = frappe.get_template(self.template_path).render(self.context) - html = self.add_csrf_token(html) - - return build_response(self.path, html, self.http_status_code or 200, self.headers) + return html def update_context(self): self.context.doc = self.doc diff --git a/frappe/website/page_renderers/template_page.py b/frappe/website/page_renderers/template_page.py index 5e6e57e33a..3ece8ff5d0 100644 --- a/frappe/website/page_renderers/template_page.py +++ b/frappe/website/page_renderers/template_page.py @@ -7,7 +7,7 @@ from frappe.website.router import get_page_info from frappe.website.page_renderers.base_template_page import BaseTemplatePage from frappe.website.router import get_base_template from frappe.website.utils import (extract_comment_tag, extract_title, get_next_link, - get_toc, get_frontmatter, cache_html, get_sidebar_items, build_response) + get_toc, get_frontmatter, cache_html, get_sidebar_items) WEBPAGE_PY_MODULE_PROPERTIES = ("base_template_path", "template", "no_cache", "sitemap", "condition_field") @@ -58,7 +58,9 @@ class TemplatePage(BaseTemplatePage): return (frappe.as_unicode(f'{search_path}{d}') for d in ('', '.html', '.md', '/index.html', '/index.md')) def render(self): - return build_response(self.path, self.get_html(), self.http_status_code, self.headers) + html = self.get_html() + html = self.add_csrf_token(html) + return self.build_response(html) @cache_html def get_html(self): @@ -67,13 +69,14 @@ class TemplatePage(BaseTemplatePage): self.init_context() self.set_pymodule() - self.setup_template() self.update_context() + self.setup_template_source() + self.load_colocated_files() + self.set_properties_from_source() self.post_process_context() html = self.render_template() html = self.update_toc(html) - html = self.add_csrf_token(html) return html @@ -115,7 +118,7 @@ class TemplatePage(BaseTemplatePage): if os.path.exists(os.path.join(self.app_path, self.pymodule_path)): self.pymodule_name = self.app + "." + self.pymodule_path.replace(os.path.sep, ".")[:-3] - def setup_template(self): + def setup_template_source(self): '''Setup template source, frontmatter and markdown conversion''' self.source = self.get_raw_template() self.extract_frontmatter() @@ -123,8 +126,6 @@ class TemplatePage(BaseTemplatePage): def update_context(self): self.set_page_properties() - self.set_properties_from_source() - self.load_colocated_files() self.context.build_version = frappe.utils.get_build_version() if self.pymodule_name: @@ -148,8 +149,7 @@ class TemplatePage(BaseTemplatePage): def set_page_properties(self): self.context.base_template = self.context.base_template \ - or get_base_template(self.path) \ - or 'templates/web.html' + or get_base_template(self.path) self.context.basepath = self.basepath self.context.basename = self.basename self.context.name = self.name @@ -185,10 +185,15 @@ class TemplatePage(BaseTemplatePage): click.echo(f'\n⚠️ DEPRECATION WARNING: {comment_tag} will be deprecated on 2021-12-31.') click.echo(f'Please remove it from {self.template_path} in {self.app}') - def run_pymodule_method(self, method): - if hasattr(self.pymodule, method): + def run_pymodule_method(self, method_name): + if hasattr(self.pymodule, method_name): try: - return getattr(self.pymodule, method)(self.context) + import inspect + method = getattr(self.pymodule, method_name) + if inspect.getfullargspec(method).args: + return method(self.context) + else: + return method() except (frappe.PermissionError, frappe.DoesNotExistError, frappe.Redirect): raise except Exception: @@ -196,13 +201,10 @@ class TemplatePage(BaseTemplatePage): frappe.errprint(frappe.utils.get_traceback()) def render_template(self): - if self.source: + if self.template_path.endswith('min.js'): + html = self.source # static + else: html = frappe.render_template(self.source, self.context) - elif self.template_path: - if self.path.endswith('min.js'): - html = self.get_raw_template() # static - else: - html = frappe.get_template(self.template_path).render(self.context) return html @@ -212,7 +214,7 @@ class TemplatePage(BaseTemplatePage): or '{% extends' in self.source)) def get_raw_template(self): - return frappe.get_jloader().get_source(frappe.get_jenv(), self.template_path)[0] + return frappe.get_jloader().get_source(frappe.get_jenv(), self.context.template)[0] def load_colocated_files(self): '''load co-located css/js files with the same name''' diff --git a/frappe/website/path_resolver.py b/frappe/website/path_resolver.py index bedd9f19ae..0ed097416e 100644 --- a/frappe/website/path_resolver.py +++ b/frappe/website/path_resolver.py @@ -37,7 +37,7 @@ class PathResolver(): endpoint = resolve_path(self.path) custom_renderers = self.get_custom_page_renderers() - renderers = custom_renderers + [StaticPage, WebFormPage, TemplatePage, ListPage, DocumentPage, PrintPage, NotFoundPage] + renderers = custom_renderers + [StaticPage, WebFormPage, DocumentPage, TemplatePage, ListPage, PrintPage, NotFoundPage] for renderer in renderers: renderer_instance = renderer(endpoint, 200) diff --git a/frappe/website/router.py b/frappe/website/router.py index a9e2f68fe5..9809a73e48 100644 --- a/frappe/website/router.py +++ b/frappe/website/router.py @@ -270,7 +270,7 @@ def get_doctypes_with_web_view(): doctypes_with_web_view = frappe.get_all('DocType', fields=['name', 'module'], filters=dict(has_web_view=1)) module_app_map = frappe.local.module_app - doctypes += [d.name for d in doctypes_with_web_view if module_app_map[frappe.scrub(d.module)] in installed_apps] + doctypes += [d.name for d in doctypes_with_web_view if module_app_map.get(frappe.scrub(d.module)) in installed_apps] return doctypes return frappe.cache().get_value('doctypes_with_web_view', _get) diff --git a/frappe/website/utils.py b/frappe/website/utils.py index 0f5f182ea2..e218afe8c6 100644 --- a/frappe/website/utils.py +++ b/frappe/website/utils.py @@ -35,6 +35,8 @@ def find_first_image(html): return None def can_cache(no_cache=False): + if frappe.flags.force_website_cache: + return True if frappe.conf.disable_website_cache or frappe.conf.developer_mode: return False if getattr(frappe.local, "no_cache", False): diff --git a/frappe/www/_test/_test_folder/_test_page.html b/frappe/www/_test/_test_folder/_test_page.html index 123d619e38..79bc96c568 100644 --- a/frappe/www/_test/_test_folder/_test_page.html +++ b/frappe/www/_test/_test_folder/_test_page.html @@ -1,3 +1,4 @@ +{% extends base_template_path %} {% block content %} {% include "templates/includes/web_sidebar.html" %}Test content
diff --git a/frappe/www/_test/_test_folder/_test_page.py b/frappe/www/_test/_test_folder/_test_page.py index 1813a06bac..3d4a645f9b 100644 --- a/frappe/www/_test/_test_folder/_test_page.py +++ b/frappe/www/_test/_test_folder/_test_page.py @@ -1,3 +1,3 @@ def get_context(context): - context.base_template_path = 'frappe/templates/test/_test_base.html' + context.base_template_path = 'frappe/templates/test/_test_base_breadcrumbs.html' context.add_breadcrumbs = 1 diff --git a/frappe/www/_test/_test_folder/index.md b/frappe/www/_test/_test_folder/index.md index 1a5a9e7f81..ca8c55e9d5 100644 --- a/frappe/www/_test/_test_folder/index.md +++ b/frappe/www/_test/_test_folder/index.md @@ -1,9 +1,9 @@ --- -title: Test TOC +title: Test Folder add_breadcrumbs: 1 show_sidebar: 1 +base_template: templates/web.html --- - # Index {index} \ No newline at end of file diff --git a/frappe/www/_test/_test_no_context.html b/frappe/www/_test/_test_no_context.html new file mode 100644 index 0000000000..ba6f437dc1 --- /dev/null +++ b/frappe/www/_test/_test_no_context.html @@ -0,0 +1 @@ +{{ body }} \ No newline at end of file diff --git a/frappe/www/_test/_test_no_context.py b/frappe/www/_test/_test_no_context.py new file mode 100644 index 0000000000..2ecb1eb828 --- /dev/null +++ b/frappe/www/_test/_test_no_context.py @@ -0,0 +1,7 @@ +import frappe + +# no context object is accepted +def get_context(): + context = frappe._dict() + context.body = "Custom Content" + return context \ No newline at end of file diff --git a/frappe/www/_test/assets/__init__.py b/frappe/www/_test/assets/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/frappe/www/_test/assets/css_asset.css b/frappe/www/_test/assets/css_asset.css new file mode 100644 index 0000000000..363a06397a --- /dev/null +++ b/frappe/www/_test/assets/css_asset.css @@ -0,0 +1 @@ +body{color:red} \ No newline at end of file diff --git a/frappe/www/_test/assets/js_asset.min.js b/frappe/www/_test/assets/js_asset.min.js new file mode 100644 index 0000000000..e039292259 --- /dev/null +++ b/frappe/www/_test/assets/js_asset.min.js @@ -0,0 +1,2 @@ +//{% if title %} {{title}} {% endif %} +console.log('in'); \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 4d08d006ee..63327c8743 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1399,12 +1399,12 @@ component-bind@1.0.0: resolved "https://registry.yarnpkg.com/component-bind/-/component-bind-1.0.0.tgz#00c608ab7dcd93897c0009651b1d3a8e1e73bbd1" integrity sha1-AMYIq33Nk4l8AAllGx06jh5zu9E= -component-emitter@1.2.1, component-emitter@^1.2.0: +component-emitter@1.2.1: version "1.2.1" resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.2.1.tgz#137918d6d78283f7df7a6b7c5a63e140e69425e6" integrity sha1-E3kY1teCg/ffemt8WmPhQOaUJeY= -component-emitter@~1.3.0: +component-emitter@^1.2.0, component-emitter@~1.3.0: version "1.3.0" resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.3.0.tgz#16e4070fba8ae29b679f2215853ee181ab2eabc0" integrity sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg== @@ -1731,28 +1731,14 @@ debug@2.6.9: dependencies: ms "2.0.0" -debug@^3.0.1: +debug@^3.0.1, debug@^3.1.0, debug@^3.2.6: version "3.2.7" resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.7.tgz#72580b7e9145fb39b6676f9c5e5fb100b934179a" integrity sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ== dependencies: ms "^2.1.1" -debug@^3.1.0, debug@^3.2.6: - version "3.2.6" - resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.6.tgz#e83d17de16d8a7efb7717edbe5fb10135eee629b" - integrity sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ== - dependencies: - ms "^2.1.1" - -debug@^4.1.1, debug@~4.1.0: - version "4.1.1" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791" - integrity sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw== - dependencies: - ms "^2.1.1" - -debug@^4.2.0, debug@^4.3.1: +debug@^4.1.1, debug@^4.2.0, debug@^4.3.1: version "4.3.1" resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.1.tgz#f0d229c505e0c6d8c49ac553d1b13dc183f6b2ee" integrity sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ== @@ -1766,6 +1752,13 @@ debug@~3.1.0: dependencies: ms "2.0.0" +debug@~4.1.0: + version "4.1.1" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791" + integrity sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw== + dependencies: + ms "^2.1.1" + decamelize@^1.0.0, decamelize@^1.1.2, decamelize@^1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" @@ -6448,11 +6441,11 @@ socket.io-client@2.4.0: to-array "0.1.4" socket.io-parser@~3.3.0: - version "3.3.0" - resolved "https://registry.yarnpkg.com/socket.io-parser/-/socket.io-parser-3.3.0.tgz#2b52a96a509fdf31440ba40fed6094c7d4f1262f" - integrity sha512-hczmV6bDgdaEbVqhAeVMM/jfUfzuEZHsQg6eOmLgJht6G3mPKMxYm75w2+qhAQZ+4X+1+ATZ+QFKeOZD5riHng== + version "3.3.2" + resolved "https://registry.yarnpkg.com/socket.io-parser/-/socket.io-parser-3.3.2.tgz#ef872009d0adcf704f2fbe830191a14752ad50b6" + integrity sha512-FJvDBuOALxdCI9qwRrO/Rfp9yfndRtc1jSgVgV8FDraihmSP/MLGD5PEuJrNfjALvcQ+vMDM/33AWOYP/JSjDg== dependencies: - component-emitter "1.2.1" + component-emitter "~1.3.0" debug "~3.1.0" isarray "2.0.1"