Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enable pdf bulk export #9283

Open
wants to merge 19 commits into
base: feat/135772-pdf-page-bulk-export
Choose a base branch
from

Conversation

arafubeatbox
Copy link
Contributor

@arafubeatbox arafubeatbox commented Oct 20, 2024

仕様書

https://dev.growi.org/66ee8495830566b31e02c953#growi

task

https://redmine.weseek.co.jp/issues/153348

備考

  • base branch は feat/page-bulk-export ではなく、feat/135772-pdf-page-bulk-export

Copy link

changeset-bot bot commented Oct 20, 2024

⚠️ No Changeset found

Latest commit: b98f78e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Base automatically changed from feat/135772-155547-pdf-converter-tsed-devcontainer to feat/135772-pdf-page-bulk-export November 11, 2024 13:37
@arafubeatbox arafubeatbox marked this pull request as ready for review November 12, 2024 10:39
.toString();

return htmlString;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remark().use(html) で得られるインスタンスは保持して使い回した方がいいんじゃないかな
どこまで差が出るかはわからないけど

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

対応しました。
インスタンス変数にして全ての job で共通にするのは並列で処理が走ったときバグる可能性があるように思えたので、ジョブごとに stream 開始前に定義して引数として渡す形にしました。

引数の型ですが、remark().use(html) の返り値の type が unified のものですが、

unified.Processor<remark.RemarkOptions>

remark が依存している unified と growi が package.json で指定している unified のバージョンが異なるっぽくて、同様の type を付与するとエラーが生じてしまいます。
そのため引数に type は付与していません。
(バージョンを対応させようとすると、esm only の remark 系のパッケージが必要となり、エラーが生じてしまいます)

}
}, 60 * 1000 * 1);
});
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

このメソッドはレビューしきれてないので引き続き

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

slackbot-proxy を起動しなくても app が使えるように、
pdf-converter もまた app の起動に必須ではないので、dependsOn からは外してほしい。

開発時に開発者がやらないといけないことはマニュアルに書いて周知する。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

こちら pdf-converter の起動ではなく、クライアントコード生成のための build になります。
pdf-converter の起動は無関係であり、これを取り除くと Error: Cannot find module '@growi/pdf-converter/dist/client-library'apps/app/src/features/page-bulk-export/server/service/page-bulk-export/index.ts で生じてしまいます。

それはそれとして、pdf-converter の開発ドキュメントは書こうと思います。
ストーリー作成しました。
https://redmine.weseek.co.jp/issues/157930


return new Promise<void>((resolve, reject) => {
// Request sync job API until the pdf export is done. If pdf export status is updated in growi, send the status to pdf-converter.
const interval = setInterval(async() => {
Copy link
Member

@yuki-takei yuki-takei Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

この setInterval、job の数だけ走るのはあまりよくない気がする。
setInterval よりシステムワイドに node-cron を使うべきではないか?

また、サーバーが再起動した時に job を参照して再開してほしい。

参考:

  • thread-deletion-cron.ts
  • vector-store-file-deletion-cron.ts

実装アイデアメモ

cronJob は2種類あってもいいかも。

  • 1つは処理完了待ちの job で、10秒とか比較的短いインターバルで動いて fail / done へステータスを遷移させる
  • もう1つは上記の処理完了待ち job の start/stop を担当する (2~3分の長めのインターバルでよい)
    • in progress な job が 1 つでもあれば処理完了待ち job を start させる
    • in progress な job が 0 個なら処理完了待ち job を stop させる
    • サーバー再起動時はこれを start しておくことで、数分後には必要があれば処理完了待ち job が start することを期待

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants