GitLab Frontend group, 10 Jan 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Engineering - User Callouts Walkthrough

Description

We walk through using user callouts in order to create user-dismissable banners in the GitLab UI.

A

Cool, so what we want to do so we're working on your issue here, where you want to prompt users to double-check their accounts recovery settings, and then we would prompt a banner that would link to their account every three months. So basically, what I'm gonna do is show you how it works currently for the GC like something that we do right now, which is the GCP credit offer if you go to the cluster's beach page mm-hmm.

A

If you go to like clusters, this is actually I, think where they created the user, call-out implementation first or no. That's not sure, there's another feature highlight somewhere here where they were using them.

B

A

Anyways, this is one of the ways that we can persist: user dismissals in the backend. So once you click this this or either one of these, actually, once you click it, it'll flip the switch in the backend saying like okay, you've dismissed this and then we'll never show it again. Unless you happen to clear it or you create a new flag for it. So you can see my screen yeah, okay, so what you really need to work?

A

What you need to really edit is like two things: is the user call enums, which just kind of declare all of the.

A

Possible user call out flags, and so there's actually two at once for cd14 ee, so you have to be mindful of that so check the ee one as well to make sure that you're not using like another duplicate ID. So in this case we would do something like I, don't know account recovery.

A

Something and then something like that, and then you would go to something like the user, call-out helper and then add a helper here to just basically map to that. You know that key mm-hmm and then you can use that in your template helper. So you determine whether or not it should show the offer, because at this point it's checking if the user has dismissed it. So in this case we have show TCP sign up offer, and so, if I go to the clusters helper, that's where I'm actually checking it here to see. Okay.

A

Well, let me back up a little bit in my template, I'm actually trying to render it here, uh-huh and then I have a helper that actually checks. There's two things in this case, whether there's an instance level setting where we hide third-party offers or whether or not it's just been dismissed, at which point we just render the flag. This is a little bit more complicated because we had this toggle or this application setting. So what you'd really only need to do is do like you know if you know show you.

B

Know if I have the relevant call out yeah, so basically, we will need to introduce like a new cloud scheme like recovery settings, maybe 2020 January or whatever I'm right. What will be the naming and we will just manually, introduce new call out each three months and merge them via merge requests, yeah.

A

So that's actually an awesome. This privacy policy or this MRT I did this for the privacy policy, because the idea was anytime, the privacy policy would be updated.

A

We would prompt the user again to like dismiss the banner, which would be like acknowledging that they've read the privacy policy, or at least they know that it's been updated, and so, when I did in this case and I, don't know if we should do the same, because we're gonna be issuing new banners every three months is that I would just link to the issue explaining why you know what this privacy policy was and then it was just specific to that issue. Number I, don't I mean other than that.

A

We would probably just have some type of other naming scheme of like q1, q2 q3, or something like that. Mmm-Hmm.

B

A very dumb question: what if the user does not science in or dismiss the cloud for more than three months or whatever, so he will basically have to Klaus available if icon not dismissed, yeah.

A

So, that's probably something we'll have to check, and actually that would probably be where we put in the user Colin's helper here is that we would be checking previous call call-outs for the account recovery, so basically I saw. Actually you know what we're probably going to need something like this, where.

B

Yeah I also thought about that. Every we're.

A

Gonna be helping Lexi's yeah, so we don't show more than one better mmm-hmm. So it'll just go down the list of call outs until hopefully we can. We can check the database and say like all right. We can clear some of these mm-hmm.

B

B

And how they're persisted in database I mean just for testing purposes if I want to quickly dismiss it, I believe something like user clouds table yeah.

A

I'd show you, but my GDK is still so yeah. You just go in the database. It's I believe it's user call-outs, but I can double-check that after this.

B

No, my they just like okay, if it's simple table I will definitely find it. It's.

A

A very small table, it's literally call out ID user ID and then whether it's dismissed, which I think because there would indicate it would be dismissed but yeah. So yep I'm.

B

Going to so bye, sically, no J helper, some another have a first point tool in our helper holding that, and sometimes nice templates, rendering that right, it's probably I'm, not I'm, not sure. If we have it just will need to check, see. Yep.

B

Okay well seems pretty.

B

Did do, did you return any additional tests for covering, when you add a new call out, or this is enough just for covering there already, we consider already covered by general outreach and no additional tests call.

A

Out as a the helpers have their own specs I think I the lights, that's funny, so you really I, don't think I added tests for the privacy policy, one because we're already testing the call out helper. So if that's not working and that's a bigger issue and if we're not rendering templates, that's a bigger issue as well. So, okay.

B

So, basically, what I will need to do I will need to have the helper or as a test only for that multiple call, outs, logic, right, mm-hmm,.

A

Yeah, so actually you know I write for the privacy policy. I did out of spec just to make make sure that if they dismissed the specific flag, but it's really kind of extra you.

B

A

B

Because, if you will do this, one for each call out Q 1, Q 2, that will be pretty.

A

Exactly yeah I, don't really think we'll need that so and I think that's pretty easy to justify in the merge request review. So ok.

B

So I will just add the test for multiple colossi behavior and it will be fine yep. Okay, thank you seems pretty straightforward. Do not expect any problems with this, so thank you. Yep I'll go ahead and stop.

A