test(vscode): getRepo 함수, 기존 URL 파싱 테스트 케이스에 타입/구조 검증 추가

[ethandeveloper2]

Related issue

Closes #848
#843

Result

• 모든 케이스에서 반환 값과 owner/repo 필드의 타입(string)을 함께 검증하도록 개선
• 함수 반환 구조(Contract)를 명확히 하는 테스트를 별도로 추가

Work list

• 각 테스트 케이스에서 값뿐 아니라 owner/repo 필드의 타입까지 동시에 검증
• 반환 구조 명세(Contract)를 위한 별도의 구조 테스트 추가(문서화 목적)

Discussion

변경 배경 및 기대 효과

• 값, 타입, 구조를 모든 케이스에서 한 번에 검증함으로써 테스트의 신뢰성을 강화했습니다.
• 함수 반환 타입을 명확하게 문서화하여, 동일한 문제의 재발을 예방하고 유지보수성을 높였습니다.

[ytaek]

(잘 모름)
음 저도 정확하게는 모르지만, 결국 ts test code도 transpile되서 js가 되고,
js의 type은 아래 처럼 7종류가 될껀데,
https://developer.mozilla.org/ko/docs/Web/JavaScript/Guide/Data_structures

이 중에서 저희가 string 말고 다른 type이 들어올 일이 있을까요? json string을 받아오는거라면
모두 string이 될게 명확한게 아닌걸까용?

[ethandeveloper2]

좋은 의견 감사합니다!

코드를 다시 확인해보니,
말씀해주신 대로 타입스크립트에서 이미 getRepo의 반환 타입이 문자열로 명확하게 보장되고 있어서,
각 케이스별 typeof 검증 테스트는 불필요하다고 판단하여 해당 부분을 삭제했습니다.

또한, 기존 문서화(Contract) 테스트 코드의 의도가 충분히 전달되지 않는 것 같아
#843 이슈와 같이 발생할 수 있는 문제를 예방하는 취지와 배경을 주석으로 명확히 남기도록 하겠습니다.

[ytaek]

리뷰 남겼습니다!!!
주석 처리 같은 경우는 unused comment 처리 정도의 이슈로 남겨놓고 다음 PR에서 해결하시면 어떨까요? 😸

[ytaek]

음 가급적이면 주석은 영어로 적으면 좋을 것 같습니다.
그리고, 가능하다면 적지 않고 코드로 말하면 좋을 수 있구요!
(주석도 소스코드의 일부분이지요. 꼭 필요한 코드만 넣듯이 주석도 필요한 부분!!)

지금 처럼, 이전 에러 같은 경우에 꼭 필요하다고 하면
짧게 이슈 넘버를 활용하는 것도 방법입니다. // refer #323

아래 의도같은 경우에는 test이름에 충분히 넣을 수 있을 것 같습니다 😺

[ethandeveloper2]

네 알겠습니다. 추가 이슈 남겨서 처리해보겠습니다.
감사합니다~

[chae-dahee]

설명해주신 과거 repo[0] 등 부분 문자열 사용으로 인한 버그 재발 방지 의도가 좋은 것 같습니다~👍

1. 첫번째 describe("Valid Git URL formats") 테스트와 중복처럼 보이는데 차이점이 궁금합니다!
2. repo[0] 버그 발생은 getRepo 는 정확한 값을 반환하는데, extension.ts에서 그 값을 잘못 사용(initialRepo[0])한 상황이라고 생각했습니다.
   그렇다면 getRepo의 유닛 테스트로는 해당 버그를 감지하기 어려울 것 같은데... 어떻게 생각하시나요?
3. 2번에 대한 내용이 맞다면, getRepo 테스트 코드가 아닌, fetchClusterNodes 함수에 대한 테스트 코드 작성으로 방지할 수 있을 것 같습니다!
   (이부분은 현재 fetchClusterNodes코드에서 단위테스트 작성이 어려워서, active 함수와 분리하는 리팩토링이 필요할 것 같습니다... 관심사 분리 측면에서도 좋을 것 같으니 테스트 팀에서 진행하거나 리팩토링 팀과 이야기해봐도 좋을 것 같아요~)

혹시 제가 파악못한 부분이 있다면 알려주시면 감사하겠습니다~!

[SingTheCode]

LGTM!!!!
고생하셨습니다ㅎㅎㅎ