rpc/haberdasher/service.twirp.go (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
// Code generated by protoc-gen-twirp v8.1.3, DO NOT EDIT. // source: rpc/haberdasher/service.proto package haberdasher import context "context" import fmt "fmt" import http "net/http" import io "io" import json "encoding/json" import strconv "strconv" import strings "strings" import protojson "google.golang.org/protobuf/encoding/protojson" import proto "google.golang.org/protobuf/proto" import twirp "github.com/twitchtv/twirp" import ctxsetters "github.com/twitchtv/twirp/ctxsetters" import bytes "bytes" import errors "errors" import path "path" import url "net/url" // Version compatibility assertion. // If the constant is not defined in the package, that likely means // the package needs to be updated to work with this generated code. // See https://twitchtv.github.io/twirp/docs/version_matrix.html const _ = twirp.TwirpPackageMinVersion_8_1_0 // ===================== // Haberdasher Interface // ===================== // Haberdasher service makes hats for clients. type Haberdasher interface { // MakeHat produces a hat of mysterious, randomly-selected color! MakeHat(context.Context, *Size) (*Hat, error) } // =========================== // Haberdasher Protobuf Client // =========================== type haberdasherProtobufClient struct { client HTTPClient urls [1]string interceptor twirp.Interceptor opts twirp.ClientOptions } // NewHaberdasherProtobufClient creates a Protobuf client that implements the Haberdasher interface. // It communicates using Protobuf and can be configured with a custom HTTPClient. func NewHaberdasherProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher { if c, ok := client.(*http.Client); ok { client = withoutRedirects(c) } clientOpts := twirp.ClientOptions{} for _, o := range opts { o(&clientOpts) } // Using ReadOpt allows backwards and forwards compatibility with new options in the future literalURLs := false _ = clientOpts.ReadOpt("literalURLs", &literalURLs) var pathPrefix string if ok := clientOpts.ReadOpt("pathPrefix", &pathPrefix); !ok { pathPrefix = "/twirp" // default prefix } // Build method URLs: <baseURL>[<prefix>]/<package>.<Service>/<Method> serviceURL := sanitizeBaseURL(baseURL) serviceURL += baseServicePath(pathPrefix, "twirp.example.haberdasher", "Haberdasher") urls := [1]string{ serviceURL + "MakeHat", } return &haberdasherProtobufClient{ client: client, urls: urls, interceptor: twirp.ChainInterceptors(clientOpts.Interceptors...), opts: clientOpts, } } func (c *haberdasherProtobufClient) MakeHat(ctx context.Context, in *Size) (*Hat, error) { ctx = ctxsetters.WithPackageName(ctx, "twirp.example.haberdasher") ctx = ctxsetters.WithServiceName(ctx, "Haberdasher") ctx = ctxsetters.WithMethodName(ctx, "MakeHat") caller := c.callMakeHat if c.interceptor != nil { caller = func(ctx context.Context, req *Size) (*Hat, error) { resp, err := c.interceptor( func(ctx context.Context, req interface{}) (interface{}, error) { typedReq, ok := req.(*Size) if !ok { return nil, twirp.InternalError("failed type assertion req.(*Size) when calling interceptor") } return c.callMakeHat(ctx, typedReq) }, )(ctx, req) if resp != nil { typedResp, ok := resp.(*Hat) if !ok { return nil, twirp.InternalError("failed type assertion resp.(*Hat) when calling interceptor") } return typedResp, err } return nil, err } } return caller(ctx, in) } func (c *haberdasherProtobufClient) callMakeHat(ctx context.Context, in *Size) (*Hat, error) { out := new(Hat) ctx, err := doProtobufRequest(ctx, c.client, c.opts.Hooks, c.urls[0], in, out) if err != nil { twerr, ok := err.(twirp.Error) if !ok { twerr = twirp.InternalErrorWith(err) } callClientError(ctx, c.opts.Hooks, twerr) return nil, err } callClientResponseReceived(ctx, c.opts.Hooks) return out, nil } // ======================= // Haberdasher JSON Client // ======================= type haberdasherJSONClient struct { client HTTPClient urls [1]string interceptor twirp.Interceptor opts twirp.ClientOptions } // NewHaberdasherJSONClient creates a JSON client that implements the Haberdasher interface. // It communicates using JSON and can be configured with a custom HTTPClient. func NewHaberdasherJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Haberdasher { if c, ok := client.(*http.Client); ok { client = withoutRedirects(c) } clientOpts := twirp.ClientOptions{} for _, o := range opts { o(&clientOpts) } // Using ReadOpt allows backwards and forwards compatibility with new options in the future literalURLs := false _ = clientOpts.ReadOpt("literalURLs", &literalURLs) var pathPrefix string if ok := clientOpts.ReadOpt("pathPrefix", &pathPrefix); !ok { pathPrefix = "/twirp" // default prefix } // Build method URLs: <baseURL>[<prefix>]/<package>.<Service>/<Method> serviceURL := sanitizeBaseURL(baseURL) serviceURL += baseServicePath(pathPrefix, "twirp.example.haberdasher", "Haberdasher") urls := [1]string{ serviceURL + "MakeHat", } return &haberdasherJSONClient{ client: client, urls: urls, interceptor: twirp.ChainInterceptors(clientOpts.Interceptors...), opts: clientOpts, } } func (c *haberdasherJSONClient) MakeHat(ctx context.Context, in *Size) (*Hat, error) { ctx = ctxsetters.WithPackageName(ctx, "twirp.example.haberdasher") ctx = ctxsetters.WithServiceName(ctx, "Haberdasher") ctx = ctxsetters.WithMethodName(ctx, "MakeHat") caller := c.callMakeHat if c.interceptor != nil { caller = func(ctx context.Context, req *Size) (*Hat, error) { resp, err := c.interceptor( func(ctx context.Context, req interface{}) (interface{}, error) { typedReq, ok := req.(*Size) if !ok { return nil, twirp.InternalError("failed type assertion req.(*Size) when calling interceptor") } return c.callMakeHat(ctx, typedReq) }, )(ctx, req) if resp != nil { typedResp, ok := resp.(*Hat) if !ok { return nil, twirp.InternalError("failed type assertion resp.(*Hat) when calling interceptor") } return typedResp, err } return nil, err } } return caller(ctx, in) } func (c *haberdasherJSONClient) callMakeHat(ctx context.Context, in *Size) (*Hat, error) { out := new(Hat) ctx, err := doJSONRequest(ctx, c.client, c.opts.Hooks, c.urls[0], in, out) if err != nil { twerr, ok := err.(twirp.Error) if !ok { twerr = twirp.InternalErrorWith(err) } callClientError(ctx, c.opts.Hooks, twerr) return nil, err } callClientResponseReceived(ctx, c.opts.Hooks) return out, nil } // ========================== // Haberdasher Server Handler // ========================== type haberdasherServer struct { Haberdasher interceptor twirp.Interceptor hooks *twirp.ServerHooks pathPrefix string // prefix for routing jsonSkipDefaults bool // do not include unpopulated fields (default values) in the response jsonCamelCase bool // JSON fields are serialized as lowerCamelCase rather than keeping the original proto names } // NewHaberdasherServer builds a TwirpServer that can be used as an http.Handler to handle // HTTP requests that are routed to the right method in the provided svc implementation. // The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks). func NewHaberdasherServer(svc Haberdasher, opts ...interface{}) TwirpServer { serverOpts := newServerOpts(opts) // Using ReadOpt allows backwards and forwards compatibility with new options in the future jsonSkipDefaults := false _ = serverOpts.ReadOpt("jsonSkipDefaults", &jsonSkipDefaults) jsonCamelCase := false _ = serverOpts.ReadOpt("jsonCamelCase", &jsonCamelCase) var pathPrefix string if ok := serverOpts.ReadOpt("pathPrefix", &pathPrefix); !ok { pathPrefix = "/twirp" // default prefix } return &haberdasherServer{ Haberdasher: svc, hooks: serverOpts.Hooks, interceptor: twirp.ChainInterceptors(serverOpts.Interceptors...), pathPrefix: pathPrefix, jsonSkipDefaults: jsonSkipDefaults, jsonCamelCase: jsonCamelCase, } } // writeError writes an HTTP response with a valid Twirp error format, and triggers hooks. // If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err) func (s *haberdasherServer) writeError(ctx context.Context, resp http.ResponseWriter, err error) { writeError(ctx, resp, err, s.hooks) } // handleRequestBodyError is used to handle error when the twirp server cannot read request func (s *haberdasherServer) handleRequestBodyError(ctx context.Context, resp http.ResponseWriter, msg string, err error) { if context.Canceled == ctx.Err() { s.writeError(ctx, resp, twirp.NewError(twirp.Canceled, "failed to read request: context canceled")) return } if context.DeadlineExceeded == ctx.Err() { s.writeError(ctx, resp, twirp.NewError(twirp.DeadlineExceeded, "failed to read request: deadline exceeded")) return } s.writeError(ctx, resp, twirp.WrapError(malformedRequestError(msg), err)) } // HaberdasherPathPrefix is a convenience constant that may identify URL paths. // Should be used with caution, it only matches routes generated by Twirp Go clients, // with the default "/twirp" prefix and default CamelCase service and method names. // More info: https://twitchtv.github.io/twirp/docs/routing.html const HaberdasherPathPrefix = "/twirp/twirp.example.haberdasher.Haberdasher/" func (s *haberdasherServer) ServeHTTP(resp http.ResponseWriter, req *http.Request) { ctx := req.Context() ctx = ctxsetters.WithPackageName(ctx, "twirp.example.haberdasher") ctx = ctxsetters.WithServiceName(ctx, "Haberdasher") ctx = ctxsetters.WithResponseWriter(ctx, resp) var err error ctx, err = callRequestReceived(ctx, s.hooks) if err != nil { s.writeError(ctx, resp, err) return } if req.Method != "POST" { msg := fmt.Sprintf("unsupported method %q (only POST is allowed)", req.Method) s.writeError(ctx, resp, badRouteError(msg, req.Method, req.URL.Path)) return } // Verify path format: [<prefix>]/<package>.<Service>/<Method> prefix, pkgService, method := parseTwirpPath(req.URL.Path) if pkgService != "twirp.example.haberdasher.Haberdasher" { msg := fmt.Sprintf("no handler for path %q", req.URL.Path) s.writeError(ctx, resp, badRouteError(msg, req.Method, req.URL.Path)) return } if prefix != s.pathPrefix { msg := fmt.Sprintf("invalid path prefix %q, expected %q, on path %q", prefix, s.pathPrefix, req.URL.Path) s.writeError(ctx, resp, badRouteError(msg, req.Method, req.URL.Path)) return } switch method { case "MakeHat": s.serveMakeHat(ctx, resp, req) return default: msg := fmt.Sprintf("no handler for path %q", req.URL.Path) s.writeError(ctx, resp, badRouteError(msg, req.Method, req.URL.Path)) return } } func (s *haberdasherServer) serveMakeHat(ctx context.Context, resp http.ResponseWriter, req *http.Request) { header := req.Header.Get("Content-Type") i := strings.Index(header, ";") if i == -1 { i = len(header) } switch strings.TrimSpace(strings.ToLower(header[:i])) { case "application/json": s.serveMakeHatJSON(ctx, resp, req) case "application/protobuf": s.serveMakeHatProtobuf(ctx, resp, req) default: msg := fmt.Sprintf("unexpected Content-Type: %q", req.Header.Get("Content-Type")) twerr := badRouteError(msg, req.Method, req.URL.Path) s.writeError(ctx, resp, twerr) } } func (s *haberdasherServer) serveMakeHatJSON(ctx context.Context, resp http.ResponseWriter, req *http.Request) { var err error ctx = ctxsetters.WithMethodName(ctx, "MakeHat") ctx, err = callRequestRouted(ctx, s.hooks) if err != nil { s.writeError(ctx, resp, err) return } d := json.NewDecoder(req.Body) rawReqBody := json.RawMessage{} if err := d.Decode(&rawReqBody); err != nil { s.handleRequestBodyError(ctx, resp, "the json request could not be decoded", err) return } reqContent := new(Size) unmarshaler := protojson.UnmarshalOptions{DiscardUnknown: true} if err = unmarshaler.Unmarshal(rawReqBody, reqContent); err != nil { s.handleRequestBodyError(ctx, resp, "the json request could not be decoded", err) return } handler := s.Haberdasher.MakeHat if s.interceptor != nil { handler = func(ctx context.Context, req *Size) (*Hat, error) { resp, err := s.interceptor( func(ctx context.Context, req interface{}) (interface{}, error) { typedReq, ok := req.(*Size) if !ok { return nil, twirp.InternalError("failed type assertion req.(*Size) when calling interceptor") } return s.Haberdasher.MakeHat(ctx, typedReq) }, )(ctx, req) if resp != nil { typedResp, ok := resp.(*Hat) if !ok { return nil, twirp.InternalError("failed type assertion resp.(*Hat) when calling interceptor") } return typedResp, err } return nil, err } } // Call service method var respContent *Hat func() { defer ensurePanicResponses(ctx, resp, s.hooks) respContent, err = handler(ctx, reqContent) }() if err != nil { s.writeError(ctx, resp, err) return } if respContent == nil { s.writeError(ctx, resp, twirp.InternalError("received a nil *Hat and nil error while calling MakeHat. nil responses are not supported")) return } ctx = callResponsePrepared(ctx, s.hooks) marshaler := &protojson.MarshalOptions{UseProtoNames: !s.jsonCamelCase, EmitUnpopulated: !s.jsonSkipDefaults} respBytes, err := marshaler.Marshal(respContent) if err != nil { s.writeError(ctx, resp, wrapInternal(err, "failed to marshal json response")) return } ctx = ctxsetters.WithStatusCode(ctx, http.StatusOK) resp.Header().Set("Content-Type", "application/json") resp.Header().Set("Content-Length", strconv.Itoa(len(respBytes))) resp.WriteHeader(http.StatusOK) if n, err := resp.Write(respBytes); err != nil { msg := fmt.Sprintf("failed to write response, %d of %d bytes written: %s", n, len(respBytes), err.Error()) twerr := twirp.NewError(twirp.Unknown, msg) ctx = callError(ctx, s.hooks, twerr) } callResponseSent(ctx, s.hooks) } func (s *haberdasherServer) serveMakeHatProtobuf(ctx context.Context, resp http.ResponseWriter, req *http.Request) { var err error ctx = ctxsetters.WithMethodName(ctx, "MakeHat") ctx, err = callRequestRouted(ctx, s.hooks) if err != nil { s.writeError(ctx, resp, err) return } buf, err := io.ReadAll(req.Body) if err != nil { s.handleRequestBodyError(ctx, resp, "failed to read request body", err) return } reqContent := new(Size) if err = proto.Unmarshal(buf, reqContent); err != nil { s.writeError(ctx, resp, malformedRequestError("the protobuf request could not be decoded")) return } handler := s.Haberdasher.MakeHat if s.interceptor != nil { handler = func(ctx context.Context, req *Size) (*Hat, error) { resp, err := s.interceptor( func(ctx context.Context, req interface{}) (interface{}, error) { typedReq, ok := req.(*Size) if !ok { return nil, twirp.InternalError("failed type assertion req.(*Size) when calling interceptor") } return s.Haberdasher.MakeHat(ctx, typedReq) }, )(ctx, req) if resp != nil { typedResp, ok := resp.(*Hat) if !ok { return nil, twirp.InternalError("failed type assertion resp.(*Hat) when calling interceptor") } return typedResp, err } return nil, err } } // Call service method var respContent *Hat func() { defer ensurePanicResponses(ctx, resp, s.hooks) respContent, err = handler(ctx, reqContent) }() if err != nil { s.writeError(ctx, resp, err) return } if respContent == nil { s.writeError(ctx, resp, twirp.InternalError("received a nil *Hat and nil error while calling MakeHat. nil responses are not supported")) return } ctx = callResponsePrepared(ctx, s.hooks) respBytes, err := proto.Marshal(respContent) if err != nil { s.writeError(ctx, resp, wrapInternal(err, "failed to marshal proto response")) return } ctx = ctxsetters.WithStatusCode(ctx, http.StatusOK) resp.Header().Set("Content-Type", "application/protobuf") resp.Header().Set("Content-Length", strconv.Itoa(len(respBytes))) resp.WriteHeader(http.StatusOK) if n, err := resp.Write(respBytes); err != nil { msg := fmt.Sprintf("failed to write response, %d of %d bytes written: %s", n, len(respBytes), err.Error()) twerr := twirp.NewError(twirp.Unknown, msg) ctx = callError(ctx, s.hooks, twerr) } callResponseSent(ctx, s.hooks) } func (s *haberdasherServer) ServiceDescriptor() ([]byte, int) { return twirpFileDescriptor0, 0 } func (s *haberdasherServer) ProtocGenTwirpVersion() string { return "v8.1.3" } // PathPrefix returns the base service path, in the form: "/<prefix>/<package>.<Service>/" // that is everything in a Twirp route except for the <Method>. This can be used for routing, // for example to identify the requests that are targeted to this service in a mux. func (s *haberdasherServer) PathPrefix() string { return baseServicePath(s.pathPrefix, "twirp.example.haberdasher", "Haberdasher") } // ===== // Utils // ===== // HTTPClient is the interface used by generated clients to send HTTP requests. // It is fulfilled by *(net/http).Client, which is sufficient for most users. // Users can provide their own implementation for special retry policies. // // HTTPClient implementations should not follow redirects. Redirects are // automatically disabled if *(net/http).Client is passed to client // constructors. See the withoutRedirects function in this file for more // details. type HTTPClient interface { Do(req *http.Request) (*http.Response, error) } // TwirpServer is the interface generated server structs will support: they're // HTTP handlers with additional methods for accessing metadata about the // service. Those accessors are a low-level API for building reflection tools. // Most people can think of TwirpServers as just http.Handlers. type TwirpServer interface { http.Handler // ServiceDescriptor returns gzipped bytes describing the .proto file that // this service was generated from. Once unzipped, the bytes can be // unmarshalled as a // google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto. // // The returned integer is the index of this particular service within that // FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a // low-level field, expected to be used for reflection. ServiceDescriptor() ([]byte, int) // ProtocGenTwirpVersion is the semantic version string of the version of // twirp used to generate this file. ProtocGenTwirpVersion() string // PathPrefix returns the HTTP URL path prefix for all methods handled by this // service. This can be used with an HTTP mux to route Twirp requests. // The path prefix is in the form: "/<prefix>/<package>.<Service>/" // that is, everything in a Twirp route except for the <Method> at the end. PathPrefix() string } func newServerOpts(opts []interface{}) *twirp.ServerOptions { serverOpts := &twirp.ServerOptions{} for _, opt := range opts { switch o := opt.(type) { case twirp.ServerOption: o(serverOpts) case *twirp.ServerHooks: // backwards compatibility, allow to specify hooks as an argument twirp.WithServerHooks(o)(serverOpts) case nil: // backwards compatibility, allow nil value for the argument continue default: panic(fmt.Sprintf("Invalid option type %T, please use a twirp.ServerOption", o)) } } return serverOpts } // WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). // Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. // If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err) func WriteError(resp http.ResponseWriter, err error) { writeError(context.Background(), resp, err, nil) } // writeError writes Twirp errors in the response and triggers hooks. func writeError(ctx context.Context, resp http.ResponseWriter, err error, hooks *twirp.ServerHooks) { // Convert to a twirp.Error. Non-twirp errors are converted to internal errors. var twerr twirp.Error if !errors.As(err, &twerr) { twerr = twirp.InternalErrorWith(err) } statusCode := twirp.ServerHTTPStatusFromErrorCode(twerr.Code()) ctx = ctxsetters.WithStatusCode(ctx, statusCode) ctx = callError(ctx, hooks, twerr) respBody := marshalErrorToJSON(twerr) resp.Header().Set("Content-Type", "application/json") // Error responses are always JSON resp.Header().Set("Content-Length", strconv.Itoa(len(respBody))) resp.WriteHeader(statusCode) // set HTTP status code and send response _, writeErr := resp.Write(respBody) if writeErr != nil { // We have three options here. We could log the error, call the Error // hook, or just silently ignore the error. // // Logging is unacceptable because we don't have a user-controlled // logger; writing out to stderr without permission is too rude. // // Calling the Error hook would confuse users: it would mean the Error // hook got called twice for one request, which is likely to lead to // duplicated log messages and metrics, no matter how well we document // the behavior. // // Silently ignoring the error is our least-bad option. It's highly // likely that the connection is broken and the original 'err' says // so anyway. _ = writeErr } callResponseSent(ctx, hooks) } // sanitizeBaseURL parses the the baseURL, and adds the "http" scheme if needed. // If the URL is unparsable, the baseURL is returned unchanged. func sanitizeBaseURL(baseURL string) string { u, err := url.Parse(baseURL) if err != nil { return baseURL // invalid URL will fail later when making requests } if u.Scheme == "" { u.Scheme = "http" } return u.String() } // baseServicePath composes the path prefix for the service (without <Method>). // e.g.: baseServicePath("/twirp", "my.pkg", "MyService") // // returns => "/twirp/my.pkg.MyService/" // // e.g.: baseServicePath("", "", "MyService") // // returns => "/MyService/" func baseServicePath(prefix, pkg, service string) string { fullServiceName := service if pkg != "" { fullServiceName = pkg + "." + service } return path.Join("/", prefix, fullServiceName) + "/" } // parseTwirpPath extracts path components form a valid Twirp route. // Expected format: "[<prefix>]/<package>.<Service>/<Method>" // e.g.: prefix, pkgService, method := parseTwirpPath("/twirp/pkg.Svc/MakeHat") func parseTwirpPath(path string) (string, string, string) { parts := strings.Split(path, "/") if len(parts) < 2 { return "", "", "" } method := parts[len(parts)-1] pkgService := parts[len(parts)-2] prefix := strings.Join(parts[0:len(parts)-2], "/") return prefix, pkgService, method } // getCustomHTTPReqHeaders retrieves a copy of any headers that are set in // a context through the twirp.WithHTTPRequestHeaders function. // If there are no headers set, or if they have the wrong type, nil is returned. func getCustomHTTPReqHeaders(ctx context.Context) http.Header { header, ok := twirp.HTTPRequestHeaders(ctx) if !ok || header == nil { return nil } copied := make(http.Header) for k, vv := range header { if vv == nil { copied[k] = nil continue } copied[k] = make([]string, len(vv)) copy(copied[k], vv) } return copied } // newRequest makes an http.Request from a client, adding common headers. func newRequest(ctx context.Context, url string, reqBody io.Reader, contentType string) (*http.Request, error) { req, err := http.NewRequest("POST", url, reqBody) if err != nil { return nil, err } req = req.WithContext(ctx) if customHeader := getCustomHTTPReqHeaders(ctx); customHeader != nil { req.Header = customHeader } req.Header.Set("Accept", contentType) req.Header.Set("Content-Type", contentType) req.Header.Set("Twirp-Version", "v8.1.3") return req, nil } // JSON serialization for errors type twerrJSON struct { Code string `json:"code"` Msg string `json:"msg"` Meta map[string]string `json:"meta,omitempty"` } // marshalErrorToJSON returns JSON from a twirp.Error, that can be used as HTTP error response body. // If serialization fails, it will use a descriptive Internal error instead. func marshalErrorToJSON(twerr twirp.Error) []byte { // make sure that msg is not too large msg := twerr.Msg() if len(msg) > 1e6 { msg = msg[:1e6] } tj := twerrJSON{ Code: string(twerr.Code()), Msg: msg, Meta: twerr.MetaMap(), } buf, err := json.Marshal(&tj) if err != nil { buf = []byte("{\"type\": \"" + twirp.Internal + "\", \"msg\": \"There was an error but it could not be serialized into JSON\"}") // fallback } return buf } // errorFromResponse builds a twirp.Error from a non-200 HTTP response. // If the response has a valid serialized Twirp error, then it's returned. // If not, the response status code is used to generate a similar twirp // error. See twirpErrorFromIntermediary for more info on intermediary errors. func errorFromResponse(resp *http.Response) twirp.Error { statusCode := resp.StatusCode statusText := http.StatusText(statusCode) if isHTTPRedirect(statusCode) { // Unexpected redirect: it must be an error from an intermediary. // Twirp clients don't follow redirects automatically, Twirp only handles // POST requests, redirects should only happen on GET and HEAD requests. location := resp.Header.Get("Location") msg := fmt.Sprintf("unexpected HTTP status code %d %q received, Location=%q", statusCode, statusText, location) return twirpErrorFromIntermediary(statusCode, msg, location) } respBodyBytes, err := io.ReadAll(resp.Body) if err != nil { return wrapInternal(err, "failed to read server error response body") } var tj twerrJSON dec := json.NewDecoder(bytes.NewReader(respBodyBytes)) dec.DisallowUnknownFields() if err := dec.Decode(&tj); err != nil || tj.Code == "" { // Invalid JSON response; it must be an error from an intermediary. msg := fmt.Sprintf("Error from intermediary with HTTP status code %d %q", statusCode, statusText) return twirpErrorFromIntermediary(statusCode, msg, string(respBodyBytes)) } errorCode := twirp.ErrorCode(tj.Code) if !twirp.IsValidErrorCode(errorCode) { msg := "invalid type returned from server error response: " + tj.Code return twirp.InternalError(msg).WithMeta("body", string(respBodyBytes)) } twerr := twirp.NewError(errorCode, tj.Msg) for k, v := range tj.Meta { twerr = twerr.WithMeta(k, v) } return twerr } // twirpErrorFromIntermediary maps HTTP errors from non-twirp sources to twirp errors. // The mapping is similar to gRPC: https://github.com/grpc/grpc/blob/master/doc/http-grpc-status-mapping.md. // Returned twirp Errors have some additional metadata for inspection. func twirpErrorFromIntermediary(status int, msg string, bodyOrLocation string) twirp.Error { var code twirp.ErrorCode if isHTTPRedirect(status) { // 3xx code = twirp.Internal } else { switch status { case 400: // Bad Request code = twirp.Internal case 401: // Unauthorized code = twirp.Unauthenticated case 403: // Forbidden code = twirp.PermissionDenied case 404: // Not Found code = twirp.BadRoute case 429: // Too Many Requests code = twirp.ResourceExhausted case 502, 503, 504: // Bad Gateway, Service Unavailable, Gateway Timeout code = twirp.Unavailable default: // All other codes code = twirp.Unknown } } twerr := twirp.NewError(code, msg) twerr = twerr.WithMeta("http_error_from_intermediary", "true") // to easily know if this error was from intermediary twerr = twerr.WithMeta("status_code", strconv.Itoa(status)) if isHTTPRedirect(status) { twerr = twerr.WithMeta("location", bodyOrLocation) } else { twerr = twerr.WithMeta("body", bodyOrLocation) } return twerr } func isHTTPRedirect(status int) bool { return status >= 300 && status <= 399 } // wrapInternal wraps an error with a prefix as an Internal error. // The original error cause is accessible by github.com/pkg/errors.Cause. func wrapInternal(err error, prefix string) twirp.Error { return twirp.InternalErrorWith(&wrappedError{prefix: prefix, cause: err}) } type wrappedError struct { prefix string cause error } func (e *wrappedError) Error() string { return e.prefix + ": " + e.cause.Error() } func (e *wrappedError) Unwrap() error { return e.cause } // for go1.13 + errors.Is/As func (e *wrappedError) Cause() error { return e.cause } // for github.com/pkg/errors // ensurePanicResponses makes sure that rpc methods causing a panic still result in a Twirp Internal // error response (status 500), and error hooks are properly called with the panic wrapped as an error. // The panic is re-raised so it can be handled normally with middleware. func ensurePanicResponses(ctx context.Context, resp http.ResponseWriter, hooks *twirp.ServerHooks) { if r := recover(); r != nil { // Wrap the panic as an error so it can be passed to error hooks. // The original error is accessible from error hooks, but not visible in the response. err := errFromPanic(r) twerr := &internalWithCause{msg: "Internal service panic", cause: err} // Actually write the error writeError(ctx, resp, twerr, hooks) // If possible, flush the error to the wire. f, ok := resp.(http.Flusher) if ok { f.Flush() } panic(r) } } // errFromPanic returns the typed error if the recovered panic is an error, otherwise formats as error. func errFromPanic(p interface{}) error { if err, ok := p.(error); ok { return err } return fmt.Errorf("panic: %v", p) } // internalWithCause is a Twirp Internal error wrapping an original error cause, // but the original error message is not exposed on Msg(). The original error // can be checked with go1.13+ errors.Is/As, and also by (github.com/pkg/errors).Unwrap type internalWithCause struct { msg string cause error } func (e *internalWithCause) Unwrap() error { return e.cause } // for go1.13 + errors.Is/As func (e *internalWithCause) Cause() error { return e.cause } // for github.com/pkg/errors func (e *internalWithCause) Error() string { return e.msg + ": " + e.cause.Error() } func (e *internalWithCause) Code() twirp.ErrorCode { return twirp.Internal } func (e *internalWithCause) Msg() string { return e.msg } func (e *internalWithCause) Meta(key string) string { return "" } func (e *internalWithCause) MetaMap() map[string]string { return nil } func (e *internalWithCause) WithMeta(key string, val string) twirp.Error { return e } // malformedRequestError is used when the twirp server cannot unmarshal a request func malformedRequestError(msg string) twirp.Error { return twirp.NewError(twirp.Malformed, msg) } // badRouteError is used when the twirp server cannot route a request func badRouteError(msg string, method, url string) twirp.Error { err := twirp.NewError(twirp.BadRoute, msg) err = err.WithMeta("twirp_invalid_route", method+" "+url) return err } // withoutRedirects makes sure that the POST request can not be redirected. // The standard library will, by default, redirect requests (including POSTs) if it gets a 302 or // 303 response, and also 301s in go1.8. It redirects by making a second request, changing the // method to GET and removing the body. This produces very confusing error messages, so instead we // set a redirect policy that always errors. This stops Go from executing the redirect. // // We have to be a little careful in case the user-provided http.Client has its own CheckRedirect // policy - if so, we'll run through that policy first. // // Because this requires modifying the http.Client, we make a new copy of the client and return it. func withoutRedirects(in *http.Client) *http.Client { copy := *in copy.CheckRedirect = func(req *http.Request, via []*http.Request) error { if in.CheckRedirect != nil { // Run the input's redirect if it exists, in case it has side effects, but ignore any error it // returns, since we want to use ErrUseLastResponse. err := in.CheckRedirect(req, via) _ = err // Silly, but this makes sure generated code passes errcheck -blank, which some people use. } return http.ErrUseLastResponse } return © } // doProtobufRequest makes a Protobuf request to the remote Twirp service. func doProtobufRequest(ctx context.Context, client HTTPClient, hooks *twirp.ClientHooks, url string, in, out proto.Message) (_ context.Context, err error) { reqBodyBytes, err := proto.Marshal(in) if err != nil { return ctx, wrapInternal(err, "failed to marshal proto request") } reqBody := bytes.NewBuffer(reqBodyBytes) if err = ctx.Err(); err != nil { return ctx, wrapInternal(err, "aborted because context was done") } req, err := newRequest(ctx, url, reqBody, "application/protobuf") if err != nil { return ctx, wrapInternal(err, "could not build request") } ctx, err = callClientRequestPrepared(ctx, hooks, req) if err != nil { return ctx, err } req = req.WithContext(ctx) resp, err := client.Do(req) if err != nil { return ctx, wrapInternal(err, "failed to do request") } defer func() { _ = resp.Body.Close() }() if err = ctx.Err(); err != nil { return ctx, wrapInternal(err, "aborted because context was done") } if resp.StatusCode != 200 { return ctx, errorFromResponse(resp) } respBodyBytes, err := io.ReadAll(resp.Body) if err != nil { return ctx, wrapInternal(err, "failed to read response body") } if err = ctx.Err(); err != nil { return ctx, wrapInternal(err, "aborted because context was done") } if err = proto.Unmarshal(respBodyBytes, out); err != nil { return ctx, wrapInternal(err, "failed to unmarshal proto response") } return ctx, nil } // doJSONRequest makes a JSON request to the remote Twirp service. func doJSONRequest(ctx context.Context, client HTTPClient, hooks *twirp.ClientHooks, url string, in, out proto.Message) (_ context.Context, err error) { marshaler := &protojson.MarshalOptions{UseProtoNames: true} reqBytes, err := marshaler.Marshal(in) if err != nil { return ctx, wrapInternal(err, "failed to marshal json request") } if err = ctx.Err(); err != nil { return ctx, wrapInternal(err, "aborted because context was done") } req, err := newRequest(ctx, url, bytes.NewReader(reqBytes), "application/json") if err != nil { return ctx, wrapInternal(err, "could not build request") } ctx, err = callClientRequestPrepared(ctx, hooks, req) if err != nil { return ctx, err } req = req.WithContext(ctx) resp, err := client.Do(req) if err != nil { return ctx, wrapInternal(err, "failed to do request") } defer func() { cerr := resp.Body.Close() if err == nil && cerr != nil { err = wrapInternal(cerr, "failed to close response body") } }() if err = ctx.Err(); err != nil { return ctx, wrapInternal(err, "aborted because context was done") } if resp.StatusCode != 200 { return ctx, errorFromResponse(resp) } d := json.NewDecoder(resp.Body) rawRespBody := json.RawMessage{} if err := d.Decode(&rawRespBody); err != nil { return ctx, wrapInternal(err, "failed to unmarshal json response") } unmarshaler := protojson.UnmarshalOptions{DiscardUnknown: true} if err = unmarshaler.Unmarshal(rawRespBody, out); err != nil { return ctx, wrapInternal(err, "failed to unmarshal json response") } if err = ctx.Err(); err != nil { return ctx, wrapInternal(err, "aborted because context was done") } return ctx, nil } // Call twirp.ServerHooks.RequestReceived if the hook is available func callRequestReceived(ctx context.Context, h *twirp.ServerHooks) (context.Context, error) { if h == nil || h.RequestReceived == nil { return ctx, nil } return h.RequestReceived(ctx) } // Call twirp.ServerHooks.RequestRouted if the hook is available func callRequestRouted(ctx context.Context, h *twirp.ServerHooks) (context.Context, error) { if h == nil || h.RequestRouted == nil { return ctx, nil } return h.RequestRouted(ctx) } // Call twirp.ServerHooks.ResponsePrepared if the hook is available func callResponsePrepared(ctx context.Context, h *twirp.ServerHooks) context.Context { if h == nil || h.ResponsePrepared == nil { return ctx } return h.ResponsePrepared(ctx) } // Call twirp.ServerHooks.ResponseSent if the hook is available func callResponseSent(ctx context.Context, h *twirp.ServerHooks) { if h == nil || h.ResponseSent == nil { return } h.ResponseSent(ctx) } // Call twirp.ServerHooks.Error if the hook is available func callError(ctx context.Context, h *twirp.ServerHooks, err twirp.Error) context.Context { if h == nil || h.Error == nil { return ctx } return h.Error(ctx, err) } func callClientResponseReceived(ctx context.Context, h *twirp.ClientHooks) { if h == nil || h.ResponseReceived == nil { return } h.ResponseReceived(ctx) } func callClientRequestPrepared(ctx context.Context, h *twirp.ClientHooks, req *http.Request) (context.Context, error) { if h == nil || h.RequestPrepared == nil { return ctx, nil } return h.RequestPrepared(ctx, req) } func callClientError(ctx context.Context, h *twirp.ClientHooks, err twirp.Error) { if h == nil || h.Error == nil { return } h.Error(ctx, err) } var twirpFileDescriptor0 = []byte{ // 199 bytes of a gzipped FileDescriptorProto 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xe2, 0x92, 0x2d, 0x2a, 0x48, 0xd6, 0xcf, 0x48, 0x4c, 0x4a, 0x2d, 0x4a, 0x49, 0x2c, 0xce, 0x48, 0x2d, 0xd2, 0x2f, 0x4e, 0x2d, 0x2a, 0xcb, 0x4c, 0x4e, 0xd5, 0x2b, 0x28, 0xca, 0x2f, 0xc9, 0x17, 0x92, 0x2c, 0x29, 0xcf, 0x2c, 0x2a, 0xd0, 0x4b, 0xad, 0x48, 0xcc, 0x2d, 0xc8, 0x49, 0xd5, 0x43, 0x52, 0xa8, 0x24, 0xc7, 0xc5, 0x12, 0x9c, 0x59, 0x95, 0x2a, 0x24, 0xc6, 0xc5, 0x96, 0x99, 0x97, 0x9c, 0x91, 0x5a, 0x2c, 0xc1, 0xa8, 0xc0, 0xa8, 0xc1, 0x1a, 0x04, 0xe5, 0x29, 0xb9, 0x73, 0x31, 0x7b, 0x24, 0x96, 0xe0, 0x92, 0x16, 0x12, 0xe1, 0x62, 0x4d, 0xce, 0xcf, 0xc9, 0x2f, 0x92, 0x60, 0x52, 0x60, 0xd4, 0xe0, 0x0c, 0x82, 0x70, 0x84, 0x84, 0xb8, 0x58, 0xf2, 0x12, 0x73, 0x53, 0x25, 0x98, 0xc1, 0x82, 0x60, 0xb6, 0x51, 0x24, 0x17, 0xb7, 0x07, 0xc2, 0x5e, 0x21, 0x2f, 0x2e, 0x76, 0xdf, 0xc4, 0xec, 0x54, 0x90, 0xd9, 0xf2, 0x7a, 0x38, 0x9d, 0xa7, 0x07, 0x72, 0x9b, 0x94, 0x1c, 0x1e, 0x05, 0x1e, 0x89, 0x25, 0x4e, 0x2a, 0x51, 0x4a, 0xe9, 0x99, 0x25, 0x19, 0xa5, 0x49, 0x7a, 0xc9, 0xf9, 0xb9, 0xfa, 0x50, 0x55, 0xfa, 0x68, 0x41, 0x92, 0xc4, 0x06, 0x0e, 0x0b, 0x63, 0x40, 0x00, 0x00, 0x00, 0xff, 0xff, 0x0c, 0xe6, 0x27, 0x35, 0x2c, 0x01, 0x00, 0x00, } |