Fix a bug where extensions using npm would have their caches leak bet…

…ween different sites. (bartfeenstra#934)

betty/cache.py

@@ -1,6 +1,7 @@
 import logging
 import shutil
 from contextlib import suppress
+from enum import unique, IntFlag, auto
 from typing import TYPE_CHECKING
 
 from betty import fs
@@ -9,6 +10,12 @@
     from betty.builtins import _
 
 
+@unique
+class CacheScope(IntFlag):
+    BETTY = auto()
+    PROJECT = auto()
+
+
 async def clear():
     with suppress(FileNotFoundError):
         shutil.rmtree(fs.CACHE_DIRECTORY_PATH)

betty/http_api_doc/__init__.py

@@ -3,6 +3,7 @@
 from shutil import copy2
 from typing import Optional, Set, Type, TYPE_CHECKING
 
+from betty.cache import CacheScope
 
 if TYPE_CHECKING:
     from betty.builtins import _
@@ -22,6 +23,10 @@ async def npm_build(self, working_directory_path: Path, assets_directory_path: P
         copy2(working_directory_path / 'node_modules' / 'redoc' / 'bundles' / 'redoc.standalone.js', assets_directory_path / 'http-api-doc.js')
         logging.getLogger().info('Built the HTTP API documentation.')
 
+    @classmethod
+    def npm_cache_scope(cls) -> CacheScope:
+        return CacheScope.BETTY
+
     async def generate(self) -> None:
         assets_directory_path = await self.app.extensions[_Npm].ensure_assets(self)
         copy2(assets_directory_path / 'http-api-doc.js', self.app.project.configuration.www_directory_path / 'http-api-doc.js')

betty/maps/__init__.py

@@ -4,6 +4,8 @@
 from shutil import copy2, copytree
 from typing import Optional, Set, Type, TYPE_CHECKING, List
 
+from betty.cache import CacheScope
+
 if TYPE_CHECKING:
     from betty.builtins import _
 
@@ -30,6 +32,10 @@ def _copy_npm_build(self, source_directory_path: Path, destination_directory_pat
         with suppress(FileNotFoundError):
             copytree(source_directory_path / 'images', destination_directory_path / 'images')
 
+    @classmethod
+    def npm_cache_scope(cls) -> CacheScope:
+        return CacheScope.BETTY
+
     async def generate(self) -> None:
         assets_directory_path = await self.app.extensions[_Npm].ensure_assets(self)
         self._copy_npm_build(assets_directory_path, self.app.project.configuration.www_directory_path)

betty/npm/__init__.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import hashlib
 import logging
 import os
 import shutil
@@ -16,6 +17,7 @@
 from betty.app.extension import Extension, discover_extension_types
 from betty.app.extension.requirement import Requirement, AnyRequirement, AllRequirements
 from betty.asyncio import sync
+from betty.cache import CacheScope
 
 if TYPE_CHECKING:
     from betty.builtins import _
@@ -105,6 +107,10 @@ class NpmBuilder:
     async def npm_build(self, working_directory_path: Path, assets_directory_path: Path) -> None:
         raise NotImplementedError
 
+    @classmethod
+    def npm_cache_scope(cls) -> CacheScope:
+        return CacheScope.PROJECT
+
 
 def discover_npm_builders() -> Set[Type[Extension | NpmBuilder]]:
     return {
@@ -115,7 +121,7 @@ def discover_npm_builders() -> Set[Type[Extension | NpmBuilder]]:
     }
 
 
-def _get_assets_directory_path(extension_type: Type[Extension] | Type[NpmBuilder]) -> Path:
+def _get_assets_directory_path(extension_type: Type[Extension | NpmBuilder]) -> Path:
     assert issubclass(extension_type, Extension)
     assert issubclass(extension_type, NpmBuilder)
     assets_directory_path = extension_type.assets_directory_path()
@@ -185,7 +191,10 @@ async def install(self, extension_type: Type[Extension | NpmBuilder], working_di
 
     def _get_cached_assets_build_directory_path(self, extension_type: Type[Extension | NpmBuilder]) -> Path:
         assert issubclass(extension_type, Extension) and issubclass(extension_type, NpmBuilder)
-        return self.cache_directory_path / extension_type.name()
+        path = self.cache_directory_path / extension_type.name()
+        if extension_type.npm_cache_scope() == CacheScope.PROJECT:
+            path /= hashlib.md5(str(self.app.project.configuration.configuration_file_path).encode('utf-8')).hexdigest()
+        return path
 
     async def ensure_assets(self, extension: Extension | NpmBuilder) -> Path:
         assets_build_directory_paths = [

betty/trees/__init__.py

@@ -4,6 +4,8 @@
 from shutil import copy2
 from typing import Optional, Set, Type, List, TYPE_CHECKING
 
+from betty.cache import CacheScope
+
 if TYPE_CHECKING:
     from betty.builtins import _
 
@@ -28,6 +30,10 @@ def _copy_npm_build(self, source_directory_path: Path, destination_directory_pat
         copy2(source_directory_path / 'trees.css', destination_directory_path / 'trees.css')
         copy2(source_directory_path / 'trees.js', destination_directory_path / 'trees.js')
 
+    @classmethod
+    def npm_cache_scope(cls) -> CacheScope:
+        return CacheScope.BETTY
+
     async def generate(self) -> None:
         assets_directory_path = await self.app.extensions[_Npm].ensure_assets(self)
         self._copy_npm_build(assets_directory_path, self.app.project.configuration.www_directory_path)