Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions proxies/openfeature-java/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.md
3 changes: 3 additions & 0 deletions proxies/openfeature-java/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
build/
.gradle/
gradle/
24 changes: 24 additions & 0 deletions proxies/openfeature-java/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
FROM gradle:8.6.0-jdk17-alpine

ARG OF_JAVA_SDK_VERSION
ENV OF_JAVA_SDK_VERSION $OF_JAVA_SDK_VERSION

ARG SDK_GITHUB_SHA
ENV SDK_GITHUB_SHA $SDK_GITHUB_SHA

ARG SDKS_TO_TEST
ENV SDKS_TO_TEST $SDKS_TO_TEST

RUN apk update && apk upgrade && \
apk add --no-cache bash git openssh

COPY . /app
WORKDIR /app

RUN echo "Docker: install.sh"
RUN ./install.sh

RUN echo "Docker: gradle bootJar"
RUN gradle bootJar

ENTRYPOINT java -jar build/libs/openfeature-java-proxy.jar
64 changes: 64 additions & 0 deletions proxies/openfeature-java/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# OpenFeature Java Proxy

This is a proxy service that bridges between the test harness and the DevCycle Java SDK. While initially intended to use OpenFeature for flag evaluation, it currently uses the DevCycle SDK directly due to the lack of an official DevCycle OpenFeature provider for Java.

## Overview

The OpenFeature Java Proxy provides the same functionality as the regular Java proxy and maintains compatibility with the existing test harness. It supports both local and cloud bucketing configurations using the DevCycle Java SDK.

## Features

- **DevCycle Integration**: Uses DevCycle Java SDK directly for feature flag evaluation
- **Multiple Client Types**: Supports both DevCycle local and cloud clients
- **EdgeDB Support**: Compatible with EdgeDB when using cloud bucketing
- **Local Bucketing**: Supports local flag evaluation for reduced latency
- **OpenFeature API Compatibility**: Maintains the same API interface as the OpenFeature Node.js proxy

## API Endpoints

### GET /spec
Returns the proxy specification including name, version, and capabilities.

### POST /client
Creates a new client instance with the specified configuration.

### POST /*/*
Executes commands on existing client instances.

## Building and Running

```bash
# Build the application
./gradlew bootJar

# Run the application
java -jar build/libs/openfeature-java-proxy.jar
```

## Docker

```bash
# Build the Docker image
docker build -t openfeature-java-proxy .

# Run the container
docker run -p 3000:3000 openfeature-java-proxy
```

## Environment Variables

- `JAVA_SDK_VERSION`: Specific version of the DevCycle Java SDK to use
- `SDK_GITHUB_SHA`: Git SHA for using a specific development version
- `LOCAL_MODE`: Set to "1" to use local SDK development mode
- `SDKS_TO_TEST`: Comma-separated list of SDKs to test (should include "of-java")

## Implementation Notes

This proxy was originally designed to use OpenFeature for Java, but due to the lack of an official DevCycle OpenFeature provider for Java, it currently uses the DevCycle Java SDK directly. The implementation maintains the same API interface as the OpenFeature Node.js version by:

- Using DevCycle SDK's `variable()` method for flag evaluation
- Converting DevCycle variables to the expected DVCVariable format
- Supporting both local and cloud DevCycle clients
- Maintaining compatibility with the existing test harness commands

Future updates may integrate an official DevCycle OpenFeature provider when available.
44 changes: 44 additions & 0 deletions proxies/openfeature-java/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
plugins {
id 'java'
id 'org.springframework.boot' version '3.1.0'
id 'io.spring.dependency-management' version '1.1.0'
}

group = 'com.dvc_harness'
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17

repositories {
mavenCentral()
}

jar {
archiveClassifier=''
enabled = false
}

dependencies {
implementation 'org.springframework.boot:spring-boot-starter'

if (System.getenv("JAVA_SDK_VERSION") != null && !System.getenv("JAVA_SDK_VERSION").isBlank()) {
// use a released version of the SDK from Maven Central
logger.info("Using released version of the SDK: ${System.getenv('JAVA_SDK_VERSION')}")
implementation("com.devcycle:java-server-sdk:${System.getenv('JAVA_SDK_VERSION')}")
} else if (System.getenv("SDK_GITHUB_SHA") != null && !System.getenv("SDK_GITHUB_SHA").isBlank()) {
logger.info("Using local copy of the SDK")
implementation project(':java-server-sdk')
} else if (System.getenv("LOCAL_MODE") != null && System.getenv("LOCAL_MODE") == "1") {
logger.info("Using local copy of the SDK")
implementation project(':java-server-sdk')
} else {
// utilize the latest release of the Java Server SDK
logger.info("Using latest release the SDK")
implementation("com.devcycle:java-server-sdk:latest.release")
}

// OpenFeature dependencies
implementation 'dev.openfeature:sdk:1.16.0'

implementation("org.springframework.boot:spring-boot-starter-web")
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
240 changes: 240 additions & 0 deletions proxies/openfeature-java/gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
#!/bin/sh

#
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################

# Attempt to set APP_HOME

# Resolve links: $0 may be a link
app_path=$0

# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done

APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit

APP_NAME="Gradle"
APP_BASE_NAME=${0##*/}

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum

warn () {
echo "$*"
} >&2

die () {
echo
echo "$*"
echo
exit 1
} >&2

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar


# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi

# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.

# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )

JAVACMD=$( cygpath --unix "$JAVACMD" )

# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi

# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.

set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"

# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi

# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#

eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'

exec "$JAVACMD" "$@"
Loading