Builds: avoid breaking builds when adding a new field to our APIs (#10295)

Closes #10257

Author: stsewd

readthedocs/builds/models.py

@@ -61,7 +61,7 @@
 )
 from readthedocs.builds.version_slug import VersionSlugField
 from readthedocs.config import LATEST_CONFIGURATION_VERSION
-from readthedocs.core.utils import trigger_build
+from readthedocs.core.utils import extract_valid_attributes_for_model, trigger_build
 from readthedocs.projects.constants import (
     BITBUCKET_COMMIT_URL,
     BITBUCKET_URL,
@@ -656,7 +656,17 @@ def __init__(self, *args, **kwargs):
                 del kwargs[key]
             except KeyError:
                 pass
-        super().__init__(*args, **kwargs)
+        valid_attributes, invalid_attributes = extract_valid_attributes_for_model(
+            model=Version,
+            attributes=kwargs,
+        )
+        if invalid_attributes:
+            log.warning(
+                "APIVersion got unexpected attributes.",
+                invalid_attributes=invalid_attributes,
+            )
+
+        super().__init__(*args, **valid_attributes)
 
     def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         return 0

readthedocs/core/utils/__init__.py

@@ -322,3 +322,23 @@ def get_cache_tag(*args):
     allowed in slugs to avoid collisions.
     """
     return ':'.join(args)
+
+
+def extract_valid_attributes_for_model(model, attributes):
+    """
+    Extract the valid attributes for a model from a dictionary of attributes.
+
+    :param model: Model class to extract the attributes for.
+    :param attributes: Dictionary of attributes to extract.
+    :returns: Tuple with the valid attributes and the invalid attributes if any.
+    """
+    attributes = attributes.copy()
+    valid_field_names = {field.name for field in model._meta.get_fields()}
+    valid_attributes = {}
+    # We can't change a dictionary while interating over its keys,
+    # so we make a copy of its keys.
+    keys = list(attributes.keys())
+    for key in keys:
+        if key in valid_field_names:
+            valid_attributes[key] = attributes.pop(key)
+    return valid_attributes, attributes

readthedocs/projects/models.py

@@ -30,7 +30,7 @@
 from readthedocs.constants import pattern_opts
 from readthedocs.core.history import ExtraHistoricalRecords
 from readthedocs.core.resolver import resolve, resolve_domain
-from readthedocs.core.utils import slugify
+from readthedocs.core.utils import extract_valid_attributes_for_model, slugify
 from readthedocs.core.utils.url import unsafe_join_url_path
 from readthedocs.domains.querysets import DomainQueryset
 from readthedocs.projects import constants
@@ -1382,7 +1382,18 @@ def __init__(self, *args, **kwargs):
                 del kwargs[key]
             except KeyError:
                 pass
-        super().__init__(*args, **kwargs)
+
+        valid_attributes, invalid_attributes = extract_valid_attributes_for_model(
+            model=Project,
+            attributes=kwargs,
+        )
+        if invalid_attributes:
+            log.warning(
+                "APIProject got unexpected attributes.",
+                invalid_attributes=invalid_attributes,
+            )
+
+        super().__init__(*args, **valid_attributes)
 
         # Overwrite the database property with the value from the API
         self.ad_free = ad_free

readthedocs/rtd_tests/tests/test_api.py

@@ -46,7 +46,7 @@
     EXTERNAL_VERSION_STATE_CLOSED,
     LATEST,
 )
-from readthedocs.builds.models import Build, BuildCommandResult, Version
+from readthedocs.builds.models import APIVersion, Build, BuildCommandResult, Version
 from readthedocs.integrations.models import Integration
 from readthedocs.oauth.models import (
     RemoteOrganization,
@@ -854,6 +854,29 @@ def test_init_api_project(self):
             {'RELEASE': 'prod'},
         )
 
+    def test_invalid_attributes_api_project(self):
+        invalid_attribute = "invalid_attribute"
+        project_data = {
+            "name": "Test Project",
+            "slug": "test-project",
+            "show_advertising": True,
+            invalid_attribute: "nope",
+        }
+        api_project = APIProject(**project_data)
+        self.assertFalse(hasattr(api_project, invalid_attribute))
+
+    def test_invalid_attributes_api_version(self):
+        invalid_attribute = "invalid_attribute"
+        version_data = {
+            "type": "branch",
+            "identifier": "main",
+            "verbose_name": "main",
+            "slug": "v2",
+            invalid_attribute: "nope",
+        }
+        api_version = APIVersion(**version_data)
+        self.assertFalse(hasattr(api_version, invalid_attribute))
+
     @override_settings(
         RTD_DEFAULT_FEATURES={
             TYPE_CONCURRENT_BUILDS: 4,