Debian Codegraph @

pkg/storage/etcd3/decoder.go

raw
1 /*
2 Copyright 2024 The Kubernetes Authors.
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 */
16
17 package etcd3
18
19 import (
20 "context"
21 "fmt"
22 "time"
23
24 "k8s.io/apimachinery/pkg/conversion"
25 "k8s.io/apimachinery/pkg/runtime"
26 endpointsrequest "k8s.io/apiserver/pkg/endpoints/request"
27 "k8s.io/apiserver/pkg/storage"
28
29 "k8s.io/klog/v2"
30 )
31
32 // NewDefaultDecoder returns the default decoder for etcd3 store
33 func NewDefaultDecoder(codec runtime.Codec, versioner storage.Versioner) Decoder {
34 return &defaultDecoder{
35 codec: codec,
36 versioner: versioner,
37 }
38 }
39
40 // Decoder is used by the etcd storage implementation to decode
41 // transformed data from the storage into an object
42 type Decoder interface {
43 // Decode decodes value of bytes into object. It will also
44 // set the object resource version to rev.
45 // On success, objPtr would be set to the object.
46 Decode(value []byte, objPtr runtime.Object, rev int64) error
47
48 // DecodeListItem decodes bytes value in array into object.
49 DecodeListItem(ctx context.Context, data []byte, rev uint64, newItemFunc func() runtime.Object) (runtime.Object, error)
50 }
51
52 var _ Decoder = &defaultDecoder{}
53
54 type defaultDecoder struct {
55 codec runtime.Codec
56 versioner storage.Versioner
57 }
58
59 // decode decodes value of bytes into object. It will also set the object resource version to rev.
60 // On success, objPtr would be set to the object.
61 func (d *defaultDecoder) Decode(value []byte, objPtr runtime.Object, rev int64) error {
62 if _, err := conversion.EnforcePtr(objPtr); err != nil {
63 // nolint:errorlint // this code was moved from store.go as is
64 return fmt.Errorf("unable to convert output object to pointer: %v", err)
65 }
66 _, _, err := d.codec.Decode(value, nil, objPtr)
67 if err != nil {
68 return err
69 }
70 // being unable to set the version does not prevent the object from being extracted
71 if err := d.versioner.UpdateObject(objPtr, uint64(rev)); err != nil {
72 klog.Errorf("failed to update object version: %v", err)
73 }
74 return nil
75 }
76
77 // decodeListItem decodes bytes value in array into object.
78 func (d *defaultDecoder) DecodeListItem(ctx context.Context, data []byte, rev uint64, newItemFunc func() runtime.Object) (runtime.Object, error) {
79 startedAt := time.Now()
80 defer func() {
81 endpointsrequest.TrackDecodeLatency(ctx, time.Since(startedAt))
82 }()
83
84 obj, _, err := d.codec.Decode(data, nil, newItemFunc())
85 if err != nil {
86 return nil, err
87 }
88
89 if err := d.versioner.UpdateObject(obj, rev); err != nil {
90 klog.Errorf("failed to update object version: %v", err)
91 }
92
93 return obj, nil
94 }