Slugify Collectives and Pages (fork-based) #1424

Koc · 2024-08-18T16:02:04Z

📝 Summary

This is a very beginning of my PR to slugify urls for Collectives and Pages. For now urls are too long and hard to understand if using cyrylic in this entities.

Here an example of some of them: http://localhost/index.php/apps/collectives/%D0%A3%D0%BA%D1%80%D0%B0%D1%97%D0%BD%D1%81%D1%8C%D0%BA%D1%96%20%D1%84%D1%83%D1%82%D0%B1%D0%BE%D0%BB%D1%96%D1%81%D1%82%D0%B8/%D0%AF%D1%80%D0%BC%D0%BE%D0%BB%D0%B5%D0%BD%D0%BA%D0%BE%20%D0%90%D0%BD%D0%B4%D1%80%D1%96%D0%B9%20%D0%9C%D0%B8%D0%BA%D0%BE%D0%BB%D0%B0%D0%B9%D0%BE%D0%B2%D0%B8%D1%87?fileId=187. Just compare it with slugified version: http://localhost/index-php/apps/collectives/ukrayinski-futbolisti-1/page-1-yurchenko-andriy-mykolayovich. Easy to read, 3 times shorter.

🖼️ Video

Screencast.from.2024-09-01.17-18-46.webm

🚧 TODO

resolve updater issue
update previewer
add/fix tests

🏁 Checklist

Code is properly formatted (npm run lint / npm run stylelint / composer run cs:check)
Sign-off message is added to all commits
Tests (unit, integration and/or end-to-end) passing and the changes are covered with tests
Documentation (README or documentation) has been updated or is not required

mejo- · 2024-08-28T10:53:14Z

Hey @Koc, thanks for looking into this. Definitely a good idea to slugify collectives and page titles for cleaner URLs.

Without looking into all the details, I wonder if we could implement this in a way that doesn't need the sluggified string to be persisted in the database.

Why not make calculate the slug of titles/names on demand in the backend and add them as attribute to the collectives and pages in the API responses? Then the frontend could always check for name/title match first and for slug match second. What do you think about this approach?

Koc · 2024-08-30T11:12:55Z

@mejo- we have a lot of pages in collectives, so I would like to reduce amount of runtime operations to speedup backend endpoints.

Koc · 2024-09-01T15:27:53Z

I've achieved some progress. Now it more or less works, we have even redirects if slugs have been renamed. You can observe how it works in the video that attached to PR description

github-actions · 2024-09-02T02:30:38Z

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

Koc · 2024-09-11T23:36:54Z

@mejo- there is one more reason to persist slug in the database: we can make it editable in upcoming PRs. Sometimes page titles can be long, so we can give possibility to our users shorten them

max-nextcloud · 2025-05-14T16:54:39Z

Thanks for the rebase, @Koc
@mejo- will take another look at the migrations and I will take a stab at fixing the cypress tests.

max-nextcloud · 2025-05-19T13:18:46Z

I'm currently looking into the page-links cypress test. I noticed two things:

Use of the old page format

When clicking a page on the sidebar it opens the old subroute for me:
http://nextcloud.local/index.php/apps/collectives/test-leaf-22/New%20page?fileId=1806

Old paths are not converted to new paths

The cypress test clicks on a number of links in a document that still have the old format. I think that's a good thing to still have around. When visiting such a link the url stays in the old format leading to a failing assertion.

I'm not sure - but I think we should rewrite urls to have the new format on visiting the old format. For one this will hopefully make the test pass... and it will also use the shorter nicer urls more often.

mejo- · 2025-05-21T15:19:08Z

lib/Service/SlugService.php

+		return $this->slugger->slug($name)->toString() . '-' . $collectiveId;
+	}
+
+	public function generatePageSlug(string $title): string {


@Koc I don't understand why the collective slug contains the collectiveId and the page slug doesn't contain the pageId.

Looking at the frontend router changes it seems to me that the slug is expected to be separate from the IDs, which makes sense to me. So maybe generateCollectiveSlug() should not add -${collectiveId} either, right?

no, we need ids for both pages and collectives. This is needed because collective/page can be renamed but we want to make it possible content using old URLs.

At the same time I can't remember why we can't store fileId inside slug on BE side (PR was opened almost year ago). I guess it's because of routing stuff - we need to distinguish old and new routes

lib/Service/PageService.php

mejo- · 2025-05-21T15:32:15Z

src/components/Collective.vue

 			this.selectVersion(null)
+
+			const routerParams = this.$router.currentRoute.params
+			// If the current page is not the one we are supposed to be on, redirect


I have to admit that I don't fully understand the purpose of this code. When is this expected to happen? Is the idea to redirect to the slugified URL when the old URL is opened?

yeah, exactly. The only one thing: it stopped work after one of latest rebases. I'm investigating it

src/components/Nav/CollectiveSettings.vue

mejo- · 2025-05-21T15:36:51Z

src/router.js

+		component: CollectiveView,
+		props: (route) => route.params,
+		children: [
+			{ path: 'page-:pageId(\\d+)-:pageSlug' },


I think it's confusing to use <slug>-<id> for the collective URL part and page-<id>-<slug> for the page URL part. Why not use <slug>-<id> for the page as well?

This was added as a prefix for some edge cases when generated slug/old file path contains digits and dash at the beginning

src/stores/collectives.js

mejo- · 2025-05-21T15:59:31Z

@juliusknorr I've opened PR with backport: #1625.

But now there is another error 🤷‍♂️ :

Could not download app contacts

@Koc seems like the CI job runs into a rate limit of the app store. I wonder whether this is because the base branch for this PR lives in your Github realm and not in nextcloud. Given that you're member of the nextcloud organisation, would you mind opening the PR again as a branch of nextcloud/collectives, instead of Koc/nextcloud-collectives? I can imagine that this helps with the failing Cypress tests.

mejo- · 2025-06-04T05:43:12Z

Dear @Koc, do you plan to continue working on this PR in the near future? Or would you prefer us to take over work on it? Both options are perfectly fine for us and there's no urgency or need to rush. I just wanted to check in with you.

Koc · 2025-06-05T14:56:30Z

hey @mejo- !

I will try to do next things:

fix/answer to your code review comments 🚧
fix conflicts after rebase ✔️
do manual testing ⏳
reopen new PR based on main repository instead of my fork ⌛

And after that I will disappear 😄 . I don't know how to fix Cypress tests

mejo- · 2025-06-05T15:59:14Z

I will try to do next things:

Thanks so much @Koc, much appreciated! Let me know when you want us to take over or when you have questions. Don't mind the upgrade app test failures, they're unrelated and will be fixed after the next app release.

Regarding creating the slugs initially, I think the best would be to implement a live-migration repair step that is scheduled anytime after the the upgrade and triggered by cron. See https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/repair.html#repair-step-types

mejo- · 2025-06-05T20:38:02Z

fix conflicts after rebase ✔️

Sorry @Koc, I just merged another larger PR that created rebase/merge conflicts for this PR one more time. They should be easy to fix this time though. Maybe you can open a new PR based on a branch in this repo soon, then I can do the manual rebase myself next time 🫣

Signed-off-by: Kostiantyn Miakshyn <[email protected]>

Koc · 2025-06-08T12:11:53Z

So, here we go. I did rebase one more time and fixed few things.
Here my manual test scenario:

switch to the current main branch
install module ./occ app:enable circles text collectives
create 2 collectives with some nested pages
switch to my branch
run ./occ upgrade
open collectives and pages by legacy urls -> it stil works, navigation is possible if slugs not generated ✔️
run ./occ maintenance:repair -> slugs generated and present in database for all collectives/pages ✔️

🔍 Preview
refresh page -> redirected to new slugified url, validated for both collective index/pages ✔️
rename collective (actually circle) -> slug changes, we've got redirected to the new url after change ✔️

Here reopened PR #1802 created from original Nextcloud repo instead of my own fork. Please don't abandon it 🙏 , I spent really too much time on such functionality

cc @mejo-

juliusknorr requested a review from mejo- August 19, 2024 07:15

juliusknorr added enhancement New feature or request 2. developing labels Aug 19, 2024

Koc force-pushed the feature/slugify-collectives-and-pages branch 4 times, most recently from 1cc11f7 to e179382 Compare August 19, 2024 23:42

Koc self-assigned this Sep 1, 2024

Koc force-pushed the feature/slugify-collectives-and-pages branch 5 times, most recently from 24eca7a to 6eb5ed6 Compare September 1, 2024 15:16

Koc marked this pull request as ready for review September 1, 2024 15:20

github-actions bot added the feedback-requested label Sep 2, 2024

Koc requested review from juliusknorr and skjnldsv September 2, 2024 10:23

skjnldsv removed their request for review September 3, 2024 07:21

Koc force-pushed the feature/slugify-collectives-and-pages branch 2 times, most recently from 4941808 to f8372d7 Compare September 11, 2024 23:35

Koc force-pushed the feature/slugify-collectives-and-pages branch 2 times, most recently from 4f66821 to 122a2b3 Compare September 28, 2024 00:09

This comment was marked as outdated.

Sign in to view

Koc force-pushed the feature/slugify-collectives-and-pages branch 2 times, most recently from c9fd222 to 7d50cb3 Compare October 5, 2024 23:29

Koc force-pushed the feature/slugify-collectives-and-pages branch from 0a0bb08 to 285f5de Compare May 14, 2025 15:46

mejo- reviewed May 21, 2025

View reviewed changes

lib/Service/PageService.php Outdated Show resolved Hide resolved

mejo- reviewed May 21, 2025

View reviewed changes

lib/Service/PageService.php Outdated Show resolved Hide resolved

mejo- reviewed May 21, 2025

View reviewed changes

src/components/Nav/CollectiveSettings.vue Show resolved Hide resolved

mejo- reviewed May 21, 2025

View reviewed changes

src/stores/collectives.js Outdated Show resolved Hide resolved

mejo- requested changes May 21, 2025

View reviewed changes

src/stores/collectives.js Outdated Show resolved Hide resolved

Koc force-pushed the feature/slugify-collectives-and-pages branch 2 times, most recently from c169728 to a1706e5 Compare June 5, 2025 14:53

Koc force-pushed the feature/slugify-collectives-and-pages branch 4 times, most recently from b83f81c to cda0a23 Compare June 8, 2025 11:54

Slugify Collectives and Pages

c21559e

Signed-off-by: Kostiantyn Miakshyn <[email protected]>

Koc force-pushed the feature/slugify-collectives-and-pages branch from cda0a23 to c21559e Compare June 8, 2025 12:01

Koc closed this Jun 8, 2025

github-project-automation bot moved this from 👀 In review to ☑️ Done in 📝 Office team Jun 8, 2025

Koc changed the title ~~Slugify Collectives and Pages~~ Slugify Collectives and Pages (fork-based) Jun 8, 2025

Koc mentioned this pull request Jun 8, 2025

Slugify Collectives and Pages #1802

Merged

5 tasks

max-nextcloud mentioned this pull request Jul 17, 2025

Collectives 3.0.0 Unable to edit/open new Sites #1879

Closed

Slugify Collectives and Pages (fork-based) #1424

Slugify Collectives and Pages (fork-based) #1424

Uh oh!

Conversation

Koc commented Aug 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Summary

🖼️ Video

🚧 TODO

🏁 Checklist

Uh oh!

mejo- commented Aug 28, 2024

Uh oh!

Koc commented Aug 30, 2024

Uh oh!

Koc commented Sep 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 2, 2024

Uh oh!

Koc commented Sep 11, 2024

Uh oh!

This comment was marked as outdated.

max-nextcloud commented May 14, 2025

Uh oh!

max-nextcloud commented May 19, 2025

Use of the old page format

Old paths are not converted to new paths

Uh oh!

mejo- May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Koc Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mejo- May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Koc Jun 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mejo- May 21, 2025

Choose a reason for hiding this comment

Uh oh!

Koc Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mejo- commented May 21, 2025

Uh oh!

mejo- commented Jun 4, 2025

Uh oh!

Koc commented Jun 5, 2025

Uh oh!

mejo- commented Jun 5, 2025

Uh oh!

mejo- commented Jun 5, 2025

Uh oh!

Koc commented Jun 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Koc commented Aug 18, 2024 •

edited

Loading

Koc commented Sep 1, 2024 •

edited

Loading