Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 52 additions & 7 deletions .github/workflows/app-store-downloads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ jobs:

report:
name: Collect and deliver
permissions:
contents: read
actions: read
needs: test
if: >-
github.event_name != 'pull_request' &&
Expand All @@ -65,21 +68,63 @@ jobs:
with:
node-version: '24'
package-manager-cache: false
- name: Collect Apple report and optionally post to Discord
- name: Find latest encrypted history
id: history
working-directory: automation/app-store-discord
env:
GITHUB_TOKEN: ${{ github.token }}
run: node scripts/restore-history.mjs
- name: Restore encrypted history
if: steps.history.outputs.run_id != ''
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
artifact-ids: ${{ steps.history.outputs.artifact_id }}
run-id: ${{ steps.history.outputs.run_id }}
github-token: ${{ github.token }}
path: ${{ runner.temp }}/routee-history-input
merge-multiple: true
- name: Prepare encrypted input and output
env:
HISTORY_RUN_ID: ${{ steps.history.outputs.run_id }}
shell: bash
run: |
mkdir -p "$RUNNER_TEMP/routee-history-input" "$RUNNER_TEMP/routee-history-output"
if [[ -z "$HISTORY_RUN_ID" ]]; then
cp automation/app-store-discord/history-seed.enc.json "$RUNNER_TEMP/routee-history-input/history.enc.json"
fi
test -s "$RUNNER_TEMP/routee-history-input/history.enc.json"
- name: Collect Apple report and encrypt complete history
working-directory: automation/app-store-discord
env:
ASC_APP_ID: '6791870747'
ASC_KEY_ID: ${{ secrets.ROUTEE_ASC_KEY_ID }}
ASC_ISSUER_ID: ${{ secrets.ROUTEE_ASC_ISSUER_ID }}
ASC_PRIVATE_KEY: ${{ secrets.ROUTEE_ASC_PRIVATE_KEY }}
ASC_REPORT_REQUEST_ID: ${{ vars.ROUTEE_ASC_REPORT_REQUEST_ID }}
HISTORY_KEY: ${{ secrets.ROUTEE_DOWNLOAD_HISTORY_KEY }}
REPORT_PERIOD: ${{ inputs.period || 'last_week' }}
shell: bash
run: |
node scripts/run-report.mjs --period "$REPORT_PERIOD" \
--history-in "$RUNNER_TEMP/routee-history-input/history.enc.json" \
--history-out "$RUNNER_TEMP/routee-history-output/history.enc.json"
- name: Preserve encrypted history before sending
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: routee-download-history
path: ${{ runner.temp }}/routee-history-output/history.enc.json
if-no-files-found: error
retention-days: 90
compression-level: 0
- name: Send the saved report to Discord
if: github.event_name == 'schedule' || inputs.send_to_discord
working-directory: automation/app-store-discord
env:
ASC_APP_ID: '6791870747'
HISTORY_KEY: ${{ secrets.ROUTEE_DOWNLOAD_HISTORY_KEY }}
DISCORD_WEBHOOK_URL: ${{ secrets.ROUTEE_DISCORD_WEBHOOK_URL }}
REPORT_PERIOD: ${{ inputs.period || 'last_week' }}
REPORT_SEND: ${{ github.event_name == 'schedule' || inputs.send_to_discord }}
shell: bash
run: |
args=(--period "$REPORT_PERIOD")
if [[ "$REPORT_SEND" == 'true' ]]; then
args+=(--send)
fi
node scripts/run-report.mjs "${args[@]}"
node scripts/run-report.mjs --period "$REPORT_PERIOD" --send --deliver-only \
--history-in "$RUNNER_TEMP/routee-history-output/history.enc.json"
3 changes: 3 additions & 0 deletions automation/app-store-discord/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ ASC_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nREPLACE_ME\n-----END PRIVATE KEY--
DISCORD_WEBHOOK_URL=
# 선택 사항: 여러 ONGOING 요청 중 하나를 지정할 때 사용
ASC_REPORT_REQUEST_ID=

# ROUTEE_DOWNLOAD_HISTORY_KEY와 같은 32바이트 base64 암호화 키
HISTORY_KEY=
2 changes: 2 additions & 0 deletions automation/app-store-discord/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ node_modules/
wrangler.jsonc
dist/
*.p8

.history/
41 changes: 32 additions & 9 deletions automation/app-store-discord/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 루티 다운로드 리포트

GitHub Actions가 App Store Connect의 **최초 다운로드 수**를 조회해 Discord 웹훅으로 전송한다. 별도 서버·Cloudflare·Discord 명령어용 앱은 사용하지 않는다.
GitHub Actions가 App Store Connect의 **기간별 최초 다운로드 수와 출시 이후 전체 최초 다운로드 수**를 Discord 웹훅으로 전송한다. 별도 서버·Cloudflare·Discord 명령어용 앱은 사용하지 않는다.

## 실행 방법

Expand All @@ -23,7 +23,8 @@ GitHub Actions가 App Store Connect의 **최초 다운로드 수**를 조회해
- 다른 다운로드 유형만 있는 날짜의 최초 다운로드는 0건이다. 날짜 자체가 없거나 자료가 미완성인 경우에는 0건으로 추정하지 않는다.
- 미확인 날짜가 있으면 **확인된 소계와 미확인 날짜**를 보낸다. 완전한 주간 합계로 표시하지 않는다.
- Apple 조회가 실패하면 수치를 만들어 보내지 않고 실행을 실패로 표시한다.
- 매 실행에서 최근 처리일 35일 내 파일을 새로 읽는다. 별도 DB·캐시가 필요 없으며 출시 이후 누적 지표는 제공하지 않는다.
- 전체 최초 다운로드는 출시일부터 연속으로 확인된 일별 수치를 합산하고, 누적 기간과 기준일을 항상 표시한다. 중간 날짜가 빠지면 그 전까지의 확인된 누적값에 **이후 집계 확인 대기**를 표시한다.
- 매 실행에서 최근 처리일 35일 내 파일을 다시 읽어 기존 전체 이력에 반영한다. 오래된 날짜의 정정도 기존 날짜를 교체하며, 이력을 90일 뒤 삭제하지 않는다.

## 최초 설정

Expand All @@ -39,10 +40,29 @@ Apple API 접근 승인, API 키 발급, 보고서 생성 요청이 필요하다
| `ROUTEE_ASC_ISSUER_ID` | 팀 Issuer ID |
| `ROUTEE_ASC_PRIVATE_KEY` | 운영 조회용 `.p8` PEM 전체 |
| `ROUTEE_DISCORD_WEBHOOK_URL` | 리포트를 받을 Discord 채널 웹훅 URL |
| `ROUTEE_DOWNLOAD_HISTORY_KEY` | 누적 이력 AES-256-GCM 암호화 키: 무작위 32바이트를 base64로 인코딩한 값 |

대상 앱 ID는 출시용 루티 `6791870747`이다. 활성 ONGOING 요청이 여러 개라면 Repository Variable `ROUTEE_ASC_REPORT_REQUEST_ID`로 하나를 지정한다.

처음에는 `send_to_discord`를 해제해 조회를 확인한다. 보고서가 준비된 후 전송을 실행한다. ONGOING 생성 이전의 전체 이력을 보장하지 않으며 ONE_TIME_SNAPSHOT의 과거 자료 수집은 현재 구현하지 않았다.
처음에는 `send_to_discord`를 해제해 조회와 암호화 이력 보관을 확인한다. 보고서가 준비된 후 전송을 실행한다.

## 전체 누적 이력

Apple report instance는 생성 35일 뒤 만료되므로 ONGOING 조회만으로 출시 이후 누적을 매번 재구성할 수 없다.

- 초기 이력 `history-seed.enc.json`은 App Store Connect **누적 기간 / 최초 다운로드 수 / 날짜별 CSV**에서 준비했다. 출시일부터 2026-11-15 UTC까지 모든 일별 행(명시적 0 포함)이 있는지, 일별 합계가 화면 누적과 같은지 대조했다. 원본 수치는 이 저장소에 포함하지 않는다.
- 매 실행은 같은 workflow의 `develop` 예약·수동 실행에서 만든 최신 `routee-download-history` artifact를 복원한다. 최초 실행에는 암호화된 초기 이력을 사용한다.
- 일별 전체 이력을 AES-256-GCM으로 암호화하고 **90일 보관 artifact**로 먼저 업로드한다. 보관에 성공한 뒤 동일한 이력·집계 시각으로 Discord에 전송한다. 수동 조회만 실행해도 이력을 갱신한다.
- 암호화 키 오류·변조·앱 불일치·만료된 artifact·GitHub 조회 오류가 있으면 전송하지 않는다. 수집한 이력을 보관하지 못한 경우에도 전송하지 않는다.
- 모든 artifact가 삭제되어 초기 이력으로 돌아가거나 실행이 오래 중단되어 35일보다 오래된 공백이 생기면, 누적값은 과거 기준으로 남을 수 있다. 마지막 확인 기준일과 대기 표시를 확인하고 전체 이력을 복구해야 한다. 초기 값에 최근 합계만 더해 공백을 숨기지 않는다.

복구 시 App Store Connect에서 **출시일부터 최신 완료일까지의 일별 CSV**를 다시 내보내거나 Admin 권한으로 `ONE_TIME_SNAPSHOT`을 요청한다(월 1회 제한). 모든 날짜와 화면 누적 합계를 검증한 뒤 아래 구조의 JSON을 Git에서 제외된 `.history/verified.json`에 만든다. `processingDate`는 확인일 UTC이며, 기준일은 최소 이틀 전이어야 한다. 실제 값을 GitHub 코드·로그·PR에 붙여 넣지 않는다.

```json
{"appId":"123","startDate":"2026-01-01","days":{"2026-01-01":{"count":2,"processingDate":"2026-01-03"}},"syncedAt":"2026-01-03T12:00:00.000Z"}
```

동일한 암호화 키로 `encryptHistory()`를 이용해 새 `history-seed.enc.json`을 만든다. 기존 artifact가 남아 있다면 초기 파일보다 우선하므로 복구한 암호화 파일을 다음 실행의 이력 입력으로 사용해야 한다. 키를 변경할 때는 기존 이력과 seed를 새 키로 함께 암호화해야 한다. 키 자체는 보관된 실제 통계를 복호화할 수 있으므로 Secrets 밖으로 공개하지 않는다.

## 로컬 실행

Expand All @@ -60,21 +80,24 @@ npm run preview
# 기본값은 안내만 출력. --apply일 때만 기존 요청 조회/생성을 실행한다.
node --env-file=.env scripts/request-reports.mjs --apply

# 실제 조회만 검증. 통계 본문은 콘솔에 출력하지 않는다.
node --env-file=.env scripts/run-report.mjs --period last_week
# 실제 조회와 이력 갱신. 통계 본문은 콘솔에 출력하지 않는다.
mkdir -p .history
node --env-file=.env scripts/run-report.mjs --period last_week \
--history-in history-seed.enc.json --history-out .history/history.enc.json

# 실제 Discord 전송
node --env-file=.env scripts/run-report.mjs --period last_week --send
# 보관된 이력으로 실제 Discord 전송 (Apple을 다시 조회하지 않음)
node --env-file=.env scripts/run-report.mjs --period last_week --send --deliver-only \
--history-in .history/history.enc.json
```

관리 스크립트는 PEM 대신 `ASC_PRIVATE_KEY_PATH`로 로컬 `.p8` 경로를 받을 수 있다. 운영 workflow에는 PEM을 Secret으로 전달한다.

## 공개 저장소에서의 정보 처리

- 실제 다운로드 수·보고서 본문·원본 파일은 GitHub 로그, Job Summary, Artifact에 남기지 않는다. Discord에만 전송한다.
- 실제 다운로드 수·보고서 본문·원본 파일은 GitHub 로그, Job Summary, Artifact에 평문으로 남기지 않는다. 저장소와 Artifact에는 인증 암호화된 이력만 저장하고, 실제 리포트는 Discord에 전송한다.
- API 키와 웹훅 URL은 코드에 넣지 않는다. 네트워크 예외 원문도 출력하지 않는다.
- PR에서는 모의 테스트만 실행하며 Secrets에 접근하지 않는다. 실제 조회는 `develop`의 예약·수동 실행에 한정한다.
- workflow 권한은 `contents: read`이며, 외부 Actions는 검증한 커밋 SHA에 고정한다.
- workflow는 `contents: read`, 실제 보고 job은 이력 복원을 위한 `actions: read`를 추가로 사용한다. 외부 Actions는 검증한 커밋 SHA에 고정한다.
- 웹훅 전송은 자동 재시도하지 않는다. 결과가 불확실하면 Discord 채널 확인 후 새 수동 실행을 선택한다.

## 공식 근거
Expand Down
1 change: 1 addition & 0 deletions automation/app-store-discord/history-seed.enc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"version":1,"iv":"mVPdI/wzfk66nHMH","tag":"q9b4rd+RcFp1ebS5ysZ8ng==","ciphertext":"uVcseeF31PS39LnahGjf4PMJk8XBWzMSCDZJId9PzdwjOg+9sZ6sMTXpH31lz0QqizyolVQouSynCVofVQcnKYRAqqMITKMkQKl70DBhgXh1VdFB99fiz4+KDIcaPxXztE2cZ9Z8ZLCmzU3r1g0feZDXds4qVDKhb3bcxz8mQC6x23NzupcQAcoo23Fg1WLgqTWbdPjBUgHkW988OvE1H4+EPp6aXcTIabnVDZZek8ReOJbPJfeWTVyXFJPJ3NIiy8xtqg0wP38rCSS2R4nYjR9j9mRrBQ0e23Vl3nIl9NtPddtnHlW0APJXk+5xIugdrNYcSFdSSc5R2WZtHx+qnSyfaU4xbDNEwbhslwePbiNlyZFGyotjwVoy5W9UhSRQDw8oUzBfGzXxLzNQ+rxTfWYX7qDT6ciu7ZOYJcgf4GvoqsXu71rpKW83umWSiFIgJDWoYr0F5EjYU8tdZX7fgYgnT5WWwklTZHCzMnisC2OxTQoFE9e8eZzy7zaUc2nZfsBWsUdXMBWJU8bSBTYQ658b9RAuk/FMlFpgbhMdkpFnAAF3iaocab6T21a0XJNkcN1Kz3m4gQ8e/8WFRur3Xz0aa4f0cO/D2ZqwDj3JQ/NwfuH5znzJT9fecpWyZsulBY7ZwHrhlgwQqyGioT5yvEU28T2/mpoDxr8asq/aS5TXVKV30+P4ZbCCqCOzS5+6uWmndjgKZU6V0Rvn4dZeyhzJmJkCgb9R3E7o4FZK/vhMM4X5TGNCDyAeD2/ed/DbFsiA3eVOgU/aXK2ZgempVdxZaxnH8iDI5/zPx99lddQXxtZmKnZPAkuKvkQLeDjyLoLbrGA0R7WQF/7vKqwwnuag8wdF+7QMoGV5STmXgFs39TbPa5hmcjdwGdoO94nuoOxb7iv2/eqDctvgOkBoPo0sJ5yB+JSbAZmxj2mknV+TKwOCgG0qNmeNitCQfdDljFWBUbZO0zK2plAV6KG7rnwTH1wpgJuIpk14xUdLAJHV4nBeZUabch1DxojhoiQ0P5pDxONS/AsJPAKNaU8Lq7dDltodsaoIkjGj66AeTk73JjDRdWQzNNJDL7XVP8xhpTQeAocT/LDJvFMeT29JEAopLLCQKxGYCYo4UWmq62bpPaeP8o1FO8pkjFndc56Uz22nNytJx1BFah6DgstXCJgkKCnuVa/bkFy8KW+l1Y+/IcIo1QZNM3Vy+br095vTteOdcF5ltXLQsJ0KlHqOTEoyNO2hOfGgVyPLcxfSpEGjjZW8uNqUkx/KANewDyUfKZ/qooUHD9IsjtOQ+c53JaAYRPDxhUWRONUGLYURtsUzIeAohkKTPFuh0E3ReJpX5lB3j+fNvGhwLqJ118jvSgDFn664VuhwMUEAU9VPr+FlPnCnFHZAxFBtlJuVqipjwUdF7rMFwEgcBXmd69eExHHNliMMxIyrAnqAzI3Kx5nPnSUI63wxlac7dkjD6HADSfuqVT8+9CWwpMAu65Nn9HjZE2N+mIsY59opbNCMXD1wi5w4ij9HDM1IyzrV5Jwo2z9HjV4Q5EYG22V+xXjQBPIsB0TCo5aQFWh1PfIhTiTN7KYxJc12iTQovHxVxpIu2PXOM7NA5rfQaOdXH13kAW1V6JynYVoPoqAfY3Jeo14+b+nc/Uo7x79vprUv39tYMW0ipRgmB+ZRz1VZkbGN+/RoPLRuriWfQR6/qwXOZ7dFPL/Dgk4UGUHtFPE4sd/1x3aT7CGZFxrTNN2b6ZZA0oUfRlam2CxSFssQKkCz3YdcbCU5GiR+KuEaAoA4AUkdwvUn7XCsiZ5anGmtwGi0nwprtN924aev+uhs/8HKOeg1d7QurQOhuV00wE0MPFERIj/hA4a85Qd2FA2tNrgUWMo8GW8GBw9WvSsBrAWf0Fhw2Mq6ze7QzZpzc0iSjSPWEa0N+kASsFhk+ZVvEvSz4XXsHOQKCvcVbhbMnjkLy18KM0mKWFIo6L3sZPtryvLU9pasZHw8xweiWyDBSQXl5cb4+bLkXnewjWedI9QYI4VlMd0U2gNcvf4N32KqzC/tqrqItz8nl3xpq1Iekz5ktnJP3HhpfpewvZGSrZ+uoUunYHrxe5jiRciL77U52lG/JfDsRoyI0s7HEHNETYBikA6x2WWDbTIHmsSjYpDPPvD2yCNRvpQH2nMKA1UqxND6aPx3GukRa59j6JQB7x91UVv/CcjKV039W3rbPbaAPHjoCkhlk1A8mTnJNz4NZ6euRe280Rcf5EGNOKqTx+7Fo4o0/tDcYuwHTtFBrye2acwEAvLPCdbbkgz0b1oUZF7Hf8Z6Dv2sa6o14f42NUlUu9Gh6VwNIZsaKR5uZbgvBPzmCpFQAai2H18JnzYqI7gqo9M9/uuiSDXbAvy2Fdha7R8q3MV3TXAOt+zL3Z3MM+VSU21kGvVg+rr1SpT0AJjrOUGaGPrBeDCHQ4SPQTP51avHzgTAxjimRZ/F3/p24FPbp5MG/JPT/lx+Rih6ZvqJ8gMbg/40wfGUtA4U4vs6PP8W0rqOyCVZ1XnGl2lODbApHPR7ONyBr/dNOjsgHm6k2SNwpYRU/9TW873JFDaEYYTyF3D7+34q9UgsgD2RbaGro12jUcuCf4516ljoS8R73ZV89O5qvVzRCxCcrtT0xvufXig460NviI7pJ9UqdpE0gSasHy7x4JyBZ0q8boZLLMERt8oMTczHmViMB3brzR9emVOFaxf8PdQAttLN0F5YgS2IxVuBnlQvUZY+lP6M1VI355Pbk2oOQRnXi7ekFpsxEJZZw/qE+JOw7Gwvcur/SzoOJDwLyNbH+l0EVf8sRcqjyZEjfWBg1I+i0BEwtN1KGgSu4ny49pnjoQCCLokp7Tb8N7TNoZmXiuFgS34Ug69leJMLolHE1t/tOUR+5moTc144J3nn/2wKyhe6M/bMVBqw8oBB54bJCe9rnB4vYDRsLLYl8UvTrrXnQwOvdCBtKsHo/HiY6n/VdZeNV2q5qAXvEuoLz7AenG0U5Av7AQj3brMyW/bV8s9JkIXtZInlJxFEtRcLRp5Q70waf36Wsc4qb6WARXZzaphr+62riC4K9tTRZP3NQp3GXgUf+ULqxBMXEl3zOBu+7Lu+NaTJzNyIJddujVUxH7cKgNI7NLH+EDmRRl6GttO/Kbseji98CT8uDPH35QLIZ6OE2dRLpl9rJ4dAIlStEj366v7kqn6uIFAKLH6OEgZssPtDjHuatPr6KsJoGsY4dQeuiCQvgj7ZZb79nmFbZm1qUt9R+ffzPdCqZiL2ktEtko5s8ACSdJ7TNzEAkXLjUzJqoQA01sIlqoy5s5f/ZYCPOAyiPfiYUnLsSd7pQEWViyauaMLP+eU+0Ic8b8tF2+XLCNkRUK+ZrTht8Hj69qB0cL5D87MWMgjCj5uSecFJcYU0707yLXgNTeIGojWmvJxp6hp5xP/KfdUP7BPhE4apS8Bl9NozUaYrHJysP7cjL+nX8Au2OWhPb+mbtAf0u5VoiIrONBDpdbnZhLwd9vVF/QG7md6pJmynuXewxcpj9VcS0TO4hsbR7zyN9pJosDWJ1bpkLGfGuUs9mtc="}
4 changes: 2 additions & 2 deletions automation/app-store-discord/scripts/preview.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { addDays, formatReport } from '../src/reports.mjs';

const now = new Date('2026-11-18T01:17:00Z');
const days = {};
for (let day = '2026-11-09'; day <= '2026-11-15'; day = addDays(day, 1)) {
for (let day = '2026-11-01'; day <= '2026-11-16'; day = addDays(day, 1)) {
days[day] = { count: 3, processingDate: addDays(day, 2) };
}
console.log('예시 데이터입니다. 실제 루티 통계가 아니며 Discord에 전송하지 않습니다.\n');
console.log(formatReport({ days, syncedAt: now.toISOString() }, 'last_week', now));
console.log(formatReport({ startDate: '2026-11-01', days, syncedAt: now.toISOString() }, 'last_week', now));
Loading
Loading