GraphQL Error when querying `connected_endpoints` on `interface_list` without `cabled: true` filter

[Kani999]

Deployment Type

Self-hosted

NetBox Version

v4.2.5

Python Version

3.12

Steps to Reproduce

1. Send the following GraphQL query:

query MyQuery {
  interface_list(
    filters: {device: "DeviceWithVirtualCircuitConnection"}
  ) {
    name
    device {
      name
      longitude
      latitude
      role {
        name
      }
    }
    connected_endpoints {
      ... on CircuitTerminationType {
        id
      }
    }
  }
}

Expected Behavior

Workaround

Including the cabled: true filter in the query resolves the error. However, this limits the query to only cabled interfaces.

Additional Information

This issue seems to be related to how the connected_endpoints field is resolved when the cabled filter is not explicitly set to true. It might be that the resolver expects a cabled connection and fails when it encounters a non-cabled interface. (It happens when VirtualCircuitTerminations are made)

Observed Behavior

Error:

{
  "data": null,
  "errors": [
    {
      "message": "The type \"<class 'circuits.models.virtual_circuits.VirtualCircuitTermination'>\" cannot be resolved for the field \"connected_endpoints\" , are you using a strawberry.field?",
      "locations": [
        {
          "line": 14,
          "column": 5
        }
      ],
      "path": [
        "interface_list",
        132,
        "connected_endpoints",
        0
      ]
    }
  ]
}

[jnovinger]

@Kani999 , thank you for opening a bug report. Unfortunately, the information you have provided is not sufficient to reproduce the reported behavior. Remember, each bug report must include detailed steps that someone else can follow on a clean, empty NetBox installation to reproduce the exact problem you're experiencing. These instructions should include the creation of any involved objects, any configuration changes, and complete accounting of the actions being taken. Also be sure that your report does not reference data on the public NetBox demo, as that is subject to change at any time by an outside party and cannot be relied upon for bug reports.

[Kani999]

@jnovinger

Steps to Reproduce (https://demo.netbox.dev)

1. Register account at https://demo.netbox.dev and log in.
2. Go to https://demo.netbox.dev/circuits/virtual-circuit-types/ and create Virtual Circuit Type called test
3. Go to Virtual Circuits and createa random Virtual Circuit
4. Open device dmi01-akron-rtr01 - Add Child Interface to interface GigabitEthernet0/1/2
   - Must be virtual
5. Terminate a Virtual Circuit at that virtual interface you just created
6. Go to GraphQL
7. Run following query

query MyQuery {
  interface_list(
    filters: {device: "dmi01-akron-rtr01"}
  ) {
    name
    device {
      name
      longitude
      latitude
      role {
        name
      }
    }
    connected_endpoints {
      ... on CircuitTerminationType {
        id
      }
    }
  }
}

9. Obtain an Error:

{
  "data": null,
  "errors": [
    {
      "message": "The type \"<class 'circuits.models.virtual_circuits.VirtualCircuitTermination'>\" cannot be resolved for the field \"connected_endpoints\" , are you using a strawberry.field?",
      "locations": [
        {
          "line": 14,
          "column": 5
        }
      ],
      "path": [
        "interface_list",
        5,
        "connected_endpoints",
        0
      ]
    }
  ]
}

---

Images:

[jnovinger]

@Kani999 , I think I'm missing something with step 5: "Terminate a Virtual Circuit at that virtual interface you just created".

When I create a Virtual Circuit Termination for the test virtual circuit and the child interface, 1) I'm not seeing anything in the "Connection" column on dmi-01-akron-rtr01's interface column for that termination and 2) I'm not getting any errors with that query in GraphQL. I believe I have everything configured as described.

Virtual Circuit Termination

dmi01-akron-rtr01 interfaces

GraphQL

[Kani999]

@jnovinger, I missed a crucial step in connecting the virtual circuit to another virtual interface termination. Here's an alternative, possibly more straightforward approach to create it:

Steps to Reproduce

1. Import Virtual Circuit Type
   Import the virtual circuit type using the following CSV data:

   name,slug
   issue_18895,issue_18895
   

   [Import Link](https://demo.netbox.dev/circuits/virtual-circuit-types/bulk_import/)

2. Import Virtual Circuit
   Import the virtual circuit using the following CSV data:

   cid,provider_network,type,status
   issue_18895,Level3 MPLS,issue_18895,active
   

   [Import Link](https://demo.netbox.dev/circuits/virtual-circuits/import/)

3. Import Interfaces

   • Important: Store/write down the IDs of the created interfaces.
     Import interfaces using the following CSV data:

   device,name,type,parent
   dmi01-akron-rtr01,GigabitEthernet0/1/2.issue_18895,virtual,GigabitEthernet0/1/2
   dmi01-akron-rtr01,GigabitEthernet0/1/2.issue_18895_second,virtual,GigabitEthernet0/1/2
   

   Example IDs:

   • first_created_interface_id = 1788
   • second_created_interface_id = 1789
     [Import Link](https://demo.netbox.dev/dcim/interfaces/bulk_import/)

4. Import Virtual Circuit Terminations

   • Use the stored IDs from the previous step.
     Import virtual circuit terminations using the following CSV data:

   virtual_circuit,role,interface
   issue_18895,peer,1788
   issue_18895,peer,1789
   

   [Import Link](https://demo.netbox.dev/circuits/virtual-circuit-terminations/import/)

5. Run GraphQL Query
   Execute the following GraphQL query to retrieve interface information:

   query MyQuery {
     interface_list(
       filters: {device: "dmi01-akron-rtr01"}
     ) {
       name
       device {
         name
         longitude
         latitude
         role {
           name
         }
       }
       connected_endpoints {
         ... on CircuitTerminationType {
           id
         }
       }
     }
   }

   [GraphQL Query Link](https://demo.netbox.dev/graphql/)

6. Error Response
   Running the GraphQL query results in the following error:

   {
     "data": null,
     "errors": [
       {
         "message": "The type \"\" cannot be resolved for the field \"connected_endpoints\" , are you using a strawberry.field?",
         "locations": [
           {
             "line": 14,
             "column": 5
           }
         ],
         "path": [
           "interface_list",
           5,
           "connected_endpoints",
           0
         ]
       }
     ]
   }

---

You have to see a connection on the created interfaces.

[github-actions]

This is a reminder that additional information is needed in order to further triage this issue. If the requested details are not provided, the issue will soon be closed automatically.

[Kani999]

This is a reminder that additional information is needed in order to further triage this issue. If the requested details are not provided, the issue will soon be closed automatically.

I've add the more information in this reply #18895 (comment)