Raw File
filter.py
# Copyright (C) 2019 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information


from typing import Dict, Iterable, Set

from swh.model.model import (
    Content, SkippedContent, Directory, Revision,
)

from swh.storage import get_storage


class FilteringProxyStorage:
    """Filtering Storage implementation. This is in charge of transparently
       filtering out known objects prior to adding them to storage.

    Sample configuration use case for filtering storage:

    .. code-block: yaml

        storage:
          cls: filter
          storage:
            cls: remote
            url: http://storage.internal.staging.swh.network:5002/

    """
    def __init__(self, storage):
        self.storage = get_storage(**storage)
        self.objects_seen = {
            'content': set(),  # sha256
            'skipped_content': set(),  # sha1_git
            'directory': set(),  # sha1_git
            'revision': set(),  # sha1_git
        }

    def __getattr__(self, key):
        if key == 'storage':
            raise AttributeError(key)
        return getattr(self.storage, key)

    def content_add(self, content: Iterable[Content]) -> Dict:
        contents = list(content)
        contents_to_add = self._filter_missing_contents(contents)
        return self.storage.content_add(
            x for x in contents if x.sha256 in contents_to_add
        )

    def skipped_content_add(self, content: Iterable[SkippedContent]) -> Dict:
        contents = list(content)
        contents_to_add = self._filter_missing_skipped_contents(contents)
        return self.storage.skipped_content_add(
            x for x in contents
            if x.sha1_git is None or x.sha1_git in contents_to_add
        )

    def directory_add(self, directories: Iterable[Directory]) -> Dict:
        directories = list(directories)
        missing_ids = self._filter_missing_ids(
            'directory',
            (d.id for d in directories)
        )
        return self.storage.directory_add(
            d for d in directories if d.id in missing_ids
        )

    def revision_add(self, revisions: Iterable[Revision]) -> Dict:
        revisions = list(revisions)
        missing_ids = self._filter_missing_ids(
            'revision',
            (r.id for r in revisions)
        )
        return self.storage.revision_add(
            r for r in revisions if r.id in missing_ids
        )

    def _filter_missing_contents(
            self, contents: Iterable[Content]) -> Set[bytes]:
        """Return only the content keys missing from swh

        Args:
            content_hashes: List of sha256 to check for existence in swh
                storage

        """
        objects_seen = self.objects_seen['content']
        missing_contents = []
        for content in contents:
            if content.sha256 in objects_seen:
                continue
            objects_seen.add(content.sha256)
            missing_contents.append(content.hashes())

        return set(self.storage.content_missing(
            missing_contents,
            key_hash='sha256',
        ))

    def _filter_missing_skipped_contents(
            self, contents: Iterable[SkippedContent]) -> Set[bytes]:
        """Return only the content keys missing from swh

        Args:
            content_hashes: List of sha1_git to check for existence in swh
                storage

        """
        objects_seen = self.objects_seen['skipped_content']
        missing_contents = []
        for content in contents:
            if content.sha1_git is None or content.sha1_git in objects_seen:
                continue
            objects_seen.add(content.sha1_git)
            missing_contents.append(content.hashes())

        return {
            c.get('sha1_git')
            for c in self.storage.skipped_content_missing(missing_contents)}

    def _filter_missing_ids(
            self,
            object_type: str,
            ids: Iterable[bytes]) -> Set[bytes]:
        """Filter missing ids from the storage for a given object type.

        Args:
            object_type: object type to use {revision, directory}
            ids: Iterable of object_type ids

        Returns:
            Missing ids from the storage for object_type

        """
        objects_seen = self.objects_seen[object_type]
        missing_ids = []
        for id in ids:
            if id in objects_seen:
                continue
            objects_seen.add(id)
            missing_ids.append(id)

        fn_by_object_type = {
            'revision': self.storage.revision_missing,
            'directory': self.storage.directory_missing,
        }

        fn = fn_by_object_type[object_type]
        return set(fn(missing_ids))
back to top