features - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #llm #rust #nodejs #java #kubernetes #awesome-list #pytorch #security #openai #open-source

features

(★ 64)

Handy tool to deal with feature toggles.

파일 탐색기

최종 버전 다운로드 (.zip)

- - main.go
- api.go
- collection_serializer.go
- collection_serializer_test.go
- errors.go
- feature.go
- feature_test.go
- response.go
- response_test.go
- router.go
- suite_test.go
- - memory.go
  - memory_test.go
- - suite.go
- engine.go
- model.go
- model_test.go
- - .gitignore
- Godeps.json
- Readme
- main.go
.travis.yml
AUTHORS
CONTRIBUTORS
features.go
features_test.go
go.mk
LICENSE
Makefile
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/albertoleal/features

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd features

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Make

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/albertoleal/features.png?branch=master)](https://travis-ci.org/albertoleal/features)
[![Coverage Status](https://coveralls.io/repos/albertoleal/features/badge.svg?branch=master&service=github)](https://coveralls.io/github/albertoleal/features?branch=master)

# Features

Features helps you to determine whether or not a feature should be made available to one or more users.
You can choose one of the following ways:

* Enable a feature only for a specific set of users;
  * Enable or disabled for a percentage of users;
  * Disable a feature.

Also known as: feature switch, feature flag, feature toggle, ...

## Storage
  * Features is completely storage agnostic. You should be able to use your own storage, you just need to implement the [`Engine`](https://github.com/albertoleal/features/blob/master/engine/engine.go) interface.
  * This library comes with an in memory store, but it's basically used for testing. You should not use this in production.

## SDKs
- [Javascript](https://github.com/albertoleal/features-js-sdk) (in progress)
- Ruby (soon)
- Python  (soon)

## How it works

Create an instance of Features type passing the storage as an argument:

```go
  Features := features.New(memory.New())
  ```

Create an instance of Feature type with the desired parameters and save it:

```go
  feature := engine.FeatureFlag{
    Key:     "Feature X",
    Enabled: false,
    Users:   []*engine.User{&engine.User{Id: "alice@example.org"}},
    Percentage: 10,
  }
  Features.Save(feature)
  ```

Check if a feature is **enabled**:

```go
  Features.IsEnabled("Feature X")
  ```

Check if a feature is **disabled**:

```go
  Features.IsDisabled("Feature X")
  ```

Execute an anonymous function if the feature is **enabled**:
  ```go
  Features.With("Feature X", func() {
    fmt.Println("`Feature X` is enabled!")
  })
  ```

Execute an anonymous function if the feature is **disabled**:
  ```go
  Features.Without("Feature X", func() {
    fmt.Println("`Feature X` is disabled!")
  })
  ```

Check if a feature is active for a particular user:

```go
  Features.UserHasAccess("Feature X", "alice@example.org")
  ```

## User percentages

If you're rolling out a feature, you might want to enable it for a percentage of your users. There are two ways you can achieve that: Either enabling the feature for a percentage of users or disabling that.

* **Enable** the feature for a percentage of users:
  ```go
  feature := engine.FeatureFlag{
    Key:     "Feature X",
    Enabled: true,
    Percentage: 10,
  }
  ```

* **Disable** the feature for a percentage of users:
  ```go
  feature := engine.FeatureFlag{
    Key:     "Feature X",
    Enabled: false,
    Percentage: 10,
  }
  ```

## Specific users

You might want to enable a feature for a set of users to try out and give feedback on before it's rolled out for everyone. To achieve this, you need to specify the users by doing the following:

```go
  feature := engine.FeatureFlag{
    Key:     "Feature X",
    Enabled: true,
    Users:   []*engine.User{&engine.User{Id: "alice@example.org"}},
  }
  ```

## HTTP API
  Features comes with an HTTP API that's used by the SDKs, but you **should not** expose that to the world because there's no authentication layer.

### API endpoints
  - [`POST` /features](#create-a-new-feature-flag) - Create a new feature flag
  - [`PUT` /features/:feature-key](#update-an-existing-feature-flag) - Update an existing feature flag
  - [`DELETE` /features/:feature-key](#delete-an-existing-feature-flag) - Delete an existing feature flag
  - [`GET` /features/:feature-key](#get-an-existing-feature-flag) - Get an existing feature flag
  - [`GET` /features](#list-all-feature-flags) - List all feature flags
  - [`PUT` /features](#validate-acccess) - Validate Access

#### Create a new feature flag
  ```bash
  curl -i http://localhost:8000/features -XPOST -d '{"key": "login-via-email", "percentage": 90, "enabled": true, "users": [{"id": "alice@example.org"}]}'
  ```
  Response:
  ```bash
  HTTP/1.1 201 Created
  Content-Type: application/json
  Date: Tue, 03 Nov 2015 23:21:07 GMT
  Content-Length: 94

{"enabled":true,"key":"login-via-email","users":[{"id":"alice@example.org"}],"percentage":90}
  ```

#### Update an existing feature flag
  ```bash
  curl -i http://localhost:8000/features/login-via-email -XPUT -d '{"key": "login-via-email", "percentage": 90, "enabled": false, "users": [{"id": "bob@example.org"}]}'
  ```
  Response:
  ```bash
  HTTP/1.1 200 OK
  Content-Type: application/json
  Date: Tue, 03 Nov 2015 23:22:05 GMT
  Content-Length: 93

{"enabled":false,"key":"login-via-email","users":[{"id":"bob@example.org"}],"percentage":90}
  ```

#### Delete an existing feature flag
  ```bash
  curl -i http://localhost:8000/features/login-via-email -XDELETE
  ```
  Response:
  ```bash
  HTTP/1.1 204 No Content
  Content-Type: application/json
  Date: Tue, 03 Nov 2015 23:24:46 GMT
  ```

#### Get an existing feature flag
  ```bash
  curl -i http://localhost:8000/features/login-via-email
  ```
  Response:
  ```bash
  HTTP/1.1 200 OK
  Content-Type: application/json
  Date: Tue, 03 Nov 2015 23:26:22 GMT
  Content-Length: 94

{"enabled":true,"key":"login-via-email","users":[{"id":"alice@example.org"}],"percentage":90}
  ```

#### List all feature flags
  ```bash
  curl -i http://localhost:8000/features
  ```
  Response:
  ```javascript
  {
    "items": [
      {
        "percentage": 90,
        "enabled": true,
        "users": [
          {
            "id": "alice@example.org"
          }
        ],
        "key": "login-via-email"
      }
    ],
    "item_count": 1
  }
  ```

#### Validate access
  ```bash
  curl -i http://localhost:8000/features -XPUT -d '{"key": "login-via-email", "user": "alice@example.org"}'
  ```
  Response for **success**:
  ```bash
  HTTP/1.1 200 OK
  Content-Type: application/json
  Date: Wed, 04 Nov 2015 00:19:46 GMT
  Content-Length: 0
  ```
  Response for **failure**:
  ```bash
  HTTP/1.1 403 Forbidden
  Content-Type: application/json
  Date: Wed, 04 Nov 2015 00:20:51 GMT
  Content-Length: 0
  ```