provider.go 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. // Package hyper provides a fantasy.Provider that proxies requests to Hyper.
  2. package hyper
  3. import (
  4. "bufio"
  5. "bytes"
  6. "cmp"
  7. "context"
  8. _ "embed"
  9. "encoding/json"
  10. "errors"
  11. "fmt"
  12. "io"
  13. "log/slog"
  14. "maps"
  15. "net/http"
  16. "net/url"
  17. "os"
  18. "strconv"
  19. "strings"
  20. "sync"
  21. "time"
  22. "charm.land/catwalk/pkg/catwalk"
  23. "charm.land/fantasy"
  24. "charm.land/fantasy/object"
  25. "github.com/charmbracelet/crush/internal/event"
  26. )
  27. //go:generate wget -O provider.json https://hyper.charm.land/api/v1/provider
  28. //go:embed provider.json
  29. var embedded []byte
  30. // Enabled returns true if hyper is enabled.
  31. var Enabled = sync.OnceValue(func() bool {
  32. b, _ := strconv.ParseBool(
  33. cmp.Or(
  34. os.Getenv("HYPER"),
  35. os.Getenv("HYPERCRUSH"),
  36. os.Getenv("HYPER_ENABLE"),
  37. os.Getenv("HYPER_ENABLED"),
  38. ),
  39. )
  40. return b
  41. })
  42. // Embedded returns the embedded Hyper provider.
  43. var Embedded = sync.OnceValue(func() catwalk.Provider {
  44. var provider catwalk.Provider
  45. if err := json.Unmarshal(embedded, &provider); err != nil {
  46. slog.Error("Could not use embedded provider data", "err", err)
  47. }
  48. if e := os.Getenv("HYPER_URL"); e != "" {
  49. provider.APIEndpoint = e + "/api/v1/fantasy"
  50. }
  51. return provider
  52. })
  53. const (
  54. // Name is the default name of this meta provider.
  55. Name = "hyper"
  56. // defaultBaseURL is the default proxy URL.
  57. defaultBaseURL = "https://hyper.charm.land"
  58. )
  59. // BaseURL returns the base URL, which is either $HYPER_URL or the default.
  60. var BaseURL = sync.OnceValue(func() string {
  61. return cmp.Or(os.Getenv("HYPER_URL"), defaultBaseURL)
  62. })
  63. var (
  64. ErrNoCredits = errors.New("you're out of credits")
  65. ErrUnauthorized = errors.New("unauthorized")
  66. )
  67. type options struct {
  68. baseURL string
  69. apiKey string
  70. name string
  71. headers map[string]string
  72. client *http.Client
  73. }
  74. // Option configures the proxy provider.
  75. type Option = func(*options)
  76. // New creates a new proxy provider.
  77. func New(opts ...Option) (fantasy.Provider, error) {
  78. o := options{
  79. baseURL: BaseURL() + "/api/v1/fantasy",
  80. name: Name,
  81. headers: map[string]string{
  82. "x-crush-id": event.GetID(),
  83. },
  84. client: &http.Client{Timeout: 0}, // stream-safe
  85. }
  86. for _, opt := range opts {
  87. opt(&o)
  88. }
  89. return &provider{options: o}, nil
  90. }
  91. // WithBaseURL sets the proxy base URL (e.g. http://localhost:8080).
  92. func WithBaseURL(url string) Option { return func(o *options) { o.baseURL = url } }
  93. // WithName sets the provider name.
  94. func WithName(name string) Option { return func(o *options) { o.name = name } }
  95. // WithHeaders sets extra headers sent to the proxy.
  96. func WithHeaders(headers map[string]string) Option {
  97. return func(o *options) {
  98. maps.Copy(o.headers, headers)
  99. }
  100. }
  101. // WithHTTPClient sets custom HTTP client.
  102. func WithHTTPClient(c *http.Client) Option { return func(o *options) { o.client = c } }
  103. // WithAPIKey sets the API key.
  104. func WithAPIKey(key string) Option {
  105. return func(o *options) {
  106. o.apiKey = key
  107. }
  108. }
  109. type provider struct{ options options }
  110. func (p *provider) Name() string { return p.options.name }
  111. // LanguageModel implements fantasy.Provider.
  112. func (p *provider) LanguageModel(_ context.Context, modelID string) (fantasy.LanguageModel, error) {
  113. if modelID == "" {
  114. return nil, errors.New("missing model id")
  115. }
  116. return &languageModel{modelID: modelID, provider: p.options.name, opts: p.options}, nil
  117. }
  118. type languageModel struct {
  119. provider string
  120. modelID string
  121. opts options
  122. }
  123. // GenerateObject implements fantasy.LanguageModel.
  124. func (m *languageModel) GenerateObject(ctx context.Context, call fantasy.ObjectCall) (*fantasy.ObjectResponse, error) {
  125. return object.GenerateWithTool(ctx, m, call)
  126. }
  127. // StreamObject implements fantasy.LanguageModel.
  128. func (m *languageModel) StreamObject(ctx context.Context, call fantasy.ObjectCall) (fantasy.ObjectStreamResponse, error) {
  129. return object.StreamWithTool(ctx, m, call)
  130. }
  131. func (m *languageModel) Provider() string { return m.provider }
  132. func (m *languageModel) Model() string { return m.modelID }
  133. // Generate implements fantasy.LanguageModel by calling the proxy JSON endpoint.
  134. func (m *languageModel) Generate(ctx context.Context, call fantasy.Call) (*fantasy.Response, error) {
  135. resp, err := m.doRequest(ctx, false, call)
  136. if err != nil {
  137. return nil, err
  138. }
  139. defer func() { _ = resp.Body.Close() }()
  140. if resp.StatusCode < 200 || resp.StatusCode >= 300 {
  141. b, _ := ioReadAllLimit(resp.Body, 64*1024)
  142. return nil, fmt.Errorf("proxy generate error: %s", strings.TrimSpace(string(b)))
  143. }
  144. var out fantasy.Response
  145. if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
  146. return nil, err
  147. }
  148. return &out, nil
  149. }
  150. // Stream implements fantasy.LanguageModel using SSE from the proxy.
  151. func (m *languageModel) Stream(ctx context.Context, call fantasy.Call) (fantasy.StreamResponse, error) {
  152. // Prefer explicit /stream endpoint
  153. resp, err := m.doRequest(ctx, true, call)
  154. if err != nil {
  155. return nil, err
  156. }
  157. switch resp.StatusCode {
  158. case http.StatusTooManyRequests:
  159. _ = resp.Body.Close()
  160. return nil, toProviderError(resp, retryAfter(resp))
  161. case http.StatusUnauthorized:
  162. _ = resp.Body.Close()
  163. return nil, ErrUnauthorized
  164. case http.StatusPaymentRequired:
  165. _ = resp.Body.Close()
  166. return nil, ErrNoCredits
  167. }
  168. if resp.StatusCode < 200 || resp.StatusCode >= 300 {
  169. defer func() { _ = resp.Body.Close() }()
  170. b, _ := ioReadAllLimit(resp.Body, 64*1024)
  171. return nil, &fantasy.ProviderError{
  172. Title: "Stream Error",
  173. Message: strings.TrimSpace(string(b)),
  174. StatusCode: resp.StatusCode,
  175. }
  176. }
  177. return func(yield func(fantasy.StreamPart) bool) {
  178. defer func() { _ = resp.Body.Close() }()
  179. scanner := bufio.NewScanner(resp.Body)
  180. buf := make([]byte, 0, 64*1024)
  181. scanner.Buffer(buf, 4*1024*1024)
  182. var (
  183. event string
  184. dataBuf bytes.Buffer
  185. sawFinish bool
  186. dispatch = func() bool {
  187. if dataBuf.Len() == 0 || event == "" {
  188. dataBuf.Reset()
  189. event = ""
  190. return true
  191. }
  192. var part fantasy.StreamPart
  193. if err := json.Unmarshal(dataBuf.Bytes(), &part); err != nil {
  194. return yield(fantasy.StreamPart{Type: fantasy.StreamPartTypeError, Error: err})
  195. }
  196. if part.Type == fantasy.StreamPartTypeFinish {
  197. sawFinish = true
  198. }
  199. ok := yield(part)
  200. dataBuf.Reset()
  201. event = ""
  202. return ok
  203. }
  204. )
  205. for scanner.Scan() {
  206. line := scanner.Text()
  207. if line == "" { // event boundary
  208. if !dispatch() {
  209. return
  210. }
  211. continue
  212. }
  213. if strings.HasPrefix(line, ":") { // comment / ping
  214. continue
  215. }
  216. if strings.HasPrefix(line, "event: ") {
  217. event = strings.TrimSpace(line[len("event: "):])
  218. continue
  219. }
  220. if strings.HasPrefix(line, "data: ") {
  221. if dataBuf.Len() > 0 {
  222. dataBuf.WriteByte('\n')
  223. }
  224. dataBuf.WriteString(line[len("data: "):])
  225. continue
  226. }
  227. }
  228. if err := scanner.Err(); err != nil {
  229. if sawFinish && (errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded)) {
  230. // If we already saw an explicit finish event, treat cancellation as a no-op.
  231. } else {
  232. _ = yield(fantasy.StreamPart{Type: fantasy.StreamPartTypeError, Error: err})
  233. return
  234. }
  235. }
  236. if err := ctx.Err(); err != nil && !sawFinish {
  237. _ = yield(fantasy.StreamPart{Type: fantasy.StreamPartTypeError, Error: err})
  238. return
  239. }
  240. // flush any pending data
  241. _ = dispatch()
  242. if !sawFinish {
  243. _ = yield(fantasy.StreamPart{Type: fantasy.StreamPartTypeFinish})
  244. }
  245. }, nil
  246. }
  247. func (m *languageModel) doRequest(ctx context.Context, stream bool, call fantasy.Call) (*http.Response, error) {
  248. addr, err := url.Parse(m.opts.baseURL)
  249. if err != nil {
  250. return nil, err
  251. }
  252. addr = addr.JoinPath(m.modelID)
  253. if stream {
  254. addr = addr.JoinPath("stream")
  255. } else {
  256. addr = addr.JoinPath("generate")
  257. }
  258. body, err := json.Marshal(call)
  259. if err != nil {
  260. return nil, err
  261. }
  262. req, err := http.NewRequestWithContext(ctx, http.MethodPost, addr.String(), bytes.NewReader(body))
  263. if err != nil {
  264. return nil, err
  265. }
  266. req.Header.Set("Content-Type", "application/json")
  267. if stream {
  268. req.Header.Set("Accept", "text/event-stream")
  269. } else {
  270. req.Header.Set("Accept", "application/json")
  271. }
  272. for k, v := range m.opts.headers {
  273. req.Header.Set(k, v)
  274. }
  275. if m.opts.apiKey != "" {
  276. req.Header.Set("Authorization", m.opts.apiKey)
  277. }
  278. return m.opts.client.Do(req)
  279. }
  280. // ioReadAllLimit reads up to n bytes.
  281. func ioReadAllLimit(r io.Reader, n int64) ([]byte, error) {
  282. var b bytes.Buffer
  283. if n <= 0 {
  284. n = 1 << 20
  285. }
  286. lr := &io.LimitedReader{R: r, N: n}
  287. _, err := b.ReadFrom(lr)
  288. return b.Bytes(), err
  289. }
  290. func toProviderError(resp *http.Response, message string) error {
  291. return &fantasy.ProviderError{
  292. Title: fantasy.ErrorTitleForStatusCode(resp.StatusCode),
  293. Message: message,
  294. StatusCode: resp.StatusCode,
  295. }
  296. }
  297. func retryAfter(resp *http.Response) string {
  298. after, err := strconv.Atoi(resp.Header.Get("Retry-After"))
  299. if err == nil && after > 0 {
  300. d := time.Duration(after) * time.Second
  301. return "Try again in " + d.String()
  302. }
  303. return "Try again later"
  304. }