Reddit投稿の履歴を保存する

Reddit投稿後の履歴を保存する

1. 概要

今回のthe Reddit App case studyの記事では、the history of submission attempts for a postの追跡を開始し、ステータスをよりわかりやすく、理解しやすいものにします。

**2. Postエンティティの改善**

まず、Postエンティティの古い文字列ステータスを、より多くの情報を追跡しながら、送信応答のより完全なリストに置き換えることから始めましょう。

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

次に、この新しい送信応答エンティティで実際に追跡しているものを見てみましょう。

@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();
    }
}

各consumed submission attemptにはSubmissionResponseがあるため、次のようになります。

attemptNumber：この試行の数
content：この試みの詳細な応答
submissionDate：この試行の送信日
scoreCheckDate：この試行でRedditPostのスコアを確認した日付

そして、ここに簡単なSpring Data JPAリポジトリがあります：

public interface SubmissionResponseRepository extends JpaRepository {

    SubmissionResponse findOneByPostAndAttemptNumber(Post post, int attemptNumber);
}

3. スケジューリングサービス

この追加情報を追跡するために、サービスレイヤーの変更を開始する必要があります。

まず、投稿が成功または失敗と見なされた理由について、適切にフォーマットされた成功または失敗の理由があることを確認します。

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";
}

ここで、古いロジックとkeep 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);
    ...
}

下位レベルのメソッドが実際に実行していることに注意してください。

addAttemptResponse()：新しいSubmissionResponseレコードを作成し、それを投稿に追加します（送信の試行ごとに呼び出されます）
updateLastAttemptResponse()：最後の試行応答を更新します（投稿のスコアを確認しているときに呼び出されます）

4. スケジュールされたポストDTO

次に、DTOを変更して、この新しい情報がクライアントに公開されるようにします。

public class ScheduledPostDto {
    ...

    private String status;

    private List detailedStatus;
}

そして、これが単純なSubmissionResponseDtoです。

public class SubmissionResponseDto {

    private int attemptNumber;

    private String content;

    private String localSubmissionDate;

    private String localScoreCheckDate;
}

また、ScheduledPostRestControllerの変換方法を変更します。

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. フロントエンド

次に、フロントエンドのscheduledPosts.jspを変更して、新しい応答を処理します。


    Detailed Status

6. テスト

最後に、新しいメソッドで簡単な単体テストを実行します。

まず、getSuccessReason()の実装をテストします。

@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"));
}

次に、getFailReason()の実装をテストします。

@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. 結論

今回の記事では、Reddit投稿のライフサイクルに非常に有用な可視性を導入しました。これで、各操作の正確な理由とともに、投稿がいつ送信されて削除されたかを正確に確認できるようになりました。

TOC