feat(go-feature-flag)!: Introduce in-process evaluation + tracking (#1365)

Signed-off-by: Thomas Poignant <[email protected]>
Signed-off-by: Todd Baert <[email protected]>
Signed-off-by: Patryk Zdunowski <[email protected]>
Signed-off-by: Ryan Lamb <[email protected]>
Signed-off-by: Adam Simon <[email protected]>
Signed-off-by: wadii <[email protected]>
Signed-off-by: Michael Beemer <[email protected]>
Signed-off-by: Giovanni De Giorgio <[email protected]>
Signed-off-by: Lukas Reining <[email protected]>
Signed-off-by: Jonathan Norris <[email protected]>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Todd Baert <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Zdunowski <[email protected]>
Co-authored-by: Ryan Lamb <[email protected]>
Co-authored-by: adams85 <[email protected]>
Co-authored-by: Adam Simon <[email protected]>
Co-authored-by: Zaimwa9 <[email protected]>
Co-authored-by: Michael Beemer <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Giovanni De Giorgio <[email protected]>
Co-authored-by: Zaimwa9 <[email protected]>
Co-authored-by: Lukas Reining <[email protected]>
Co-authored-by: Jonathan Norris <[email protected]>

Author: 14 people

.gitmodules

@@ -17,3 +17,6 @@
 [submodule "libs/shared/flagd-core/spec"]
 	path = libs/shared/flagd-core/spec
 	url = https://github.com/open-feature/spec
+[submodule "libs/providers/go-feature-flag/wasm-releases"]
+	path = libs/providers/go-feature-flag/wasm-releases
+	url = https://github.com/go-feature-flag/wasm-releases.git

libs/providers/go-feature-flag/.eslintrc.json

@@ -1,6 +1,6 @@
 {
   "extends": ["../../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
+  "ignorePatterns": ["!**/*", "src/lib/wasm/wasm_exec.js"],
   "rules": {
     "@typescript-eslint/no-explicit-any": "off",
     "quotes": ["error", "single"]

libs/providers/go-feature-flag/README.md

@@ -1,18 +1,215 @@
-# Server-side Go Feature Flag Provider
+# Server-side GO Feature Flag Provider
 
-This provider is an implementation for [`go-feature-flag`](https://github.com/thomaspoignant/go-feature-flag) a simple and complete
-feature flag solution, without any complex backend system to install, all you need is a file as your backend.
+A feature flag provider for [OpenFeature](https://openfeature.dev/) that integrates with [go-feature-flag](https://github.com/thomaspoignant/go-feature-flag), a simple and complete feature flag solution.
 
-It uses [`go-feature-flag-relay-proxy`](https://github.com/thomaspoignant/go-feature-flag-relay-proxy) which expose the capabilities of the SDK through an API layer.
+This provider supports both **in-process** and **remote** evaluation modes, offering flexibility for different deployment scenarios.
 
-## Installation
+## Features 🚀
 
+- **Dual Evaluation Modes**: In-process evaluation for performance and remote evaluation for centralized control
+- **Real-time Configuration Updates**: Automatic polling for flag configuration changes
+- **Comprehensive Data Collection**: Built-in event tracking and analytics
+- **Flexible Context Support**: Rich evaluation context with targeting rules
+- **Caching**: Intelligent caching with automatic cache invalidation
+- **Error Handling**: Robust error handling with fallback mechanisms
+- **TypeScript Support**: Full TypeScript support with type safety
+- **OpenFeature Compliance**: Full compliance with OpenFeature specification
+
+## Installation 📦
+
+```bash
+npm install @openfeature/go-feature-flag-provider
+```
+
+### Peer Dependencies
+
+```bash
+npm install @openfeature/server-sdk
+```
+
+## Quick Start 🏃‍♂️
+
+### Basic Setup
+
+```typescript
+import { OpenFeature } from '@openfeature/server-sdk';
+import { GoFeatureFlagProvider, EvaluationType } from '@openfeature/go-feature-flag-provider';
+
+// Initialize the provider
+const provider = new GoFeatureFlagProvider({
+  endpoint: 'https://your-relay-proxy.com',
+  evaluationType: EvaluationType.Remote,
+});
+
+// Register the provider
+OpenFeature.setProvider(provider);
+
+// Get a client
+const client = OpenFeature.getClient();
+
+// Evaluate a flag
+const flagValue = await client.getBooleanValue('my-feature-flag', false, {
+  targetingKey: 'user-123',
+  email: '[email protected]',
+});
+```
+
+### In-Process Evaluation
+
+For high-performance scenarios where you want to evaluate flags locally:
+
+```typescript
+import { GoFeatureFlagProvider, EvaluationType } from '@openfeature/go-feature-flag-provider';
+
+const provider = new GoFeatureFlagProvider({
+  endpoint: 'https://your-relay-proxy.com',
+  evaluationType: EvaluationType.InProcess,
+  flagChangePollingIntervalMs: 30000, // Poll every 30 seconds
+});
+```
+
+## Configuration Options ⚙️
+
+### Provider Options
+
+| Option                        | Type               | Default      | Description                                     |
+| ----------------------------- | ------------------ | ------------ | ----------------------------------------------- |
+| `endpoint`                    | `string`           | **Required** | The endpoint of the GO Feature Flag relay-proxy |
+| `evaluationType`              | `EvaluationType`   | `InProcess`  | Evaluation mode: `InProcess` or `Remote`        |
+| `timeout`                     | `number`           | `10000`      | HTTP request timeout in milliseconds            |
+| `flagChangePollingIntervalMs` | `number`           | `120000`     | Polling interval for configuration changes      |
+| `dataFlushInterval`           | `number`           | `120000`     | Data collection flush interval                  |
+| `maxPendingEvents`            | `number`           | `10000`      | Maximum pending events before flushing          |
+| `disableDataCollection`       | `boolean`          | `false`      | Disable data collection entirely                |
+| `apiKey`                      | `string`           | `undefined`  | API key for authentication                      |
+| `exporterMetadata`            | `ExporterMetadata` | `undefined`  | Custom metadata for events                      |
+| `fetchImplementation`         | `FetchAPI`         | `undefined`  | Custom fetch implementation                     |
+
+### Evaluation Types
+
+#### InProcess Evaluation
+
+- **Performance**: Fastest evaluation with local caching
+- **Network**: Minimal network calls, only for configuration updates and tracking
+- **Use Case**: High-performance applications, real-time evaluation
+
+#### Remote Evaluation
+
+- **Performance**: Network-dependent evaluation
+- **Network**: Each evaluation requires a network call, works well with side-cars or in the edge
+- **Use Case**: Centralized control
+
+## Advanced Usage 🔧
+
+### Custom Context and Targeting
+
+```typescript
+const context = {
+  targetingKey: 'user-123',
+  email: '[email protected]',
+  firstname: 'John',
+  lastname: 'Doe',
+  anonymous: false,
+  professional: true,
+  rate: 3.14,
+  age: 30,
+  company_info: {
+    name: 'my_company',
+    size: 120,
+  },
+  labels: ['pro', 'beta'],
+};
+
+const flagValue = await client.getBooleanValue('my-feature-flag', false, context);
+```
+
+### Data Collection and Analytics
+
+The provider automatically collects evaluation data. You can customize this behavior:
+
+```typescript
+const provider = new GoFeatureFlagProvider({
+  endpoint: 'https://your-relay-proxy.com',
+  evaluationType: EvaluationType.Remote,
+  disableDataCollection: false, // Enable data collection
+  dataFlushInterval: 20000, // Flush every 20 seconds
+  maxPendingEvents: 5000, // Max 5000 pending events
+});
+```
+
+### Custom Exporter Metadata
+
+Add custom metadata to your evaluation events:
+
+```typescript
+import { ExporterMetadata } from '@openfeature/go-feature-flag-provider';
+
+const metadata = new ExporterMetadata()
+  .add('environment', 'production')
+  .add('version', '1.0.0')
+  .add('region', 'us-east-1');
+
+const provider = new GoFeatureFlagProvider({
+  endpoint: 'https://your-relay-proxy.com',
+  evaluationType: EvaluationType.Remote,
+  exporterMetadata: metadata,
+});
+```
+
+## Flag Types Supported 🎯
+
+The provider supports all OpenFeature flag types:
+
+### Boolean Flags
+
+```typescript
+const isEnabled = await client.getBooleanValue('feature-flag', false, context);
+const details = await client.getBooleanDetails('feature-flag', false, context);
 ```
-$ npm install @openfeature/go-feature-flag-provider
+
+### String Flags
+
+```typescript
+const message = await client.getStringValue('welcome-message', 'Hello!', context);
+const details = await client.getStringDetails('welcome-message', 'Hello!', context);
 ```
 
-Required peer dependencies
+### Number Flags
 
+```typescript
+const percentage = await client.getNumberValue('discount-percentage', 0, context);
+const details = await client.getNumberDetails('discount-percentage', 0, context);
 ```
-$ npm install @openfeature/server-sdk
+
+### Object Flags
+
+```typescript
+const config = await client.getObjectValue('user-config', {}, context);
+const details = await client.getObjectDetails('user-config', {}, context);
 ```
+
+## Tracking Events 📊
+
+The provider supports custom event tracking:
+
+```typescript
+// Track a custom event
+client.track('user_action', context, {
+  action: 'button_click',
+  page: 'homepage',
+  timestamp: Date.now(),
+});
+```
+
+## Contributing 🤝
+
+We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for details.
+
+## License 📄
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## Support 💬
+
+- **Documentation**: [GO Feature Flag Documentation](https://gofeatureflag.org/), [OpenFeature Documentation](https://openfeature.dev/)
+- **Issues**: [GitHub Issues](https://github.com/thomaspoignant/go-feature-flag/issues)

libs/providers/go-feature-flag/jest.config.ts

@@ -2,13 +2,13 @@
 export default {
   displayName: 'provider-go-feature-flag',
   preset: '../../../jest.preset.js',
-  globals: {
-    'ts-jest': {
-      tsconfig: '<rootDir>/tsconfig.spec.json',
-    },
-  },
   transform: {
-    '^.+\\.[tj]s$': 'ts-jest',
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+      },
+    ],
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
   coverageDirectory: '../../../coverage/libs/providers/go-feature-flag',