Dashboard URL does not show new name when dashboard name is updated #1009

rauchy · 2019-08-15T08:16:43Z

Before dashboard title change:

After dashboard title change:

arikfr · 2016-04-23T19:02:57Z

This is sort of intentional to make sure the URL doesn't break. I see two possible solutions here:

Stop using slugs for dashboard names and switch to ids as we do with queries, alerts, etc.
If we want to keep the slugs, we should add the id of the dashboard to the name and do the lookup by the id and not the slug. I.e. if the dashboard id is 7, then the url will be /dashboard/7-cohort-analysis. Because the slug is meaningless for lookup we can keep it at sync with the actual title. This has other benefits such as removing the need to make sure the slug is unique (the id will guarantee this).

ChiragKParmar · 2016-05-04T18:46:34Z

Frankly, I am not sure which one would be better! I think second option is better in terms of giving ability to user to guess what the dashboard is for (from the slugs).

arikfr · 2016-05-04T18:48:04Z

I agree. And because we have the "technology" it's not a big cost to keep slugs, while improving their implementation.

susodapop · 2019-01-17T13:26:15Z

Related to this: the CSS title needs to update when the dashboard name is changed. I think fixing the title is independent of the URL slug. It should be fixed regardless what is done about the slugs.

Notice in the attached screenshot that the tab title doesn't match the dashboard title.

arikfr · 2019-01-17T13:30:33Z

@susodapop worth opening a separate issue for this then. Probably an easy fix.

…unless there is no number in it - in that case, take the entire slug as id

arikfr

Worth taking a moment and clearing the code a bit -- there are some places where we expect a dashboard ID, but call it slug in the code 😖

arikfr · 2019-08-15T08:47:13Z

redash/handlers/dashboards.py

-        dashboard = get_object_or_404(models.Dashboard.get_by_slug_and_org, dashboard_slug, self.current_org)
+        if dashboard_slug.split('-')[0].isdigit():
+            identifier = int(dashboard_slug.split('-')[0])
+            fn = models.Dashboard.get_by_id_and_org


We have 185 dashboards in our database that match this pattern already ("28 Days Growth Metrics"), so old URLs will stop working. We need a fallback here.

Some ideas:

Try with get_by_slug_and_org if get_by_id_and_org fails.

Test if the slug matches the dashboards slug.

Preferred and implemented the first, but then realized that it breaks when you have a dashboard called "28 Days Growth Metrics" (available through /dashboards/28-days-growth-metrics) and then you create another dashboard called "I like trains" which gets assigned with id 28 (available through /dashboards/28-i-like-trains).

In that case, get_by_id_and_org wouldn't fail, and your previous links would break.

Why?

When you request 28-days... it will work with get_by_slug_and_org, and when you request 28-i-like... it will fail get_by_slug_and_org and then try get_by_id_and_org which will work.

Hehe, that's the opposite direction of what you suggested in the first option :)
Yeah, that might work, but it would add an extra query for most dashboard loads. I went ahead and implemented the second option which seems to work fine.

Rethinking it, there's no possible way I can think that we can remain agnostic to the slug if we don't do get_by_slug_and_org and fallback to get_by_id_and_org (i.e. if we don't go down this path, renaming dashboards would always break existing links). aba6e3b

Hehe, that's the opposite direction of what you suggested in the first option :)

😳 when I first read your reply I thought that's what happened, read my suggestion again but still parsed it in reverse order. 🤦‍♂️

Yeah, that might work, but it would add an extra query for most dashboard loads. I went ahead and implemented the second option which seems to work fine.

🤔 how about the following:

Currently the dashboard URLs are /dashboard/<slug>. But they should actually be /dashboards/<id>-<whatever>. So what if as part of this change we will change the URLs and keep the old ones for backward compatibility.

This way if we get a request for /dashboard/... we know it's an old URL and we should pass a slug but if it's /dashboards/... we use the new logic?

👍 a851402 😈

arikfr · 2019-08-15T08:47:39Z

client/app/services/dashboard.js

+  .replace(/[^\w-]+/g, '')
+  .replace(/--+/g, '-')
+  .replace(/^-+/, '')
+  .replace(/-+$/, '')}`;


We should still create the slug in the backend, it will just update when you update the dashboard name.

Yeah, but that might break existing links, if anyone kept them.

My intention was to have existing slugs continue to work, while new links would be dashboards/123-pretty-much-the-name-of-the-dashboard-here-but-could-be-anything-youd-like-cause-we-only-care-about-the-id-from-now.

It doesn't have to:

We will keep the current slug value in the database as is, so we can do lookups for existing dashboards.

We will no longer update it, but compute it when returning the API response based on the current name.

name_as_slug 😬😬😬

url which contains their new name

rauchy · 2019-08-19T19:05:29Z

You should probably move this into redash.utils.slugify.

What does it do differently?

How does it handle unicode?

Tests?

I realized this after a few minutes 🤦‍♂

redash/serializers/__init__.py

gabrieldutra

Applied some of the updates, for tomorrow it will be missing:

~~Make the old url for dashboard change redirect (I think I'll just use the location.update hack as we do when the dashboard changes name)~~
~~Update other api calls to use id~~ (need to confirm the "break all existing api usages" part)
~~Update backend tests~~
~~Update Cypress tests~~

gabrieldutra · 2020-07-02T01:49:30Z

redash/serializers/__init__.py

@@ -246,6 +246,7 @@ def serialize_dashboard(obj, with_widgets=False, user=None, with_favorite_state=
    d = {
        "id": obj.id,
        "slug": obj.slug,
+        "name_as_slug": obj.name_as_slug,


Backward compatibility reasons + the other routes needed the slug. So the delete button wouldn't work if you had changed the dashboard url for example (considering route as /api/dashboards/:slug as the api would rely in the actual "slug".

gabrieldutra · 2020-07-02T01:50:51Z

redash/models/__init__.py

+            cls.query.filter(
+                cast(cls.id, db.String) == id_or_slug, cls.org == org
+            ).one_or_none()
+            or cls.query.filter(cls.slug == id_or_slug, cls.org == org).one()


This looks good to me, but need to keep in mind that all existing api usage outside of our Frontend will be broken.

gabrieldutra · 2020-07-02T01:58:20Z

client/app/pages/dashboards/hooks/useDashboard.js

+          if (has(data, "name")) {
+            navigateTo(urlForDashboard(updatedDashboard), true);
+          }


Yep, correct

gabrieldutra · 2020-07-03T02:50:52Z

tests/handlers/test_dashboards.py

        self.assertEqual(rv.status_code, 200)
        self.assertTrue(rv.json["widgets"][0]["restricted"])
        self.assertNotIn("restricted", rv.json["widgets"][1])

    def test_get_non_existing_dashboard(self):
-        rv = self.make_request("get", "/api/dashboards/not_existing")
+        rv = self.make_request("get", "/api/dashboards/-1")


This actually doesn't happen only to the dashboard, but anything that's /api/resource/not_a_number causes a sqlalchemy error. This PR didn't feel like a scope to fix it and at least now I don't have an idea on how to solve this as it turned to be a dynamic thing.

arikfr

Looking good. Two small things in comments.

arikfr · 2020-07-13T10:44:06Z

redash/handlers/dashboards.py

+        fn = (
+            models.Dashboard.get_by_slug_and_org
+            if request.args.get("legacy") is not None
+            else models.Dashboard.get_by_id_and_org
        )


Ternary operators aren't that readable in Python. Might be better to write this as:

if request.args.get("legacy") is not None: fn = models.Dashboard.get_by_slug_and_org else: fn = models.get_by_id_and_org

(fn will be available in the outer context)

arikfr · 2020-07-13T10:45:12Z

redash/serializers/__init__.py

@@ -246,6 +246,7 @@ def serialize_dashboard(obj, with_widgets=False, user=None, with_favorite_state=
    d = {
        "id": obj.id,
        "slug": obj.slug,
+        "name_as_slug": obj.name_as_slug,


Now that we migrated all API routes to use an id, we can drop this?

kravets-levko

Looks good 👍 Just two small notes, but fixing them is up to you.

client/app/pages/dashboards/DashboardPage.jsx

client/app/pages/dashboards/hooks/useDashboard.js

client/app/pages/dashboards/DashboardPage.jsx

Co-authored-by: Levko Kravets <levko.ne@gmail.com>

arikfr · 2020-07-16T20:04:05Z

👍

…etredash#1009) * on dashboard api calls - take the id from the beginning of the slug, unless there is no number in it - in that case, take the entire slug as id * add dashboard id when showing links to dashboards * change path to include new name when renaming dashboards * move slug generation to backend * redirect to new name after changing (this time with a proper promise) * oh right, we already have a slug function * add spec that makes sure that renamed dashboards are redirected to the url which contains their new name * use id-slug in all Cypress specs * move dashboards from /dashboard/:slug to /dashboards/:id-:name_as_slug * Update dashboard url as its name changes * Update separator to be "/" * Update missing dashboard urls * Update api not to depend on int id * Use '-' instead of '/' as separator and update Dashboard.get calls * slug -> name_as_slug * Keep slug urls on cypress * Update route path * Use legacy attr for GET * Use getter for urlForDashboard * Update dashboard url when loaded by slug * Update Dashboard routes to use id instead of slug * Update Dashboard handler tests * Update Cypress tests * Fix create new dashboard spec * Use axios { params } * Drop Ternary operator * Send updated slug directly in 'slug' attr * Update multiple urls Dashboard test name * Update route names Co-authored-by: Levko Kravets <levko.ne@gmail.com> Co-authored-by: Gabriel Dutra <nesk.frz@gmail.com> Co-authored-by: Levko Kravets <levko.ne@gmail.com>

arikfr added the Backend label Apr 23, 2016

arikfr added enhancement help wanted labels Mar 18, 2018

arikfr added this to the Next milestone Mar 18, 2018

Omer Lachish added 3 commits August 15, 2019 11:14

on dashboard api calls - take the id from the beginning of the slug, …

467a128

…unless there is no number in it - in that case, take the entire slug as id

add dashboard id when showing links to dashboards

1e818f6

change path to include new name when renaming dashboards

90ef7cc

arikfr reviewed Aug 15, 2019

View reviewed changes

Omer Lachish added 5 commits August 17, 2019 23:05

Merge branch 'master' into id-and-slug-for-dashboards

8392126

move slug generation to backend

aba6e3b

redirect to new name after changing (this time with a proper promise)

0ae13b0

oh right, we already have a slug function

0783351

add spec that makes sure that renamed dashboards are redirected to the

1aedc44

url which contains their new name

Omer Lachish added 2 commits August 19, 2019 22:13

use id-slug in all Cypress specs

b7a7a55

move dashboards from /dashboard/:slug to /dashboards/:id-:name_as_slug

a851402

weekly-digest bot mentioned this pull request Aug 26, 2019

Weekly Digest (19 August, 2019 - 26 August, 2019) #4098

Closed

arikfr mentioned this pull request Sep 25, 2019

Can't create dashboards named favorites #4185

Open

gabrieldutra added 6 commits June 26, 2020 13:49

Merge branch 'master' into id-and-slug-for-dashboards

75b71d7

Update dashboard url as its name changes

6ea5b97

Update separator to be "/"

8e5f491

Update missing dashboard urls

3f47fb8

Update api not to depend on int id

2649292

Use '-' instead of '/' as separator and update Dashboard.get calls

59a9143

gabrieldutra reviewed Jun 30, 2020

View reviewed changes

redash/serializers/__init__.py Show resolved Hide resolved

gabrieldutra added 2 commits July 1, 2020 23:09

Use legacy attr for GET

49482d9

Use getter for urlForDashboard

52041a3

gabrieldutra reviewed Jul 2, 2020

View reviewed changes

gabrieldutra added 3 commits July 2, 2020 13:53

Update dashboard url when loaded by slug

2ccc4c1

Update Dashboard routes to use id instead of slug

08c14de

Update Dashboard handler tests

d7728d1

gabrieldutra reviewed Jul 3, 2020

View reviewed changes

gabrieldutra added 3 commits July 3, 2020 11:42

Update Cypress tests

d166069

Merge branch 'master' into id-and-slug-for-dashboards

210a755

Fix create new dashboard spec

7a8cb0e

gabrieldutra requested review from arikfr and kravets-levko July 6, 2020 15:40

gabrieldutra added 2 commits July 6, 2020 16:57

Merge branch 'master' into id-and-slug-for-dashboards

0957129

Use axios { params }

eb82583

arikfr reviewed Jul 13, 2020

View reviewed changes

gabrieldutra added 4 commits July 13, 2020 12:35

Drop Ternary operator

fd26a9f

Send updated slug directly in 'slug' attr

6e68b91

Merge branch 'master' into id-and-slug-for-dashboards

2de74b3

Update multiple urls Dashboard test name

cd867a7

kravets-levko approved these changes Jul 13, 2020

View reviewed changes

client/app/pages/dashboards/DashboardPage.jsx Outdated Show resolved Hide resolved

client/app/pages/dashboards/hooks/useDashboard.js Show resolved Hide resolved

gabrieldutra reviewed Jul 13, 2020

View reviewed changes

client/app/pages/dashboards/DashboardPage.jsx Outdated Show resolved Hide resolved

Update route names

212d4b4

Co-authored-by: Levko Kravets <levko.ne@gmail.com>

arikfr merged commit cb97364 into master Jul 16, 2020

arikfr deleted the id-and-slug-for-dashboards branch July 16, 2020 20:04

gabrieldutra mentioned this pull request Aug 25, 2020

Update dashboard api doc to use the id instead of slug getredash/website#477

Open

susodapop mentioned this pull request Mar 5, 2021

API returns "Internal Server Error" for dashboard-slug #5416

Closed

RuiFG mentioned this pull request Feb 8, 2023

Fix Redash Source open-metadata/OpenMetadata#10141

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dashboard URL does not show new name when dashboard name is updated #1009

Dashboard URL does not show new name when dashboard name is updated #1009

rauchy commented Aug 15, 2019

arikfr commented Apr 23, 2016

ChiragKParmar commented May 4, 2016

arikfr commented May 4, 2016

susodapop commented Jan 17, 2019

arikfr commented Jan 17, 2019

arikfr left a comment

arikfr Aug 15, 2019

rauchy Aug 17, 2019

arikfr Aug 18, 2019

rauchy Aug 18, 2019

rauchy Aug 18, 2019

arikfr Aug 19, 2019

rauchy Aug 19, 2019

arikfr Aug 15, 2019

rauchy Aug 15, 2019 •

edited

Loading

arikfr Aug 15, 2019

rauchy Aug 18, 2019

rauchy commented Aug 19, 2019

gabrieldutra left a comment •

edited

Loading

gabrieldutra Jul 2, 2020

gabrieldutra Jul 2, 2020

gabrieldutra Jul 2, 2020

gabrieldutra Jul 3, 2020 •

edited

Loading

arikfr left a comment

arikfr Jul 13, 2020

gabrieldutra Jul 13, 2020

arikfr Jul 13, 2020

kravets-levko left a comment

arikfr commented Jul 16, 2020

Dashboard URL does not show new name when dashboard name is updated #1009

Dashboard URL does not show new name when dashboard name is updated #1009

Conversation

rauchy commented Aug 15, 2019

arikfr commented Apr 23, 2016

ChiragKParmar commented May 4, 2016

arikfr commented May 4, 2016

susodapop commented Jan 17, 2019

arikfr commented Jan 17, 2019

arikfr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rauchy Aug 15, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rauchy commented Aug 19, 2019

gabrieldutra left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabrieldutra Jul 3, 2020 • edited Loading

Choose a reason for hiding this comment

arikfr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kravets-levko left a comment

Choose a reason for hiding this comment

arikfr commented Jul 16, 2020

rauchy Aug 15, 2019 •

edited

Loading

gabrieldutra left a comment •

edited

Loading

gabrieldutra Jul 3, 2020 •

edited

Loading