You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/12/21 15:55:13 UTC

[GitHub] [pulsar] AlvaroStream opened a new pull request, #19019: [improve][doc] Java example explaining code without using lombok

AlvaroStream opened a new pull request, #19019:
URL: https://github.com/apache/pulsar/pull/19019

   <!--
   ### Contribution Checklist
     
     - PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.trs9rsex3xom)*. 
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
     
     - Each pull request should address only one issue, not mix up code from multiple issues.
     
     - Each commit in the pull request has a meaningful commit message
   
     - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
   -->
   
   ### Motivation
   
   <!-- Explain here the context, and why you're making that change. What is the problem you're trying to solve. -->
   
   Following strictly the example can make people that doesn't use lombok get this error:
   
   No serializer found for class com.mytest.Product and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)
   
   ### Modifications
   
   <!-- Describe the modifications you've done. -->
   
   Increase the documentation on the code example.
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   ### Does this pull request potentially affect one of the following parts:
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   *If the box was checked, please highlight the changes*
   
   - [ ] Dependencies (add or upgrade a dependency)
   - [ ] The public API
   - [ ] The schema
   - [ ] The default values of configurations
   - [ ] The threading model
   - [ ] The binary protocol
   - [ ] The REST endpoints
   - [ ] The admin CLI options
   - [ ] The metrics
   - [ ] Anything that affects deployment
   
   ### Documentation
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   - [X] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) to your PR description, or else your PR might not get merged. -->
   - [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
   - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
   - [ ] `doc-complete` <!-- Docs have been already added -->
   
   I tried executing the sh start.sh:
   
   ````
   
   [SUCCESS] Docusaurus website is running at: http://localhost:3000/
   
   ✔ Client
     Compiled successfully in 27.76s
   
   client (webpack 5.75.0) compiled with 1 warning
   <w> [webpack.cache.PackFileCacheStrategy] Skipped not serializable cache item 'Compilation/modules|/Users/arodriguez/Code/git_pulsar_alvaro/site2/.preview/pulsar-site/site2/website-next/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[6].use[1]!/Users/arodriguez/Code/git_pulsar_alvaro/site2/.preview/pulsar-site/site2/website-next/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[6].use[2]!/Users/arodriguez/Code/git_pulsar_alvaro/site2/.preview/pulsar-site/site2/website-next/src/css/custom.css': No serializer registered for Warning
   <w> while serializing webpack/lib/cache/PackFileCacheStrategy.PackContentItems -> webpack/lib/NormalModule -> Array { 1 items } -> webpack/lib/ModuleWarning -> Warning
   
   ````
   
   But I couldn't access the docs:
   
   http://localhost:3000/docs/schema-understand/
   http://localhost:3000/docs/2.10.x/schema-understand/
   
   Was giving always `Page Not found`
   
   
   ### Matching PR in forked repository
   
   PR in forked repository: https://github.com/AlvaroStream/pulsar
   
   <!--
   After opening this PR, the build in apache/pulsar will fail and instructions will
   be provided for opening a PR in the PR author's forked repository.
   
   apache/pulsar pull requests should be first tested in your own fork since the 
   apache/pulsar CI based on GitHub Actions has constrained resources and quota.
   GitHub Actions provides separate quota for pull requests that are executed in 
   a forked repository.
   
   The tests will be run in the forked repository until all PR review comments have
   been handled, the tests pass and the PR is approved by a reviewer.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] codelipenghui commented on pull request #19019: [improve][doc] Java example explaining code without using lombok

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on PR #19019:
URL: https://github.com/apache/pulsar/pull/19019#issuecomment-1364808642

   @AlvaroStream 
   
   I noticed you have removed
   
   ```
      @Builder
       @AllArgsConstructor
       @NoArgsConstructor
   ```
   
   From the last comment https://github.com/apache/pulsar/pull/19019#discussion_r1055114376. We don't need to add the constructors if we have the annotation. The Lombok will generate them. 
   
   We should remove https://github.com/apache/pulsar/pull/19019/files#diff-fe3c06d8365d562427069af4376e699002169fdcf1047e836e771ce355756044R130-R134 if we have Lombok annotations.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] AlvaroStream commented on pull request #19019: [improve][doc] Java example explaining code without using lombok

Posted by GitBox <gi...@apache.org>.
AlvaroStream commented on PR #19019:
URL: https://github.com/apache/pulsar/pull/19019#issuecomment-1365003264

   @codelipenghui sorry, I missunderstood. Now is better?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] codelipenghui commented on a diff in pull request #19019: [improve][doc] Java example explaining code without using lombok

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on code in PR #19019:
URL: https://github.com/apache/pulsar/pull/19019#discussion_r1055114376


##########
site2/docs/schema-understand.md:
##########
@@ -122,6 +122,11 @@ Pulsar gets the schema definition from the predefined `struct` using an Avro lib
 1. Create the _User_ class to define the messages sent to Pulsar topics.
 
    ```java
+   # If you use Lombok
+   @Builder
+   @AllArgsConstructor
+   @NoArgsConstructor

Review Comment:
   We can remove line 133 to 137 since lombok will generate the constructors.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] AlvaroStream commented on a diff in pull request #19019: [improve][doc] Java example explaining code without using lombok

Posted by GitBox <gi...@apache.org>.
AlvaroStream commented on code in PR #19019:
URL: https://github.com/apache/pulsar/pull/19019#discussion_r1055357155


##########
site2/docs/schema-understand.md:
##########
@@ -122,6 +122,11 @@ Pulsar gets the schema definition from the predefined `struct` using an Avro lib
 1. Create the _User_ class to define the messages sent to Pulsar topics.
 
    ```java
+   # If you use Lombok
+   @Builder
+   @AllArgsConstructor
+   @NoArgsConstructor

Review Comment:
   Thanks I just changed it a i though it was.
   
   Removed.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] codelipenghui merged pull request #19019: [improve][doc] Java example explaining code without using lombok

Posted by GitBox <gi...@apache.org>.
codelipenghui merged PR #19019:
URL: https://github.com/apache/pulsar/pull/19019


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org