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

Jump to bottom

Fix caching with resources in subdirs #987

Merged
merged 4 commits into from
Oct 30, 2019
Merged

Fix caching with resources in subdirs #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd22fd0
lint test_fingerprint
alexcjohnson Oct 29, 2019
f9277fe
fix fingerprint for nested folders and pathological cases
alexcjohnson Oct 30, 2019
a13d787
Merge branch 'dev' into cache-subdirs
Marc-Andre-Rivet Oct 30, 2019
eb85473
changelog for cache-subdirs
alexcjohnson Oct 30, 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 CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Fixed
- [#987](https://github.com/plotly/dash/pull/987) Fix cache string handling for component suites with nested folders in their packages.
- [#986](https://github.com/plotly/dash/pull/986) Fix a bug with evaluation of `_force_eager_loading` when application is loaded with gunicorn

## [1.5.0] - 2019-10-29
Expand Down
34 changes: 15 additions & 19 deletions dash/fingerprint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,27 @@
import re

build_regex = re.compile(r'^(?P<filename>[\w@~-]+)(?P<extension>.*)$')

check_regex = re.compile(
r'^(?P<filename>.*)[.]v[\w-]+m[0-9a-fA-F]+(?P<extension>(?:(?:(?<![.])[.])?[\w])+)$'
)
cache_regex = re.compile(r"^v[\w-]+m[0-9a-fA-F]+$")


def build_fingerprint(path, version, hash_value):
res = build_regex.match(path)
path_parts = path.split("/")
filename, extension = path_parts[-1].split(".", 1)

return '{}.v{}m{}{}'.format(
res.group('filename'),
str(version).replace('.', '_'),
return "{}.v{}m{}.{}".format(
"/".join(path_parts[:-1] + [filename]),
str(version).replace(".", "_"),
hash_value,
res.group('extension'),
extension,
)


def check_fingerprint(path):
path_parts = path.split("/")
name_parts = path_parts[-1].split(".")

# Check if the resource has a fingerprint
res = check_regex.match(path)

# Resolve real resource name from fingerprinted resource path
return (
res.group('filename') + res.group('extension')
if res is not None
else path,
res is not None,
)
if len(name_parts) > 2 and cache_regex.match(name_parts[1]):
original_name = ".".join([name_parts[0]] + name_parts[2:])
return "/".join(path_parts[:-1] + [original_name]), True

return path, False
126 changes: 96 additions & 30 deletions tests/unit/test_fingerprint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,122 @@

from dash.fingerprint import build_fingerprint, check_fingerprint

version = 1
hash_value = 1

valid_resources = [
{'path': 'react@16.8.6.min.js', 'fingerprint': 'react@16.v1m1.8.6.min.js'},
{'path': 'react@16.8.6.min.js', 'fingerprint': 'react@16.v1_1_1m1234567890abcdef.8.6.min.js', 'version': '1.1.1', 'hash': '1234567890abcdef' },
{'path': 'react@16.8.6.min.js', 'fingerprint': 'react@16.v1_1_1-alpha_1m1234567890abcdef.8.6.min.js', 'version': '1.1.1-alpha.1', 'hash': '1234567890abcdef' },
{'path': 'dash.plotly.js', 'fingerprint': 'dash.v1m1.plotly.js'},
{'path': 'dash.plotly.j_s', 'fingerprint': 'dash.v1m1.plotly.j_s'},
{'path': 'dash.plotly.css', 'fingerprint': 'dash.v1m1.plotly.css'},
{'path': 'dash.plotly.xxx.yyy.zzz', 'fingerprint': 'dash.v1m1.plotly.xxx.yyy.zzz'},
{'path': 'dash~plotly.js', 'fingerprint': 'dash~plotly.v1m1.js'}
{"path": "react@16.8.6.min.js", "fingerprint": "react@16.v1m1.8.6.min.js"},
{
"path": "react@16.8.6.min.js",
"fingerprint": "react@16.v1_1_1m1234567890abcdef.8.6.min.js",
"version": "1.1.1",
"hash": "1234567890abcdef",
},
{
"path": "react@16.8.6.min.js",
"fingerprint": "react@16.v1_1_1-alpha_1m1234567890abcdef.8.6.min.js",
"version": "1.1.1-alpha.1",
"hash": "1234567890abcdef",
},
{"path": "dash.plotly.js", "fingerprint": "dash.v1m1.plotly.js"},
{"path": "dash.plotly.j_s", "fingerprint": "dash.v1m1.plotly.j_s"},
{"path": "dash.plotly.css", "fingerprint": "dash.v1m1.plotly.css"},
{"path": "dash.plotly.xxx.yyy.zzz", "fingerprint": "dash.v1m1.plotly.xxx.yyy.zzz"},
{"path": "dash~plotly.js", "fingerprint": "dash~plotly.v1m1.js"},
{"path": "nested/folder/file.js", "fingerprint": "nested/folder/file.v1m1.js"},
{
# kind of pathological, but we have what looks like a version string
# in a different place - still works
"path": "nested.v2m2/folder/file.js",
"fingerprint": "nested.v2m2/folder/file.v1m1.js"
},
{
# even works if it gets doubled up in the right place
"path": "nested/folder/file.v2m2.js",
"fingerprint": "nested/folder/file.v1m1.v2m2.js"
},
{
"path": "nested.dotted/folder.structure/file.name.css",
"fingerprint": "nested.dotted/folder.structure/file.v1m1.name.css",
},
{
"path": "dash..plotly.js",
"fingerprint": "dash.v1_1_1m1234567890..plotly.js",
"version": "1.1.1",
"hash": "1234567890",
},
{
"path": "dash.",
"fingerprint": "dash.v1_1_1m1234567890.",
"version": "1.1.1",
"hash": "1234567890",
},
{
"path": "dash..",
"fingerprint": "dash.v1_1_1m1234567890..",
"version": "1.1.1",
"hash": "1234567890",
},
{
"path": "dash.js.",
"fingerprint": "dash.v1_1_1m1234567890.js.",
"version": "1.1.1",
"hash": "1234567890",
},
{
"path": "dash.j-s",
"fingerprint": "dash.v1_1_1m1234567890.j-s",
"version": "1.1.1",
"hash": "1234567890",
},
]

valid_fingerprints = [
'react@16.v1_1_2m1571771240.8.6.min.js',
'dash.plotly.v1_1_1m1234567890.js',
'dash.plotly.v1_1_1m1234567890.j_s',
'dash.plotly.v1_1_1m1234567890.css',
'dash.plotly.v1_1_1m1234567890.xxx.yyy.zzz',
'dash.plotly.v1_1_1-alpha1m1234567890.js',
'dash.plotly.v1_1_1-alpha_3m1234567890.js',
'dash.plotly.v1_1_1m1234567890123.js',
'dash.plotly.v1_1_1m4bc3.js',
'dash~plotly.v1m1.js'
"react@16.v1_1_2m1571771240.8.6.min.js",
"dash.v1_1_1m1234567890.plotly.js",
"dash.v1_1_1m1234567890.plotly.j_s",
"dash.v1_1_1m1234567890.plotly.css",
"dash.v1_1_1m1234567890.plotly.xxx.yyy.zzz",
"dash.v1_1_1-alpha1m1234567890.plotly.js",
"dash.v1_1_1-alpha_3m1234567890.plotly.js",
"dash.v1_1_1m1234567890123.plotly.js",
"dash.v1_1_1m4bc3.plotly.js",
"dash~plotly.v1m1.js",
"nested/folder/file.v1m1.js",
"nested.dotted/folder.structure/file.v1m1.name.css",
# this one has a pattern that looks like the version string in the wrong place
# AND one in the right place.
"nested.v2m2/folder/file.v1m1.js",
"nested.v2m2.dotted/folder.structure/file.v1m1.name.css",
]

invalid_fingerprints = [
'dash.plotly.v1_1_1m1234567890..js',
'dash.plotly.v1_1_1m1234567890.',
'dash.plotly.v1_1_1m1234567890..',
'dash.plotly.v1_1_1m1234567890.js.',
'dash.plotly.v1_1_1m1234567890.j-s'
"dash.plotly.v1_1_1m1234567890.js",
"folder/dash.plotly.v1_1_1m1234567890.js",
"nested.v1m1/folder/file.js",
"nested.v1m1.dotted/folder.structure/file.name.css",
]


def test_fingerprint():
for resource in valid_resources:
# The fingerprint matches expectations
fingerprint = build_fingerprint(resource.get('path'), resource.get('version', version), resource.get('hash', hash_value))
assert fingerprint == resource.get('fingerprint')
fingerprint = build_fingerprint(
resource.get("path"),
resource.get("version", version),
resource.get("hash", hash_value),
)
assert fingerprint == resource.get("fingerprint")

(original_path, has_fingerprint) = check_fingerprint(fingerprint)
# The inverse operation returns that the fingerprint was valid and the original path
# The inverse operation returns that the fingerprint was valid
# and the original path
assert has_fingerprint
assert original_path == resource.get('path')
assert original_path == resource.get("path")

for resource in valid_fingerprints:
(_, has_fingerprint) = check_fingerprint(resource)
assert has_fingerprint
assert has_fingerprint, resource
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

To report which resource it is when one fails, rather than just assert False


for resource in invalid_fingerprints:
(_, has_fingerprint) = check_fingerprint(resource)
assert not has_fingerprint
assert not has_fingerprint, resource