Invite management #297
Invite management #297
Conversation
### Notes This adds a new feature to valkyrie for managing invites into discord both for create and deleting invite. Currently there is a hardcoded command `!create-invite` that will generate a new invite for the specific channel the command was iniatied in. With the default settings of 24 hours expiry and 10 uses, however we can further this by defining set parameters. More or less just a PoC implementation on creating an invite based on the set parameters.
This adds a implementation into the invite script which generates an invite to the specific channel based of a channel being made in the defense category with `ext-*-audit` format. To-do: Link with role-manager to whirl up a role with the same channel name, granting access to that channel only.
|
Just added the To-do: Link with role-manager to whirl up a role with the same channel name, granting access to that channel only. |
This commit adds a new discord command `/create-invite` that allows you to generate a new invite within the channel that the command is run from. Max age / max uses: Included are two parameters, `max-age` and `max-uses` that optionally let you specify the amount of time the invite link will be available for, and the number of invites. By default this will be set to 24 hours and for only 10 uses.
Once a new `ext-*-audit` channel has been created, this will now create a role with the exact same name as the channel, and assign permissions to only view that channel. Now will need to get a role assignment going when a new user joins the server based off the invite.
|
Added the permission / role creation in the last commit, so now when |
| const invite = await channelOrigin.createInvite({ | ||
| maxAge: numericMaxAge, | ||
| maxUses: numericMaxUses, | ||
| unique: true, |
There was a problem hiding this comment.
Interesting. Wonder what happens if this is off lol.
There was a problem hiding this comment.
@Shadowfiend Looks like it defaults to 24 hours, infinite uses = 0 😁
There was a problem hiding this comment.
Oh I just meant the unique property.
This commit adds the following major changes - Fix `globals.ts` to have proper seconds (since it was calculating based off milliseconds and not seconds). Updated `github-auth.ts` to reflect this change. - Setup proper channel role mapping. Now it will name the new role `Defense: clientName` based on the `ext-channel-audit` name pattern. - Fix typescript issues - Remove max-age/max-uses from `/create-invite` command
|
@Shadowfiend One thing to note on the |
discord-scripts/invite-management.ts
Outdated
| const maxAge = WEEK | ||
| const maxUses = 10 |
There was a problem hiding this comment.
At this point we've repeated our default age and uses 3 times. I think what I'd suggest here is to make createInvite return an object ({ url: string; maxAge: number; maxUses: number }) and be entirely in charge of the default age and uses (using its parameter defaults). That way we cut most of this down.
I would also consider making createInvite take a TextChannel instead of a channel id, since all callers have access to the object. That way you can also eliminate the extra channel lookup by id that we do in createInvite.
There was a problem hiding this comment.
I've got this all fixed now so we only have those defaults on maxAge / maxUses in the main func. Now they are set as they should be as parameter defaults, so if needed we can easily add custom values down the road. And instead of passing channel.id, it just sends the channel.object and runs invite from there.
lib/globals.ts
Outdated
| @@ -1,3 +1,7 @@ | |||
| export const HOST = process.env.HUBOT_HOST | |||
| export const SECOND = 1000 | |||
| export const MILLISECOND = 1000 | |||
| export const SECOND = 1 | |||
There was a problem hiding this comment.
This should be 1 * MILLISECOND—if we need to do a division later on by MILLISECOND to have the right precision for e.g. the Discord API, let's do that there.
We can probably drop a comment on these indicating that they're in millisecond precision.
The reasoning to do that rather than reindex everything against seconds is:
- More precision is good in many cases, until it's time to drop to lower precision.
30 * MILLISECOND(as used below) isn't correct—we're not setting an interval for 30 milliseconds, but rather for 30 seconds. The goal of the constants here is so that the phrase that uses it reflects the intent, and to do that across most use cases successfully, we need to use the higher precision as the basis.
There was a problem hiding this comment.
Ok that makes sense! So then for the Discord API, since we need exact seconds for DAY, WEEK instances we will have to do WEEK / MILLISECOND in-order to get the desired maxAge: 604800 vs 604800000 by default. Unless you'd prefer we just add that into the global.ts scope, something along the lines of WEEK_IN_SECONDS.
Since otherwise DiscordAPI comes back with DiscordAPIError[50035]: Invalid Form Body max_age[NUMBER_TYPE_MAX]: int value should be less than or equal to 604800.
Edit: I've actually just updated the main invite-management.ts with a / MILLISECOND to account for this if that makes more sense!
This commits goes through the review changes and resolves these issues: - Remove extra consts on `maxAge/maxUses` - Rather than passing `channel.id`, pass the object instead - Suggested fix on split/slice for audit channel name (thank youuu!)
Make sure error logging in place incase client-name not found, skip role creation
| channelId: string, | ||
| maxAge = WEEK, | ||
| channel: TextChannel, | ||
| maxAge = (1 * WEEK) / MILLISECOND, |
There was a problem hiding this comment.
Not blocking, but let's do this conversion inside, when we call channel.createInvite—so the caller can always pass things and receive things in terms of our base time unit (the ms) throughout the codebase, and we only convert when we touch the external entity that requires a different denomination.
| @@ -1,6 +1,6 @@ | |||
| export const HOST = process.env.HUBOT_HOST | |||
| export const MILLISECOND = 1000 | |||
| export const SECOND = 1 | |||
| export const SECOND = 1 * MILLISECOND | |||
There was a problem hiding this comment.
Realizing this should really be phrased as:
export const MILLISECOND = 1 // Base unit of time for our code.
export const SECOND = 1000 * MILLISECOND
...| if (clientName) { | ||
| const roleName = clientName | ||
| ? `Defense: ${clientName}` | ||
| : `Defense: ${channel.name}` |
There was a problem hiding this comment.
Since we have the if (clientName) check now, I think this can just be:
| if (clientName) { | |
| const roleName = clientName | |
| ? `Defense: ${clientName}` | |
| : `Defense: ${channel.name}` | |
| if (clientName) { | |
| const roleName = `Defense: ${clientName}` |
Notes
This adds a new feature to valkyrie for managing invites into discord both for create and deleting invite.
You can use the
/create-invitecommand which will generate an invite for the channel that the command is being sent from. With the default settings of 7 days expiry and 10 uses.Defense implementation
This now includes an interaction
discordClient.on("channelCreate")to check if a channel has been made withext-*-auditformat and will generate an invite link into that channel based off this. This will also create a matching role with channel access calledDefense: roleScreenshots
Role assignments
Since this is only the component to create/delete invites, we would need to still tie this together with the
role-management.tsimplementation. That being that when a new member joins the discord server, we monitor thediscordClient.on("GuildMemberAdd")event and check the inviteID used, then assign role tied to that. Whether that should always assume the channel to which an invite is generated a role should be assigned to that once the invite is used (?).To-do
/create-invite