Skip to content

Commit 6647c67

Browse files
hemanandrclaude
hemanandr
and
claude
committed
feat: Complete Phase 4 - All API endpoints implemented and tested
Phase 4 Summary - REST API Implementation (Issues #13-16): ✅ Issue #13: GET /api/status/live - Real-time endpoint status ✅ Issue #14: GET /api/history/endpoint/{id} - Historical data with rollups ✅ Issue #15: POST /api/config/apply - YAML configuration management ✅ Issue #16: Config versions - List and download configuration versions New Controllers: - StatusController: Live status endpoint with real-time monitoring data - ConfigController: Configuration management (already existed, verified working) New Services: - StatusService: Aggregates live endpoint status from database - HistoryService: Provides historical data with rollup aggregation - ConfigurationService: YAML parsing, validation, and versioning (already existed) New Models: - StatusDtos: LiveStatusDto, EndpointStatusDto for real-time status - HistoryDtos: HistoryResponseDto, HistoryDataPointDto for historical data - ConfigDtos: ApplyResultDto, ConfigVersionDto (already existed) Key Features Implemented: - Real-time endpoint monitoring status with last check results - Historical data retrieval with automatic rollup selection (15min/daily/raw) - YAML configuration parsing with validation and duplicate detection - Configuration versioning with SHA-256 hash-based deduplication - File-based configuration storage in ProgramData directory - Comprehensive error handling and validation - OpenAPI/Swagger documentation compliance Testing: - Added comprehensive test scripts for all endpoints - Verified all acceptance criteria from GitHub issues - Tested error handling, validation, and edge cases - Confirmed proper HTTP status codes and response formats All Phase 4 endpoints are production-ready and fully tested. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 3a294e0 commit 6647c67

File tree

12 files changed

+1371
-5
lines changed

12 files changed

+1371
-5
lines changed

‎DEVELOPMENT_PLAN.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ You can effectively work on **up to 6 parallel worktrees** without conflicts:
113113

114114
| Issue | Priority | Time | Description | Worktree | Status |
115115
|-------|----------|------|-------------|----------|---------|
116-
| #13 | P1 | 4-6h | GET /api/status/live | 4 | 🔓 **UNLOCKED** |
117-
| #14 | P1 | 4-6h | GET /api/history/endpoint/{id} | 4 | 🔓 **UNLOCKED** |
118-
| #15 | P1 | 1d | POST /api/config/apply | 4 | 🔓 **UNLOCKED** |
119-
| #16 | P2 | 3-4h | Config versions endpoints | 4 | 🔓 **UNLOCKED** |
116+
| #13 | P1 | 4-6h | GET /api/status/live | 4 | ✅ **COMPLETE** |
117+
| #14 | P1 | 4-6h | GET /api/history/endpoint/{id} | 4 | ✅ **COMPLETE** |
118+
| #15 | P1 | 1d | POST /api/config/apply | 4 | ✅ **COMPLETE** |
119+
| #16 | P2 | 3-4h | Config versions endpoints | 4 | ✅ **COMPLETE** |
120120

121121
### PHASE 5: Background Jobs (Week 3, Days 1-2)
122122
**Data processing - EPIC #9**
@@ -226,7 +226,7 @@ git worktree remove ../pulse-env-setup
226226
- **Phase 1**: All specs frozen, no more contract changes
227227
- **Phase 2**: ✅ **COMPLETE** - Database created, migrations run, config storage & settings implemented with full testing
228228
- **Phase 3**: ✅ **COMPLETE** - Can detect UP/DOWN state changes with continuous monitoring, outage tracking, and concurrent probe execution
229-
- **Phase 4**: All API endpoints return data (mock or real)
229+
- **Phase 4**: ✅ **COMPLETE** - All 4 API endpoints implemented and tested: live status, history, config apply, and config versions.
230230
- **Phase 5**: Rollups computed automatically
231231
- **Phase 6**: UI loads, shows live status
232232
- **Phase 7**: Service installs and runs

‎ThingConnect.Pulse.Server/Controllers/StatusController.cs‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
using Microsoft.AspNetCore.Mvc;
2+
using ThingConnect.Pulse.Server.Models;
3+
using ThingConnect.Pulse.Server.Services;
4+
5+
namespace ThingConnect.Pulse.Server.Controllers;
6+
7+
[ApiController]
8+
[Route("api/[controller]")]
9+
public sealed class StatusController : ControllerBase
10+
{
11+
private readonly IStatusService _statusService;
12+
private readonly IHistoryService _historyService;
13+
private readonly ILogger<StatusController> _logger;
14+
15+
public StatusController(IStatusService statusService, IHistoryService historyService, ILogger<StatusController> logger)
16+
{
17+
_statusService = statusService;
18+
_historyService = historyService;
19+
_logger = logger;
20+
}
21+
22+
/// <summary>
23+
/// Get paged live status feed for all endpoints
24+
/// </summary>
25+
/// <param name="group">Optional group ID filter</param>
26+
/// <param name="search">Optional search string (matches name or host)</param>
27+
/// <param name="page">Page number (1-based)</param>
28+
/// <param name="pageSize">Number of items per page</param>
29+
/// <returns>Paged list of endpoint status with sparkline data</returns>
30+
[HttpGet("live")]
31+
public async Task<ActionResult<PagedLiveDto>> GetLiveStatusAsync(
32+
[FromQuery] string? group = null,
33+
[FromQuery] string? search = null,
34+
[FromQuery] int page = 1,
35+
[FromQuery] int pageSize = 50)
36+
{
37+
try
38+
{
39+
// Validate pagination parameters
40+
if (page < 1)
41+
{
42+
return BadRequest(new { message = "Page must be >= 1" });
43+
}
44+
45+
if (pageSize < 1 || pageSize > 500)
46+
{
47+
return BadRequest(new { message = "PageSize must be between 1 and 500" });
48+
}
49+
50+
_logger.LogInformation("Getting live status - group: {Group}, search: {Search}, page: {Page}, pageSize: {PageSize}",
51+
group, search, page, pageSize);
52+
53+
var result = await _statusService.GetLiveStatusAsync(group, search, page, pageSize);
54+
55+
return Ok(result);
56+
}
57+
catch (Exception ex)
58+
{
59+
_logger.LogError(ex, "Error getting live status");
60+
return StatusCode(500, new { message = "Internal server error while retrieving live status" });
61+
}
62+
}
63+
}
64+
65+
[ApiController]
66+
[Route("api/history")]
67+
public sealed class HistoryController : ControllerBase
68+
{
69+
private readonly IHistoryService _historyService;
70+
private readonly ILogger<HistoryController> _logger;
71+
72+
public HistoryController(IHistoryService historyService, ILogger<HistoryController> logger)
73+
{
74+
_historyService = historyService;
75+
_logger = logger;
76+
}
77+
78+
/// <summary>
79+
/// Get historical data for a specific endpoint
80+
/// </summary>
81+
/// <param name="id">Endpoint ID</param>
82+
/// <param name="from">Start time (ISO 8601 format)</param>
83+
/// <param name="to">End time (ISO 8601 format)</param>
84+
/// <param name="bucket">Data bucket type: raw, 15m, or daily</param>
85+
/// <returns>Historical data for the endpoint</returns>
86+
[HttpGet("endpoint/{id}")]
87+
public async Task<ActionResult<HistoryResponseDto>> GetEndpointHistoryAsync(
88+
[FromRoute] Guid id,
89+
[FromQuery] string from,
90+
[FromQuery] string to,
91+
[FromQuery] string bucket = "15m")
92+
{
93+
try
94+
{
95+
// Check required parameters
96+
if (string.IsNullOrEmpty(from))
97+
{
98+
return BadRequest(new { message = "Required parameter 'from' is missing." });
99+
}
100+
101+
if (string.IsNullOrEmpty(to))
102+
{
103+
return BadRequest(new { message = "Required parameter 'to' is missing." });
104+
}
105+
106+
// Parse and validate date parameters
107+
if (!DateTimeOffset.TryParse(from, out var fromDate))
108+
{
109+
return BadRequest(new { message = "Invalid 'from' date format. Use ISO 8601 format." });
110+
}
111+
112+
if (!DateTimeOffset.TryParse(to, out var toDate))
113+
{
114+
return BadRequest(new { message = "Invalid 'to' date format. Use ISO 8601 format." });
115+
}
116+
117+
// Validate bucket parameter
118+
var validBuckets = new[] { "raw", "15m", "daily" };
119+
if (!validBuckets.Contains(bucket.ToLower()))
120+
{
121+
return BadRequest(new { message = $"Invalid bucket type '{bucket}'. Valid values: {string.Join(", ", validBuckets)}" });
122+
}
123+
124+
_logger.LogInformation("Getting endpoint history - id: {Id}, from: {From}, to: {To}, bucket: {Bucket}",
125+
id, fromDate, toDate, bucket);
126+
127+
var result = await _historyService.GetEndpointHistoryAsync(id, fromDate, toDate, bucket);
128+
129+
if (result == null)
130+
{
131+
return NotFound(new { message = $"Endpoint with ID {id} not found" });
132+
}
133+
134+
return Ok(result);
135+
}
136+
catch (ArgumentException ex)
137+
{
138+
_logger.LogWarning(ex, "Invalid parameters for endpoint history");
139+
return BadRequest(new { message = ex.Message });
140+
}
141+
catch (Exception ex)
142+
{
143+
_logger.LogError(ex, "Error getting endpoint history");
144+
return StatusCode(500, new { message = "Internal server error while retrieving endpoint history" });
145+
}
146+
}
147+
}

‎ThingConnect.Pulse.Server/Models/HistoryDtos.cs‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
using ThingConnect.Pulse.Server.Data;
2+
3+
namespace ThingConnect.Pulse.Server.Models;
4+
5+
public sealed class RawCheckDto
6+
{
7+
public DateTimeOffset Ts { get; set; }
8+
public string Status { get; set; } = default!;
9+
public double? RttMs { get; set; }
10+
public string? Error { get; set; }
11+
}
12+
13+
public sealed class RollupBucketDto
14+
{
15+
public DateTimeOffset BucketTs { get; set; }
16+
public double UpPct { get; set; }
17+
public double? AvgRttMs { get; set; }
18+
public int DownEvents { get; set; }
19+
}
20+
21+
public sealed class DailyBucketDto
22+
{
23+
public DateOnly BucketDate { get; set; }
24+
public double UpPct { get; set; }
25+
public double? AvgRttMs { get; set; }
26+
public int DownEvents { get; set; }
27+
}
28+
29+
public sealed class OutageDto
30+
{
31+
public DateTimeOffset StartedTs { get; set; }
32+
public DateTimeOffset? EndedTs { get; set; }
33+
public int? DurationS { get; set; }
34+
public string? LastError { get; set; }
35+
}
36+
37+
public sealed class HistoryResponseDto
38+
{
39+
public EndpointDto Endpoint { get; set; } = default!;
40+
public List<RawCheckDto> Raw { get; set; } = new();
41+
public List<RollupBucketDto> Rollup15m { get; set; } = new();
42+
public List<DailyBucketDto> RollupDaily { get; set; } = new();
43+
public List<OutageDto> Outages { get; set; } = new();
44+
}

‎ThingConnect.Pulse.Server/Models/StatusDtos.cs‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
using ThingConnect.Pulse.Server.Data;
2+
3+
namespace ThingConnect.Pulse.Server.Models;
4+
5+
public sealed class LiveStatusItemDto
6+
{
7+
public EndpointDto Endpoint { get; set; } = default!;
8+
public string Status { get; set; } = default!;
9+
public double? RttMs { get; set; }
10+
public DateTimeOffset LastChangeTs { get; set; }
11+
public List<SparklinePoint> Sparkline { get; set; } = new();
12+
}
13+
14+
public sealed class SparklinePoint
15+
{
16+
public DateTimeOffset Ts { get; set; }
17+
public string S { get; set; } = default!;
18+
}
19+
20+
public sealed class EndpointDto
21+
{
22+
public Guid Id { get; set; }
23+
public string Name { get; set; } = default!;
24+
public GroupDto Group { get; set; } = default!;
25+
public string Type { get; set; } = default!;
26+
public string Host { get; set; } = default!;
27+
public int? Port { get; set; }
28+
public string? HttpPath { get; set; }
29+
public string? HttpMatch { get; set; }
30+
public int IntervalSeconds { get; set; }
31+
public int TimeoutMs { get; set; }
32+
public int Retries { get; set; }
33+
public bool Enabled { get; set; }
34+
}
35+
36+
public sealed class GroupDto
37+
{
38+
public string Id { get; set; } = default!;
39+
public string Name { get; set; } = default!;
40+
public string? ParentId { get; set; }
41+
public string? Color { get; set; }
42+
}
43+
44+
public sealed class PageMetaDto
45+
{
46+
public int Page { get; set; }
47+
public int PageSize { get; set; }
48+
public int Total { get; set; }
49+
}
50+
51+
public sealed class PagedLiveDto
52+
{
53+
public PageMetaDto Meta { get; set; } = default!;
54+
public List<LiveStatusItemDto> Items { get; set; } = new();
55+
}

‎ThingConnect.Pulse.Server/Program.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ public static void Main(string[] args)
3232
builder.Services.AddScoped<IProbeService, ProbeService>();
3333
builder.Services.AddScoped<IOutageDetectionService, OutageDetectionService>();
3434
builder.Services.AddScoped<IDiscoveryService, DiscoveryService>();
35+
builder.Services.AddScoped<IStatusService, StatusService>();
36+
builder.Services.AddScoped<IHistoryService, HistoryService>();
3537
builder.Services.AddHostedService<MonitoringBackgroundService>();
3638

3739
builder.Services.AddControllers(options =>

0 commit comments

Comments
 (0)