Skip to content

Commit fb81d59

Browse files
bjee19bjee19
authored
Refactor codebase to use inline error checking (#1026)
Problem: There were some places in the codebase where inline error checking wasn't used. Solution: Refactor codebase to use inline error checking.
1 parent f540fca commit fb81d59

File tree

15 files changed

+48
-45
lines changed

15 files changed

+48
-45
lines changed

‎internal/framework/controller/reconciler.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req reconcile.Request) (reco
7474
}
7575

7676
obj := newObject(r.cfg.ObjectType)
77-
err := r.cfg.Getter.Get(ctx, req.NamespacedName, obj)
78-
if err != nil {
77+
if err := r.cfg.Getter.Get(ctx, req.NamespacedName, obj); err != nil {
7978
if !apierrors.IsNotFound(err) {
8079
logger.Error(err, "Failed to get the resource")
8180
return reconcile.Result{}, err

‎internal/framework/controller/register.go

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,13 @@ func Register(
8282
}
8383

8484
for field, indexerFunc := range cfg.fieldIndices {
85-
err := addIndex(ctx, mgr.GetFieldIndexer(), objectType, field, indexerFunc)
86-
if err != nil {
85+
if err := addIndex(
86+
ctx,
87+
mgr.GetFieldIndexer(),
88+
objectType,
89+
field,
90+
indexerFunc,
91+
); err != nil {
8792
return err
8893
}
8994
}
@@ -101,8 +106,7 @@ func Register(
101106
NamespacedNameFilter: cfg.namespacedNameFilter,
102107
}
103108

104-
err := builder.Complete(cfg.newReconciler(recCfg))
105-
if err != nil {
109+
if err := builder.Complete(cfg.newReconciler(recCfg)); err != nil {
106110
return fmt.Errorf("cannot build a controller for %T: %w", objectType, err)
107111
}
108112

@@ -119,8 +123,7 @@ func addIndex(
119123
c, cancel := context.WithTimeout(ctx, addIndexFieldTimeout)
120124
defer cancel()
121125

122-
err := indexer.IndexField(c, objectType, field, indexerFunc)
123-
if err != nil {
126+
if err := indexer.IndexField(c, objectType, field, indexerFunc); err != nil {
124127
return fmt.Errorf("failed to add index for %T for field %s: %w", objectType, field, err)
125128
}
126129

‎internal/framework/events/first_eventbatch_preparer.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,7 @@ func (p *FirstEventBatchPreparerImpl) Prepare(ctx context.Context) (EventBatch,
7070
total := 0
7171

7272
for _, list := range p.objectLists {
73-
err := p.reader.List(ctx, list)
74-
if err != nil {
73+
if err := p.reader.List(ctx, list); err != nil {
7574
return nil, err
7675
}
7776

@@ -85,8 +84,7 @@ func (p *FirstEventBatchPreparerImpl) Prepare(ctx context.Context) (EventBatch,
8584
for _, obj := range p.objects {
8685
key := types.NamespacedName{Namespace: obj.GetNamespace(), Name: obj.GetName()}
8786

88-
err := p.reader.Get(ctx, key, obj)
89-
if err != nil {
87+
if err := p.reader.Get(ctx, key, obj); err != nil {
9088
if !apierrors.IsNotFound(err) {
9189
return nil, err
9290
}

‎internal/framework/helpers/helpers.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ func PrepareTimeForFakeClient(t metav1.Time) metav1.Time {
3535
panic(fmt.Errorf("failed to marshal time: %w", err))
3636
}
3737

38-
err = t.Unmarshal(bytes)
39-
if err != nil {
38+
if err = t.Unmarshal(bytes); err != nil {
4039
panic(fmt.Errorf("failed to unmarshal time: %w", err))
4140
}
4241

‎internal/framework/status/updater.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,7 @@ func (upd *updaterImpl) update(
146146
// Otherwise, the Update status API call can fail.
147147
// Note: the default client uses a cache for reads, so we're not making an unnecessary API call here.
148148
// the default is configurable in the Manager options.
149-
err := upd.cfg.Client.Get(ctx, nsname, obj)
150-
if err != nil {
149+
if err := upd.cfg.Client.Get(ctx, nsname, obj); err != nil {
151150
if !apierrors.IsNotFound(err) {
152151
upd.cfg.Logger.Error(
153152
err,
@@ -161,8 +160,7 @@ func (upd *updaterImpl) update(
161160

162161
statusSetter(obj)
163162

164-
err = upd.cfg.Client.Status().Update(ctx, obj)
165-
if err != nil {
163+
if err := upd.cfg.Client.Status().Update(ctx, obj); err != nil {
166164
upd.cfg.Logger.Error(
167165
err,
168166
"Failed to update status",

‎internal/mode/provisioner/deployment.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ import (
1414
// It will configure the Deployment to use the Gateway with the given NamespacedName.
1515
func prepareDeployment(depYAML []byte, id string, gwNsName types.NamespacedName) (*v1.Deployment, error) {
1616
dep := &v1.Deployment{}
17-
err := yaml.Unmarshal(depYAML, dep)
18-
if err != nil {
17+
if err := yaml.Unmarshal(depYAML, dep); err != nil {
1918
return nil, fmt.Errorf("failed to unmarshal deployment: %w", err)
2019
}
2120

‎internal/mode/provisioner/handler.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,7 @@ func (h *eventHandler) ensureDeploymentsMatchGateways(ctx context.Context) {
110110
panic(fmt.Errorf("failed to prepare deployment: %w", err))
111111
}
112112

113-
err = h.k8sClient.Create(ctx, deployment)
114-
if err != nil {
113+
if err = h.k8sClient.Create(ctx, deployment); err != nil {
115114
panic(fmt.Errorf("failed to create deployment: %w", err))
116115
}
117116

@@ -129,8 +128,7 @@ func (h *eventHandler) ensureDeploymentsMatchGateways(ctx context.Context) {
129128
for _, nsname := range removedGwsWithDeps {
130129
deployment := h.provisions[nsname]
131130

132-
err := h.k8sClient.Delete(ctx, deployment)
133-
if err != nil {
131+
if err := h.k8sClient.Delete(ctx, deployment); err != nil {
134132
panic(fmt.Errorf("failed to delete deployment: %w", err))
135133
}
136134

‎internal/mode/provisioner/manager.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,13 @@ func StartManager(cfg Config) error {
7272
eventCh := make(chan interface{})
7373

7474
for _, regCfg := range controllerRegCfgs {
75-
err := controller.Register(ctx, regCfg.objectType, mgr, eventCh, regCfg.options...)
76-
if err != nil {
75+
if err := controller.Register(
76+
ctx,
77+
regCfg.objectType,
78+
mgr,
79+
eventCh,
80+
regCfg.options...,
81+
); err != nil {
7782
return fmt.Errorf("cannot register controller for %T: %w", regCfg.objectType, err)
7883
}
7984
}
@@ -113,8 +118,7 @@ func StartManager(cfg Config) error {
113118
firstBatchPreparer,
114119
)
115120

116-
err = mgr.Add(eventLoop)
117-
if err != nil {
121+
if err := mgr.Add(eventLoop); err != nil {
118122
return fmt.Errorf("cannot register event loop: %w", err)
119123
}
120124

‎internal/mode/static/handler.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ func (h *eventHandlerImpl) HandleEventBatch(ctx context.Context, batch events.Ev
9090
}
9191

9292
var nginxReloadRes nginxReloadResult
93-
err := h.updateNginx(ctx, dataplane.BuildConfiguration(ctx, graph, h.cfg.serviceResolver))
94-
if err != nil {
93+
if err := h.updateNginx(ctx, dataplane.BuildConfiguration(ctx, graph, h.cfg.serviceResolver)); err != nil {
9594
h.cfg.logger.Error(err, "Failed to update NGINX configuration")
9695
nginxReloadRes.error = err
9796
} else {

‎internal/mode/static/manager.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,13 @@ func StartManager(cfg config.Config) error {
156156
ctx := ctlr.SetupSignalHandler()
157157

158158
for _, regCfg := range controllerRegCfgs {
159-
err := controller.Register(ctx, regCfg.objectType, mgr, eventCh, regCfg.options...)
160-
if err != nil {
159+
if err := controller.Register(
160+
ctx,
161+
regCfg.objectType,
162+
mgr,
163+
eventCh,
164+
regCfg.options...,
165+
); err != nil {
161166
return fmt.Errorf("cannot register controller for %T: %w", regCfg.objectType, err)
162167
}
163168
}
@@ -226,8 +231,7 @@ func StartManager(cfg config.Config) error {
226231
eventHandler,
227232
firstBatchPreparer)
228233

229-
err = mgr.Add(eventLoop)
230-
if err != nil {
234+
if err = mgr.Add(eventLoop); err != nil {
231235
return fmt.Errorf("cannot register event loop: %w", err)
232236
}
233237

‎internal/mode/static/nginx/config/execute.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ import (
99
func execute(template *template.Template, data interface{}) []byte {
1010
var buf bytes.Buffer
1111

12-
err := template.Execute(&buf, data)
13-
if err != nil {
12+
if err := template.Execute(&buf, data); err != nil {
1413
panic(err)
1514
}
1615

‎internal/mode/static/nginx/runtime/manager.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ func (m *ManagerImpl) Reload(ctx context.Context) error {
4949

5050
// send HUP signal to the NGINX main process reload configuration
5151
// See https://nginx.org/en/docs/control.html
52-
err = syscall.Kill(pid, syscall.SIGHUP)
53-
if err != nil {
52+
if err := syscall.Kill(pid, syscall.SIGHUP); err != nil {
5453
return fmt.Errorf("failed to send the HUP signal to NGINX main: %w", err)
5554
}
5655

‎internal/mode/static/state/graph/gateway_listener.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,7 @@ func validateListenerHostname(listener v1beta1.Listener) []conditions.Condition
206206
return nil
207207
}
208208

209-
err := validateHostname(h)
210-
if err != nil {
209+
if err := validateHostname(h); err != nil {
211210
path := field.NewPath("hostname")
212211
valErr := field.Invalid(path, listener.Hostname, err.Error())
213212
return staticConds.NewListenerUnsupportedValue(valErr.Error())

‎internal/mode/static/state/graph/httproute.go

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,10 @@ func buildRoute(
180180
ParentRefs: sectionNameRefs,
181181
}
182182

183-
err := validateHostnames(ghr.Spec.Hostnames, field.NewPath("spec").Child("hostnames"))
184-
if err != nil {
183+
if err := validateHostnames(
184+
ghr.Spec.Hostnames,
185+
field.NewPath("spec").Child("hostnames"),
186+
); err != nil {
185187
r.Valid = false
186188
r.Conditions = append(r.Conditions, staticConds.NewRouteUnsupportedValue(err.Error()))
187189

@@ -550,7 +552,11 @@ func validateMatch(
550552
allErrs = append(allErrs, validateQueryParamMatch(validator, q, queryParamPath)...)
551553
}
552554

553-
if err := validateMethodMatch(validator, match.Method, matchPath.Child("method")); err != nil {
555+
if err := validateMethodMatch(
556+
validator,
557+
match.Method,
558+
matchPath.Child("method"),
559+
); err != nil {
554560
allErrs = append(allErrs, err)
555561
}
556562

‎internal/mode/static/state/resolver/service_resolver_test.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ func createSlice(
7272

7373
func createFakeK8sClient(initObjs ...client.Object) (client.Client, error) {
7474
scheme := runtime.NewScheme()
75-
err := discoveryV1.AddToScheme(scheme)
76-
if err != nil {
75+
if err := discoveryV1.AddToScheme(scheme); err != nil {
7776
return nil, err
7877
}
7978

0 commit comments

Comments
 (0)