diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-docs.yml new file mode 100644 index 00000000..f55147cd --- /dev/null +++ b/.github/workflows/generate-docs.yml @@ -0,0 +1,37 @@ +name: Generate and publish documentation + +on: + release: + types: [ released ] + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: set up JDK + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + - name: Generate API documentation + run: ./gradlew dokkaHtml + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'parsely/build/dokka/html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index b765d4de..ff79a3cf 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -17,7 +17,6 @@ jobs: with: java-version: '17' distribution: 'temurin' - cache: gradle - name: Build library run: ./gradlew :parsely:assembleDebug - name: Publish to Maven Central Repository diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 01172d57..d764f0e9 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -15,7 +15,10 @@ jobs: with: java-version: '17' distribution: 'temurin' - cache: gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + - name: Validate binary compatibility + run: ./gradlew apiCheck - name: Build library run: ./gradlew :parsely:assembleDebug - name: Build example app @@ -44,7 +47,7 @@ jobs: name: artifact path: ~/.m2/repository/com/parsely/parsely/* functional-tests: - runs-on: macos-latest + runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: @@ -54,9 +57,37 @@ jobs: with: java-version: '17' distribution: 'temurin' - cache: gradle + - name: Setup Gradle + uses: gradle/gradle-build-action@v2 + - name: Enable KVM group perms + run: | + echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules + sudo udevadm control --reload-rules + sudo udevadm trigger --name-match=kvm + - name: AVD cache + uses: actions/cache@v3 + id: avd-cache + with: + path: | + ~/.android/avd/* + ~/.android/adb* + key: avd + - name: Create AVD and generate snapshot for caching + if: steps.avd-cache.outputs.cache-hit != 'true' + uses: reactivecircus/android-emulator-runner@v2 + with: + working-directory: . + api-level: 31 + profile: Nexus 6 + arch: x86_64 + force-avd-creation: false + avd-name: macOS-avd-x86_64-31 + emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none + disable-animations: true + disk-size: 4096M + script: echo "Generated AVD snapshot for caching." - name: Functional Tests - uses: reactivecircus/android-emulator-runner@v2.28.0 + uses: reactivecircus/android-emulator-runner@v2 with: working-directory: . api-level: 31 @@ -66,7 +97,8 @@ jobs: avd-name: macOS-avd-x86_64-31 emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none disable-animations: true - script: ./gradlew :parsely:connectedDebugAndroidTest + disk-size: 4096M + script: adb uninstall "com.parsely.parselyandroid.test"; ./gradlew :parsely:connectedDebugAndroidTest - name: Publish build artifacts uses: actions/upload-artifact@v3 if: always() diff --git a/.github/workflows/submit-gradle-dependencies.yml b/.github/workflows/submit-gradle-dependencies.yml index 0e201cb1..fb7edc56 100644 --- a/.github/workflows/submit-gradle-dependencies.yml +++ b/.github/workflows/submit-gradle-dependencies.yml @@ -1,9 +1,6 @@ name: Submit dependencies to GitHub Dependency Graph on: push: - branches: - - main - - release/* permissions: contents: write jobs: diff --git a/example/build.gradle b/example/build.gradle index f93f8620..3a4d0631 100644 --- a/example/build.gradle +++ b/example/build.gradle @@ -3,12 +3,13 @@ plugins { } android { - compileSdkVersion 33 + compileSdk 34 + namespace = "com.example" defaultConfig { applicationId "com.parsely.example.parselyexample" minSdkVersion 21 - targetSdkVersion 33 + targetSdkVersion 34 versionCode 1 versionName "1.0" } diff --git a/example/src/main/java/com/example/InternalDebugOnlyData.java b/example/src/main/java/com/example/InternalDebugOnlyData.java new file mode 100644 index 00000000..59a0f2f3 --- /dev/null +++ b/example/src/main/java/com/example/InternalDebugOnlyData.java @@ -0,0 +1,58 @@ +package com.example; + +import com.parsely.parselyandroid.ParselyTrackerInternal; + +import org.jetbrains.annotations.Nullable; + +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; + +/** + * The InternalDebugOnlyData class is designed to provide access to internal data for debugging + * purposes through reflection. The methods within this class are intended for internal use only + * and should *not* be utilized within the SDK user's code. + * @noinspection KotlinInternalInJava + */ +class InternalDebugOnlyData { + private final ParselyTrackerInternal parselyTracker; + + InternalDebugOnlyData(ParselyTrackerInternal parselyTracker) { + this.parselyTracker = parselyTracker; + } + + boolean engagementIsActive() { + return (boolean) invokePrivateMethod("engagementIsActive"); + } + + @Nullable + Double getEngagementInterval() { + return (Double) invokePrivateMethod("getEngagementInterval"); + } + + @Nullable + Double getVideoEngagementInterval() { + return (Double) invokePrivateMethod("getVideoEngagementInterval"); + } + + long getFlushInterval() { + return (long) invokePrivateMethod("getFlushInterval"); + } + + boolean videoIsActive() { + return (boolean) invokePrivateMethod("videoIsActive"); + } + + boolean flushTimerIsActive() { + return (boolean) invokePrivateMethod("flushTimerIsActive"); + } + + private Object invokePrivateMethod(String methodName) { + try { + Method method = ParselyTrackerInternal.class.getDeclaredMethod(methodName); + method.setAccessible(true); + return method.invoke(parselyTracker); + } catch (IllegalAccessException | NoSuchMethodException | InvocationTargetException e) { + throw new RuntimeException(e); + } + } +} diff --git a/example/src/main/java/com/example/MainActivity.java b/example/src/main/java/com/example/MainActivity.java index 0eed11a1..89ecbca5 100644 --- a/example/src/main/java/com/example/MainActivity.java +++ b/example/src/main/java/com/example/MainActivity.java @@ -1,31 +1,38 @@ package com.example; -import java.util.ArrayList; -import java.util.Calendar; -import java.util.HashMap; -import java.util.Map; -import java.util.Timer; -import java.util.TimerTask; - +import android.app.Activity; import android.os.Bundle; import android.os.Handler; import android.os.Message; -import android.app.Activity; -import android.view.Menu; import android.view.View; import android.widget.TextView; -import com.parsely.parselyandroid.*; +import com.parsely.parselyandroid.ParselyTracker; +import com.parsely.parselyandroid.ParselyTrackerInternal; +import com.parsely.parselyandroid.ParselyVideoMetadata; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.HashMap; +import java.util.Map; +import java.util.Timer; +import java.util.TimerTask; + +/** + * @noinspection KotlinInternalInJava + */ public class MainActivity extends Activity { + private InternalDebugOnlyData internalDebugOnlyData; + @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); // initialize the Parsely tracker with your site id and the current Context - ParselyTracker.sharedInstance("example.com", 30, this, true); + ParselyTracker.init("example.com", 30, this, true); + internalDebugOnlyData = new InternalDebugOnlyData((ParselyTrackerInternal) ParselyTracker.sharedInstance()); final TextView intervalView = (TextView) findViewById(R.id.interval); @@ -39,8 +46,8 @@ protected void onCreate(Bundle savedInstanceState) { public void handleMessage(Message msg) { TextView[] v = (TextView[]) msg.obj; TextView iView = v[0]; - if (ParselyTracker.sharedInstance().flushTimerIsActive()) { - iView.setText(String.format("Flush Interval: %d", ParselyTracker.sharedInstance().getFlushInterval())); + if (internalDebugOnlyData.flushTimerIsActive()) { + iView.setText(String.format("Flush Interval: %d", internalDebugOnlyData.getFlushInterval())); } else { iView.setText("Flush timer inactive"); } @@ -62,23 +69,23 @@ public void run() { private void updateEngagementStrings() { StringBuilder eMsg = new StringBuilder("Engagement is "); - if (ParselyTracker.sharedInstance().engagementIsActive() == true) { + if (internalDebugOnlyData.engagementIsActive()) { eMsg.append("active."); } else { eMsg.append("inactive."); } - eMsg.append(String.format(" (interval: %.01fms)", ParselyTracker.sharedInstance().getEngagementInterval())); + eMsg.append(String.format(" (interval: %.01fms)", internalDebugOnlyData.getEngagementInterval())); TextView eView = findViewById(R.id.et_interval); eView.setText(eMsg.toString()); StringBuilder vMsg = new StringBuilder("Video is "); - if (ParselyTracker.sharedInstance().videoIsActive() == true) { + if (internalDebugOnlyData.videoIsActive()) { vMsg.append("active."); } else { vMsg.append("inactive."); } - vMsg.append(String.format(" (interval: %.01fms)", ParselyTracker.sharedInstance().getVideoEngagementInterval())); + vMsg.append(String.format(" (interval: %.01fms)", internalDebugOnlyData.getVideoEngagementInterval())); TextView vView = findViewById(R.id.video_interval); vView.setText(vMsg.toString()); @@ -117,7 +124,7 @@ public void trackPlay(View view) { 90 ); // NOTE: For videos embedded in an article, "url" should be the URL for that article. - ParselyTracker.sharedInstance().trackPlay("http://example.com/app-videos", null, metadata, null); + ParselyTracker.sharedInstance().trackPlay("http://example.com/app-videos", "", metadata, null); } @@ -125,5 +132,7 @@ public void trackPause(View view) { ParselyTracker.sharedInstance().trackPause(); } - public void trackReset(View view) {ParselyTracker.sharedInstance().resetVideo(); } + public void trackReset(View view) { + ParselyTracker.sharedInstance().resetVideo(); + } } diff --git a/gradle.properties b/gradle.properties index d7e44c72..35cf87ca 100644 --- a/gradle.properties +++ b/gradle.properties @@ -18,8 +18,5 @@ org.gradle.jvmargs=-XX:MaxMetaspaceSize=2g # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects # org.gradle.parallel=true -android.disableAutomaticComponentCreation=true android.useAndroidX=true -android.experimental.lint.version=8.1.0 - diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c0..d64cd491 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index aa991fce..1af9e093 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,7 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 4f906e0c..1aa94a42 100755 --- a/gradlew +++ b/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,99 @@ # ############################################################################## -## -## 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/HEAD/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_NAME="Gradle" -APP_BASE_NAME=`basename "$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"' +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit # 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 - ;; - 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 +119,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,88 +130,120 @@ 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. + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + 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 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*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + 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, 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" +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +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" "$@" diff --git a/gradlew.bat b/gradlew.bat index ac1b06f9..6689b85b 100644 --- a/gradlew.bat +++ b/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,8 @@ if "%OS%"=="Windows_NT" setlocal set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -40,7 +41,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 +76,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/parsely/api/parsely.api b/parsely/api/parsely.api new file mode 100644 index 00000000..bc5179a6 --- /dev/null +++ b/parsely/api/parsely.api @@ -0,0 +1,47 @@ +public final class com/parsely/parselyandroid/ParselyAlreadyInitializedException : java/lang/Exception { + public fun ()V +} + +public class com/parsely/parselyandroid/ParselyMetadata { + public fun ()V + public fun (Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/Calendar;)V + public synthetic fun (Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/Calendar;ILkotlin/jvm/internal/DefaultConstructorMarker;)V +} + +public final class com/parsely/parselyandroid/ParselyNotInitializedException : java/lang/Exception { + public fun ()V +} + +public abstract interface class com/parsely/parselyandroid/ParselyTracker { + public static final field Companion Lcom/parsely/parselyandroid/ParselyTracker$Companion; + public static fun init (Ljava/lang/String;ILandroid/content/Context;)V + public static fun init (Ljava/lang/String;ILandroid/content/Context;Z)V + public static fun init (Ljava/lang/String;Landroid/content/Context;)V + public abstract fun resetVideo ()V + public static fun sharedInstance ()Lcom/parsely/parselyandroid/ParselyTracker; + public abstract fun startEngagement (Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V + public abstract fun stopEngagement ()V + public abstract fun trackPageview (Ljava/lang/String;Ljava/lang/String;Lcom/parsely/parselyandroid/ParselyMetadata;Ljava/util/Map;)V + public abstract fun trackPause ()V + public abstract fun trackPlay (Ljava/lang/String;Ljava/lang/String;Lcom/parsely/parselyandroid/ParselyVideoMetadata;Ljava/util/Map;)V +} + +public final class com/parsely/parselyandroid/ParselyTracker$Companion { + public final fun init (Ljava/lang/String;ILandroid/content/Context;)V + public final fun init (Ljava/lang/String;ILandroid/content/Context;Z)V + public final fun init (Ljava/lang/String;Landroid/content/Context;)V + public static synthetic fun init$default (Lcom/parsely/parselyandroid/ParselyTracker$Companion;Ljava/lang/String;ILandroid/content/Context;ZILjava/lang/Object;)V + public final fun sharedInstance ()Lcom/parsely/parselyandroid/ParselyTracker; +} + +public final class com/parsely/parselyandroid/ParselyTracker$DefaultImpls { + public static synthetic fun startEngagement$default (Lcom/parsely/parselyandroid/ParselyTracker;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;ILjava/lang/Object;)V + public static synthetic fun trackPageview$default (Lcom/parsely/parselyandroid/ParselyTracker;Ljava/lang/String;Ljava/lang/String;Lcom/parsely/parselyandroid/ParselyMetadata;Ljava/util/Map;ILjava/lang/Object;)V + public static synthetic fun trackPlay$default (Lcom/parsely/parselyandroid/ParselyTracker;Ljava/lang/String;Ljava/lang/String;Lcom/parsely/parselyandroid/ParselyVideoMetadata;Ljava/util/Map;ILjava/lang/Object;)V +} + +public final class com/parsely/parselyandroid/ParselyVideoMetadata : com/parsely/parselyandroid/ParselyMetadata { + public fun (Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/Calendar;I)V + public synthetic fun (Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;Ljava/lang/String;Ljava/lang/String;Ljava/util/Calendar;IILkotlin/jvm/internal/DefaultConstructorMarker;)V +} + diff --git a/parsely/build.gradle b/parsely/build.gradle index 6c69d623..a9f71961 100644 --- a/parsely/build.gradle +++ b/parsely/build.gradle @@ -1,8 +1,10 @@ import org.jetbrains.kotlin.gradle.dsl.ExplicitApiMode + plugins { id 'com.android.library' id 'org.jetbrains.kotlin.android' id 'org.jetbrains.kotlinx.kover' + id 'org.jetbrains.kotlinx.binary-compatibility-validator' } ext { @@ -12,11 +14,12 @@ ext { } android { - compileSdkVersion 33 + compileSdk 34 + namespace = "com.parsely.parselyandroid" defaultConfig { minSdkVersion 21 - targetSdkVersion 33 + targetSdkVersion 34 testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" testInstrumentationRunnerArguments clearPackageData: 'true' @@ -30,6 +33,9 @@ android { proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } + buildFeatures { + buildConfig = false + } packagingOptions { exclude 'META-INF/LGPL2.1' exclude 'META-INF/LICENSE' @@ -61,17 +67,17 @@ android { kotlin { explicitApi(ExplicitApiMode.Strict) + jvmToolchain(17) } } dependencies { - implementation 'androidx.appcompat:appcompat:1.4.2' - implementation 'com.fasterxml.jackson.core:jackson-databind:2.13.3' + implementation 'com.fasterxml.jackson.core:jackson-databind:2.14.1' implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1' implementation 'androidx.lifecycle:lifecycle-process:2.6.2' implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutinesVersion" - testImplementation 'org.robolectric:robolectric:4.10.3' + testImplementation 'org.robolectric:robolectric:4.11.1' testImplementation 'androidx.test:core:1.5.0' testImplementation "org.assertj:assertj-core:$assertJVersion" testImplementation 'junit:junit:4.13.2' diff --git a/parsely/src/androidTest/java/com/parsely/parselyandroid/FunctionalTests.kt b/parsely/src/androidTest/java/com/parsely/parselyandroid/FunctionalTests.kt index 6bda073e..4d555df3 100644 --- a/parsely/src/androidTest/java/com/parsely/parselyandroid/FunctionalTests.kt +++ b/parsely/src/androidTest/java/com/parsely/parselyandroid/FunctionalTests.kt @@ -60,7 +60,7 @@ class FunctionalTests { scenario.onActivity { activity: Activity -> beforeEach(activity) server.enqueue(MockResponse().setResponseCode(200)) - parselyTracker = initializeTracker(activity) + initializeTracker(activity) repeat(51) { parselyTracker.trackPageview("url") @@ -91,7 +91,7 @@ class FunctionalTests { scenario.onActivity { activity: Activity -> beforeEach(activity) server.enqueue(MockResponse().setResponseCode(200)) - parselyTracker = initializeTracker(activity) + initializeTracker(activity) parselyTracker.trackPageview("url") } @@ -135,7 +135,7 @@ class FunctionalTests { beforeEach(activity) server.enqueue(MockResponse().setResponseCode(200)) server.enqueue(MockResponse().setResponseCode(200)) - parselyTracker = initializeTracker(activity, flushInterval = 1.hours) + initializeTracker(activity, flushInterval = 1.hours) repeat(20) { parselyTracker.trackPageview("url") @@ -169,7 +169,7 @@ class FunctionalTests { scenario.onActivity { activity: Activity -> beforeEach(activity) server.enqueue(MockResponse().setResponseCode(200)) - parselyTracker = initializeTracker(activity) + initializeTracker(activity) repeat(eventsToSend) { parselyTracker.trackPageview("url") @@ -217,7 +217,7 @@ class FunctionalTests { scenario.onActivity { activity: Activity -> beforeEach(activity) server.enqueue(MockResponse().setResponseCode(200)) - parselyTracker = initializeTracker(activity, flushInterval = 30.seconds) + initializeTracker(activity, flushInterval = 30.seconds) // when startTimestamp = System.currentTimeMillis().milliseconds @@ -314,13 +314,14 @@ class FunctionalTests { private fun initializeTracker( activity: Activity, flushInterval: Duration = defaultFlushInterval - ): ParselyTracker { + ) { val field: Field = ParselyTrackerInternal::class.java.getDeclaredField("ROOT_URL") field.isAccessible = true field.set(this, url) - return ParselyTracker.sharedInstance( + ParselyTracker.init( siteId, flushInterval.inWholeSeconds.toInt(), activity.application ) + parselyTracker = ParselyTracker.sharedInstance() } private companion object { diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ParselyAlreadyInitializedException.kt b/parsely/src/main/java/com/parsely/parselyandroid/ParselyAlreadyInitializedException.kt new file mode 100644 index 00000000..dced4a57 --- /dev/null +++ b/parsely/src/main/java/com/parsely/parselyandroid/ParselyAlreadyInitializedException.kt @@ -0,0 +1,4 @@ +package com.parsely.parselyandroid + +public class ParselyAlreadyInitializedException() : + Exception("Parse.ly SDK has been already initialized. Reinitialization is not supported.") diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ParselyNotInitializedException.kt b/parsely/src/main/java/com/parsely/parselyandroid/ParselyNotInitializedException.kt new file mode 100644 index 00000000..1d3d10b0 --- /dev/null +++ b/parsely/src/main/java/com/parsely/parselyandroid/ParselyNotInitializedException.kt @@ -0,0 +1,4 @@ +package com.parsely.parselyandroid + +public class ParselyNotInitializedException() : + Exception("Parse.ly client has not been initialized. Call ParselyTracker#init before using the SDK.") diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.kt b/parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.kt index 7e57efae..e6adbe82 100644 --- a/parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.kt +++ b/parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.kt @@ -16,22 +16,28 @@ package com.parsely.parselyandroid import android.content.Context +import org.jetbrains.annotations.TestOnly /** * Tracks Parse.ly app views in Android apps * - * * Accessed as a singleton. Maintains a queue of pageview events in memory and periodically * flushes the queue to the Parse.ly pixel proxy server. */ public interface ParselyTracker { - public val engagementInterval: Double? - public val videoEngagementInterval: Double? - public val flushInterval: Long - - public fun engagementIsActive(): Boolean - public fun videoIsActive(): Boolean + /** + * Register a pageview event using a URL and optional metadata. + * + * @param url The URL of the article being tracked + * (eg: "http://example.com/some-old/article.html") + * @param urlRef Referrer URL associated with this video view. + * @param urlMetadata Optional metadata for the URL -- not used in most cases. Only needed + * when `url` isn't accessible over the Internet (i.e. app-only + * content). Do not use this for **content also hosted on** URLs Parse.ly + * would normally crawl. + * @param extraData A Map of additional information to send with the event. + */ public fun trackPageview( url: String, urlRef: String = "", @@ -39,37 +45,101 @@ public interface ParselyTracker { extraData: Map? = null, ) + /** + * Start engaged time tracking for the given URL. + * + * + * This starts a timer which will send events to Parse.ly on a regular basis + * to capture engaged time for this URL. The value of `url` should be a URL for + * which `trackPageview` has been called. + * + * @param url The URL to track engaged time for. + * @param urlRef Referrer URL associated with this video view. + */ public fun startEngagement( url: String, urlRef: String = "", extraData: Map? = null ) + /** + * Stop engaged time tracking. + * + * + * Stops the engaged time tracker, sending any accumulated engaged time to Parse.ly. + * NOTE: This **must** be called in your `MainActivity` during various Android lifecycle events + * like `onPause` or `onStop`. Otherwise, engaged time tracking may keep running in the background + * and Parse.ly values may be inaccurate. + */ public fun stopEngagement() + /** + * Start video tracking. + * + * + * Starts tracking view time for a video being viewed at a given url. Will send a `videostart` + * event unless the same url/videoId had previously been paused. + * Video metadata must be provided, specifically the video ID and video duration. + * + * + * The `url` value is *not* the URL of a video, but the post which contains the video. If the video + * is not embedded in a post, then this should contain a well-formatted URL on the customer's + * domain (e.g. http:///app-videos). This URL doesn't need to return a 200 status + * when crawled, but must but well-formatted so Parse.ly systems recognize it as belonging to + * the customer. + * + * @param url URL of post the video is embedded in. If videos is not embedded, a + * valid URL for the customer should still be provided. + * (e.g. http:///app-videos) + * @param urlRef Referrer URL associated with this video view. + * @param videoMetadata Metadata about the video being tracked. + * @param extraData A Map of additional information to send with the event. + */ public fun trackPlay( url: String, urlRef: String = "", videoMetadata: ParselyVideoMetadata, extraData: Map? = null, ) + + /** + * Pause video tracking. + * + * + * Pauses video tracking for an ongoing video. If [.trackPlay] is immediately called again for + * the same video, a new video start event will not be sent. This models a user pausing a + * playing video. + * + * + * NOTE: This or [.resetVideo] **must** be called in your `MainActivity` during various Android lifecycle events + * like `onPause` or `onStop`. Otherwise, engaged time tracking may keep running in the background + * and Parse.ly values may be inaccurate. + */ public fun trackPause() + + /** + * Reset tracking on a video. + * + * + * Stops video tracking and resets internal state for the video. If [.trackPlay] is immediately + * called for the same video, a new video start event is set. This models a user stopping a + * video and (on [.trackPlay] being called again) starting it over. + * + * + * NOTE: This or [.trackPause] **must** be called in your `MainActivity` during various Android lifecycle events + * like `onPause` or `onStop`. Otherwise, engaged time tracking may keep running in the background + * and Parse.ly values may be inaccurate. + */ public fun resetVideo() - public fun flushEventQueue() - public fun flushTimerIsActive(): Boolean public companion object { private const val DEFAULT_FLUSH_INTERVAL_SECS = 60 private var instance: ParselyTrackerInternal? = null - /** - * Singleton instance accessor. Note: This must be called after [.sharedInstance] - * - * @return The singleton instance - */ - @JvmStatic - public fun sharedInstance(): ParselyTracker? { - return instance + private fun ensureInitialized(): ParselyTracker { + return instance ?: run { + throw ParselyNotInitializedException() + } } /** @@ -83,17 +153,24 @@ public interface ParselyTracker { */ @JvmStatic @JvmOverloads - public fun sharedInstance( + public fun init( siteId: String, flushInterval: Int = DEFAULT_FLUSH_INTERVAL_SECS, context: Context, dryRun: Boolean = false, - ): ParselyTracker { - return instance ?: run { - val newInstance = ParselyTrackerInternal(siteId, flushInterval, context, dryRun) - instance = newInstance - return newInstance + ) { + if (instance != null) { + throw ParselyAlreadyInitializedException() } + instance = ParselyTrackerInternal(siteId, flushInterval, context, dryRun) + } + + @JvmStatic + public fun sharedInstance(): ParselyTracker = ensureInitialized() + + @TestOnly + internal fun tearDown() { + instance = null } } } diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ParselyTrackerInternal.kt b/parsely/src/main/java/com/parsely/parselyandroid/ParselyTrackerInternal.kt index 05cec30a..a88a999c 100644 --- a/parsely/src/main/java/com/parsely/parselyandroid/ParselyTrackerInternal.kt +++ b/parsely/src/main/java/com/parsely/parselyandroid/ParselyTrackerInternal.kt @@ -66,55 +66,24 @@ internal class ParselyTrackerInternal internal constructor( ) } - /** - * Get the heartbeat interval - * - * @return The base engagement tracking interval. - */ - override val engagementInterval: Double? + private val engagementInterval: Double? get() = engagementManager?.intervalMillis - override val videoEngagementInterval: Double? + private val videoEngagementInterval: Double? get() = videoEngagementManager?.intervalMillis - /** - * Returns whether the engagement tracker is running. - * - * @return Whether the engagement tracker is running. - */ - override fun engagementIsActive(): Boolean { + @Suppress("unused") // used via reflection in sample app + private fun engagementIsActive(): Boolean { return engagementManager?.isRunning ?: false } - /** - * Returns whether video tracking is active. - * - * @return Whether video tracking is active. - */ - override fun videoIsActive(): Boolean { + private fun videoIsActive(): Boolean { return videoEngagementManager?.isRunning ?: false } - /** - * Returns the interval at which the event queue is flushed to Parse.ly. - * - * @return The interval at which the event queue is flushed to Parse.ly. - */ - override val flushInterval: Long + private val flushInterval: Long get() = flushManager.intervalMillis / 1000 - /** - * Register a pageview event using a URL and optional metadata. - * - * @param url The URL of the article being tracked - * (eg: "http://example.com/some-old/article.html") - * @param urlRef Referrer URL associated with this video view. - * @param urlMetadata Optional metadata for the URL -- not used in most cases. Only needed - * when `url` isn't accessible over the Internet (i.e. app-only - * content). Do not use this for **content also hosted on** URLs Parse.ly - * would normally crawl. - * @param extraData A Map of additional information to send with the event. - */ override fun trackPageview( url: String, urlRef: String, @@ -141,17 +110,6 @@ internal class ParselyTrackerInternal internal constructor( ) } - /** - * Start engaged time tracking for the given URL. - * - * - * This starts a timer which will send events to Parse.ly on a regular basis - * to capture engaged time for this URL. The value of `url` should be a URL for - * which `trackPageview` has been called. - * - * @param url The URL to track engaged time for. - * @param urlRef Referrer URL associated with this video view. - */ override fun startEngagement( url: String, urlRef: String, @@ -183,15 +141,6 @@ internal class ParselyTrackerInternal internal constructor( ).also { it.start() } } - /** - * Stop engaged time tracking. - * - * - * Stops the engaged time tracker, sending any accumulated engaged time to Parse.ly. - * NOTE: This **must** be called in your `MainActivity` during various Android lifecycle events - * like `onPause` or `onStop`. Otherwise, engaged time tracking may keep running in the background - * and Parse.ly values may be inaccurate. - */ override fun stopEngagement() { engagementManager?.let { it.stop() @@ -200,28 +149,6 @@ internal class ParselyTrackerInternal internal constructor( engagementManager = null } - /** - * Start video tracking. - * - * - * Starts tracking view time for a video being viewed at a given url. Will send a `videostart` - * event unless the same url/videoId had previously been paused. - * Video metadata must be provided, specifically the video ID and video duration. - * - * - * The `url` value is *not* the URL of a video, but the post which contains the video. If the video - * is not embedded in a post, then this should contain a well-formatted URL on the customer's - * domain (e.g. http:///app-videos). This URL doesn't need to return a 200 status - * when crawled, but must but well-formatted so Parse.ly systems recognize it as belonging to - * the customer. - * - * @param url URL of post the video is embedded in. If videos is not embedded, a - * valid URL for the customer should still be provided. - * (e.g. http:///app-videos) - * @param urlRef Referrer URL associated with this video view. - * @param videoMetadata Metadata about the video being tracked. - * @param extraData A Map of additional information to send with the event. - */ override fun trackPlay( url: String, urlRef: String, @@ -266,36 +193,10 @@ internal class ParselyTrackerInternal internal constructor( ).also { it.start() } } - /** - * Pause video tracking. - * - * - * Pauses video tracking for an ongoing video. If [.trackPlay] is immediately called again for - * the same video, a new video start event will not be sent. This models a user pausing a - * playing video. - * - * - * NOTE: This or [.resetVideo] **must** be called in your `MainActivity` during various Android lifecycle events - * like `onPause` or `onStop`. Otherwise, engaged time tracking may keep running in the background - * and Parse.ly values may be inaccurate. - */ override fun trackPause() { videoEngagementManager?.stop() } - /** - * Reset tracking on a video. - * - * - * Stops video tracking and resets internal state for the video. If [.trackPlay] is immediately - * called for the same video, a new video start event is set. This models a user stopping a - * video and (on [.trackPlay] being called again) starting it over. - * - * - * NOTE: This or [.trackPause] **must** be called in your `MainActivity` during various Android lifecycle events - * like `onPause` or `onStop`. Otherwise, engaged time tracking may keep running in the background - * and Parse.ly values may be inaccurate. - */ override fun resetVideo() { videoEngagementManager?.stop() videoEngagementManager = null @@ -311,15 +212,6 @@ internal class ParselyTrackerInternal internal constructor( inMemoryBuffer.add(event) } - /** - * Deprecated since 3.1.1. The SDK now automatically flushes the queue on app lifecycle events. - * Any usage of this method is safe to remove and will have no effect. Keeping for backwards compatibility. - */ - @Deprecated("The SDK now automatically flushes the queue on app lifecycle events. Any usage of this method is safe to remove and will have no effect") - override fun flushEventQueue() { - // no-op - } - /** * Start the timer to flush events to Parsely. * @@ -337,7 +229,7 @@ internal class ParselyTrackerInternal internal constructor( * * @return Whether the event queue flush timer is running. */ - override fun flushTimerIsActive(): Boolean { + private fun flushTimerIsActive(): Boolean { return flushManager.isRunning } @@ -349,7 +241,7 @@ internal class ParselyTrackerInternal internal constructor( flushQueue.invoke(dryRun) } - companion object { + internal companion object { private const val DEFAULT_ENGAGEMENT_INTERVAL_MILLIS = 10500 @JvmField val ROOT_URL: String = "https://p1.parsely.com/".intern() } diff --git a/parsely/src/test/java/com/parsely/parselyandroid/ParselyTrackerTest.kt b/parsely/src/test/java/com/parsely/parselyandroid/ParselyTrackerTest.kt new file mode 100644 index 00000000..e179d0e4 --- /dev/null +++ b/parsely/src/test/java/com/parsely/parselyandroid/ParselyTrackerTest.kt @@ -0,0 +1,40 @@ +package com.parsely.parselyandroid + +import org.junit.After +import org.junit.Test +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment + +@RunWith(RobolectricTestRunner::class) +class ParselyTrackerTest { + + @Test(expected = ParselyNotInitializedException::class) + fun `given no prior initialization, when executing a method, throw the exception`() { + ParselyTracker.sharedInstance().startEngagement("url") + } + + @Test(expected = ParselyAlreadyInitializedException::class) + fun `given prior initialization, when initializing, throw an exception`() { + ParselyTracker.init(siteId = "", context = RuntimeEnvironment.getApplication()) + + ParselyTracker.init(siteId = "", context = RuntimeEnvironment.getApplication()) + } + + @Test + fun `given no prior initialization, when initializing, do not throw any exception`() { + ParselyTracker.init(siteId = "", context = RuntimeEnvironment.getApplication()) + } + + @Test + fun `given tracker initialized, when calling a method, do not throw any exception`() { + ParselyTracker.init(siteId = "", context = RuntimeEnvironment.getApplication()) + + ParselyTracker.sharedInstance().startEngagement("url") + } + + @After + fun tearDown() { + ParselyTracker.tearDown() + } +} diff --git a/settings.gradle b/settings.gradle index e42700e3..3a08fd12 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,11 +1,12 @@ pluginManagement { - gradle.ext.agpVersion = '7.2.2' + gradle.ext.agpVersion = '8.2.2' plugins { id 'com.android.application' version gradle.ext.agpVersion id 'com.android.library' version gradle.ext.agpVersion id 'org.jetbrains.kotlin.android' version '1.9.10' id 'org.jetbrains.kotlinx.kover' version '0.7.4' + id 'org.jetbrains.kotlinx.binary-compatibility-validator' version '0.14.0' } repositories {