From 38de9f5a1361460d7aa001f6437a2ae635239c4a Mon Sep 17 00:00:00 2001 From: Kaushal Kapasi Date: Fri, 26 Aug 2022 16:32:20 -0400 Subject: [PATCH] split current java sdk into common and cloud folders --- example/build.gradle | 7 +- .../gradle/wrapper/gradle-wrapper.properties | 2 +- example/gradlew | 263 +++++++++++------- example/gradlew.bat | 14 +- example/settings.gradle | 4 +- .../java/sdk/app/controller/HelloWorld.java | 12 +- .../src/main/resources/templates/home.html | 6 +- gradle/wrapper/gradle-wrapper.jar | Bin 52818 -> 58702 bytes gradle/wrapper/gradle-wrapper.properties | 3 +- gradlew | 68 +++-- gradlew.bat | 18 +- .../DVCCloudClient.java} | 14 +- .../sdk/server/{ => common}/api/DVCApi.java | 6 +- .../server/{ => common}/api/DVCApiClient.java | 6 +- .../{ => common}/exception/DVCException.java | 6 +- .../AuthorizationHeaderInterceptor.java | 2 +- .../server/{ => common}/model/DVCOptions.java | 3 +- .../{ => common}/model/DVCResponse.java | 2 +- .../{ => common}/model/ErrorResponse.java | 2 +- .../sdk/server/{ => common}/model/Event.java | 2 +- .../server/{ => common}/model/Feature.java | 2 +- .../{ => common}/model/HttpResponseCode.java | 2 +- .../sdk/server/{ => common}/model/User.java | 2 +- .../{ => common}/model/UserAndEvents.java | 2 +- .../server/{ => common}/model/Variable.java | 2 +- .../DVCCloudClientTest.java} | 14 +- .../server/{ => common}/api/DVCApiMock.java | 4 +- .../sdk/server/{ => common}/model/Meta.java | 3 +- .../sdk/server/helpers/TestResponse.java | 6 +- 29 files changed, 287 insertions(+), 190 deletions(-) rename src/main/java/com/devcycle/sdk/server/{api/DVCClient.java => cloud/DVCCloudClient.java} (93%) rename src/main/java/com/devcycle/sdk/server/{ => common}/api/DVCApi.java (92%) rename src/main/java/com/devcycle/sdk/server/{ => common}/api/DVCApiClient.java (86%) rename src/main/java/com/devcycle/sdk/server/{ => common}/exception/DVCException.java (70%) rename src/main/java/com/devcycle/sdk/server/{ => common}/interceptor/AuthorizationHeaderInterceptor.java (92%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/DVCOptions.java (72%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/DVCResponse.java (92%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/ErrorResponse.java (95%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/Event.java (96%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/Feature.java (97%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/HttpResponseCode.java (92%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/User.java (98%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/UserAndEvents.java (96%) rename src/main/java/com/devcycle/sdk/server/{ => common}/model/Variable.java (97%) rename src/test/java/com/devcycle/sdk/server/{api/DVCClientTest.java => cloud/DVCCloudClientTest.java} (92%) rename src/test/java/com/devcycle/sdk/server/{ => common}/api/DVCApiMock.java (89%) rename src/test/java/com/devcycle/sdk/server/{ => common}/model/Meta.java (75%) diff --git a/example/build.gradle b/example/build.gradle index 4f9817cb..ac910c8d 100644 --- a/example/build.gradle +++ b/example/build.gradle @@ -21,7 +21,12 @@ dependencies { compileOnly('org.projectlombok:lombok:1.18.24') - implementation("com.devcycle:java-server-sdk:1.0.5") + // The line below makes the Example App use the production build of the Java Server SDK + // implementation("com.devcycle:java-server-sdk:1.0.7") + + // The line below makes the Example App use the local version of the Java Server SDK + // Run `./gradlew build` in the root directory (`cd .. && ./gradlew build`) to build the local version of the SDK + implementation project(':java-server-sdk') testImplementation 'org.springframework.boot:spring-boot-starter-test' } diff --git a/example/gradle/wrapper/gradle-wrapper.properties b/example/gradle/wrapper/gradle-wrapper.properties index 05679dc3..3ab0b725 100644 --- a/example/gradle/wrapper/gradle-wrapper.properties +++ b/example/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/example/gradlew b/example/gradlew index 744e882e..a69d9cb6 100755 --- a/example/gradlew +++ b/example/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# 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. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# 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 -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +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 -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +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" +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 - ;; +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 @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + 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 @@ -106,80 +140,101 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +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 -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -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" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi +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 - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + 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 - i=`expr $i + 1` + # 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 - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# 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. +# -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/example/gradlew.bat b/example/gradlew.bat index ac1b06f9..53a6b238 100644 --- a/example/gradlew.bat +++ b/example/gradlew.bat @@ -14,7 +14,7 @@ @rem limitations under the License. @rem -@if "%DEBUG%" == "" @echo off +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -25,7 +25,7 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto execute +if %ERRORLEVEL% equ 0 goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar :end @rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd +if %ERRORLEVEL% equ 0 goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/example/settings.gradle b/example/settings.gradle index 688a8cac..39ddd892 100755 --- a/example/settings.gradle +++ b/example/settings.gradle @@ -1 +1,3 @@ -rootProject.name = "java-server-sdk-example-app" \ No newline at end of file +rootProject.name = "java-server-sdk-example-app" +include ':java-server-sdk' +project(':java-server-sdk').projectDir = new File(settingsDir, '../') \ No newline at end of file diff --git a/example/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java b/example/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java index 766fafa1..f5949678 100644 --- a/example/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java +++ b/example/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java @@ -1,8 +1,8 @@ package com.devcycle.example.java.sdk.app.controller; -import com.devcycle.sdk.server.api.DVCClient; -import com.devcycle.sdk.server.model.User; -import com.devcycle.sdk.server.model.Variable; +import com.devcycle.sdk.server.cloud.DVCCloudClient; +import com.devcycle.sdk.server.common.model.User; +import com.devcycle.sdk.server.common.model.Variable; import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Controller; @@ -12,10 +12,10 @@ @Controller public class HelloWorld { - DVCClient dvc; + DVCCloudClient dvc; public HelloWorld(@Qualifier("devcycleServerKey") String serverKey) { - dvc = new DVCClient(serverKey); + dvc = new DVCCloudClient(serverKey); } @Value("${spring.application.name}") @@ -30,7 +30,7 @@ public String homePage(Model model) { return "home"; } - @GetMapping("/activateFlag") + @GetMapping("/cloud/activateFlag") public String homePageActivatedFlag(Model model) { Variable updateHomePage = dvc.variable(getUser(), "activate-flag", defaultValue); diff --git a/example/src/main/resources/templates/home.html b/example/src/main/resources/templates/home.html index 5dedf7bc..c1353a2b 100644 --- a/example/src/main/resources/templates/home.html +++ b/example/src/main/resources/templates/home.html @@ -19,7 +19,9 @@

Example app for the DevCycle Java SDK

Simple Spring Boot example to show how a default value before creating a feature and fetching a variable via the DevCycle SDK

- +
@@ -32,7 +34,7 @@

Example app for the DevCycle Java SDK