사용자에게 유효하지 않은 링크를 어떻게 보여줄것인가

[reddevilmidzy]

초기에 계획한 것은 사용자가 repository url을 입력하면 이제 주기적으로 링크를 검사하고 유효하지 않은 링크가 있다면 유효한 링크로 변경하는 PR을 올리는 것이 목표였다.

물론 이걸 다른 걸로 완전히 바꿀 생각은 아직 없지만 이 프로세스에 문제점이 보인다.

결과를 실시간으로 확인할 수 없다.

초기 사용자가 우리 서비스를 사용하게 하려면 그래도 눈에 보여지는 결과를 기대할(일단 나라면) 것 같다. 그러나 repository 파싱과 링크 검증 과정은 비동기로 처리되고 사용자가 repository url을 입력하며 요청한 응답에는 이런 링크 검증에 대한 응답은 포함되지 않고, 단순히 요청이 제대로 요청됐느냐에 대한 응답만 응답된다.

그리고 만약 입력한 repository url에 모든 링크가 유효하다는 것을 확인하는 방법은 PR이 올라오지 않았다는 것으로밖에 확인이 불가하다. PR이 어느 시간대에 올라오는지도 모를뿐더러 아직 PR이 올라오지 않아 이 repository는 모든 링크가 검증됐구나라고 생각한 찰나에 PR이 올라올 수도 있다.

그래서 이 문제를 해결하기 위한 방법으로 2가지가 있다.

이메일로 결과 전송

검증 결과를 이메일로 전송하는 것이다. #46
아래서 이야기할 실시간에는 관심없고 결과만 궁금하다! 하는 사용자들은 이 이메일 결과를 확인하면 될 듯 하다.

클라이언트와 실시간 통신

다른 방법으로는 클라이언트와 웹 소켓(혹은 SSE) 통신을 맺고 실시간으로 처리 과정을 보여주는 것이다. 시각적으로 프로세스를 보여주니 이 서비스에 흥미가 생기길 희망하고 있다.

이런 느낌으로 빨간색 부분은 기존에 깨진 링크고 초록색 부분은 새로 변경될 링크다. 주황색은 코드 블럭이다. 만약 깨진 링크를 발견하면 코드 블럭이 추가되고, 깨진 링크 발견 없이 프로세스가 종료된다면 모든 링크가 유효하다고 응답을 보내는 것이다.

사용자가 PR을 만들기 전에 만들 PR을 확인하고 싶을 수도 있는데 이때 이걸 확인해도 좋을 듯 하다. 그리고 여기서 확인하고 PR 생성 버튼 딱 누르면 이제 PR이 생성된다.

[reddevilmidzy]

이제 방향을 cli 쪽으로 바꿨고 ci 환경에서 돌아가는 것을 최우선으로 개발하고 있다. 다만 이렇게 되면 사용자가 쉽게 접할 수 없기 때문에(queensac[bot] 설치, yml 수정 등등) 편하게 접할 수 있도록 웹 환경에서도 로그 정도만 보여주는 방식을 구현해보자.