bug: Convert Query errors exporting IPs that are null

[jjeff07]

Component

No response

Infrahub SDK version

1.19.0

Current Behavior

GQL:

Device {
    edges {
      node {
       __typename
        id
        ip {
          ip
        }
    }
}

Data:

{
  "data": {
    "Device": {
      "edges": [
        {
          "node": {
            "ip": {
              "ip": null
            }
        }
    }
}

Error:

File "C:\Users\justin.jeffery\Code\infrahub-avd\.venv\Lib\site-packages\infrahub_sdk\node\attribute.py", line 82, in __init__
    self._value = mapper(data.get("value"))
                  ~~~~~~^^^^^^^^^^^^^^^^^^^
  File "C:\Users\justin.jeffery\AppData\Local\Programs\Python\Python313\Lib\ipaddress.py", line 117, in ip_interface
    raise ValueError(f'{address!r} does not appear to be an IPv4 or IPv6 interface')
ValueError: {'ip': None} does not appear to be an IPv4 or IPv6 interface

Expected Behavior

If an Attribute of kind IPHost is optional and has no value the GQL works fine with querying the value but if querying the ip instead it should also return None and not error. This means all my queries I either:

• Cannot use converted response.
• Or have to query the value, check if it is None, then manually split the mask off.

This may also apply to IPNetwork items as well.

Steps to Reproduce

1. Create schema with IPHost Attribute
2. Create Query extracting only the IP and not the value
3. Use the converted resposne in the SDK

Additional Information

No response

[ogenstad]

Hey, wanted to check around the expectations here. While I agree that this is a bug I'm not sure if that query should produce anything under the "ip" attribute. In this case even if the ip address was there it would be a raw string for the address such as "192.168.1.1", where as "value" would be an interface like "192.168.1.1/24". So for queries where we want to convert to a node I think we'd want to query for the "value".

So I think what we have here would either raise an error (but a better one). It could basically raise an error stating that we can't use this query to create an InfrahubNode. An easier example would be if we queries for ".netmask" instead of ".ip". The other alternative would be to just skip that attribute and silently ignore the fact that we're missing ".value".

It could be that this query would work today if you had a value in ".ip", however it would add the longest possible prefix which might not actually be correct compared to what would come from the database for ".value". The alternative would be to ignore this fact and live with the fact that what's stored as "192.168.1.1/24" in the database for .value gets translated to "192.168.1.1/32", which might be fine in most cases but would also be incorrect.

[minitriga]

@jjeff07 can you confirm that if the IP address exists that it works?