For full text search please use the '?' prefix. e.g. ? Onboarding

Pdf Generator

Arc42와 C4 model을 참고하여 프로젝트 문서를 작성

Goal

제공되는 웹페이지를 A4 크기의 PDF로 만들어 client에게 제공

Requirements Overview

기존에 PDF 생성에 사용하던 PDFCrowd를 대체할 도구 제작

Quality Goals

  1. PDFCrowd보다 저럼하게 → $276/month 보다 저렴히
  2. PDFCrowd보다 빠르게 PDF 생성 → 20~30초보다 빠르게
  3. PDFCrowd보다 Scalability 좋게 → 동시 생성 가능 개수를 전체 8개보다 많게
  4. 생성된 PDF를 S3 저장하여 서비스하고 그대로 파일을 방치하는 프로세스를 개선하여 인프라·관리 비용을 줄일 것

Stakeholders

NameExpectations
LukeProject, AWS Infra 관리

Constraints

Technical Constraints

ConstraintBackground and / or motivation
Web browser로 다운가능파트너사나 Report 고객에게 PDF를 제공할 때 가장 접근성이 좋다.

Context

C4Context title System Context diagram for PDF download Person(user, "User", "People that need PDF") System_Boundary(WebApp, "Web App") { Container(WebPage, "Web Page", "Report, Portal, .com") Container(PdfGenerator, "PDF Generator", "AWS Lambda, S3") } BiRel(user, WebPage, "1. Request to download PDF ⬇️ / 4. Download PDF file ⬆️") BiRel(WebPage, PdfGenerator, "2. Request API ➡️ / 3. Redirect to PDF file ⬅️") UpdateRelStyle(user, WebPage, $offsetX="-115", $offsetY="-30", $lineColor="blue", $textColor="red") UpdateRelStyle(WebPage, PdfGenerator, $offsetX="-85", $offsetY="45")

User

사용자용도
Report 고객Mybook 다운로드
파트너사Mybook 인쇄
[.com] 고객동의서(미리 생성)

Build, Deployment

github action을 통해 nuxt build.

client code는 S3, cloudfront로 배포, server code는 aws lambda로 배포. (cloudfront는 없어도 될 듯?)

현재 AWS GPJ dev 계정에만 연결되어 있음. 추후 AWS GPK 계정에도 세팅해야 함.

HTML page to PDF render

이 프로젝트에서 생성할 PDF target. 2023년 Q3 현재 back-end에서 제작 중.

추후 front-end에서 담당할 예정

예제 URL
  • Sample URL A
  • Sample URL B

PDF file

S3에 저장되는 결과물. github action을 통해 하루 단위로 삭제. Quality Goals#4

github 공식문서에서 언급하듯이 cron 신뢰도가 좀 떨어지므로 2번 trigger 걸어놓음.
결과는 slack channel로 message 보내게 해뒀으니 체크하여 대응할 수 있도록 함.

Solution Strategy

Quality goalSolution ApproachDetails
$276/month 보다 저렴히AWS Lambda 사용Lambda resource setting
20~30초보다 빠르게 PDF 생성AWS Lambda 사용Lambda resource setting
동시 생성 가능 개수를 전체 8개보다 많게AWS Lambda 사용AWS Lambda를 쓰는 이유
인프라·관리 비용 줄이기Github action cron 사용하루 한 번 S3 dir 삭제

Building Block View

/server/routes/*

Puppeteer로 지정된 Render URL을 PDF로 생성하여 S3에 저장 후 redirect하는 API

/pages/*

FileSaver.js, JSZip를 사용하여 client 단에서 Download를 실행시키는 페이지

Runtime View

Deployment View

GPJ dev 계정

InfrastructureDescription
AWS LambdaLambda Function URL
AWS S3 client 배포용S3 URL
AWS S3 PDF resourcesS3 URL

Decision Log

Client가 아닌 server generator을 쓰는 이유

client에서 생성할 수 있지만, server에서 생성해서 내려주는게 사용자별 browser 호환성 문제 없다.

Client PDF generator tools

AWS Lambda를 쓰는 이유

Scalability 확보를 위해. Quality Goals#3

복수(30개) pdf 생성 & 다운로드 테스트해보니 browser에서 동시 접속 제한만큼 병렬로 생성 됨 (보통 6개)

  • 이전 PDFCrowd는 여러 명이 사용해도 전체 8개 제한이 있지만 Lambda는 그런 제한이 없음

Lambda resource setting

생성에 걸리는 시간 Quality Goals#2 관련

PDFCrowd의 경우 20~30초

메모리에 따라 CPU 할당도 변경.
Sample PDF(6.5초 rendering) 기준, run Puppeteer + Load HTML + save PDF to S3에 걸리는 시간:

할당된 메모리생성에 걸리는 시간
4096MB18초
2048MB21초
1024MB48초

CPU를 더 할당해도, lambda cold start와 API response time은 못 줄임.

가격 Quality Goals#1 충족

2기가 기준으로 sample pdf 하나당 $0.0006993가 소모된다. (memory cpu 가격만 따졌을 때) 1만 건당 7달러.
2022.08~2023.08의 1년에 약 2만 건. $14 vs $3312(PDFCrowd plan $276/month x 12개월)

S3를 써야 하는 이유

lambda에서 직접 다운로드 불가 - 용량 초과(Invocation payload)

하루 한 번 S3 directory 삭제 Quality Goals#4

Github cron issue - 공식 문서에서 schedule time이 부정확하고 누락 가능성도 있다고 언급
-> 새벽에 2번 실행. slack message 확인 후 안됐으면 github에서 직접 실행 가능

github actions나 AWS lambda 시간은 UTC+0 기준.

Download multiple PDF into one zip file

파트너사? 사용자가 하나하나 받기 불편하다고 요청

FileSaver.js, JSZip, JSZipUtils으로 browser 단에서 받도록

References

Generation pdf with headless chrome

찾는 문서마다 chromium binary가 몇 년 지난 구 버전뿐이라 다른 문서에서 설명하는 docker image로 올려야 하나 고민했는데 계속 찾아보니 최신 binary를 발견

참고 URLs

Etc

그 외 참고했던 URLs
Backlinks