https://github.com/n-r-w/singleflight

Golang Singleflight group with generics
https://github.com/n-r-w/singleflight

Last synced: 5 days ago
JSON representation

Golang Singleflight group with generics

• Host: GitHub
• URL: https://github.com/n-r-w/singleflight
• Owner: n-r-w
• License: bsd-2-clause
• Created: 2024-02-25T08:53:35.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-26T09:38:32.000Z (9 months ago)
• Last Synced: 2024-06-21T14:28:37.687Z (5 months ago)
• Language: Go
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Go Reference](https://pkg.go.dev/badge/github.com/n-r-w/singleflight.svg)](https://pkg.go.dev/github.com/n-r-w/singleflight)

[![Go Coverage](https://github.com/n-r-w/singleflight/wiki/coverage.svg)](https://raw.githack.com/wiki/n-r-w/singleflight/coverage.html)

![CI Status](https://github.com/n-r-w/singleflight/actions/workflows/go.yml/badge.svg)

[![Stability](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

[![Go Report](https://goreportcard.com/badge/github.com/n-r-w/singleflight)](https://goreportcard.com/badge/github.com/n-r-w/singleflight)

# singleflight

Fork from `golang.org/x/sync/singleflight` with generics and context support.

## Usage

Singleflight is a concurrency method to prevent duplicate work from being executed due to multiple calls for the same resource.

V2 contains breaking changes from V1, because it adds context and reorders the output parameters of the `Do` method (putting the error last).

Context cancellation should be handled inside the function passed to `Do`, because singleflight does not interrupt the function execution if the context is canceled.

```bash

go get github.com/n-r-w/singleflight/v2

```

```go

package main

import (

    "log"

    "time"

    "github.com/n-r-w/singleflight/v2"

    "golang.org/x/sync/errgroup"

)

func main() {

    var (

        g singleflight.Group[int, string]

        errGroup errgroup.Group

        ctx = context.Background()

    )

    const key = 1

    // 10 goroutines are trying to get the value for the same key,

    // but only one of them will call the function and the others will wait for the result.

    for i := 0; i < 10; i++ {

        iCopy := i

        errGroup.Go(func() error {

            _, _, err := g.Do(ctx, key, func(_ context.Context) (string, error) {

                log.Println("called for", iCopy)

                time.Sleep(1 * time.Second)

                return "Hello, world!", nil

            })

            return err

        })

    }

    if err := errGroup.Wait(); err != nil {

        log.Println(err)

    }

}

```