Legacy Migration

These instructions can be used to migrate a project using the legacy common_storage package to alliance_platform_storage.

Install the alliance_platform_storage package as per the installation instructions.

Note

If this is an older project that is not using the published alliance_platform packages at all you will need to add the following to settings/base.py (at minimum) if no ALLIANCE_PLATFORM setting already exists:

ALLIANCE_PLATFORM = {
    "CORE": {"PROJECT_DIR": PROJECT_DIR},
}

Follow these steps:

• For the widget to continue working you will need to copy the common_storage/templates/widgets/async_file_input.html file to <app>/templates/alliance_platform/storage/widgets/async_file_input.html. <app> can be any of the project specific apps (in the base template xenopus_frog_app for example, or django_site).

• Delete the common_storage app entirely from django-root, and remove it from INSTALLED_APPS.

• Remove common_storage.test_common_storage from TEST_APPS in settings/base.py.

• The directory structure is changed from common_storage, so imports and settings references should be replaced as follows:

  • common_storage.s3 to alliance_platform.storage.async_uploads.storage.s3

  • common_storage.azure to alliance_platform.storage.async_uploads.storage.azure

  • common_storage.base to alliance_platform.storage.async_uploads.storage.base

  • common_storage.views to alliance_platform.storage.async_uploads.views

  • common_storage.registry to alliance_platform.storage.async_uploads.registry

  • common_storage.drf to alliance_platform.storage.async_uploads.rest_framework

  • common_storage.fields.async_file.AsyncFileFormField to alliance_platform.storage.async_uploads.forms.AsyncFileField

  • common_storage.fields.async_file.AsyncImageFormField to alliance_platform.storage.async_uploads.forms.AsyncImageField

  • common_storage.fields.async_file.AsyncFileInput to alliance_platform.storage.async_uploads.forms.AsyncFileInput

  • common_storage.fields.async_file.AsyncFileInputDataValidator to alliance_platform.storage.async_uploads.forms.AsyncFileInputDataValidator

  • common_storage.fields.async_file.AsyncFileInputDataLengthValidator to alliance_platform.storage.async_uploads.forms.AsyncFileInputDataLengthValidator

  • common_storage.models.AsyncTempFile to alliance_platform.storage.async_uploads.models.AsyncTempFile

  • All remaining instances of common_storage.fields.async_file to alliance_platform.storage.async_uploads.models

• In urls.py remove the paths for DownloadRedirectView and GenerateUploadView, and add the following instead (if not already done as part of installation):

  # You can change the path to whatever you like, or add the patterns to the top level
  path("async-file/", include(default_async_field_registry.get_url_patterns())),
  

When you migrate, if the common_storage_async_temp_file table exists its data will be copied into the corresponding table in alliance_platform.storage.

Warning

Before doing this upgrade, check that the AsyncTempFile table has the following fields, otherwise the migration will break. If any of these fields don’t exist you will need to first upgrade to the latest version of common_storage.

• created_at

• original_filename

• key

• field_name

• content_type_id

• error

• moved_to_location

Notable differences

The only potential breaking change in async uploads between the most recent version of common_storage and the initial published version of alliance_platform_storage is the addition of the field_id argument to generate_upload_url() and generate_download_url(). However, this will only matter if you are calling these functions directly, or have extended an AsyncUploadStorage class and overridden these methods. If so, you will just need to update the signature to accept the field_id argument.

ManifestStaticFilesExcludeWebpackStorage

The other change is the removal of the ManifestStaticFilesExcludeWebpackStorage class. Instead, you can now use ExcludingManifestStaticFilesStorage. Its usage would be something like:

STORAGES = {
    "staticfiles": {
        "BACKEND": "alliance_platform.storage.staticfiles.storage.ExcludingManifestStaticFilesStorage",
        # Adjust this based on the specific setting name or build directory in your project
        "OPTIONS": {"exclude_patterns": [f"{settings.FRONTEND_PRODUCTION_DIR}/*"]},
    }
}