From 48160f9d847c0246883bc81599613b1ebe2652a6 Mon Sep 17 00:00:00 2001
From: Kurt Partridge <kep@google.com>
Date: Fri, 10 Aug 2012 14:21:18 -0700
Subject: [PATCH] [Rlog3] improve stat recording

Change-Id: Ie3b70e6eadc2a9af5ef45ddfad6a3398cea7bfe8
---
 .../android/inputmethod/latin/LatinIME.java   |  3 +
 .../android/inputmethod/research/LogUnit.java |  8 ++-
 .../inputmethod/research/ResearchLogger.java  | 56 ++++++++++---------
 .../inputmethod/research/Statistics.java      | 19 ++++++-
 4 files changed, 58 insertions(+), 28 deletions(-)

diff --git a/java/src/com/android/inputmethod/latin/LatinIME.java b/java/src/com/android/inputmethod/latin/LatinIME.java
index 9d52f3a701..a2c9e5b8f5 100644
--- a/java/src/com/android/inputmethod/latin/LatinIME.java
+++ b/java/src/com/android/inputmethod/latin/LatinIME.java
@@ -1588,6 +1588,9 @@ public final class LatinIME extends InputMethodService implements KeyboardAction
         mConnection.setComposingText(batchInputText, 1);
         mExpectingUpdateSelection = true;
         mConnection.endBatchEdit();
+        if (ProductionFlag.IS_EXPERIMENTAL) {
+            ResearchLogger.latinIME_onEndBatchInput(batchInputText, 0);
+        }
         // Space state must be updated before calling updateShiftState
         mSpaceState = SPACE_STATE_PHANTOM;
         mKeyboardSwitcher.updateShiftState();
diff --git a/java/src/com/android/inputmethod/research/LogUnit.java b/java/src/com/android/inputmethod/research/LogUnit.java
index 3e542a43ff..ab9d2f8578 100644
--- a/java/src/com/android/inputmethod/research/LogUnit.java
+++ b/java/src/com/android/inputmethod/research/LogUnit.java
@@ -62,12 +62,16 @@ import java.util.List;
         mIsPartOfMegaword = isPartOfMegaword;
     }
 
+    private static final Object[] NULL_VALUES = new Object[0];
     /**
      * Adds a new log statement.  The time parameter in successive calls to this method must be
      * monotonically increasing, or splitByTime() will not work.
      */
-    public void addLogStatement(final LogStatement logStatement, final Object[] values,
-            final long time) {
+    public void addLogStatement(final LogStatement logStatement, final long time,
+            Object... values) {
+        if (values == null) {
+            values = NULL_VALUES;
+        }
         mLogStatementList.add(logStatement);
         mValuesList.add(values);
         mTimeList.add(time);
diff --git a/java/src/com/android/inputmethod/research/ResearchLogger.java b/java/src/com/android/inputmethod/research/ResearchLogger.java
index 9ea46eeb97..0c94abc246 100644
--- a/java/src/com/android/inputmethod/research/ResearchLogger.java
+++ b/java/src/com/android/inputmethod/research/ResearchLogger.java
@@ -565,10 +565,8 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
             mFeedbackLogBuffer.clear();
         }
         final LogUnit feedbackLogUnit = new LogUnit();
-        final Object[] values = {
-            feedbackContents
-        };
-        feedbackLogUnit.addLogStatement(LOGSTATEMENT_FEEDBACK, values, SystemClock.uptimeMillis());
+        feedbackLogUnit.addLogStatement(LOGSTATEMENT_FEEDBACK, SystemClock.uptimeMillis(),
+                feedbackContents);
         mFeedbackLogBuffer.shiftIn(feedbackLogUnit);
         publishLogBuffer(mFeedbackLogBuffer, mFeedbackLog, true /* isIncludingPrivateData */);
         mFeedbackLog.close(new Runnable() {
@@ -653,19 +651,14 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
         }
     }
 
-    private static final Object[] NULL_VALUES = {};
-
     /**
      * Buffer a research log event, flagging it as privacy-sensitive.
      */
     private synchronized void enqueueEvent(LogStatement logStatement, Object... values) {
-        if (values == null) {
-            values = NULL_VALUES;
-        }
         assert values.length == logStatement.mKeys.length;
         if (isAllowedToLog()) {
             final long time = SystemClock.uptimeMillis();
-            mCurrentLogUnit.addLogStatement(logStatement, values, time);
+            mCurrentLogUnit.addLogStatement(logStatement, time, values);
         }
     }
 
@@ -701,11 +694,8 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
     /* package for test */ void publishLogBuffer(final LogBuffer logBuffer,
             final ResearchLog researchLog, final boolean isIncludingPrivateData) {
         final LogUnit openingLogUnit = new LogUnit();
-        final Object[] values = {
-            isIncludingPrivateData
-        };
-        openingLogUnit.addLogStatement(LOGSTATEMENT_LOG_SEGMENT_OPENING, values,
-                SystemClock.uptimeMillis());
+        openingLogUnit.addLogStatement(LOGSTATEMENT_LOG_SEGMENT_OPENING, SystemClock.uptimeMillis(),
+                isIncludingPrivateData);
         researchLog.publish(openingLogUnit, true /* isIncludingPrivateData */);
         LogUnit logUnit;
         while ((logUnit = logBuffer.shiftOut()) != null) {
@@ -716,7 +706,7 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
             researchLog.publish(logUnit, isIncludingPrivateData);
         }
         final LogUnit closingLogUnit = new LogUnit();
-        closingLogUnit.addLogStatement(LOGSTATEMENT_LOG_SEGMENT_CLOSING, NULL_VALUES,
+        closingLogUnit.addLogStatement(LOGSTATEMENT_LOG_SEGMENT_CLOSING,
                 SystemClock.uptimeMillis());
         researchLog.publish(closingLogUnit, true /* isIncludingPrivateData */);
     }
@@ -732,19 +722,21 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
         return false;
     }
 
-    private static final LogStatement LOGSTATEMENT_COMMIT_AUTOSPACE =
-            new LogStatement("CommitAutospace", true, false);
-    private void onWordComplete(final String word, final long maxTime, final boolean isPartial) {
-        Log.d(TAG, "onWordComplete: " + word);
+    private static final LogStatement LOGSTATEMENT_COMMIT_RECORD_SPLIT_WORDS =
+            new LogStatement("recordSplitWords", true, false);
+    private void onWordComplete(final String word, final long maxTime, final boolean isSplitWords) {
         if (word != null && word.length() > 0 && hasLetters(word)) {
             mCurrentLogUnit.setWord(word);
-            mStatistics.recordWordEntered();
+            final boolean isDictionaryWord = mDictionary != null
+                    && mDictionary.isValidWord(word);
+            mStatistics.recordWordEntered(isDictionaryWord);
         }
         final LogUnit newLogUnit = mCurrentLogUnit.splitByTime(maxTime);
         enqueueCommitText(word);
-        if (isPartial) {
-            enqueueEvent(LOGSTATEMENT_COMMIT_AUTOSPACE, NULL_VALUES);
+        if (isSplitWords) {
+            enqueueEvent(LOGSTATEMENT_COMMIT_RECORD_SPLIT_WORDS);
             enqueueCommitText(" ");
+            mStatistics.recordSplitWords();
         }
         commitCurrentLogUnit();
         mCurrentLogUnit = newLogUnit;
@@ -1205,11 +1197,23 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
         getInstance().enqueueEvent(LOGSTATEMENT_USER_TIMESTAMP);
     }
 
+    private static final LogStatement LOGSTATEMENT_LATINIME_ONENDBATCHINPUT =
+            new LogStatement("LatinIMEOnEndBatchInput", true, false, "enteredText",
+                    "enteredWordPos");
+    public static void latinIME_onEndBatchInput(final CharSequence enteredText,
+            final int enteredWordPos) {
+        final ResearchLogger researchLogger = getInstance();
+        researchLogger.enqueueEvent(LOGSTATEMENT_LATINIME_ONENDBATCHINPUT, enteredText,
+                enteredWordPos);
+        researchLogger.mStatistics.recordGestureInput();
+    }
+
     private static final LogStatement LOGSTATEMENT_STATISTICS =
             new LogStatement("Statistics", false, false, "charCount", "letterCount", "numberCount",
                     "spaceCount", "deleteOpsCount", "wordCount", "isEmptyUponStarting",
                     "isEmptinessStateKnown", "averageTimeBetweenKeys", "averageTimeBeforeDelete",
-                    "averageTimeDuringRepeatedDelete", "averageTimeAfterDelete");
+                    "averageTimeDuringRepeatedDelete", "averageTimeAfterDelete",
+                    "dictionaryWordCount", "splitWordsCount", "gestureInputCount");
     private static void logStatistics() {
         final ResearchLogger researchLogger = getInstance();
         final Statistics statistics = researchLogger.mStatistics;
@@ -1219,6 +1223,8 @@ public class ResearchLogger implements SharedPreferences.OnSharedPreferenceChang
                 statistics.mIsEmptinessStateKnown, statistics.mKeyCounter.getAverageTime(),
                 statistics.mBeforeDeleteKeyCounter.getAverageTime(),
                 statistics.mDuringRepeatedDeleteKeysCounter.getAverageTime(),
-                statistics.mAfterDeleteKeyCounter.getAverageTime());
+                statistics.mAfterDeleteKeyCounter.getAverageTime(),
+                statistics.mDictionaryWordCount, statistics.mSplitWordsCount,
+                statistics.mGestureInputCount);
     }
 }
diff --git a/java/src/com/android/inputmethod/research/Statistics.java b/java/src/com/android/inputmethod/research/Statistics.java
index 2065ab15eb..90d7f38b3c 100644
--- a/java/src/com/android/inputmethod/research/Statistics.java
+++ b/java/src/com/android/inputmethod/research/Statistics.java
@@ -36,6 +36,12 @@ public class Statistics {
     int mDeleteKeyCount;
     // Number of words entered during a session.
     int mWordCount;
+    // Number of words found in the dictionary.
+    int mDictionaryWordCount;
+    // Number of words split and spaces automatically entered.
+    int mSplitWordsCount;
+    // Number of gestures that were input.
+    int mGestureInputCount;
     // Whether the text field was empty upon editing
     boolean mIsEmptyUponStarting;
     boolean mIsEmptinessStateKnown;
@@ -143,8 +149,19 @@ public class Statistics {
         mLastTapTime = time;
     }
 
-    public void recordWordEntered() {
+    public void recordWordEntered(final boolean isDictionaryWord) {
         mWordCount++;
+        if (isDictionaryWord) {
+            mDictionaryWordCount++;
+        }
+    }
+
+    public void recordSplitWords() {
+        mSplitWordsCount++;
+    }
+
+    public void recordGestureInput() {
+        mGestureInputCount++;
     }
 
     public void setIsEmptyUponStarting(final boolean isEmpty) {
-- 
GitLab