remove(api): unused heartbeat endpoints

Author: heiytor

api/routes/device.go

@@ -18,7 +18,6 @@ const (
 	DeleteDeviceURL             = "/devices/:uid"
 	RenameDeviceURL             = "/devices/:uid"
 	OfflineDeviceURL            = "/devices/:uid/offline"
-	HeartbeatDeviceURL          = "/devices/:uid/heartbeat"
 	LookupDeviceURL             = "/lookup"
 	UpdateDeviceStatusURL       = "/devices/:uid/:status"
 	CreateTagURL                = "/devices/:uid/tags"      // Add a tag to a device.
@@ -234,19 +233,6 @@ func (h *Handler) UpdateDeviceStatus(c gateway.Context) error {
 	return c.NoContent(http.StatusOK)
 }
 
-func (h *Handler) HeartbeatDevice(c gateway.Context) error {
-	var req requests.DeviceHeartbeat
-	if err := c.Bind(&req); err != nil {
-		return err
-	}
-
-	if err := c.Validate(&req); err != nil {
-		return err
-	}
-
-	return h.service.DeviceHeartbeat(c.Ctx(), models.UID(req.UID))
-}
-
 func (h *Handler) CreateDeviceTag(c gateway.Context) error {
 	var req requests.DeviceCreateTag
 	if err := c.Bind(&req); err != nil {

api/routes/device_test.go

@@ -549,57 +549,6 @@ func TestLookupDevice(t *testing.T) {
 	}
 }
 
-func TestHeartbeatDevice(t *testing.T) {
-	mock := new(mocks.Service)
-
-	cases := []struct {
-		title          string
-		uid            string
-		requiredMocks  func()
-		expectedStatus int
-	}{
-		{
-			title:          "fails when bind fails to validate uid",
-			uid:            "",
-			requiredMocks:  func() {},
-			expectedStatus: http.StatusBadRequest,
-		},
-		{
-			title: "fails when try to heartbeat non-existing device",
-			uid:   "1234",
-			requiredMocks: func() {
-				mock.On("DeviceHeartbeat", gomock.Anything, models.UID("1234")).Return(svc.ErrNotFound).Once()
-			},
-			expectedStatus: http.StatusNotFound,
-		},
-		{
-			title: "success when try to heartbeat of a existing device",
-			uid:   "123",
-			requiredMocks: func() {
-				mock.On("DeviceHeartbeat", gomock.Anything, models.UID("123")).Return(nil).Once()
-			},
-			expectedStatus: http.StatusOK,
-		},
-	}
-
-	for _, tc := range cases {
-		t.Run(tc.title, func(t *testing.T) {
-			tc.requiredMocks()
-
-			req := httptest.NewRequest(http.MethodPost, fmt.Sprintf("/internal/devices/%s/heartbeat", tc.uid), nil)
-			req.Header.Set("Content-Type", "application/json")
-			req.Header.Set("X-Role", guard.RoleOwner)
-			req.Header.Set("X-Tenant-ID", "tenant-id")
-			rec := httptest.NewRecorder()
-
-			e := NewRouter(mock)
-			e.ServeHTTP(rec, req)
-
-			assert.Equal(t, tc.expectedStatus, rec.Result().StatusCode)
-		})
-	}
-}
-
 func TestRemoveDeviceTag(t *testing.T) {
 	mock := new(mocks.Service)
 

api/routes/routes.go

@@ -32,7 +32,6 @@ func NewRouter(service services.Service) *echo.Echo {
 
 	internalAPI.GET(GetDeviceByPublicURLAddress, gateway.Handler(handler.GetDeviceByPublicURLAddress))
 	internalAPI.POST(OfflineDeviceURL, gateway.Handler(handler.OfflineDevice))
-	internalAPI.POST(HeartbeatDeviceURL, gateway.Handler(handler.HeartbeatDevice))
 	internalAPI.GET(LookupDeviceURL, gateway.Handler(handler.LookupDevice))
 
 	internalAPI.PATCH(SetSessionAuthenticatedURL, gateway.Handler(handler.SetSessionAuthenticated))

api/services/device.go

@@ -26,7 +26,6 @@ type DeviceService interface {
 	LookupDevice(ctx context.Context, namespace, name string) (*models.Device, error)
 	OffineDevice(ctx context.Context, uid models.UID, online bool) error
 	UpdateDeviceStatus(ctx context.Context, tenant string, uid models.UID, status models.DeviceStatus) error
-	DeviceHeartbeat(ctx context.Context, uid models.UID) error
 	UpdateDevice(ctx context.Context, tenant string, uid models.UID, name *string, publicURL *bool) error
 }
 
@@ -296,14 +295,6 @@ func (s *service) UpdateDeviceStatus(ctx context.Context, tenant string, uid mod
 	return s.store.DeviceUpdateStatus(ctx, uid, status)
 }
 
-func (s *service) DeviceHeartbeat(ctx context.Context, uid models.UID) error {
-	if err := s.store.DeviceSetOnline(ctx, uid, clock.Now(), true); err != nil {
-		return NewErrDeviceNotFound(uid, err)
-	}
-
-	return nil
-}
-
 func (s *service) UpdateDevice(ctx context.Context, tenant string, uid models.UID, name *string, publicURL *bool) error {
 	device, err := s.store.DeviceGetByUID(ctx, uid, tenant)
 	if err != nil {

api/services/device_test.go

@@ -3214,24 +3214,6 @@ func TestUpdateDeviceStatus_cloud_subscription_inactive(t *testing.T) {
 	mock.AssertExpectations(t)
 }
 
-func TestDeviceHeartbeat(t *testing.T) {
-	mock := new(mocks.Store)
-
-	ctx := context.TODO()
-
-	uid := models.UID("uid")
-
-	clockMock.On("Now").Return(now).Once()
-
-	mock.On("DeviceSetOnline", ctx, uid, now, true).Return(nil).Once()
-
-	service := NewService(store.Store(mock), privateKey, publicKey, storecache.NewNullCache(), clientMock, nil)
-	err := service.DeviceHeartbeat(ctx, uid)
-	assert.NoError(t, err)
-
-	mock.AssertExpectations(t)
-}
-
 func TestDeviceUpdate(t *testing.T) {
 	mock := new(mocks.Store)
 	service := NewService(store.Store(mock), privateKey, publicKey, storecache.NewNullCache(), clientMock, nil)