Merge pull request #463 from devlights/add-goroutine-leak-examples

Author: devlights

Makefile

@@ -53,6 +53,11 @@ clean:
 install: 
 	$(GOINSTALL) $(BIN_DIR)
 
+.PHONY: vet
+vet:
+	go vet ./...
+	staticcheck ./...
+
 .PHONY: run
 run: 
 	$(GORUN) $(CMD_PKG) -onetime -example ${EXAMPLE}

examples/basic/goroutines/examples.go

@@ -1,6 +1,9 @@
 package goroutines
 
-import "github.com/devlights/try-golang/mapping"
+import (
+	"github.com/devlights/try-golang/examples/basic/goroutines/leak"
+	"github.com/devlights/try-golang/mapping"
+)
 
 type (
 	register struct{}
@@ -23,4 +26,6 @@ func (r *register) Regist(m mapping.ExampleMapping) {
 	m["goroutines_using_chan_semaphore"] = UsingChanSemaphore
 	m["goroutines_using_mutex"] = UsingMutex
 	m["goroutines_with_context_deadline"] = WithContextDeadline
+
+	leak.NewRegister().Regist(m)
 }

examples/basic/goroutines/leak/abandoned_receiver.go

@@ -0,0 +1,49 @@
+package leak
+
+import (
+	"context"
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// AbandonedReceiver -- goroutineリークが発生するパターンのサンプルです。
+//
+// チャネルの送受信の実装があるが、タイミングによっては送信側がいなくなってしまうパターン。
+// 受信側のgoroutineが永遠に待ち続けるので終了しません。
+//
+// 解決方法としては、送信側が適切に使い終わったチャネルを閉じること。
+//
+// REFERENCES:
+//   - https://betterprogramming.pub/common-goroutine-leaks-that-you-should-avoid-fe12d12d6ee
+func AbandonedReceiver() error {
+	var (
+		ctx, cxl = context.WithTimeout(context.Background(), 10*time.Millisecond)
+		ch       = make(chan int)
+		iowait   = func() {
+			time.Sleep(1 * time.Second)
+		}
+		fn = func(ch <-chan int) {
+			iowait()
+			data := <-ch
+			output.Stdoutl("[recv]", data)
+		}
+	)
+	defer cxl()
+
+	go fn(ch)
+
+	select {
+	case ch <- 1:
+		output.Stdoutl("[send]", 1)
+	case <-ctx.Done():
+	}
+
+	//
+	// チャネルにデータを送信するものがいなくなるので
+	// 上のgoroutineはプロセスが起動中は永遠に終了しません。
+	//
+	time.Sleep(1 * time.Second)
+
+	return nil
+}

examples/basic/goroutines/leak/abandoned_sender.go

@@ -0,0 +1,48 @@
+package leak
+
+import (
+	"context"
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// AbandonedSender -- goroutineリークが発生するパターンのサンプルです。
+//
+// チャネルの送受信の実装があるが、タイミングによっては受信側がいなくなってしまうパターン。
+// 送信側のgoroutineが永遠に待ち続けるので終了しません。
+//
+// 解決方法としては、Bufferedなチャネルを使うこと。
+//
+// REFERENCES:
+//   - https://betterprogramming.pub/common-goroutine-leaks-that-you-should-avoid-fe12d12d6ee
+func AbandonedSender() error {
+	var (
+		ctx, cxl = context.WithTimeout(context.Background(), 10*time.Millisecond)
+		ch       = make(chan int)
+		iowait   = func() {
+			time.Sleep(1 * time.Second)
+		}
+		fn = func(ch chan<- int) {
+			iowait()
+			ch <- 1
+			output.Stdoutl("[send]", 1)
+		}
+	)
+	defer cxl()
+
+	go fn(ch)
+	select {
+	case v := <-ch:
+		output.Stdoutl("[recv]", v)
+	case <-ctx.Done():
+	}
+
+	//
+	// チャネルからデータを受信するものがいなくなるので
+	// 上のgoroutineはプロセスが起動中は永遠に終了しません。
+	//
+	time.Sleep(1 * time.Second)
+
+	return nil
+}

examples/basic/goroutines/leak/examples.go

@@ -0,0 +1,21 @@
+package leak
+
+import "github.com/devlights/try-golang/mapping"
+
+type (
+	register struct{}
+)
+
+// NewRegister -- このパッケージ用のサンプルを登録する mapping.Register を生成します。
+func NewRegister() mapping.Register {
+	return new(register)
+}
+
+// Regist -- 登録します.
+func (r *register) Regist(m mapping.ExampleMapping) {
+	m["goroutines_leak_forgotten_sender"] = ForgottenSender
+	m["goroutines_leak_forgotten_receiver"] = ForgottenReceiver
+	m["goroutines_leak_abandoned_sender"] = AbandonedSender
+	m["goroutines_leak_abandoned_receiver"] = AbandonedReceiver
+	m["goroutines_leak_sender_after_error_check"] = SenderAfterErrorCheck
+}

examples/basic/goroutines/leak/forgotten_receiver.go

@@ -0,0 +1,36 @@
+package leak
+
+import (
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// ForgottenReceiver -- goroutineリークが発生するパターンのサンプルです。
+//
+// チャネルを作成し、チャネルの受信側がいないパターン。
+// 送信側のgoroutineが永遠に待ち続けるので終了しません。
+//
+// 解決方法としては、Bufferedなチャネルを使うこと。
+//
+// REFERENCES:
+//   - https://betterprogramming.pub/common-goroutine-leaks-that-you-should-avoid-fe12d12d6ee
+func ForgottenReceiver() error {
+	var (
+		fn = func(ch chan<- int) {
+			ch <- 1
+			output.Stdoutl("[goroutine leak]", 1)
+		}
+		ch = make(chan int)
+	)
+
+	go fn(ch)
+
+	//
+	// チャネルのデータを受信するものがいないので
+	// 上のgoroutineはプロセスが起動中は永遠に終了しません。
+	//
+	time.Sleep(1 * time.Second)
+
+	return nil
+}

examples/basic/goroutines/leak/forgotten_sender.go

@@ -0,0 +1,36 @@
+package leak
+
+import (
+	"time"
+
+	"github.com/devlights/gomy/output"
+)
+
+// ForgottenSender -- goroutineリークが発生するパターンのサンプルです。
+//
+// チャネルを作成し、チャネルの送信側がいないパターン。
+// 受信側のgoroutineが永遠に待ち続けるので終了しません。
+//
+// 解決方法としては、送信側が適切に使い終わったチャネルを閉じること。
+//
+// REFERENCES:
+//   - https://betterprogramming.pub/common-goroutine-leaks-that-you-should-avoid-fe12d12d6ee
+func ForgottenSender() error {
+	var (
+		fn = func(ch <-chan int) {
+			data := <-ch
+			output.Stdoutl("[goroutine leak]", data)
+		}
+		ch = make(chan int)
+	)
+
+	go fn(ch)
+
+	//
+	// チャネルにデータを送信するものがいないので
+	// 上のgoroutineはプロセスが起動中は永遠に終了しません。
+	//
+	time.Sleep(1 * time.Second)
+
+	return nil
+}

examples/basic/goroutines/leak/sender_after_error_check.go

@@ -0,0 +1,43 @@
+package leak
+
+import (
+	"errors"
+
+	"github.com/devlights/gomy/output"
+)
+
+// SenderAfterErrorCheck -- goroutineリークが発生するパターンのサンプルです。
+//
+// チャネルの送受信の実装があるが、内部の処理結果によっては送信側がいなくなってしまうパターン。
+// 受信側のgoroutineが永遠に待ち続けるので終了しません。
+//
+// 解決方法としては、送信側が適切に使い終わったチャネルを閉じること。
+//
+// REFERENCES:
+//   - https://betterprogramming.pub/common-goroutine-leaks-that-you-should-avoid-fe12d12d6ee
+func SenderAfterErrorCheck() error {
+	var (
+		ch   = make(chan int)
+		proc = func() bool {
+			return false
+		}
+		fn = func(ch <-chan int) {
+			data := <-ch
+			output.Stdoutl("[recv]", data)
+		}
+	)
+
+	go fn(ch)
+
+	if !proc() {
+		return errors.New("this is dummy error")
+	}
+
+	//
+	// 上でエラーが発生した場合、以下は処理されない。
+	// なので、上で起動しているgoroutineは永遠に受信待機することになる。
+	//
+	ch <- 1
+
+	return nil
+}