見出し画像

GoとLaunchDarklyでフィーチャーフラグを実装する

homie株式会社｜住宅・不動産営業DX支援

はじめに

業務でフィーチャーフラグを実装をする機会があり、技術調査の一環でフィチーチャーフラグのプラットフォームであるLaunchDarklyを使って実装してみました。
この記事では、Go言語とLaunchDarklyを使った具体的なフィーチャーフラグの実装方法について解説します。フィーチャーフラグ自体の概要やメリットについては、多くの記事で詳しく説明されていますので、ここでは割愛します。
フィーチャーフラグについては、よくわからないという方は以下の記事がおすすめです。
フィーチャーフラグ（Feature Flag）はなぜ必要なのか？
Feature Flag

やること

この記事では以下の内容で進めます。
・LaunchDarklyでフィーチャーフラグを設定する
・設定したフィーチャーフラグをSDKを使って取得する

動作環境

Goバージョン：1.22.5

1.LaunchDarklyでフラグを設定

LaunchDarklyでアカウントを作成後、Create flagよりフラグを追加します。

2.フラグの取得

2-1.SDKのインストール

go get github.com/launchdarkly/go-server-sdk/v7

2-2.バックエンドでの実装
SDKを使ってLaunchDarklyに設定したフラグを取得します。
以下のコードを追加（LaunchDarklyから引用）。
featureFlagKeyには、作成したfeature flagのキーを指定してください。

package main

import (
	"fmt"
	"os"
	"time"

	"github.com/launchdarkly/go-sdk-common/v3/ldcontext"
	"github.com/launchdarkly/go-sdk-common/v3/ldvalue"
	ld "github.com/launchdarkly/go-server-sdk/v7"
)

  func showBanner() {
    fmt.Print("\n        ██       \n" +
      "          ██     \n" +
      "      ████████   \n" +
      "         ███████ \n" +
      "██ LAUNCHDARKLY █\n" +
      "         ███████ \n" +
      "      ████████   \n" +
      "          ██     \n" +
      "        ██       \n")
  }

  func showMessage(s string) { fmt.Printf("*** %s\n\n", s) }

  func main() {
    var sdkKey = os.Getenv("LAUNCHDARKLY_SDK_KEY")

    if sdkKey == "" {
      showMessage("LaunchDarkly SDK key is required: set the LAUNCHDARKLY_SDK_KEY environment variable and try again.")
      os.Exit(1)
    }

    ldClient, _ := ld.MakeClient(sdkKey, 5*time.Second)
    if ldClient.Initialized() {
      showMessage("SDK successfully initialized!")
    } else {
      showMessage("SDK failed to initialize")
      os.Exit(1)
    }

    // Set up the evaluation context. This context should appear on your LaunchDarkly contexts dashboard
    // soon after you run the demo.
    context := ldcontext.NewBuilder("example-user-key").
      Name("Sandy").
      Build()

    // Set featureFlagKey to the feature flag key you want to evaluate.
    var featureFlagKey = "sample-feature"

    if os.Getenv("LAUNCHDARKLY_FLAG_KEY") != "" {
      featureFlagKey = os.Getenv("LAUNCHDARKLY_FLAG_KEY")
    }

    flagValue, err := ldClient.BoolVariation(featureFlagKey, context, false)
    if err != nil {
      showMessage("error: " + err.Error())
    }

    showMessage(fmt.Sprintf("The '%s' feature flag evaluates to %t.", featureFlagKey, flagValue))

    if flagValue {
      showBanner()
    }

    if os.Getenv("CI") != "" {
      os.Exit(0)
    }

    updateCh := ldClient.GetFlagTracker().AddFlagValueChangeListener(featureFlagKey, context, ldvalue.Null())

    for event := range updateCh {
      showMessage(fmt.Sprintf("The '%s' feature flag evaluates to %t.", featureFlagKey, event.NewValue.BoolValue()))
      if event.NewValue.BoolValue() {
        showBanner()
      }
    }
  }

2-3.SDK キーの取得
LaunchDarklyから設定データを取得するには SDKのキーが必要になります。
キーはLaunchDarklyの以下の画面からコピーします。

  1. アカウント設定(歯車アイコン)をクリック

  2. サイドバーのProjectsを選択

  3. プロジェクト名を選択

  4. 環境ごとのキーが表示されるので使いたい環境のキーをコピー（以下の画像)

先ほどコピーしたキーを.envに追加。

LAUNCHDARKLY_SDK_KEY=XXXXXXXX

環境変数の登録

$ source .env
$ env | grep SDK
LAUNCHDARKLY_SDK_KEY=XXXXXXXX

起動するとフラグを取得し、フラグの状態を表示がされます

$ go run main.go
[LaunchDarkly] 2024/08/02 00:28:25 INFO: Starting LaunchDarkly client 7.6.0
[LaunchDarkly] 2024/08/02 00:28:25 INFO: Starting LaunchDarkly streaming connection
[LaunchDarkly] 2024/08/02 00:28:25 INFO: Waiting up to 5000 milliseconds for LaunchDarkly client to start...
[LaunchDarkly] 2024/08/02 00:28:25 INFO: Connecting to LaunchDarkly stream
[LaunchDarkly] 2024/08/02 00:28:26 INFO: LaunchDarkly streaming is active
[LaunchDarkly] 2024/08/02 00:28:26 INFO: Initialized LaunchDarkly client
*** SDK successfully initialized!

*** The 'sample-feature' feature flag evaluates to true.


        ██
          ██
      ████████
         ███████
██ LAUNCHDARKLY █
         ███████
      ████████
          ██
        ██

LaunchDarklyのフラグ管理画面で取得するフラグをOFFで保存します。そうすると、取得した設定データもOFFになることがわかります。

*** The 'sample-feature' feature flag evaluates to false.

指定したフラグがない場合はエラーが返されます。

*** error: unknown feature key: sample. Verify that this feature key exists. Returning default value

コンテキストについて

コンテキストを使用すると、ユーザー、組織、デバイスなどに関連する属性を基に、フィーチャーフラグのターゲットルールを柔軟に作成できます。これにより、特定のユーザーやグループに対して、異なるフィーチャーフラグの設定を適用することが可能です。

以下のコード例では、「Sandy」という名前のユーザーコンテキストを作成し、そのユーザーに基づいたフィーチャーフラグの評価を行えるようにしています。

context := ldcontext.NewBuilder("example-user-key").
      Name("Sandy").
      Build()

このコードでは、example-user-key というキーを持つコンテキストが作成され、Name("Sandy") により、名前が "Sandy" であるユーザーとして識別されます。このコンテキストを使うことで、LaunchDarklyは "Sandy" に対して適切なフラグのバリエーションを提供します。
作成されたコンテキストはLaunchDarklyの以下の画面から確認できます。

フラグに個別のコンテキストを割り当てる

フラグページにある「Add rule」から「Target individuals」を選択。
コンテキストの対象として先ほど作成した「Sandy」を選択することができるようになっています。

少数のコンテキストなどを個別に対象とするときに利用できそうです。

その他

クイックスタートで始めると様々な言語のSDKを使って手軽に設定データの取得、動作確認をすることができます。

さらに、LaunchDarklyでは監視やデータ分析などのサービスとも連携できる点も魅力的です。
https://launchdarkly.com/integrations/
LaunchDarkly以外にもフィーチャーフラグを管理できるサービスは沢山あるようです。
以下の記事でサービスごとの比較がされておりわかりやすかったです。
世の中のフィーチャーフラグのベンダー比較 （2024年前半）

まとめ

今回はGoのSDKが提供されていてすぐに利用できる点とドキュメントが豊富で初めて利用する場合でもとっつきやすいなどの理由からLaunchDarklyを選択しました。
LaunchDarklyを触ってみたところ、UIも直感的で使いやすく設計されており、非エンジニアの方でも直感的に操作できると感じました。
また、ドキュメントも豊富で、SDKの使い方などについても非常にわかりやすくまとめられていました。

LaunchDarklyの試用期間はサインアップから2週間になっています。トライアル期間が終わるとフラグの作成や編集などはできなくなるようでした。
継続して使用する場合は、プランの変更が必要ですので、試用期間中にその機能やサービスが自分のニーズに合っているかをしっかりと確認することをお勧めします。

参考

https://pkg.go.dev/github.com/launchdarkly/go-server-sdk/v6
https://docs.launchdarkly.com/home