[Improvement][Api] Interface and entity optimization to improve code scalability (#10466). by hstdream · Pull Request #10468 · apache/dolphinscheduler

hstdream · 2022-06-16T02:04:22Z

Purpose of the pull request

To make the interface and entity easier to expand and improve the extensibility

Brief change log

Interface: there are new interface parameters behind. You can use otherparamsjson in the code
Entity: extend entity Dto
Add burying point

Verify this pull request

Add interface parms otherparamsjson

…scalability (apache#10466).

SbloodyS · 2022-06-16T02:08:00Z

Hi @hstdream , can you describe why did you want to do that? This may cause ui request error.

hstdream · 2022-06-16T02:12:00Z

I think if some new content is added later, the restrictions here are relatively large. UI currently has a child partner to modify

…scalability (apache#10466).

SbloodyS · 2022-06-16T02:15:23Z

I think if some new content is added later, the restrictions here are relatively large. UI currently has a child partner to modify

We suggest adding a feature to the same pr. It is not necessary to make meaningless changes in advance.

hstdream · 2022-06-16T02:15:33Z

Hi @hstdream , can you describe why did you want to do that? This may cause ui request error.

I think if some new content is added later, the restrictions here are relatively large. UI currently has a child partner to modify

hstdream · 2022-06-16T02:20:04Z

I think if some new content is added later, the restrictions here are relatively large. UI currently has a child partner to modify

We suggest adding a feature to the same pr. It is not necessary to make meaningless changes in advance.

How to operate?

SbloodyS · 2022-06-16T02:23:21Z

Descirbed what feature you want to implement in the associate issue and develop it in the same branch. Submit this branch to a PR after completion. @hstdream

caishunfeng · 2022-06-16T02:33:08Z

@hstdream please add some detail into pr description, includes Purpose of the pull request, Brief change log, Verify this pull request.
BTW, How does this relate to add license? Please use the right pr title.

hstdream · 2022-06-16T02:45:07Z

@hstdream please add some detail into pr description, includes Purpose of the pull request, Brief change log, Verify this pull request. BTW, How does this relate to add license? Please use the right pr title.

ok

lenboo · 2022-06-16T03:00:20Z

Descirbed what feature you want to implement in the associate issue and develop it in the same branch. Submit this branch to a PR after completion. @hstdream

@SbloodyS
Hi SbloodyS, with more and more new functions, there will be more incompatibilities in the API. We hope to fix the interface parameters to solve the problem of version compatibility and make fewer changes to interface parameters.
I think it's necessary to enhance the extensibility of the API.

SbloodyS · 2022-06-16T03:08:56Z

Descirbed what feature you want to implement in the associate issue and develop it in the same branch. Submit this branch to a PR after completion. @hstdream
@SbloodyS
Hi SbloodyS, with more and more new functions, there will be more incompatibilities in the API. We hope to fix the interface parameters to solve the problem of version compatibility and make fewer changes to interface parameters.
I think it's necessary to enhance the extensibility of the API.

In this case, i think we should create a general issue to describe all APIs that need to be modified. Then create sub issues to associate them. And then create the pr link to the sub issues. WDYT? @lenboo

hstdream · 2022-06-16T03:11:21Z

Descirbed what feature you want to implement in the associate issue and develop it in the same branch. Submit this branch to a PR after completion. @hstdream

purpose: to make the interface and entity easier to expand and improve the extensibility

interface: there are new interface parameters behind. You can use otherparamsjson in the code

entity: extend entity

…scalability (apache#10466).

codecov-commenter · 2022-06-16T06:59:18Z

Codecov Report

Merging #10468 (3004c47) into dev (720a10a) will decrease coverage by 0.00%.
The diff coverage is 57.89%.

@@             Coverage Diff              @@
##                dev   #10468      +/-   ##
============================================
- Coverage     40.90%   40.90%   -0.01%     
- Complexity     4852     4853       +1     
============================================
  Files           883      885       +2     
  Lines         35972    35982      +10     
  Branches       3991     3991              
============================================
+ Hits          14714    14717       +3     
- Misses        19802    19807       +5     
- Partials       1456     1458       +2

Impacted Files	Coverage Δ
...uler/api/controller/ProcessInstanceController.java	`72.09% <ø> (ø)`
...dolphinscheduler/api/dto/ProcessDefinitionDto.java	`0.00% <0.00%> (ø)`
...e/dolphinscheduler/api/dto/ProcessInstanceDto.java	`0.00% <0.00%> (ø)`
...che/dolphinscheduler/api/python/PythonGateway.java	`17.00% <ø> (ø)`
...hinscheduler/api/service/impl/BaseServiceImpl.java	`89.79% <ø> (ø)`
...r/api/service/impl/ProcessInstanceServiceImpl.java	`60.10% <ø> (ø)`
...api/service/impl/ProcessDefinitionServiceImpl.java	`31.14% <62.50%> (+0.38%)`	⬆️
...er/api/controller/ProcessDefinitionController.java	`45.34% <100.00%> (ø)`
...er/master/dispatch/host/assign/RandomSelector.java	`77.77% <0.00%> (-5.56%)`	⬇️
...e/dolphinscheduler/remote/NettyRemotingClient.java	`50.00% <0.00%> (-2.09%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 720a10a...3004c47. Read the comment docs.

SbloodyS · 2022-06-16T07:37:30Z

...pi/src/main/java/org/apache/dolphinscheduler/api/controller/ProcessDefinitionController.java

                                          @RequestParam(value = "tenantCode", required = true) String tenantCode,
                                          @RequestParam(value = "taskRelationJson", required = true) String taskRelationJson,
                                          @RequestParam(value = "taskDefinitionJson", required = true) String taskDefinitionJson,
+                                          @RequestParam(value = "otherParamsJson", required = false) String otherParamsJson,


We should add this param to the swagger's doc.

This is not the swagger's param. You can take a look at @ApiImplicitParam.

hstdream · 2022-06-16T07:56:01Z

close #10466

purpose: to make the interface and entity easier to expand and improve the extensibility

interface: there are new interface parameters behind. You can use otherparamsjson in the code

entity: extend entity

…scalability (apache#10466).

lenboo · 2022-06-16T08:28:51Z

Descirbed what feature you want to implement in the associate issue and develop it in the same branch. Submit this branch to a PR after completion. @hstdream
@SbloodyS
Hi SbloodyS, with more and more new functions, there will be more incompatibilities in the API. We hope to fix the interface parameters to solve the problem of version compatibility and make fewer changes to interface parameters.
I think it's necessary to enhance the extensibility of the API.

In this case, i think we should create a general issue to describe all APIs that need to be modified. Then create sub issues to associate them. And then create the pr link to the sub issues. WDYT? @lenboo

Good idea! But how can we let contributors know this when they modify the code?

SbloodyS · 2022-06-16T08:38:32Z

Good idea! But how can we let contributors know this when they modify the code?

At present, the issue can only be associated when the committers review the code.

sonarqubecloud · 2022-06-16T09:08:40Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
5 Code Smells

50.0% Coverage
0.0% Duplication

lenboo

+1

zhongjiajie · 2022-06-17T06:26:39Z

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/python/PythonGateway.java

                                                int releaseState,
                                                String taskRelationJson,
                                                String taskDefinitionJson,
+                                                String otherParamsJson,


This change will fail python API submit function, maybe we should change python integrate test to avoid regression

zhongjiajie · 2022-06-17T06:29:02Z

...pi/src/main/java/org/apache/dolphinscheduler/api/controller/ProcessDefinitionController.java


        Map<String, Object> result = processDefinitionService.updateProcessDefinition(loginUser, projectCode, name, code, description, globalParams,
-            locations, timeout, tenantCode, taskRelationJson, taskDefinitionJson,executionType);
+            locations, timeout, tenantCode, taskRelationJson, taskDefinitionJson,otherParamsJson, executionType);


I wonder why this addition can pass checktyle, i think it is should be a space before otherParamsJson

…scalability (apache#10466). (apache#10468) * [Improvement][Api] Interface and entity optimization to improve code scalability (apache#10466). * [Improvement][Api] Interface and entity optimization to improve code scalability (apache#10466). * [Improvement][Api] Interface and entity optimization to improve code scalability (apache#10466). * [Improvement][Api] Interface and entity optimization to improve code scalability (apache#10466). * fix ut timezone. Co-authored-by: houshitao <shitaohou@163.com>

[Improvement][Api] Interface and entity optimization to improve code …

d71df08

…scalability (apache#10466).

hstdream requested review from SbloodyS and caishunfeng as code owners June 16, 2022 02:04

hstdream changed the title ~~[Improvement][Api] Interface and entity optimization to improve code …~~ [Improvement][Api] Interface and entity optimization to improve code scalability (#10466). Jun 16, 2022

SbloodyS assigned hstdream Jun 16, 2022

SbloodyS added backend improvement make more easy to user or prompt friendly labels Jun 16, 2022

[Improvement][Api] Interface and entity optimization to improve code …

2dd09d0

…scalability (apache#10466).

SbloodyS added the don't merge label Jun 16, 2022

hstdream changed the title ~~[Improvement][Api] Interface and entity optimization to improve code scalability (#10466).~~ add license. Jun 16, 2022

hstdream changed the title ~~add license.~~ [Improvement][Api] Interface and entity optimization to improve code scalability (#10466). Jun 16, 2022

SbloodyS removed the don't merge label Jun 16, 2022

SbloodyS added this to the 3.0.0-beta-3 milestone Jun 16, 2022

[Improvement][Api] Interface and entity optimization to improve code …

40d8be5

…scalability (apache#10466).

SbloodyS reviewed Jun 16, 2022

View reviewed changes

[Improvement][Api] Interface and entity optimization to improve code …

3622a6a

…scalability (apache#10466).

fix ut timezone.

3004c47

lenboo approved these changes Jun 16, 2022

View reviewed changes

lenboo merged commit f3c647d into apache:dev Jun 16, 2022

zhongjiajie reviewed Jun 17, 2022

View reviewed changes

zhongjiajie mentioned this pull request Jun 17, 2022

[Bug] [python] integrate test run strategy change #10488

Closed

3 tasks

zhongjiajie modified the milestones: 3.0.0-release, 3.1.0-alpha Aug 3, 2022

Conversation

hstdream commented Jun 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of the pull request

Brief change log

Verify this pull request

Uh oh!

SbloodyS commented Jun 16, 2022

Uh oh!

hstdream commented Jun 16, 2022 • edited by SbloodyS Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SbloodyS commented Jun 16, 2022

Uh oh!

hstdream commented Jun 16, 2022

Uh oh!

hstdream commented Jun 16, 2022

Uh oh!

SbloodyS commented Jun 16, 2022

Uh oh!

caishunfeng commented Jun 16, 2022

Uh oh!

hstdream commented Jun 16, 2022

Uh oh!

lenboo commented Jun 16, 2022 • edited by zhongjiajie Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SbloodyS commented Jun 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hstdream commented Jun 16, 2022

Uh oh!

codecov-commenter commented Jun 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

SbloodyS Jun 16, 2022

Choose a reason for hiding this comment

Uh oh!

hstdream Jun 16, 2022

Choose a reason for hiding this comment

Uh oh!

SbloodyS Jun 16, 2022

Choose a reason for hiding this comment

Uh oh!

hstdream Jun 16, 2022

Choose a reason for hiding this comment

Uh oh!

hstdream commented Jun 16, 2022

Uh oh!

lenboo commented Jun 16, 2022

Uh oh!

SbloodyS commented Jun 16, 2022

Uh oh!

sonarqubecloud bot commented Jun 16, 2022

Uh oh!

lenboo left a comment

Choose a reason for hiding this comment

Uh oh!

zhongjiajie Jun 17, 2022

Choose a reason for hiding this comment

Uh oh!

zhongjiajie Jun 17, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

hstdream commented Jun 16, 2022 •

edited

Loading

hstdream commented Jun 16, 2022 •

edited by SbloodyS

Loading

lenboo commented Jun 16, 2022 •

edited by zhongjiajie

Loading

SbloodyS commented Jun 16, 2022 •

edited

Loading

codecov-commenter commented Jun 16, 2022 •

edited

Loading