Merge pull request #1785 from braingram/manifest_extension_mismatch

issue warning if manifest id does not match uri

CHANGES.rst

@@ -16,6 +16,10 @@
 - Fix bug where a dictionary containing a key ``id`` caused
   any contained references to fail to resolve [#1716]
 
+- Issue a ``AsdfManifestURIMismatchWarning`` during write if a used
+  extension was created from a manifest registered with a uri that
+  does not match the id in the manifest [#1785]
+
 
 3.2.0 (2024-04-05)
 ------------------

asdf/_asdf.py

@@ -19,6 +19,7 @@
 from .exceptions import (
     AsdfConversionWarning,
     AsdfDeprecationWarning,
+    AsdfManifestURIMismatchWarning,
     AsdfPackageVersionWarning,
     AsdfWarning,
     DelimiterNotFoundError,
@@ -491,7 +492,15 @@ def _update_extension_history(self, tree, serialization_context):
             if manifest is not None:
                 # check if this extension was built from a manifest is a different package
                 resource_mapping = get_config().resource_manager._mappings_by_uri.get(manifest["id"])
-                if resource_mapping.package_name != extension.package_name:
+                # if an extension was registered with a manifest uri that does not match the id the
+                # resource_mapping lookup will fail (resource_mapping will be None)
+                if resource_mapping is None:
+                    warnings.warn(
+                        f"Extension ({extension.extension_uri}) uses a manifest with a uri that "
+                        "does not match it's id. Please open an issue with the extension maintainer",
+                        AsdfManifestURIMismatchWarning,
+                    )
+                elif resource_mapping.package_name != extension.package_name:
                     ext_meta["manifest_software"] = Software(
                         name=resource_mapping.package_name,
                         version=resource_mapping.package_version,

asdf/_tests/test_extension.py

@@ -5,7 +5,7 @@
 from yaml.representer import RepresenterError
 
 from asdf import AsdfFile, config_context
-from asdf.exceptions import AsdfWarning, ValidationError
+from asdf.exceptions import AsdfManifestURIMismatchWarning, AsdfWarning, ValidationError
 from asdf.extension import (
     Compressor,
     Converter,
@@ -941,3 +941,44 @@ class FractionWithInverseExtension:
 
         read_f1 = roundtrip_object(f1)
         assert read_f1.inverse.inverse is read_f1
+
+
+def test_manifest_uri_id_mismatch_warning(tmp_path):
+    with config_context() as config:
+        # make an extension with a manifest (where id doesn't match the registered uri)
+        full_manifest = """%YAML 1.1
+---
+id: asdf://somewhere.org/manifests/foo
+extension_uri: asdf://somewhere.org/extensions/foo
+tags:
+  - asdf://somewhere.org/tags/bar
+...
+"""
+        config.add_resource_mapping({"asdf://somewhere.org/extensions/foo": full_manifest})
+
+        class Foo:
+            pass
+
+        class FooConverter:
+            tags = ["asdf://somewhere.org/tags/bar"]
+            types = [Foo]
+
+            def to_yaml_tree(self, *args):
+                return {}
+
+            def from_yaml_tree(self, *args):
+                return Foo()
+
+        extension = ManifestExtension.from_uri(
+            "asdf://somewhere.org/extensions/foo",
+            converters=[FooConverter()],
+        )
+
+        # use the extension to write out a file
+        config.add_extension(extension)
+
+        af = AsdfFile()
+        af["foo"] = Foo()
+        fn = tmp_path / "foo.asdf"
+        with pytest.warns(AsdfManifestURIMismatchWarning):
+            af.write_to(fn)

asdf/exceptions.py

@@ -3,6 +3,8 @@
 __all__ = [
     "AsdfConversionWarning",
     "AsdfDeprecationWarning",
+    "AsdfManifestURIMismatchWarning",
+    "AsdfPackageVersionWarning",
     "AsdfProvisionalAPIWarning",
     "AsdfWarning",
     "DelimiterNotFoundError",
@@ -54,3 +56,10 @@ class AsdfPackageVersionWarning(AsdfWarning):
     """
     A warning indicating a package version mismatch
     """
+
+
+class AsdfManifestURIMismatchWarning(AsdfWarning):
+    """
+    A warning indicaing that an extension registered with a manifest
+    contains a id that does not match the uri of the manifest.
+    """

tox.ini

@@ -274,8 +274,7 @@ commands_pre =
     pip install -r {env_tmp_dir}/requirements.txt
     pip freeze
 commands =
-    pytest roman_datamodels/tests \
-        -W "ignore:asdf.extensions plugin from package gwcs==0.18.3:asdf.exceptions.AsdfWarning"
+    pytest roman_datamodels/tests
 
 [testenv:weldx]
 change_dir = {env_tmp_dir}
@@ -320,5 +319,8 @@ commands_pre =
     pip install -r {env_tmp_dir}/requirements.txt
     pip freeze
 commands =
+# the AsdfManifestURIMismatchWarning filter can be removed when a new sunpy
+# is released which contains the fixed manifests:
+# https://github.com/sunpy/sunpy/pull/7432
     pytest dkist \
-        -W "ignore:asdf.extensions plugin from package gwcs==0.18.3:asdf.exceptions.AsdfWarning"
+        -W "ignore::asdf.exceptions.AsdfManifestURIMismatchWarning"