fixes generation error creation (#15)

### TL;DR

Fix generation error handling and add documentation to trace.go

### What changed?

- Fixed the `SetError` method in `Generation` to use "result" instead of "update" event type and properly structure the error data
- Added automatic call to `End()` after setting an error in a generation
- Updated `SetGenerationError` in `Logger` to match the same pattern and end the generation after setting an error
- Added documentation comments to all functions and types in trace.go

### How to test?

1. Verify that error handling in generations works correctly by triggering an error condition
2. Confirm that generations are properly ended after an error is set
3. Check that the error data is correctly structured in the logs

### Why make this change?

This change ensures consistent error handling in generations and properly ends generations after errors occur, preventing hanging or incomplete generation records. The added documentation in trace.go improves code readability and helps developers understand the purpose of each component in the tracing system.

Author: akshaydeo

.gitignore

@@ -1 +1,54 @@
-testConfig.json
+# Project specific
+testConfig.json
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool
+*.out
+coverage.txt
+coverage.html
+
+# Dependency directories
+vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# Build artifacts
+dist/
+build/
+bin/
+
+# IDE specific files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Air (live reload) tmp directory
+tmp/
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# Logs
+*.log
+
+# Debug files
+__debug_bin
+debug
+
+.DS_Store

logging/generation.go

@@ -288,9 +288,12 @@ func (g *Generation) SetResult(r interface{}) {
 
 func (g *Generation) SetError(err *GenerationError) {
 	g.error = err
-	g.commit("update", map[string]interface{}{
-		"error": g.error,
+	g.commit("result", map[string]interface{}{
+		"result": map[string]interface{}{
+			"error": g.error,
+		},
 	})
+	g.End()
 }
 
 func (g *Generation) data() map[string]interface{} {

logging/logger.go

@@ -253,9 +253,12 @@ func (l *Logger) AddResultToGeneration(gId string, result interface{}) {
 
 // SetGenerationError sets an error for the specified generation
 func (l *Logger) SetGenerationError(gId string, error *GenerationError) {
-	l.writer.commit(newCommitLog(EntityGeneration, gId, "error", map[string]interface{}{
-		"error": error,
+	l.writer.commit(newCommitLog(EntityGeneration, gId, "result", map[string]interface{}{
+		"result": map[string]interface{}{
+			"error": error,
+		},
 	}))
+	end(l.writer, EntityGeneration, gId)
 }
 
 // EndGeneration marks the specified generation as ended

logging/trace.go

@@ -1,5 +1,6 @@
 package logging
 
+// TraceConfig represents the configuration for a trace
 type TraceConfig struct {
 	Id        string             `json:"id"`
 	SpanId    *string            `json:"spanId,omitempty"`
@@ -8,11 +9,13 @@ type TraceConfig struct {
 	SessionId *string
 }
 
+// Trace represents a trace in the logging system
 type Trace struct {
 	*eventEmitter
 	SessionId *string
 }
 
+// newTrace creates a new trace
 func newTrace(c *TraceConfig, w *writer) *Trace {
 	t := &Trace{
 		eventEmitter: &eventEmitter{
@@ -31,6 +34,7 @@ func newTrace(c *TraceConfig, w *writer) *Trace {
 	return t
 }
 
+// AddGeneration adds a generation to the trace
 func (t *Trace) AddGeneration(c *GenerationConfig) *Generation {
 	g := newGeneration(c, t.writer)
 	gData := g.data()
@@ -39,10 +43,12 @@ func (t *Trace) AddGeneration(c *GenerationConfig) *Generation {
 	return g
 }
 
+// SetFeedback adds a feedback to the trace
 func (t *Trace) SetFeedback(f *Feedback) {
 	t.commit("add-feedback", f)
 }
 
+// AddSpan adds a span to the trace
 func (t *Trace) AddSpan(c *SpanConfig) *Span {
 	s := newSpan(c, t.writer)
 	sData := s.data()
@@ -51,6 +57,7 @@ func (t *Trace) AddSpan(c *SpanConfig) *Span {
 	return s
 }
 
+// AddRetrieval adds a retrieval to the trace
 func (t *Trace) AddRetrieval(c *RetrievalConfig) *Retrieval {
 	r := newRetrieval(c, t.writer)
 	rData := r.data()