feat: add provider implementation #3

duyhungtnn · 2025-09-10T12:49:13Z

This PR initializes a new OpenFeature provider for Bucketeer, creating a Node.js server SDK that bridges the Bucketeer feature flag service with OpenFeature's standardized API.

Copilot

Pull Request Overview

This PR initializes a new OpenFeature provider for Bucketeer, creating a Node.js server SDK that bridges the Bucketeer feature flag service with OpenFeature's standardized API.

Sets up TypeScript project configuration with linting, formatting, and build tools
Implements BuckeeterProvider class that wraps the Bucketeer SDK to provide OpenFeature-compatible flag evaluation
Creates utility functions for converting between OpenFeature evaluation contexts and Bucketeer user objects

Reviewed Changes

Copilot reviewed 14 out of 16 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
package.json	Defines project metadata, dependencies, and peer dependencies for the OpenFeature Bucketeer provider
src/internal/BucketeerProvider.ts	Main provider implementation with flag evaluation methods and client initialization
src/internal/EvaluationContext.ts	Utility functions for converting OpenFeature contexts to Bucketeer user objects
src/internal/BKTEvaluationDetailExt.ts	Helper functions to convert Bucketeer evaluation details to OpenFeature resolution details
src/internal/version.ts	Exports SDK version from package.json
src/index.ts	Main entry point exporting the provider and re-exporting Bucketeer SDK types
tsconfig.test.json	TypeScript configuration for test files
tslint.json	TSLint configuration extending basic rules
eslint.config.mjs	ESLint configuration for TypeScript files
.prettierrc.js	Code formatting configuration
.prettierignore	Files to exclude from Prettier formatting
.nvmrc	Node.js version specification
.npmrc	NPM registry configuration
.npmignore	Files to exclude from NPM package

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/internal/BucketeerProvider.ts

tsconfig.test.json

package.json

Copilot

Pull Request Overview

Copilot reviewed 14 out of 16 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

package.json

tsconfig.test.json

src/internal/BucketeerProvider.ts

Copilot

Pull Request Overview

Copilot reviewed 16 out of 19 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/internal/version.ts

src/internal/BucketeerProvider.ts

tslint.json

Copilot

Pull Request Overview

Copilot reviewed 15 out of 18 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/internal/version.ts

eslint.config.mjs

Copilot

Pull Request Overview

Copilot reviewed 18 out of 22 changed files in this pull request and generated 5 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/internal/BucketeerProvider.ts

test/BucketeerProvider.test.ts

Copilot

Pull Request Overview

Copilot reviewed 18 out of 22 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

test/EvaluationContext.test.ts

duyhungtnn · 2025-10-02T09:12:39Z

Updated

Document in README
E2e tests
Example
Github workflows
- e2e
- pull_request

Copilot

Pull Request Overview

Copilot reviewed 35 out of 40 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/internal/BucketeerProvider.ts

Replaces default import of dotenv with named import and updates usage in bucketeer-config.ts. Adds fallback values for userAgent and ipAddress in flags route. Fixes tsconfig.json structure and adds allowSyntheticDefaultImports option. feat: init SDK feat: added detail implementation chore: edit parameter names in BucketeerProvider methods Replaces underscored parameter names with direct names in evaluation methods for clarity and consistency. Updates internal references to use the new parameter names. fix: assign client instance in BucketeerProvider Sets the initialized client to `this.client` in BucketeerProvider to ensure the instance is available after initialization. Also removes the empty 'exclude' array from tsconfig.test.json. chore: Reset client to undefined on close After destroying the client in onClose, set the client property to undefined to ensure proper cleanup and prevent potential reuse of a destroyed client instance. chore: switch test runner from Ava to Jest Replaced Ava and related packages with Jest, ts-jest, and @types/jest in package.json. Updated tsconfig.test.json to remove unused types. This change standardizes testing on Jest for better TypeScript integration and ecosystem support. test: add Jest test setup and initial unit tests Introduces Jest configuration and scripts for testing. Adds unit tests for BKTEvaluationDetailExt and EvaluationContext utilities. Updates TypeScript config to include test files and removes tsconfig.test.json. Cleans up package.json scripts and dependencies. test: init provider test test: evaluation logic chore: Use constant for initialization timeout Replaces hardcoded timeout value with DEFAULT_WAIT_FOR_INITIALIZATION_TIMEOUT_MS in BuckeeterProvider and updates related test to use the constant. This improves maintainability and consistency. fix: use SDK version import in version.ts Replaces require with ES module import for package.json to improve consistency and compatibility with modern TypeScript/ES module syntax. chore: add initialization timeout option to BuckeeterProvider BuckeeterProvider now accepts an optional initializationTimeoutMs parameter, allowing customization of the client initialization timeout. Updated related tests to cover the new option and default behavior. Also removed test files from tsconfig.json 'include' and deleted tslint.json. fix: ESLint config: use 'extends' instead of 'plugins' Replaces the incorrect 'plugins' key with 'extends' in the ESLint configuration to properly apply recommended TypeScript and Prettier rules. chore: update import syntax for package.json Changed the import statement for package.json to use default import syntax, improving compatibility with module systems. fix: lint fail in tests by using explicit undefined variable Replaces direct usage of 'undefined' with an explicit variable cast to 'any' in test cases for convertContextValueToString and evaluationContextToBKTUser. This improves clarity and type safety in the test suite. chore: improve config validation in BucketeerProvider Constructor now uses defineBKTConfig to validate and fill defaults for user-provided config. This ensures missing required fields are caught early, providing faster feedback to developers. Also, wrapper SDK version and source ID are always set, overriding user values. test: update BucketeerProvider test config initialization Refactored test configuration to use defineBKTConfig for both mockConfig and expectedConfig. Updated interval values to milliseconds and incremented appVersion to 1.0.1 for consistency with the new config structure. chore: enable lint check chore: add PR title validation and CI workflows Introduces GitHub Actions workflows for validating pull request titles against semantic conventions and for running CI tasks including dependency installation, linting, unit tests, and build on PRs targeting the main branch. Update .prettierignore to exclude more directories Expanded the .prettierignore file to ignore common build, coverage, and dependency directories, including .github/, node_modules/, dist/, build/, coverage/, and their equivalents in example subdirectories. fix: build command fix(typo): Rename BuckeeterProvider to BucketeerProvider Corrects the class name, import/export statements, and test references from 'BuckeeterProvider' to 'BucketeerProvider' for consistency and accuracy. chore: init example Update .gitignore feat: init example chore: update make_file test: init e2e test test: add dotenv support and update SDK dependencies Introduced .env.example and dotenv for environment variable management. Updated constants to use new variable names, added jest.setup.js for dotenv initialization, and configured Jest to use the setup file. Upgraded bkt-node-server-sdk to v0.4.2 and added dotenv to devDependencies. fix: BucketeerProvider tests for config handling Simplifies test variable naming and improves assertions to verify that SDK version and source ID are set internally, regardless of user config input. Removes redundant expectedConfig and clarifies the initialization logic in BucketeerProvider tests. test(e2e): evaluation test cases The BucketeerProvider now includes the SDK version in its metadata. Also, SDK_VERSION is exported from the main entry point. Added comprehensive e2e tests for feature flag evaluation covering boolean, string, number, and JSON types. fix: update e2e test case chore: add local evaluation tests and rename remote tests Introduced localEvaluate.test.ts to test BucketeerProvider with local evaluation enabled. Renamed evaluate.test.ts to remoteEvaluate.test.ts and added logger to the BKTConfig in the remote evaluation tests for consistency. Create e2e.yml fix: lint fail because unused file Update pull-request.yml fixf: formatting in example project files Added a missing newline in tsconfig.json and package.json, and improved spacing in README.md for better readability and consistency. Update README and flags route with improved examples Expanded the README with comprehensive usage instructions, examples, and documentation for integrating Bucketeer with OpenFeature in Node.js. Refactored the example flags route to use request headers for evaluation context and return multiple feature flag values, aligning with the new documentation. Update README.md chore: remove push trigger for feat/example branch in workflows The push event for the 'feat/example' branch has been removed from both e2e.yml and pull-request.yml workflows, leaving only workflow_dispatch and workflow_call triggers. This streamlines workflow execution and prevents unnecessary runs on pushes to the example feature branch. chore: move and update imports in e2e test Renamed localEvaluate.test.ts and remoteEvaluate.test.ts from the constants directory to the e2e root. Updated import paths to reference './constants/constants' instead of './constants'. fix: correct context Updated README and e2e tests to import BucketeerProvider and defineBKTConfig from '@bucketeer/openfeature-node-server-sdk' instead of 'bkt-node-server-sdk'. Refactored tests to explicitly pass evaluation context to feature flag evaluation methods, improving clarity and aligning with OpenFeature best practices. fix: handle missing case when resolving object with null Refactor type mismatch object evaluation tests Consolidated multiple individual tests for type mismatches in object evaluation into a single parameterized test suite. This improves maintainability and reduces code duplication in BucketeerProvider tests.

Copilot

Pull Request Overview

Copilot reviewed 35 out of 42 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

example/.env.example

nnnkkk7

Thanks!
LGTM!!

duyhungtnn · 2025-10-30T14:21:07Z

Hi @cre8ivejp, @nnnkkk7,
I think there’s an issue in the objectVariationDetails method implementation.
The provider throws an error when returning a default evaluation where evaluation_value is not an object.

For example:

If the user sets the default value to null and there’s no evaluation for the flag key,
our SDK returns the default evaluation using the user’s default value — in this case, variationValue will be null.
null is a valid type for both OpenFeature JsonValue and our SDK’s BKTValue.
So Our Provider throw an error, but it should not.

Please do not merge this PR, I will make a fix.

Updated BucketeerProvider to accept all valid JsonValue types, including null and primitives, in objectVariationDetails. Adjusted related tests to reflect the new behavior and removed type mismatch error handling for non-object values.

Copilot

Pull Request Overview

Copilot reviewed 35 out of 42 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

duyhungtnn · 2025-10-31T03:19:53Z

I updated the PR 2cc7966
Please help me to take a look @nnnkkk7

nnnkkk7

LGTM!
Thank you!

cre8ivejp

Amazing work!
Thank you 🎉

duyhungtnn self-assigned this Sep 10, 2025

duyhungtnn requested a review from Copilot September 10, 2025 12:55

Copilot AI reviewed Sep 10, 2025

View reviewed changes

src/internal/BucketeerProvider.ts Outdated Show resolved Hide resolved

tsconfig.test.json Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

duyhungtnn requested a review from Copilot September 11, 2025 02:21

Copilot AI reviewed Sep 11, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

tsconfig.test.json Outdated Show resolved Hide resolved

src/internal/BucketeerProvider.ts Outdated Show resolved Hide resolved

duyhungtnn requested a review from Copilot September 12, 2025 08:20

Copilot AI reviewed Sep 12, 2025

View reviewed changes

src/internal/version.ts Outdated Show resolved Hide resolved

src/internal/BucketeerProvider.ts Show resolved Hide resolved

tslint.json Outdated Show resolved Hide resolved

duyhungtnn requested a review from Copilot September 12, 2025 09:01

Copilot AI reviewed Sep 12, 2025

View reviewed changes

src/internal/version.ts Outdated Show resolved Hide resolved

eslint.config.mjs Outdated Show resolved Hide resolved

duyhungtnn marked this pull request as ready for review September 12, 2025 09:12

duyhungtnn requested review from cre8ivejp and nnnkkk7 as code owners September 12, 2025 09:12

duyhungtnn requested a review from Copilot September 12, 2025 10:43

Copilot AI reviewed Sep 12, 2025

View reviewed changes

duyhungtnn requested a review from Copilot September 12, 2025 10:48

Copilot AI reviewed Sep 12, 2025

View reviewed changes

test/EvaluationContext.test.ts Show resolved Hide resolved

test/EvaluationContext.test.ts Show resolved Hide resolved

test/EvaluationContext.test.ts Show resolved Hide resolved

duyhungtnn requested a review from Copilot October 2, 2025 09:14

Copilot AI reviewed Oct 2, 2025

View reviewed changes

nnnkkk7 reviewed Oct 22, 2025

View reviewed changes

src/internal/BucketeerProvider.ts Outdated Show resolved Hide resolved

src/internal/BucketeerProvider.ts Show resolved Hide resolved

duyhungtnn added 2 commits October 27, 2025 20:08

fix: lint fail

345384f

duyhungtnn force-pushed the feat/init-sdk branch from e130015 to 345384f Compare October 27, 2025 13:09

duyhungtnn requested review from Copilot and nnnkkk7 October 27, 2025 13:21

Copilot AI reviewed Oct 27, 2025

View reviewed changes

example/.env.example Outdated Show resolved Hide resolved

Update .env.example

225b880

nnnkkk7 approved these changes Oct 30, 2025

View reviewed changes

duyhungtnn marked this pull request as draft October 30, 2025 14:21

duyhungtnn requested a review from Copilot October 31, 2025 03:17

Copilot AI reviewed Oct 31, 2025

View reviewed changes

duyhungtnn requested a review from nnnkkk7 October 31, 2025 03:18

duyhungtnn marked this pull request as ready for review October 31, 2025 03:24

chore: remove unused code

76bae88

nnnkkk7 approved these changes Nov 10, 2025

View reviewed changes

cre8ivejp approved these changes Nov 17, 2025

View reviewed changes

cre8ivejp changed the title ~~feat: init provider~~ feat: add provider implementation Nov 17, 2025

cre8ivejp merged commit 18e1dea into main Nov 17, 2025
4 checks passed

cre8ivejp deleted the feat/init-sdk branch November 17, 2025 01:58

bucketeer-bot mentioned this pull request Nov 19, 2025

chore: release v0.0.1 #6

Merged

cre8ivejp mentioned this pull request Nov 19, 2025

chore: release v0.0.1 #9

Merged

feat: add provider implementation #3

feat: add provider implementation #3

Uh oh!

Conversation

duyhungtnn commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

duyhungtnn commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Updated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

nnnkkk7 left a comment

Choose a reason for hiding this comment

Uh oh!

duyhungtnn commented Oct 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

duyhungtnn commented Oct 31, 2025

Uh oh!

nnnkkk7 left a comment

Choose a reason for hiding this comment

Uh oh!

duyhungtnn commented Sep 10, 2025 •

edited

Loading

duyhungtnn commented Oct 2, 2025 •

edited

Loading