開発ログ#043 自前Page Break, PDF出力機能をDeploy。ページサイズ対応と長いワークシートの段階生成を改善
前回は、解答用紙の動的な描画完了を検知し、Cloud Run + PuppeteerでPDFとして出力するところまで実装した。
今回は、そのPDF出力機能を実運用へ近づけるために、ファイル管理、ダウンロード時のUI、ページサイズへの対応を整理した。
さらに、長いワークシートをAIに生成させたことで新たに見つかった、複数のSection Headingが同時に作られる問題も修正した。
結論から書くと、一連の変更を無事Deployし、本番環境でもワークシートと解答用紙のPDF生成、保存、自動ダウンロードまで確認できた。
ワークシートと解答用紙のPDFを分けて管理
これまでは、ワークシートと解答用紙で同じPDF保存先を利用していた。
しかし、実際の運用では、
ワークシートだけを配布する
解答用紙だけを確認する
両方を別々に出力する
という使い方が考えられる。
そこで、ワークシートのデータにそれぞれ専用のPDF保存先を設け、個別に管理する構成へ変更した。
PDFボタンを押したときには、現在の表示モードをもとに出力対象を記録する。
PDF生成
↓
種類に対応する保存先を更新
↓
フロント側が完了を検知
↓
対応するPDFをダウンロード
という流れである。
これにより、ワークシートPDFを生成したあとに解答用紙PDFを生成しても、お互いのファイルを上書きせずに管理できるようになった。
古いPDFについては、新しいファイルの保存に成功してから削除する。生成に失敗した場合でも、直前のファイルが失われない順序を維持している。
ダウンロードするファイル名を整理
生成されたPDFがすべて同じような名前では、ダウンロード後に内容を見分けにくい。
そこで、ワークシートに保存しているファイル名を基準に、
worksheet
answer sheet
の種類が分かる名前を付けるようにした。
模範解答や配点の表示状態まで、すべてファイル名へ含める案も検討した。
しかし、条件を増やしすぎると名前が長くなり、かえって扱いにくくなる。そのため、まずはワークシートと解答用紙の違いを明確にすることを優先した。
ファイル名は情報を完全に表現するものではなく、一覧で見たときに内容を判別できる程度が使いやすいと判断した。
PDF生成中のUIを改善
Cloud Run + PuppeteerによるPDF生成は、通常でも十数秒ほどかかることがある。
特にCloud Runのインスタンスが起動していない場合は、最初の生成に追加の待ち時間が発生する。
すでにプログレスバーは実装していたが、進捗だけでは「何のPDFを生成しているのか」が分かりにくかった。
そこでPDF生成中のFloating Groupに、
PDFを準備していること
出力対象がワークシートか解答用紙か
対象となるワークシート名
処理中であることを示すプログレスバー
を表示するようにした。
プログレスバーは実際の処理率を取得しているものではない。一定の範囲までは少しずつ進み、PDF生成完了時に100%になる疑似的な進捗表示である。
正確な割合ではなくても、画面が停止しているのではなく処理が続いていると伝えられるため、待ち時間の体感を改善できた。
解答用紙でページサイズが反映されない問題
次に確認したのが、解答用紙PDFのページサイズだった。
A4では正常に見えてもLetterでは解答欄が重なり、逆にLetterを調整するとA4で同様の崩れが発生することがあった。
調査すると、ページサイズ自体は切り替わっていたものの、以下の設定が完全には同期していなかった。
エディタ上のページサイズ
解答用紙の表示領域
Page Break計算に使うサイズ
PDF用cloneのページサイズ
Puppeteerの出力サイズ
つまり、PDFだけが間違っていたのではなく、各処理が参照するレイアウト情報にずれがあった。
解答用紙専用の余白を設定
解答用紙では、ワークシートと同じ大きな余白を使う必要はない。
解答内容を一覧しやすくし、用紙を効率よく使うため、余白は次の値へ統一した。
上:64px
下:48px
左右:48px
上部にはタイトルや氏名欄があるため、上だけ少し広くしている。
解答用紙ではこの余白を固定し、ユーザーが変更する設定にはしていない。選択肢を増やすよりも、どのページサイズでも安定したレイアウトになることを優先した。
ページ設定処理を共通化
これまでは、表示モードの切り替えやページ読み込み時に、個別のJavaScriptからページサイズと余白を渡していた。
そのため、処理を追加するたびに同じ設定を書く必要があり、一部のフローで値を渡し忘れる可能性があった。
そこで、BubbleのCustom Eventとして、
ワークシート用のページ設定
解答用紙用のページ設定
解答用紙のReady状態のリセット
を分けて管理する構成に変更した。
ワークシート表示時は、ユーザーが選択したページサイズと余白を適用する。
解答用紙表示時は、選択されたページサイズと、解答用紙専用の固定余白を適用する。
通常のエディタ操作だけでなく、PuppeteerがPDF生成用URLへアクセスした場合も、同じCustom Eventを実行するようにした。
これにより、どのフローから表示しても同じレイアウト設定を利用できるようになった。
Puppeteerの画面幅でレイアウトが変化
ページサイズと余白を揃えても、PDF上で解答欄が横につぶれる場合があった。
デバッグモードでPDF用cloneを表示すると、その時点ですでに崩れているケースが確認できた。
さらに調べると、Puppeteerのブラウザ表示領域が狭く、Bubble側でレスポンシブレイアウトが適用されていた。
解答用紙は、空いている横幅に複数の解答Objectを並べる構成になっている。そのため、ブラウザ幅が変わるとObjectの並び方も変化する。
つまり、
ページサイズ
↓
Bubbleのレスポンシブ計算
↓
解答Objectの横並び
↓
PDF用clone
という順序で、最初の表示状態がPDFへ引き継がれていた。
そこでPuppeteerの表示領域をPC向けの幅へ調整した。
これによりLetterで発生していた崩れは改善した。その後、A4でも別の設定漏れが見つかったが、ページサイズ変更時に解答用紙用ではなくワークシート用の設定を呼び出していたことが原因だった。
フローを修正し、A4とLetterの両方でレイアウトを確認した。
解答用紙にはまだ不安定な部分が残る
今回の修正後、本番環境で複数回PDFを生成したところ、ほとんどは正常に出力された。
ただし、解答用紙の横並びがまれにつぶれる現象は完全には解消していない。
解答用紙は、Bubbleのレスポンシブな配置結果を読み取り、PDF用のページへ再配置している。描画やサイズ計算のタイミングによっては、異なる状態を取得してしまう可能性がある。
今回は利用できる品質には到達したと判断し、これ以上の変更はいったん保留にした。
将来的には、ワークシートと同じように、最初から固定されたObject配置を基準としてPDF用ページを構築する方式へ統一したい。
長いワークシート生成で見つかった問題
PDFの動作確認用として、AIに4〜5ページ程度の長いワークシートを依頼した。
その結果、1回の生成で複数のSection Headingが作られ、すべてのセクション番号が「1」になる問題が発生した。
現在のSheetoは、
ユーザーが依頼
↓
1つのセクションを生成
↓
内容を確認
↓
次のセクションを追加
という段階的な作成を前提としている。
しかし、AIへの指示では、1回の応答に含められるSection Headingの数を明確に制限していなかった。
そのため「4〜5ページのワークシートを作成して」と依頼すると、AIは複数のセクションをまとめて生成しようとしていた。
これはAIの生成ミスというより、Sheeto側のデータ設計とAIへの指示が一致していなかったことが原因だった。
Section Headingを1つに制限
現在の構成に合わせて、AIへの指示を修正した。
主な変更は次のとおりである。
1回の応答で生成できるSection Headingは1つだけ
Section Headingは必ず最初に配置
同じ応答の中で、2つ目のSection Headingを生成しない
長いワークシートは複数回に分けて作る
未作成の内容は、次に追加できる候補として案内する
これにより、長いワークシートを依頼された場合でも、最初のセクションだけを生成するようになった。
AIは生成後に、
「最初のセクションを作成しました。次に語彙練習や記述問題を追加できます」
という形で案内する。
ユーザーは生成された内容を確認しながら、必要なセクションを順番に追加できる。
問題数も少し調整
これまでの指示では、通常の練習用セクションで合計8問を生成する設定になっていた。
しかし、セクション単位で作成する現在の設計では、毎回8問生成すると少し長く感じる場合がある。
そこで、問題数の目安を次のように調整した。
通常のセクション:4〜6問
長めの読解セクション:4〜5問
ユーザーが十分な練習量を求めた場合:6〜8問
また、問題数にはFill in the Blank、Multiple Choice、Free Responseを含め、Section Headingや説明用Textは含めないことも明確にした。
これにより、1つのセクションが過度に長くならず、複数回に分けてワークシート全体を構成しやすくなった。
今回実現できたこと
今回の開発では、以下を実装・整理した。
ワークシートPDFと解答用紙PDFの保存先を分離
出力対象に応じた自動ダウンロード
PDFファイル名の整理
PDF生成中に対象名を表示
A4とLetterのページサイズ対応
解答用紙専用の固定余白
ページ設定処理のCustom Event化
Puppeteerの表示領域調整
通常画面とPDF生成画面でページ設定を共通化
Section Headingの複数生成を防止
長いワークシートの段階生成
セクションごとの問題数を調整
一連の変更を本番環境へDeploy
今後について
今回、ワークシートと解答用紙のPDF出力を含む一連の変更を無事Deployした。
本番環境で複数回テストした結果、PDFの生成、保存、自動ダウンロードまで、全体としては問題なく利用できている。
今後は、
解答用紙のページ構築をワークシート方式へ近づける
開発中のCloud Runと本番用Cloud Runを分離する
PDF生成エラー時の案内を改善する
セクションを順番に提案するUIを検討する
さまざまな教材パターンで出力を検証する
といった改善を進めたい。
今回は、PDFの見た目だけでなく、ファイル管理、待ち時間のUI、ページ設定、AIによる教材生成の単位まで見直すことになった。
PDF出力機能を本番へ反映できたことに加え、Sheetoが長いワークシートをどのように組み立てるべきかも、より明確になった一日だった。