|
| 1 | +// Copyright (c) 2025 Uber Technologies, Inc. |
| 2 | +// |
| 3 | +// Permission is hereby granted, free of charge, to any person obtaining a copy |
| 4 | +// of this software and associated documentation files (the "Software"), to deal |
| 5 | +// in the Software without restriction, including without limitation the rights |
| 6 | +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 7 | +// copies of the Software, and to permit persons to whom the Software is |
| 8 | +// furnished to do so, subject to the following conditions: |
| 9 | +// |
| 10 | +// The above copyright notice and this permission notice shall be included in |
| 11 | +// all copies or substantial portions of the Software. |
| 12 | +// |
| 13 | +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 14 | +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 15 | +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 16 | +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 17 | +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 18 | +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 19 | +// THE SOFTWARE. |
| 20 | + |
| 21 | +package dig |
| 22 | + |
| 23 | +// BeforeCallbackInfo contains information about a provided function or decorator |
| 24 | +// called by Dig, and is passed to a [BeforeCallback] registered with |
| 25 | +// [WithProviderBeforeCallback] or [WithDecoratorBeforeCallback]. |
| 26 | +type BeforeCallbackInfo struct { |
| 27 | + // Name is the name of the function in the format: |
| 28 | + // <package_name>.<function_name> |
| 29 | + Name string |
| 30 | +} |
| 31 | + |
| 32 | +// BeforeCallback is a function that can be registered with a provided function |
| 33 | +// using [WithProviderBeforeCallback] or decorator using [WithDecoratorBeforeCallback] |
| 34 | +// to cause it to be called before the provided function or decorator is run. |
| 35 | +type BeforeCallback func(bci BeforeCallbackInfo) |
| 36 | + |
| 37 | +// WithProviderBeforeCallback returns a [ProvideOption] which has Dig call |
| 38 | +// the passed in [BeforeCallback] before the corresponding constructor begins running. |
| 39 | +// |
| 40 | +// For example, the following prints a message |
| 41 | +// before "myConstructor" is called: |
| 42 | +// |
| 43 | +// c := dig.New() |
| 44 | +// myCallback := func(bci BeforeCallbackInfo) { |
| 45 | +// fmt.Printf("%q started", bci.Name) |
| 46 | +// } |
| 47 | +// c.Provide(myConstructor, WithProviderBeforeCallback(myCallback)), |
| 48 | +// |
| 49 | +// BeforeCallbacks can also be specified for Decorators with [WithDecoratorBeforeCallback]. |
| 50 | +// |
| 51 | +// See [BeforeCallbackInfo] for more info on the information passed to the [BeforeCallback]. |
| 52 | +func WithProviderBeforeCallback(callback BeforeCallback) ProvideOption { |
| 53 | + return withBeforeCallbackOption{ |
| 54 | + callback: callback, |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +// WithDecoratorBeforeCallback returns a [DecorateOption] which has Dig call |
| 59 | +// the passed in [BeforeCallback] before the corresponding decorator begins running. |
| 60 | +// |
| 61 | +// For example, the following prints a message |
| 62 | +// before "myDecorator" is called: |
| 63 | +// |
| 64 | +// c := dig.New() |
| 65 | +// myCallback := func(bci BeforeCallbackInfo) { |
| 66 | +// fmt.Printf("%q started", bci.Name) |
| 67 | +// } |
| 68 | +// c.Decorate(myDecorator, WithDecoratorBeforeCallback(myCallback)), |
| 69 | +// |
| 70 | +// BeforeCallbacks can also be specified for Constructors with [WithProviderBeforeCallback]. |
| 71 | +// |
| 72 | +// See [BeforeCallbackInfo] for more info on the information passed to the [BeforeCallback]. |
| 73 | +func WithDecoratorBeforeCallback(callback BeforeCallback) DecorateOption { |
| 74 | + return withBeforeCallbackOption{ |
| 75 | + callback: callback, |
| 76 | + } |
| 77 | +} |
| 78 | + |
| 79 | +type withBeforeCallbackOption struct { |
| 80 | + callback BeforeCallback |
| 81 | +} |
| 82 | + |
| 83 | +var ( |
| 84 | + _ ProvideOption = withBeforeCallbackOption{} |
| 85 | + _ DecorateOption = withBeforeCallbackOption{} |
| 86 | +) |
| 87 | + |
| 88 | +func (o withBeforeCallbackOption) applyProvideOption(po *provideOptions) { |
| 89 | + po.BeforeCallback = o.callback |
| 90 | +} |
| 91 | + |
| 92 | +func (o withBeforeCallbackOption) apply(do *decorateOptions) { |
| 93 | + do.BeforeCallback = o.callback |
| 94 | +} |
0 commit comments