Skip to content

fix: Handle null user in comment transformation #38

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

Open
rbolkey wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Handle null user in comment transformation #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions src/utils/graphql-issues-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -881,10 +881,12 @@ export class GraphQLIssuesService {
id: comment.id,
body: comment.body,
embeds: extractEmbeds(comment.body),
user: {
id: comment.user.id,
name: comment.user.name,
},
user: comment.user
? {
id: comment.user.id,
name: comment.user.name,
}
: undefined,
createdAt: comment.createdAt instanceof Date
? comment.createdAt.toISOString()
: (comment.createdAt
Expand Down
4 changes: 2 additions & 2 deletions src/utils/linear-types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export interface LinearIssue {
url: string;
expiresAt: string;
}>;
user: {
user?: {
id: string;
name: string;
};
Expand Down Expand Up @@ -153,7 +153,7 @@ export interface CreateCommentArgs {
export interface LinearComment {
id: string;
body: string;
user: {
user?: {
id: string;
name: string;
};
Expand Down
179 changes: 179 additions & 0 deletions tests/unit/graphql-issues-service-comments.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
import { GraphQLIssuesService } from "../../src/utils/graphql-issues-service.js";
import type { GraphQLService } from "../../src/utils/graphql-service.js";

/**
* Unit tests for comment transformation in GraphQLIssuesService
*
* These tests verify the fix for null user handling:
* - System-generated comments (e.g., Jira sync) have user: null
* - The transformation should handle null users without crashing
*/

describe("GraphQLIssuesService - Comment Transformation", () => {
let mockGraphQLService: {
rawRequest: ReturnType<typeof vi.fn>;
};
let service: GraphQLIssuesService;

beforeEach(() => {
mockGraphQLService = {
rawRequest: vi.fn(),
};
service = new GraphQLIssuesService(
mockGraphQLService as unknown as GraphQLService,
);
});

describe("getIssueById - comment user handling", () => {
it("should handle comment with null user", async () => {
mockGraphQLService.rawRequest.mockResolvedValue({
issues: {
nodes: [
{
id: "issue-1",
identifier: "TEST-1",
title: "Test Issue",
description: null,
branchName: "test-branch",
priority: 0,
estimate: null,
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
state: { id: "state-1", name: "Todo" },
assignee: null,
team: { id: "team-1", key: "TEST", name: "Test Team" },
project: null,
labels: { nodes: [] },
cycle: null,
projectMilestone: null,
parent: null,
children: { nodes: [] },
comments: {
nodes: [
{
id: "comment-1",
body: "System generated comment",
user: null,
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
},
],
},
},
],
},
});

const result = await service.getIssueById("TEST-1");

expect(result.comments).toHaveLength(1);
expect(result.comments![0].user).toBeUndefined();
expect(result.comments![0].body).toBe("System generated comment");
});

it("should handle comment with valid user", async () => {
mockGraphQLService.rawRequest.mockResolvedValue({
issues: {
nodes: [
{
id: "issue-1",
identifier: "TEST-1",
title: "Test Issue",
description: null,
branchName: "test-branch",
priority: 0,
estimate: null,
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
state: { id: "state-1", name: "Todo" },
assignee: null,
team: { id: "team-1", key: "TEST", name: "Test Team" },
project: null,
labels: { nodes: [] },
cycle: null,
projectMilestone: null,
parent: null,
children: { nodes: [] },
comments: {
nodes: [
{
id: "comment-1",
body: "User comment",
user: { id: "user-1", name: "Test User" },
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
},
],
},
},
],
},
});

const result = await service.getIssueById("TEST-1");

expect(result.comments).toHaveLength(1);
expect(result.comments![0].user).toEqual({
id: "user-1",
name: "Test User",
});
});

it("should handle mix of comments with and without users", async () => {
mockGraphQLService.rawRequest.mockResolvedValue({
issues: {
nodes: [
{
id: "issue-1",
identifier: "TEST-1",
title: "Test Issue",
description: null,
branchName: "test-branch",
priority: 0,
estimate: null,
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
state: { id: "state-1", name: "Todo" },
assignee: null,
team: { id: "team-1", key: "TEST", name: "Test Team" },
project: null,
labels: { nodes: [] },
cycle: null,
projectMilestone: null,
parent: null,
children: { nodes: [] },
comments: {
nodes: [
{
id: "comment-1",
body: "System comment",
user: null,
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
},
{
id: "comment-2",
body: "User comment",
user: { id: "user-1", name: "Test User" },
createdAt: "2026-01-01T00:00:00.000Z",
updatedAt: "2026-01-01T00:00:00.000Z",
},
],
},
},
],
},
});

const result = await service.getIssueById("TEST-1");

expect(result.comments).toHaveLength(2);
expect(result.comments![0].user).toBeUndefined();
expect(result.comments![1].user).toEqual({
id: "user-1",
name: "Test User",
});
});
});
});