[FSSDK-8823] chore: prepare for release 4.0.0 (#411)

* use go-sdk v2

* update changelog

* update readme

* update readme

* update changelog & Makefile

* use go-sdk v2.0.0

Author: pulak-opti

CHANGELOG.md

@@ -4,6 +4,53 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [4.0.0] - January 22, 2023
+
+### New Features
+
+The 4.0.0 release introduces a new primary feature, [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) enabled through integration with [Optimizely Data Platform (ODP)](https://docs.developers.optimizely.com/optimizely-data-platform/docs) ([#356](https://github.com/optimizely/agent/pull/356), [#364](https://github.com/optimizely/agent/pull/364), [#365](https://github.com/optimizely/agent/pull/365), [#366](https://github.com/optimizely/agent/pull/366)).
+
+You can use ODP, a high-performance [Customer Data Platform (CDP)](https://www.optimizely.com/optimization-glossary/customer-data-platform/), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.
+
+With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.
+
+This version includes the following changes:
+
+- `FetchQualifiedSegments()` API has been added to the `/decide` endpoint. This API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. Fetched data will be stored in the local cache to avoid repeated network delays.
+
+- `SendOdpEvent()` API has been added with the `/send-opd-event` endpoint. Customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.
+
+For details, refer to our documentation pages:
+
+* [Advanced Audience Targeting](https://docs.developers.optimizely.com/feature-experimentation/docs/optimizely-data-platform-advanced-audience-targeting) 
+
+* [Server SDK Support](https://docs.developers.optimizely.com/feature-experimentation/docs/advanced-audience-targeting-for-server-side-sdks)
+
+* [Use Optimizely Agent](https://docs.developers.optimizely.com/feature-experimentation/docs/use-optimizely-agent)
+
+* [Configure Optimizely Agent](https://docs.developers.optimizely.com/feature-experimentation/docs/configure-optimizely-agent)
+
+This release also introduces a fundamental enhancement to the agent with the addition of a datafile syncer. This feature is designed to facilitate seamless synchronization of datafiles across agent nodes, ensuring consistency and accuracy in the operation of the webhook API.
+The datafile syncer uses a PubSub system (Default: Redis) to send updated datafile webhook notification to Agent nodes (in HA system) so that nodes can immediately fetch the latest datafile. ([#405](https://github.com/optimizely/agent/pull/405))
+
+### Breaking Changes
+
+- ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated. From Agent, it can be switched off from config.yaml or env variables.
+- Updated go-sdk version to v2.0.0 with module path github.com/optimizely/go-sdk/v2
+
+### Functionality Enhancement
+
+* Updated openapi schema to 3.1.0. ([#392](https://github.com/optimizely/agent/pull/392))
+* Added support for prometheus metrics. ([#348](https://github.com/optimizely/agent/pull/348))
+* Github Issue template is udpated. ([#396](https://github.com/optimizely/agent/pull/396))
+* Updated go version to 1.21. ([#398](https://github.com/optimizely/agent/pull/398))
+* Added OpenTelemetry Tracing Support. ([#400](https://github.com/optimizely/agent/pull/400))
+* Added traceID & spanID to logs. ([#407](https://github.com/optimizely/agent/pull/407))
+
+### Bug fixes
+
+In previous versions, there was an issue where the Notification API would miss notification events when the Agent was operating in HA mode. It only got notification events from one Agent node. The bug has been addressed in this release with the implementation of a comprehensive solution. A PubSub system (Default: Redis) is used to ensure consistent retrieval of notification events across all nodes in an HA setup. ([#399](https://github.com/optimizely/agent/pull/399))
+
 ## [3.2.0] - December 13, 2023
 
 ### New Features

Makefile

@@ -23,7 +23,7 @@ MAKEFLAGS += --silent
 # Use linker flags to strip debugging info from the binary.
 # -s Omit the symbol table and debug information.
 # -w Omit the DWARF symbol table.
-LDFLAGS=-ldflags "-s -w -X main.Version=${APP_VERSION} -X github.com/optimizely/go-sdk/pkg/event.ClientName=Agent -X github.com/optimizely/go-sdk/pkg/event.Version=${APP_VERSION}"
+LDFLAGS=-ldflags "-s -w -X main.Version=${APP_VERSION} -X github.com/optimizely/go-sdk/v2/pkg/event.ClientName=Agent -X github.com/optimizely/go-sdk/v2/pkg/event.Version=${APP_VERSION}"
 .PHONY: all lint clean
 
 all: test lint build ## runs the test, lint and build targets

README.md

@@ -433,6 +433,14 @@ sys
 (c) 2009 The Go Authors
 License (BSD 3-Clause): https://github.com/golang/sys
 
+opentelemetry-go
+Copyright The OpenTelemetry Authors
+License (Apache-2.0): https://github.com/open-telemetry/opentelemetry-go
+
+prometheus client_golang
+Copyright 2015 The Prometheus Authors
+License (Apache-2.0): https://github.com/prometheus/client_golang
+
 ## Apache Copyright Notice
 
 Copyright 2019-present, Optimizely, Inc. and contributors

cmd/optimizely/main.go

@@ -50,7 +50,7 @@ import (
 	_ "github.com/optimizely/agent/plugins/interceptors/all"       // Initiate the loading of the userprofileservice plugins
 	_ "github.com/optimizely/agent/plugins/odpcache/all"           // Initiate the loading of the odpCache plugins
 	_ "github.com/optimizely/agent/plugins/userprofileservice/all" // Initiate the loading of the interceptor plugins
-	"github.com/optimizely/go-sdk/pkg/logging"
+	"github.com/optimizely/go-sdk/v2/pkg/logging"
 )
 
 // Version holds the admin version

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/golang-jwt/jwt/v4 v4.5.0
 	github.com/google/uuid v1.3.1
 	github.com/lestrrat-go/jwx v0.9.0
-	github.com/optimizely/go-sdk v1.8.4-0.20240118173841-4adb1affdb93
+	github.com/optimizely/go-sdk/v2 v2.0.0
 	github.com/orcaman/concurrent-map v1.0.0
 	github.com/prometheus/client_golang v1.11.0
 	github.com/rakyll/statik v0.1.7

go.sum

@@ -244,8 +244,8 @@ github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE=
 github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU=
 github.com/onsi/gomega v1.18.1 h1:M1GfJqGRrBrrGGsbxzV5dqM2U2ApXefZCQpkukxYRLE=
 github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs=
-github.com/optimizely/go-sdk v1.8.4-0.20240118173841-4adb1affdb93 h1:aySLExk0xgvlquiBwTnmir49OIAoP8tjYTCaYgm9JqY=
-github.com/optimizely/go-sdk v1.8.4-0.20240118173841-4adb1affdb93/go.mod h1:v1+k17OkqjhWuvTGiFhvaq6KDYRiVFsWrpqr0PnlKAU=
+github.com/optimizely/go-sdk/v2 v2.0.0 h1:GUwblFAgWc6FbRujtNZ4cz6+VlfaVqWXkq8PGs7Hgrw=
+github.com/optimizely/go-sdk/v2 v2.0.0/go.mod h1:MusRCFsU7+XzJCoCTgheLoENJSf1iiFYm4KbJqz6BYA=
 github.com/orcaman/concurrent-map v1.0.0 h1:I/2A2XPCb4IuQWcQhBhSwGfiuybl/J0ev9HDbW65HOY=
 github.com/orcaman/concurrent-map v1.0.0/go.mod h1:Lu3tH6HLW3feq74c2GC+jIMS/K2CFcDWnWD9XkenwhI=
 github.com/pelletier/go-toml/v2 v2.0.6 h1:nrzqCb7j9cDFj2coyLNLaZuJTLjWjlaz6nvTvIwycIU=

pkg/handlers/activate.go

@@ -26,8 +26,8 @@ import (
 
 	"github.com/optimizely/agent/pkg/middleware"
 	"github.com/optimizely/agent/pkg/optimizely"
-	"github.com/optimizely/go-sdk/pkg/config"
-	"github.com/optimizely/go-sdk/pkg/entities"
+	"github.com/optimizely/go-sdk/v2/pkg/config"
+	"github.com/optimizely/go-sdk/v2/pkg/entities"
 )
 
 type keyMap map[string]string

pkg/handlers/activate_test.go

@@ -26,7 +26,7 @@ import (
 	"testing"
 
 	"github.com/go-chi/chi/v5"
-	"github.com/optimizely/go-sdk/pkg/entities"
+	"github.com/optimizely/go-sdk/v2/pkg/entities"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/suite"
 

pkg/handlers/decide.go

@@ -24,10 +24,10 @@ import (
 	"github.com/go-chi/render"
 
 	"github.com/optimizely/agent/pkg/middleware"
-	"github.com/optimizely/go-sdk/pkg/client"
-	"github.com/optimizely/go-sdk/pkg/decide"
-	"github.com/optimizely/go-sdk/pkg/decision"
-	"github.com/optimizely/go-sdk/pkg/odp/segment"
+	"github.com/optimizely/go-sdk/v2/pkg/client"
+	"github.com/optimizely/go-sdk/v2/pkg/decide"
+	"github.com/optimizely/go-sdk/v2/pkg/decision"
+	"github.com/optimizely/go-sdk/v2/pkg/odp/segment"
 )
 
 // DecideBody defines the request body for decide API

pkg/handlers/decide_test.go

@@ -33,10 +33,10 @@ import (
 	"github.com/optimizely/agent/pkg/middleware"
 	"github.com/optimizely/agent/pkg/optimizely"
 	"github.com/optimizely/agent/pkg/optimizely/optimizelytest"
-	"github.com/optimizely/go-sdk/pkg/client"
-	"github.com/optimizely/go-sdk/pkg/decide"
-	"github.com/optimizely/go-sdk/pkg/entities"
-	"github.com/optimizely/go-sdk/pkg/odp/segment"
+	"github.com/optimizely/go-sdk/v2/pkg/client"
+	"github.com/optimizely/go-sdk/v2/pkg/decide"
+	"github.com/optimizely/go-sdk/v2/pkg/entities"
+	"github.com/optimizely/go-sdk/v2/pkg/odp/segment"
 )
 
 type DecideTestSuite struct {