Skip to content

Cache bleach.Cleaner for faster conversion of markdown to safe html #3599

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

Merged
bmd3k merged 3 commits into from
May 7, 2020
Merged

Cache bleach.Cleaner for faster conversion of markdown to safe html #3599

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2eda2f
Cache bleach Cleaner once per thread.
bmd3k May 6, 2020
66ae40b
Merge remote-tracking branch 'upstream/master' into cache-bleach-cleaner
bmd3k May 7, 2020
c87450f
triggering CI
bmd3k May 7, 2020
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
20 changes: 15 additions & 5 deletions tensorboard/plugin_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

import threading

import bleach
from bleach.sanitizer import Cleaner

# pylint: disable=g-bad-import-order
# Google-only: import markdown_freewisdom
Expand Down Expand Up @@ -64,7 +64,7 @@
]

# Cache Markdown converter to avoid expensive initialization at each
# call to `markdown_to_safe_html`.
# call to `markdown_to_safe_html`. Cache a different instance per thread.
class _MarkdownStore(threading.local):
def __init__(self):
self.markdown = markdown.Markdown(
Expand All @@ -75,6 +75,18 @@ def __init__(self):
_MARKDOWN_STORE = _MarkdownStore()


# Cache Cleaner to avoid expensive initialization at each call to `clean`.
# Cache a different instance per thread.
class _CleanerStore(threading.local):
def __init__(self):
self.cleaner = Cleaner(
tags=_ALLOWED_TAGS, attributes=_ALLOWED_ATTRIBUTES
)


_CLEANER_STORE = _CleanerStore()


def markdown_to_safe_html(markdown_string):
"""Convert Markdown to HTML that's safe to splice into the DOM.

Expand Down Expand Up @@ -126,9 +138,7 @@ def markdowns_to_safe_html(markdown_strings, combine):
unsafe_htmls.append(unsafe_html)

unsafe_combined = combine(unsafe_htmls)
sanitized_combined = bleach.clean(
unsafe_combined, tags=_ALLOWED_TAGS, attributes=_ALLOWED_ATTRIBUTES
)
sanitized_combined = _CLEANER_STORE.cleaner.clean(unsafe_combined)

warning = ""
if total_null_bytes:
Expand Down