Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
150 additions
and
107 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 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,82 @@ | ||
// Copyright (c) 2016 Uber Technologies, Inc. | ||
// | ||
// 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. | ||
|
||
package http | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"strconv" | ||
"time" | ||
|
||
"go.uber.org/yarpc/api/transport" | ||
"go.uber.org/yarpc/internal/errors" | ||
) | ||
|
||
// parseTTL takes a context parses the given TTL, clamping the context to that | ||
// TTL and as a side-effect, tracking any errors encountered while attempting | ||
// to parse and validate that TTL. | ||
// | ||
// Leaves the context unchanged if the TTL is empty. | ||
func parseTTL(ctx context.Context, req *transport.Request, ttl string) (_ context.Context, cancel func(), _ error) { | ||
if ttl == "" { | ||
return ctx, func() {}, nil | ||
} | ||
|
||
ttlms, err := strconv.Atoi(ttl) | ||
if err != nil { | ||
return ctx, func() {}, invalidTTLError{ | ||
Service: req.Service, | ||
Procedure: req.Procedure, | ||
TTL: ttl, | ||
} | ||
} | ||
|
||
// negative TTLs are invalid | ||
if ttlms < 0 { | ||
return ctx, func() {}, invalidTTLError{ | ||
Service: req.Service, | ||
Procedure: req.Procedure, | ||
TTL: fmt.Sprint(ttlms), | ||
} | ||
} | ||
|
||
ctx, cancel = context.WithTimeout(ctx, time.Duration(ttlms)*time.Millisecond) | ||
return ctx, cancel, nil | ||
} | ||
|
||
// invalidTTLError is a failure to process a request because the TTL was in an | ||
// invalid format. | ||
type invalidTTLError struct { | ||
Service string | ||
Procedure string | ||
TTL string | ||
} | ||
|
||
func (e invalidTTLError) AsHandlerError() errors.HandlerError { | ||
return errors.HandlerBadRequestError(e) | ||
} | ||
|
||
func (e invalidTTLError) Error() string { | ||
return fmt.Sprintf( | ||
`invalid TTL %q for procedure %q of service %q: must be positive integer`, | ||
e.TTL, e.Procedure, e.Service, | ||
) | ||
} |
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,58 @@ | ||
package http | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"go.uber.org/yarpc/api/transport" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestParseTTL(t *testing.T) { | ||
req := &transport.Request{ | ||
Caller: "caller", | ||
Service: "service", | ||
Procedure: "hello", | ||
Encoding: "raw", | ||
} | ||
|
||
tests := []struct { | ||
ttlString string | ||
wantErr error | ||
wantMessage string | ||
}{ | ||
{ | ||
ttlString: "-1000", | ||
wantErr: invalidTTLError{ | ||
Service: "service", | ||
Procedure: "hello", | ||
TTL: "-1000", | ||
}, | ||
wantMessage: `invalid TTL "-1000" for procedure "hello" of service "service": must be positive integer`, | ||
}, | ||
{ | ||
ttlString: "not an integer", | ||
wantErr: invalidTTLError{ | ||
Service: "service", | ||
Procedure: "hello", | ||
TTL: "not an integer", | ||
}, | ||
wantMessage: `invalid TTL "not an integer" for procedure "hello" of service "service": must be positive integer`, | ||
}, | ||
} | ||
|
||
for _, tt := range tests { | ||
ctx, cancel, err := parseTTL(context.Background(), req, tt.ttlString) | ||
defer cancel() | ||
|
||
if tt.wantErr != nil && assert.Error(t, err) { | ||
assert.Equal(t, tt.wantErr, err) | ||
assert.Equal(t, tt.wantMessage, err.Error()) | ||
} else { | ||
assert.NoError(t, err) | ||
_, ok := ctx.Deadline() | ||
assert.True(t, ok) | ||
} | ||
} | ||
} |