Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

follow redirects when prerendering #2832

Merged
merged 2 commits into from
Nov 24, 2021
Merged

follow redirects when prerendering #2832

merged 2 commits into from
Nov 24, 2021

Conversation

Rich-Harris
Copy link
Member

When prerendering, if a page or endpoint redirects to another location, the redirect is logged but not followed. In a case I encountered just now, a /docs link in the nav bar was followed, but the page consisted of this...

<script context="module">
  /** @type {import('@sveltejs/kit').Load} */
  export function load() {
    return {
      status: 308,
      redirect: '/docs/getting-started'
    };
  }
</script>

...and /docs/getting-started was never crawled. Easily fixed by ensuring that there's a link to the correct URL, but I would expect Kit to do the right thing here regardless.

Haven't added a test yet as I'm under the cosh

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Nov 18, 2021

🦋 Changeset detected

Latest commit: d73a7e2

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

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

@@ -191,6 +192,11 @@ export async function prerender({ cwd, out, log, config, build_data, fallback, a
log.warn(`${rendered.status} ${decoded_path} -> ${location}`);
writeFileSync(file, `<meta http-equiv="refresh" content="0;url=${encodeURI(location)}">`);
written_files.push(file);

const resolved = resolve(path, location);
if (resolved.startsWith('/')) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we've had bugs with this logic before and it's in a few different places like line 129 of load_node. I wonder if we should make a util function for it. I think this will need to be updated to match load_node (and I'm pretty sure it's somewhere else too - maybe elsewhere in prerendering):

resolved.startsWith('/') && !resolved.startsWith('//')

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, added a util. bonus — it's significantly faster than calling startsWith

@benmccann
Copy link
Member

I noticed one issue, but looks good to me other than that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants