You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@dubbo.apache.org by "khanimteyaz (GitHub)" <gi...@apache.org> on 2018/12/14 20:19:01 UTC

[GitHub] [incubator-dubbo] khanimteyaz opened pull request #2967: Documentation/2935#dubbo rpc api

## What is the purpose of the change

Added javadoc and documentation for dubbo-rpc-api filter package. 

## Brief changelog

Added documentation for java classes for developer, to provide high level idea what this current class suppose to do.

## Verifying this change

Run build locally.

Follow this checklist to help us incorporate your contribution quickly and easily:

- [x] Make sure there is a [2935](https://github.com/apache/incubator-dubbo/issues/2935) field for the change (usually before you start working on it). Trivial changes like typos do not require a GITHUB issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
- [ ] Format the pull request title like `[Dubbo-XXX] Fix UnknownException when host config not exist #XXX`. Each commit in the pull request should have a meaningful subject line and body.
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [ ] Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in [test module](https://github.com/apache/incubator-dubbo/tree/master/dubbo-test).
- [ ] Run `mvn clean install -DskipTests=false` & `mvn clean test-compile failsafe:integration-test` to make sure unit-test and integration-test pass.
- [ ] If this contribution is large, please follow the [Software Donation Guide](https://github.com/apache/incubator-dubbo/wiki/Software-donation-guide).


[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2967: Documentation/2935#dubbo rpc api

Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
Thanks @beiwei30 and @carryxyh.

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] codecov-io commented on issue #2967: Documentation/2935#dubbo rpc api

Posted by "codecov-io (GitHub)" <gi...@apache.org>.
# [Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=h1) Report
> Merging [#2967](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=desc) into [master](https://codecov.io/gh/apache/incubator-dubbo/commit/31de87008a33129d82236cfbf107fdf50cb477ad?src=pr&el=desc) will **decrease** coverage by `0.04%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/graphs/tree.svg?width=650&token=VnEIkiFQT0&height=150&src=pr)](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=tree)

```diff
@@            Coverage Diff             @@
##           master    #2967      +/-   ##
==========================================
- Coverage   64.08%   64.03%   -0.05%     
==========================================
  Files         584      584              
  Lines       26059    26059              
  Branches     4562     4562              
==========================================
- Hits        16699    16686      -13     
- Misses       7185     7194       +9     
- Partials     2175     2179       +4
```


| [Impacted Files](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [...va/org/apache/dubbo/rpc/filter/TpsLimitFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvVHBzTGltaXRGaWx0ZXIuamF2YQ==) | `100% <ø> (ø)` | :arrow_up: |
| [...n/java/org/apache/dubbo/rpc/filter/EchoFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvRWNob0ZpbHRlci5qYXZh) | `75% <ø> (ø)` | :arrow_up: |
| [...org/apache/dubbo/rpc/filter/ActiveLimitFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQWN0aXZlTGltaXRGaWx0ZXIuamF2YQ==) | `78.12% <ø> (ø)` | :arrow_up: |
| [.../org/apache/dubbo/rpc/filter/CompatibleFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ29tcGF0aWJsZUZpbHRlci5qYXZh) | `83.33% <ø> (ø)` | :arrow_up: |
| [.../org/apache/dubbo/rpc/filter/DeprecatedFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvRGVwcmVjYXRlZEZpbHRlci5qYXZh) | `76.19% <ø> (ø)` | :arrow_up: |
| [...org/apache/dubbo/rpc/filter/ClassLoaderFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ2xhc3NMb2FkZXJGaWx0ZXIuamF2YQ==) | `100% <ø> (ø)` | :arrow_up: |
| [...rg/apache/dubbo/rpc/filter/ExecuteLimitFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvRXhlY3V0ZUxpbWl0RmlsdGVyLmphdmE=) | `87.5% <ø> (ø)` | :arrow_up: |
| [...apache/dubbo/rpc/filter/tps/DefaultTPSLimiter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvdHBzL0RlZmF1bHRUUFNMaW1pdGVyLmphdmE=) | `66.66% <ø> (ø)` | :arrow_up: |
| [...ava/org/apache/dubbo/rpc/filter/ContextFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ29udGV4dEZpbHRlci5qYXZh) | `92.59% <ø> (ø)` | :arrow_up: |
| [...apache/dubbo/rpc/filter/ConsumerContextFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ29uc3VtZXJDb250ZXh0RmlsdGVyLmphdmE=) | `100% <ø> (ø)` | :arrow_up: |
| ... and [11 more](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=footer). Last update [31de870...118c914](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).


[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org

[GitHub] [incubator-dubbo] khanimteyaz commented on issue #2967: Documentation/2935#dubbo rpc api

Posted by "khanimteyaz (GitHub)" <gi...@apache.org>.
On it. Sorry for the delay in response.

On Mon, Dec 17, 2018 at 7:50 AM 时无两丶 <no...@github.com> wrote:

> Hi, @khanimteyaz <https://github.com/khanimteyaz>
> Very nice work, I'd like take a look.
> Another thing, would u pls clear your commits? Seems like your pr has four
> commits.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/apache/incubator-dubbo/pull/2967#issuecomment-447702803>,
> or mute the thread
> <https://github.com/notifications/unsubscribe-auth/AdXcPdW5b5DTbcqEitzRwDCSFGapxd07ks5u5v9TgaJpZM4ZUNbi>
> .
>


[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org

[GitHub] [incubator-dubbo] codecov-io commented on issue #2967: Documentation/2935#dubbo rpc api

Posted by "codecov-io (GitHub)" <gi...@apache.org>.
# [Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=h1) Report
> Merging [#2967](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=desc) into [master](https://codecov.io/gh/apache/incubator-dubbo/commit/31de87008a33129d82236cfbf107fdf50cb477ad?src=pr&el=desc) will **decrease** coverage by `0.15%`.
> The diff coverage is `n/a`.

[![Impacted file tree graph](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/graphs/tree.svg?width=650&token=VnEIkiFQT0&height=150&src=pr)](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=tree)

```diff
@@            Coverage Diff             @@
##           master    #2967      +/-   ##
==========================================
- Coverage   64.09%   63.93%   -0.16%     
==========================================
  Files         584      584              
  Lines       26059    26059              
  Branches     4562     4562              
==========================================
- Hits        16702    16662      -40     
- Misses       7184     7215      +31     
- Partials     2173     2182       +9
```


| [Impacted Files](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=tree) | Coverage Δ | |
|---|---|---|
| [...va/org/apache/dubbo/rpc/filter/TpsLimitFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvVHBzTGltaXRGaWx0ZXIuamF2YQ==) | `100% <ø> (ø)` | :arrow_up: |
| [...n/java/org/apache/dubbo/rpc/filter/EchoFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvRWNob0ZpbHRlci5qYXZh) | `75% <ø> (ø)` | :arrow_up: |
| [...org/apache/dubbo/rpc/filter/ActiveLimitFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQWN0aXZlTGltaXRGaWx0ZXIuamF2YQ==) | `78.12% <ø> (ø)` | :arrow_up: |
| [.../org/apache/dubbo/rpc/filter/CompatibleFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ29tcGF0aWJsZUZpbHRlci5qYXZh) | `83.33% <ø> (ø)` | :arrow_up: |
| [.../org/apache/dubbo/rpc/filter/DeprecatedFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvRGVwcmVjYXRlZEZpbHRlci5qYXZh) | `76.19% <ø> (ø)` | :arrow_up: |
| [...org/apache/dubbo/rpc/filter/ClassLoaderFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ2xhc3NMb2FkZXJGaWx0ZXIuamF2YQ==) | `100% <ø> (ø)` | :arrow_up: |
| [...rg/apache/dubbo/rpc/filter/ExecuteLimitFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvRXhlY3V0ZUxpbWl0RmlsdGVyLmphdmE=) | `87.5% <ø> (ø)` | :arrow_up: |
| [...apache/dubbo/rpc/filter/tps/DefaultTPSLimiter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvdHBzL0RlZmF1bHRUUFNMaW1pdGVyLmphdmE=) | `66.66% <ø> (ø)` | :arrow_up: |
| [...ava/org/apache/dubbo/rpc/filter/ContextFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ29udGV4dEZpbHRlci5qYXZh) | `92.59% <ø> (ø)` | :arrow_up: |
| [...apache/dubbo/rpc/filter/ConsumerContextFilter.java](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree#diff-ZHViYm8tcnBjL2R1YmJvLXJwYy1hcGkvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2R1YmJvL3JwYy9maWx0ZXIvQ29uc3VtZXJDb250ZXh0RmlsdGVyLmphdmE=) | `100% <ø> (ø)` | :arrow_up: |
| ... and [15 more](https://codecov.io/gh/apache/incubator-dubbo/pull/2967/diff?src=pr&el=tree-more) | |

------

[Continue to review full report at Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=continue).
> **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta)
> `Δ = absolute <relative> (impact)`, `ø = not affected`, `? = missing data`
> Powered by [Codecov](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=footer). Last update [31de870...75da9e5](https://codecov.io/gh/apache/incubator-dubbo/pull/2967?src=pr&el=lastupdated). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments).


[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org

[GitHub] [incubator-dubbo] beiwei30 commented on issue #2967: Documentation/2935#dubbo rpc api

Posted by "beiwei30 (GitHub)" <gi...@apache.org>.
nice job :)

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] carryxyh commented on issue #2967: Documentation/2935#dubbo rpc api

Posted by "carryxyh (GitHub)" <gi...@apache.org>.
Hi, @khanimteyaz 
Very nice work, I'd like take a look.
Another thing, would u pls clear your commits? Seems like your pr has four commits.

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org


[GitHub] [incubator-dubbo] beiwei30 closed pull request #2967: Documentation/2935#dubbo rpc api

Posted by "beiwei30 (GitHub)" <gi...@apache.org>.
[ pull request closed by beiwei30 ]

[ Full content available at: https://github.com/apache/incubator-dubbo/pull/2967 ]
This message was relayed via gitbox.apache.org for notifications@dubbo.apache.org