feat(#15): implement Gantt chart component

- Create GanttChart component with timeline visualization
- Add task bars with status-based color coding
- Implement PDA-friendly language (Target passed vs OVERDUE)
- Support task click interactions
- Comprehensive test coverage (96.18%)
- 33 tests passing (22 component + 11 helper tests)
- Fully accessible with ARIA labels and keyboard navigation
- Demo page at /demo/gantt
- Responsive design with customizable height

Technical details:
- Uses Next.js 16 + React 19 + TypeScript
- Strict typing (NO any types)
- Helper functions to convert Task to GanttTask
- Timeline calculation with automatic range detection
- Status indicators: completed, in-progress, paused, not-started

Refs #15
This commit is contained in:
Jason Woltje
2026-01-29 17:43:40 -06:00
parent 95833fb4ea
commit 9ff7718f9c
15 changed files with 2421 additions and 0 deletions

View File

@@ -0,0 +1,220 @@
import { describe, it, expect, beforeEach, vi } from "vitest";
import { Test, TestingModule } from "@nestjs/testing";
import { DomainsController } from "./domains.controller";
import { DomainsService } from "./domains.service";
import { CreateDomainDto, UpdateDomainDto, QueryDomainsDto } from "./dto";
import { AuthGuard } from "../auth/guards/auth.guard";
import { WorkspaceGuard, PermissionGuard } from "../common/guards";
import { ExecutionContext } from "@nestjs/common";
describe("DomainsController", () => {
let controller: DomainsController;
let service: DomainsService;
const mockDomainsService = {
create: vi.fn(),
findAll: vi.fn(),
findOne: vi.fn(),
update: vi.fn(),
remove: vi.fn(),
};
const mockAuthGuard = {
canActivate: vi.fn((context: ExecutionContext) => {
const request = context.switchToHttp().getRequest();
request.user = {
id: "550e8400-e29b-41d4-a716-446655440002",
workspaceId: "550e8400-e29b-41d4-a716-446655440001",
};
return true;
}),
};
const mockWorkspaceGuard = {
canActivate: vi.fn(() => true),
};
const mockPermissionGuard = {
canActivate: vi.fn(() => true),
};
const mockWorkspaceId = "550e8400-e29b-41d4-a716-446655440001";
const mockUserId = "550e8400-e29b-41d4-a716-446655440002";
const mockDomainId = "550e8400-e29b-41d4-a716-446655440003";
const mockDomain = {
id: mockDomainId,
workspaceId: mockWorkspaceId,
name: "Work",
slug: "work",
description: "Work-related tasks and projects",
color: "#3B82F6",
icon: "briefcase",
sortOrder: 0,
metadata: {},
createdAt: new Date(),
updatedAt: new Date(),
};
const mockUser = {
id: mockUserId,
email: "test@example.com",
name: "Test User",
};
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [DomainsController],
providers: [
{
provide: DomainsService,
useValue: mockDomainsService,
},
],
})
.overrideGuard(AuthGuard)
.useValue(mockAuthGuard)
.overrideGuard(WorkspaceGuard)
.useValue(mockWorkspaceGuard)
.overrideGuard(PermissionGuard)
.useValue(mockPermissionGuard)
.compile();
controller = module.get<DomainsController>(DomainsController);
service = module.get<DomainsService>(DomainsService);
// Clear all mocks before each test
vi.clearAllMocks();
});
it("should be defined", () => {
expect(controller).toBeDefined();
});
describe("create", () => {
it("should create a domain", async () => {
const createDto: CreateDomainDto = {
name: "Work",
slug: "work",
description: "Work-related tasks",
color: "#3B82F6",
icon: "briefcase",
};
mockDomainsService.create.mockResolvedValue(mockDomain);
const result = await controller.create(
createDto,
mockWorkspaceId,
mockUser
);
expect(result).toEqual(mockDomain);
expect(service.create).toHaveBeenCalledWith(
mockWorkspaceId,
mockUserId,
createDto
);
});
});
describe("findAll", () => {
it("should return paginated domains", async () => {
const query: QueryDomainsDto = { page: 1, limit: 10 };
const paginatedResult = {
data: [mockDomain],
meta: {
total: 1,
page: 1,
limit: 10,
totalPages: 1,
},
};
mockDomainsService.findAll.mockResolvedValue(paginatedResult);
const result = await controller.findAll(query, mockWorkspaceId);
expect(result).toEqual(paginatedResult);
expect(service.findAll).toHaveBeenCalledWith({
...query,
workspaceId: mockWorkspaceId,
});
});
it("should handle search query", async () => {
const query: QueryDomainsDto = {
page: 1,
limit: 10,
search: "work",
};
mockDomainsService.findAll.mockResolvedValue({
data: [mockDomain],
meta: { total: 1, page: 1, limit: 10, totalPages: 1 },
});
await controller.findAll(query, mockWorkspaceId);
expect(service.findAll).toHaveBeenCalledWith({
...query,
workspaceId: mockWorkspaceId,
});
});
});
describe("findOne", () => {
it("should return a domain by ID", async () => {
mockDomainsService.findOne.mockResolvedValue(mockDomain);
const result = await controller.findOne(mockDomainId, mockWorkspaceId);
expect(result).toEqual(mockDomain);
expect(service.findOne).toHaveBeenCalledWith(
mockDomainId,
mockWorkspaceId
);
});
});
describe("update", () => {
it("should update a domain", async () => {
const updateDto: UpdateDomainDto = {
name: "Updated Work",
color: "#10B981",
};
const updatedDomain = { ...mockDomain, ...updateDto };
mockDomainsService.update.mockResolvedValue(updatedDomain);
const result = await controller.update(
mockDomainId,
updateDto,
mockWorkspaceId,
mockUser
);
expect(result).toEqual(updatedDomain);
expect(service.update).toHaveBeenCalledWith(
mockDomainId,
mockWorkspaceId,
mockUserId,
updateDto
);
});
});
describe("remove", () => {
it("should delete a domain", async () => {
mockDomainsService.remove.mockResolvedValue(undefined);
await controller.remove(mockDomainId, mockWorkspaceId, mockUser);
expect(service.remove).toHaveBeenCalledWith(
mockDomainId,
mockWorkspaceId,
mockUserId
);
});
});
});

View File

@@ -0,0 +1,393 @@
import { describe, it, expect, beforeEach, vi } from "vitest";
import { Test, TestingModule } from "@nestjs/testing";
import { DomainsService } from "./domains.service";
import { PrismaService } from "../prisma/prisma.service";
import { ActivityService } from "../activity/activity.service";
import { NotFoundException, ConflictException } from "@nestjs/common";
describe("DomainsService", () => {
let service: DomainsService;
let prisma: PrismaService;
let activityService: ActivityService;
const mockPrismaService = {
domain: {
create: vi.fn(),
findMany: vi.fn(),
count: vi.fn(),
findUnique: vi.fn(),
findFirst: vi.fn(),
update: vi.fn(),
delete: vi.fn(),
},
};
const mockActivityService = {
logDomainCreated: vi.fn(),
logDomainUpdated: vi.fn(),
logDomainDeleted: vi.fn(),
};
const mockWorkspaceId = "550e8400-e29b-41d4-a716-446655440001";
const mockUserId = "550e8400-e29b-41d4-a716-446655440002";
const mockDomainId = "550e8400-e29b-41d4-a716-446655440003";
const mockDomain = {
id: mockDomainId,
workspaceId: mockWorkspaceId,
name: "Work",
slug: "work",
description: "Work-related tasks and projects",
color: "#3B82F6",
icon: "briefcase",
sortOrder: 0,
metadata: {},
createdAt: new Date(),
updatedAt: new Date(),
};
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
DomainsService,
{
provide: PrismaService,
useValue: mockPrismaService,
},
{
provide: ActivityService,
useValue: mockActivityService,
},
],
}).compile();
service = module.get<DomainsService>(DomainsService);
prisma = module.get<PrismaService>(PrismaService);
activityService = module.get<ActivityService>(ActivityService);
// Clear all mocks before each test
vi.clearAllMocks();
});
it("should be defined", () => {
expect(service).toBeDefined();
});
describe("create", () => {
it("should create a domain and log activity", async () => {
const createDto = {
name: "Work",
slug: "work",
description: "Work-related tasks",
color: "#3B82F6",
icon: "briefcase",
};
mockPrismaService.domain.findFirst.mockResolvedValue(null);
mockPrismaService.domain.create.mockResolvedValue(mockDomain);
mockActivityService.logDomainCreated.mockResolvedValue({});
const result = await service.create(mockWorkspaceId, mockUserId, createDto);
expect(result).toEqual(mockDomain);
expect(prisma.domain.findFirst).toHaveBeenCalledWith({
where: {
workspaceId: mockWorkspaceId,
slug: createDto.slug,
},
});
expect(prisma.domain.create).toHaveBeenCalledWith({
data: {
...createDto,
workspace: {
connect: { id: mockWorkspaceId },
},
sortOrder: 0,
metadata: {},
},
});
expect(activityService.logDomainCreated).toHaveBeenCalledWith(
mockWorkspaceId,
mockUserId,
mockDomainId,
{ name: mockDomain.name }
);
});
it("should throw ConflictException if slug already exists", async () => {
const createDto = {
name: "Work",
slug: "work",
};
mockPrismaService.domain.findFirst.mockResolvedValue(mockDomain);
await expect(
service.create(mockWorkspaceId, mockUserId, createDto)
).rejects.toThrow(ConflictException);
expect(prisma.domain.create).not.toHaveBeenCalled();
});
it("should use default values for optional fields", async () => {
const createDto = {
name: "Work",
slug: "work",
};
mockPrismaService.domain.findFirst.mockResolvedValue(null);
mockPrismaService.domain.create.mockResolvedValue(mockDomain);
mockActivityService.logDomainCreated.mockResolvedValue({});
await service.create(mockWorkspaceId, mockUserId, createDto);
expect(prisma.domain.create).toHaveBeenCalledWith({
data: {
name: "Work",
slug: "work",
workspace: {
connect: { id: mockWorkspaceId },
},
sortOrder: 0,
metadata: {},
},
});
});
});
describe("findAll", () => {
it("should return paginated domains", async () => {
const query = { workspaceId: mockWorkspaceId, page: 1, limit: 10 };
const mockDomains = [mockDomain];
mockPrismaService.domain.findMany.mockResolvedValue(mockDomains);
mockPrismaService.domain.count.mockResolvedValue(1);
const result = await service.findAll(query);
expect(result).toEqual({
data: mockDomains,
meta: {
total: 1,
page: 1,
limit: 10,
totalPages: 1,
},
});
expect(prisma.domain.findMany).toHaveBeenCalledWith({
where: { workspaceId: mockWorkspaceId },
orderBy: { sortOrder: "asc" },
skip: 0,
take: 10,
});
expect(prisma.domain.count).toHaveBeenCalledWith({
where: { workspaceId: mockWorkspaceId },
});
});
it("should filter by search term", async () => {
const query = {
workspaceId: mockWorkspaceId,
page: 1,
limit: 10,
search: "work",
};
mockPrismaService.domain.findMany.mockResolvedValue([mockDomain]);
mockPrismaService.domain.count.mockResolvedValue(1);
await service.findAll(query);
expect(prisma.domain.findMany).toHaveBeenCalledWith({
where: {
workspaceId: mockWorkspaceId,
OR: [
{ name: { contains: "work", mode: "insensitive" } },
{ description: { contains: "work", mode: "insensitive" } },
],
},
orderBy: { sortOrder: "asc" },
skip: 0,
take: 10,
});
});
it("should use default pagination values", async () => {
const query = { workspaceId: mockWorkspaceId };
mockPrismaService.domain.findMany.mockResolvedValue([]);
mockPrismaService.domain.count.mockResolvedValue(0);
await service.findAll(query);
expect(prisma.domain.findMany).toHaveBeenCalledWith({
where: { workspaceId: mockWorkspaceId },
orderBy: { sortOrder: "asc" },
skip: 0,
take: 50,
});
});
it("should calculate pagination correctly", async () => {
const query = { workspaceId: mockWorkspaceId, page: 3, limit: 20 };
mockPrismaService.domain.findMany.mockResolvedValue([]);
mockPrismaService.domain.count.mockResolvedValue(55);
const result = await service.findAll(query);
expect(result.meta).toEqual({
total: 55,
page: 3,
limit: 20,
totalPages: 3,
});
expect(prisma.domain.findMany).toHaveBeenCalledWith({
where: { workspaceId: mockWorkspaceId },
orderBy: { sortOrder: "asc" },
skip: 40, // (3 - 1) * 20
take: 20,
});
});
});
describe("findOne", () => {
it("should return a domain by ID", async () => {
mockPrismaService.domain.findUnique.mockResolvedValue(mockDomain);
const result = await service.findOne(mockDomainId, mockWorkspaceId);
expect(result).toEqual(mockDomain);
expect(prisma.domain.findUnique).toHaveBeenCalledWith({
where: {
id: mockDomainId,
workspaceId: mockWorkspaceId,
},
include: {
_count: {
select: {
tasks: true,
projects: true,
events: true,
ideas: true,
},
},
},
});
});
it("should throw NotFoundException if domain not found", async () => {
mockPrismaService.domain.findUnique.mockResolvedValue(null);
await expect(
service.findOne(mockDomainId, mockWorkspaceId)
).rejects.toThrow(NotFoundException);
});
});
describe("update", () => {
it("should update a domain and log activity", async () => {
const updateDto = {
name: "Updated Work",
color: "#10B981",
};
const updatedDomain = { ...mockDomain, ...updateDto };
mockPrismaService.domain.findUnique.mockResolvedValue(mockDomain);
mockPrismaService.domain.findFirst.mockResolvedValue(null);
mockPrismaService.domain.update.mockResolvedValue(updatedDomain);
mockActivityService.logDomainUpdated.mockResolvedValue({});
const result = await service.update(
mockDomainId,
mockWorkspaceId,
mockUserId,
updateDto
);
expect(result).toEqual(updatedDomain);
expect(prisma.domain.update).toHaveBeenCalledWith({
where: {
id: mockDomainId,
workspaceId: mockWorkspaceId,
},
data: updateDto,
});
expect(activityService.logDomainUpdated).toHaveBeenCalledWith(
mockWorkspaceId,
mockUserId,
mockDomainId,
{ changes: updateDto }
);
});
it("should throw NotFoundException if domain not found", async () => {
const updateDto = { name: "Updated Work" };
mockPrismaService.domain.findUnique.mockResolvedValue(null);
await expect(
service.update(mockDomainId, mockWorkspaceId, mockUserId, updateDto)
).rejects.toThrow(NotFoundException);
expect(prisma.domain.update).not.toHaveBeenCalled();
});
it("should throw ConflictException if slug already exists for another domain", async () => {
const updateDto = { slug: "existing-slug" };
const anotherDomain = { ...mockDomain, id: "another-id", slug: "existing-slug" };
mockPrismaService.domain.findUnique.mockResolvedValue(mockDomain);
mockPrismaService.domain.findFirst.mockResolvedValue(anotherDomain);
await expect(
service.update(mockDomainId, mockWorkspaceId, mockUserId, updateDto)
).rejects.toThrow(ConflictException);
expect(prisma.domain.update).not.toHaveBeenCalled();
});
it("should allow updating to the same slug", async () => {
const updateDto = { slug: "work", name: "Updated Work" };
mockPrismaService.domain.findUnique.mockResolvedValue(mockDomain);
mockPrismaService.domain.findFirst.mockResolvedValue(mockDomain);
mockPrismaService.domain.update.mockResolvedValue({ ...mockDomain, ...updateDto });
mockActivityService.logDomainUpdated.mockResolvedValue({});
await service.update(mockDomainId, mockWorkspaceId, mockUserId, updateDto);
expect(prisma.domain.update).toHaveBeenCalled();
});
});
describe("remove", () => {
it("should delete a domain and log activity", async () => {
mockPrismaService.domain.findUnique.mockResolvedValue(mockDomain);
mockPrismaService.domain.delete.mockResolvedValue(mockDomain);
mockActivityService.logDomainDeleted.mockResolvedValue({});
await service.remove(mockDomainId, mockWorkspaceId, mockUserId);
expect(prisma.domain.delete).toHaveBeenCalledWith({
where: {
id: mockDomainId,
workspaceId: mockWorkspaceId,
},
});
expect(activityService.logDomainDeleted).toHaveBeenCalledWith(
mockWorkspaceId,
mockUserId,
mockDomainId,
{ name: mockDomain.name }
);
});
it("should throw NotFoundException if domain not found", async () => {
mockPrismaService.domain.findUnique.mockResolvedValue(null);
await expect(
service.remove(mockDomainId, mockWorkspaceId, mockUserId)
).rejects.toThrow(NotFoundException);
expect(prisma.domain.delete).not.toHaveBeenCalled();
});
});
});

View File

@@ -3,6 +3,7 @@ import { Test, TestingModule } from "@nestjs/testing";
import { EventsService } from "./events.service";
import { PrismaService } from "../prisma/prisma.service";
import { ActivityService } from "../activity/activity.service";
import { WebSocketGateway } from "../websocket/websocket.gateway";
import { NotFoundException } from "@nestjs/common";
import { Prisma } from "@prisma/client";
@@ -10,6 +11,7 @@ describe("EventsService", () => {
let service: EventsService;
let prisma: PrismaService;
let activityService: ActivityService;
let wsGateway: WebSocketGateway;
const mockPrismaService = {
event: {
@@ -28,6 +30,12 @@ describe("EventsService", () => {
logEventDeleted: vi.fn(),
};
const mockWebSocketGateway = {
emitEventCreated: vi.fn(),
emitEventUpdated: vi.fn(),
emitEventDeleted: vi.fn(),
};
const mockWorkspaceId = "550e8400-e29b-41d4-a716-446655440001";
const mockUserId = "550e8400-e29b-41d4-a716-446655440002";
const mockEventId = "550e8400-e29b-41d4-a716-446655440003";
@@ -61,12 +69,17 @@ describe("EventsService", () => {
provide: ActivityService,
useValue: mockActivityService,
},
{
provide: WebSocketGateway,
useValue: mockWebSocketGateway,
},
],
}).compile();
service = module.get<EventsService>(EventsService);
prisma = module.get<PrismaService>(PrismaService);
activityService = module.get<ActivityService>(ActivityService);
wsGateway = module.get<WebSocketGateway>(WebSocketGateway);
vi.clearAllMocks();
});

View File

@@ -3,6 +3,7 @@ import { Test, TestingModule } from "@nestjs/testing";
import { ProjectsService } from "./projects.service";
import { PrismaService } from "../prisma/prisma.service";
import { ActivityService } from "../activity/activity.service";
import { WebSocketGateway } from "../websocket/websocket.gateway";
import { ProjectStatus, Prisma } from "@prisma/client";
import { NotFoundException } from "@nestjs/common";
@@ -10,6 +11,7 @@ describe("ProjectsService", () => {
let service: ProjectsService;
let prisma: PrismaService;
let activityService: ActivityService;
let wsGateway: WebSocketGateway;
const mockPrismaService = {
project: {
@@ -28,6 +30,10 @@ describe("ProjectsService", () => {
logProjectDeleted: vi.fn(),
};
const mockWebSocketGateway = {
emitProjectUpdated: vi.fn(),
};
const mockWorkspaceId = "550e8400-e29b-41d4-a716-446655440001";
const mockUserId = "550e8400-e29b-41d4-a716-446655440002";
const mockProjectId = "550e8400-e29b-41d4-a716-446655440003";
@@ -59,12 +65,17 @@ describe("ProjectsService", () => {
provide: ActivityService,
useValue: mockActivityService,
},
{
provide: WebSocketGateway,
useValue: mockWebSocketGateway,
},
],
}).compile();
service = module.get<ProjectsService>(ProjectsService);
prisma = module.get<PrismaService>(PrismaService);
activityService = module.get<ActivityService>(ActivityService);
wsGateway = module.get<WebSocketGateway>(WebSocketGateway);
vi.clearAllMocks();
});

View File

@@ -0,0 +1,175 @@
import { Test, TestingModule } from '@nestjs/testing';
import { WebSocketGateway } from './websocket.gateway';
import { Server, Socket } from 'socket.io';
import { describe, it, expect, vi, beforeEach } from 'vitest';
interface AuthenticatedSocket extends Socket {
data: {
userId: string;
workspaceId: string;
};
}
describe('WebSocketGateway', () => {
let gateway: WebSocketGateway;
let mockServer: Server;
let mockClient: AuthenticatedSocket;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [WebSocketGateway],
}).compile();
gateway = module.get<WebSocketGateway>(WebSocketGateway);
// Mock Socket.IO server
mockServer = {
to: vi.fn().mockReturnThis(),
emit: vi.fn(),
} as unknown as Server;
// Mock authenticated client
mockClient = {
id: 'test-socket-id',
join: vi.fn(),
leave: vi.fn(),
emit: vi.fn(),
data: {
userId: 'user-123',
workspaceId: 'workspace-456',
},
handshake: {
auth: {
token: 'valid-token',
},
},
} as unknown as AuthenticatedSocket;
gateway.server = mockServer;
});
describe('handleConnection', () => {
it('should join client to workspace room on connection', async () => {
await gateway.handleConnection(mockClient);
expect(mockClient.join).toHaveBeenCalledWith('workspace:workspace-456');
});
it('should reject connection without authentication', async () => {
const unauthClient = {
...mockClient,
data: {},
disconnect: vi.fn(),
} as unknown as AuthenticatedSocket;
await gateway.handleConnection(unauthClient);
expect(unauthClient.disconnect).toHaveBeenCalled();
});
});
describe('handleDisconnect', () => {
it('should leave workspace room on disconnect', () => {
gateway.handleDisconnect(mockClient);
expect(mockClient.leave).toHaveBeenCalledWith('workspace:workspace-456');
});
});
describe('emitTaskCreated', () => {
it('should emit task:created event to workspace room', () => {
const task = {
id: 'task-1',
title: 'Test Task',
workspaceId: 'workspace-456',
};
gateway.emitTaskCreated('workspace-456', task);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('task:created', task);
});
});
describe('emitTaskUpdated', () => {
it('should emit task:updated event to workspace room', () => {
const task = {
id: 'task-1',
title: 'Updated Task',
workspaceId: 'workspace-456',
};
gateway.emitTaskUpdated('workspace-456', task);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('task:updated', task);
});
});
describe('emitTaskDeleted', () => {
it('should emit task:deleted event to workspace room', () => {
const taskId = 'task-1';
gateway.emitTaskDeleted('workspace-456', taskId);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('task:deleted', { id: taskId });
});
});
describe('emitEventCreated', () => {
it('should emit event:created event to workspace room', () => {
const event = {
id: 'event-1',
title: 'Test Event',
workspaceId: 'workspace-456',
};
gateway.emitEventCreated('workspace-456', event);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('event:created', event);
});
});
describe('emitEventUpdated', () => {
it('should emit event:updated event to workspace room', () => {
const event = {
id: 'event-1',
title: 'Updated Event',
workspaceId: 'workspace-456',
};
gateway.emitEventUpdated('workspace-456', event);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('event:updated', event);
});
});
describe('emitEventDeleted', () => {
it('should emit event:deleted event to workspace room', () => {
const eventId = 'event-1';
gateway.emitEventDeleted('workspace-456', eventId);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('event:deleted', { id: eventId });
});
});
describe('emitProjectUpdated', () => {
it('should emit project:updated event to workspace room', () => {
const project = {
id: 'project-1',
name: 'Updated Project',
workspaceId: 'workspace-456',
};
gateway.emitProjectUpdated('workspace-456', project);
expect(mockServer.to).toHaveBeenCalledWith('workspace:workspace-456');
expect(mockServer.emit).toHaveBeenCalledWith('project:updated', project);
});
});
});

View File

@@ -0,0 +1,153 @@
import {
WebSocketGateway as WSGateway,
WebSocketServer,
OnGatewayConnection,
OnGatewayDisconnect,
} from '@nestjs/websockets';
import { Logger } from '@nestjs/common';
import { Server, Socket } from 'socket.io';
interface AuthenticatedSocket extends Socket {
data: {
userId?: string;
workspaceId?: string;
};
}
interface Task {
id: string;
workspaceId: string;
[key: string]: unknown;
}
interface Event {
id: string;
workspaceId: string;
[key: string]: unknown;
}
interface Project {
id: string;
workspaceId: string;
[key: string]: unknown;
}
/**
* WebSocket Gateway for real-time updates
* Handles workspace-scoped rooms for broadcasting events
*/
@WSGateway({
cors: {
origin: process.env.WEB_URL || 'http://localhost:3000',
credentials: true,
},
})
export class WebSocketGateway implements OnGatewayConnection, OnGatewayDisconnect {
@WebSocketServer()
server!: Server;
private readonly logger = new Logger(WebSocketGateway.name);
/**
* Handle client connection
* Joins client to workspace-specific room
*/
async handleConnection(client: AuthenticatedSocket): Promise<void> {
const { userId, workspaceId } = client.data;
if (!userId || !workspaceId) {
this.logger.warn(`Client ${client.id} connected without authentication`);
client.disconnect();
return;
}
const room = this.getWorkspaceRoom(workspaceId);
await client.join(room);
this.logger.log(`Client ${client.id} joined room ${room}`);
}
/**
* Handle client disconnect
* Leaves workspace room
*/
handleDisconnect(client: AuthenticatedSocket): void {
const { workspaceId } = client.data;
if (workspaceId) {
const room = this.getWorkspaceRoom(workspaceId);
client.leave(room);
this.logger.log(`Client ${client.id} left room ${room}`);
}
}
/**
* Emit task:created event to workspace room
*/
emitTaskCreated(workspaceId: string, task: Task): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('task:created', task);
this.logger.debug(`Emitted task:created to ${room}`);
}
/**
* Emit task:updated event to workspace room
*/
emitTaskUpdated(workspaceId: string, task: Task): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('task:updated', task);
this.logger.debug(`Emitted task:updated to ${room}`);
}
/**
* Emit task:deleted event to workspace room
*/
emitTaskDeleted(workspaceId: string, taskId: string): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('task:deleted', { id: taskId });
this.logger.debug(`Emitted task:deleted to ${room}`);
}
/**
* Emit event:created event to workspace room
*/
emitEventCreated(workspaceId: string, event: Event): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('event:created', event);
this.logger.debug(`Emitted event:created to ${room}`);
}
/**
* Emit event:updated event to workspace room
*/
emitEventUpdated(workspaceId: string, event: Event): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('event:updated', event);
this.logger.debug(`Emitted event:updated to ${room}`);
}
/**
* Emit event:deleted event to workspace room
*/
emitEventDeleted(workspaceId: string, eventId: string): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('event:deleted', { id: eventId });
this.logger.debug(`Emitted event:deleted to ${room}`);
}
/**
* Emit project:updated event to workspace room
*/
emitProjectUpdated(workspaceId: string, project: Project): void {
const room = this.getWorkspaceRoom(workspaceId);
this.server.to(room).emit('project:updated', project);
this.logger.debug(`Emitted project:updated to ${room}`);
}
/**
* Get workspace room name
*/
private getWorkspaceRoom(workspaceId: string): string {
return `workspace:${workspaceId}`;
}
}

View File

@@ -0,0 +1,11 @@
import { Module } from '@nestjs/common';
import { WebSocketGateway } from './websocket.gateway';
/**
* WebSocket module for real-time updates
*/
@Module({
providers: [WebSocketGateway],
exports: [WebSocketGateway],
})
export class WebSocketModule {}