simplifying if-else chains to switches #6208

cristaloleg · Jul 29, 2018

Description

Simplifying if-else chains to switches.
All the changes were suggested by https://github.com/go-critic/go-critic

Motivation and Context

To make code easier to read.

How Has This Been Tested?

Regular build, there is no logical changes, only style and code simplification.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added unit tests to cover my changes.
I have added/updated functional tests in mint. (If yes, add mint PR # here: )
All new and existing tests passed.

codecov · Jul 29, 2018

Codecov Report

Merging #6208 into master will increase coverage by 0.05%.
The diff coverage is 55.85%.

@@            Coverage Diff             @@
##           master    #6208      +/-   ##
==========================================
+ Coverage   58.41%   58.46%   +0.05%     
==========================================
  Files         222      222              
  Lines       32058    32043      -15     
==========================================
+ Hits        18726    18734       +8     
+ Misses      11689    11685       -4     
+ Partials     1643     1624      -19

Impacted Files	Coverage Δ
cmd/common-main.go	`13.51% <0%> (-0.08%)`	⬇️
cmd/httprange.go	`91.54% <100%> (ø)`	⬆️
cmd/bool-flag.go	`100% <100%> (ø)`	⬆️
cmd/admin-rpc-client.go	`51.43% <100%> (ø)`	⬆️
cmd/admin-handlers.go	`55.05% <100%> (+0.1%)`	⬆️
cmd/xl-sets.go	`55.95% <100%> (+0.86%)`	⬆️
cmd/object-api-errors.go	`57.63% <100%> (+0.2%)`	⬆️
cmd/fs-v1-helpers.go	`69.93% <25%> (+0.09%)`	⬆️
cmd/postpolicyform.go	`70.62% <33.33%> (-0.7%)`	⬇️
cmd/posix.go	`70.06% <42.3%> (+0.27%)`	⬆️
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eabfcea...7dd973e. Read the comment docs.

harshavardhana · Jul 29, 2018

harshavardhana requested changes Jul 29, 2018

View changes

harshavardhana · Jul 29, 2018

cmd/disk-cache.go

@@ -230,7 +230,7 @@ func (c cacheObjects) GetObject(ctx context.Context, bucket, object string, star
 		return err
 	}
 	go func() {
-		if err = GetObjectFn(ctx, bucket, object, 0, objInfo.Size, io.MultiWriter(writer, pipeWriter), etag); err != nil {


These changes are not related to the changes mentioned by this PR, would it be possible to send this separately?

harshavardhana · Jul 29, 2018

cmd/endpoint.go

@@ -330,12 +330,12 @@ func CreateEndpoints(serverAddr string, args ...[]string) (string, EndpointList,
 				host = endpoint.Host
 			}
 			hostIPSet, _ := getHostIP4(host)
-			if IPSet, ok := pathIPMap[endpoint.Path]; ok {
-				if !IPSet.Intersection(hostIPSet).IsEmpty() {
+			if ipSet, ok := pathIPMap[endpoint.Path]; ok {


Keep cleanups to separate PR, this doesn't fix anything related to if-else or cyclomatic complexity.

harshavardhana · Jul 29, 2018

cmd/fallocate.go

@@ -20,6 +20,6 @@ package cmd

 // Fallocate is not POSIX and not supported under Windows
 // Always return successful
-func Fallocate(fd int, offset int64, len int64) error {
+func Fallocate(fd int, offset int64, length int64) error {


Same here len is synonymous to length, no reason to rename it. The corresponding function in fallocate_linux.go is untouched..

It's a builtin function https://golang.org/pkg/builtin/#len

harshavardhana · Jul 29, 2018

cmd/logger/logger.go

@@ -283,9 +284,9 @@ func LogIf(ctx context.Context, err error) {
 		req = &ReqInfo{API: "SYSTEM"}
 	}

-	API := "SYSTEM"
+	apiName := "SYSTEM"


Same here avoid cleanups like this....

harshavardhana · Jul 29, 2018

cmd/posix-errors.go

@@ -25,8 +25,7 @@ import (
 // Function not implemented error
 func isSysErrNoSys(err error) bool {
 	if pathErr, ok := err.(*os.PathError); ok {
-		switch pathErr.Err {
-		case syscall.ENOSYS:
+		if pathErr.Err == syscall.ENOSYS {


Further simplification is possible simply do return pathErr.Err == syscall.ENOSYS

harshavardhana · Jul 29, 2018

cmd/posix-errors.go

@@ -58,8 +55,7 @@ func isSysErrNoSpace(err error) bool {
 // Input/output error
 func isSysErrIO(err error) bool {
 	if pathErr, ok := err.(*os.PathError); ok {
-		switch pathErr.Err {
-		case syscall.EIO:
+		if pathErr.Err == syscall.EIO {


Further simplification is possible simply do return pathErr.Err == syscall.EIO

harshavardhana · Jul 29, 2018

cmd/posix-errors.go

@@ -69,8 +65,7 @@ func isSysErrIO(err error) bool {
 // Check if the given error corresponds to EISDIR (is a directory).
 func isSysErrIsDir(err error) bool {
 	if pathErr, ok := err.(*os.PathError); ok {
-		switch pathErr.Err {
-		case syscall.EISDIR:
+		if pathErr.Err == syscall.EISDIR {


Further simplification is possible simply do return pathErr.Err == syscall.EISDIR

harshavardhana · Jul 29, 2018

cmd/posix-errors.go

@@ -80,8 +75,7 @@ func isSysErrIsDir(err error) bool {
 // Check if the given error corresponds to ENOTDIR (is not a directory).
 func isSysErrNotDir(err error) bool {
 	if pathErr, ok := err.(*os.PathError); ok {
-		switch pathErr.Err {
-		case syscall.ENOTDIR:
+		if pathErr.Err == syscall.ENOTDIR {


Further simplification is possible simply do return pathErr.Err == syscall.ENOTDIR

harshavardhana · Jul 29, 2018

cmd/posix-errors.go

@@ -91,8 +85,7 @@ func isSysErrNotDir(err error) bool {
 // Check if the given error corresponds to the ENAMETOOLONG (name too long).
 func isSysErrTooLong(err error) bool {
 	if pathErr, ok := err.(*os.PathError); ok {
-		switch pathErr.Err {
-		case syscall.ENAMETOOLONG:
+		if pathErr.Err == syscall.ENAMETOOLONG {


Further simplification is possible simply do return pathErr.Err == syscall.ENAMETOOLONG

harshavardhana · Jul 29, 2018

cmd/retry.go

@@ -61,7 +61,7 @@ var globalRandomSource = rand.New(&lockedRandSource{
 // until the maximum retry attempts are reached. - this function is a fully
 // configurable version, meant for only advanced use cases. For the most part
 // one should use newRetryTimerSimple and newRetryTimer.
-func newRetryTimerWithJitter(unit time.Duration, cap time.Duration, jitter float64, doneCh chan struct{}) <-chan int {
+func newRetryTimerWithJitter(unit time.Duration, max time.Duration, jitter float64, doneCh chan struct{}) <-chan int {


Do not change the variable name cap - any good reason you change it?

Because of https://golang.org/pkg/builtin/#cap same as https://golang.org/pkg/builtin/#len in another file.

cristaloleg · Jul 29, 2018

cristaloleg reviewed Jul 29, 2018

View changes

Thanks for the quick review. Will address suggestions quickly.

cristaloleg · Jul 29, 2018

cmd/disk-cache.go

@@ -230,7 +230,7 @@ func (c cacheObjects) GetObject(ctx context.Context, bucket, object string, star
 		return err
 	}
 	go func() {
-		if err = GetObjectFn(ctx, bucket, object, 0, objInfo.Size, io.MultiWriter(writer, pipeWriter), etag); err != nil {


cristaloleg · Jul 29, 2018

cmd/endpoint.go

@@ -330,12 +330,12 @@ func CreateEndpoints(serverAddr string, args ...[]string) (string, EndpointList,
 				host = endpoint.Host
 			}
 			hostIPSet, _ := getHostIP4(host)
-			if IPSet, ok := pathIPMap[endpoint.Path]; ok {
-				if !IPSet.Intersection(hostIPSet).IsEmpty() {
+			if ipSet, ok := pathIPMap[endpoint.Path]; ok {


cristaloleg · Jul 29, 2018

cmd/logger/logger.go

@@ -283,9 +284,9 @@ func LogIf(ctx context.Context, err error) {
 		req = &ReqInfo{API: "SYSTEM"}
 	}

-	API := "SYSTEM"
+	apiName := "SYSTEM"


cristaloleg · Jul 29, 2018

cmd/posix-errors.go

@@ -25,8 +25,7 @@ import (
 // Function not implemented error
 func isSysErrNoSys(err error) bool {
 	if pathErr, ok := err.(*os.PathError); ok {
-		switch pathErr.Err {
-		case syscall.ENOSYS:
+		if pathErr.Err == syscall.ENOSYS {


cristaloleg · Jul 29, 2018

cmd/fallocate.go

@@ -20,6 +20,6 @@ package cmd

 // Fallocate is not POSIX and not supported under Windows
 // Always return successful
-func Fallocate(fd int, offset int64, len int64) error {
+func Fallocate(fd int, offset int64, length int64) error {


It's a builtin function https://golang.org/pkg/builtin/#len

cristaloleg · Jul 29, 2018

cmd/retry.go

@@ -61,7 +61,7 @@ var globalRandomSource = rand.New(&lockedRandSource{
 // until the maximum retry attempts are reached. - this function is a fully
 // configurable version, meant for only advanced use cases. For the most part
 // one should use newRetryTimerSimple and newRetryTimer.
-func newRetryTimerWithJitter(unit time.Duration, cap time.Duration, jitter float64, doneCh chan struct{}) <-chan int {
+func newRetryTimerWithJitter(unit time.Duration, max time.Duration, jitter float64, doneCh chan struct{}) <-chan int {


Because of https://golang.org/pkg/builtin/#cap same as https://golang.org/pkg/builtin/#len in another file.

kannappanr · Jul 31, 2018

kannappanr reviewed Jul 31, 2018

View changes

kannappanr · Jul 31, 2018

cmd/bool-flag.go

@@ -56,11 +56,12 @@ func (bf *BoolFlag) UnmarshalJSON(data []byte) (err error) {

 // ParseBoolFlag - parses string into BoolFlag.
 func ParseBoolFlag(s string) (bf BoolFlag, err error) {
-	if s == "on" {
+	switch {


this can be changed to

switch s { case "on": bf = true case "off": bf = false default: err = fmt.Errorf("invalid value ‘%s’ for BoolFlag", s) }

harshavardhana · Jul 31, 2018

harshavardhana reviewed Jul 31, 2018

View changes

kannappanr · Jul 31, 2018

kannappanr reviewed Jul 31, 2018

View changes

LGTM

ebozduman · Jul 31, 2018

ebozduman requested changes Jul 31, 2018

View changes

ebozduman · Jul 31, 2018

cmd/os-reliable.go

 			return fmt.Errorf("%s (%s)->(%s)", errCrossDeviceLink, srcFilePath, dstFilePath)
-		} else if os.IsNotExist(err) {
+		case os.IsNotExist(err):
 			return errFileNotFound
 		}


Don't we need default here (although it was even also missing in the original code);

default: return err

cristaloleg · Jul 31, 2018

cristaloleg dismissed stale reviews from kannappanr and harshavardhana via `fea64af` Jul 31, 2018

kannappanr · Jul 31, 2018

kannappanr reviewed Jul 31, 2018

View changes

kannappanr · Jul 31, 2018

cmd/os-reliable.go

@@ -95,6 +95,8 @@ func renameAll(srcFilePath, dstFilePath string) (err error) {
 			return fmt.Errorf("%s (%s)->(%s)", errCrossDeviceLink, srcFilePath, dstFilePath)
 		case os.IsNotExist(err):
 			return errFileNotFound
+		default:
+			return err
 		}
 	}
 	return err


It will look cleaner, if it is changed to return nil

@cristaloleg,
Could you please incorporate @kannappanr's comment?
Thanks

harshavardhana · Aug 3, 2018

Can you fix the conflicts @cristaloleg ?

kannappanr · Aug 4, 2018

kannappanr reviewed Aug 4, 2018

View changes

kannappanr · Aug 4, 2018

cmd/os-reliable.go

@@ -83,17 +83,20 @@ func renameAll(srcFilePath, dstFilePath string) (err error) {
 	}

 	if err = reliableRename(srcFilePath, dstFilePath); err != nil {
-		if isSysErrNotDir(err) {
+		switch {


Sorry, I think you misunderstood what I meant. I wanted the renameAll function to look like this

func renameAll(srcFilePath, dstFilePath string) (err error) { if srcFilePath == "" || dstFilePath == "" { return errInvalidArgument } if err = checkPathLength(srcFilePath); err != nil { return err } if err = checkPathLength(dstFilePath); err != nil { return err } if err = reliableRename(srcFilePath, dstFilePath); err != nil { switch { case isSysErrNotDir(err): return errFileAccessDenied case isSysErrPathNotFound(err): // This is a special case should be handled only for // windows, because windows API does not return "not a // directory" error message. Handle this specifically here. return errFileAccessDenied case isSysErrCrossDevice(err): return fmt.Errorf("%s (%s)->(%s)", errCrossDeviceLink, srcFilePath, dstFilePath) case os.IsNotExist(err): return errFileNotFound default: return err } } return nil }

Oh, now it's clear 😉

kannappanr · Aug 4, 2018

kannappanr approved these changes Aug 4, 2018

View changes

LGTM.

minio-ops · Aug 4, 2018

Mint Automation

Test	Result
mint-gateway-s3.sh	✔️
mint-gateway-azure.sh	✔️
mint-xl.sh	✔️
mint-gateway-nas.sh	✔️
mint-large-bucket.sh	✔️
mint-worm.sh	✔️
mint-fs.sh	✔️
mint-dist-xl.sh	❌ more...

6208-7dd973e/mint-dist-xl.sh.log:

Running with
SERVER_ENDPOINT:      minikube:31146
ACCESS_KEY:           minio
SECRET_KEY:           ***REDACTED***
ENABLE_HTTPS:         0
SERVER_REGION:        us-east-1
MINT_DATA_DIR:        /mint/data
MINT_MODE:            full
ENABLE_VIRTUAL_STYLE: 0

To get logs, run 'docker cp 200e1f766a5c:/mint/log /tmp/mint-logs'
(1/13) Running awscli tests ... done in 52 seconds
(2/13) Running aws-sdk-go tests ... done in 0 seconds
(3/13) Running aws-sdk-java tests ... done in 1 seconds
(4/13) Running aws-sdk-php tests ... done in 42 seconds
(5/13) Running aws-sdk-ruby tests ... done in 7 seconds
(6/13) Running mc tests ... done in 20 seconds
(7/13) Running minio-dotnet tests ... FAILED in 2 minutes and 34 seconds

Unhandled Exception: System.AggregateException: One or more errors occurred. (One or more errors occurred. (Minio API responded with message=Multiple disks failures, unable to write data.) (Minio API responded with message=Multiple disks failures, unable to write data.) (Minio API responded with message=Multiple disks failures, unable to write data.)) ---> System.AggregateException: One or more errors occurred. (Minio API responded with message=Multiple disks failures, unable to write data.) (Minio API responded with message=Multiple disks failures, unable to write data.) (Minio API responded with message=Multiple disks failures, unable to write data.) ---> Minio.Exceptions.MinioException: Minio API responded with message=Multiple disks failures, unable to write data.
   at Minio.MinioClient.ParseError(IRestResponse response)
   at Minio.MinioClient.<>c.<.ctor>b__76_0(IRestResponse response)
   at Minio.MinioClient.HandleIfErrorResponse(IRestResponse response, IEnumerable`1 handlers, DateTime startTime)
   at Minio.MinioClient.<ExecuteTaskAsync>d__79.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Runtime.CompilerServices.ConfiguredTaskAwaitable`1.ConfiguredTaskAwaiter.GetResult()
   at Minio.MinioClient.<PutObjectAsync>d__20.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Runtime.CompilerServices.ConfiguredTaskAwaitable`1.ConfiguredTaskAwaiter.GetResult()
   at Minio.MinioClient.<PutObjectAsync>d__15.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Runtime.CompilerServices.TaskAwaiter.GetResult()
   at Minio.Functional.Tests.FunctionalTest.<PutObject_Task>d__52.MoveNext() in /mint/run/core/minio-dotnet/FunctionalTest.cs:line 741
   --- End of inner exception stack trace ---
   at System.Threading.Tasks.Task.ThrowIfExceptional(Boolean includeTaskCanceledExceptions)
   at System.Threading.Tasks.Task.Wait(Int32 millisecondsTimeout, CancellationToken cancellationToken)
   at System.Threading.Tasks.Task.Wait()
   at Minio.Functional.Tests.FunctionalTest.<RemoveObjects_Test2>d__75.MoveNext() in /mint/run/core/minio-dotnet/FunctionalTest.cs:line 1669
   --- End of inner exception stack trace ---
   at System.Threading.Tasks.Task.ThrowIfExceptional(Boolean includeTaskCanceledExceptions)
   at System.Threading.Tasks.Task.Wait(Int32 millisecondsTimeout, CancellationToken cancellationToken)
   at System.Threading.Tasks.Task.Wait()
   at Minio.Functional.Tests.FunctionalTest.Main(String[] args) in /mint/run/core/minio-dotnet/FunctionalTest.cs:line 220

Executed 6 out of 13 tests successfully.

ebozduman · Aug 6, 2018

ebozduman approved these changes Aug 6, 2018

View changes

LGTM

cristaloleg · Aug 6, 2018

Thanks to everyone 👍

simplifying if-else chains to switches

Loading status checks…

a04534f

replace consts with named versions

Loading status checks…

aae6b6e

PR suggestions

Loading status checks…

1c53552

cristaloleg force-pushed the cristaloleg:master branch from aae6b6e to 1c53552 Jul 29, 2018

Merge branch 'master' into master

Verified

This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.

GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits

Loading status checks…

9dc9f61

kannappanr requested review from harshavardhana, ebozduman and kannappanr and removed request for harshavardhana Jul 30, 2018

simplify switch

Loading status checks…

3dfc6d6

cristaloleg added some commits Jul 31, 2018

add default case

ce450e8

Merge branch 'master' of github.com:cristaloleg/minio

Loading status checks…

fea64af

cristaloleg dismissed stale reviews from kannappanr and harshavardhana via fea64af Jul 31, 2018

kannappanr referenced this pull request Aug 2, 2018
Merged
Add reliable RemoveAll to handle racy situations #6227
3 of 9 tasks complete

cristaloleg added some commits Aug 4, 2018

resolve merge conflict

40f7aa3

review fix

Loading status checks…

63b3124

cristaloleg force-pushed the cristaloleg:master branch from 9b6aa09 to 63b3124 Aug 4, 2018

correct return for the renameAll

Loading status checks…

7dd973e

minio/minio

Join GitHub today

simplifying if-else chains to switches #6208

Conversation

cristaloleg commented Jul 29, 2018 • edited

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

This comment has been minimized.

codecov bot commented Jul 29, 2018 • edited

Codecov Report

harshavardhana requested changes Jul 29, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

cristaloleg reviewed Jul 29, 2018 View changes

cristaloleg left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

cristaloleg force-pushed the cristaloleg:master branch from aae6b6e to 1c53552 Jul 29, 2018

kannappanr requested review from harshavardhana, ebozduman and kannappanr and removed request for harshavardhana Jul 30, 2018

kannappanr reviewed Jul 31, 2018 View changes

This comment has been minimized.

kannappanr Jul 31, 2018 • edited

This comment has been minimized.

harshavardhana reviewed Jul 31, 2018 View changes

kannappanr reviewed Jul 31, 2018 View changes

kannappanr left a comment

ebozduman requested changes Jul 31, 2018 View changes

This comment has been minimized.

ebozduman Jul 31, 2018 • edited

cristaloleg added some commits Jul 31, 2018

cristaloleg dismissed stale reviews from kannappanr and harshavardhana via fea64af Jul 31, 2018

kannappanr reviewed Jul 31, 2018 View changes

This comment has been minimized.

This comment has been minimized.

kannappanr referenced this pull request Aug 2, 2018

This comment has been minimized.

harshavardhana commented Aug 3, 2018

cristaloleg added some commits Aug 4, 2018

cristaloleg force-pushed the cristaloleg:master branch from 9b6aa09 to 63b3124 Aug 4, 2018

kannappanr reviewed Aug 4, 2018 View changes

This comment has been minimized.

kannappanr Aug 4, 2018 • edited

This comment has been minimized.

kannappanr approved these changes Aug 4, 2018 View changes

kannappanr left a comment

This comment has been minimized.

minio-ops commented Aug 4, 2018

Mint Automation

6208-7dd973e/mint-dist-xl.sh.log:

ebozduman approved these changes Aug 6, 2018 View changes

ebozduman left a comment

Hide details View details kannappanr merged commit 37de2db into minio:master Aug 6, 2018 3 of 4 checks passed

3 of 4 checks passed

This comment has been minimized.

cristaloleg commented Aug 6, 2018

cristaloleg commented Jul 29, 2018 •

edited

codecov bot commented Jul 29, 2018 •

edited

harshavardhana requested changes Jul 29, 2018

View changes

cristaloleg reviewed Jul 29, 2018

View changes

cristaloleg force-pushed the cristaloleg:master branch from `aae6b6e` to `1c53552` Jul 29, 2018

kannappanr reviewed Jul 31, 2018

View changes

kannappanr Jul 31, 2018 •

edited

harshavardhana reviewed Jul 31, 2018

View changes

kannappanr reviewed Jul 31, 2018

View changes

ebozduman requested changes Jul 31, 2018

View changes

ebozduman Jul 31, 2018 •

edited

cristaloleg dismissed stale reviews from kannappanr and harshavardhana via `fea64af` Jul 31, 2018

kannappanr reviewed Jul 31, 2018

View changes

cristaloleg force-pushed the cristaloleg:master branch from `9b6aa09` to `63b3124` Aug 4, 2018

kannappanr reviewed Aug 4, 2018

View changes

kannappanr Aug 4, 2018 •

edited

kannappanr approved these changes Aug 4, 2018

View changes

ebozduman approved these changes Aug 6, 2018

View changes

kannappanr merged commit `37de2db` into minio:master Aug 6, 2018
3 of 4 checks passed