GitLab Release Stage, 1 Sep 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Rewrites, splats and placeholder support for GitLab Pages

Description

This is a demo of how GitLab Pages supports defining splats, placeholders and rewrites in the _redirects file as part of the whole redirects feature https://docs.gitlab.com/ee/user/project/pages/redirects.html.

The feature will be enabled on https://gitlab.com very soon.
Please check the documentation MR (linked below) for instructions on how to enable this feature on self-managed installations.

Please add any feedback to https://gitlab.com/gitlab-org/gitlab-pages/-/issues/500

Documentation MR https://gitlab.com/gitlab-org/gitlab/-/merge_requests/59803

A

Hi everyone, my name, is jaime martinez, I'm a back-end engineer here at gitlab and today I'm going to show you the support for splats. Please hold their redirects on pages for gitlab pages. uh This is a very requested feature from a lot of our users and um yeah. This is, I will show you how it works, and how is this enabled right now? It's only on our staging environment, but it should make it to production bracing.

A

So I have a project here this redirects file and I can show you actually it's the same one. On the left side, uh we have a set of basic rules that have been working for a while uh already, which is mostly redirects and, as you can see, we're adding support for rewrites.

A

So, instead of just redirecting to a 302 or 301, we can now rewrite. uh We can also. We also support uh this. These placeholders here to be replaced and I'll actually rewrite as well splat to match anything that goes into this directory to redirect to this file and some placeholders with splats and a bit of a few more examples with the splats sorry with placeholders, and so I will show you real quick.

A

This is some production on gitlab.com. As you can see, this uh file is telling us their placeholders are not supported and spots are not supported.

A

This is understating so now we can see that they're valid.

A

So we can try this out so I'll. Have the rules on this side.

A

And now we can try going to say, for example, all slash file.

A

Cool and this matches this rule here so we're being sent back to 301 file html, let's see what happens, it will go to this one here.

A

So this is showing that when you don't specify a status code, you will be redirected via 301. So if I look at the network and try this again.

A

We need to go to the hold.

A

A

A

And you can see here at the bottom: we've got a 301 so that one's working, then let's try a 302.

A

You can see here file, we got redirected.

A

A

To go into file if I can find the location, header.

A

Anyway, uh we're being redirected here row two now: let's try our rewrite.

A

This should save the contents of this file with a 200 without actually redirecting. Let's clear this out.

A

Cool so rewrite html.

A

The path is still all rewrite, but we actually serve the contents of new rewrite index html, that's working, then: let's try this news.

A

I believe I have the current date, which is september 1st.

A

2021 in the side of the world, I think it's index.html.

A

Yes, cool and you can see- uh I actually did a rewrite, so we were saved at 200 down here, but it's showing the contents of this post.

A

So yep done, let's go and I can show you real, quick, the structure of this directory now this is the file that we just got so.

A

Cool this one here now, let's just give it up this slide a try.

A

So in theory, if we go to splat any uh path in here, we should be serve the contents of this file. So.

A

This is also a rewrite so yeah we are serving this content. This is pretty cool. This is very nice for single page applications.

A

If I go to index.html or any file, we serve the same content. um I forgot to test this, but if the file exists already, we would save that file instead of redirecting that. So that's um shouldn't be an issue and then let's just try this one here, uh what happens.

A

Okay, please hold there.

A

This rule is the same.

A

This one will actually redirect. So if I go to index html.

A

This redirects me to carrier dot index.html.

A

Because this file exists, it should exist.

A

Oh, I think this rule actually matched.

A

This rule must have matched the this rule and here instead because the file didn't exist. So if I try to go to a file that actually exists, it just says.

A

Actually serve the contents of carries our spot and we were redirected.

A

We were redirected from place folder to here to carry this but cool and.

A

There's a few more uh rules in here. You can go ahead and try if you'd like, I did add the last rule to do like a single page application so yeah. This basically shows that any of the files that exist are matched first and they are served.

A

For example, I check some of the files that exist in this file.

A

My html, I don't think, let's see if we have a rule for that. One.

A

Nope, so we can test this thing, so this last rule is matching everything to that to index serving the content of index, so whatever dot html serves me the content of index without redirecting. However, if I go to my html, this is not me, so we are actually sharing the content on the file because it exists.

A

This is really nice because for javascript or any other resources that you're saving should they should be served as well with them, so yeah yeah there. It goes um like I said this is uh this testing is on staging on a staging environment, so once we have validated this will enable it in production and for cell managed instances.

A

I believe that's noted in the documentation which is in this mi here which I'll post in the video and you basically just need to enable a feature flag on pages on the pages environment.

A

Which is not documented, but I will add this to the dots. Basically, I need to enable placeholders.

A

I'll put that in the box, all right, uh if you have any questions, feel free to reach out to this issue and we'll try to get back to you as soon as possible. Thanks.