Prevent adding duplicate dashlet if present with same name and label

[monishdeb]

Overview

Steps to replicate:

1. Go to any existing report instance (say 'Activity Details') >> enable for 'Available for Dashboard' >> Save
2. Then change the 'Limit Dashboard Results' count and save again.
3. Go to homepage, and click on 'Available Dashlets'

Before

There are duplicate dashlets under 'Available Dashlets'

After

Updates the existing dashlets.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

I understand the overall issue, but am wondering if this is a typo: setting $dashlet->url to equal $params['label'] ?

[monishdeb]

Thanks for pointing this, was a typo on my end :/ Updated the patch now.

[colemanw]

Why would we search for existing dashlets by label? Labels are not guaranteed to be unique.

The existing code has this legacy quirk where even if you don't pass an id it will still attempt to update based on name or url. Removing the matching on url feels like a good step forward. It removes half of the legacy behavior (which IMO would be nice to get rid of completely). But then this PR adds label in, which feels like a step backwards toward more legacy behavior. Can we just do name matching only?

[monishdeb]

Hmm agree, updated the patch. Can you please check now?

[demeritcowboy]

• General standards
  • [r-explain] PASS
  • [r-user] PASS
  • [r-doc] PASS
  • [r-run] PASS
    • I didn't test fancy things, like multiple domains, multiple users...
• Developer standards
  • [r-tech] PASS
  • [r-code] PASS
    • As far as I can tell the original version ONLY used url but that was before the limit existed. Then name was introduced for https://issues.civicrm.org/jira/browse/CRM-13892 and the default dashlets still seem to work here.
  • [r-maint] ?
  • [r-test] PASS

[monishdeb]

Jenkins test this please

[demeritcowboy]

This runs ok for me. And you can still have, e.g. two versions of the same civireport like chart and table as separate dashlets if you save a copy (separate report instance).