Initial beta release

Author: keelerm84

.circleci/config.yml

@@ -2,33 +2,42 @@ version: 2
 jobs:
   build:
     docker:
-      # TODO test on other versions of Rust
-      - image: circleci/rust:latest
-
+      - image: cimg/rust:1.56.1
+    resource_class: medium+
     steps:
       - checkout
-
-      - run:
-          name: Install clippy
-          command: rustup component add clippy
       - run:
-          name: Install rustfmt
-          command: rustup component add rustfmt
-
-      - run: cargo build
-      - run: cargo test
+          name: Check Version
+          command: |
+            cargo --version
+            rustc --version
       - run:
-          name: Check consistent formatting
+          name: Check Formatting
           command: cargo fmt && git diff --exit-code
-      - run: cargo doc --no-deps
-      - run: cargo clippy -- -D warnings
-
+      - run:
+          name: Install Crate Dependencies
+          command: sudo apt-get update && sudo apt install libssl-dev libncurses5-dev libncursesw5-dev
+      - run:
+          name: Clippy
+          command: cargo clippy -- -D warnings
+      - run:
+          name: Test
+          command: cargo test
+      - run:
+          name: Gather Coverage
+          command: ./coverage.sh --html
       - store_artifacts:
+          name: Upload Coverage
+          path: target/llvm-cov/html
+          destination: coverage
+      - run:
+          name: Generate Docs
+          command: RUSTDOCFLAGS="-Dwarnings" cargo doc --no-deps
+      - store_artifacts:
+          name: Upload Docs
           path: target/doc
           destination: doc
 
-  # TODO publish crate
-
 workflows:
   version: 2
   build:

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Support request
+    url: https://support.launchdarkly.com/hc/en-us/requests/new
+    about: File your support requests with LaunchDarkly's support team

.gitignore

@@ -1,3 +1,4 @@
 /target
 **/*.rs.bk
-Cargo.lock
+Cargo.lock
+.idea

.ldrelease/config.yml

@@ -0,0 +1,13 @@
+version: 2
+
+repo:
+  public: rust-server-sdk
+  private: rust-server-sdk-private
+
+publications:
+  - url: https://docs.rs/launchdarkly-server-sdk
+    description: crates.io
+
+jobs:
+  - template:
+      name: rust

CHANGELOG.md

@@ -1,3 +1,6 @@
 # Change log
 
 All notable changes to the LaunchDarkly Rust server-side SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
+
+## [1.0.0-beta.1] - 2022-01-21
+Initial beta release of the LaunchDarkly Server-Side SDK for Rust.

CONTRIBUTING.md

@@ -9,3 +9,35 @@ The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launch
 ## Submitting pull requests
 
 We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
+
+## Build instructions
+
+This SDK uses the standard `cargo` build system.
+
+### Building
+
+To build the SDK without running any tests:
+
+```sh
+cargo build
+```
+
+To check and report errors without compiling object files, run:
+
+```sh
+cargo check
+```
+
+### Testing
+
+To run all tests (unit, doc, etc), run:
+
+```sh
+cargo test
+```
+
+If you want to only run the much faster unit tests, run:
+
+```sh
+cargo test --lib
+```

Cargo.toml

@@ -1,32 +1,50 @@
 [package]
-name = "ldclient"
-version = "0.1.0"
-authors = ["Sam Stokes <sstokes@launchdarkly.com>"]
+name = "launchdarkly-server-sdk"
+description = "LaunchDarkly Server-Side SDK"
+version = "1.0.0-beta.1"
+authors = ["LaunchDarkly"]
 edition = "2018"
+license = "Apache-2.0"
+homepage = "https://docs.launchdarkly.com/sdk/server-side/rust"
+repository = "https://github.com/launchdarkly/rust-server-sdk-evaluation"
+keywords = ["launchdarkly", "launchdarkly-sdk", "feature-flags", "feature-toggles"]
+exclude = [
+    ".circleci",
+    ".github",
+    ".ldrelease",
+    ".pre-commit-config.yaml",
+    "coverage.sh"
+]
 
 [dependencies]
-chrono = "0.4.9"
-eventsource-client = "0.3.1"
-futures = "0.1.25"
-http = ">= 0.1.18"
+chrono = "0.4.19"
+crossbeam-channel = "0.5.1"
+data-encoding = "2.3.2"
+eventsource-client = "0.8.1"
+futures = "0.3.12"
 lazy_static = "1.4.0"
-log = "0.4.6"
+log = "0.4.14"
 lru = { version = "0.5.3", default_features = false }
-regex = "1"
 reqwest = "0.9.11"
-semver = "0.10.0"
-serde = { version = "1.0.89", features = ["derive"] }
-serde_json = "1.0.39"
-sha1 = { version = "0.6.0", features = ["std"] }
+ring = "0.16.20"
+launchdarkly-server-sdk-evaluation = { version = "1.0.0-beta.2" }
+serde = { version = "1.0.132", features = ["derive"] }
+serde_json = { version = "1.0.73", features = ["float_roundtrip"] }
 thiserror = "1.0"
-tokio = "0.1.16"
+tokio = { version = "1.2.0", features = ["rt-multi-thread"] }
+threadpool = "1.8.1"
+parking_lot = "0.11.2"
+tokio-stream = { version = "0.1.8", features = ["sync"] }
 
 [dev-dependencies]
 maplit = "1.0.1"
 env_logger = "0.7.1"
+serde_json = { version = "1.0.73", features = ["preserve_order"] } # for deterministic JSON testing
 spectral = "0.6.0"
 cursive = "0.11"
-tokio-executor = "0.1.6"
+tokio = { version = "1.2.0", features = ["macros", "time"] }
+test-case = "1.2.0"
+mockito = "0.30.0"
 
 [build-dependencies]
 built = "0.4"

README.md

@@ -4,15 +4,27 @@
 
 The LaunchDarkly Server-Side SDK for Rust is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
 
+*This version of the SDK is a **beta** version and should not be considered ready for production use while this message is visible.*
+
 ## LaunchDarkly overview
 
 [LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/docs/getting-started) using LaunchDarkly today!
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
 
+## Getting started
+
+Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/server-side/rust#getting-started) for instructions on getting started with using the SDK.
+
+This repository also contains several small [example implementations](./examples). You can run these with:
+
+```sh
+cargo run --example EXAMPLE_NAME
+```
+
 ## Learn more
 
-Check out our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/docs/rust-server-sdk-reference).
+Check out our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/rust).
 
 ## Testing
 
@@ -34,5 +46,4 @@ We encourage pull requests and other contributions from the community. Check out
     * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides
     * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
-    * [blog.launchdarkly.com](https://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
-    * [Feature Flagging Guide](https://github.com/launchdarkly/featureflags/  "Feature Flagging Guide") for best practices and strategies
+    * [launchdarkly.com/blog](https://launchdarkly.com/blog/  "LaunchDarkly Blog Documentation") for the latest product updates

coverage.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o pipefail
+
+# We are using an older version of the toolchain for now as there is a bug with
+# coverage generation. See https://github.com/rust-lang/rust/issues/79645
+export RUSTUP_TOOLCHAIN=nightly-2022-01-09
+
+# cargo-llvm-cov requires the nightly compiler to be installed
+rustup toolchain install $RUSTUP_TOOLCHAIN
+rustup component add llvm-tools-preview --toolchain $RUSTUP_TOOLCHAIN
+cargo install cargo-llvm-cov
+
+# generate coverage report to command line by default; otherwise allow
+# CI to pass in '--html' (or other formats).
+
+if [ -n "$1" ]; then
+  cargo llvm-cov --all-features --workspace "$1"
+else
+  cargo llvm-cov --all-features --workspace
+fi