Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Linear embed support for projects/updates #334

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add Linear embed support for projects/updates #334

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
734dfe9
Add support for projects/updates
zuuring Dec 17, 2024
bc07d07
Add project update support
zuuring Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 152 additions & 80 deletions discord-scripts/fix-linear-embed.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,16 @@
// track processed message to avoid duplicates if original message is edited
const processedMessages = new Map<
string,
Map<string, { issueId: string; commentId?: string; teamName?: string }>
Map<
string,
{
issueId?: string
commentId?: string
teamName?: string
projectId?: string
projectUpdateId?: string
}
>
>()

// let us also track sent embeds to delete them if the original message is deleted or edited WIP
Expand All @@ -27,6 +36,9 @@
/(?<!https:\/\/linear\.app\/[a-zA-Z0-9-]+\/issue\/)[A-Z]{3,}-\d+\b/gi
}

const projectRegex =
/https:\/\/linear\.app\/([a-zA-Z0-9-]+)\/project\/([a-zA-Z0-9-]+)(?:#projectUpdate-([a-zA-Z0-9]+))?/g

const issueUrlRegex =
/https:\/\/linear\.app\/([a-zA-Z0-9-]+)\/issue\/([a-zA-Z0-9-]+)(?:.*#comment-([a-zA-Z0-9]+))?/g

Expand All @@ -50,93 +62,122 @@

async function createLinearEmbed(
linearClient: LinearClient,
issueId: string,
issueId?: string,
commentId?: string,
teamName?: string,
projectId?: string,
projectUpdateId?: string,
) {
try {
const issue = await linearClient.issue(issueId)

const project = issue.project ? await issue.project : null
const state = issue.state ? await issue.state : null
const assignee = issue.assignee ? await issue.assignee : null
const comments = await issue.comments()
const comment = commentId
? comments.nodes.find((c) => c.id.startsWith(commentId))
: null

const embed = new EmbedBuilder()

if (comment) {
// Comment-focused embed
embed
.setTitle(`Comment on Issue: ${issue.title}`)
.setURL(
`https://linear.app/${teamName}/issue/${issue.identifier}#comment-${commentId}`,
)
.setDescription(
truncateToWords(comment.body, "No comment body available.", 50),
)
.addFields(
{
name: "Issue",
value: `${issue.title} (${state?.name || "No status"})`,
inline: false,
},
{
name: "Assignee",
value: assignee?.name.toString() || "Unassigned",
inline: true,
},
{
name: "Priority",
value: issue.priority?.toString() || "None",
inline: true,
},
)
.setFooter({ text: `Project: ${project?.name || "No project"}` })
} else {
// Issue-focused embed
embed
.setTitle(`Issue: ${issue.title}`)
.setURL(`https://linear.app/${teamName}/issue/${issue.identifier}`)
.setDescription(
truncateToWords(issue.description, "No description available.", 50),
)
.addFields(
{ name: "Status", value: state?.name || "No status", inline: true },
{
name: "Assignee",
value: assignee?.name.toString() || "Unassigned",
inline: true,
},
{
name: "Priority",
value: issue.priority?.toString() || "None",
inline: true,
},
)
.setFooter({ text: `Project: ${project?.name || "No project"}` })

if (comments.nodes.length > 0) {
embed.addFields({
name: "Recent Comment",
value: truncateToWords(
comments.nodes[0].body,
"No recent comment.",
25,
),
})
// project embed handling
if (projectId) {
const cleanProjectId = projectId.split("-").pop()
const project = cleanProjectId
? await linearClient.project(cleanProjectId)
: null
const updates = await project?.projectUpdates()
const update = projectUpdateId
? updates?.nodes.find((u) => u.id.startsWith(projectUpdateId))
: null

if (project) {
embed
.setTitle(`Project: ${project.name}`)
.setURL(
`https://linear.app/${teamName}/project/${projectId}/overview`,
)
.setDescription(
truncateToWords(
project.description,
"No description available.",
50,
),
)
.setTimestamp(new Date(project.updatedAt))
if (update) {
embed
.setTitle(
`Project Update: ${project.name} - ${new Date(
project.updatedAt,
).toLocaleString()}`,
)
.setURL(
`https://linear.app/${teamName}/project/${projectId}#projectUpdate-${projectUpdateId}`,
)
.setDescription(
truncateToWords(update?.body, "No description available.", 50),
)
}
}

return embed
}

if (issue.updatedAt) {
embed.setTimestamp(new Date(issue.updatedAt))
// issue + comment embed handling
if (issueId) {
const issue = await linearClient.issue(issueId)
const state = issue.state ? await issue.state : null
const assignee = issue.assignee ? await issue.assignee : null
const comments = await issue.comments()
const comment = commentId
? comments.nodes.find((c) => c.id.startsWith(commentId))
: null

if (comment) {
embed
.setTitle(`Comment on Issue: ${issue.title}`)
.setURL(
`https://linear.app/${teamName}/issue/${issue.identifier}#comment-${commentId}`,
)
.setDescription(
truncateToWords(comment.body, "No comment body available.", 50),
)
.addFields(
{
name: "Issue",
value: `${issue.title} (${state?.name || "No status"})`,
},
{
name: "Assignee",
value: assignee?.name || "Unassigned",
inline: true,
},
{
name: "Priority",
value: issue.priority?.toString() || "None",
inline: true,
},
)
} else {
embed
.setTitle(`Issue: ${issue.title}`)
.setURL(`https://linear.app/${teamName}/issue/${issue.identifier}`)
.setDescription(
truncateToWords(issue.description, "No description available.", 50),
)
.addFields(
{ name: "Status", value: state?.name || "No status", inline: true },
{
name: "Assignee",
value: assignee?.name || "Unassigned",
inline: true,
},
{
name: "Priority",
value: issue.priority?.toString() || "None",
inline: true,
},
)
}

return embed
}

return embed
return null
} catch (error) {
console.error("Error creating Linear embed:", error)

Check warning on line 180 in discord-scripts/fix-linear-embed.ts

View workflow job for this annotation

GitHub Actions / lint 

Unexpected console statement
return null
}
}
Expand All @@ -155,16 +196,27 @@

const urlMatches = Array.from(message.matchAll(issueUrlRegex))
const issueMatches = Array.from(message.matchAll(issueTagRegex))
const projectMatches = Array.from(message.matchAll(projectRegex))

if (urlMatches.length === 0 && issueMatches.length === 0) {
if (
urlMatches.length === 0 &&
issueMatches.length === 0 &&
projectMatches.length === 0
) {
return
}

const processedIssues =
processedMessages.get(messageId) ??
new Map<
string,
{ issueId: string; commentId?: string; teamName?: string }
{
issueId?: string
commentId?: string
teamName?: string
projectId?: string
projectUpdateId?: string
}
>()
processedMessages.set(messageId, processedIssues)

Expand All @@ -188,8 +240,19 @@
}
})

projectMatches.forEach((match) => {
const teamName = match[1]
const projectId = match[2]
const projectUpdateId = match[3]
const uniqueKey = `project-${projectId}`

if (!processedIssues.has(uniqueKey)) {
processedIssues.set(uniqueKey, { projectId, teamName, projectUpdateId })
}
})

const embedPromises = Array.from(processedIssues.values()).map(
async ({ issueId, commentId, teamName }) => {
async ({ issueId, commentId, teamName, projectId, projectUpdateId }) => {
logger.debug(
`Processing issue: ${issueId}, comment: ${commentId ?? "N/A"}, team: ${
teamName ?? "N/A"
Expand All @@ -201,6 +264,8 @@
issueId,
commentId,
teamName,
projectId,
projectUpdateId,
)
return { embed, issueId }
},
Expand Down Expand Up @@ -278,8 +343,15 @@
const issueMatches = issueTagRegex
? Array.from(newMessage.content.matchAll(issueTagRegex))
: []
const projectMatches = projectRegex
? Array.from(newMessage.content.matchAll(projectRegex))
: []

if (urlMatches.length === 0 && issueMatches.length === 0) {
if (
urlMatches.length === 0 &&
issueMatches.length === 0 &&
projectMatches.length === 0
) {
if (embedMessage) {
await embedMessage.delete().catch((error) => {
robot.logger.error(
Expand All @@ -291,7 +363,7 @@
return
}

const match = urlMatches[0] || issueMatches[0]
const match = urlMatches[0] || issueMatches[0] || projectMatches[0]
const teamName = match[1] || undefined
const issueId = match[2] || match[0]
const commentId = urlMatches.length > 0 ? match[3] || undefined : undefined
Expand Down
Loading