Database schema: set {} as default for DbNode.repository_metadata

aiida/backends/djsite/db/migrations/0046_add_node_repository_metadata.py

@@ -30,7 +30,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='dbnode',
             name='repository_metadata',
-            field=django.contrib.postgres.fields.jsonb.JSONField(null=True),
+            field=django.contrib.postgres.fields.jsonb.JSONField(default=dict, null=True),
         ),
         upgrade_schema_version(REVISION, DOWN_REVISION),
     ]

aiida/backends/djsite/db/models.py

@@ -127,7 +127,7 @@ class DbNode(m.Model):
     attributes = JSONField(default=dict, null=True)
     # JSON Extras
     extras = JSONField(default=dict, null=True)
-    repository_metadata = JSONField(null=True)
+    repository_metadata = JSONField(default=dict, null=True)
 
     objects = m.Manager()
     # Return aiida Node instances or their subclasses instead of DbNode instances

aiida/backends/sqlalchemy/migrations/versions/0edcdd5a30f0_dbgroup_extras.py

@@ -28,6 +28,9 @@
 
 def upgrade():
     """Upgrade: Add the extras column to the 'db_dbgroup' table"""
+    # We add the column with a `server_default` because otherwise the migration would fail since existing rows will not
+    # have a value and violate the not-nullable clause. However, the model doesn't use a server default but a default
+    # on the ORM level, so we remove the server default from the column directly after.
     op.add_column(
         'db_dbgroup', sa.Column('extras', postgresql.JSONB(astext_type=sa.Text()), nullable=False, server_default='{}')
     )

aiida/backends/sqlalchemy/migrations/versions/7536a82b2cc4_add_node_repository_metadata.py

@@ -28,7 +28,12 @@
 
 def upgrade():
     """Migrations for the upgrade."""
-    op.add_column('db_dbnode', sa.Column('repository_metadata', postgresql.JSONB(astext_type=sa.Text()), nullable=True))
+    # We add the column with a `server_default` because otherwise the migration would fail since existing rows will not
+    # have a value and violate the not-nullable clause.
+    op.add_column(
+        'db_dbnode',
+        sa.Column('repository_metadata', postgresql.JSONB(astext_type=sa.Text()), nullable=False, server_default='{}')
+    )
 
 
 def downgrade():

aiida/backends/sqlalchemy/models/node.py

@@ -41,7 +41,7 @@ class DbNode(Base):
     mtime = Column(DateTime(timezone=True), default=timezone.now, onupdate=timezone.now)
     attributes = Column(JSONB)
     extras = Column(JSONB)
-    repository_metadata = Column(JSONB)
+    repository_metadata = Column(JSONB, nullable=False, default=dict, server_default='{}')
 
     dbcomputer_id = Column(
         Integer,

aiida/orm/nodes/node.py

@@ -37,7 +37,6 @@
 from .repository import NodeRepositoryMixin
 
 if TYPE_CHECKING:
-    from aiida.repository import File
     from ..implementation import Backend
     from ..implementation.nodes import BackendNode
 
@@ -286,7 +285,7 @@ def repository_metadata(self) -> typing.Dict:
 
         :return: the repository metadata
         """
-        return self.backend_entity.repository_metadata or {}
+        return self.backend_entity.repository_metadata
 
     @repository_metadata.setter
     def repository_metadata(self, value):

tests/backends/aiida_django/migrations/test_migrations_0046_add_node_repository_metadata.py

@@ -25,9 +25,9 @@ def setUpBeforeMigration(self):
         dbnode.save()
         self.node_pk = dbnode.pk
 
-    def test_group_string_update(self):
+    def test_migration(self):
         """Test that the column is added and null by default."""
         DbNode = self.apps.get_model('db', 'DbNode')
         node = DbNode.objects.get(pk=self.node_pk)
         assert hasattr(node, 'repository_metadata')
-        assert node.repository_metadata is None
+        assert node.repository_metadata == {}

tests/backends/aiida_django/migrations/test_migrations_0047_migrate_repository.py

@@ -82,7 +82,7 @@ def test_migration(self):
                 }
             }
         }
-        assert node_03.repository_metadata is None
+        assert node_03.repository_metadata == {}
 
         for hashkey, content in (
             (node_01.repository_metadata['o']['sub']['o']['path']['o']['file_b.txt']['k'], b'b'),

tests/backends/aiida_sqlalchemy/test_migrations.py

@@ -1786,7 +1786,7 @@ def test_add_node_repository_metadata(self):
             try:
                 node = session.query(DbNode).filter(DbNode.id == self.node_id).one()
                 assert hasattr(node, 'repository_metadata')
-                assert node.repository_metadata is None
+                assert node.repository_metadata == {}
             finally:
                 session.close()
 
@@ -1884,7 +1884,7 @@ def test_migration(self):
                         }
                     }
                 }
-                assert node_03.repository_metadata is None
+                assert node_03.repository_metadata == {}
 
                 for hashkey, content in (
                     (node_01.repository_metadata['o']['sub']['o']['path']['o']['file_b.txt']['k'], b'b'),

tests/orm/implementation/test_nodes.py

@@ -59,7 +59,7 @@ def test_creation(self):
         self.assertIsNone(node.process_type)
         self.assertEqual(node.attributes, dict())
         self.assertEqual(node.extras, dict())
-        self.assertEqual(node.repository_metadata, None)
+        self.assertEqual(node.repository_metadata, {})
         self.assertEqual(node.node_type, self.node_type)
         self.assertEqual(node.label, self.node_label)
         self.assertEqual(node.description, self.node_description)
@@ -87,7 +87,7 @@ def test_creation(self):
         self.assertIsNone(node.process_type)
         self.assertEqual(node.attributes, dict())
         self.assertEqual(node.extras, dict())
-        self.assertEqual(node.repository_metadata, None)
+        self.assertEqual(node.repository_metadata, {})
         self.assertEqual(node.node_type, self.node_type)
         self.assertEqual(node.label, self.node_label)
         self.assertEqual(node.description, self.node_description)