go.temporal.io/server@v1.23.0/common/rpc/context.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package rpc
    26  
    27  import (
    28  	"context"
    29  	"time"
    30  
    31  	"go.temporal.io/server/common/headers"
    32  )
    33  
    34  type (
    35  	valueCopyCtx struct {
    36  		context.Context
    37  
    38  		valueCtx context.Context
    39  	}
    40  )
    41  
    42  func (c *valueCopyCtx) Value(key any) any {
    43  	if value := c.Context.Value(key); value != nil {
    44  		return value
    45  	}
    46  
    47  	return c.valueCtx.Value(key)
    48  }
    49  
    50  // CopyContextValues copies values in source Context to destination Context.
    51  func CopyContextValues(dst context.Context, src context.Context) context.Context {
    52  	return &valueCopyCtx{
    53  		Context:  dst,
    54  		valueCtx: src,
    55  	}
    56  }
    57  
    58  // ResetContextTimeout creates new context with specified timeout and copies values from source Context.
    59  func ResetContextTimeout(ctx context.Context, newTimeout time.Duration) (context.Context, context.CancelFunc) {
    60  	newContext, cancel := context.WithTimeout(context.Background(), newTimeout)
    61  	return CopyContextValues(newContext, ctx), cancel
    62  }
    63  
    64  // NewContextWithTimeoutAndVersionHeaders creates context with timeout and version headers.
    65  func NewContextWithTimeoutAndVersionHeaders(timeout time.Duration) (context.Context, context.CancelFunc) {
    66  	return context.WithTimeout(headers.SetVersions(context.Background()), timeout)
    67  }
    68  
    69  // NewContextFromParentWithTimeoutAndVersionHeaders creates context from parent context with timeout and version headers.
    70  func NewContextFromParentWithTimeoutAndVersionHeaders(parentCtx context.Context, timeout time.Duration) (context.Context, context.CancelFunc) {
    71  	return context.WithTimeout(headers.SetVersions(parentCtx), timeout)
    72  }