Skip to content

Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template #4904

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
merged 14 commits into from
Jun 17, 2020
Merged

Fix setting tickwidth, tickcolor, ticklen, linecolor and possibly more attributes via template #4904

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
bddaafa
allow template input in Lib.coerce2 - fix issue 4852
archmoj Jun 5, 2020
11fd23c
update axes_breaks-round-weekdaysm baseline
archmoj Jun 5, 2020
756a0ee
refactor coerce rename v to valIn
archmoj Jun 7, 2020
a2c1c93
refactor coerce rename out to valOut
archmoj Jun 7, 2020
8d0b4cb
exit early
archmoj Jun 7, 2020
5c3be81
rename propOut to valOut
archmoj Jun 7, 2020
642bf28
add internal _coerce function
archmoj Jun 7, 2020
57cec14
reduce condition checks
archmoj Jun 8, 2020
1d9cc4a
keep track of source and input in _coerce function
archmoj Jun 9, 2020
cf7c061
fixup Lib.coerce2 description and color test
archmoj Jun 10, 2020
21b86cd
add jasmine tests to cover invalid inputs in Lib.coerce2
archmoj Jun 10, 2020
2b911d1
make room for opts - rename opts to attr
archmoj Jun 16, 2020
adc36cd
validate input when calling from coerce2
archmoj Jun 16, 2020
24d1da9
remove unnecessary validation, also
archmoj Jun 17, 2020
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
69 changes: 46 additions & 23 deletions src/lib/coerce.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,58 +361,81 @@ exports.valObjectMeta = {
* as a convenience, returns the value it finally set
*/
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
var opts = nestedProperty(attributes, attribute).get();
return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
var shouldValidate = (opts || {}).shouldValidate;

var attr = nestedProperty(attributes, attribute).get();
if(dflt === undefined) dflt = attr.dflt;
var src = ''; // i.e. default

var propIn = nestedProperty(containerIn, attribute);
var propOut = nestedProperty(containerOut, attribute);
var v = propIn.get();
var valIn = propIn.get();

var template = containerOut._template;
if(v === undefined && template) {
v = nestedProperty(template, attribute).get();
if(valIn === undefined && template) {
valIn = nestedProperty(template, attribute).get();
if(valIn !== undefined && shouldValidate && validate(valIn, attr)) src = 't'; // template
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see - shouldValidate is really just used to improve performance for regular coerce by skipping these extra validation steps. Very nice.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That said, is this particular line actually necessary? Since this step is overwriting valIn, after this we're going to treat it as though it came from the container, so on line 406 (or 398) we'll reset it to 'c'. In practice we don't care about this for now - given the coerce2 logic all we care about is truthy (specified) or falsy (default), but in case that ever changes, seems like we should either:

  • remove this line and pick a single truthy value for src so future users don't think 'c' vs 't' is accurate
  • or fix lines 398 and 406 to preserve a pre-existing 't', something like:
// 398
src: src || 'c'
//406
if(!src && valOut !== undefined && shouldValidate && validate(valIn, attr)) src = 'c';

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Revised in 24d1da9.


// already used the template value, so short-circuit the second check
template = 0;
}

if(dflt === undefined) dflt = opts.dflt;

/**
* arrayOk: value MAY be an array, then we do no value checking
* at this point, because it can be more complicated than the
* individual form (eg. some array vals can be numbers, even if the
* single values must be color strings)
*/
if(opts.arrayOk && isArrayOrTypedArray(v)) {
propOut.set(v);
return v;
if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
propOut.set(valIn);
return {
inp: valIn,
val: valIn,
src: 'c' // container
};
}

var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
coerceFunction(v, propOut, dflt, opts);
var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
coerceFunction(valIn, propOut, dflt, attr);

var valOut = propOut.get();
if(valOut !== undefined && shouldValidate && validate(valIn, attr)) src = 'c'; // container

var out = propOut.get();
// in case v was provided but invalid, try the template again so it still
// overrides the regular default
if(template && out === dflt && !validate(v, opts)) {
v = nestedProperty(template, attribute).get();
coerceFunction(v, propOut, dflt, opts);
out = propOut.get();
if(template && valOut === dflt && !validate(valIn, attr)) {
valIn = nestedProperty(template, attribute).get();
coerceFunction(valIn, propOut, dflt, attr);
valOut = propOut.get();

if(valOut !== undefined && shouldValidate && validate(valIn, attr)) src = 't'; // template
}
return out;
};

return {
inp: valIn,
val: valOut,
src: src
};
}

/**
* Variation on coerce
* useful when setting an attribute to a valid value
* can change the default for another attribute.
*
* Uses coerce to get attribute value if user input is valid,
* returns attribute default if user input it not valid or
* returns false if there is no user input.
*/
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
var propIn = nestedProperty(containerIn, attribute);
var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
var valIn = propIn.get();

return (valIn !== undefined && valIn !== null) ? propOut : false;
var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
shouldValidate: true
});
return (out.src && out.inp !== undefined) ? out.val : false;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I'm not sure about this, but at this point I think the best way to handle it will be extensive jasmine testing.

I see we actually do have a test that contradicts one thing I was hoping to "fix":

plotly.js/test/jasmine/tests/lib_test.js

Line 781 in be70865

it('should set and return the default if the user input is not valid', function() {

Do we have a good reason for that behavior? It seems contrary to what we do with templates, as well as contrary to what I think the purpose of coerce2 should be, which would be stated something like:

should set the default and return false if the user input is not valid

@archmoj do you see any issue if we make such a change? I feel like that test is locking down a bug rather than useful behavior.

(while we're at it there's a piece of copypasta in that test

plotly.js/test/jasmine/tests/lib_test.js

Lines 795 to 798 in be70865

expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
expect(sizeOut).toBe(outObj.testMarker.testSize);
- should be 2 colOut lines and 2 sizeOut lines)

So what I'd like to see is a test covering each of the valTypes used by coerce2, and for each one:

  • valid input in the container
  • valid input in the container but changing type (ie '2' to 2) if such a thing exists for this valType
  • invalid input in the container OR no input in the container, with:
    • no input in the template
    • invalid input in the template
    • valid input in the template
    • valid input in the template but changing type (ie '2' to 2) if such a thing exists for this valType

I suspect getting this to work for all valTypes may not be worthwhile - especially since there are things like colorscale where even the default may be "fixed" by the coercion process, and subplotid where the default affects which input values are allowed. But we should be able to find a way to make it work for the ones we actually use for coerce2

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexcjohnson thanks for the review. Please see cf7c061 and 21b86cd.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexcjohnson wondering what should be the result of this test?
https://github.com/plotly/plotly.js/blob/master/test/jasmine/tests/axes_test.js#L1791-L1797
Shouldn't it be

expect(yaxis.ticklen).toBe(undefined);
expect(yaxis.tickwidth).toBe(undefined);
expect(yaxis.tickcolor).toBe(undefined);
expect(yaxis.ticks).toBe('');

?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexcjohnson this PR is ready for another review.
Please see adc36cd.

};

/*
Expand Down
Binary file modified test/image/baselines/axes_breaks-round-weekdays.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 42 additions & 38 deletions test/image/mocks/axes_custom-ticks_log-date.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,48 @@
"layout": {
"width": 500,
"height": 300,
"title": {
"text": "custom ticks on date & log axes"
},
"paper_bgcolor": "lightblue",
"plot_bgcolor": "#ddd",
"yaxis": {
"type": "log",
"tickmode": "array",
"tickvals": [
1,
10,
100
],
"ticktext": [
"one",
"ten",
"one<br>hundred"
],
"gridwidth": 2,
"tickwidth": 15,
"tickcolor": "green",
"gridcolor": "green"
},
"xaxis": {
"type": "date",
"tickmode": "array",
"tickvals": [
"2010-01-16",
"2010-02-14"
],
"ticktext": [
"Jan 16",
"Feb 14"
],
"gridwidth": 10,
"tickwidth": 50,
"tickcolor": "rgba(255,0,0,0.75)",
"gridcolor": "rgba(255,0,0,0.25)"
"template": {
"layout": {
"title": {
"text": "custom ticks on date & log axes"
},
"paper_bgcolor": "lightblue",
"plot_bgcolor": "#ddd",
"yaxis": {
"type": "log",
"tickmode": "array",
"tickvals": [
1,
10,
100
],
"ticktext": [
"one",
"ten",
"one<br>hundred"
],
"gridwidth": 2,
"tickwidth": 15,
"tickcolor": "green",
"gridcolor": "green"
},
"xaxis": {
"type": "date",
"tickmode": "array",
"tickvals": [
"2010-01-16",
"2010-02-14"
],
"ticktext": [
"Jan 16",
"Feb 14"
],
"gridwidth": 10,
"tickwidth": 50,
"tickcolor": "rgba(255,0,0,0.75)",
"gridcolor": "rgba(255,0,0,0.25)"
}
}
}
}
}
8 changes: 4 additions & 4 deletions test/jasmine/tests/axes_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1803,10 +1803,10 @@ describe('Test axes', function() {
Plotly.plot(gd, data, layout);

var yaxis = gd._fullLayout.yaxis;
expect(yaxis.ticklen).toBe(5);
expect(yaxis.tickwidth).toBe(1);
expect(yaxis.tickcolor).toBe('#444');
expect(yaxis.ticks).toBe('outside');
expect(yaxis.ticklen).toBe(undefined);
expect(yaxis.tickwidth).toBe(undefined);
expect(yaxis.tickcolor).toBe(undefined);
expect(yaxis.ticks).toBe('');
expect(yaxis.showticklabels).toBe(true);
expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
expect(yaxis.tickangle).toBe('auto');
Expand Down
74 changes: 71 additions & 3 deletions test/jasmine/tests/lib_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ describe('Test lib.js:', function() {
expect(sizeOut).toBe(outObj.testMarker.testSize);
});

it('should set and return the default if the user input is not valid', function() {
it('should set the default and return false if the user input is not valid', function() {
var colVal = 'r';
var sizeVal = 'aaaaah!';
var attrs = {
Expand All @@ -792,12 +792,80 @@ describe('Test lib.js:', function() {
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe('rgba(0, 0, 0, 0)');
expect(colOut).toBe(false);
expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(false);
expect(outObj.testMarker.testSize).toBe(20);
});

it('should set the user input', function() {
var colVal = 'red';
var sizeVal = '1e2';
var attrs = {
testMarker: {
testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
testSize: {valType: 'number', dflt: 20}
}
};
var obj = {testMarker: {testColor: colVal, testSize: sizeVal}};
var outObj = {};
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe('red');
expect(colOut).toBe(outObj.testMarker.testColor);
expect(sizeOut).toBe(100);
expect(sizeOut).toBe(outObj.testMarker.testSize);
expect(sizeOut).toBe(20);
});

it('should set to template if the container input is not valid', function() {
var attrs = {
testMarker: {
testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
testSize: {valType: 'number', dflt: 20}
}
};
var obj = {
testMarker: {testColor: 'invalid', testSize: 'invalid'}
};
var outObj = {
_template: {
testMarker: {testColor: 'red', testSize: '1e2'}
}
};
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe('red');
expect(colOut).toBe(outObj.testMarker.testColor);
expect(sizeOut).toBe(100);
expect(sizeOut).toBe(outObj.testMarker.testSize);
});

it('should set to default and return false if the both container and template inputs are not valid', function() {
var attrs = {
testMarker: {
testColor: {valType: 'color', dflt: 'rgba(0, 0, 0, 0)'},
testSize: {valType: 'number', dflt: 20}
}
};
var obj = {
testMarker: {testColor: 'invalid', testSize: 'invalid'}
};
var outObj = {
_template: {
testMarker: {testColor: 'invalid', testSize: 'invalid'}
}
};
var colOut = coerce2(obj, outObj, attrs, 'testMarker.testColor');
var sizeOut = coerce2(obj, outObj, attrs, 'testMarker.testSize');

expect(colOut).toBe(false);
expect(outObj.testMarker.testColor).toBe('rgba(0, 0, 0, 0)');
expect(sizeOut).toBe(false);
expect(outObj.testMarker.testSize).toBe(20);
});

it('should return false if there is no user input', function() {
var colVal = null;
var sizeVal; // undefined
Expand Down