[gwt-contrib] [google-web-toolkit] r10316 committed - Add ServerFailure.getRequestContext()....

codesite-noreply Fri, 10 Jun 2011 14:07:25 -0700

Revision: 10316
Author:   [email protected]
Date:     Fri Jun 10 10:21:52 2011
Log:      Add ServerFailure.getRequestContext().
Provide getters for Request -> RequestContext -> RequestFactory ->
RequestTransport.
Add fakes for modified interfaces.
Issue 6469.
Review at http://gwt-code-reviews.appspot.com/1451815/
Patch by: bobv
Review by: rjrjr
Suggested by: jasonhall


http://code.google.com/p/google-web-toolkit/source/detail?r=10316

Added:

/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequest.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestFactory.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestTransport.java

Modified:
 /trunk/user/src/com/google/web/bindery/requestfactory/shared/Request.java

/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestContext.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestFactory.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestTransport.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/ServerFailure.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/impl/AbstractRequest.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/impl/AbstractRequestContext.java/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestContext.java/trunk/user/test/com/google/web/bindery/requestfactory/gwt/client/RequestFactoryTest.java


=======================================
--- /dev/null

+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequest.javaFri Jun 10 10:21:52 2011

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2011 Google Inc.
+ *

+ * Licensed under the Apache License, Version 2.0 (the "License"); you maynot+ * use this file except in compliance with the License. You may obtain acopy of

+ * the License at
+ *
+ * http://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 limitationsunder

+ * the License.
+ */
+package com.google.web.bindery.requestfactory.shared.testing;
+
+import com.google.web.bindery.requestfactory.shared.Receiver;
+import com.google.web.bindery.requestfactory.shared.Request;
+import com.google.web.bindery.requestfactory.shared.RequestContext;
+
+/**

+ * A no-op implementation of Request that can be used as a base type forwriting

+ * unit tests.
+ *
+ * @param <T> The return type of objects in the corresponding response.
+ */
+public class FakeRequest<T> implements Request<T> {
+
+  /**
+   * No-op.
+   */
+  @Override
+  public void fire() {
+  }
+
+  /**
+   * No-op.
+   */
+  @Override
+  public void fire(Receiver<? super T> receiver) {
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public RequestContext getRequestContext() {
+    return null;
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public RequestContext to(Receiver<? super T> receiver) {
+    return null;
+  }
+
+  /**
+   * Returns {@code this}.
+   */
+  @Override
+  public Request<T> with(String... propertyRefs) {
+    return this;
+  }
+}
=======================================
--- /dev/null

+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestFactory.javaFri Jun 10 10:21:52 2011

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2011 Google Inc.
+ *

+ * Licensed under the Apache License, Version 2.0 (the "License"); you maynot+ * use this file except in compliance with the License. You may obtain acopy of

+ * the License at
+ *
+ * http://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 limitationsunder

+ * the License.
+ */
+package com.google.web.bindery.requestfactory.shared.testing;
+
+import com.google.web.bindery.event.shared.EventBus;
+import com.google.web.bindery.requestfactory.shared.EntityProxy;
+import com.google.web.bindery.requestfactory.shared.EntityProxyId;
+import com.google.web.bindery.requestfactory.shared.ProxySerializer;
+import com.google.web.bindery.requestfactory.shared.ProxyStore;
+import com.google.web.bindery.requestfactory.shared.Request;
+import com.google.web.bindery.requestfactory.shared.RequestFactory;
+import com.google.web.bindery.requestfactory.shared.RequestTransport;
+
+/**
+ * A no-op implementation of {@link RequestFactory} that can be used for
+ * building mocks.
+ */
+public class FakeRequestFactory implements RequestFactory {
+
+  private EventBus eventBus;
+  private RequestTransport requestTransport;
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override

+ public <P extends EntityProxy> Request<P> find(EntityProxyId<P> proxyId){

+    return null;
+  }
+
+  /**
+   * Returns the last value passed to
+   * {@link #initialize(EventBus, RequestTransport)}.
+   */
+  @Override
+  public EventBus getEventBus() {
+    return eventBus;
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public String getHistoryToken(Class<? extends EntityProxy> clazz) {
+    return null;
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public String getHistoryToken(EntityProxyId<?> proxy) {
+    return null;
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public Class<? extends EntityProxy> getProxyClass(String historyToken) {
+    return null;
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override

+ public <T extends EntityProxy> EntityProxyId<T> getProxyId(StringhistoryToken) {

+    return null;
+  }
+
+  /**
+   * Returns the last value passed to
+   * {@link #initialize(EventBus, RequestTransport)}.
+   */
+  @Override
+  public RequestTransport getRequestTransport() {
+    return requestTransport;
+  }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public ProxySerializer getSerializer(ProxyStore store) {
+    return null;
+  }
+
+  /**

+ * Equivalent to {@code initialize(eventBus, newFakeRequestTransport())}.

+   */
+  @Override
+  public void initialize(EventBus eventBus) {
+    initialize(eventBus, new FakeRequestTransport());
+  }
+
+  /**
+   * Saves the parameters for later retrieval.
+   */
+  @Override
+  public void initialize(EventBus eventBus, RequestTransport transport) {
+    this.eventBus = eventBus;
+    this.requestTransport = transport;
+  }
+}
=======================================
--- /dev/null

+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestTransport.javaFri Jun 10 10:21:52 2011

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2011 Google Inc.
+ *

+ * Licensed under the Apache License, Version 2.0 (the "License"); you maynot+ * use this file except in compliance with the License. You may obtain acopy of

+ * the License at
+ *
+ * http://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 limitationsunder

+ * the License.
+ */
+package com.google.web.bindery.requestfactory.shared.testing;
+
+import com.google.web.bindery.requestfactory.shared.RequestTransport;
+
+/**

+ * A no-op implementation of {@link RequestTransport} that can be used forunit

+ * testing.
+ */
+public class FakeRequestTransport implements RequestTransport {
+  /**
+   * No-op.
+   */
+  @Override
+  public void send(String payload, TransportReceiver receiver) {
+  }
+}
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/Request.javaThu Jun 2 12:22:33 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/Request.javaFri Jun 10 10:21:52 2011

@@ -16,9 +16,14 @@
 package com.google.web.bindery.requestfactory.shared;

 /**
- * Implemented by the request objects created by this factory.
+ * A Request represents a single method invocation on the server. It

+ * encapsulates the arguments provided to the Request factory methoddeclared in+ * a RequestContext as well as a set of object paths to return from theserver.

+ * The returned data is provided to an optional {@link Receiver} object,
+ * specified by the {@link #to(Receiver)} method.
  *
  * @param <T> The return type of objects in the corresponding response.
+ * @see com.google.web.bindery.requestfactory.shared.testing.FakeRequest
  */
 public interface Request<T> {

@@ -35,6 +40,11 @@
    */
   void fire(Receiver<? super T> receiver);

+  /**
+   * Returns the RequestContext associated with the Request.
+   */
+  RequestContext getRequestContext();
+
   /**

* Specify the object that will receive the result of the methodinvocation.

    *
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestContext.javaFri May 27 05:11:13 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestContext.javaFri Jun 10 10:21:52 2011

@@ -90,6 +90,11 @@
    */
   void fire(Receiver<Void> receiver);

+  /**
+   * Returns the {@link RequestFactory} that created the RequestContext.
+   */
+  RequestFactory getRequestFactory();
+
   /**

* Returns true if any changes have been made to proxies mutable underthis* context. Note that vacuous changes — e.g.foo.setName(foo.getName()

=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestFactory.javaThu Jun 2 12:22:33 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestFactory.javaFri Jun 10 10:21:52 2011

@@ -40,6 +40,7 @@
  * supertypes of value types is not supported (e.g. Object, Enum, Number).
  * </p>
  *

+ * @seecom.google.web.bindery.requestfactory.shared.testing.FakeRequestFactory* @seecom.google.web.bindery.requestfactory.server.testing.InProcessRequestTransport

  */
 public interface RequestFactory {
@@ -117,6 +118,13 @@
    */
   <T extends EntityProxy> EntityProxyId<T> getProxyId(String historyToken);

+  /**
+   * Returns the RequestTransport set via {@link #initialize}.
+   *
+   * @return the {@link RequestTransport} associated with this instance
+   */
+  RequestTransport getRequestTransport();
+
   /**
    * Returns a ProxySerializer that can encode and decode the various
    * EntityProxy and ValueProxy types reachable from the RequestFactory.
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestTransport.javaThu Jun 2 12:22:33 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/RequestTransport.javaFri Jun 10 10:21:52 2011

@@ -20,6 +20,7 @@
  * payload to the backend.
  *

* @seecom.google.web.bindery.requestfactory.gwt.client.DefaultRequestTransport+ * @seecom.google.web.bindery.requestfactory.shared.testing.FakeRequestTransport

  */
 public interface RequestTransport {
   /**
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/ServerFailure.javaThu Jun 2 12:22:33 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/ServerFailure.javaFri Jun 10 10:21:52 2011

@@ -27,6 +27,7 @@
   private final String stackTraceString;
   private final String exceptionType;
   private final boolean fatal;
+  private RequestContext requestContext;

   /**
    * Constructs a ServerFailure with null properties.
@@ -73,6 +74,13 @@
   public String getMessage() {
     return message;
   }
+
+  /**
+   * Returns the RequestContext that triggered the ServerFailure.
+   */
+  public RequestContext getRequestContext() {
+    return requestContext;
+  }

   /**
    * Return the failure stack trace.
@@ -92,4 +100,11 @@
   public boolean isFatal() {
     return fatal;
   }
-}
+
+  /**
+   * Sets the RequestContext to return via {@link #getRequestContext()}.
+   */
+  public void setRequestContext(RequestContext requestContext) {
+    this.requestContext = requestContext;
+  }
+}
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/impl/AbstractRequest.javaThu Apr 21 12:44:49 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/impl/AbstractRequest.javaFri Jun 10 10:21:52 2011

@@ -36,8 +36,7 @@
  *
  * @param <T> return type
  */
-public abstract class AbstractRequest<T> implements Request<T>,
-    InstanceRequest<BaseProxy, T> {

+public abstract class AbstractRequest<T> implements Request<T>,InstanceRequest<BaseProxy, T> {


   /**
    * Used by generated subtypes.
@@ -66,6 +65,11 @@
   public Set<String> getPropertyRefs() {
     return Collections.unmodifiableSet(propertyRefs);
   }
+
+  @Override
+  public RequestContext getRequestContext() {
+    return requestContext;
+  }

   public RequestData getRequestData() {
     if (requestData == null) {
@@ -119,8 +123,9 @@
     // The user may not have called to()
     if (receiver != null) {
       @SuppressWarnings("unchecked")
-      T result = (T) EntityCodex.decode(requestContext,

- requestData.getReturnType(), requestData.getElementType(),split);

+      T result =

+ (T) EntityCodex.decode(requestContext,requestData.getReturnType(), requestData

+              .getElementType(), split);
       receiver.onSuccess(result);
     }
   }
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/impl/AbstractRequestContext.javaThu Jun 9 11:31:51 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/impl/AbstractRequestContext.javaFri Jun 10 10:21:52 2011

@@ -661,6 +661,7 @@
    */
   protected void fail(Receiver<Void> receiver, ServerFailure failure) {
     reuse();
+    failure.setRequestContext(this);
     Set<Throwable> causes = null;

for (AbstractRequest<?> request : newArrayList<AbstractRequest<?>>(state.invocations)) {

       try {
=======================================

---/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestContext.javaFri May 27 05:11:13 2011+++/trunk/user/src/com/google/web/bindery/requestfactory/shared/testing/FakeRequestContext.javaFri Jun 10 10:21:52 2011

@@ -21,6 +21,7 @@
 import com.google.web.bindery.requestfactory.shared.Receiver;
 import com.google.web.bindery.requestfactory.shared.Request;
 import com.google.web.bindery.requestfactory.shared.RequestContext;
+import com.google.web.bindery.requestfactory.shared.RequestFactory;

 /**

* A no-op implementation of RequestConext that can be used as a base typefor

@@ -73,6 +74,14 @@
   @Override
   public void fire(Receiver<Void> receiver) {
   }
+
+  /**
+   * Returns {@code null}.
+   */
+  @Override
+  public RequestFactory getRequestFactory() {
+    return null;
+  }

   /**
    * Always returns {@code false}.
=======================================

---/trunk/user/test/com/google/web/bindery/requestfactory/gwt/client/RequestFactoryTest.javaThu Jun 9 11:31:51 2011+++/trunk/user/test/com/google/web/bindery/requestfactory/gwt/client/RequestFactoryTest.javaFri Jun 10 10:21:52 2011

@@ -74,6 +74,7 @@

     @Override
     public void onFailure(ServerFailure error) {

+ assertSame(persistRequest.getRequestContext(),error.getRequestContext());

       assertEquals(expectedException, error.getExceptionType());
       if (expectedException != null) {
         assertFalse(error.getStackTraceString().length() == 0);

--
http://groups.google.com/group/Google-Web-Toolkit-Contributors

[gwt-contrib] [google-web-toolkit] r10316 committed - Add ServerFailure.getRequestContext()....

Reply via email to