plotly / plotly/plotly.js

diffConfig always returns true if modeBarButtons (array of array) is populated

Ouverte
#5,273 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug P3
Langage dominant
JavaScript
Étoiles
18.3k
Forks
2k
Merge moyen
2 j 12 h
PR mergées (30 j)
28

Description

diffConfig function has bug where it always returns true if modeBarButtons (array of array) is populated. This results in unnecessary re-rendering. The function should check if the array member is array inside a for loop, It should be -

/*

  • simple diff for config - for now, just treat all changes as equivalent
    */
    function diffConfig(oldConfig, newConfig) {
    var key;

    for(key in oldConfig) {
    if(key.charAt(0) === '_') continue;
    var oldVal = oldConfig[key];
    var newVal = newConfig[key];
    if(oldVal !== newVal) {
    if(Lib.isPlainObject(oldVal) && Lib.isPlainObject(newVal)) {
    if(diffConfig(oldVal, newVal)) {
    return true;
    }
    } else if(Array.isArray(oldVal) && Array.isArray(newVal)) {
    if(oldVal.length !== newVal.length) {
    return true;
    }

             for(var i = 0; i < oldVal.length; i++) {
                 if(oldVal[i] !== newVal[i]) {
     				**if(Array.isArray(oldVal[i]) && Array.isArray(newVal[i])){
     					if(diffConfig(oldVal[i], newVal[i])) {
     						return true;
     					}
     				}							
                     else** if(Lib.isPlainObject(oldVal[i]) && Lib.isPlainObject(newVal[i])) {
                         if(diffConfig(oldVal[i], newVal[i])) {
                             return true;
                         }
                     } else {
                         return true;
                     }
                 }
             }
         } else {
             return true;
         }
     }
    

    }
    }

e.g Config object used -

const plotlyConfig: Partial = {
responsive: true,
displaylogo: false,
displayModeBar: true,
doubleClick: false,
showTips: false,
scrollZoom: false,
modeBarButtons: [
[
'select2d',
'lasso2d',
'zoom2d',
'pan2d',
'resetScale2d',
],
],
locale: language,
locales: locales
}

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Localisez la fonction diffConfig et utilisez l’exemple plotlyConfig avec des tableaux modeBarButtons imbriqués comme cas de reproduction. Comparez les tableaux imbriqués équivalents et vérifiez que les configurations inchangées ne sont pas signalées comme différentes, afin d’éviter le re-rendu inutile ; l’issue ne nomme aucun fichier ni test.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
data-visualization, frontend
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.