Ensure patch version is provided if accessing versioned documentation #612

nain-F49FF806 · 2024-10-09T11:21:15Z

This is step one in addressing #360

Have modified the router slightly

If complete (including patch) version provided, forward as is
If only upto minor version is provided, redirect to patch zero of that minor version

This should help in redirecting minor version documentation access to (hopefully) valid pages

Todo/Future: Consider forwarding to latest patch when only minor version provided

nain-F49FF806 · 2024-10-09T11:26:37Z

terragrunt/modules/release-distribution/lambdas/doc-router/index.js

+    const minor_versioned_pattern = /^(\d+)\.(\d+)\/(.*)/
+    if (minor_versioned_pattern.test(request.uri)) {
+        const patched_uri = request.uri.replace(minor_versioned_pattern, "$1.$2.0/$3");
+        return temp_redirect(patched_uri, callback);


Note: Temp redirect is used so the patch version used can be updated later.

why do we want to update it later? 🤔

This is in case we could update the code to get the latest patch live and direct to it.
If we can then temp redirect would be good, as the latest patch version for a minor release can change.

If we are happy with always redirecting to the patch zero release. Then regular redirect should do.

terragrunt/modules/release-distribution/lambdas/doc-router/index.js

MarcoIeni · 2024-10-09T15:36:22Z

terragrunt/modules/release-distribution/lambdas/doc-router/index.js

        return callback(null, request);
    }
+    // Include patch version 0 if only minor version is provided
+    // Todo("Forward to latest patch version if possible")


I'm not sure if we can do this.
Asked in the original issue.
If we can't let's delete this line. 👍

MarcoIeni · 2024-10-09T15:37:16Z

terragrunt/modules/release-distribution/lambdas/doc-router/index.js

        return callback(null, request);
    }
+    // Include patch version 0 if only minor version is provided
+    // Todo("Forward to latest patch version if possible")
+    const minor_versioned_pattern = /^(\d+)\.(\d+)\/(.*)/


This regex looks good 👍

MarcoIeni · 2024-10-09T15:53:31Z

Looks great 🥳
Let me check if this is all that's required and I'll deploy it to the dev environment

MarcoIeni · 2024-10-09T15:56:33Z

terragrunt/modules/release-distribution/lambdas/doc-router/index.js

        return callback(null, request);
    }
+    // Include patch version 0 if only minor version is provided


Suggested change

// Include patch version 0 if only minor version is provided

// Include patch version 0 if minor version is provided

MarcoIeni · 2024-10-09T16:00:41Z

Applied to dev-doc.rust-lang.org 👍
However https://dev-doc.rust-lang.org/1.65/std/boxed/struct.Box.html it's not working

MarcoIeni · 2024-10-09T16:02:09Z

But https://dev-doc.rust-lang.org/1.65.0/std/boxed/struct.Box.html it's not working too.
let me check

MarcoIeni · 2024-10-09T16:09:45Z

I redeployed the master branch and apparently those URLs are not working in dev 🤔

I need to find a way to test this. 👀

MarcoIeni · 2024-10-09T16:12:40Z

Ok. Now https://dev-doc.rust-lang.org/1.65.0/std/boxed/struct.Box.html is working (the issue was my chache probably)

I will apply your changes again

MarcoIeni · 2024-10-09T16:15:27Z

I applied your code and https://dev-doc.rust-lang.org/1.65/std/boxed/struct.Box.html isn't working.

Do you have any idea? Maybe the regex substitution doesn't work?

nain-F49FF806 · 2024-10-09T19:48:00Z

I applied your code and https://dev-doc.rust-lang.org/1.65/std/boxed/struct.Box.html isn't working.

Do you have any idea? Maybe the regex substitution doesn't work?

Hi, I checked the request in browser's dev console.

I suspect the pattern has not matched due to the leading / indicating the root.
Have made a commit fixing the regex accordingly.

Could you try now?

p.s:
If the above is the correct reason why it didn't work then we may have to update the earlier regex also.
Have edited only one regex now so we can see if it works without changing behavior of the patch versioned case.

MarcoIeni · 2024-10-10T09:15:16Z

Deloyed 👍
https://dev-doc.rust-lang.org/1.65/std/boxed/struct.Box.html now works 🥳

I left some comments about the regex

terragrunt/modules/release-distribution/lambdas/doc-router/index.js

jdno · 2024-10-10T10:18:38Z

This is something that I'd love to see added to our rust-lang/infra-smoke-tests. It will probably require creating a new TestSuite, so I'll try to create a tracking issue with some instructions later.

MarcoIeni · 2024-10-10T13:15:35Z

Looks great, I'm testing this one last time just to be sure 😂

EDIT: applied in dev again 👍 I'll wait a few minutes and see if it works. Let me know if it works for you.

MarcoIeni

This is working for me and the code looks good. 👍
Great job, thanks 🙌
I'll wait for a review from JD since CDN is quite critical.

MarcoIeni · 2024-10-10T14:05:01Z

One note for the maintainers: I want to merge this with "squash" strategy. Is that fine or do we want to the contributors to force push?

jdno

Looks good! I'm adding it to our smoke tests, but we can already go ahead and deploy it...

MarcoIeni · 2024-11-18T12:20:43Z

nain, can you squash your commits into a single one? After that, push a new commit where you update this sha with the sha of your first commit.

So in total, this PR should contain 2 commits.

Let me know if this is clear 👍

- If complete (including patch) version provided, forward as is - If only upto minor version is provided, redirect to patch zero of that minor version

nain-F49FF806 · 2024-11-18T13:20:34Z

nain, can you squash your commits into a single one? After that, push a new commit where you update this sha with the sha of your first commit.

So in total, this PR should contain 2 commits.

Let me know if this is clear 👍

Hi, I have squashed commits and updated the sha like you said. Let me know if this is correct (more so if it is not:)

MarcoIeni · 2024-11-18T13:31:20Z

Applied to production 👍

MarcoIeni · 2024-11-18T13:36:34Z

https://doc.rust-lang.org/1.65/std/boxed/struct.Box.html it's working 🎉

Thanks nain and sorry if it took us so long to review but CDNs are quite critical!

I hope to see you again in my GitHub notifications 😁

nain-F49FF806 commented Oct 9, 2024

View reviewed changes

MarcoIeni reviewed Oct 9, 2024

View reviewed changes

terragrunt/modules/release-distribution/lambdas/doc-router/index.js Outdated Show resolved Hide resolved

MarcoIeni reviewed Oct 9, 2024

View reviewed changes

MarcoIeni reviewed Oct 10, 2024

View reviewed changes

terragrunt/modules/release-distribution/lambdas/doc-router/index.js Outdated Show resolved Hide resolved

MarcoIeni reviewed Oct 10, 2024

View reviewed changes

terragrunt/modules/release-distribution/lambdas/doc-router/index.js Outdated Show resolved Hide resolved

MarcoIeni approved these changes Oct 10, 2024

View reviewed changes

MarcoIeni requested a review from jdno October 10, 2024 14:04

jdno approved these changes Nov 18, 2024

View reviewed changes

Ensure patch version is provided if accessing versioned documentation

5d17669

- If complete (including patch) version provided, forward as is - If only upto minor version is provided, redirect to patch zero of that minor version

nain-F49FF806 force-pushed the patch-1 branch from df0b6c6 to 5d17669 Compare November 18, 2024 13:07

Update deployed-ref

05bd2ad

MarcoIeni merged commit a6db197 into rust-lang:master Nov 18, 2024
3 checks passed

MarcoIeni mentioned this pull request Nov 18, 2024

Redirect minor versions to latest patch #360

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure patch version is provided if accessing versioned documentation #612

Ensure patch version is provided if accessing versioned documentation #612

nain-F49FF806 commented Oct 9, 2024

nain-F49FF806 Oct 9, 2024

MarcoIeni Oct 9, 2024

nain-F49FF806 Oct 9, 2024

MarcoIeni Oct 9, 2024

MarcoIeni Oct 9, 2024

MarcoIeni commented Oct 9, 2024

MarcoIeni Oct 9, 2024

MarcoIeni commented Oct 9, 2024

MarcoIeni commented Oct 9, 2024

MarcoIeni commented Oct 9, 2024 •

edited

Loading

MarcoIeni commented Oct 9, 2024 •

edited

Loading

MarcoIeni commented Oct 9, 2024

nain-F49FF806 commented Oct 9, 2024 •

edited

Loading

MarcoIeni commented Oct 10, 2024 •

edited

Loading

jdno commented Oct 10, 2024

MarcoIeni commented Oct 10, 2024 •

edited

Loading

MarcoIeni left a comment

MarcoIeni commented Oct 10, 2024

jdno left a comment

MarcoIeni commented Nov 18, 2024 •

edited

Loading

nain-F49FF806 commented Nov 18, 2024

MarcoIeni commented Nov 18, 2024

MarcoIeni commented Nov 18, 2024

	// Include patch version 0 if only minor version is provided
	// Include patch version 0 if minor version is provided

Ensure patch version is provided if accessing versioned documentation #612

Ensure patch version is provided if accessing versioned documentation #612

Conversation

nain-F49FF806 commented Oct 9, 2024

nain-F49FF806 Oct 9, 2024

Choose a reason for hiding this comment

MarcoIeni Oct 9, 2024

Choose a reason for hiding this comment

nain-F49FF806 Oct 9, 2024

Choose a reason for hiding this comment

MarcoIeni Oct 9, 2024

Choose a reason for hiding this comment

MarcoIeni Oct 9, 2024

Choose a reason for hiding this comment

MarcoIeni commented Oct 9, 2024

MarcoIeni Oct 9, 2024

Choose a reason for hiding this comment

MarcoIeni commented Oct 9, 2024

MarcoIeni commented Oct 9, 2024

MarcoIeni commented Oct 9, 2024 • edited Loading

MarcoIeni commented Oct 9, 2024 • edited Loading

MarcoIeni commented Oct 9, 2024

nain-F49FF806 commented Oct 9, 2024 • edited Loading

MarcoIeni commented Oct 10, 2024 • edited Loading

jdno commented Oct 10, 2024

MarcoIeni commented Oct 10, 2024 • edited Loading

MarcoIeni left a comment

Choose a reason for hiding this comment

MarcoIeni commented Oct 10, 2024

jdno left a comment

Choose a reason for hiding this comment

MarcoIeni commented Nov 18, 2024 • edited Loading

nain-F49FF806 commented Nov 18, 2024

MarcoIeni commented Nov 18, 2024

MarcoIeni commented Nov 18, 2024

MarcoIeni commented Oct 9, 2024 •

edited

Loading

MarcoIeni commented Oct 9, 2024 •

edited

Loading

nain-F49FF806 commented Oct 9, 2024 •

edited

Loading

MarcoIeni commented Oct 10, 2024 •

edited

Loading

MarcoIeni commented Oct 10, 2024 •

edited

Loading

MarcoIeni commented Nov 18, 2024 •

edited

Loading