refactor: provide API for change plugin motion status synchronously #4745

guqing · 2023-10-18T04:52:41Z

What type of PR is this?

/kind improvement
/area core
/area console

What this PR does / why we need it:

提供允许同步更改插件运行状态的 API

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?

提供允许同步更改插件运行状态的 API

codecov · 2023-10-18T04:56:36Z

Codecov Report

Merging #4745 (754954e) into main (21e975d) will decrease coverage by 0.08%.
The diff coverage is 37.77%.

@@             Coverage Diff              @@
##               main    #4745      +/-   ##
============================================
- Coverage     61.58%   61.50%   -0.08%     
- Complexity     2797     2798       +1     
============================================
  Files           403      403              
  Lines         14725    14770      +45     
  Branches       1023     1028       +5     
============================================
+ Hits           9068     9085      +17     
- Misses         5165     5193      +28     
  Partials        492      492

Files	Coverage Δ
...lo/app/core/extension/endpoint/PluginEndpoint.java	`64.60% <37.77%> (-2.85%)`	⬇️

guqing · 2023-10-18T08:05:35Z

ready for review

ruibaby

/lgtm

@halo-dev/sig-halo

JohnNiang · 2023-10-20T03:26:01Z

application/src/main/java/run/halo/app/core/extension/endpoint/PluginEndpoint.java

+        private ExpectedAction action;
+        private boolean async;
+
+        enum ExpectedAction {


不建议在这里制造一种新概念。整个系统尽量保持一种风格。

没懂保持一种风格指的是保持什么

参数为 boolean 值？

JohnNiang · 2023-10-20T03:36:24Z

application/src/main/java/run/halo/app/core/extension/endpoint/PluginEndpoint.java

@@ -201,6 +203,27 @@ public RouterFunction<ServerResponse> endpoint() {
                    .response(responseBuilder()
                        .implementation(Plugin.class))
            )
+            .PUT("plugins/{name}/motion-status", this::changeMotionStatus,


这里似乎不是一个常规的资源型请求 - PUT resources。

得确认一下分配插件管理权限后是否能正常调用。

可以的，与 PUT plugins/{name}/reload 一样，权限正确

请看 RFC：https://github.com/halo-dev/rfcs/blob/main/identity/002-security.md#%E8%B5%84%E6%BA%90%E5%8A%A8%E8%AF%8D

参考：

PUT /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy

https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#replace-ephemeralcontainers-pod-v1-core
kubernetes 的 api-conventions 中也没有关于 PUT 子资源的描述 https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#verbs-on-resources，但是他们是这么做的

那么对于这种更新部分字段操作的自定义 API 不用 PUT 用什么呢

直接对子资源的某些字段进行 PUT 操作似乎也是合理的。建议我们先完善一下 RFC。

JohnNiang

/lgtm

f2c-ci-robot · 2023-10-23T03:05:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JohnNiang

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~~ [JohnNiang]

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

#### What type of PR is this? /area console /kind improvement #### What this PR does / why we need it: 适配 #4745 ，使用新的接口启动/停止插件。 #### Which issue(s) this PR fixes: Fixes #4744 #### Special notes for your reviewer: #### Does this PR introduce a user-facing change? ```release-note None ```

f2c-ci-robot bot requested review from lan-yonghui and minliacom October 18, 2023 04:53

guqing changed the title ~~[WIP] refactor: provide APIs for change plugin motion status synchronously~~ [WIP] refactor: provide API for change plugin motion status synchronously Oct 18, 2023

guqing force-pushed the refactor/4744 branch from a64a0b9 to dd21630 Compare October 18, 2023 06:52

ruibaby mentioned this pull request Oct 18, 2023

refactor: use new api to change plugin status #4747

Merged

guqing force-pushed the refactor/4744 branch from dd21630 to d393568 Compare October 18, 2023 07:46

refactor: provide APIs for change plugin motion status synchronously

92ebdf0

guqing force-pushed the refactor/4744 branch from d393568 to 92ebdf0 Compare October 18, 2023 07:58

guqing changed the title ~~[WIP] refactor: provide API for change plugin motion status synchronously~~ refactor: provide API for change plugin motion status synchronously Oct 18, 2023

f2c-ci-robot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 18, 2023

ruibaby reviewed Oct 19, 2023

View reviewed changes

f2c-ci-robot bot assigned ruibaby Oct 19, 2023

f2c-ci-robot bot added the lgtm Indicates that a PR is ready to be merged. label Oct 19, 2023

ruibaby added this to the 2.11.x milestone Oct 19, 2023

JohnNiang reviewed Oct 20, 2023

View reviewed changes

refactor: update api definition for change plugin state

e0970a6

f2c-ci-robot bot removed the lgtm Indicates that a PR is ready to be merged. label Oct 20, 2023

Merge branch 'main' into refactor/4744

754954e

JohnNiang approved these changes Oct 23, 2023

View reviewed changes

f2c-ci-robot bot assigned JohnNiang Oct 23, 2023

f2c-ci-robot bot added the lgtm Indicates that a PR is ready to be merged. label Oct 23, 2023

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

f2c-ci-robot bot merged commit 772c7fc into halo-dev:main Oct 23, 2023
2 checks passed

guqing deleted the refactor/4744 branch October 23, 2023 03:19

JohnNiang modified the milestones: 2.11.x, 2.11.0 Oct 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: provide API for change plugin motion status synchronously #4745

refactor: provide API for change plugin motion status synchronously #4745

guqing commented Oct 18, 2023 •

edited

Loading

codecov bot commented Oct 18, 2023 •

edited

Loading

guqing commented Oct 18, 2023 •

edited

Loading

ruibaby left a comment

JohnNiang Oct 20, 2023

guqing Oct 20, 2023

guqing Oct 20, 2023

JohnNiang Oct 20, 2023

guqing Oct 20, 2023

JohnNiang Oct 20, 2023

guqing Oct 20, 2023 •

edited

Loading

JohnNiang Oct 20, 2023

JohnNiang left a comment

f2c-ci-robot bot commented Oct 23, 2023

refactor: provide API for change plugin motion status synchronously #4745

refactor: provide API for change plugin motion status synchronously #4745

Conversation

guqing commented Oct 18, 2023 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?

codecov bot commented Oct 18, 2023 • edited Loading

Codecov Report

guqing commented Oct 18, 2023 • edited Loading

ruibaby left a comment

Choose a reason for hiding this comment

JohnNiang Oct 20, 2023

Choose a reason for hiding this comment

guqing Oct 20, 2023

Choose a reason for hiding this comment

guqing Oct 20, 2023

Choose a reason for hiding this comment

JohnNiang Oct 20, 2023

Choose a reason for hiding this comment

guqing Oct 20, 2023

Choose a reason for hiding this comment

JohnNiang Oct 20, 2023

Choose a reason for hiding this comment

guqing Oct 20, 2023 • edited Loading

Choose a reason for hiding this comment

JohnNiang Oct 20, 2023

Choose a reason for hiding this comment

JohnNiang left a comment

Choose a reason for hiding this comment

f2c-ci-robot bot commented Oct 23, 2023

guqing commented Oct 18, 2023 •

edited

Loading

codecov bot commented Oct 18, 2023 •

edited

Loading

guqing commented Oct 18, 2023 •

edited

Loading

guqing Oct 20, 2023 •

edited

Loading