Add base to paginate

[kevinzunigacuellar]

Changes

• Closes The "page" prop in paginated dynamic routes doesn’t handle base URLs #10358
• Adds base url to next and prev links in paginate()

Testing

Updated tests

Docs

withastro/docs#8569

withastro/docs#9200

[changeset-bot]

🦋 Changeset detected

Latest commit: d840819

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[ematipico]

A changeset is missing

[bluwy]

There's no changeset, but presumably this would be a major as existing users would've manually added the base now, and we might break them?

[ematipico]

But isn't this a bug? Users were using a workaround for the bug. Or do we document that those URLs were meant to be without base?

[github-actions]

This PR is blocked because it contains a major changeset. A reviewer will merge this at the next release if approved.

[bluwy]

@ematipico The docs doesn't explicit mention about the base. I think it has always worked this way for very long and it's risky to fix it now even if it may be a bug.

I was thinking of documenting that you need to add the base manually. Or maybe paginate() can accept an option to prepend base, which we will turn on automatically in Astro 5?

[ematipico]

@ematipico The docs doesn't explicit mention about the base. I think it has always worked this way for very long and it's risky to fix it now even if it may be a bug.

I was thinking of documenting that you need to add the base manually. Or maybe paginate() can accept an option to prepend base, which we will turn on automatically in Astro 5?

Yeah, that sounds like a reasonable approach!

[kevinzunigacuellar]

I am leaning towards the most simple solution to just edit docs and mention that base is not prepended by default. If it's okay with everyone, I will close the PR an open one in docs. Thanks for all the support @bluwy and @ematipico

[ematipico]

I am leaning towards the most simple solution to just edit docs and mention that base is not prepended by default. If it's okay with everyone, I will close the PR an open one in docs. Thanks for all the support @bluwy and @ematipico

Make sure to not delete the branch. We will recreate this PR once we start the works towards Astro 5.0

[sarah11918]

Suggestion for a style of changeset here!

(PLT2204)

[ematipico]

@sarah11918 Code snippet added here 9403870 (#11253)

[sarah11918]

Quick reminder (as will be the process going forward) that this will require an update to the 5.0.0-beta branch v5 upgrade guide under the appropriate heading there!

@kevinzunigacuellar is a maintainer, so can commit directly there. But, might not make the obvious connection to the Linear task. So especially @ematipico and @bluwy whom I suspect will be helping out a lot with non-core PRs, please help everyone out who doesn't use Linear! 🙌

[delucis]

Thanks for the PR @kevinzunigacuellar!

How does this change impact pages not directly in src/pages/?

As an example:

• I have base: "blog" in my config
• I have src/pages/categories/[...category].astro which uses paginate()

The correct inclusion of base would be /blog/categories/2.

Does this PR do that or does it generate /categores/blog/2?

[sarah11918]

Noting that the place to update this information in the upgrade guide is here:

Preview: https://5-0-0-beta--astro-docs-2.netlify.app/en/guides/upgrade-to/v5/#changed-add-base-to-paginate-plt2204
File: https://github.com/withastro/docs/edit/5.0.0-beta/src/content/docs/en/guides/upgrade-to/v5.mdx (line 223)

Will also require an update to:
https://docs.astro.build/en/reference/api-reference/#pageurlprev and following entries that all say "If a value is set for base, prepend the base path to the URL"

[sarah11918]

@kevinzunigacuellar Does this also affect page.url.first and page.url.last? If so, then the changeset shouldn't only mention previous and next. If not, isn't that kind of confusing? 😅

Note: I think first and last are very recent additions, maybe even before you made this PR!

[ematipico]

Thanks for the PR @kevinzunigacuellar!

How does this change impact pages not directly in src/pages/?

As an example:

* I have `base: "blog"` in my config

* I have `src/pages/categories/[...category].astro` which uses `paginate()`

The correct inclusion of base would be /blog/categories/2.

Does this PR do that or does it generate /categores/blog/2?

The base is always prefixed to any route, regardless of their position the file system. In your example, the emitted route is /blog/categories/2

[ematipico]

@sarah11918 I updated the changeset to include all the APIs that were modified

[delucis]

The base is always prefixed to any route, regardless of their position the file system. In your example, the emitted route is /blog/categories/2

Fantastic, thanks for the clarification @ematipico. In that case approving conceptually 😁

Thanks again for the PR @kevinzunigacuellar and for taking it to the finish line Ema 💜