fix: event log fetch uses pagination

go.mod

@@ -16,7 +16,7 @@ require (
 	github.com/gorilla/websocket v1.5.3
 	github.com/ilyakaznacheev/cleanenv v1.5.0
 	github.com/jackc/pgx/v5 v5.7.2
-	github.com/open-amt-cloud-toolkit/go-wsman-messages/v2 v2.17.0
+	github.com/open-amt-cloud-toolkit/go-wsman-messages/v2 v2.17.1
 	github.com/prometheus/client_golang v1.20.5
 	github.com/rs/zerolog v1.33.0
 	github.com/stretchr/testify v1.10.0

go.sum

@@ -173,6 +173,8 @@ github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJm
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/open-amt-cloud-toolkit/go-wsman-messages/v2 v2.17.0 h1:2iDhRp5Td6aeCNjCPg6tJrtn2pcdjOhrXv/JV7CwfTM=
 github.com/open-amt-cloud-toolkit/go-wsman-messages/v2 v2.17.0/go.mod h1:ZFZRyYEYWs2ngCuwzK+n+vc0ga1Hh4BRJYBiwXxDTD0=
+github.com/open-amt-cloud-toolkit/go-wsman-messages/v2 v2.17.1 h1:KRBPfhr7X1I1B8Y+5a4jaiWLf72rpHBeRWfZHBN5BHI=
+github.com/open-amt-cloud-toolkit/go-wsman-messages/v2 v2.17.1/go.mod h1:ezWfnNZ2up9X90aNy3B/5YpxCacyPB9dFANJc8UBuok=
 github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U=
 github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
 github.com/opencontainers/image-spec v1.1.0 h1:8SG7/vwALn54lVB/0yZ/MMwhFrPYtpEHQb2IpWsCzug=

internal/controller/http/v1/devicemanagement.go

@@ -390,7 +390,15 @@
 func (r *deviceManagementRoutes) getEventLog(c *gin.Context) {
 	guid := c.Param("guid")
 
-	eventLogs, err := r.d.GetEventLog(c.Request.Context(), guid)
+	var odata OData
+	if err := c.ShouldBindQuery(&odata); err != nil {
+		validationErr := ErrValidationProfile.Wrap("get", "ShouldBindQuery", err)
+		ErrorResponse(c, validationErr)
+
+		return
+	}
+
+	eventLogs, err := r.d.GetEventLog(c.Request.Context(), odata.Skip, odata.Top, guid)
 	if err != nil {
 		r.l.Error(err, "http - v1 - getEventLog")
 		ErrorResponse(c, err)
@@ -404,16 +412,34 @@
 func (r *deviceManagementRoutes) downloadEventLog(c *gin.Context) {
 	guid := c.Param("guid")
 
-	eventLogs, err := r.d.GetEventLog(c.Request.Context(), guid)
-	if err != nil {
-		r.l.Error(err, "http - v1 - getEventLog")
-		ErrorResponse(c, err)
+	var allEventLogs []dto.EventLog
 
-		return
+	startIndex := 0
+
+	// Keep fetching logs until NoMoreRecords is true
+	for {
+		eventLogs, err := r.d.GetEventLog(c.Request.Context(), 0, 0, guid)
+		if err != nil {
+			r.l.Error(err, "http - v1 - getEventLog")
+			ErrorResponse(c, err)
+
+			return
+		}
+
+		// Append the current batch of logs
+		allEventLogs = append(allEventLogs, eventLogs.EventLogs...)
+
+		// Break if no more records
+		if eventLogs.NoMoreRecords {
+			break
+		}
+
+		// Update the startIndex for the next batch
+		startIndex += len(eventLogs.EventLogs)
 	}
 
 	// Convert logs to CSV
-	csvReader, err := r.e.ExportEventLogsCSV(eventLogs)
+	csvReader, err := r.e.ExportEventLogsCSV(allEventLogs)
 	if err != nil {
 		r.l.Error(err, "http - v1 - downloadEventLog")
 		ErrorResponse(c, err)

internal/controller/http/v1/devicemanagement_test.go

@@ -169,14 +169,14 @@ func TestDeviceManagement(t *testing.T) {
 		},
 		{
 			name:   "getEventLog - successful retrieval",
-			url:    "/api/v1/amt/log/event/valid-guid",
+			url:    "/api/v1/amt/log/event/valid-guid?$skip=1&$top=10",
 			method: http.MethodGet,
 			mock: func(m *mocks.MockDeviceManagementFeature) {
-				m.EXPECT().GetEventLog(context.Background(), "valid-guid").
-					Return([]dto.EventLog{}, nil)
+				m.EXPECT().GetEventLog(context.Background(), 1, 10, "valid-guid").
+					Return(dto.EventLogs{}, nil)
 			},
 			expectedCode: http.StatusOK,
-			response:     []dto.EventLog{},
+			response:     dto.EventLogs{},
 		},
 		{
 			name:   "setBootOptions - successful setting",

internal/controller/ws/v1/interface.go

@@ -52,7 +52,7 @@ type Feature interface {
 	SendPowerAction(ctx context.Context, guid string, action int) (power.PowerActionResponse, error)
 	SetBootOptions(ctx context.Context, guid string, bootSetting dto.BootSetting) (power.PowerActionResponse, error)
 	GetAuditLog(ctx context.Context, startIndex int, guid string) (dto.AuditLog, error)
-	GetEventLog(ctx context.Context, guid string) ([]dto.EventLog, error)
+	GetEventLog(ctx context.Context, startIndex, maxReadRecords int, guid string) (dto.EventLogs, error)
 	Redirect(ctx context.Context, conn *websocket.Conn, guid, mode string) error
 	GetNetworkSettings(c context.Context, guid string) (dto.NetworkSettings, error)
 	GetCertificates(c context.Context, guid string) (dto.SecuritySettings, error)

internal/entity/dto/v1/eventlog.go

@@ -1,5 +1,11 @@
 package dto
 
+// EventLog defines the structure of an event log.
+type EventLogs struct {
+	EventLogs     []EventLog `json:"EventLogs"`
+	NoMoreRecords bool       `json:"NoMoreRecords"`
+}
+
 type EventLog struct {
 	DeviceAddress   int    `json:"DeviceAddress"`
 	EventSensorType int    `json:"EventSensorType"`

internal/usecase/amtexplorer/explorer_test.go

@@ -657,7 +657,7 @@ func TestExecuteCall(t *testing.T) {
 			call: "AMTMessageLog",
 			repoMock: func(repo *mocks.MockDeviceManagementRepository) {
 				repo.EXPECT().
-					GetByID(gomock.Any(), device.GUID, device.TenantID).
+					GetByID(context.Background(), device.GUID, device.TenantID).
 					Return(device, nil)
 			},
 			amtMock: func(amt *mocks.MockAMTExplorer, man *mocks.MockAMTExplorerWSMAN) {
@@ -666,7 +666,10 @@ func TestExecuteCall(t *testing.T) {
 					Return(amt)
 				amt.EXPECT().
 					GetAMTMessageLog().
-					Return(messagelog.Response{Message: &client.Message{XMLInput: executeResponse.XMLInput, XMLOutput: executeResponse.XMLOutput}}, nil)
+					Return(messagelog.Response{Message: &client.Message{
+						XMLInput:  executeResponse.XMLInput,
+						XMLOutput: executeResponse.XMLOutput,
+					}}, nil)
 			},
 			res: executeResponse,
 			err: nil,
@@ -676,7 +679,7 @@ func TestExecuteCall(t *testing.T) {
 			call: "AMTMessageLog",
 			repoMock: func(repo *mocks.MockDeviceManagementRepository) {
 				repo.EXPECT().
-					GetByID(gomock.Any(), device.GUID, device.TenantID).
+					GetByID(context.Background(), device.GUID, device.TenantID).
 					Return(device, nil)
 			},
 			amtMock: func(amt *mocks.MockAMTExplorer, man *mocks.MockAMTExplorerWSMAN) {

internal/usecase/devices/info.go

@@ -123,48 +123,55 @@
 	return auditLogResponse, nil
 }
 
-func (uc *UseCase) GetEventLog(c context.Context, guid string) ([]dto.EventLog, error) {
+func (uc *UseCase) GetEventLog(c context.Context, startIndex, maxReadRecords int, guid string) (dto.EventLogs, error) {
 	item, err := uc.repo.GetByID(c, guid, "")
 	if err != nil {
-		return nil, err
+		return dto.EventLogs{}, err
 	}
 
 	if item == nil || item.GUID == "" {
-		return nil, ErrNotFound
+		return dto.EventLogs{}, ErrNotFound
 	}
 
 	device := uc.device.SetupWsmanClient(*item, false, true)
 
-	eventLogs, err := device.GetEventLog()
+	eventLogs, err := device.GetEventLog(startIndex, maxReadRecords)
 	if err != nil {
-		return nil, err
+		return dto.EventLogs{}, err
 	}
 
-	events := make([]dto.EventLog, len(eventLogs.RefinedEventData))
-
-	for idx := range eventLogs.RefinedEventData {
-		event := &eventLogs.RefinedEventData[idx]
-		dtoEvent := dto.EventLog{
-			// DeviceAddress:   event.DeviceAddress,
-			// EventSensorType: event.EventSensorType,
-			// EventType:       event.EventType,
-			// EventOffset:     event.EventOffset,
-			// EventSourceType: event.EventSourceType,
-			EventSeverity: event.EventSeverity,
-			// SensorNumber:    event.SensorNumber,
-			Entity: event.Entity,
-			// EntityInstance:  event.EntityInstance,
-			// EventData:       event.EventData,
-			Time: event.TimeStamp.String(),
-			// EntityStr:       event.EntityStr,
-			Description: event.Description,
-			// EventTypeDesc:   event.EventTypeDesc,
+	// Initialize with nil if no records
+	var events []dto.EventLog
+	if len(eventLogs.RefinedEventData) > 0 {
+		events = make([]dto.EventLog, len(eventLogs.RefinedEventData))
+
+		for idx := range eventLogs.RefinedEventData {
+			event := &eventLogs.RefinedEventData[idx]
+			dtoEvent := dto.EventLog{
+				// DeviceAddress:   event.DeviceAddress,
+				// EventSensorType: event.EventSensorType,
+				// EventType:       event.EventType,
+				// EventOffset:     event.EventOffset,
+				// EventSourceType: event.EventSourceType,
+				EventSeverity: event.EventSeverity,
+				// SensorNumber:    event.SensorNumber,
+				Entity: event.Entity,
+				// EntityInstance:  event.EntityInstance,
+				// EventData:       event.EventData,
+				Time: event.TimeStamp.String(),
+				// EntityStr:       event.EntityStr,
+				Description: event.Description,
+				// EventTypeDesc:   event.EventTypeDesc,
+			}
+
+			events[idx] = dtoEvent
 		}
-
-		events[idx] = dtoEvent
 	}
 
-	return events, nil
+	return dto.EventLogs{
+		EventLogs:     events,
+		NoMoreRecords: eventLogs.NoMoreRecords,
+	}, nil
 }
 
 func (uc *UseCase) GetGeneralSettings(c context.Context, guid string) (interface{}, error) {

internal/usecase/devices/info_test.go

@@ -433,15 +433,15 @@ func TestGetEventLog(t *testing.T) {
 					SetupWsmanClient(gomock.Any(), false, true).
 					Return(man2)
 				man2.EXPECT().
-					GetEventLog().
+					GetEventLog(1, 10).
 					Return(messagelog.GetRecordsResponse{}, nil)
 			},
 			repoMock: func(repo *mocks.MockDeviceManagementRepository) {
 				repo.EXPECT().
 					GetByID(context.Background(), device.GUID, "").
 					Return(device, nil)
 			},
-			res: []dto.EventLog{},
+			res: dto.EventLogs{},
 			err: nil,
 		},
 		{
@@ -453,7 +453,7 @@ func TestGetEventLog(t *testing.T) {
 					GetByID(context.Background(), device.GUID, "").
 					Return(nil, ErrGeneral)
 			},
-			res: []dto.EventLog(nil),
+			res: dto.EventLogs{},
 			err: devices.ErrGeneral,
 		},
 		{
@@ -464,15 +464,15 @@ func TestGetEventLog(t *testing.T) {
 					SetupWsmanClient(gomock.Any(), false, true).
 					Return(man2)
 				man2.EXPECT().
-					GetEventLog().
+					GetEventLog(1, 10).
 					Return(messagelog.GetRecordsResponse{}, ErrGeneral)
 			},
 			repoMock: func(repo *mocks.MockDeviceManagementRepository) {
 				repo.EXPECT().
 					GetByID(context.Background(), device.GUID, "").
 					Return(device, nil)
 			},
-			res: []dto.EventLog(nil),
+			res: dto.EventLogs{},
 			err: ErrGeneral,
 		},
 	}
@@ -489,7 +489,7 @@ func TestGetEventLog(t *testing.T) {
 
 			tc.repoMock(repo)
 
-			res, err := useCase.GetEventLog(context.Background(), device.GUID)
+			res, err := useCase.GetEventLog(context.Background(), 1, 10, device.GUID)
 
 			require.Equal(t, tc.res, res)
 			require.IsType(t, tc.err, err)

internal/usecase/devices/interfaces.go

@@ -72,7 +72,7 @@ type (
 		SendPowerAction(ctx context.Context, guid string, action int) (power.PowerActionResponse, error)
 		SetBootOptions(ctx context.Context, guid string, bootSetting dto.BootSetting) (power.PowerActionResponse, error)
 		GetAuditLog(ctx context.Context, startIndex int, guid string) (dto.AuditLog, error)
-		GetEventLog(ctx context.Context, guid string) ([]dto.EventLog, error)
+		GetEventLog(ctx context.Context, startIndex, maxReadRecords int, guid string) (dto.EventLogs, error)
 		Redirect(ctx context.Context, conn *websocket.Conn, guid, mode string) error
 		GetNetworkSettings(c context.Context, guid string) (dto.NetworkSettings, error)
 		GetCertificates(c context.Context, guid string) (dto.SecuritySettings, error)

internal/usecase/devices/wsman/interfaces.go

@@ -50,7 +50,7 @@ type Management interface {
 	SetBootConfigRole(role int) (interface{}, error)
 	ChangeBootOrder(bootSource string) (cimBoot.ChangeBootOrder_OUTPUT, error)
 	GetAuditLog(startIndex int) (auditlog.Response, error)
-	GetEventLog() (messagelog.GetRecordsResponse, error)
+	GetEventLog(startIndex, maxReadRecords int) (messagelog.GetRecordsResponse, error)
 	GetNetworkSettings() (NetworkResults, error)
 	GetCertificates() (Certificates, error)
 	GetTLSSettingData() ([]tls.SettingDataResponse, error)