slug icon indicating copy to clipboard operation
slug copied to clipboard

Make safe for use with concurrent goroutines (fix race hazards)

Open timbunce opened this issue 4 years ago • 5 comments

Also removes the forcing of go version 1.13 since it's not needed.

timbunce avatar Oct 29 '19 13:10 timbunce

Hello and thank for this changes.

I moved removing of Go 1.13 requirement to another PR and merged with master #42 because I always squash pull requests and wanted it in separate commit. Thank you for showing me this.

matrixik avatar Oct 30 '19 18:10 matrixik

Travis run tests by default with -race https://github.com/gosimple/slug/blob/master/.travis.yml#L18

So if you add test it should find if anything bad happen to the code at future.

matrixik avatar Oct 30 '19 18:10 matrixik

Please, add test that will catch race condition if some change break this code. Travis run tests by default with -race

The -race flag only detects races encountered by the test code that's run. The way the current tests are written doesn't trigger races.

The original API for the module is built around modifying globals, so naturally there is, and always will be, a race hazard using that API. That's why I've added a new API.

The old API is now implemented in terms of the new one, so testing the old is also testing the new.

In 05c89ad I've added t.Run and t.Parallel calls to demonstrate the problem. I've left the t.Parallel calls commented out. If they are uncommented then the tests with fail. Use go test -race -p N ... to change the level of parallelism.

timbunce avatar Nov 03 '19 21:11 timbunce

Also, re the go 1.13 change, I did that wrong. I should have changed it to go 1.12 or go 1.11 rather than removing it.

timbunce avatar Nov 03 '19 22:11 timbunce

Hello @matrixik. Anything else needed for this PR?

timbunce avatar Jan 02 '20 10:01 timbunce