-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adds support for stream mode (#183)
* chore: refactor package structure * feat(openai): add stream support, WIP * chore(refactor): refactor api_test.go * chore(refactor): add stream test to api_test.go * chore: print final linebreak + print message when not streamed * chore(fix): fixes remaining tests in api_test.go * chore: start refactoring for root_test.go * chore: WIP refactoring for cli tests * chore: finish tests * chore: add comment and remove trailing linebreak * chore: add comments * chore: update docs with stream flas * chore(fix,test): fix test for streamed output * chore(fix,lint): fix linting error * chore(fix,test): fix panic error * chore: remove github script part in release pipeline
- Loading branch information
Showing
41 changed files
with
989 additions
and
518 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // Copyright (c) 2023 Tim <tbckr> | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
| // this software and associated documentation files (the "Software"), to deal in | ||
| // the Software without restriction, including without limitation the rights to | ||
| // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
| // the Software, and to permit persons to whom the Software is furnished to do so, | ||
| // subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
| // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
| // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
| // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package testlib | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func SetAPIKey(t *testing.T) { | ||
| err := os.Setenv("OPENAI_API_KEY", "test") | ||
| require.NoError(t, err) | ||
|
|
||
| t.Cleanup(func() { | ||
| _ = os.Unsetenv("OPENAI_API_KEY") | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| // Copyright (c) 2023 Tim <tbckr> | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
| // this software and associated documentation files (the "Software"), to deal in | ||
| // the Software without restriction, including without limitation the rights to | ||
| // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
| // the Software, and to permit persons to whom the Software is furnished to do so, | ||
| // subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
| // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
| // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
| // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package testlib | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "github.com/jarcoal/httpmock" | ||
| ) | ||
|
|
||
| const ( | ||
| baseURL = "https://api.openai.com/v1" | ||
| chatCompletionSuffix = "/chat/completions" | ||
| ) | ||
|
|
||
| func RegisterExpectedChatResponse(response string) { | ||
| httpmock.RegisterResponder( | ||
| "POST", | ||
| fmt.Sprintf("%s%s", baseURL, chatCompletionSuffix), | ||
| httpmock.NewStringResponder( | ||
| 200, | ||
| fmt.Sprintf(`{ | ||
| "choices": [ | ||
| { | ||
| "index": 0, | ||
| "finish_reason": "length", | ||
| "message": { | ||
| "role": "assistant", | ||
| "content": "%s" | ||
| } | ||
| } | ||
| ] | ||
| }`, response), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| func RegisterExpectedChatResponseStream(response string) { | ||
| httpmock.RegisterResponder( | ||
| "POST", | ||
| fmt.Sprintf("%s%s", baseURL, chatCompletionSuffix), | ||
| func(request *http.Request) (*http.Response, error) { | ||
| // Reference: https://github.com/sashabaranov/go-openai/blob/a09cb0c528c110a6955a9ee9a5d021a57ed44b90/chat_stream_test.go#L39 | ||
| data := createStreamedMessages(response) | ||
| resp := httpmock.NewBytesResponse(200, data) | ||
| resp.Header.Set("Content-Type", "text/event-stream") | ||
| return resp, nil | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func createStreamedMessages(response string) []byte { | ||
| // Data is written in the format of Server-Sent Events (SSE). | ||
| // The first message is the event name, followed by the data. | ||
| // Right now, there are two events: "message" and "done". The "done" event is sent when the completion is finished. | ||
| const ( | ||
| eventMessage = "event: message\n" | ||
|
|
||
| dataMessageTemplate = "data: %s\n\n" | ||
| messageTemplate = `{"id":"1","object":"completion","created":1598069254,"model":"gpt-3.5-turbo","choices":[{"index":0,"delta":{"content":"%c"},"finish_reason":"max_tokens"}]}` | ||
|
|
||
| eventDone = "event: done\n" | ||
| dataDone = "data: [DONE]\n\n" | ||
| ) | ||
| var buff bytes.Buffer | ||
| for _, char := range response { | ||
| buff.WriteString(eventMessage) | ||
| buff.WriteString(fmt.Sprintf(dataMessageTemplate, fmt.Sprintf(messageTemplate, char))) | ||
| } | ||
| buff.WriteString(eventDone) | ||
| buff.WriteString(dataDone) | ||
|
|
||
| return buff.Bytes() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Copyright (c) 2023 Tim <tbckr> | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
| // this software and associated documentation files (the "Software"), to deal in | ||
| // the Software without restriction, including without limitation the rights to | ||
| // use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
| // the Software, and to permit persons to whom the Software is furnished to do so, | ||
| // subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
| // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
| // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
| // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package testlib | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/spf13/viper" | ||
| ) | ||
|
|
||
| type TestCtx struct { | ||
| Config *viper.Viper | ||
|
|
||
| ConfigDir string | ||
| CacheDir string | ||
| PersonasDir string | ||
| } | ||
|
|
||
| func NewTestCtx(t *testing.T) *TestCtx { | ||
| cacheDir := t.TempDir() | ||
| configDir := t.TempDir() | ||
| personasDir := t.TempDir() | ||
|
|
||
| config := viper.New() | ||
| config.AddConfigPath(configDir) | ||
| config.SetConfigName("config") | ||
| config.SetConfigType("yaml") | ||
| config.Set("cacheDir", cacheDir) | ||
| config.Set("personas", personasDir) | ||
| config.Set("TESTING", 1) | ||
|
|
||
| return &TestCtx{ | ||
| Config: config, | ||
| ConfigDir: configDir, | ||
| CacheDir: cacheDir, | ||
| PersonasDir: personasDir, | ||
| } | ||
| } |
Oops, something went wrong.