GitLab GDK and Gitpod walkthroughs, 16 Jun 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Support Engineering: Contributing to GitLab with GDK

Description

related issue:
- https://gitlab.com/gitlab-org/gitlab/-/issues/333387
- https://gitlab.com/gitlab-org/gitlab/-/issues/333450
- https://gitlab.com/gitlab-com/support/support-pairing/-/issues/3406

A

Hi rocky hi sabine. Thank you for joining me in this video, uh hello.

B

A

In this video I'm going to demonstrate how you can use the gitlab development kit to contribute to the gitlab project, here's some context. First, there there is a possibility that the user is not allowed to create a group and the menu item for this group is still rendered in the ui and when you navigate to it, you'll be presented with a 404 error.

A

This merge request then set out to resolve that and out of that merge request, we created a follow-up issue to um to research. Whether you can still create a project through the ui in the menu when you're not allowed to now users that are not allowed to create a project.

A

They can be external, so using gdk we can go to any user. In this case. It's this one. We can edit this user.

A

I'm gonna turn off my video in case that might speed things up.

A

B

A

So you can see that I've set this user as an external user already now, if we go to that actual user, this is um how they see their environment and we can see that they don't have a little button here for a menu, but we can see that they still have this menu and we can see that they can still create a project.

A

So, let's see how that looks like.

A

And we can see that they're actually here where they can go through the whole ui of creating a new project. So, let's see how that goes. My test project.

A

And we see that the user gets an error. Namespace is not valid, so ideally, this entire view would not even be rendered because um because an external user isn't allowed to create a project to begin with, uh following the rails convention, we can see that the path is projects new.

A

So let's go to that bit in our code and before doing that, I'm going to spin up the the rails console so that we don't have to wait for that later. On.

A

And then in the meantime,.

A

And let's go to that file, so it's a controller project.

A

And then we go to the method, new.

A

We can see here that there is some logic regarding the namespace and if it's invalid, it returns access the knight and otherwise you can just create a project. However. Instead we want to return access denied already prior to checking for namespace. If the user is not allowed to create a project, so we can go something like access.

A

A

Unless the user can create a.

A

Project we save that and then we go back to our user here and let's see what happens if we visit this page.

A

A

A

A

Okay, so we see that it renders the 404 now um that's good, because this user isn't allowed to create a project. However,.

A

um From a ui perspective, uh ideally you wouldn't want to see these buttons right so yep. Let's look at what we can see in the ui about this button and we can see that it says something along the lines of well create project link and um create blank project. So, let's just search for that in the code base.

A

Maybe that will help us find what we want.

B

Create blank project.

A

Let's not have markdown files.

B

Let's not have these.

B

B

A

Now, if we look at this list,.

A

B

You can set the exact.

B

A

Maybe search for menu as.

A

B

A

A

Leave that, in the background meanwhile see what else we could look at.

A

um Projects drop down blank project and create project links.

B

Maybe blank underscore project.

A

Well, if we look at what we currently see as a result, it just took a very long time.

B

A

My screen, it's it's quite hot weather. Now we can see that this file um has this result and we quickly look at it.

A

We see that this does look very familiar, create blank project, import project. It looks like this is a file we need.

A

So just by using the browser and inspecting the element, you can find a way by just grabbing the code base for whatever you're looking for and if we see here create project- and we see here import project all the way to create from template.

A

We can see that that all three of these represent what's in the code base and that we don't actually want them if you're not allowed to create a project as an.

B

A

User, so let's put that in the cloud: oh this entire bit.

A

Using hammock is a if.

B

B

A

Then we indent it save and let's see how that looks like.

B

A

We can see that it no longer renders the buttons for creating a project. So that's good.

A

If you look at the top of this file, you see here that this file is slightly removed along with the combined menu so to injudicate now to enable that combined menu. You can just enable software feature.

A

A

And let's see how that looks,.

A

Like and now the new menu is rendered, if we click on that and we're in projects here, you can see that this user, this button is still rendered create new project.

A

So let's get rid of that one too, as suggested here. Well, we should go to this file top nav.

A

A

And then, let's just search for project.

A

No not exactly what I'm looking for.

B

B

A

We see that in this method, all the menu items are created for um for creating a project.

A

So we see that it says one for exploring start and yours and then the final one for creating a new one.

A

You can see that I did it here as well for the group in an early in the earlier issue.

A

So with that same idea, we can just say.

B

If current user can create.

A

And that's all: we need, let's confirm how that looks like.

B

A

And that button is now no longer rendered.

A

um I think that's all. We need um for future iterations and feedback from the developers we can see with this. Just in the merge request, perhaps there's something that that we so far overlooked, um but that will be something for later then, for now, let's just commit a merge.

A

I won't be needing this.

A

Anymore, let's look at what we have so far.

A

We see three unstaged files. We've got this change, the project controller.

A

In the new menu we're adding the condition and we're doing so as well in the old menu, let's create a new branch.

B

A

A

Let's stage this.

A

A

Okay, uh if this does get merged, we can actually close the issue. The follow-up issue so.

A

Let's see what that.

B

B

A

A

Okay and let's just push.

A

A

Okay, we successfully pushed, and you can see that we also have a reference for creating a merge request.

A

Let's navigate to that page.

B

A

This is really all we need. What does this? Mr? Do it.

B

B

A

Looks like it didn't add my closest statement.

A

It needs that in the body of the merch request to automatically close an issue. So let's do that here.

A

Let's add a bunch of labels because we're all from the support team, um let's start off with support team contributions, um this entire um menu- it sits under the editor group, so let's go to create.

B

Group editor.

A

It's a change in the back end and it's a change in the front end um and if any other features that we need, we can just um iterate on that. Currently, I'm gonna sign it to me. Let's put a new workflow and I'm gonna ask review from paul.

A

A

Reason why I'm asking from him is because he he has been working on this new menu so much and he might be the best person to review this. To start with the review process, create mesh request and that's all we need.

B

A

Any feedback that we may get from the developers um more labels changes anything uh you can just progress with that. Follow up on their advice, learn new things. Often the case. um It's not expected to make the merch request perfect in one go just start small small changes um get familiar with using gdk, it's fun. It's.

B

A

Way to contribute, um you all have any questions.

A

Alright, then I'm going to stop the recording.

A