Skip to content

fix: Update config diff check method to handle nested arrays #7579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
camdecoster merged 13 commits into from
Oct 15, 2025
Merged

fix: Update config diff check method to handle nested arrays #7579

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b480d04
Linting/formatting
camdecoster Oct 10, 2025
34a669e
Move diff function to helpers and update to handle nested arrays
camdecoster Oct 10, 2025
364466a
Add tests for diff function
camdecoster Oct 10, 2025
3b3816f
Switch object clone method to keep undefined values in clone
camdecoster Oct 10, 2025
20c534f
Switch loops to improve performance
camdecoster Oct 13, 2025
47be541
Fix test label
camdecoster Oct 13, 2025
ef102cc
Add draftlog
camdecoster Oct 13, 2025
1b65938
Fix bad loop conversion
camdecoster Oct 14, 2025
0da832e
Move constant to top of file; remove unused require
camdecoster Oct 14, 2025
2767f07
Switch method to check for equality
camdecoster Oct 15, 2025
01e698a
Update tests per method change
camdecoster Oct 15, 2025
8ceebdf
Handle when collections aren't objects or object+array
camdecoster Oct 15, 2025
3bc5b7e
Add more tests
camdecoster Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Switch method to check for equality
  • Loading branch information
@camdecoster
camdecoster committed Oct 15, 2025
commit 2767f07db7b06256c470aeef6dbb88a51ff301af
44 changes: 22 additions & 22 deletions src/plot_api/helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
'use strict';

var isNumeric = require('fast-isnumeric');
var m4FromQuat = require('gl-mat4/fromQuat');

var Registry = require('../registry');
var Lib = require('../lib');
Expand Down Expand Up @@ -510,39 +509,40 @@ exports.clearAxisTypes = function (gd, traces, layoutUpdate) {
};

/**
* Check if a collection (object or array) has changed given two versions of
* the collection: old and new.
* Check if two collections (object or array) are equal
*
* @param {Object|Array} oldCollection: Old version of collection to compare
* @param {Object|Array} newCollection: New version of collection to compare
* @param {Object|Array} collection1: First collection to compare
* @param {Object|Array} collection2: Second collection to compare
*/
const hasCollectionChanged = (oldCollection, newCollection) => {
const collectionsAreEqual = (collection1, collection2) => {
const isArrayOrObject = (...vals) => vals.every((v) => Lib.isPlainObject(v)) || vals.every((v) => Array.isArray(v));
if ([oldCollection, newCollection].every((a) => Array.isArray(a))) {
if (oldCollection.length !== newCollection.length) return true;
if ([collection1, collection2].every((a) => Array.isArray(a))) {
if (collection1.length !== collection2.length) return false;

for (let i = 0; i < oldCollection.length; i++) {
const oldVal = oldCollection[i];
const newVal = newCollection[i];
for (let i = 0; i < collection1.length; i++) {
const oldVal = collection1[i];
const newVal = collection2[i];
if (oldVal !== newVal) {
const hasChanged = isArrayOrObject(oldVal, newVal) ? hasCollectionChanged(oldVal, newVal) : true;
if (hasChanged) return true;
const equal = isArrayOrObject(oldVal, newVal) ? collectionsAreEqual(oldVal, newVal) : false;
if (!equal) return false;
}
}

return true;
} else {
if (Object.keys(oldCollection).length !== Object.keys(newCollection).length) return true;
if (Object.keys(collection1).length !== Object.keys(collection2).length) return false;

for (const k in oldCollection) {
for (const k in collection1) {
if (k.startsWith('_')) continue;
const oldVal = oldCollection[k];
const newVal = newCollection[k];
const oldVal = collection1[k];
const newVal = collection2[k];
if (oldVal !== newVal) {
const hasChanged = isArrayOrObject(oldVal, newVal) ? hasCollectionChanged(oldVal, newVal) : true;
if (hasChanged) return true;
const equal = isArrayOrObject(oldVal, newVal) ? collectionsAreEqual(oldVal, newVal) : false;
if (!equal) return false;
}
}
}

return false;
return true;
}
};
exports.hasCollectionChanged = hasCollectionChanged;
exports.collectionsAreEqual = collectionsAreEqual;
2 changes: 1 addition & 1 deletion src/plot_api/plot_api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2610,7 +2610,7 @@ function react(gd, data, layout, config) {
const oldConfig = Lib.extendDeepAll({}, gd._context);
gd._context = undefined;
setPlotContext(gd, config);
configChanged = helpers.hasCollectionChanged(oldConfig, gd._context);
configChanged = !helpers.collectionsAreEqual(oldConfig, gd._context);
}

if (configChanged) {
Expand Down