Transition.cancel bug in 2697?

Dave_Haynes · August 18, 2015, 1:38pm

My team and I just got Daily Build 2697. Two of the three of us are on Windows, so text input in the Windows Simulator is a huge deal.

However, transitions seem to be slightly broken now. Suddenly (without any other changes aside from getting latest daily build) our navigation menu started breaking, so I tracked down the issue, and this is what seems to be happening.

Our menu has a transition like so, in a hide() method:

transition.to(menuGroup, {time = 400, x = newX, transition=easing.outExpo, tag="menu", onComplete=function() &nbsp; &nbsp; print("making menuGroup.isVisible = false") &nbsp; &nbsp; menuGroup.isVisible = false end})

It basically slides offscreen, then we make it invisible after the transition completes. Note that we have set a tag to “menu”.

Inside our navigation menu class, we have a custom removeSelf:

local removeSelf = menuOverallGroup.removeSelf -- the original removeSelf() menuOverallGroup.removeSelf = function(self) print("inside menuOverallGroup.removeSelf") &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; transition.cancel("menu") &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; display.remove(menuGroup) menuGroup = nil &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp; -- finally, call the original removeSelf: removeSelf(self) end

That removeSelf function gets called when the scene that uses the navigation menu is destroyed:

display.remove(navigationMenuGroup) navigationMenuGroup = nil

So if the navigationmenu gets destroyed while it’s transitioning, that transition.cancel() inside removeSelf should stop all “menu” transitions from happening, but in my case, the onComplete still fired.

Console Log:

Aug 18 09:30:30.716: inside menu’s hide function

Aug 18 09:30:30.969: inside menuOverallGroup.removeSelf <-- should have cancelled the transition here

Aug 18 09:30:31.133: making menuGroup.isVisible = false <-- should not be happening

Aug 18 09:30:31.133: Runtime error (because menuGroup is nil already)

…attempt to index upvalue ‘menuGroup’ (a nil value)

After researching a bit, we noticed this from the Daily Build release notes:

Release notes for build 2015. through 2015.2693

_ All - Fix issues with transition library. _
Maintenance

So… is it possible that transition.cancel isn’t properly cancelling transitions now?

I was unable to reproduce this in a previous daily build (2687).

Thanks,

Dave

rob · August 18, 2015, 9:43pm

Engineering and QA don’t see a problem with our test cases. Please file a bug report on this. Include a basic test case that demonstrates the problem. It should be complete project (i.e. main.lua, config.lua, build.settings + any other assets needed to run) put in a .zip file. Use the “Report a bug” link at the top of the page to submit the bug. Include the link to this forum post in the text of the submission. When you get the email confirming submission, please post the CaseID # back here as a reference.

Thanks

Rob

Dave_Haynes · August 19, 2015, 1:15pm

While creating the example for the bug, I was able to make it happen on the older 2687 build as well. I’ve submitted the bug, but forgot to include a link to this forum post. (Doh!) It’s CaseID 42334

In the meantime, this is the gist of the code:

local testText = display.newText("TESTING...", display.contentCenterX, display.contentCenterY, native.systemFont, 18) transition.to(testText, {time=3000, alpha=0, tag="test", onComplete=function() print("This transition should be cancelled before we get here (see below), so this should never be printed.") end}) print("Attempting to cancel the transition") transition.cancel("test")

Is there anything wrong with that code to make it fail? Looks pretty similar to the code here:

https://docs.coronalabs.com/api/library/transition/cancel.html

What will happen, when that code runs is that the text will just fade to fully transparent, then the onComplete happens. It seems as if the transition.cancel never happens.

Thanks,

Dave

Dave_Haynes · August 19, 2015, 1:22pm

Also, it seems to only happen when using a tag.

This works as expected:

local testText = display.newText("TESTING...", display.contentCenterX, display.contentCenterY, native.systemFont, 18) local trans = transition.to(testText, {time=3000, alpha=0, tag="test"}) print("Attempting to cancel the transition") transition.cancel(trans)

Is there a way to edit a reported bug?

Thanks,

Dave

Alex10 · August 19, 2015, 1:27pm

Dave, I just tested your initial transition code with the tag on one of my dev machines, and it seemed to work as normal. Meaning, the transition was canceled. I’m using Win 7 64 bit with Corona 2015.2692.

I just now tested your transition variable cancellation as well, and that works for me too. I’m going to move up to another daily build shortly and report back if I see anything different.

Dave_Haynes · August 19, 2015, 1:45pm

@Alex, thanks for testing!

We noticed the problem initially on 2697, then I had gone back to 2687 and couldn’t reproduce it in our code.

So I created the simple example above to prove it, but I didn’t realize I was still on 2687. Strangely, the problem exists there. Switching back to 2697 (the one we initially had trouble with), transition.cancel is working as expected… So I’m perplexed.

I think maybe the transition.cancel(tagName) just needs someone to take a look at it and verify it’s working properly.

Thanks,

Dave

Dave_Haynes · August 19, 2015, 8:32pm

[I deleted my last post as there was actually an issue with it that I am resolving now. It’s what I get for trying to clean it up and then insufficiently testing my cleanup before posting…]

Alex10 · August 19, 2015, 8:48pm

Noted! I’ll do my best to give it a go when you get some code up.

Dave_Haynes · August 20, 2015, 12:43pm

I’m still looking into this. I cannot seem to reproduce it on demand. Code that previously worked in our app has started failing, and in the process of trying to prove it, I found the transition cancel bug that’s already been fixed, but can’t prove the problem that our app now has.

I can’t figure out what the magic combination is… I thought I had it figured out yesterday. I thought it was related to canceling a transition inside an object’s removeSelf, but then my contrived example (that I posted here, then deleted) had some other issues that was causing it to fail besides what I was trying to prove.

I’m going to spend a little bit more time on it this morning before throwing in the towel. Essentially I can fix my problem by just wrapping some code like so:

if menuGroup ~= nil then &nbsp; &nbsp;menuGroup.isVisible = false end

But what bothers me is that I don’t see any reason for that code (inside a transition’s onComplete) to ever fire… It should have been canceled, and I debugged, stepping through, and I see it start the transition, then I see it call transition.cancel on it a little later, and then the onComplete happens. It’s blowing my mind.

I’m wondering if something is somehow detaching the transition from whatever table/array they’re stored in, and then the transition.cancel(tagName) just doesn’t see it. But I can’t figure out what would be doing that.

Dave

Dave_Haynes · August 20, 2015, 6:25pm

Okay, I think I’m onto something. I don’t know exactly what is causing the problem, but I can finally reproduce it. I’ve been trying to make the example more concise, but I can’t seem to. This seems to be the magic combination.

local widget = require( "widget" ) local composer = require( "composer" ) composer.recycleOnSceneChange = true local scene = composer.newScene() local rect local scrollView local function removeObjectAndCancelTransition() &nbsp; &nbsp; print("-- Removing rect, which affects the scrollView group") &nbsp; &nbsp; display.remove(rect) &nbsp; &nbsp; rect = nil &nbsp; &nbsp; print("-- Should be cancelling transTag transition") &nbsp; &nbsp; transition.cancel("transTag") end -- "scene:create()" function scene:create( event ) &nbsp; &nbsp; local sceneGroup = self.view &nbsp; &nbsp; local group = display.newGroup() &nbsp; &nbsp; scrollView = widget.newScrollView { &nbsp; &nbsp; &nbsp; &nbsp; top = 0, &nbsp; &nbsp; &nbsp; &nbsp; left = 0, &nbsp; &nbsp; &nbsp; &nbsp; width = display.contentWidth, &nbsp; &nbsp; &nbsp; &nbsp; height = display.contentHeight, &nbsp; &nbsp; &nbsp; &nbsp; scrollWidth = display.contentWidth, &nbsp; &nbsp; &nbsp; &nbsp; scrollHeight = display.contentHeight, &nbsp; &nbsp; &nbsp; &nbsp; horizontalScrollDisabled = true, &nbsp; &nbsp; &nbsp; &nbsp; friction = .99, -- how fast the content travels when flicked; default is 0.972 &nbsp; &nbsp; &nbsp; &nbsp; backgroundColor = {0, 0, 0}, &nbsp; &nbsp; &nbsp; &nbsp; hideScrollBar = true &nbsp; &nbsp; } &nbsp; &nbsp; rect = display.newRect(0,0,100,100) &nbsp; &nbsp; rect:setFillColor(1,0,0,1) &nbsp; &nbsp; transition.to(rect,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; { &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; time = 1500,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; x = 100,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; transition = easing.outExpo,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; tag = "transTag",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; onComplete = function() &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; print("\*\*\* WRONG: Transition COMPLETED, but it should be CANCELLED! \*\*\*") &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; end, &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; onCancel = function() &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; print("\*\*\* RIGHT: Transaction CANCELLED, as expected \*\*\*") &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; end &nbsp; &nbsp; &nbsp; &nbsp; }) &nbsp; &nbsp; scrollView:insert(rect) &nbsp; &nbsp; group:insert(scrollView) &nbsp; &nbsp; -- Using a timer here so that the scene will be created properly before we attempt to destroy it. &nbsp; &nbsp; timer.performWithDelay(100, function() &nbsp; &nbsp; &nbsp; &nbsp; -- change the value of cancelAsExpected to see the difference. &nbsp; &nbsp; &nbsp; &nbsp; local cancelAsExpected = false &nbsp; &nbsp; &nbsp; &nbsp; if cancelAsExpected then &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; -- this cancels the transition as expected &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; composer.removeScene("scene1") &nbsp; &nbsp; &nbsp; &nbsp; else &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; -- this does not cancel the transition &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; composer.gotoScene("scene2", options) &nbsp; &nbsp; &nbsp; &nbsp; end &nbsp; &nbsp; end) end -- "scene:destroy()" function scene:destroy( event ) &nbsp; &nbsp; print("-- destroying scene1 --") &nbsp; &nbsp; local sceneGroup = self.view &nbsp; &nbsp; removeObjectAndCancelTransition() end -- ------------------------------------------------------------------------------- -- Unimportant stuff -- ------------------------------------------------------------------------------- -- "scene:show()" function scene:show( event ) end -- "scene:hide()" function scene:hide( event ) end -- Listener setup scene:addEventListener( "create", scene ) scene:addEventListener( "show", scene ) scene:addEventListener( "hide", scene ) scene:addEventListener( "destroy", scene ) -- ------------------------------------------------------------------------------- return scene

Both composer.removeScene and composer.gotoScene will call the destroy method in that example. However, the gotoScene version will not cancel the transition properly.

Thanks,

Dave

Dave_Haynes · August 20, 2015, 6:29pm

Note that the only way I can get it to fail is by having an item inserted into a scrollView, then display.removed… And I can only get it to break using composer.gotoScene.

It’s a fairly complicated combination, but it worked properly back in 2687, but not in 2697.

Thanks,

Dave

Michael_W · August 20, 2015, 6:48pm

Thanks Dave, we’ll look into it. Note that the work-around for now is to cancel the transition before removing the object. Change remvoeObjectAndCancelTransition to this, and your sample works as expected:

[lua]local function removeObjectAndCancelTransition()
print("-- Should be cancelling transTag transition")
transition.cancel(“transTag”)

    print("-- Removing rect, which affects the scrollView group")
    display.remove(rect)
    rect = nil
end[/lua]

Dave_Haynes · August 20, 2015, 6:58pm

Thanks, Michael. It’s unfortunately much more complicated than that in my actual app, which is why it took me about 3 days to figure out how to reproduce it in a simpler example.

Dave

Andrzej_Futuretro · September 24, 2015, 11:03am

Hi guys,

Just to add another voice to this, I’ve also found that in daily builds >2687 all kinds of weirdness has crept into my project and I’m fairly certain it’s related to transition.cancel no longer working. Unfortunately I can’t give you a clearer example, as like Dave my transitions are buried in a complex mess of code. I’m on OSX and the issues are prevalent in both the simulator and iOS device builds.

Many thanks,

Andrzej

// Futuretro Studios

Andrzej_Futuretro · September 24, 2015, 11:27am

In fact my problems with transitions began at precisely 2692. Everything was fine up to 2690 inclusive, and has remained broken including the latest (2722). I’ll see if I can’t provide some more substantial feedback when I get the chance.

Andrzej

greg_brady · September 25, 2015, 12:09pm

The problem tracking down this bug, is that everything works fine for a few minutes then it all goes sideways… like a heap that is being

blown away…

reedhos · September 26, 2015, 8:42am

I ran into issues with the transition library after upgrading to 2692. The problem for me was calling transition.cancel for a transition that was already cancelled/nil. Changing that fixed all my issues with transitions.

greg_brady · September 26, 2015, 1:05pm

I don’t call transition.cancel the problem still happens.

rob · August 18, 2015, 9:43pm

Engineering and QA don’t see a problem with our test cases. Please file a bug report on this. Include a basic test case that demonstrates the problem. It should be complete project (i.e. main.lua, config.lua, build.settings + any other assets needed to run) put in a .zip file. Use the “Report a bug” link at the top of the page to submit the bug. Include the link to this forum post in the text of the submission. When you get the email confirming submission, please post the CaseID # back here as a reference.

Thanks

Rob

Dave_Haynes · August 19, 2015, 1:15pm

While creating the example for the bug, I was able to make it happen on the older 2687 build as well. I’ve submitted the bug, but forgot to include a link to this forum post. (Doh!) It’s CaseID 42334

In the meantime, this is the gist of the code:

local testText = display.newText("TESTING...", display.contentCenterX, display.contentCenterY, native.systemFont, 18) transition.to(testText, {time=3000, alpha=0, tag="test", onComplete=function() print("This transition should be cancelled before we get here (see below), so this should never be printed.") end}) print("Attempting to cancel the transition") transition.cancel("test")

Is there anything wrong with that code to make it fail? Looks pretty similar to the code here:

https://docs.coronalabs.com/api/library/transition/cancel.html

What will happen, when that code runs is that the text will just fade to fully transparent, then the onComplete happens. It seems as if the transition.cancel never happens.

Thanks,

Dave