From cee81cae7577d7d53856479b7d36de34ef8c6bf4 Mon Sep 17 00:00:00 2001
From: Injun Song <ijsong@gmail.com>
Date: Mon, 2 Dec 2024 01:13:15 +0900
Subject: [PATCH] refactor: Remove unnecessary code from
 proto/varlogpb/log_entry.go

- replaced InvalidLogEntry with an empty LogEntry across the codebase
- removed proto/varlogpb/log_entry.go as it contained unused code
- updated related files to reflect these changes
---
 internal/storagenode/client/log_client.go |  2 +-
 pkg/varlog/subscribe.go                   |  4 ++--
 pkg/varlogtest/admin.go                   |  7 +++----
 pkg/varlogtest/log.go                     |  7 +++----
 proto/varlogpb/log_entry.go               | 13 -------------
 5 files changed, 9 insertions(+), 24 deletions(-)
 delete mode 100644 proto/varlogpb/log_entry.go

diff --git a/internal/storagenode/client/log_client.go b/internal/storagenode/client/log_client.go
index 730b7d5ec..8c2a3123a 100644
--- a/internal/storagenode/client/log_client.go
+++ b/internal/storagenode/client/log_client.go
@@ -18,7 +18,7 @@ type SubscribeResult struct {
 }
 
 var InvalidSubscribeResult = SubscribeResult{
-	LogEntry: varlogpb.InvalidLogEntry(),
+	LogEntry: varlogpb.LogEntry{},
 	Error:    errors.New("invalid subscribe result"),
 }
 
diff --git a/pkg/varlog/subscribe.go b/pkg/varlog/subscribe.go
index 533981018..481ef784e 100644
--- a/pkg/varlog/subscribe.go
+++ b/pkg/varlog/subscribe.go
@@ -518,7 +518,7 @@ func (p *dispatcher) dispatch(_ context.Context) {
 		sentErr = sentErr || res.Error != nil
 	}
 	if !sentErr {
-		p.onNextFunc(varlogpb.InvalidLogEntry(), io.EOF)
+		p.onNextFunc(varlogpb.LogEntry{}, io.EOF)
 	}
 }
 
@@ -532,7 +532,7 @@ type invalidSubscriber struct {
 }
 
 func (s invalidSubscriber) Next() (varlogpb.LogEntry, error) {
-	return varlogpb.InvalidLogEntry(), s.err
+	return varlogpb.LogEntry{}, s.err
 }
 
 func (s invalidSubscriber) Close() error {
diff --git a/pkg/varlogtest/admin.go b/pkg/varlogtest/admin.go
index 04d55d5ff..33bdb7883 100644
--- a/pkg/varlogtest/admin.go
+++ b/pkg/varlogtest/admin.go
@@ -82,6 +82,7 @@ func (c *testAdmin) ListStorageNodes(ctx context.Context, opts ...varlog.AdminCa
 
 	return ret, nil
 }
+
 func (c *testAdmin) GetStorageNodes(ctx context.Context, opts ...varlog.AdminCallOption) (map[types.StorageNodeID]admpb.StorageNodeMetadata, error) {
 	snms, err := c.ListStorageNodes(ctx)
 	if err != nil {
@@ -182,8 +183,7 @@ func (c *testAdmin) AddTopic(ctx context.Context, opts ...varlog.AdminCallOption
 	c.vt.topics[topicID] = topicDesc
 	c.vt.trimGLSNs[topicID] = types.InvalidGLSN
 
-	invalidLogEntry := varlogpb.InvalidLogEntry()
-	c.vt.globalLogEntries[topicID] = []*varlogpb.LogEntry{&invalidLogEntry}
+	c.vt.globalLogEntries[topicID] = []*varlogpb.LogEntry{{}}
 
 	return proto.Clone(&topicDesc).(*varlogpb.TopicDescriptor), nil
 }
@@ -294,8 +294,7 @@ func (c *testAdmin) AddLogStream(_ context.Context, topicID types.TopicID, logSt
 
 	c.vt.logStreams[logStreamID] = lsd
 
-	invalidLogEntry := varlogpb.InvalidLogEntry()
-	c.vt.localLogEntries[logStreamID] = []*varlogpb.LogEntry{&invalidLogEntry}
+	c.vt.localLogEntries[logStreamID] = []*varlogpb.LogEntry{{}}
 
 	topicDesc.LogStreams = append(topicDesc.LogStreams, logStreamID)
 	c.vt.topics[topicID] = topicDesc
diff --git a/pkg/varlogtest/log.go b/pkg/varlogtest/log.go
index f7cc50b0f..2e6810c2f 100644
--- a/pkg/varlogtest/log.go
+++ b/pkg/varlogtest/log.go
@@ -215,7 +215,7 @@ func (c *testLog) Subscribe(ctx context.Context, topicID types.TopicID, begin ty
 		for _, logEntry := range copiedLogEntries {
 			onNextFunc(logEntry, nil)
 		}
-		onNextFunc(varlogpb.InvalidLogEntry(), io.EOF)
+		onNextFunc(varlogpb.LogEntry{}, io.EOF)
 	}()
 
 	return func() {
@@ -319,7 +319,6 @@ func (c *testLog) PeekLogStream(ctx context.Context, tpid types.TopicID, lsid ty
 		GLSN: tail.GLSN,
 	}
 	return first, last, nil
-
 }
 
 func (c *testLog) AppendableLogStreams(tpid types.TopicID) map[types.LogStreamID]struct{} {
@@ -463,7 +462,7 @@ func newErrSubscriber(err error) *errSubscriber {
 }
 
 func (s errSubscriber) Next() (varlogpb.LogEntry, error) {
-	return varlogpb.InvalidLogEntry(), s.err
+	return varlogpb.LogEntry{}, s.err
 }
 
 func (s errSubscriber) Close() error {
@@ -496,7 +495,7 @@ func (s *subscriberImpl) Next() (varlogpb.LogEntry, error) {
 	logEntry, err := s.next()
 	if err != nil {
 		s.setErr(err)
-		return varlogpb.InvalidLogEntry(), err
+		return varlogpb.LogEntry{}, err
 	}
 	if s.cursor == s.end {
 		s.setErr(io.EOF)
diff --git a/proto/varlogpb/log_entry.go b/proto/varlogpb/log_entry.go
deleted file mode 100644
index ee73f76ff..000000000
--- a/proto/varlogpb/log_entry.go
+++ /dev/null
@@ -1,13 +0,0 @@
-package varlogpb
-
-func InvalidLogEntryMeta() LogEntryMeta {
-	return LogEntryMeta{}
-}
-
-func InvalidLogEntry() LogEntry {
-	return LogEntry{}
-}
-
-func (le LogEntry) Invalid() bool {
-	return le.GLSN.Invalid() && le.LLSN.Invalid() && len(le.Data) == 0
-}