add pdf-converter app #9279

arafubeatbox · 2024-10-20T08:08:15Z

実装内容

pdf に変換する pdf-converter アプリを apps/pdf-converter 配下に実装
- ts.ed + openAPI で実装
- pdf-converter ビルド時に以下を使い、クライアントコードを自動生成
  - https://github.com/tsedio/tsed-cli/tree/master/packages/cli-generate-swagger (decorator の内容から openapi spec 生成)
  - https://orval.dev/guides/basics (openapi spec からクライアントコード生成。一番シンプルな設定を利用。)

仕様書

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

task

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

備考

base branch は feat/page-bulk-export ではなく、feat/135772-pdf-page-bulk-export
以下の PR で feat/135772-pdf-page-bulk-export は完成する想定
1. pdf-converter のアプリを実装 (この PR)
2. pdf-converter の devcontainer を設定 (Feat/135772 155547 pdf converter tsed devcontainer #9280)
3. GROWI で PDF 形式の bulk export を有効にする (enable pdf bulk export #9283)
pdf-converter のデプロイ設定は https://redmine.weseek.co.jp/issues/155548 で行う想定

changeset-bot · 2024-10-20T08:08:19Z

⚠️ No Changeset found

Latest commit: dadcf07

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

arafubeatbox · 2024-10-20T09:43:36Z

github がバグって差分が正しく反映されていなかったので、PR の open/close を繰り返していましたm(_ _)m

arafubeatbox · 2024-10-20T10:01:37Z

apps/pdf-converter/.gitignore

@@ -0,0 +1,2 @@
+/dist
+/specs/**/*.json


specs に openapi spec を出力する設定にしていますが、
https://github.com/tsedio/tsed-cli/tree/master/packages/cli-generate-swagger
に yaml だけ出力するオプションがありませんでした (コードも確認しました

arafubeatbox · 2024-10-20T10:02:22Z

apps/pdf-converter/package.json

+    "dev:pdf-converter": "nodemon --watch \"src/**/*.ts\" --ignore \"node_modules/**/*\" --exec ts-node -r \"dotenv-flow/config\" src/index.ts",
+    "lint": "yarn eslint **/*.{js,ts}",
+    "gen:client-code": "tsed run generate-swagger --output ./specs && orval",
+    "build": "yarn gen:client-code && tsc -p tsconfig.build.json"


build 時に gen:client-code でクライアントコードも自動生成しています。

arafubeatbox · 2024-10-20T10:14:10Z

apps/pdf-converter/.eslintrc.js

+  extends: '../../.eslintrc.js',
+  rules: {
+    'no-useless-constructor': 'off',
+    '@typescript-eslint/consistent-type-imports': 'off',


ts.ed で DI している場所で @typescript-eslint/consistent-type-imports がオンになっていると、DI 対象の import が type のみの import に強要されますが、その結果 DI された対象が何であっても実体のない [Function: anonymous] となってしまいます。
例えば DI された hoge に対して hogeMethod を実行すると TypeError: hoge.hogeMethod is not a function
となってしまいます。

多分 ts.ed の DI では、DI 対象の実装本体を import する必要があるっぽいです。

yuki-takei · 2024-10-23T19:11:48Z

apps/pdf-converter/docker/Dockerfile

+
+EXPOSE 3010
+
+ENTRYPOINT ["/usr/bin/tini", "-e", "143", "--"]


tini は不要
https://tips.weseek.co.jp/6151b1832b337100519281e7

terminus と連携して解決するのが望ましい
https://tsed.io/tutorials/terminus.html

後続ストーリーで対応をお願いしたい

ストーリー作成しました。 https://redmine.weseek.co.jp/issues/156179

yuki-takei · 2024-10-23T19:12:34Z

apps/pdf-converter/package.json

この app は type: module にできないだろうか？
Ts.ED が未対応というケースもあるだろうが調査をしてほしい(後続ストーリーでOK)

https://redmine.weseek.co.jp/issues/156177 ストーリー作成しました

yuki-takei · 2024-10-23T19:19:06Z

apps/pdf-converter/specs/v3/docs/swagger.yaml

このファイルは .gitignore したらだめなの？

apps/pdf-converter/src/client-library の生成元の schema がわかると良いかなと思いましたが、確かにあまり気にすることは無さそうですね。むしろ schema が手動修正 -> commit されるリスクの方が大きそうです。
ignore しますm(_ _)m

yuki-takei · 2024-10-23T19:24:26Z

apps/pdf-converter/package.json

+  "private": true,
+  "scripts": {
+    "dev:pdf-converter": "nodemon --watch \"src/**/*.ts\" --ignore \"node_modules/**/*\" --exec ts-node -r \"dotenv-flow/config\" src/index.ts",
+    "lint": "yarn eslint **/*.{js,ts}",


tsconfig を細かくチェックはしていないのだけれど、build での tsc は typecheck はせずにスピードを出すのが望ましい。
代わりに lint で typecheck のための tsc を走らせる。
後続ストーリーでよい。

https://redmine.weseek.co.jp/issues/156178 ストーリー作成しました。

arafubeatbox added 3 commits October 20, 2024 16:42

add pdf-converter app

e1f8e1f

add newlines

7b6135f

change pdf-converter port to 3010

5d0d7ab

remove @tsed/cli-core

38ef835

arafubeatbox changed the base branch from feat/page-bulk-export to feat/135772-pdf-page-bulk-export October 20, 2024 09:30

arafubeatbox closed this Oct 20, 2024

arafubeatbox deleted the feat/135772-153347-pdf-converter-app-tsed branch October 20, 2024 09:37

arafubeatbox restored the feat/135772-153347-pdf-converter-app-tsed branch October 20, 2024 09:37

arafubeatbox deleted the feat/135772-153347-pdf-converter-app-tsed branch October 20, 2024 09:38

arafubeatbox restored the feat/135772-153347-pdf-converter-app-tsed branch October 20, 2024 09:39

arafubeatbox reopened this Oct 20, 2024

arafubeatbox changed the base branch from feat/135772-pdf-page-bulk-export to feat/page-bulk-export October 20, 2024 09:40

arafubeatbox changed the base branch from feat/page-bulk-export to feat/135772-pdf-page-bulk-export October 20, 2024 09:40

arafubeatbox marked this pull request as ready for review October 20, 2024 09:41

arafubeatbox added 3 commits October 20, 2024 18:52

add openapi spec and client-library for pdf-converter

d0ab9ae

remove json openapi spec

db522ae

ignore json openapi spec

79da525

arafubeatbox commented Oct 20, 2024

View reviewed changes

remove unnecessary comment

12d78c7

arafubeatbox commented Oct 20, 2024

View reviewed changes

yuki-takei requested changes Oct 23, 2024

View reviewed changes

gitignore spec dir for pdf-converter

dadcf07

yuki-takei approved these changes Oct 24, 2024

View reviewed changes

yuki-takei merged commit fa9a711 into feat/135772-pdf-page-bulk-export Oct 24, 2024
4 checks passed

yuki-takei deleted the feat/135772-153347-pdf-converter-app-tsed branch October 24, 2024 07:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add pdf-converter app #9279

add pdf-converter app #9279

arafubeatbox commented Oct 20, 2024 •

edited

Loading

changeset-bot bot commented Oct 20, 2024 •

edited

Loading

arafubeatbox commented Oct 20, 2024

arafubeatbox Oct 20, 2024

arafubeatbox Oct 20, 2024

arafubeatbox Oct 20, 2024 •

edited

Loading

yuki-takei Oct 23, 2024

arafubeatbox Oct 24, 2024

yuki-takei Oct 23, 2024

arafubeatbox Oct 24, 2024

yuki-takei Oct 23, 2024

arafubeatbox Oct 24, 2024

yuki-takei Oct 23, 2024

arafubeatbox Oct 24, 2024

		@@ -0,0 +1,2 @@
		/dist
		/specs/*/.json

add pdf-converter app #9279

add pdf-converter app #9279

Conversation

arafubeatbox commented Oct 20, 2024 • edited Loading

実装内容

仕様書

task

備考

changeset-bot bot commented Oct 20, 2024 • edited Loading

⚠️ No Changeset found

arafubeatbox commented Oct 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arafubeatbox Oct 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arafubeatbox commented Oct 20, 2024 •

edited

Loading

changeset-bot bot commented Oct 20, 2024 •

edited

Loading

arafubeatbox Oct 20, 2024 •

edited

Loading