Использование TDD и прогрессивного улучшения для создания приложения чата

Что такое прогрессивное улучшение?

Если бы я попросил вас создать приложение для чата, вы, вероятно, начали бы задумываться о дизайне. Вы можете задать некоторые из следующих вопросов

— Использую ли я обычный HTTP или веб-сокеты?

— Какую базу данных я собираюсь использовать?

— Буду ли я поддерживать групповые чаты?

— Что я буду использовать для аутентификации?

— Какие технологии мы будем использовать в пользовательском интерфейсе?

Это может продолжаться в течение нескольких дней, идеально составляя план и дизайн, прежде чем мы начнем его выполнять. И это, конечно, разумные вопросы, но слишком легко увязнуть в разработке «идеальной» системы. Как разработчики мы знаем, что все эти благие намерения имеют тенденцию поражать поклонников, как только мы начинаем программировать. Прогрессивное улучшение — гораздо более прагматичный способ развития. Я использую следующий цикл:

• Напишите тест для самого базового функционала, который может быть полезен / необходим

•  Напишите самый простой неоптимизированный код для прохождения теста.

•  При необходимости рефакторинг.

•  Повторение

Это приводит нас прямо к коду, и мы думаем о проблемах в практическом, а не теоретическом смысле. В конечном итоге вы получите полное решение, но с быстрой обратной связью и хорошо проверенным кодом.

Практически это означает много недолговечного кода, который переписывается. Если я сначала создаю свое чат-приложение, используя список истории в памяти вместо формального бэкенда, мне придется вернуться назад и внести некоторые довольно фундаментальные изменения. Однако, используя TDD, мой код будет формироваться таким образом, чтобы сделать этот рефакторинг очень дешевым, и я буду исследовать проблемное пространство с помощью кода и тестов, а не составлять ручной список вещей, которые, я думаю, мне нужно будет рассмотреть , Рабочий код — единственная мера успеха.

For many this will be a very different way of working. I encourage you not to just read and forget this post but to try it out tomorrow at work. It’s a very satisfying way of working that results in beautiful, flexible code.

Applying This to a Chat Application

As mentioned earlier, I’m building a chat application, something like Whatsapp or telegram. What is the most basic piece of functionality we could test for in a chat application? Ideally, for one person to be able to send a message to another. To do that, we can ignore databases, authentication and all that other stuff. Let’s just send a message between two people. But we can break it down further; for this to happen, I need to be able to “see” a chat, so I need to be able to access a chats content. When a chat first starts, it will have no content in it. So,my first test should then be to retrieve a chat, and expect the chat to have no messages in it.

With progressive enhancement, the “nothing happens” test is often the first. It instantly gets you thinking about the API and design. To get to even this point, I’ve had to make a number of assumptions. I have had to decide that if two people are in the system and I request the chat log between the two of them, but they haven’t spoken, it will return an empty list of message (not null, not an error etc). And this choice is clearly documented by the test. This is why I love TDD- it results in a clear set of documentation in the form of tests. Below is the first test.

@Test

public void noChatTextForPeopleWhoHaventSpokenBefore() throws Exception {

WizChatApplication chatApplication = startServer();
HttpResponse<JsonNode> jsonResponse = get(chatApplication.url() + "/chat/jason/sookie").asJson();
assertThat(extractChat(jsonResponse), is(""));
}


private WizChatApplication startServer() throws Exception {
  WizChatApplication chatApplication = new WizChatApplication();
  chatApplication.main(new String[]{"server"});
  return chatApplication;
}



private String extractChat(HttpResponse<JsonNode> jsonResponse) {
return jsonResponse.getBody().getObject().getString("chat");
}

@Path("/chat/{userOne}/{userTwo}")
@Produces(MediaType.APPLICATION_JSON)
public class ChatRoomResource {

  @GET
  public Chat chatBetween(@PathParam("userOne") Optional<String> userOne,
    @PathParam("userTwo") Optional<String> userTwo) {
    return new Chat(“”);
  }

public class Chat {
  private String chat;

  public Chat() {
  // Jackson deserialization
  }

  public Chat(String content) {
  this.chat = content;
  }

  @JsonProperty
  public String getChat() {
  return chat;
  }
}

@Test
public void chatReturnsMessagesThatHaveBeenSent() throws Exception {
WizChatApplication chatApplication = startServer();
    String message = "Hey Sookie";
    post(chatApplication.url() + "/chat/jason/sookie")
    .field("message", message)
.asJson();

    HttpResponse<JsonNode> jsonResponse = get(chatApplication.url() + "/chat/jason/sookie").asJson();

    assertThat(extractChat(jsonResponse), is("jason: " + message));

}

 @Test
    public void userWithMultipleChatsCanAccessAllChats() throws Exception {
        String message = "This a chat between bob and sue";
        post(chatApplication.url() + "/chat/bob/sue")
                .field("message", message)
                .asJson();

        String message2 = "This is a chat between Mike and Bob”;

        post(chatApplication.url() + "/chat/mike/bob")
                .field("message", message2)
                .asJson();

        HttpResponse<JsonNode> jsonResponseBobSue = get(chatApplication.url() + "/chat/bob/sue").asJson();
        HttpResponse<JsonNode> jsonResponseMikeDan = get(chatApplication.url() + "/chat/mike/bob").asJson();

        assertThat(extractChat(jsonResponseBobSue), is("bob: " + message));
        assertThat(extractChat(jsonResponseMikeDan), is("mike: " + message2));

    }

@Path("/chat/{userOne}/{userTwo}")
@Produces(MediaType.APPLICATION_JSON)
public class ChatRoomResource {

    List<Chat> chats = new LinkedList<Chat>();

    @GET
    public Chat chatBetween(@PathParam("userOne") final Optional<String> userOne,
                            @PathParam("userTwo") final Optional<String> userTwo) {
        String userOneName = userOne.get();
        String userTwoName = userTwo.get();
        return chats.stream()
                .filter(chat -> chat.isBetween(userOneName, userTwoName))
                .findFirst()
                .orElse(new Chat("", userOneName, userTwoName));
    }

    @POST
    public void newMessage(
            @PathParam("userOne") Optional<String> from,
            @PathParam("userTwo") Optional<String> to,
            @FormParam("message") Optional<String> message
    ) {
        String formattedMessage = from.get() + ": " + message.get();
        for (Chat chat : chats) {
            if (chat.isBetween(from.get(), to.get())) {
                chat.addMessage(formattedMessage);
                return;
            }
        }
        chats.add(new Chat(formattedMessage, from.get(), to.get()));

    }

}

public class Chat {
    private String chat;
    public String userOne;
    public String userTwo;

    public Chat() {
        // Jackson deserialization
    }

    public Chat(String content, String userOne, String userTwo) {
        this.chat = content;
        this.userOne = userOne;
        this.userTwo = userTwo;
    }


    @JsonProperty
    public String getChat() {
        return chat;
    }

    public void addMessage(String s) {
        chat += s;
    }

    public boolean isBetween(String s, String s1) {
        return userOne.equals(s) && userTwo.equals(s1) || userOne.equals(s1) && userTwo.equals(s);
    }
}