feat: add verification function to the notification settings for the mailbox #5464

LIlGG · 2024-03-07T07:43:52Z

What type of PR is this?

/kind feature
/area ui
/area core
/milestone 2.14.x

What this PR does / why we need it:

为邮件的 通知设置 添加验证的功能。

同时为 formkit 增加了一个新的组件 (verificationForm)，用于支持验证，它的定义方式如下：

- $formkit: verificationForm
  action: "http://localhost:8090/verify/user"
  label: 用户验证
  children:
    - $formkit: text
      label: "用户名"
      name: username
      validation: required
    - $formkit: password
      label: "密码"
      name: password
      validation: required

verificationForm 支持 action 属性，当前端数据验证通过时，会将其下所包含的子节点数据发送至 action 所代表的接口上。
按上述示例，则验证数据会提交至 http://localhost:8090/verify/user 进行验证。验证的数据为 {name: xxx, password: xxx}

需要注意的是，verificationForm 只用于包装需要验证的数据，不会破坏原始数据的格式。因此上述数据在提交保存后仍旧为 {name: xxx, password: xxx} 而不会变成 {verificationForm1: {name: xxx, password: xxx}}

How to test it?

测试邮箱中的 通知设置 新增的验证按钮是否可以正常验证邮箱。
查看数据是否正常回显

Which issue(s) this PR fixes:

Fixes #4714

Does this PR introduce a user-facing change?

在邮件通知设置中增加了发送测试的功能。

ruibaby · 2024-03-07T07:49:54Z

hi @longjuan ，有时间可以尝试一下基于此 PR 为 S3 插件的配置表单添加一个验证。

codecov · 2024-03-07T07:50:22Z

Codecov Report

Attention: Patch coverage is 20.48193% with 66 lines in your changes are missing coverage. Please review.

Project coverage is 56.49%. Comparing base (5fdf6c0) to head (f4a0dca).
Report is 81 commits behind head on main.

Files	Patch %	Lines
...n/halo/app/notification/EmailSenderHelperImpl.java	7.14%	26 Missing ⚠️
...cation/endpoint/EmailConfigValidationEndpoint.java	35.89%	25 Missing ⚠️
...a/run/halo/app/notification/EmailSenderHelper.java	0.00%	9 Missing ⚠️
.../java/run/halo/app/notification/EmailNotifier.java	14.28%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5464      +/-   ##
============================================
- Coverage     56.91%   56.49%   -0.43%     
- Complexity     3319     3320       +1     
============================================
  Files           587      595       +8     
  Lines         18968    19249     +281     
  Branches       1401     1357      -44     
============================================
+ Hits          10795    10874      +79     
- Misses         7594     7813     +219     
+ Partials        579      562      -17

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ruibaby · 2024-03-07T07:51:23Z

hi @LIlGG，在合并此 PR 前，建议同时提交对应文档的修改 PR。

https://docs.halo.run/developer-guide/form-schema

LIlGG · 2024-03-07T08:06:40Z

hi, @guqing ，目前还缺少验证邮箱是否联通的后端接口，有时间的话帮忙补充一下。

guqing · 2024-03-07T09:47:19Z

hi, @guqing ，目前还缺少验证邮箱是否联通的后端接口，有时间的话帮忙补充一下。

已补充

longjuan · 2024-03-08T14:51:42Z

有时间可以尝试一下基于此 PR 为 S3 插件的配置表单添加一个验证。

longjuan/halo-plugin-s3os@e9bba38
https://github.com/longjuan/halo-plugin-s3os/tree/feat/validation-config
发现一个问题，保存后的配置再次编辑时会空白，创建配置时请求data的displayName为空

application/src/main/resources/extensions/role-template-notification.yaml

LIlGG · 2024-03-11T08:12:11Z

发现一个问题，保存后的配置再次编辑时会空白，创建配置时请求data的displayName为空

已进行修复，你可以强制拉取一下最新的代码再进行测试。
另外希望能够测试一下是否能够兼容旧数据，例如先在旧版本上填写配置，然后在适配 verifyForm 之后看看回显是否正常。

longjuan · 2024-03-11T08:28:26Z

有个建议：
希望在验证按钮附近提供一个未验证或通过的图标/tag，顶部弹窗有时候注意不到。
当验证后配置又有改变就重新置为未验证。

longjuan · 2024-03-11T12:47:07Z

s3 1.8+halo 2.13配置升级到s3 1.8+本pr：无问题
s3 1.8+halo 2.13配置升级到s3测试分支+本pr：无问题

但s3测试分支+本pr 新建策略并编辑会出现名称闪现后消失的问题（旧版本保存的配置没问题）

2024-03-11_20-39-25.mp4

…ame level

LIlGG · 2024-03-12T08:47:11Z

希望在验证按钮附近提供一个未验证或通过的图标/tag，顶部弹窗有时候注意不到。
当验证后配置又有改变就重新置为未验证。

目前验证按钮是无状态的。另外对于已经保存的内容，再次打开是无法确定是否经过了验证。

不过可以考虑单轮配置阶段增加图标，例如在验证完成之后，加一个验证通过的图标。在修改配置之后，恢复初始状态。

ui/src/formkit/inputs/verify-form/index.ts

JohnNiang

IMO，支持验证表单和邮箱验证测试应该是两个功能，如果能够拆分一下提交会不会更好呢？

LIlGG · 2024-03-20T11:26:33Z

IMO，支持验证表单和邮箱验证测试应该是两个功能，如果能够拆分一下提交会不会更好呢？

我认为虽然是可以进行拆分，但此 PR 主要还是用于添加邮箱验证测试这个业务功能，而验证表单是为了满足此业务而产生的组件。例如在写文章列表的同时抽象出一个用于展示列表的公共组件，本质上是同一件事情。

…mkit-verify-button

ruibaby

/lgtm

…-button

sonarcloud · 2024-03-25T04:41:04Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.3% Duplication on New Code

See analysis details on SonarCloud

guqing

/lgtm

ruibaby

/lgtm

f2c-ci-robot · 2024-03-26T07:58:23Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ruibaby

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ruibaby]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

为 FormKit Schema 文档添加 verifyForm 的内容。相关改动查看 halo-dev/halo#5464 /kind documentation ```release-note None ```

f2c-ci-robot bot added this to the 2.14.x milestone Mar 7, 2024

f2c-ci-robot bot added area/ui Issues or PRs related to the Halo UI area/core Issues or PRs related to the Halo Core labels Mar 7, 2024

f2c-ci-robot bot requested review from Aanko and ruibaby March 7, 2024 07:43

guqing force-pushed the feat/formkit-verify-button branch 2 times, most recently from 22e0c63 to 0556d41 Compare March 7, 2024 09:46

longjuan reviewed Mar 8, 2024

View reviewed changes

application/src/main/resources/extensions/role-template-notification.yaml Outdated Show resolved Hide resolved

guqing force-pushed the feat/formkit-verify-button branch from 4e8775a to d154ba6 Compare March 11, 2024 07:37

LIlGG and others added 4 commits March 11, 2024 15:59

feat: add support for data validation to formkit

5dc73d1

feat: add an API for validate email config

6418412

fix: role template config

9c5d68d

solving the problem of data echo

0044d34

guqing force-pushed the feat/formkit-verify-button branch from a2949f0 to 0044d34 Compare March 11, 2024 08:00

update typescript check

3426082

LIlGG force-pushed the feat/formkit-verify-button branch from c936f19 to 3426082 Compare March 11, 2024 08:18

fix the issue where newly created content does not save data of the s…

0d4a998

…ame level

refactor: user email getter

5ed45ff

guqing requested a review from JohnNiang March 18, 2024 04:59

LIlGG and others added 2 commits March 18, 2024 17:27

update verification form style

676ffe1

Merge branch 'main' into feat/formkit-verify-button

919ad2d

ruibaby requested changes Mar 20, 2024

View reviewed changes

ui/src/formkit/inputs/verify-form/index.ts Outdated Show resolved Hide resolved

JohnNiang reviewed Mar 20, 2024

View reviewed changes

LIlGG added 2 commits March 21, 2024 12:36

Merge branch 'main' of https://github.com/halo-dev/halo into feat/for…

aabcabf

…mkit-verify-button

rename actions to action

301f433

ruibaby reviewed Mar 21, 2024

View reviewed changes

f2c-ci-robot bot assigned ruibaby Mar 21, 2024

f2c-ci-robot bot added lgtm Indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Mar 21, 2024

Merge remote-tracking branch 'upstream/main' into feat/formkit-verify…

060f39e

…-button

f2c-ci-robot bot removed lgtm Indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Mar 25, 2024

Merge branch 'main' into feat/formkit-verify-button

f4a0dca

guqing reviewed Mar 25, 2024

View reviewed changes

f2c-ci-robot bot assigned guqing Mar 25, 2024

f2c-ci-robot bot added the lgtm Indicates that a PR is ready to be merged. label Mar 25, 2024

LIlGG requested a review from ruibaby March 25, 2024 07:39

ruibaby approved these changes Mar 26, 2024

View reviewed changes

f2c-ci-robot bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 26, 2024

f2c-ci-robot bot merged commit a281015 into halo-dev:main Mar 26, 2024
8 checks passed

LIlGG deleted the feat/formkit-verify-button branch March 26, 2024 08:10

ruibaby modified the milestones: 2.14.x, 2.14.0 Mar 26, 2024

f2c-ci-robot bot pushed a commit to halo-dev/docs that referenced this pull request Mar 27, 2024

docs: add formkit verfiyForm documentation (#327)

64b30fa

为 FormKit Schema 文档添加 verifyForm 的内容。相关改动查看 halo-dev/halo#5464 /kind documentation ```release-note None ```

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add verification function to the notification settings for the mailbox #5464

feat: add verification function to the notification settings for the mailbox #5464

LIlGG commented Mar 7, 2024 •

edited

ruibaby commented Mar 7, 2024 •

edited

codecov bot commented Mar 7, 2024 •

edited

ruibaby commented Mar 7, 2024

LIlGG commented Mar 7, 2024

guqing commented Mar 7, 2024

longjuan commented Mar 8, 2024 •

edited

LIlGG commented Mar 11, 2024

longjuan commented Mar 11, 2024

longjuan commented Mar 11, 2024

LIlGG commented Mar 12, 2024

JohnNiang left a comment

LIlGG commented Mar 20, 2024 •

edited

ruibaby left a comment

sonarcloud bot commented Mar 25, 2024

guqing left a comment

ruibaby left a comment

f2c-ci-robot bot commented Mar 26, 2024

feat: add verification function to the notification settings for the mailbox #5464

feat: add verification function to the notification settings for the mailbox #5464

Conversation

LIlGG commented Mar 7, 2024 • edited

What type of PR is this?

What this PR does / why we need it:

How to test it?

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?

ruibaby commented Mar 7, 2024 • edited

codecov bot commented Mar 7, 2024 • edited

Codecov Report

ruibaby commented Mar 7, 2024

LIlGG commented Mar 7, 2024

guqing commented Mar 7, 2024

longjuan commented Mar 8, 2024 • edited

LIlGG commented Mar 11, 2024

longjuan commented Mar 11, 2024

longjuan commented Mar 11, 2024

LIlGG commented Mar 12, 2024

JohnNiang left a comment

Choose a reason for hiding this comment

LIlGG commented Mar 20, 2024 • edited

ruibaby left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Mar 25, 2024

Quality Gate passed

guqing left a comment

Choose a reason for hiding this comment

ruibaby left a comment

Choose a reason for hiding this comment

f2c-ci-robot bot commented Mar 26, 2024

LIlGG commented Mar 7, 2024 •

edited

ruibaby commented Mar 7, 2024 •

edited

codecov bot commented Mar 7, 2024 •

edited

longjuan commented Mar 8, 2024 •

edited

LIlGG commented Mar 20, 2024 •

edited