add example for timeout settings in API file

Author: kevwan

http/timeout/etc/timeout-api.yaml

@@ -0,0 +1,3 @@
+Name: timeout-api
+Host: 0.0.0.0
+Port: 8888

http/timeout/go.mod

@@ -0,0 +1,33 @@
+module timeout
+
+go 1.18
+
+require github.com/zeromicro/go-zero v1.3.2
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.1.2 // indirect
+	github.com/go-logr/logr v1.2.2 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang-jwt/jwt/v4 v4.2.0 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/uuid v1.3.0 // indirect
+	github.com/justinas/alice v1.2.0 // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
+	github.com/openzipkin/zipkin-go v0.4.0 // indirect
+	github.com/prometheus/client_golang v1.11.0 // indirect
+	github.com/prometheus/client_model v0.2.0 // indirect
+	github.com/prometheus/common v0.30.0 // indirect
+	github.com/prometheus/procfs v0.7.3 // indirect
+	github.com/spaolacci/murmur3 v1.1.0 // indirect
+	go.opentelemetry.io/otel v1.3.0 // indirect
+	go.opentelemetry.io/otel/exporters/jaeger v1.3.0 // indirect
+	go.opentelemetry.io/otel/exporters/zipkin v1.3.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.3.0 // indirect
+	go.opentelemetry.io/otel/trace v1.3.0 // indirect
+	go.uber.org/automaxprocs v1.4.0 // indirect
+	golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 // indirect
+	google.golang.org/grpc v1.44.0 // indirect
+	google.golang.org/protobuf v1.27.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+)

http/timeout/go.sum

@@ -0,0 +1,7 @@
+package config
+
+import "github.com/zeromicro/go-zero/rest"
+
+type Config struct {
+	rest.RestConf
+}

http/timeout/internal/config/config.go

@@ -0,0 +1,28 @@
+package handler
+
+import (
+	"net/http"
+
+	"github.com/zeromicro/go-zero/rest/httpx"
+	"timeout/internal/logic"
+	"timeout/internal/svc"
+	"timeout/internal/types"
+)
+
+func FastHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		var req types.FastRequest
+		if err := httpx.Parse(r, &req); err != nil {
+			httpx.Error(w, err)
+			return
+		}
+
+		l := logic.NewFastLogic(r.Context(), svcCtx)
+		err := l.Fast(&req)
+		if err != nil {
+			httpx.Error(w, err)
+		} else {
+			httpx.Ok(w)
+		}
+	}
+}

http/timeout/internal/handler/fasthandler.go

@@ -0,0 +1,28 @@
+package handler
+
+import (
+	"net/http"
+
+	"github.com/zeromicro/go-zero/rest/httpx"
+	"timeout/internal/logic"
+	"timeout/internal/svc"
+	"timeout/internal/types"
+)
+
+func SlowHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		var req types.SlowRequest
+		if err := httpx.Parse(r, &req); err != nil {
+			httpx.Error(w, err)
+			return
+		}
+
+		l := logic.NewSlowLogic(r.Context(), svcCtx)
+		err := l.Slow(&req)
+		if err != nil {
+			httpx.Error(w, err)
+		} else {
+			httpx.Ok(w)
+		}
+	}
+}

http/timeout/internal/handler/routes.go

@@ -0,0 +1,32 @@
+package logic
+
+import (
+	"context"
+	"time"
+
+	"timeout/internal/svc"
+	"timeout/internal/types"
+
+	"github.com/zeromicro/go-zero/core/logx"
+)
+
+type FastLogic struct {
+	logx.Logger
+	ctx    context.Context
+	svcCtx *svc.ServiceContext
+}
+
+func NewFastLogic(ctx context.Context, svcCtx *svc.ServiceContext) *FastLogic {
+	return &FastLogic{
+		Logger: logx.WithContext(ctx),
+		ctx:    ctx,
+		svcCtx: svcCtx,
+	}
+}
+
+func (l *FastLogic) Fast(req *types.FastRequest) error {
+	// should timeout
+	time.Sleep(time.Second * 4)
+
+	return nil
+}

http/timeout/internal/handler/slowhandler.go

@@ -0,0 +1,31 @@
+package logic
+
+import (
+	"context"
+	"time"
+
+	"timeout/internal/svc"
+	"timeout/internal/types"
+
+	"github.com/zeromicro/go-zero/core/logx"
+)
+
+type SlowLogic struct {
+	logx.Logger
+	ctx    context.Context
+	svcCtx *svc.ServiceContext
+}
+
+func NewSlowLogic(ctx context.Context, svcCtx *svc.ServiceContext) *SlowLogic {
+	return &SlowLogic{
+		Logger: logx.WithContext(ctx),
+		ctx:    ctx,
+		svcCtx: svcCtx,
+	}
+}
+
+func (l *SlowLogic) Slow(req *types.SlowRequest) error {
+	time.Sleep(time.Second * 4)
+
+	return nil
+}

http/timeout/internal/logic/fastlogic.go

@@ -0,0 +1,15 @@
+package svc
+
+import (
+	"timeout/internal/config"
+)
+
+type ServiceContext struct {
+	Config config.Config
+}
+
+func NewServiceContext(c config.Config) *ServiceContext {
+	return &ServiceContext{
+		Config: c,
+	}
+}

http/timeout/internal/logic/slowlogic.go

@@ -0,0 +1,20 @@
+type SlowRequest {
+	Name string `path:"name"`
+}
+
+type FastRequest {
+	Name string `path:"name"`
+}
+
+@server(
+	timeout: 5s
+)
+service timeout-api {
+	@handler SlowHandler
+	get /slow/:name(SlowRequest)
+}
+
+service timeout-api {
+	@handler FastHandler
+	get /fast/:name(FastRequest)
+}

http/timeout/internal/svc/servicecontext.go

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+
+	"timeout/internal/config"
+	"timeout/internal/handler"
+	"timeout/internal/svc"
+
+	"github.com/zeromicro/go-zero/core/conf"
+	"github.com/zeromicro/go-zero/rest"
+)
+
+var configFile = flag.String("f", "etc/timeout-api.yaml", "the config file")
+
+func main() {
+	flag.Parse()
+
+	var c config.Config
+	conf.MustLoad(*configFile, &c)
+
+	ctx := svc.NewServiceContext(c)
+	server := rest.MustNewServer(c.RestConf)
+	defer server.Stop()
+
+	handler.RegisterHandlers(server, ctx)
+
+	fmt.Printf("Starting server at %s:%d...\n", c.Host, c.Port)
+	server.Start()
+}

http/timeout/internal/types/types.go

@@ -49,7 +49,7 @@ func timingWheelMode() {
 	defer tw.Stop()
 	for i := 0; ; i++ {
 		tw.SetTimer(i, i, interval)
-		time.Sleep(time.Millisecond)
+		time.Sleep(time.Microsecond)
 	}
 }
 
@@ -72,7 +72,7 @@ func traditionalMode() {
 
 func job(count *uint64) {
 	v := atomic.AddUint64(count, 1)
-	if v%1000 == 0 {
+	if v%10000 == 0 {
 		fmt.Println(v)
 	}
 }