Fix issue where events too close to each other would get coalesced

Add tests for form field getters and setters

Author: irgendeinich

android/src/main/java/com/pspdfkit/react/TestingModule.java

@@ -40,7 +40,7 @@ public static String getValue(@NonNull String key) throws InterruptedException {
             if (!values.containsKey(key)) {
                 values.wait(60000);
                 if (!values.containsKey(key)) {
-                    throw new IllegalArgumentException("Key " + key + " was not found.");
+                    throw new IllegalArgumentException("Key " + key + " was not found. Got: " + values.toString());
                 }
             }
             return values.get(key);

android/src/main/java/com/pspdfkit/react/events/PdfViewDataReturnedEvent.java

@@ -22,10 +22,12 @@ public class PdfViewDataReturnedEvent extends Event<PdfViewDataReturnedEvent> {
 
     public static final String EVENT_NAME = "pdfViewDataReturned";
 
+    private final int requestId;
     private final WritableMap payload;
 
     public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull List<Annotation> annotationsToSerialize) {
         super(viewId);
+        this.requestId = requestId;
         Map<String, Object> map = new HashMap<>();
         map.put("requestId", requestId);
         try {
@@ -47,6 +49,7 @@ public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull List<
 
     public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull JSONObject jsonObject) {
         super(viewId);
+        this.requestId = requestId;
         Map<String, Object> map = new HashMap<>();
         map.put("requestId", requestId);
 
@@ -61,7 +64,7 @@ public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull JSONO
 
     public PdfViewDataReturnedEvent(@IdRes int viewId, int requestId, @NonNull Throwable throwable) {
         super(viewId);
-
+        this.requestId = requestId;
         payload = Arguments.createMap();
         payload.putInt("requestId", requestId);
         payload.putString("error", throwable.getMessage());
@@ -76,4 +79,9 @@ public String getEventName() {
     public void dispatch(RCTEventEmitter rctEventEmitter) {
         rctEventEmitter.receiveEvent(getViewTag(), getEventName(), payload);
     }
+
+    @Override
+    public short getCoalescingKey() {
+        return (short) requestId;
+    }
 }

samples/Catalog/android/app/src/androidTest/java/com/pspdfkit/react/PdfViewTest.java

@@ -6,6 +6,7 @@
 import android.support.test.runner.AndroidJUnit4;
 
 import com.pspdfkit.annotations.FreeTextAnnotation;
+import com.pspdfkit.forms.TextFormField;
 import com.pspdfkit.preferences.PSPDFKitPreferences;
 import com.pspdfkit.react.helper.JsonUtilities;
 import com.pspdfkit.react.test.TestActivity;
@@ -27,6 +28,7 @@
 import static com.pspdfkit.react.utils.ViewActions.waitForViewNotDisplayed;
 import static junit.framework.Assert.assertEquals;
 import static junit.framework.Assert.assertFalse;
+import static junit.framework.Assert.assertNull;
 
 @RunWith(AndroidJUnit4.class)
 public class PdfViewTest {
@@ -110,6 +112,50 @@ public void testGettingAnnotationsInComponentDidMount() throws InterruptedExcept
         assertEquals("{\"annotations\":[]}", annotations);
     }
 
+    @Test
+    public void testSettingsFormValues() throws InterruptedException {
+        // FormsScreen.js
+
+        openExample("Forms");
+
+        // Check with the form provider that the fields are empty.
+        PdfFragment fragment = (PdfFragment) activityRule.getActivity().getSupportFragmentManager().findFragmentByTag("PDF1");
+        TextFormField lastname = (TextFormField) fragment.getDocument().getFormProvider().getFormFieldWithFullyQualifiedName("Name_Last");
+        TextFormField firstname = (TextFormField)fragment.getDocument().getFormProvider().getFormFieldWithFullyQualifiedName("Name_First");
+        assertNull(lastname.getFormElement().getText());
+        assertNull(firstname.getFormElement().getText());
+
+        // Perform setting the form values.
+        onView(withText("SET")).perform(click());
+
+        assertEquals("Appleseed", lastname.getFormElement().getText());
+        assertEquals("John", firstname.getFormElement().getText());
+    }
+
+    @Test
+    public void testGettingFormValues() throws InterruptedException {
+        // FormsScreen.js
+
+        openExample("Forms");
+
+        // Check with the form provider that the fields are empty.
+        PdfFragment fragment = (PdfFragment) activityRule.getActivity().getSupportFragmentManager().findFragmentByTag("PDF1");
+        TextFormField lastname = (TextFormField) fragment.getDocument().getFormProvider().getFormFieldWithFullyQualifiedName("Name_Last");
+        TextFormField firstname = (TextFormField)fragment.getDocument().getFormProvider().getFormFieldWithFullyQualifiedName("Name_First");
+        assertNull(lastname.getFormElement().getText());
+        assertNull(firstname.getFormElement().getText());
+
+        // Set the form fields.
+        lastname.getFormElement().setText("Appleseed");
+        firstname.getFormElement().setText("John");
+
+        // Get the form values in our react code.
+        onView(withText("GET")).perform(click());
+
+        assertEquals("{\"value\":\"Appleseed\"}", TestingModule.getValue("lastName"));
+        assertEquals("{\"value\":\"John\"}", TestingModule.getValue("firstName"));
+    }
+
     private void openExample(String exampleName) throws InterruptedException {
         // Wait until react is loaded.
         onView(isRoot()).perform(waitForView(withText("Test Cases")));

samples/Catalog/testing/FormsScreen.js

@@ -0,0 +1,51 @@
+import React, { Component } from "react";
+
+import {
+    View,
+    Button,
+    NativeModules
+} from "react-native"
+
+import PSPDFKitView from "react-native-pspdfkit";
+
+export default class FormsScreen extends Component<{}> {
+    static navigationOptions = ({ navigation }) => {
+        return {
+            title: "PDF"
+        };
+    };
+
+    componentDidMount() {
+        NativeModules.TestingModule.setValue("did_load", "true");
+    }
+
+    render() {
+        return (
+            <View style={{ flex: 1 }}>
+                <PSPDFKitView
+                    ref="pdfView"
+                    document="file:///android_asset/Form_example.pdf"
+                    configuration={{
+                    }}
+                    fragmentTag="PDF1"
+                    annotationAuthorName="Author"
+                    style={{ flex: 1 }}
+                />
+                <View style={{ flexDirection: 'row', height: 40, alignItems: 'center', padding: 10 }}>
+                    <Button onPress={() => {
+                        this.refs.pdfView.getFormFieldValue("Name_Last").then(value => {
+                            NativeModules.TestingModule.setValue("lastName", JSON.stringify(value));
+                        })
+                        this.refs.pdfView.getFormFieldValue("Name_First").then(value => {
+                            NativeModules.TestingModule.setValue("firstName", JSON.stringify(value));
+                        })
+                    }} title="Get" />
+                    <Button onPress={() => {
+                        this.refs.pdfView.setFormFieldValue("Name_Last", "Appleseed");
+                        this.refs.pdfView.setFormFieldValue("Name_First", "John");
+                    }} title="Set" />
+                </View>
+            </View>
+        );
+    }
+}

samples/Catalog/testing/Testing.js

@@ -19,6 +19,7 @@ import styles from './styles'
 import AuthorNameScreen from './AuthorNameScreen'
 import AnnotationToolbarScreen from './AnnotationToolbarScreen'
 import GetAnnotationsScreen from './GetAnnotationsScreen'
+import FormsScreen from './FormsScreen'
 
 import PSPDFKitView from "react-native-pspdfkit";
 
@@ -38,6 +39,12 @@ var examples = [
         action: component => {
             component.props.navigation.navigate("GetAnnotations");
         }
+    },
+    {
+        name: "Forms",
+        action: component => {
+            component.props.navigation.navigate("Forms");
+        }
     }
 ]
 
@@ -105,6 +112,9 @@ export default StackNavigator(
         },
         GetAnnotations: {
             screen: GetAnnotationsScreen
+        },
+        Forms: {
+            screen: FormsScreen
         }
     },
     {