[SRU] Page not found error on refreshing bowser (in AngularJS-based detail page)

[hongbin]

[Impact]

When clicking instances snapshot detail on Images menu and then refresh the pages will get an error:
```
The page you were looking for doesn't exist
You may have mistyped the address or the page may have moved.
```

[Test Case]

1. Deply a OpenStack env with horizon
2. Click instances snapshot detail on Images menu
3. Refresh the page
4. Check if you will see the error 'The page you were looking for doesn't exist'

[Regression Potential]

This problem has been fixed in Queens with two patches [1][2], we need to backport them into Ocata as well.

But in fact, directly backporting these two primitive patches [1][2] into Ocata will not be able to work, because:

1, In Ocata release, getDetailsPath returns "'project/ngdetails/OS::Glance::Image/' + item.id;"

https://github.com/openstack/horizon/blob/stable/ocata/openstack_dashboard/static/app/core/images/images.service.js#L59

function getDetailsPath(item) {
return 'project/ngdetails/OS::Glance::Image/' + item.id;
}

2, In > Ocata release, eg: Pike release, getDetailsPath returns "detailRoute + 'OS::Glance::Image/' + item.id"

https://github.com/openstack/horizon/blob/stable/pike/openstack_dashboard/static/app/core/images/images.service.js#L69

function getDetailsPath(item) {
return detailRoute + 'OS::Glance::Image/' + item.id;
}

So we will see the error 'The current URL, project/ngdetails/OS::Glance::Image/46ef8cab-dfc3-4690-8abb-d416978d237e, didn't match any of these.' when backporting two primitive patches into Ocata. So the following simple changes need to be made in urls.py in addition to the primitive backport patches as well.

-ngdetails_url = url(r'^ngdetails/',
+ngdetails_url = url(r'^project/ngdetails/',

[1] https://review.openstack.org/#/c/541676/
[2] https://review.openstack.org/#/c/553970/

[Original Bug Report]

Once I get into the container detail view, refresh the browser will show a page not found error:

  The current URL, ngdetails/OS::Zun::Container/c54ba416-a955-45b2-848b-aee57b748e08, didn't match any of these

Full output: http://paste.openstack.org/show/605296/

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/477447

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/477461

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/477447
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=fe0df4579cd091caa49a5a0a14bc3b3d93bcd1a4
Submitter: Jenkins
Branch: master

commit fe0df4579cd091caa49a5a0a14bc3b3d93bcd1a4
Author: Shu Muto <email address hidden>
Date: Thu May 25 18:39:15 2017 +0900

    Enable to refresh ngdetails view

    For now refreshing ngdetails view by browser using F5 key or reload
    button, it causes 404 error from django. To fix this issue, this patch
    adds the url for '/ngdetails'.

    Furthermore, to specify current navigation and to check access grants
    to current panel, each access to Horizon django framework needs its
    dashboard and panel objects. It means that we need to specify dashboard
    and panel that ngdetails view belongs to.

    Also, this patch adds the process and settings to specify dashboard and
    panel object for each ngdetails view.

    Change-Id: I4bcffd2e222ce2df186551cceba0aa38f600d9c8
    Closes-Bug: #1681627

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/477461
Committed: https://git.openstack.org/cgit/openstack/zun-ui/commit/?id=7bee55d9258c67de922c656e2428522c6f9b36da
Submitter: Jenkins
Branch: master

commit 7bee55d9258c67de922c656e2428522c6f9b36da
Author: Shu Muto <email address hidden>
Date: Mon Jun 26 17:50:24 2017 +0900

    Enable to refresh details view

    For now refreshing details view by browser using F5 key or reload
    button, it causes 404 error from django. This patch fixes this issue.

    Change-Id: I3deb51a3895ad65be6e83dac61a4a5982ac21c45
    Closes-Bug: #1681627
    Depends-On: I4bcffd2e222ce2df186551cceba0aa38f600d9c8

[Bence Romsics (bence-romsics)]

This could be reopened because of the revert under review: https://review.openstack.org/490131. Or do we open a new bug after a revert?

For the record this affects the details page of the 'trunks' panel just as well as the 'images', 'users' and 'domains' panels.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/491346

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/491349

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon 12.0.0.0rc1 release candidate.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/zun-ui 0.2.0 release.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/496511

[OpenStack Infra (hudson-openstack)]

Change abandoned by Shu Muto (<email address hidden>) on branch: master
Review: https://review.openstack.org/496511
Reason: Due to another idea, I will implement in original patch: https://review.openstack.org/#/c/491346/

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/520340

[Akihiro Motoki (amotoki)]

We discussed the plan on this bug in the horizon team meeting. The conclusion is we will land only https://review.openstack.org/#/c/520340/ (which just allows refresh) in Queens and discuss how to recover navigation in Rocky.
Based on this, this bug will be closed by https://review.openstack.org/#/c/520340/ and the latter will be tackled as a separate bug.

[Akihiro Motoki (amotoki)]

bug 1746706 is filed on the navigation issue.

[Akihiro Motoki (amotoki)]

there is another issue (bug 1746709) too. This also needs to be tackled later.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/520340
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=077163a03c9aea08efd56251e49d69eb1cc4d093
Submitter: Zuul
Branch: master

commit 077163a03c9aea08efd56251e49d69eb1cc4d093
Author: Shu Muto <email address hidden>
Date: Thu Nov 16 16:55:46 2017 +0900

    Enable to refresh ngdetails view

    For now, refreshing ngdetails view by browser using F5 key or reload
    button, it causes 404 error from django. To fix this issue, this patch
    adds the url for '/ngdetails' into django.

    To reproduce navigations, each request for views.py requires
    'dashboard' and 'panel' object. Otherwise django side returns
    500 error.

    However the URL for request of details page (i.e. /ngdetails/)
    can not provide informations to set the proper navigation.

    So this patch set them to default dashboard and default panel.

    This patch focuses to prevent 500 error. So the issue for
    settings of proper navigation will be fixed by subsequent patch.

    Change-Id: Ib9f1fe48b3cdecff5ad56e68a5ba58a41cb35f38
    Closes-Bug: #1681627

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/541676

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon 13.0.0.0rc1 release candidate.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/541676
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=a0fc40b4e85d3090e657cca9824de719b33a7ba2
Submitter: Zuul
Branch: stable/pike

commit a0fc40b4e85d3090e657cca9824de719b33a7ba2
Author: Shu Muto <email address hidden>
Date: Thu Nov 16 16:55:46 2017 +0900

    Enable to refresh ngdetails view

    For now, refreshing ngdetails view by browser using F5 key or reload
    button, it causes 404 error from django. To fix this issue, this patch
    adds the url for '/ngdetails' into django.

    To reproduce navigations, each request for views.py requires
    'dashboard' and 'panel' object. Otherwise django side returns
    500 error.

    However the URL for request of details page (i.e. /ngdetails/)
    can not provide informations to set the proper navigation.

    So this patch set them to default dashboard and default panel.

    This patch focuses to prevent 500 error. So the issue for
    settings of proper navigation will be fixed by subsequent patch.

    Change-Id: Ib9f1fe48b3cdecff5ad56e68a5ba58a41cb35f38
    Closes-Bug: #1681627
    (cherry picked from commit 077163a03c9aea08efd56251e49d69eb1cc4d093)

[Gloria Gu (gloria-gu)]

the fixes cause problem at https://bugs.launchpad.net/horizon/+bug/1754133

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon 12.0.3 release.

[Giuseppe Petralia (peppepetra)]

This issue is affecting also openstack/horizon 11.0.4 release (Ocata)
We need a backport of the bug fix.

[Akihiro Motoki (amotoki)]

Everyone can propose a backport to stable branches. Feel free to propose a backport to ocata.
Ocata is entering the extended maintenance phase, so we are looking for volunteers to maintain stable/ocata branch.

[Akihiro Motoki (amotoki)]

I added ocata-backport-potential tag so that anyone who is interested in stable/ocata can verify a fix in stable/ocata and propose a backport.

[Hua Zhang (zhhuabj)]

In fact, backporting two primitive patches [1][2] into Ocata will not be able to work, because:

1, In Ocata release, getDetailsPath returns "'project/ngdetails/OS::Glance::Image/' + item.id;"

https://github.com/openstack/horizon/blob/stable/ocata/openstack_dashboard/static/app/core/images/images.service.js#L59

function getDetailsPath(item) {
return 'project/ngdetails/OS::Glance::Image/' + item.id;
}

2, In > Ocata release, eg: Pike release, getDetailsPath returns "detailRoute + 'OS::Glance::Image/' + item.id"

https://github.com/openstack/horizon/blob/stable/pike/openstack_dashboard/static/app/core/images/images.service.js#L69

function getDetailsPath(item) {
return detailRoute + 'OS::Glance::Image/' + item.id;
}

So we will see the error 'The current URL, project/ngdetails/OS::Glance::Image/46ef8cab-dfc3-4690-8abb-d416978d237e, didn't match any of these.' when backporting two primitive patches into Ocata. So the following simple changes need to be made in urls.py in addition to the primitive backport patches as well.

-ngdetails_url = url(r'^ngdetails/',
+ngdetails_url = url(r'^project/ngdetails/',

I will propose a backport to ocata later.

[1] https://review.openstack.org/#/c/541676/
[2] https://review.openstack.org/#/c/553970/

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/ocata
Review: https://review.openstack.org/629373

[Hua Zhang (zhhuabj)]

Submit two dependent submissions as below:

https://review.openstack.org/629373 Enable to refresh ngdetails view
https://review.openstack.org/629374 Fix Angular errors in openstack_auth

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/629373
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=f557a8dd34e91b60de2f4a192aad3a0861b4b5ac
Submitter: Zuul
Branch: stable/ocata

commit f557a8dd34e91b60de2f4a192aad3a0861b4b5ac
Author: Shu Muto <email address hidden>
Date: Thu Nov 16 16:55:46 2017 +0900

    Enable to refresh ngdetails view

    For now, refreshing ngdetails view by browser using F5 key or reload
    button, it causes 404 error from django. To fix this issue, this patch
    adds the url for '/ngdetails' into django.

    To reproduce navigations, each request for views.py requires
    'dashboard' and 'panel' object. Otherwise django side returns
    500 error.

    However the URL for request of details page (i.e. /ngdetails/)
    can not provide informations to set the proper navigation.

    So this patch set them to default dashboard and default panel.

    This patch focuses to prevent 500 error. So the issue for
    settings of proper navigation will be fixed by subsequent patch.

    Change-Id: Ib9f1fe48b3cdecff5ad56e68a5ba58a41cb35f38
    Closes-Bug: #1681627
    (cherry picked from commit 077163a03c9aea08efd56251e49d69eb1cc4d093)
    (cherry picked from commit a0fc40b4e85d3090e657cca9824de719b33a7ba2)
    Signed-off-by: Zhang Hua <email address hidden>

[Edward Hope-Morley (hopem)]

Pike patch will be included in PR done in bug 1822192

[Edward Hope-Morley (hopem)]

@zhhuabj my apologies, the PR i mentioned above is for Cinder not Horizon so we will need to submit an SRU for Pike as well.

[Hua Zhang (zhhuabj)]

@Ed, the branch 12.0.3 has included those two fixed patches, so horizon pike 3:12.0.3-0ubuntu1~cloud1 released on Apr 2 has included them.

[Edward Hope-Morley (hopem)]

@zhhuabj ack thanks, lets get the ocata sru underway then

[Corey Bryant (corey.bryant)]

@zhhuabj it looks like upstream stable/ocata is still in extended maintenance mode. Would you be able to submit the patch to stable/ocata?

[Hua Zhang (zhhuabj)]

@corey, yeah, I have submitted the patch to stable/ocata before, see https://bugs.launchpad.net/horizon/+bug/1681627/comments/27, and they have already been merged by upstream as well now. thanks.

[Corey Bryant (corey.bryant)]

@Hua, thanks I somehow missed that last time. By the way I don't think this fix landed in our pike package. At least I did a quick grep for "ngdetails" and didn't find the first LOC from the stable/pike upstream patch. Anyway Pike is EOL now but we should at least change the status above from Fix released to won't fix.

[Corey Bryant (corey.bryant)]

@Hua, sorry I'm confused on what's needed for Ocata.

The SRU Details mentioned we need:

[1] https://review.openstack.org/#/c/541676/
[2] https://review.openstack.org/#/c/553970/

and

-ngdetails_url = url(r'^ngdetails/',
+ngdetails_url = url(r'^project/ngdetails/',

Are the ngdetails_url changes available in any upstream commits?

Thanks,
Corey

[Hua Zhang (zhhuabj)]

@corey,

for Pike, how did you do a quick grep for "ngdetails" ? just now I downloaded the source package (sudo apt-get source openstack-dashboard=3:12.0.3-0ubuntu1~cloud1) and confirmed the following two changes have been in Pike.

https://review.opendev.org/#/c/541676/
https://review.opendev.org/#/c/553970/

for Ocata, yeah, the ngdetails_url changes for Ocata have been available in upstream (https://review.opendev.org/#/c/629374/4/openstack_dashboard/urls.py)

https://review.openstack.org/629373
https://review.openstack.org/629374

[Corey Bryant (corey.bryant)]

I was confused by the bug description because it sounded like there were 3 patches required, but it looks like just the 2 are required. Also for pike I was confused because the "# add URL for ngdetails" bits were missing but they are removed by the other patch so pike looks ok.

[Corey Bryant (corey.bryant)]

s/missing/moved/

[Corey Bryant (corey.bryant)]

Hello hongbin, or anyone else affected,

Accepted horizon into ocata-proposed. The package will build now and be available in the Ubuntu Cloud Archive in a few hours, and then in the -proposed repository.

Please help us by testing this new package. To enable the -proposed repository:

  sudo add-apt-repository cloud-archive:ocata-proposed
  sudo apt-get update

Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, and change the tag from verification-ocata-needed to verification-ocata-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-ocata-failed. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[Hua Zhang (zhhuabj)]

Successfully verified ocata-proposed openstack-dashboard=3:11.0.4-0ubuntu1~cloud2.6, it works, thanks.

[Corey Bryant (corey.bryant)]

The verification of the Stable Release Update for horizon has completed successfully and the package has now been released to -updates. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

[Corey Bryant (corey.bryant)]

This bug was fixed in the package horizon - 3:11.0.4-0ubuntu1~cloud2.6
---------------

 horizon (3:11.0.4-0ubuntu1~cloud2.6) xenial-ocata; urgency=medium
 .
   * Enable to refresh ngdetails view (LP: #1681627)
     - d/p/0001-Enable-to-refresh-ngdetails-view.patch
     - d/p/0002-Fix-Angular-errors-in-openstack_auth.patch

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/horizon ocata-eol release.