ikieEngineeringGet started
All posts

할 일동기화포트·어댑터웹훅

다른 앱의 할 일 일곱을 엔진 하나로 붙였어요

Notion·Slack·Todoist·Linear·Google Tasks·Microsoft To Do·GitHub의 할 일이 할 일 모음으로 들어와요. 원본마다 다른 것은 칸 대응뿐이라 어댑터 하나가 160~350줄이에요. 칸 셋을 3방향으로 합치고, 웹훅 몸은 믿지 않고 신호로만 써요.

English

할 일은 한 앱에만 있지 않아요. 회사 일은 Linear에, 개인 일은 Todoist에, 같이 쓰는 문서는 Notion에, 누가 맡긴 일은 Slack 메시지로 와요. ikie의 할 일 모음은 그것들이 다 모이는 곳이 되려고 해요. 다른 앱에서 나에게 맡긴 열린 할 일이 들어오고, 할 시간은 ikie에서 정해요.

10월 16일 하루에 원본 일곱을 붙였어요. 첫 원본(Notion)을 붙이며 포트와 엔진을 만들었고, 나머지 여섯은 어댑터만 더했어요.

  1. 04:16Notion: 포트·3방향 합치기·엔진·표를 함께 (#557)
  2. 13:42Notion 웹훅으로 몇 초 안에 받기 (#583)
  3. 17:06Slack: 메시지 바로가기로 할 일 넣기 (#592)
  4. 19:45Todoist: 프로젝트마다 목록, 웹훅 (#598)
  5. 22:52Linear: 나에게 맡긴 이슈, 웹훅 (#600)
  6. 23:02Google Tasks·Microsoft To Do·GitHub 이슈 (#603)

캘린더 맞추기와 같은 모양으로

ikie는 이미 외부 캘린더를 칸마다 세 쪽을 견줘 합치고 있었어요. 할 일 원본도 같은 모양으로 만들었어요. 다른 것은 칸 수예요. 캘린더는 칸 묶음이 여럿이지만, 할 일은 제목·끝냄·마감 셋뿐이에요.

  1. 판단packages/core/src/task-sync.ts

    칸 셋을 3방향으로 합쳐 ikie에 쓸 것과 원본에 보낼 것을 정해요. DB도 네트워크도 몰라요.

  2. 포트TaskSourcePort

    원본 이름, 목록, 칸 만들기, 열린 할 일, 하나 다시 읽기, 바꾼 칸 보내기. 이 여섯 가지가 전부예요.

  3. 엔진lib/data/task-sync.ts

    포트로 읽고, 판단이 정한 대로 쓰기만 해요. 같은 원본을 두 곳에서 동시에 맞추지 않게 잠가요.

  4. 어댑터 ×7lib/data/<원본>

    원본의 API를 포트 모양으로 바꿔요. 칸 대응은 core의 원본별 파일에 순수 함수로 둬요.

엔진은 어느 원본인지 몰라요. 포트 하나만 부르고, 무엇을 쓸지는 순수 계산이 정해요.

원본마다 다른 것은 "원본의 무엇이 제목·끝냄·마감인가"뿐이에요. 그래서 어댑터가 작아요.

숫자로 보기
원본어댑터(칸 대응 + API)
Notion345줄
Todoist254줄
Linear226줄
Slack196줄
GitHub185줄
Google Tasks164줄
Microsoft To Do160줄
원본마다 core의 칸 대응 파일과 lib/data 어댑터 폴더의 줄 수(시험 빼고)예요. 엔진은 155줄, 판단은 104줄로 일곱이 함께 써요.

Notion이 가장 큰 것은 칸이 정해져 있지 않아서예요. Notion 표는 사람마다 칸이 달라서, 어느 칸이 끝냄이고 마감인지 골라야 해요. Todoist·Linear·Google Tasks처럼 칸이 정해진 원본은 고를 것이 없어요.

칸 셋, 둘 다 바뀌면 원본

맞출 때마다 칸마다 세 값을 견줘요. 마지막으로 맞춘 값(기준), 지금 ikie의 값, 지금 원본의 값이에요. 기준과 다른 쪽이 바꾼 쪽이에요.

칸기준(마지막으로 맞춘 값)ikie원본(Linear)합친 값
제목결제 화면 고치기결제 화면 문구 고치기결제 화면 고치기결제 화면 문구 고치기ikie만 바꿈: 원본에 보내요
끝냄열림열림끝냄끝냄원본만 바꿈: ikie에 써요
마감10/20 15:0010/20 15:0010/2010/20 15:00같은 날의 날만: 바뀌지 않은 것
칸마다 세 쪽을 견줘요. 둘 다 바꿨으면 원본이 이겨요. 할 일의 주인은 원본이고, ikie는 할 시간을 더하는 쪽이에요.

마감 줄이 이 일의 까다로운 곳이었어요. Linear와 Google Tasks는 마감을 날로만 담아요. ikie에서 "20일 3시까지"로 정하고 보내면, 원본은 "20일"만 돌려줘요. 그대로 견주면 원본이 마감을 바꾼 것처럼 보여서 ikie의 시각이 지워져요. 그래서 기준이 시각 있는 마감이고 원본이 같은 날의 날만 돌려주면, 원본은 바뀌지 않은 것으로 봐요(#600).

Microsoft To Do도 마감을 날로 담는데, 그 날은 그 사람의 시간대로 읽고 써요. 같은 3시가 서울과 런던에서 다른 날일 수 있으니까요.

원본마다 다른 것은 칸 대응뿐이에요

원본목록맞추는 칸바로 알아채기
Notion데이터베이스마다제목·끝냄·마감 (칸을 골라요)웹훅
Todoist프로젝트마다제목·끝냄·마감웹훅
Linear팀마다제목·끝냄·마감(날만)웹훅
Google Tasks할 일 목록마다제목·끝냄·마감(날만)크론
Microsoft To Do목록마다제목·끝냄·마감(그 사람의 날)크론
GitHub맡은 이슈 한 목록제목·끝냄(닫기)크론
Slack넣은 메시지 모음없음 (넣을 때만 묶어요)메시지 바로가기

가져오는 것은 열린 것, 그리고 나에게 맡긴 것이에요. Todoist는 맡은 사람이 없거나 나인 것만, Linear와 GitHub는 나에게 맡긴 이슈만 가져와요. 남의 일로 할 일 모음이 차면 안 되니까요. 반복하는 Todoist 할 일은 빼요. Todoist는 반복을 끝내면 다음 회차로 넘겨 열린 채 두어서, 끝냄을 맞추면 계속 넘어가거든요.

Slack은 맞출 칸이 없는 원본이에요. 메시지에서 "ikie에 할 일로"를 누르면 그 메시지가 할 일 모음에 들어오고, Slack에서 여는 링크가 붙어요. 다른 원본과 같은 묶음 표에 적히니, 할 일 줄에 Slack 로고와 열기 링크가 똑같이 붙어요.

Notion은 짐작하지 않아요

Notion 표에는 "완료" 대신 "중요"라는 체크 칸이, "마감" 대신 "시작일"이라는 날짜 칸이 있을 수 있어요. 처음에는 체크 칸이 하나뿐이면 그것을 끝냄으로 짐작했어요. 그러면 ikie에서 할 일을 끝낼 때 Notion의 "중요"가 켜져요. 남의 데이터를 잘못 고치는 거예요.

그래서 짐작을 줄였어요(#568, #571).

  • 이름이 끝냄·마감과 맞지 않는 칸은 하나뿐이어도 쓰지 않아요.
  • 상태 선택 칸이 있으면 어느 상태를 끝낸 것으로 볼지 사람이 골라요.
  • 맞는 칸이 없으면 사람이 이미 있는 칸에서 고르거나, ikie가 끝냄(체크)·마감(날짜) 칸을 그 표에 만들어요.

고른 칸 대응은 목록마다 저장하고, 어댑터는 그것을 먼저 따라요.

남의 데이터를 고치는 쪽은 짐작하지 않아요. 모르면 사람에게 고르게 하거나, 칸을 새로 만들어요.

웹훅 몸은 믿지 않아요

앱을 열지 않아도 맞춰야 해요. 그래서 세 가지 길로 맞춰요.

  • 앱을 열 때와 쓰기 뒤: 캘린더 맞추기와 함께 돌아요.
  • 웹훅: Notion·Todoist·Linear는 바뀌면 ikie를 불러요. 서명을 확인하고, 응답한 뒤 그 사람의 원본을 맞춰요.
  • 크론: 5분마다 돌고, 마지막으로 맞춘 지 10분 지난 원본을 오래된 것부터 20개씩 맞춰요. 웹훅이 없는 원본은 이것으로 맞춰요.

웹훅이 실어 오는 몸은 신호로만 써요. "누구의 원본이 바뀌었다"까지만 읽고, 값은 원본 API에서 다시 읽어요. 몸에 적힌 제목이나 상태를 그대로 쓰지 않으니, 순서가 뒤바뀌어 온 웹훅이나 같은 웹훅이 두 번 와도 결과가 같아요. 맞추는 길이 하나라서 웹훅·크론·앱 열기가 모두 같은 엔진을 타요.

서명은 원본마다 방식이 달라요. 셋 다 받은 몸 그대로를 비밀로 HMAC-SHA256해서 견주고, Linear는 1분 넘게 지난 웹훅도 막아요. 몸을 JSON으로 다시 쓰면 바이트가 달라지니, 받은 글 그대로 재요.

끊어도 잃지 않아요

연결을 끊으면 토큰만 지우고 원본·목록·묶음은 남겨요. 같은 계정으로 다시 이으면 그 묶음에 다시 붙어서, 같은 할 일이 두 번 들어오지 않아요(#633).

  • 원본에서 할 일이 다른 목록으로 옮겨 가면 묶음도 따라 옮겨요.
  • 원본에서 안 보이면 사라진 때만 적어 두고, 다시 나타나면 이어 맞춰요.
  • ikie에서 지운 할 일은 묶음을 남겨서 다시 가져오지 않아요. 원본은 지우지 않아요.

연결은 로그인 수단이 아니라 계정 잇기예요. Google Tasks와 Microsoft To Do는 Google·Outlook 로그인과 같은 키를 쓰지만 연결을 따로 둬서, 할 일 연결을 끊어도 로그인과 캘린더는 그대로예요. 토큰은 DB에 잠가 둬요.

배운 것

  • 첫 원본에서 포트를 만들면 둘째부터는 어댑터만 남아요. 일곱 중 여섯은 칸 대응과 API 호출만 더했어요.
  • 날만 담는 원본은 메아리를 조심해요. 보낸 값이 줄어서 돌아오면 그것은 바뀐 것이 아니에요.
  • 남의 데이터는 짐작으로 고치지 않아요. 하나뿐인 칸이라도 이름이 맞지 않으면 사람에게 물어요.
  • 웹훅은 신호예요. 값은 원본에서 다시 읽으면 순서·중복·위조를 따로 걱정할 일이 줄어요.

캘린더를 칸마다 합치는 이야기는 동기화 글에, 이렇게 모인 할 일 모음을 다시 짠 이야기는 할 일 모음 글에 있어요.

The ikie teamikie is a calendar for your events and to-dos in one place. Here we write about the problems we run into while building it, and how we solve them.