Move form_builder into internal pkg. (#311)

JiayueShi · jiayueshi-work · web-flow · commit 21eef5bc8dd8 · 2023-05-16T13:38:09.000-07:00
* Move form_uilder into internal pkg.

* Fix import of audio.go

* Reorganize.

* Fix import.

* Fix

---------

Co-authored-by: JoyShi &lt;joy.shi@sap.com&gt;
diff --git a/audio.go b/audio.go
@@ -6,6 +6,8 @@ import (
 	"fmt"
 	"net/http"
 	"os"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 // Whisper Defines the models provided by OpenAI to use when processing audio with OpenAI.
@@ -72,7 +74,7 @@ func (c *Client) callAudioAPI(
 	if err != nil {
 		return AudioResponse{}, err
 	}
-	req.Header.Add("Content-Type", builder.formDataContentType())
+	req.Header.Add("Content-Type", builder.FormDataContentType())
 
 	if request.HasJSONResponse() {
 		err = c.sendRequest(req, &response)
@@ -92,55 +94,55 @@ func (r AudioRequest) HasJSONResponse() bool {
 
 // audioMultipartForm creates a form with audio file contents and the name of the model to use for
 // audio processing.
-func audioMultipartForm(request AudioRequest, b formBuilder) error {
+func audioMultipartForm(request AudioRequest, b utils.FormBuilder) error {
 	f, err := os.Open(request.FilePath)
 	if err != nil {
 		return fmt.Errorf("opening audio file: %w", err)
 	}
 	defer f.Close()
 
-	err = b.createFormFile("file", f)
+	err = b.CreateFormFile("file", f)
 	if err != nil {
 		return fmt.Errorf("creating form file: %w", err)
 	}
 
-	err = b.writeField("model", request.Model)
+	err = b.WriteField("model", request.Model)
 	if err != nil {
 		return fmt.Errorf("writing model name: %w", err)
 	}
 
 	// Create a form field for the prompt (if provided)
 	if request.Prompt != "" {
-		err = b.writeField("prompt", request.Prompt)
+		err = b.WriteField("prompt", request.Prompt)
 		if err != nil {
 			return fmt.Errorf("writing prompt: %w", err)
 		}
 	}
 
 	// Create a form field for the format (if provided)
 	if request.Format != "" {
-		err = b.writeField("response_format", string(request.Format))
+		err = b.WriteField("response_format", string(request.Format))
 		if err != nil {
 			return fmt.Errorf("writing format: %w", err)
 		}
 	}
 
 	// Create a form field for the temperature (if provided)
 	if request.Temperature != 0 {
-		err = b.writeField("temperature", fmt.Sprintf("%.2f", request.Temperature))
+		err = b.WriteField("temperature", fmt.Sprintf("%.2f", request.Temperature))
 		if err != nil {
 			return fmt.Errorf("writing temperature: %w", err)
 		}
 	}
 
 	// Create a form field for the language (if provided)
 	if request.Language != "" {
-		err = b.writeField("language", request.Language)
+		err = b.WriteField("language", request.Language)
 		if err != nil {
 			return fmt.Errorf("writing language: %w", err)
 		}
 	}
 
 	// Close the multipart writer
-	return b.close()
+	return b.Close()
 }
diff --git a/client.go b/client.go
@@ -7,14 +7,16 @@ import (
 	"io"
 	"net/http"
 	"strings"
+
+	utils "github.com/sashabaranov/go-openai/internal"
 )
 
 // Client is OpenAI GPT-3 API client.
 type Client struct {
 	config ClientConfig
 
 	requestBuilder    requestBuilder
-	createFormBuilder func(io.Writer) formBuilder
+	createFormBuilder func(io.Writer) utils.FormBuilder
 }
 
 // NewClient creates new OpenAI API client.
@@ -28,8 +30,8 @@ func NewClientWithConfig(config ClientConfig) *Client {
 	return &Client{
 		config:         config,
 		requestBuilder: newRequestBuilder(),
-		createFormBuilder: func(body io.Writer) formBuilder {
-			return newFormBuilder(body)
+		createFormBuilder: func(body io.Writer) utils.FormBuilder {
+			return utils.NewFormBuilder(body)
 		},
 	}
 }
diff --git a/files.go b/files.go
@@ -36,7 +36,7 @@ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File
 	var b bytes.Buffer
 	builder := c.createFormBuilder(&b)
 
-	err = builder.writeField("purpose", request.Purpose)
+	err = builder.WriteField("purpose", request.Purpose)
 	if err != nil {
 		return
 	}
@@ -46,12 +46,12 @@ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File
 		return
 	}
 
-	err = builder.createFormFile("file", fileData)
+	err = builder.CreateFormFile("file", fileData)
 	if err != nil {
 		return
 	}
 
-	err = builder.close()
+	err = builder.Close()
 	if err != nil {
 		return
 	}
@@ -61,7 +61,7 @@ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File
 		return
 	}
 
-	req.Header.Set("Content-Type", builder.formDataContentType())
+	req.Header.Set("Content-Type", builder.FormDataContentType())
 
 	err = c.sendRequest(req, &file)
 
diff --git a/files_test.go b/files_test.go
@@ -1,6 +1,7 @@
 package openai //nolint:testpackage // testing private field
 
 import (
+	. "github.com/sashabaranov/go-openai/internal"
 	"github.com/sashabaranov/go-openai/internal/test"
 	"github.com/sashabaranov/go-openai/internal/test/checks"
 
@@ -85,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) FormBuilder {
 		return mockBuilder
 	}
 
diff --git a/form_builder.go b/form_builder.go
diff --git a/image.go b/image.go
@@ -69,40 +69,40 @@ func (c *Client) CreateEditImage(ctx context.Context, request ImageEditRequest)
 	builder := c.createFormBuilder(body)
 
 	// image
-	err = builder.createFormFile("image", request.Image)
+	err = builder.CreateFormFile("image", request.Image)
 	if err != nil {
 		return
 	}
 
 	// mask, it is optional
 	if request.Mask != nil {
-		err = builder.createFormFile("mask", request.Mask)
+		err = builder.CreateFormFile("mask", request.Mask)
 		if err != nil {
 			return
 		}
 	}
 
-	err = builder.writeField("prompt", request.Prompt)
+	err = builder.WriteField("prompt", request.Prompt)
 	if err != nil {
 		return
 	}
 
-	err = builder.writeField("n", strconv.Itoa(request.N))
+	err = builder.WriteField("n", strconv.Itoa(request.N))
 	if err != nil {
 		return
 	}
 
-	err = builder.writeField("size", request.Size)
+	err = builder.WriteField("size", request.Size)
 	if err != nil {
 		return
 	}
 
-	err = builder.writeField("response_format", request.ResponseFormat)
+	err = builder.WriteField("response_format", request.ResponseFormat)
 	if err != nil {
 		return
 	}
 
-	err = builder.close()
+	err = builder.Close()
 	if err != nil {
 		return
 	}
@@ -113,7 +113,7 @@ func (c *Client) CreateEditImage(ctx context.Context, request ImageEditRequest)
 		return
 	}
 
-	req.Header.Set("Content-Type", builder.formDataContentType())
+	req.Header.Set("Content-Type", builder.FormDataContentType())
 	err = c.sendRequest(req, &response)
 	return
 }
@@ -133,27 +133,27 @@ func (c *Client) CreateVariImage(ctx context.Context, request ImageVariRequest)
 	builder := c.createFormBuilder(body)
 
 	// image
-	err = builder.createFormFile("image", request.Image)
+	err = builder.CreateFormFile("image", request.Image)
 	if err != nil {
 		return
 	}
 
-	err = builder.writeField("n", strconv.Itoa(request.N))
+	err = builder.WriteField("n", strconv.Itoa(request.N))
 	if err != nil {
 		return
 	}
 
-	err = builder.writeField("size", request.Size)
+	err = builder.WriteField("size", request.Size)
 	if err != nil {
 		return
 	}
 
-	err = builder.writeField("response_format", request.ResponseFormat)
+	err = builder.WriteField("response_format", request.ResponseFormat)
 	if err != nil {
 		return
 	}
 
-	err = builder.close()
+	err = builder.Close()
 	if err != nil {
 		return
 	}
@@ -165,7 +165,7 @@ func (c *Client) CreateVariImage(ctx context.Context, request ImageVariRequest)
 		return
 	}
 
-	req.Header.Set("Content-Type", builder.formDataContentType())
+	req.Header.Set("Content-Type", builder.FormDataContentType())
 	err = c.sendRequest(req, &response)
 	return
 }
diff --git a/image_test.go b/image_test.go
@@ -1,6 +1,7 @@
 package openai //nolint:testpackage // testing private field
 
 import (
+	utils "github.com/sashabaranov/go-openai/internal"
 	"github.com/sashabaranov/go-openai/internal/test"
 	"github.com/sashabaranov/go-openai/internal/test/checks"
 
@@ -268,19 +269,19 @@ type mockFormBuilder struct {
 	mockClose          func() error
 }
 
-func (fb *mockFormBuilder) createFormFile(fieldname string, file *os.File) error {
+func (fb *mockFormBuilder) CreateFormFile(fieldname string, file *os.File) error {
 	return fb.mockCreateFormFile(fieldname, file)
 }
 
-func (fb *mockFormBuilder) writeField(fieldname, value string) error {
+func (fb *mockFormBuilder) WriteField(fieldname, value string) error {
 	return fb.mockWriteField(fieldname, value)
 }
 
-func (fb *mockFormBuilder) close() error {
+func (fb *mockFormBuilder) Close() error {
 	return fb.mockClose()
 }
 
-func (fb *mockFormBuilder) formDataContentType() string {
+func (fb *mockFormBuilder) FormDataContentType() string {
 	return ""
 }
 
@@ -290,7 +291,7 @@ func TestImageFormBuilderFailures(t *testing.T) {
 	client := NewClientWithConfig(config)
 
 	mockBuilder := &mockFormBuilder{}
-	client.createFormBuilder = func(io.Writer) formBuilder {
+	client.createFormBuilder = func(io.Writer) utils.FormBuilder {
 		return mockBuilder
 	}
 	ctx := context.Background()
@@ -357,7 +358,7 @@ func TestVariImageFormBuilderFailures(t *testing.T) {
 	client := NewClientWithConfig(config)
 
 	mockBuilder := &mockFormBuilder{}
-	client.createFormBuilder = func(io.Writer) formBuilder {
+	client.createFormBuilder = func(io.Writer) utils.FormBuilder {
 		return mockBuilder
 	}
 	ctx := context.Background()
diff --git a/internal/form_builder.go b/internal/form_builder.go
diff --git a/internal/form_builder_test.go b/internal/form_builder_test.go

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ import (`
`6`	`6`	`"fmt"`
`7`	`7`	`"net/http"`
`8`	`8`	`"os"`
	`9`	`+`
	`10`	`+ utils "github.com/sashabaranov/go-openai/internal"`
`9`	`11`	`)`
`10`	`12`
`11`	`13`	`// Whisper Defines the models provided by OpenAI to use when processing audio with OpenAI.`
`@@ -72,7 +74,7 @@ func (c *Client) callAudioAPI(`
`72`	`74`	`if err != nil {`
`73`	`75`	`return AudioResponse{}, err`
`74`	`76`	`}`
`75`		`- req.Header.Add("Content-Type", builder.formDataContentType())`
	`77`	`+ req.Header.Add("Content-Type", builder.FormDataContentType())`
`76`	`78`
`77`	`79`	`if request.HasJSONResponse() {`
`78`	`80`	`err = c.sendRequest(req, &response)`
`@@ -92,55 +94,55 @@ func (r AudioRequest) HasJSONResponse() bool {`
`92`	`94`
`93`	`95`	`// audioMultipartForm creates a form with audio file contents and the name of the model to use for`
`94`	`96`	`// audio processing.`
`95`		`-func audioMultipartForm(request AudioRequest, b formBuilder) error {`
	`97`	`+func audioMultipartForm(request AudioRequest, b utils.FormBuilder) error {`
`96`	`98`	`f, err := os.Open(request.FilePath)`
`97`	`99`	`if err != nil {`
`98`	`100`	`return fmt.Errorf("opening audio file: %w", err)`
`99`	`101`	`}`
`100`	`102`	`defer f.Close()`
`101`	`103`
`102`		`- err = b.createFormFile("file", f)`
	`104`	`+ err = b.CreateFormFile("file", f)`
`103`	`105`	`if err != nil {`
`104`	`106`	`return fmt.Errorf("creating form file: %w", err)`
`105`	`107`	`}`
`106`	`108`
`107`		`- err = b.writeField("model", request.Model)`
	`109`	`+ err = b.WriteField("model", request.Model)`
`108`	`110`	`if err != nil {`
`109`	`111`	`return fmt.Errorf("writing model name: %w", err)`
`110`	`112`	`}`
`111`	`113`
`112`	`114`	`// Create a form field for the prompt (if provided)`
`113`	`115`	`if request.Prompt != "" {`
`114`		`- err = b.writeField("prompt", request.Prompt)`
	`116`	`+ err = b.WriteField("prompt", request.Prompt)`
`115`	`117`	`if err != nil {`
`116`	`118`	`return fmt.Errorf("writing prompt: %w", err)`
`117`	`119`	`}`
`118`	`120`	`}`
`119`	`121`
`120`	`122`	`// Create a form field for the format (if provided)`
`121`	`123`	`if request.Format != "" {`
`122`		`- err = b.writeField("response_format", string(request.Format))`
	`124`	`+ err = b.WriteField("response_format", string(request.Format))`
`123`	`125`	`if err != nil {`
`124`	`126`	`return fmt.Errorf("writing format: %w", err)`
`125`	`127`	`}`
`126`	`128`	`}`
`127`	`129`
`128`	`130`	`// Create a form field for the temperature (if provided)`
`129`	`131`	`if request.Temperature != 0 {`
`130`		`- err = b.writeField("temperature", fmt.Sprintf("%.2f", request.Temperature))`
	`132`	`+ err = b.WriteField("temperature", fmt.Sprintf("%.2f", request.Temperature))`
`131`	`133`	`if err != nil {`
`132`	`134`	`return fmt.Errorf("writing temperature: %w", err)`
`133`	`135`	`}`
`134`	`136`	`}`
`135`	`137`
`136`	`138`	`// Create a form field for the language (if provided)`
`137`	`139`	`if request.Language != "" {`
`138`		`- err = b.writeField("language", request.Language)`
	`140`	`+ err = b.WriteField("language", request.Language)`
`139`	`141`	`if err != nil {`
`140`	`142`	`return fmt.Errorf("writing language: %w", err)`
`141`	`143`	`}`
`142`	`144`	`}`
`143`	`145`
`144`	`146`	`// Close the multipart writer`
`145`		`- return b.close()`
	`147`	`+ return b.Close()`
`146`	`148`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File`
`36`	`36`	`var b bytes.Buffer`
`37`	`37`	`builder := c.createFormBuilder(&b)`
`38`	`38`
`39`		`- err = builder.writeField("purpose", request.Purpose)`
	`39`	`+ err = builder.WriteField("purpose", request.Purpose)`
`40`	`40`	`if err != nil {`
`41`	`41`	`return`
`42`	`42`	`}`
`@@ -46,12 +46,12 @@ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File`
`46`	`46`	`return`
`47`	`47`	`}`
`48`	`48`
`49`		`- err = builder.createFormFile("file", fileData)`
	`49`	`+ err = builder.CreateFormFile("file", fileData)`
`50`	`50`	`if err != nil {`
`51`	`51`	`return`
`52`	`52`	`}`
`53`	`53`
`54`		`- err = builder.close()`
	`54`	`+ err = builder.Close()`
`55`	`55`	`if err != nil {`
`56`	`56`	`return`
`57`	`57`	`}`
`@@ -61,7 +61,7 @@ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File`
`61`	`61`	`return`
`62`	`62`	`}`
`63`	`63`
`64`		`- req.Header.Set("Content-Type", builder.formDataContentType())`
	`64`	`+ req.Header.Set("Content-Type", builder.FormDataContentType())`
`65`	`65`
`66`	`66`	`err = c.sendRequest(req, &file)`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -69,40 +69,40 @@ func (c *Client) CreateEditImage(ctx context.Context, request ImageEditRequest)`
`69`	`69`	`builder := c.createFormBuilder(body)`
`70`	`70`
`71`	`71`	`// image`
`72`		`- err = builder.createFormFile("image", request.Image)`
	`72`	`+ err = builder.CreateFormFile("image", request.Image)`
`73`	`73`	`if err != nil {`
`74`	`74`	`return`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`// mask, it is optional`
`78`	`78`	`if request.Mask != nil {`
`79`		`- err = builder.createFormFile("mask", request.Mask)`
	`79`	`+ err = builder.CreateFormFile("mask", request.Mask)`
`80`	`80`	`if err != nil {`
`81`	`81`	`return`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`85`		`- err = builder.writeField("prompt", request.Prompt)`
	`85`	`+ err = builder.WriteField("prompt", request.Prompt)`
`86`	`86`	`if err != nil {`
`87`	`87`	`return`
`88`	`88`	`}`
`89`	`89`
`90`		`- err = builder.writeField("n", strconv.Itoa(request.N))`
	`90`	`+ err = builder.WriteField("n", strconv.Itoa(request.N))`
`91`	`91`	`if err != nil {`
`92`	`92`	`return`
`93`	`93`	`}`
`94`	`94`
`95`		`- err = builder.writeField("size", request.Size)`
	`95`	`+ err = builder.WriteField("size", request.Size)`
`96`	`96`	`if err != nil {`
`97`	`97`	`return`
`98`	`98`	`}`
`99`	`99`
`100`		`- err = builder.writeField("response_format", request.ResponseFormat)`
	`100`	`+ err = builder.WriteField("response_format", request.ResponseFormat)`
`101`	`101`	`if err != nil {`
`102`	`102`	`return`
`103`	`103`	`}`
`104`	`104`
`105`		`- err = builder.close()`
	`105`	`+ err = builder.Close()`
`106`	`106`	`if err != nil {`
`107`	`107`	`return`
`108`	`108`	`}`
`@@ -113,7 +113,7 @@ func (c *Client) CreateEditImage(ctx context.Context, request ImageEditRequest)`
`113`	`113`	`return`
`114`	`114`	`}`
`115`	`115`
`116`		`- req.Header.Set("Content-Type", builder.formDataContentType())`
	`116`	`+ req.Header.Set("Content-Type", builder.FormDataContentType())`
`117`	`117`	`err = c.sendRequest(req, &response)`
`118`	`118`	`return`
`119`	`119`	`}`
`@@ -133,27 +133,27 @@ func (c *Client) CreateVariImage(ctx context.Context, request ImageVariRequest)`
`133`	`133`	`builder := c.createFormBuilder(body)`
`134`	`134`
`135`	`135`	`// image`
`136`		`- err = builder.createFormFile("image", request.Image)`
	`136`	`+ err = builder.CreateFormFile("image", request.Image)`
`137`	`137`	`if err != nil {`
`138`	`138`	`return`
`139`	`139`	`}`
`140`	`140`
`141`		`- err = builder.writeField("n", strconv.Itoa(request.N))`
	`141`	`+ err = builder.WriteField("n", strconv.Itoa(request.N))`
`142`	`142`	`if err != nil {`
`143`	`143`	`return`
`144`	`144`	`}`
`145`	`145`
`146`		`- err = builder.writeField("size", request.Size)`
	`146`	`+ err = builder.WriteField("size", request.Size)`
`147`	`147`	`if err != nil {`
`148`	`148`	`return`
`149`	`149`	`}`
`150`	`150`
`151`		`- err = builder.writeField("response_format", request.ResponseFormat)`
	`151`	`+ err = builder.WriteField("response_format", request.ResponseFormat)`
`152`	`152`	`if err != nil {`
`153`	`153`	`return`
`154`	`154`	`}`
`155`	`155`
`156`		`- err = builder.close()`
	`156`	`+ err = builder.Close()`
`157`	`157`	`if err != nil {`
`158`	`158`	`return`
`159`	`159`	`}`
`@@ -165,7 +165,7 @@ func (c *Client) CreateVariImage(ctx context.Context, request ImageVariRequest)`
`165`	`165`	`return`
`166`	`166`	`}`
`167`	`167`
`168`		`- req.Header.Set("Content-Type", builder.formDataContentType())`
	`168`	`+ req.Header.Set("Content-Type", builder.FormDataContentType())`
`169`	`169`	`err = c.sendRequest(req, &response)`
`170`	`170`	`return`
`171`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package openai //nolint:testpackage // testing private field`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ utils "github.com/sashabaranov/go-openai/internal"`
`4`	`5`	`"github.com/sashabaranov/go-openai/internal/test"`
`5`	`6`	`"github.com/sashabaranov/go-openai/internal/test/checks"`
`6`	`7`
`@@ -268,19 +269,19 @@ type mockFormBuilder struct {`
`268`	`269`	`mockClose func() error`
`269`	`270`	`}`
`270`	`271`
`271`		`-func (fb mockFormBuilder) createFormFile(fieldname string, file os.File) error {`
	`272`	`+func (fb mockFormBuilder) CreateFormFile(fieldname string, file os.File) error {`
`272`	`273`	`return fb.mockCreateFormFile(fieldname, file)`
`273`	`274`	`}`
`274`	`275`
`275`		`-func (fb *mockFormBuilder) writeField(fieldname, value string) error {`
	`276`	`+func (fb *mockFormBuilder) WriteField(fieldname, value string) error {`
`276`	`277`	`return fb.mockWriteField(fieldname, value)`
`277`	`278`	`}`
`278`	`279`
`279`		`-func (fb *mockFormBuilder) close() error {`
	`280`	`+func (fb *mockFormBuilder) Close() error {`
`280`	`281`	`return fb.mockClose()`
`281`	`282`	`}`
`282`	`283`
`283`		`-func (fb *mockFormBuilder) formDataContentType() string {`
	`284`	`+func (fb *mockFormBuilder) FormDataContentType() string {`
`284`	`285`	`return ""`
`285`	`286`	`}`
`286`	`287`
`@@ -290,7 +291,7 @@ func TestImageFormBuilderFailures(t *testing.T) {`
`290`	`291`	`client := NewClientWithConfig(config)`
`291`	`292`
`292`	`293`	`mockBuilder := &mockFormBuilder{}`
`293`		`- client.createFormBuilder = func(io.Writer) formBuilder {`
	`294`	`+ client.createFormBuilder = func(io.Writer) utils.FormBuilder {`
`294`	`295`	`return mockBuilder`
`295`	`296`	`}`
`296`	`297`	`ctx := context.Background()`
`@@ -357,7 +358,7 @@ func TestVariImageFormBuilderFailures(t *testing.T) {`
`357`	`358`	`client := NewClientWithConfig(config)`
`358`	`359`
`359`	`360`	`mockBuilder := &mockFormBuilder{}`
`360`		`- client.createFormBuilder = func(io.Writer) formBuilder {`
	`361`	`+ client.createFormBuilder = func(io.Writer) utils.FormBuilder {`
`361`	`362`	`return mockBuilder`
`362`	`363`	`}`
`363`	`364`	`ctx := context.Background()`