Merge lp:~mterry/unity8/tutorial-reappears into lp:unity8

[Michael Terry]

Make sure the edge tutorial is destroyed when we receive a call during the wizard.

Make sure the edge tutorial is destroyed when we receive a call during the wizard.

Now... This bug doesn't make sense to me. What's happening is that the Tutorial.qml Loader is correctly marked as "active=false". But the loaded object is not actually released/destroyed.

I couldn't figure why this was happening. And I couldn't reproduce it via qmltests. In all cases I saw, the object was correctly destroyed. But I could reproduce the bug on the device. And adding log printfs indicated that yup, the object was staying around after Loader.active was false.

But on a hunch, cleaning up the object hierarchy helped. Before, each tutorial page would have a visual parent of "shell.stages" but a QtObject parent of the tutorial loader item. This is a leftover from before the latest tutorial redesign. Now visual parents *shouldn't* affect object lifecycle, I think...? But it seems like it does.

Because when I made the tutorial page's visual parents be the same as their QtObject parents (and just moved the whole Tutorial object underneath shell.stages), it worked fine. The tutorial objects were destroyed when the loader went inactive.

Do any Qml-heads know why this happens? I would guess some refcounting somewhere, but I don't know why I couldn't reproduce in qmltests.

I added some sanity checks at the end of the current test for wizard/tutorial early exit, which don't hurt. But even without my qml changes, they still pass (because I could never reproduce this bug in laboratory conditions).

== Checklist ==

 * Are there any related MPs required for this MP to build/function as expected? Please list.
 No

 * Did you perform an exploratory manual test run of your code change and any related functionality?
 Yes

 * Did you make sure that your branch does not contain spurious tags?
 Yes

 * If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
 NA

 * If you changed the UI, has there been a design review?
 NA

[Michael Terry (mterry)]

(Oh yeah, and I cleared out a couple unused vestigial properties: stages and overlay)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1699
http://jenkins.qa.ubuntu.com/job/unity8-ci/5490/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/1993
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/654
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/655
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/655
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/1755
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1991
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/1991/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/19200

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/5490/rebuild

review: Needs Fixing (continuous-integration)

[Albert Astals Cid (aacid)]

 * Did you perform an exploratory manual test run of the code change and any related functionality?
Yes

 * Did CI run pass?
It passed up to the expected passing standards

 * Did you make sure that the branch does not contain spurious tags?
Yes

review: Approve

=== modified file 'qml/Shell.qml'
--- qml/Shell.qml	2015-04-03 14:23:47 +0000
+++ qml/Shell.qml	2015-04-03 14:23:47 +0000
@@ -283,6 +283,31 @@
                 value: shell.background
             }
         }
+
+        Tutorial {
+            id: tutorial
+            objectName: "tutorial"
+            anchors.fill: parent
+            active: AccountsService.demoEdges
+            paused: LightDM.Greeter.active
+            launcher: launcher
+            panel: panel
+            edgeSize: shell.edgeSize
+
+            // EdgeDragAreas don't work with mice.  So to avoid trapping the user,
+            // we'll tell the tutorial to avoid using them on the Desktop.  The
+            // Desktop doesn't use the same spread design anyway.  The tutorial is
+            // all a bit of a placeholder on non-phone form factors right now.
+            // When the design team gives us more guidance, we can do something
+            // more clever here.
+            // TODO: use DeviceConfiguration instead of checking source
+            useEdgeDragArea: applicationsDisplayLoader.source != Qt.resolvedUrl("Stages/DesktopStage.qml")
+
+            onFinished: {
+                AccountsService.demoEdges = false;
+                active = false; // for immediate response / if AS is having problems
+            }
+        }
     }
 
     InputMethod {
@@ -580,32 +605,6 @@
         }
     }
 
-    Tutorial {
-        id: tutorial
-        objectName: "tutorial"
-        active: AccountsService.demoEdges
-        paused: LightDM.Greeter.active
-        launcher: launcher
-        panel: panel
-        stages: stages
-        overlay: overlay
-        edgeSize: shell.edgeSize
-
-        // EdgeDragAreas don't work with mice.  So to avoid trapping the user,
-        // we'll tell the tutorial to avoid using them on the Desktop.  The
-        // Desktop doesn't use the same spread design anyway.  The tutorial is
-        // all a bit of a placeholder on non-phone form factors right now.
-        // When the design team gives us more guidance, we can do something
-        // more clever here.
-        // TODO: use DeviceConfiguration instead of checking source
-        useEdgeDragArea: applicationsDisplayLoader.source != Qt.resolvedUrl("Stages/DesktopStage.qml")
-
-        onFinished: {
-            AccountsService.demoEdges = false;
-            active = false; // for immediate response / if AS is having problems
-        }
-    }
-
     Connections {
         target: SessionBroadcast
         onShowHome: showHome()

=== modified file 'qml/Tutorial/Tutorial.qml'
--- qml/Tutorial/Tutorial.qml	2015-04-03 14:23:47 +0000
+++ qml/Tutorial/Tutorial.qml	2015-04-03 14:23:47 +0000
@@ -27,8 +27,6 @@
 
     property Item launcher
     property Item panel
-    property Item stages
-    property Item overlay
 
     readonly property bool launcherEnabled: loader.item ? loader.item.launcherEnabled : true
     readonly property bool spreadEnabled: loader.item ? loader.item.spreadEnabled : true
@@ -79,18 +77,6 @@
             value: root.panel
         }
 
-        Binding {
-            target: loader.item
-            property: "stages"
-            value: root.stages
-        }
-
-        Binding {
-            target: loader.item
-            property: "overlay"
-            value: root.overlay
-        }
-
         Connections {
             target: loader.item
             onFinished: root.finished()

=== modified file 'qml/Tutorial/TutorialContent.qml'
--- qml/Tutorial/TutorialContent.qml	2015-04-03 14:23:47 +0000
+++ qml/Tutorial/TutorialContent.qml	2015-04-03 14:23:47 +0000
@@ -22,8 +22,6 @@
 
     property Item launcher
     property Item panel
-    property Item stages
-    property Item overlay
 
     readonly property bool launcherEnabled: !running ||
                                             (!paused && tutorialLeft.shown)
@@ -67,7 +65,6 @@
     TutorialLeft {
         id: tutorialLeft
         objectName: "tutorialLeft"
-        parent: root.stages
         anchors.fill: parent
         launcher: root.launcher
         paused: !shown || root.paused
@@ -78,7 +75,6 @@
     TutorialLeftFinish {
         id: tutorialLeftFinish
         objectName: "tutorialLeftFinish"
-        parent: root.stages
         anchors.fill: parent
         textXOffset: root.launcher.panelWidth
         paused: !shown || root.paused
@@ -99,7 +95,6 @@
     TutorialRight {
         id: tutorialRight
         objectName: "tutorialRight"
-        parent: root.stages
         anchors.fill: parent
         edgeSize: root.edgeSize
         panel: root.panel
@@ -111,7 +106,6 @@
     TutorialBottom {
         id: tutorialBottom
         objectName: "tutorialBottom"
-        parent: root.stages
         anchors.fill: parent
         edgeSize: root.edgeSize
         paused: !shown || root.paused
@@ -122,7 +116,6 @@
     TutorialBottomFinish {
         id: tutorialBottomFinish
         objectName: "tutorialBottomFinish"
-        parent: root.stages
         anchors.fill: parent
         backgroundFadesOut: true
         paused: !shown || root.paused

=== modified file 'tests/qmltests/tst_Shell.qml'
--- tests/qmltests/tst_Shell.qml	2015-04-03 14:23:47 +0000
+++ tests/qmltests/tst_Shell.qml	2015-04-03 14:23:47 +0000
@@ -988,6 +988,11 @@
             tryCompare(ApplicationManager, "focusedApplicationId", "gallery-app");
             compare(wizard.shown, false);
             compare(tutorial.running, false);
+            tryCompare(AccountsService, "demoEdges", false);
+            tryCompare(Wizard.System, "wizardEnabled", false);
+
+            var tutorialLeft = findChild(tutorial, "tutorialLeft");
+            compare(tutorialLeft, null); // should be destroyed with tutorial
         }
 
         function test_tapOnRightEdgeReachesApplicationSurface() {