move marshaller and unmarshaler into internal pkg (#304) (#325)

vvatanabe · web-flow · commit 62eb4beed29f · 2023-05-28T05:51:07.000+04:00
diff --git a/chat_stream.go b/chat_stream.go
@@ -4,6 +4,8 @@ import (
 	"bufio"
 	"context"
 	"net/http"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 type ChatCompletionStreamChoiceDelta struct {
@@ -65,7 +67,7 @@ func (c *Client) CreateChatCompletionStream(
 			reader:             bufio.NewReader(resp.Body),
 			response:           resp,
 			errAccumulator:     newErrorAccumulator(),
-			unmarshaler:        &jsonUnmarshaler{},
+			unmarshaler:        &utils.JSONUnmarshaler{},
 		},
 	}
 	return
diff --git a/error_accumulator.go b/error_accumulator.go
@@ -4,6 +4,8 @@ import (
 	"bytes"
 	"fmt"
 	"io"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 type errorAccumulator interface {
@@ -19,13 +21,13 @@ type errorBuffer interface {
 
 type defaultErrorAccumulator struct {
 	buffer      errorBuffer
-	unmarshaler unmarshaler
+	unmarshaler utils.Unmarshaler
 }
 
 func newErrorAccumulator() errorAccumulator {
 	return &defaultErrorAccumulator{
 		buffer:      &bytes.Buffer{},
-		unmarshaler: &jsonUnmarshaler{},
+		unmarshaler: &utils.JSONUnmarshaler{},
 	}
 }
 
@@ -42,7 +44,7 @@ func (e *defaultErrorAccumulator) unmarshalError() (errResp *ErrorResponse) {
 		return
 	}
 
-	err := e.unmarshaler.unmarshal(e.buffer.Bytes(), &errResp)
+	err := e.unmarshaler.Unmarshal(e.buffer.Bytes(), &errResp)
 	if err != nil {
 		errResp = nil
 	}
diff --git a/error_accumulator_test.go b/error_accumulator_test.go
@@ -7,6 +7,7 @@ import (
 	"net/http"
 	"testing"
 
+	utils "github.com/sashabaranov/go-openai/internal"
 	"github.com/sashabaranov/go-openai/internal/test"
 	"github.com/sashabaranov/go-openai/internal/test/checks"
 )
@@ -33,7 +34,7 @@ func (b *failingErrorBuffer) Bytes() []byte {
 	return []byte{}
 }
 
-func (*failingUnMarshaller) unmarshal(_ []byte, _ any) error {
+func (*failingUnMarshaller) Unmarshal(_ []byte, _ any) error {
 	return errTestUnmarshalerFailed
 }
 
@@ -62,7 +63,7 @@ func TestErrorAccumulatorReturnsUnmarshalerErrors(t *testing.T) {
 func TestErrorByteWriteErrors(t *testing.T) {
 	accumulator := &defaultErrorAccumulator{
 		buffer:      &failingErrorBuffer{},
-		unmarshaler: &jsonUnmarshaler{},
+		unmarshaler: &utils.JSONUnmarshaler{},
 	}
 	err := accumulator.write([]byte("{"))
 	if !errors.Is(err, errTestErrorAccumulatorWriteFailed) {
@@ -91,7 +92,7 @@ func TestErrorAccumulatorWriteErrors(t *testing.T) {
 
 	stream.errAccumulator = &defaultErrorAccumulator{
 		buffer:      &failingErrorBuffer{},
-		unmarshaler: &jsonUnmarshaler{},
+		unmarshaler: &utils.JSONUnmarshaler{},
 	}
 
 	_, err = stream.Recv()
diff --git a/files_test.go b/files_test.go
@@ -1,7 +1,7 @@
 package openai //nolint:testpackage // testing private field
 
 import (
-	. "github.com/sashabaranov/go-openai/internal"
+	utils "github.com/sashabaranov/go-openai/internal"
 	"github.com/sashabaranov/go-openai/internal/test"
 	"github.com/sashabaranov/go-openai/internal/test/checks"
 
@@ -86,7 +86,7 @@ func TestFileUploadWithFailingFormBuilder(t *testing.T) {
 	config.BaseURL = ""
 	client := NewClientWithConfig(config)
 	mockBuilder := &mockFormBuilder{}
-	client.createFormBuilder = func(io.Writer) FormBuilder {
+	client.createFormBuilder = func(io.Writer) utils.FormBuilder {
 		return mockBuilder
 	}
 
diff --git a/internal/marshaller.go b/internal/marshaller.go
@@ -0,0 +1,15 @@
+package openai
+
+import (
+	"encoding/json"
+)
+
+type Marshaller interface {
+	Marshal(value any) ([]byte, error)
+}
+
+type JSONMarshaller struct{}
+
+func (jm *JSONMarshaller) Marshal(value any) ([]byte, error) {
+	return json.Marshal(value)
+}
diff --git a/internal/unmarshaler.go b/internal/unmarshaler.go
@@ -0,0 +1,15 @@
+package openai
+
+import (
+	"encoding/json"
+)
+
+type Unmarshaler interface {
+	Unmarshal(data []byte, v any) error
+}
+
+type JSONUnmarshaler struct{}
+
+func (jm *JSONUnmarshaler) Unmarshal(data []byte, v any) error {
+	return json.Unmarshal(data, v)
+}
diff --git a/marshaller.go b/marshaller.go
diff --git a/request_builder.go b/request_builder.go
@@ -4,19 +4,21 @@ import (
 	"bytes"
 	"context"
 	"net/http"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 type requestBuilder interface {
 	build(ctx context.Context, method, url string, request any) (*http.Request, error)
 }
 
 type httpRequestBuilder struct {
-	marshaller marshaller
+	marshaller utils.Marshaller
 }
 
 func newRequestBuilder() *httpRequestBuilder {
 	return &httpRequestBuilder{
-		marshaller: &jsonMarshaller{},
+		marshaller: &utils.JSONMarshaller{},
 	}
 }
 
@@ -26,7 +28,7 @@ func (b *httpRequestBuilder) build(ctx context.Context, method, url string, requ
 	}
 
 	var reqBytes []byte
-	reqBytes, err := b.marshaller.marshal(request)
+	reqBytes, err := b.marshaller.Marshal(request)
 	if err != nil {
 		return nil, err
 	}
diff --git a/request_builder_test.go b/request_builder_test.go
@@ -19,7 +19,7 @@ type (
 	failingMarshaller     struct{}
 )
 
-func (*failingMarshaller) marshal(_ any) ([]byte, error) {
+func (*failingMarshaller) Marshal(_ any) ([]byte, error) {
 	return []byte{}, errTestMarshallerFailed
 }
 
diff --git a/stream.go b/stream.go
@@ -5,6 +5,8 @@ import (
 	"context"
 	"errors"
 	"net/http"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 var (
@@ -54,7 +56,7 @@ func (c *Client) CreateCompletionStream(
 			reader:             bufio.NewReader(resp.Body),
 			response:           resp,
 			errAccumulator:     newErrorAccumulator(),
-			unmarshaler:        &jsonUnmarshaler{},
+			unmarshaler:        &utils.JSONUnmarshaler{},
 		},
 	}
 	return
diff --git a/stream_reader.go b/stream_reader.go
@@ -6,6 +6,8 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 type streamable interface {
@@ -19,7 +21,7 @@ type streamReader[T streamable] struct {
 	reader         *bufio.Reader
 	response       *http.Response
 	errAccumulator errorAccumulator
-	unmarshaler    unmarshaler
+	unmarshaler    utils.Unmarshaler
 }
 
 func (stream *streamReader[T]) Recv() (response T, err error) {
@@ -63,7 +65,7 @@ waitForData:
 		return
 	}
 
-	err = stream.unmarshaler.unmarshal(line, &response)
+	err = stream.unmarshaler.Unmarshal(line, &response)
 	return
 }
 
diff --git a/unmarshaler.go b/unmarshaler.go

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@ import (`
`4`	`4`	`"bytes"`
`5`	`5`	`"fmt"`
`6`	`6`	`"io"`
	`7`	`+`
	`8`	`+ utils "github.com/sashabaranov/go-openai/internal"`
`7`	`9`	`)`
`8`	`10`
`9`	`11`	`type errorAccumulator interface {`
`@@ -19,13 +21,13 @@ type errorBuffer interface {`
`19`	`21`
`20`	`22`	`type defaultErrorAccumulator struct {`
`21`	`23`	`buffer errorBuffer`
`22`		`- unmarshaler unmarshaler`
	`24`	`+ unmarshaler utils.Unmarshaler`
`23`	`25`	`}`
`24`	`26`
`25`	`27`	`func newErrorAccumulator() errorAccumulator {`
`26`	`28`	`return &defaultErrorAccumulator{`
`27`	`29`	`buffer: &bytes.Buffer{},`
`28`		`- unmarshaler: &jsonUnmarshaler{},`
	`30`	`+ unmarshaler: &utils.JSONUnmarshaler{},`
`29`	`31`	`}`
`30`	`32`	`}`
`31`	`33`
`@@ -42,7 +44,7 @@ func (e defaultErrorAccumulator) unmarshalError() (errResp ErrorResponse) {`
`42`	`44`	`return`
`43`	`45`	`}`
`44`	`46`
`45`		`- err := e.unmarshaler.unmarshal(e.buffer.Bytes(), &errResp)`
	`47`	`+ err := e.unmarshaler.Unmarshal(e.buffer.Bytes(), &errResp)`
`46`	`48`	`if err != nil {`
`47`	`49`	`errResp = nil`
`48`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ import (`
`7`	`7`	`"net/http"`
`8`	`8`	`"testing"`
`9`	`9`
	`10`	`+ utils "github.com/sashabaranov/go-openai/internal"`
`10`	`11`	`"github.com/sashabaranov/go-openai/internal/test"`
`11`	`12`	`"github.com/sashabaranov/go-openai/internal/test/checks"`
`12`	`13`	`)`
`@@ -33,7 +34,7 @@ func (b *failingErrorBuffer) Bytes() []byte {`
`33`	`34`	`return []byte{}`
`34`	`35`	`}`
`35`	`36`
`36`		`-func (*failingUnMarshaller) unmarshal(_ []byte, _ any) error {`
	`37`	`+func (*failingUnMarshaller) Unmarshal(_ []byte, _ any) error {`
`37`	`38`	`return errTestUnmarshalerFailed`
`38`	`39`	`}`
`39`	`40`
`@@ -62,7 +63,7 @@ func TestErrorAccumulatorReturnsUnmarshalerErrors(t *testing.T) {`
`62`	`63`	`func TestErrorByteWriteErrors(t *testing.T) {`
`63`	`64`	`accumulator := &defaultErrorAccumulator{`
`64`	`65`	`buffer: &failingErrorBuffer{},`
`65`		`- unmarshaler: &jsonUnmarshaler{},`
	`66`	`+ unmarshaler: &utils.JSONUnmarshaler{},`
`66`	`67`	`}`
`67`	`68`	`err := accumulator.write([]byte("{"))`
`68`	`69`	`if !errors.Is(err, errTestErrorAccumulatorWriteFailed) {`
`@@ -91,7 +92,7 @@ func TestErrorAccumulatorWriteErrors(t *testing.T) {`
`91`	`92`
`92`	`93`	`stream.errAccumulator = &defaultErrorAccumulator{`
`93`	`94`	`buffer: &failingErrorBuffer{},`
`94`		`- unmarshaler: &jsonUnmarshaler{},`
	`95`	`+ unmarshaler: &utils.JSONUnmarshaler{},`
`95`	`96`	`}`
`96`	`97`
`97`	`98`	`_, err = stream.Recv()`
Original file line number	Diff line number	Diff line change
`@@ -4,19 +4,21 @@ import (`
`4`	`4`	`"bytes"`
`5`	`5`	`"context"`
`6`	`6`	`"net/http"`
	`7`	`+`
	`8`	`+ utils "github.com/sashabaranov/go-openai/internal"`
`7`	`9`	`)`
`8`	`10`
`9`	`11`	`type requestBuilder interface {`
`10`	`12`	`build(ctx context.Context, method, url string, request any) (*http.Request, error)`
`11`	`13`	`}`
`12`	`14`
`13`	`15`	`type httpRequestBuilder struct {`
`14`		`- marshaller marshaller`
	`16`	`+ marshaller utils.Marshaller`
`15`	`17`	`}`
`16`	`18`
`17`	`19`	`func newRequestBuilder() *httpRequestBuilder {`
`18`	`20`	`return &httpRequestBuilder{`
`19`		`- marshaller: &jsonMarshaller{},`
	`21`	`+ marshaller: &utils.JSONMarshaller{},`
`20`	`22`	`}`
`21`	`23`	`}`
`22`	`24`
`@@ -26,7 +28,7 @@ func (b *httpRequestBuilder) build(ctx context.Context, method, url string, requ`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`var reqBytes []byte`
`29`		`- reqBytes, err := b.marshaller.marshal(request)`
	`31`	`+ reqBytes, err := b.marshaller.Marshal(request)`
`30`	`32`	`if err != nil {`
`31`	`33`	`return nil, err`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ type (`
`19`	`19`	`failingMarshaller struct{}`
`20`	`20`	`)`
`21`	`21`
`22`		`-func (*failingMarshaller) marshal(_ any) ([]byte, error) {`
	`22`	`+func (*failingMarshaller) Marshal(_ any) ([]byte, error) {`
`23`	`23`	`return []byte{}, errTestMarshallerFailed`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ import (`
`6`	`6`	`"fmt"`
`7`	`7`	`"io"`
`8`	`8`	`"net/http"`
	`9`	`+`
	`10`	`+ utils "github.com/sashabaranov/go-openai/internal"`
`9`	`11`	`)`
`10`	`12`
`11`	`13`	`type streamable interface {`
`@@ -19,7 +21,7 @@ type streamReader[T streamable] struct {`
`19`	`21`	`reader *bufio.Reader`
`20`	`22`	`response *http.Response`
`21`	`23`	`errAccumulator errorAccumulator`
`22`		`- unmarshaler unmarshaler`
	`24`	`+ unmarshaler utils.Unmarshaler`
`23`	`25`	`}`
`24`	`26`
`25`	`27`	`func (stream *streamReader[T]) Recv() (response T, err error) {`
`@@ -63,7 +65,7 @@ waitForData:`
`63`	`65`	`return`
`64`	`66`	`}`
`65`	`67`
`66`		`- err = stream.unmarshaler.unmarshal(line, &response)`
	`68`	`+ err = stream.unmarshaler.Unmarshal(line, &response)`
`67`	`69`	`return`
`68`	`70`	`}`
`69`	`71`