Weird Runway Relationship for Specific Models

[dmmceldowney]

Description

There's some weird behavior going on in my Statamic project and I'm not sure what the issue is, specifically. Hopefully there's just a single config line I missed somewhere that is causing this behavior.

I've got a table service_provider_domains that has a BelongsTo relationship with two tables: service_providers and domains. I've got my Laravel relationships defined with snake-case function names. However, I'm running into two issues.

1. I can't use the snake-case name for the function call and I get an error when I try to do so. To fix it, I have to remove the underscore altogether. If I do not, the table does not load in the Statamic CP and I get the following error, regardless of quotes: Runway could not find [service_provider]
2. After removing the underscore, the table successfully loads in the CP. However, the name field of the ServiceProvider does not show up; instead I just get a blank space. If I edit the record in the CP, the name properly shows up in the edit page and I can even pick a different one easily (awesome!). But it's not showing up in the table view, and I need it to show up there for this table to be useful (less awesome).

So, why doesn't snake-case work for the resource value in the blueprint and why doesn't it load the relationship properly in the table view?

Blueprint

main:
    fields:
      -
        handle: id
        field:
          type: integer
          display: 'ID'
          visiblity: readonly
      -
        handle: service_provider_id
        field:
          max_items: 1
          mode: default
          resource: service_provider # changing to serviceprovider will load the page
          create: true
          display: 'Service Provider'
          type: 'belongs_to'
      -
        handle: domain_id
        field:
          max_items: 1
          mode: default
          resource: domain
          create: true
          display: 'Domain'
          type: 'belongs_to'
      -

edit: forgot to add the relationships for the ServiceProviderDomain

ServiceProviderDomain relationships

public function service_provider(): BelongsTo
{
    return $this->belongsTo(ServiceProviderDomain::class);
}

public function domain(): BelongsTo
{
        return $this->belongsTo(Domain::class);
}

Environment

Environment
Application Name: Laravel
Laravel Version: 10.48.2
PHP Version: 8.3.7
Composer Version: 2.7.6
Environment: local
Debug Mode: ENABLED
URL: localhost
Maintenance Mode: OFF

Cache
Config: NOT CACHED
Events: NOT CACHED
Routes: NOT CACHED
Views: CACHED

Drivers
Broadcasting: log
Cache: statamic
Database: mysql
Logs: stack / single
Mail: smtp
Queue: sync
Session: file

Statamic
Addons: 1
Antlers: runtime
Sites: 1
Stache Watcher: Enabled
Static Caching: Disabled
Version: 4.53.2 PRO

Statamic Addons
statamic-rad-pack/runway: 6.6.2

[duncanmcclean]

I have a couple of ideas of things you could try....

1. In terms of the relationship, the best practise is to use "camel case" for the relationship method names. So instead of service_provider, try using serviceProvider:

   public function serviceProvider(): BelongsTo
   {
       return $this->belongsTo(ServiceProviderDomain::class);
   }

   Also, you have the "belongs to" here pointing at the ServiceProviderDomain model, should it not be pointing at your ServiceProvider model?

2. Regarding the reference to the related resource in your blueprint:

   resource: service_provider # changing to serviceprovider will load the page

   In Runway v6, resource handles (which is what you're using here) don't include underscores for multi-word model names, which is why it doesn't work until you remove it. In Runway v7, they do. You can override this handle if you want, in your runway.php config file:

   // config/runway.php
   
   ServiceProvider::class => [
       'handle' => 'service_provider',
   ],

   For future reference, you can see a list of all resources (inc their resource handles) by running php please runway:resources.

3. Regarding the blank space problem... what does the "Service Provider" resource's blueprint look like? Does it have any fields in it w/ "Listable" set to "Shown by default"?
   Runway will attempt to display the value of the first listable field in the blueprint (referred to as the "title field" inside Runway)

[dmmceldowney]

First idea was an oversight that I caught after I posted 🤦🏻 - good eye! I did end up changing that to the correct model and I was still getting the same result. Sorry for posting with incorrect information!

I'm gonna try the other part to that suggestion now - changing to camel case instead of snake case. I think I got used to that syntax from a previous job where that was the standard ("the relationship should be accessed the same way it shows up in the DB"), so I'm gonna fix those real quick and come back with updates!

Thanks so much for responding. I really, really appreciate it.

[dmmceldowney]

Turns out that was all that was really needed. Thanks a million. I'll look into upgrading statamic and runway to the latest versions after we finish this buildout! ❤️

[duncanmcclean]

Awesome, glad to hear it was a simple fix.