src/main/java/com/google/android/libraries/feed/common/testing/PagingState.java

// Copyright 2018 The Feed Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy 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
// limitations under the License.

package com.google.android.libraries.feed.common.testing;

import static com.google.android.libraries.feed.common.testing.ResponseBuilder.ROOT_CONTENT_ID;
import static com.google.common.truth.Truth.assertThat;

import com.google.android.libraries.feed.common.testing.ResponseBuilder.WireProtocolInfo;
import com.google.android.libraries.feed.internalapi.common.testing.ContentIdGenerators;
import com.google.protobuf.ByteString;
import com.google.search.now.feed.client.StreamDataProto.StreamToken;
import com.google.search.now.wire.feed.ContentIdProto.ContentId;
import com.google.search.now.wire.feed.ResponseProto.Response;
import java.nio.charset.Charset;

/**
 * Creates a paging based responses. Create two {@link Response} object, and initial response and a
 * page response. In addition, create a {@link StreamToken} which is used to trigger the paged
 * response.
 */
public class PagingState {
  public final Response initialResponse;
  public final Response pageResponse;
  public final StreamToken streamToken;

  public PagingState(
      ContentId[] initialCards,
      ContentId[] pageCards,
      int tokenId,
      ContentIdGenerators idGenerator) {
    ByteString token = ByteString.copyFrom(Integer.toString(tokenId), Charset.defaultCharset());
    initialResponse = getInitialResponse(initialCards, tokenId, token);
    streamToken = getSessionId(token, tokenId, idGenerator);
    pageResponse = getPageResponse(pageCards);
  }

  private static Response getInitialResponse(ContentId[] cards, int tokenId, ByteString token) {
    ResponseBuilder responseBuilder =
        ResponseBuilder.forClearAllWithCards(cards).addStreamToken(tokenId, token);
    WireProtocolInfo info = responseBuilder.getWireProtocolInfo();
    assertThat(info.hasToken).isTrue();
    return responseBuilder.build();
  }

  private static Response getPageResponse(ContentId[] pagedCards) {
    return ResponseBuilder.builder().addCardsToRoot(pagedCards).build();
  }

  private static StreamToken getSessionId(
      ByteString token, int id, ContentIdGenerators idGenerator) {
    ContentId tokenId =
        ContentId.newBuilder().setContentDomain("token").setId(id).setTable("feature").build();

    StreamToken.Builder tokenBuilder = StreamToken.newBuilder();
    tokenBuilder.setParentId(idGenerator.createContentId(ROOT_CONTENT_ID));
    tokenBuilder.setContentId(idGenerator.createContentId(tokenId));
    tokenBuilder.setNextPageToken(token);
    return tokenBuilder.build();
  }
}