Fix bugs introduced with YogaKit improvements #328
Reference in New Issue
Block a user
No description provided.
Delete Branch "yogakit-edge-bugs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
I'm trying to fix some bugs I introduced in my latest PR, but while writing the Unit Tests for them, I saw a really weird behaviour. The following exact piece of code WORKS inside a Yoga C++ unit test, but fails from a Objective-C unit test. I had me completely confused and blocked me in my progression. Any ideas?
From C
From Objective-C
Btw, while stepping through the debugger, the Yoga
YGNodeStyleGetPosition
method seems to calculate the right value, but somehow, in between the value being returned and saved on the stack of the Objective-C method, theYGValue
struct is filled with nonsense.I committed the Objective-C tests if anybody wants to play with this @dshahidehpour @emilsjolander
@hartbit I'm patching onto my machine right now to take a look. Did you try running the tests via BUCK and Xcode? It should make absolutely no difference, just curious.
@dshahidehpour I tried both with BUCK and Xcode and got the same results. But as a side note, some other tests do fail when run through Xcode, for two reasons I think:
Xcode runs some tests in parallel, which cause
YGNodeGetInstanceCount
to return more instances than those of the test calling the function.Xcode defaults to running the tests on a retina simulator, which causes some of the UILabels to return slightly different sizes when
sizeThatFits
is called. Those tests should probably be written to not depend on precise values of UILabel sizes.David.
Not totally helpful, but, I tried running this test before the Swift API diff landed, and the test passes, not sure if this tells us anything helpful. I have to go offline, but I'll revisit ASAP!
Travis failed initially because I forgot to commit some minor changes. Lets see what it says now...
Travis won't run because my previous PR was reverted. Anyway, this is the command I run to test YogaKit and which fails on this branch:
@hartbit The diff has relanded, are you still seeing this issue after rebasing?
@dshahidehpour The diff fixed the problems I was having and I was able to finish this PR and fix the remaining bugs and add the required tests.
In doing so, I found a problem: the getters for the
horizontal
,vertical
andall
properties crashes because the Yoga C API throws an assert when attempting to get those values back, as if it was not expected. I fixed it by removing the assert in the C API and documenting the change by writing C unit tests that demonstrate what the output is supposed to me.I'm open to discussion.
@emilsjolander any idea why this is needed?
@@ -387,0 +408,4 @@
view.yoga.bottom = 4;
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).value, 4);
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).unit, YGUnitPixel);
XCTAssertEqual(view.yoga.bottom, 4);
I think we can remove the verification that
YGNodeRef
's setters are working, that shouldn't be our responsibility.I do think it's valuable to verify that they are set to
Pixel
values, though.I do think it's valuable to verify that getter for
view.yoga.*
works, and that it is aYGUnitPixel
would be more than enough. Any chance we can condense these tests so that we simply test that different@@ -387,0 +408,4 @@
view.yoga.bottom = 4;
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).value, 4);
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).unit, YGUnitPixel);
XCTAssertEqual(view.yoga.bottom, 4);
I think those tests are important. They were failing because a bug in the macros I wrote was causing the getters/setters to not be defined and Objective-C would therefore auto-synthesise them, causing the
YGNodeSet
functions to never be called. The tests make sure the macros are defined and called correctly to both (1) define the correct getters and setters and (2) have the setters callYGNodeSet
. Its so easy to mess up the macros and never see it.It is not needed i guess. but getting the computed value of "all" or "horizontal edge just does not make sense. e.g.
At this point resolving
marginHorizontal
does not make much sense. I don't think this should be fixed by removing the assert. If we want to return the value set then we should instead have another function to do so.@@ -387,0 +408,4 @@
view.yoga.bottom = 4;
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).value, 4);
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).unit, YGUnitPixel);
XCTAssertEqual(view.yoga.bottom, 4);
Thanks for clarifying!
I was just thinking that if we had a unit test that tested layout while using margin/paddng/border, etc, it would become clear that the
NodeRef
's weren't being properly set because the layout would be in correct. Since this accomplishes the same thing (yet in a slightly more verbose way) I won't argue the point anymore :) Thanks for the test cases!@emilsjolander So If I'm understanding you right we should:
ASSERT
back.YGEdgeAll
,YGEdgeHorizontal
,YGEdgeVertical
to access their respective representations.YGEdgeTests
since they are testing functionality we don't support.test*PropertiesWork
->test*Properties
revert
@@ -11,2 +12,3 @@
@interface YGLayout (Private)
@interface YGLayout ()
Why did you remove the
(Private)
?The tests should test that setting
node.marginHorizontal = 10
results in a a node withmarginLeft
andmarginRight
set. However there are already tests for this in Yoga so not sure what the value is in adding tests for this in yogakit as well.@@ -387,0 +408,4 @@
view.yoga.bottom = 4;
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).value, 4);
XCTAssertEqual(YGNodeStyleGetPosition(view.yoga.node, YGEdgeBottom).unit, YGUnitPixel);
XCTAssertEqual(view.yoga.bottom, 4);
I started with tests which tested the layout, but it felt like a duplication of tests in the C++ Yoga tests. I felt better with tests which read like what they are testing. But if you feel strongly about it, I don't mind updating the tests :)
But what would the getter of
marginHorizontal
do? Right now, I'm not aware of any function in Yoga which I can call which returns the non-computed value. Should I create it? But what should its name be? I wrote these tests as a result of removing the assert because with the assert, the getters of multi-edge shorthands crashed.Let's just not have a getter for
marginHorizontal
and similar for now. We don't allow this is any other versions anyways so if we were to change how those work it should not be part of this PR anyways.I think that would negatively affect the API in Swift and for users of Objective-C which want to use dot-notation. The whole point of the PR I wrote which was recently merged was to make the APIs cleaner by using properties. Reverting that for multi-edge shorthands looks really weird to me:
view.yoga.marginVertical = 20
is just syntax-sugar[view.yoga setMarginVertical:20]
. So (for ObjC) we can add- (void)setMarginVertical:
and still use the dot-syntax.Not sure how it translates for the Swift API, though.
I also wouldn't be against removing the computed edges from
YogaKit
It does work, but (1) we loose auto-completion and (2) it's kind of an anti-pattern to use dot-notation on methods.
The code I provided above is how it translates to Swift: we are forced to use the method syntax.
Sorry if I come across as vindicative. I'm just trying to express that I feel this would be a net-loss for the Objective-C and more importantly the Swift API. Can we try to think of solutions which would allow us the retain the getters? Here are some ideas to help me/us think about it:
We could implement the getters to return a value when the short-hand edges have the same value, and return undefined instead:
Any other ideas?
@hartbit What is the status of this?
@emilsjolander I am waiting for your feedback on my reply on the comment above to see what we do about the getters :)
@hartbit I agree we should keep these as being properties. I like the suggestion of returning
YGUndefined
when the semantics are not defined. I suggest for this pull request to always returnYGUndefined
for the property getters of YGEdgeAll/Horizontal/Vertical. That way we are able to land the rest of this PR. In a follow up issue / PR we can discuss improving this by implementing what you suggested above. How does that sound?Done
@@ -11,2 +12,3 @@
@interface YGLayout (Private)
@interface YGLayout ()
That's required because the private header now contains a property (
node
, which needs to be accessed in the tests) and which isn't synthesised if declared in a category, compared to a private interface definition.@emilsjolander All done for me. I did as you suggested and made all shorthand edge getters return
YGUndefined
for now :)@hartbit travis is failing
@emilsjolander My bad. It's fixed now. Had forgotten to remove the tests I had added to prove that the removable of the ASSERT was behaving as expected. The tests are not necessary now that I put the ASSERT back.
@emilsjolander has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
Pull request closed