Dataset versioning

gateway/sds_gateway/api_methods/migrations/0021_dataset_previous_version_alter_dataset_version.py

@@ -0,0 +1,33 @@
+# Generated by Django 4.2.26
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+def convert_version_to_integer(apps, schema_editor):
+    """Convert empty string versions to 1 before changing field type."""
+    Dataset = apps.get_model('api_methods', 'Dataset')
+    # Update all datasets with empty or invalid version strings to default value of 1
+    for dataset in Dataset.objects.all():
+        if not dataset.version or dataset.version.strip() == '':
+            dataset.version = '1'
+            dataset.save(update_fields=['version'])
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("api_methods", "0020_group_owner_as_member_and_individual_share_field"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='dataset',
+            name='previous_version',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='next_version', to='api_methods.dataset'),
+        ),
+        migrations.RunPython(convert_version_to_integer, migrations.RunPython.noop),
+        migrations.AlterField(
+            model_name='dataset',
+            name='version',
+            field=models.IntegerField(default=1),
+        ),
+    ]

gateway/sds_gateway/api_methods/migrations/max_migration.txt

@@ -1 +1 @@
-0020_group_owner_as_member_and_individual_share_field
+0021_dataset_previous_version_alter_dataset_version

gateway/sds_gateway/api_methods/models.py

@@ -683,7 +683,14 @@ class Dataset(BaseModel):
     institutions = models.TextField(blank=True)
     release_date = models.DateTimeField(blank=True, null=True)
     repository = models.URLField(blank=True)
-    version = models.CharField(max_length=255, blank=True)
+    version = models.IntegerField(default=1)
+    previous_version = models.ForeignKey(
+        "self",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="next_version",
+    )
     website = models.URLField(blank=True)
     provenance = models.JSONField(blank=True, null=True)
     citation = models.JSONField(blank=True, null=True)
@@ -1093,6 +1100,17 @@ def user_can_share(cls, user: "User", item_uuid: uuid.UUID, item_type: str) -> b
             PermissionLevel.CO_OWNER,
         ]
 
+    @classmethod
+    def user_can_advance_version(
+        cls, user: "User", item_uuid: uuid.UUID, item_type: str
+    ) -> bool:
+        """Check if user can advance the version of the item."""
+        permission_level = cls.get_user_permission_level(user, item_uuid, item_type)
+        return permission_level in [
+            PermissionLevel.OWNER,
+            PermissionLevel.CO_OWNER,
+        ]
+
 
 class DEPRECATEDPostProcessedData(BaseModel):
     """

gateway/sds_gateway/api_methods/serializers/dataset_serializers.py

@@ -24,6 +24,8 @@ class DatasetGetSerializer(serializers.ModelSerializer[Dataset]):
     owner_email = serializers.SerializerMethodField()
     permission_level = serializers.SerializerMethodField()
     can_edit = serializers.SerializerMethodField()
+    can_advance_version = serializers.SerializerMethodField()
+    next_version = serializers.SerializerMethodField()
 
     def get_authors(self, obj):
         """Return the full authors list using the model's get_authors_display method."""
@@ -162,10 +164,45 @@ def get_can_edit(self, obj):
         ).first()
 
         if permission:
-            return permission.permission_level in ["co-owner", "contributor"]
+            return permission.permission_level in [
+                PermissionLevel.CO_OWNER,
+                PermissionLevel.CONTRIBUTOR,
+            ]
 
         return False
 
+    def get_can_advance_version(self, obj):
+        """Check if the current user can advance the version of the dataset."""
+        request = self.context.get("request")
+        if not request or not hasattr(request, "user"):
+            return False
+
+        # Check if user is the owner
+        if obj.owner == request.user:
+            return True
+
+        # Check for shared permissions that allow advancing the version
+        permission = UserSharePermission.objects.filter(
+            shared_with=request.user,
+            item_type=ItemType.DATASET,
+            item_uuid=obj.uuid,
+            is_enabled=True,
+            is_deleted=False,
+        ).first()
+
+        if permission:
+            return permission.permission_level == PermissionLevel.CO_OWNER
+
+        return False
+
+    def get_next_version(self, obj):
+        """Get the next version of the dataset."""
+        next_version = None
+        if obj.next_version.exists():
+            next_version_obj = obj.next_version.first()
+            next_version = next_version_obj.version
+        return next_version
+
     class Meta:
         model = Dataset
         fields = "__all__"

gateway/sds_gateway/api_methods/tests/factories.py

@@ -46,7 +46,7 @@ class DatasetFactory(DjangoModelFactory):
         institutions: Fixed list ["Example University"]
         release_date: Random datetime
         repository: Random URL
-        version: Fixed value "1.0.0"
+        version: Integer number
         website: Random URL
         provenance: Fixed dict {"source": "test"}
         citation: Fixed dict {"title": "Test Dataset"}
@@ -89,7 +89,7 @@ class DatasetFactory(DjangoModelFactory):
     institutions = ["Example University"]
     release_date = Faker("date_time")
     repository = Faker("url")
-    version = "1.0.0"
+    version = 1
     website = Faker("url")
     provenance = {"source": "test"}
     citation = {"title": "Test Dataset"}

gateway/sds_gateway/static/js/actions/DetailsActionManager.js

@@ -9,6 +9,9 @@ class DetailsActionManager {
 	 */
 	constructor(config) {
 		this.permissions = config.permissions;
+		this.itemUuid = config.itemUuid;
+		this.itemType = config.itemType;
+		this.modalId = `${this.itemType}DetailsModal-${this.itemUuid}`;
 		this.initializeEventListeners();
 	}
 
@@ -69,7 +72,7 @@ class DetailsActionManager {
 		// Handle modal show events
 		document.addEventListener("show.bs.modal", (e) => {
 			const modal = e.target;
-			if (modal.id === "datasetDetailsModal") {
+			if (modal.id === this.modalId) {
 				this.handleDatasetDetailsModalShow(modal, e);
 			}
 		});
@@ -82,7 +85,7 @@ class DetailsActionManager {
 	async handleCaptureDetails(captureUuid) {
 		try {
 			// Show loading state
-			this.showModalLoading("captureDetailsModal");
+			window.DOMUtils.showModalLoading(this.modalId);
 
 			// Fetch capture details
 			const captureData = await window.APIClient.get(
@@ -93,11 +96,11 @@ class DetailsActionManager {
 			this.populateCaptureDetailsModal(captureData);
 
 			// Show modal
-			this.openModal("captureDetailsModal");
+			window.DOMUtils.openModal(this.modalId);
 		} catch (error) {
 			console.error("Error loading capture details:", error);
-			this.showModalError(
-				"captureDetailsModal",
+			window.DOMUtils.showModalError(
+				this.modalId,
 				"Failed to load capture details",
 			);
 		}
@@ -110,17 +113,17 @@ class DetailsActionManager {
 	 * @param {Object} tree - File tree data
 	 */
 	async populateDatasetDetailsModal(datasetData, statistics, tree) {
-		const modal = document.getElementById("datasetDetailsModal");
+		const modal = document.getElementById(this.modalId);
 		if (!modal) return;
 
 		// Clear loading state and restore original modal content
-		this.clearModalLoading("datasetDetailsModal");
+		window.DOMUtils.clearModalLoading(this.modalId);
 
 		// Update basic information using the correct selectors from the template
 		this.updateElementText(
 			modal,
 			".dataset-details-name",
-			datasetData.name || "Untitled Dataset",
+			`${datasetData.name} (v${datasetData.version})` || "Untitled Dataset",
 		);
 		this.updateElementText(
 			modal,
@@ -183,7 +186,7 @@ class DetailsActionManager {
 	 * @param {Object} captureData - Capture data
 	 */
 	populateCaptureDetailsModal(captureData) {
-		const modal = document.getElementById("captureDetailsModal");
+		const modal = document.getElementById(this.modalId);
 		if (!modal) return;
 
 		// Update basic information
@@ -645,71 +648,6 @@ class DetailsActionManager {
 		}
 	}
 
-	/**
-	 * Clear modal loading state and restore original content
-	 * @param {string} modalId - Modal ID
-	 */
-	clearModalLoading(modalId) {
-		const modal = document.getElementById(modalId);
-		if (!modal) return;
-
-		const modalBody = modal.querySelector(".modal-body");
-		if (modalBody?.dataset.originalContent) {
-			// Restore original content
-			modalBody.innerHTML = modalBody.dataset.originalContent;
-			// Clean up the stored content
-			delete modalBody.dataset.originalContent;
-		}
-	}
-
-	/**
-	 * Show modal error
-	 * @param {string} modalId - Modal ID
-	 * @param {string} message - Error message
-	 */
-	async showModalError(modalId, message) {
-		const modal = document.getElementById(modalId);
-		if (!modal) return;
-
-		const modalBody = modal.querySelector(".modal-body");
-		if (modalBody) {
-			await window.DOMUtils.renderError(modalBody, message, {
-				format: "alert",
-				alert_type: "danger",
-				icon: "exclamation-triangle",
-			});
-		}
-
-		// Show modal even with error
-		this.openModal(modalId);
-	}
-
-	/**
-	 * Open modal
-	 * @param {string} modalId - Modal ID
-	 */
-	openModal(modalId) {
-		const modal = document.getElementById(modalId);
-		if (!modal) return;
-
-		const bootstrapModal = new bootstrap.Modal(modal);
-		bootstrapModal.show();
-	}
-
-	/**
-	 * Close modal
-	 * @param {string} modalId - Modal ID
-	 */
-	closeModal(modalId) {
-		const modal = document.getElementById(modalId);
-		if (!modal) return;
-
-		const bootstrapModal = bootstrap.Modal.getInstance(modal);
-		if (!bootstrapModal) return;
-
-		bootstrapModal.hide();
-	}
-
 	/**
 	 * Handle dataset details modal show
 	 * @param {Element} modal - Modal element
@@ -721,8 +659,8 @@ class DetailsActionManager {
 
 		if (!triggerElement) {
 			console.warn("No trigger element found for dataset details modal");
-			this.showModalError(
-				"datasetDetailsModal",
+			window.DOMUtils.showModalError(
+				this.modalId,
 				"Unable to load dataset details",
 			);
 			return;
@@ -733,7 +671,7 @@ class DetailsActionManager {
 
 		if (!datasetUuid) {
 			console.warn("No dataset UUID found on trigger element:", triggerElement);
-			this.showModalError("datasetDetailsModal", "Dataset UUID not found");
+			window.DOMUtils.showModalError(this.modalId, "Dataset UUID not found");
 			return;
 		}
 
@@ -748,7 +686,7 @@ class DetailsActionManager {
 	async loadDatasetDetailsForModal(datasetUuid) {
 		try {
 			// Show loading state
-			this.showModalLoading("datasetDetailsModal");
+			window.DOMUtils.showModalLoading(this.modalId);
 
 			// Fetch dataset details
 			const response = await window.APIClient.get(
@@ -764,8 +702,8 @@ class DetailsActionManager {
 			await this.populateDatasetDetailsModal(datasetData, statistics, tree);
 		} catch (error) {
 			console.error("Error loading dataset details:", error);
-			this.showModalError(
-				"datasetDetailsModal",
+			window.DOMUtils.showModalError(
+				this.modalId,
 				"Failed to load dataset details",
 			);
 		}