フィードバックの投稿を組織メールで通知 #146

keita-yasuda · 2024-04-12T09:05:11Z

Issues：101

・リソースコメント投稿・利活用方法投稿・利活用方法コメント投稿時に対象組織のAdminユーザに通知メールを送信
・送信メールのテンプレートファイルを独自に定義

Sheile · 2024-04-15T10:01:53Z

ブランチの元コミット

後述するテストの問題はありますが、PRを切るときは対象ブランチの最新から切るべきです。
4月9日にmainブランチが更新されているため、mainブランチを最新化した上でrebaseをお願いします。

ユニットテスト

mainブランチを最新化するとckan 2.10への対応が含まれるため、ユニットテストが動かなくなっているようです。
今回の修正とは関係ないですが、これは早めに直しておきたいですね。

それはそれとして、今回対応した箇所でもユニットテストが落ちているので、対応しておきたいです。
（修正箇所などは別途コメントします）
https://github.com/c-3lab/ckanext-feedback/actions/runs/8659812951/job/23746449259?pr=146#step:10:130

ckanext/feedback/controllers/resource.py

ckanext/feedback/controllers/utilization.py

ckanext/feedback/templates/email_notification/email_template.text

ckanext/feedback/services/common/send_mail.py

ckanext/feedback/templates/email_notification/email_template.text

ckanext/feedback/controllers/utilization.py

ckanext/feedback/services/common/send_mail.py

docs/ja/email_notification.md

ckanext/feedback/controllers/resource.py

ckanext/feedback/services/common/send_mail.py

ryo-ma · 2024-05-01T00:00:07Z

docs/ja/email_notification.md

+        * Utilizationの新規投稿通知に使用する件名
+
+            ```ini
+            ckan.feedback.notice.email.subject_util = Post a Utilization


utilだとutilityと捉えられるので省略せずにutilizationでお願いしたいです。
79行目も同様

ryo-ma · 2024-05-01T00:01:07Z

docs/ja/email_notification.md

+    CKAN_SMTP_STARTTLS=True
+    CKAN_SMTP_USER=user
+    CKAN_SMTP_PASSWORD=pass
+    ```


SMTPの設定はiniからでも可能である旨を記載ください。

ryo-ma · 2024-05-01T00:03:38Z

docs/ja/email_notification.md

+
+    ```bash
+    ckan -c ckan.ini jobs worker
+    ```


ローカルのdokcer-composeで実行する際の手順も欲しいです。必要があればdocker-composeに追記をお願いします。

keita-yasuda · 2024-05-23T01:04:00Z

development/feedback_setup.sh

@@ -3,6 +3,10 @@ docker exec -it ckan-docker-ckan-dev-1 bash -c "chmod 777 /srv/app/src/ckan/ckan
 # pip install ckanext-feedback
 docker exec -it ckan-docker-ckan-dev-1 bash -c "pip install /srv/app/src_extensions/ckanext-feedback"
 # add ckanext-feedback to ckan.plugins
-docker exec -it ckan-docker-ckan-dev-1 bash -c "sed -i '168s/$/ feedback/' /srv/app/ckan.ini"
+docker exec -it ckan-docker-ckan-dev-1 bash -c "sed -i 's/\(ckan\.plugins = .*\)/\1 feedback/' /srv/app/ckan.ini"


NOTE: ckan.pluginsを行数ではなく正規表現で指定する方法に修正。

keita-yasuda · 2024-05-23T01:18:33Z

development/docker-compose.yml

+      context:  ckan/
+      dockerfile: Dockerfile.dev
+      args:
+        - TZ=${TZ}
+    env_file:
+      - .env
+    depends_on:
+      db:
+        condition: service_healthy
+      solr:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    volumes:
+      - ../../../:/srv/app/src_extensions/ckanext-feedback
+      - /srv/app/src_extensions/ckanext-feedback/development/
+    restart: unless-stopped


NOTE: やりたい事は、ckan-dev: と同じ作りのコンテナでワーカーの起動。
参考元：https://github.com/ckan/ckan-docker/blob/cc095f1323a6dc81d49ae76c5c24bc1d9a1c0172/docker-compose.dev.yml#L11-L30

dockerfile:はこのファイルのckan-dev:が使用するファイルを指定している。

ワーカーへのアクセスを必要とするモジュールが存在しないので、参考元には存在するports:の定義はこのコンテナでは不要。

volumes:はこのファイルのckan-dev:の設定を踏襲。

keita-yasuda · 2024-05-23T01:29:27Z

development/feedback_setup.sh

+docker exec -it ckan-docker-ckan-dev-1 bash -c "ckan feedback init"
+# Copy ckan.datapusher.api_token setting value from ckan-dev to ckan-worker in ckan.ini
+docker exec ckan-docker-ckan-dev-1 sh -c "grep '^ckan.datapusher.api_token' /srv/app/ckan.ini" | xargs -I {} docker exec ckan-docker-ckan-worker-1 sh -c "sed -i '/^\[app:main\]/a {}' /srv/app/ckan.ini"


NOTE: ワーカーがckan-devと連携する為には、ckan-devコンテナのckan.iniのckan.datapusher.api_tokenの設定値を、ワーカーコンテナ内のckan.iniに追記する必要があったため、該当項目の設定のコピーを行っている。

ryo-ma · 2024-05-23T03:23:55Z

コンフリクトをしているのでリベースの対応もお願いします。

Enable configuration of notification settings from ckan.ini and feedback_config.json. Preferences in feedback_config.json take precedence. Settings include: - Enabling/disabling the feature - Directory for storing email templates - Email template names - Subject lines

* Accept email template, subject, and content as arguments * Define available templates and subject in the configuration file

* It is necessary to start a worker inside the container using 'ckan -c ckan.ini jobs worker'.

keita-yasuda force-pushed the feature/notice-function branch 2 times, most recently from 4ea720e to eafbcb5 Compare April 12, 2024 09:16