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

fix(storages): use ssec storage at correct times #798

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −14
Open

fix(storages): use ssec storage at correct times #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion alexandria/core/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from django.contrib.postgres.search import SearchVectorField
from django.core.exceptions import ImproperlyConfigured, ObjectDoesNotExist
from django.core.files import File as DjangoFile
from django.core.files.storage import storages
from django.core.validators import RegexValidator
from django.db import models, transaction
from django.dispatch import receiver
Expand Down Expand Up @@ -172,7 +173,10 @@ def clone(self):
self.pk = None
self.save()

storage = File.content.field.storage
storage_backend = settings.ALEXANDRIA_FILE_STORAGE
if settings.ALEXANDRIA_ENABLE_AT_REST_ENCRYPTION:
storage_backend = "alexandria.storages.backends.s3.SsecGlobalS3Storage"
storage = storages.create_storage({"BACKEND": storage_backend})
Comment on lines -175 to +179
Copy link
Contributor

@fugal-dy fugal-dy Mar 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The clone method appears to bypass the whole django-storages implementation. shouldn't that create a new File aka copy the latest_original.content for the cloned Document?

latest_original.pk = None
latest_original.document = self
if isinstance(storage, S3Storage):
Expand Down
4 changes: 1 addition & 3 deletions alexandria/core/tests/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ def test_document_no_files(


def test_clone_document_s3(db, mocker, settings, file_factory):
settings.ALEXANDRIA_FILE_STORAGE = (
"alexandria.storages.backends.s3.SsecGlobalS3Storage"
)
settings.ALEXANDRIA_FILE_STORAGE = "alexandria.storages.backends.s3.S3Storage"
settings.ALEXANDRIA_ENABLE_AT_REST_ENCRYPTION = True
name = "name-of-the-file"
mocker.patch("storages.backends.s3.S3Storage.save", return_value=name)
Expand Down
18 changes: 9 additions & 9 deletions alexandria/storages/fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,17 @@
from django.db.models.fields.files import FieldFile
from storages.backends.s3 import S3Storage

from alexandria.storages.backends.s3 import SsecGlobalS3Storage


class DynamicStorageFieldFile(FieldFile):
def __init__(self, instance, field, name):
super().__init__(instance, field, name)
self.storage = storages.create_storage(
{"BACKEND": settings.ALEXANDRIA_FILE_STORAGE}
)
storage_backend = settings.ALEXANDRIA_FILE_STORAGE
if settings.ALEXANDRIA_ENABLE_AT_REST_ENCRYPTION:
from alexandria.core.models import File

if instance.encryption_status == File.EncryptionStatus.SSEC_GLOBAL_KEY:
self.storage = SsecGlobalS3Storage()
storage_backend = "alexandria.storages.backends.s3.SsecGlobalS3Storage"
self.storage = storages.create_storage({"BACKEND": storage_backend})


class DynamicStorageFileField(models.FileField):
Expand All @@ -28,7 +25,9 @@ class DynamicStorageFileField(models.FileField):
# of Alexandria: https://github.com/projectcaluma/alexandria/issues/480

def __init__(self, storage=None, **kwargs):
storage = storages.create_storage({"BACKEND": settings.ALEXANDRIA_FILE_STORAGE})
self.storage = storages.create_storage(
{"BACKEND": settings.ALEXANDRIA_FILE_STORAGE}
)
super().__init__(storage=storage, **kwargs)
Comment on lines 27 to 31
Copy link
Contributor

@fugal-dy fugal-dy Mar 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

that's a bit hard to grasp. This is probably a noop. storage is not defined here but self.storage but self.storage will probably be overwritten in the following super() where it will probably default to default_storage since the kwarg storage is None.

The whole thing might still work because of DynamicStorageFieldFile (referenced in attr_class) because the attr self.storage is overwritten there.


def pre_save(self, instance, add):
Expand Down Expand Up @@ -56,8 +55,9 @@ def pre_save(self, instance, add):
"Set `ALEXANDRIA_FILE_STORAGE` to `alexandria.storages.s3.S3Storage`."
)
raise ImproperlyConfigured(msg)
storage = SsecGlobalS3Storage()
if instance.encryption_status == File.EncryptionStatus.SSEC_GLOBAL_KEY:
self.storage = storage
self.storage = storages.create_storage(
{"BACKEND": "alexandria.storages.backends.s3.SsecGlobalS3Storage"}
)
_file = super().pre_save(instance, add)
return _file
2 changes: 1 addition & 1 deletion alexandria/storages/tests/test_dynamic_field.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def test_dynamic_storage_select_global_ssec(
mocker.patch("alexandria.core.tasks.create_thumbnail.delay", side_effect=None)
if raises is not None:
with pytest.raises(raises):
file_factory()
file_factory(encryption_status=settings.ALEXANDRIA_ENCRYPTION_METHOD)
return
file_factory(encryption_status=settings.ALEXANDRIA_ENCRYPTION_METHOD)
assert SsecGlobalS3Storage.save.called_once()
Expand Down
Loading