TOC

Preserve o histórico de envios de publicações do Reddit

Preserve o histórico de envios de publicações do Reddit

1. Visão geral

Nesta edição dethe Reddit App case study, vamos começar a monitorarthe history of submission attempts for a post e tornar os status mais descritivos e fáceis de entender.

2. Melhorando a entidadePost

Primeiro, vamos começar substituindo o antigo status de String na entidadePost por uma lista muito mais completa de respostas de envio, mantendo o controle de muito mais informações: 

public class Post {
    ...
    @OneToMany(fetch = FetchType.EAGER, mappedBy = "post")
    private List submissionsResponse;
}

A seguir, vamos ver o que estamos realmente monitorando nesta nova entidade de resposta de envio: 

@Entity
public class SubmissionResponse implements IEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private int attemptNumber;

    private String content;

    private Date submissionDate;

    private Date scoreCheckDate;

    @JsonIgnore
    @ManyToOne
    @JoinColumn(name = "post_id", nullable = false)
    private Post post;

    public SubmissionResponse(int attemptNumber, String content, Post post) {
        super();
        this.attemptNumber = attemptNumber;
        this.content = content;
        this.submissionDate = new Date();
        this.post = post;
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("Attempt No ").append(attemptNumber).append(" : ").append(content);
        return builder.toString();
    }
}

Observe que cadaconsumed submission attempt tem umSubmissionResponse, de modo que:

  • attemptNumber: o número desta tentativa

  • content: a resposta detalhada desta tentativa

  • submissionDate: a data de envio desta tentativa

  • scoreCheckDate: a data em que verificamos a pontuação do RedditPost nesta tentativa

E aqui está o repositório simples do Spring Data JPA: 

public interface SubmissionResponseRepository extends JpaRepository {

    SubmissionResponse findOneByPostAndAttemptNumber(Post post, int attemptNumber);
}

3. Serviço de agendamento

Agora precisamos começar a modificar a camada de serviço para acompanhar essas informações extras.

Primeiro, vamos nos certificar de que temos motivos de sucesso ou fracasso bem formatados para explicar por que o Post foi considerado um sucesso ou um fracasso: 

private final static String SCORE_TEMPLATE = "score %d %s minimum score %d";
private final static String TOTAL_VOTES_TEMPLATE = "total votes %d %s minimum total votes %d";

protected String getFailReason(Post post, PostScores postScores) {
    StringBuilder builder = new StringBuilder();
    builder.append("Failed because ");
    builder.append(String.format(
      SCORE_TEMPLATE, postScores.getScore(), "<", post.getMinScoreRequired()));

    if (post.getMinTotalVotes() > 0) {
        builder.append(" and ");
        builder.append(String.format(TOTAL_VOTES_TEMPLATE,
          postScores.getTotalVotes(), "<", post.getMinTotalVotes()));
    }
    if (post.isKeepIfHasComments()) {
        builder.append(" and has no comments");
    }
    return builder.toString();
}

protected String getSuccessReason(Post post, PostScores postScores) {
    StringBuilder builder = new StringBuilder();
    if (postScores.getScore() >= post.getMinScoreRequired()) {
        builder.append("Succeed because ");
        builder.append(String.format(SCORE_TEMPLATE,
          postScores.getScore(), ">=", post.getMinScoreRequired()));
        return builder.toString();
    }
    if (
      (post.getMinTotalVotes() > 0) &&
      (postScores.getTotalVotes() >= post.getMinTotalVotes())
    ) {
        builder.append("Succeed because ");
        builder.append(String.format(TOTAL_VOTES_TEMPLATE,
          postScores.getTotalVotes(), ">=", post.getMinTotalVotes()));
        return builder.toString();
    }
    return "Succeed because has comments";
}

Agora, vamos melhorar a lógica antiga ekeep track of this extra historical information: 

private void submitPost(...) {
    ...
    if (errorNode == null) {
        post.setSubmissionsResponse(addAttemptResponse(post, "Submitted to Reddit"));
        ...
    } else {
        post.setSubmissionsResponse(addAttemptResponse(post, errorNode.toString()));
        ...
    }
}
private void checkAndReSubmit(Post post) {
    if (didIntervalPass(...)) {
        PostScores postScores = getPostScores(post);
        if (didPostGoalFail(post, postScores)) {
            ...
            resetPost(post, getFailReason(post, postScores));
        } else {
            ...
            updateLastAttemptResponse(
              post, "Post reached target score successfully " +
                getSuccessReason(post, postScores));
        }
    }
}
private void checkAndDeleteInternal(Post post) {
    if (didIntervalPass(...)) {
        PostScores postScores = getPostScores(post);
        if (didPostGoalFail(post, postScores)) {
            updateLastAttemptResponse(post,
              "Deleted from reddit, consumed all attempts without reaching score " +
                getFailReason(post, postScores));
            ...
        } else {
            updateLastAttemptResponse(post,
              "Post reached target score successfully " +
                getSuccessReason(post, postScores));
            ...
        }
    }
}
private void resetPost(Post post, String failReason) {
    ...
    updateLastAttemptResponse(post, "Deleted from Reddit, to be resubmitted " + failReason);
    ...
}

Observe o que os métodos de nível inferior estão realmente fazendo:

  • addAttemptResponse(): cria um novo registroSubmissionResponse e adiciona-o à postagem (chamado a cada tentativa de envio)

  • updateLastAttemptResponse(): atualiza a última tentativa de resposta (chamada durante a verificação da pontuação da postagem)

4. DTO de postagem programada

Em seguida, modificaremos o DTO para garantir que essas novas informações sejam expostas de volta ao cliente: 

public class ScheduledPostDto {
    ...

    private String status;

    private List detailedStatus;
}

E aqui está oSubmissionResponseDto simples: 

public class SubmissionResponseDto {

    private int attemptNumber;

    private String content;

    private String localSubmissionDate;

    private String localScoreCheckDate;
}

Também modificaremos o método de conversão em nossoScheduledPostRestController: 

private ScheduledPostDto convertToDto(Post post) {
    ...
    List response = post.getSubmissionsResponse();
    if ((response != null) && (response.size() > 0)) {
        postDto.setStatus(response.get(response.size() - 1).toString().substring(0, 30));
        List responsedto =
          post.getSubmissionsResponse().stream().
            map(res -> generateResponseDto(res)).collect(Collectors.toList());
        postDto.setDetailedStatus(responsedto);
    } else {
        postDto.setStatus("Not sent yet");
        postDto.setDetailedStatus(Collections.emptyList());
    }
    return postDto;
}

private SubmissionResponseDto generateResponseDto(SubmissionResponse responseEntity) {
    SubmissionResponseDto dto = modelMapper.map(responseEntity, SubmissionResponseDto.class);
    String timezone = userService.getCurrentUser().getPreference().getTimezone();
    dto.setLocalSubmissionDate(responseEntity.getSubmissionDate(), timezone);
    if (responseEntity.getScoreCheckDate() != null) {
        dto.setLocalScoreCheckDate(responseEntity.getScoreCheckDate(), timezone);
    }
    return dto;
}

5. a parte dianteira

A seguir, modificaremos nosso front-endscheduledPosts.jsp para lidar com nossa nova resposta: 


    
Detailed Status

6. Testes

Por fim, realizaremos um teste de unidade simples em nossos novos métodos:

Primeiro, vamos testar a implementação degetSuccessReason(): 

@Test
public void whenHasEnoughScore_thenSucceed() {
    Post post = new Post();
    post.setMinScoreRequired(5);
    PostScores postScores = new PostScores(6, 10, 1);

    assertTrue(getSuccessReason(post, postScores).contains("Succeed because score"));
}

@Test
public void whenHasEnoughTotalVotes_thenSucceed() {
    Post post = new Post();
    post.setMinScoreRequired(5);
    post.setMinTotalVotes(8);
    PostScores postScores = new PostScores(2, 10, 1);

    assertTrue(getSuccessReason(post, postScores).contains("Succeed because total votes"));
}

@Test
public void givenKeepPostIfHasComments_whenHasComments_thenSucceed() {
    Post post = new Post();
    post.setMinScoreRequired(5);
    post.setKeepIfHasComments(true);
    final PostScores postScores = new PostScores(2, 10, 1);

    assertTrue(getSuccessReason(post, postScores).contains("Succeed because has comments"));
}

A seguir, testaremos a implementação degetFailReason(): 

@Test
public void whenNotEnoughScore_thenFail() {
    Post post = new Post();
    post.setMinScoreRequired(5);
    PostScores postScores = new PostScores(2, 10, 1);

    assertTrue(getFailReason(post, postScores).contains("Failed because score"));
}

@Test
public void whenNotEnoughTotalVotes_thenFail() {
    Post post = new Post();
    post.setMinScoreRequired(5);
    post.setMinTotalVotes(15);
    PostScores postScores = new PostScores(2, 10, 1);

    String reason = getFailReason(post, postScores);
    assertTrue(reason.contains("Failed because score"));
    assertTrue(reason.contains("and total votes"));
}

@Test
public void givenKeepPostIfHasComments_whenNotHasComments_thenFail() {
    Post post = new Post();
    post.setMinScoreRequired(5);
    post.setKeepIfHasComments(true);
    final PostScores postScores = new PostScores(2, 10, 0);

    String reason = getFailReason(post, postScores);
    assertTrue(reason.contains("Failed because score"));
    assertTrue(reason.contains("and has no comments"));
}

7. Conclusão

Nesta edição, introduzimos uma visibilidade muito útil no ciclo de vida de uma postagem do Reddit. Agora podemos ver exatamente quando uma postagem foi enviada e excluída a cada vez, junto com o motivo exato de cada operação.

Related