mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-25 19:15:51 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #5730 from matrix-org/erikj/cache_versions

Browse source 
Cache get_version_string.
This commit is contained in:
Erik Johnston 2019-07-22 14:52:52 +01:00 committed by GitHub
commit 720d30469f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/5730.misc Normal file
View file

@ -0,0 +1 @@
Cache result of get_version_string to reduce overhead of `/version` federation requests.

23
synapse/util/versionstring.py
View file

@ -22,6 +22,23 @@ logger = logging.getLogger(__name__)
def get_version_string(module):
"""Given a module calculate a git-aware version string for it.
If called on a module not in a git checkout will return `__verison__`.
Args:
module (module)
Returns:
str
"""
cached_version = getattr(module, "_synapse_version_string_cache", None)
if cached_version:
return cached_version
version_string = module.__version__
try:
null = open(os.devnull, "w")
cwd = os.path.dirname(os.path.abspath(module.__file__))
@ -80,8 +97,10 @@ def get_version_string(module):
s for s in (git_branch, git_tag, git_commit, git_dirty) if s
)
return "%s (%s)" % (module.__version__, git_version)
version_string = "%s (%s)" % (module.__version__, git_version)
except Exception as e:
logger.info("Failed to check for git repository: %s", e)
return module.__version__
module._synapse_version_string_cache = version_string
return version_string