dependsOn not working as expected for fields with the same attribute name

[ThaDaVos]

• Laravel Version: 9.35.1
• Nova Version: 4.16.1
• PHP Version: 8.0.23
• Database Driver & Version: MySQL 8.x
• Operating System and Version: Ubuntu
• Browser type and version: Firefox
• Reproduction Repository: https://github.com/###/###

Description:

As discussed in #4648 there is an issue when using dependsOn with fields using the same attribute - in our case we're using two selects depending on a type field - based on the type a different select with different label is used - but due this issue, the first field is displayed twice in it's full.

Detailed steps to reproduce the issue on a fresh Nova installation:

See: #4648

Select::make('Field Type')
    ->options([
        'text' => 'Text',
        'number' => 'Number',
    ])
    ->onlyOnForms()
    ->displayUsingLabels(),

Number::make('Number', 'field_value')
    ->help('Number test')
    ->onlyOnForms()
    ->dependsOn(
        ['field_type'],
        function (Number $field, NovaRequest $request, FormData $formData) {
            if ($formData->field_type == 'number') {
                $field
                    ->show()
                    ->rules('required');
            } else {
                $field
                    ->hide();
            }
        }
    ),

Text::make('Text', 'field_value')
    ->help('Text test')
    ->onlyOnForms()
    ->dependsOn(
        ['field_type'],
        function (Text $field, NovaRequest $request, FormData $formData) {
            if ($formData->field_type == 'text') {
                $field
                    ->show()
                    ->rules('required');
            } else {
                $field
                    ->hide();
            }
        }
    ),

[crynobone]

Please add reproducing code.

[ThaDaVos]

See above - hope that's good

[crynobone]

CleanShot.2022-10-18.at.18.07.12.mp4

Unable to reproduce the issue, please provide full reproducing repository based on fresh installation as suggested in the bug report template (or you can refer to nova-issues/issue-4936@5b9b119 for example)

[szymon-szychulski]

I have the same issue. Code to reproduce:

Select::make('Action', 'action')
    ->options(
        array_combine(
            ['option_1', 'option_2'],
            ['Option 1', 'Option 2']
        )
    )
    ->displayUsingLabels(),


Select::make('Choose answer', 'answer')
    ->hide()
    ->options(array_combine(
        ['option_1', 'option_2'],
        ['Option 1', 'Option 2']
    ))
    ->dependsOn(
        ['action'],
        function (Select $field, NovaRequest $request, FormData $formData) {
            if ($formData->action === 'option_1') {
                $field->show();
            }
        }
    ),

Number::make('Enter number', 'answer')
    ->hide()
    ->dependsOn(
        ['action'],
        function (Select $field, NovaRequest $request, FormData $formData) {
            if ($formData->action === 'option_1') {
                $field->show();
            }
        }),

I hope it's clear now. In this case the attribute for second Select field and Number field is the same and Nova has the problem with displaying it correctly and handling. Of course there should be possibility to have two or more fields with the same name and using both of them with dependsOn.

[crynobone]

Nova has the problem with displaying it correctly and handling.

Explain what you mean here.

[szymon-szychulski]

Explain what you mean here.

Ok, I will show more complex example:

    public function fields(Request $request): array
    {
        return [
            Select::make('Action', 'action')
                ->required()
                ->options(
                    array_combine(
                        AuditSpecificationCustomRuleModel::ACTIONS,
                        AuditSpecificationCustomRuleModel::ACTIONS
                    )
                )
                ->displayUsingLabels(),

            Select::make('Surcharge', 'action_parameters->0')
                ->hide()
                ->required()
                ->rules([
                    Rule::in(AuditSurchargeModel::SURCHARGES)
                ])
                ->options(array_combine(
                    AuditSurchargeModel::SURCHARGES,
                    AuditSurchargeModel::SURCHARGES
                ))
                ->dependsOn(
                    ['action'],
                    function (Select $field, NovaRequest $request, FormData $formData) {
                        if ($formData->action === AuditSpecificationCustomRuleModel::ADD_SURCHARGE) {
                            $field->show();
                        }
                    }
                ),

            Select::make('Price type', 'action_parameters->1')
                ->hide()
                ->required()
                ->rules([
                    Rule::in(MasterPriceListPrice::TYPES)
                ])
                ->options(array_combine(
                    MasterPriceListPrice::TYPES,
                    MasterPriceListPrice::TYPES
                ))
                ->dependsOn(
                    ['action'],
                    function (Select $field, NovaRequest $request, FormData $formData) {
                        if ($formData->action === AuditSpecificationCustomRuleModel::ADD_SURCHARGE) {
                            $field->show();
                        }
                    }
                ),

            Number::make('Price value max', 'action_parameters->2')
                ->hide()
                ->required()
                ->rules([
                    'numeric',
                    'min:0'
                ])
                ->dependsOn(
                    ['action'],
                    function (Number $field, NovaRequest $request, FormData $formData) {
                        if ($formData->action === AuditSpecificationCustomRuleModel::ADD_SURCHARGE) {
                            $field->show();
                        }
                    }
                ),

            Select::make('Shipment type', 'action_parameters->0')
                ->hide()
                ->required()
                ->rules([
                    Rule::in(OrderModel::TYPES)
                ])
                ->options(array_combine(
                    OrderModel::TYPES,
                    OrderModel::TYPES
                ))
                ->dependsOn(
                    ['action'],
                    function (Select $field, NovaRequest $request, FormData $formData) {
                        if ($formData->action === AuditSpecificationCustomRuleModel::SET_SHIPMENT_TYPE) {
                            $field->show();
                        }
                    }
                )
        ];
    }

Behaviour after I chose "Add surcharge" option:

Behaviour after I chose "Set shipment type" option:

Basically fields dependent on action are displayed completely wrong. For "Add surcharge" option you can see both also last Select, where it should not be displayed, and for option "Set shipment type" no field is displayed.

[crynobone]

What's the return type of AuditSpecificationCustomRuleModel::ADD_SURCHARGE and wouldn't Select::make('Surcharge', 'action_parameters->0') and Select::make('Shipment type', 'action_parameters->0') set as single Select and you handle everything under dependsOn. That's how you do it.

Having multiple Select with same attribute name will not be supported in Nova.

[ThaDaVos]

Why isn't having multiple Select with the same attribute through dependsOn not supported (as for example the title should be different and the logic inside dependsOn can stay single purpose), but is having the same attribute used, by a Text and Number with dependsOn, supported?

Either, don't support it at all, or support all cases - at least, that's my opinion - seeing that multiple people are using the pattern of multiple Select fields, same attribute and dependsOn - seems that it's a case which gets used, in our case to keep our dependsOn concise, instead of using multiple if statements to further determine the state - also, it eases the other parts of the field's configuration, like the title/label but also helpText etc

[crynobone]

because it's impossible to target which field should be updated.