You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@eventmesh.apache.org by "Pil0tXia (via GitHub)" <gi...@apache.org> on 2023/10/31 05:07:44 UTC

[PR] [ISSUE #4521] Enhancing clarity and Avoiding future conflicts in exception enum (eventmesh)

Pil0tXia opened a new pull request, #4524:
URL: https://github.com/apache/eventmesh/pull/4524

   <!--
   ### Contribution Checklist
   
     - Name the pull request in the form "[ISSUE #XXXX] Title of the pull request", 
       where *XXXX* should be replaced by the actual issue number.
       Skip *[ISSUE #XXXX]* if there is no associated github issue for this pull request.
   
     - 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. 
       Please do not mix up code from multiple issues.
     
     - Each commit in the pull request should have 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.
   
   (The sections below can be removed for hotfixes of typos)
   -->
   
   <!--
   (If this PR fixes a GitHub issue, please add `Fixes #<XXX>` or `Closes #<XXX>`.)
   -->
   
   Fixes #4521.
   
   ### Motivation
   
   The Message subclass represents the string message for exceptions; however, its concept may potentially conflict with MQ messages. To address this concern, the class name has been changed while retaining the field name.
   
   Type refers to a kind or category, where its constituents share similar characteristics. It can pertain to a single exception or multiple exceptions of the same type, which might lead to potential ambiguity. Therefore, its class name has been exacted to the primary classification level `Category`.
   
   ### Modifications
   
   The names of various exception enumeration classes have been optimized to better align with their usage in the code, adhere more closely to English grammar, and avoid potential conflicts with future-introduced concepts.
   
   ### Documentation
   
   - Does this pull request introduce a new feature? (yes / no)
   - If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
   - If a feature is not applicable for documentation, explain why?
   - If a feature is not documented yet in this PR, please create a followup issue for adding the documentation
   


-- 
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: dev-unsubscribe@eventmesh.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: dev-help@eventmesh.apache.org


Re: [PR] [ISSUE #4521] Enhancing clarity and Avoiding future conflicts in exception enum (eventmesh)

Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #4524:
URL: https://github.com/apache/eventmesh/pull/4524#issuecomment-1786585018

   We're currently processing your upload.  This comment will be updated when the results are available.


-- 
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: issues-unsubscribe@eventmesh.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org


Re: [PR] [ISSUE #4521] A poor naming. (eventmesh)

Posted by "xwm1992 (via GitHub)" <gi...@apache.org>.
xwm1992 merged PR #4524:
URL: https://github.com/apache/eventmesh/pull/4524


-- 
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: dev-unsubscribe@eventmesh.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: dev-help@eventmesh.apache.org


Re: [PR] [ISSUE #4521] A poor naming. (eventmesh)

Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4524:
URL: https://github.com/apache/eventmesh/pull/4524#discussion_r1377271497


##########
eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java:
##########
@@ -17,60 +17,60 @@
 
 package org.apache.eventmesh.admin.enums;
 
-import static org.apache.eventmesh.admin.common.ConfigConst.COLON;
+import static org.apache.eventmesh.admin.constant.ConfigConst.COLON;
 
 import org.springframework.http.HttpStatus;
 
 import lombok.Getter;
 
 /**
- * An enumeration class that conforms to the RESTful specifications and custom error reporting requirements.
+ * An error enumeration class that conforms to the RESTful specifications and custom error reporting requirements.

Review Comment:
   This class contains `SUCCESS`, why did you deliberately modify the description to emphasize it as `An error enumeration class` after changing the class name from `Errors` to `Status`?
   
   ---
   这个类包含`SUCCESS`,为什么在将类名从`Errors`改成`Status`以后,又特意修改描述强调它是`An error enumeration class`?



##########
eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java:
##########
@@ -17,60 +17,60 @@
 
 package org.apache.eventmesh.admin.enums;
 
-import static org.apache.eventmesh.admin.common.ConfigConst.COLON;
+import static org.apache.eventmesh.admin.constant.ConfigConst.COLON;
 
 import org.springframework.http.HttpStatus;
 
 import lombok.Getter;
 
 /**
- * An enumeration class that conforms to the RESTful specifications and custom error reporting requirements.
+ * An error enumeration class that conforms to the RESTful specifications and custom error reporting requirements.

Review Comment:
   This class contains `SUCCESS`, why did you deliberately modify the description to emphasize it as `An error enumeration class` after changing the class name from `Errors` to `Status`?
   
   ---
   这个类包含`SUCCESS`,为什么在将类名从`Errors`改成`Status`以后,又特意修改描述强调它是`An error enumeration class`?



-- 
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: issues-unsubscribe@eventmesh.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org


Re: [PR] [ISSUE #4521] A poor naming. (eventmesh)

Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4524:
URL: https://github.com/apache/eventmesh/pull/4524#discussion_r1377271497


##########
eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java:
##########
@@ -17,60 +17,60 @@
 
 package org.apache.eventmesh.admin.enums;
 
-import static org.apache.eventmesh.admin.common.ConfigConst.COLON;
+import static org.apache.eventmesh.admin.constant.ConfigConst.COLON;
 
 import org.springframework.http.HttpStatus;
 
 import lombok.Getter;
 
 /**
- * An enumeration class that conforms to the RESTful specifications and custom error reporting requirements.
+ * An error enumeration class that conforms to the RESTful specifications and custom error reporting requirements.

Review Comment:
   Because this class contains `SUCCESS`, the class name is modified. Why did you deliberately modify the description to emphasize it as `An error enumeration class` after changing the class name from `Errors` to `Status`?
   
   ---
   因为这个类包含`SUCCESS`,所以修改类名。为什么在将类名从`Errors`改成`Status`以后,又特意修改描述强调它是`An error enumeration class`?



-- 
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: issues-unsubscribe@eventmesh.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org


Re: [PR] [ISSUE #4521] A poor naming. (eventmesh)

Posted by "Pil0tXia (via GitHub)" <gi...@apache.org>.
Pil0tXia commented on code in PR #4524:
URL: https://github.com/apache/eventmesh/pull/4524#discussion_r1377339605


##########
eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java:
##########
@@ -17,60 +17,60 @@
 
 package org.apache.eventmesh.admin.enums;
 
-import static org.apache.eventmesh.admin.common.ConfigConst.COLON;
+import static org.apache.eventmesh.admin.constant.ConfigConst.COLON;
 
 import org.springframework.http.HttpStatus;
 
 import lombok.Getter;
 
 /**
- * An enumeration class that conforms to the RESTful specifications and custom error reporting requirements.
+ * An error enumeration class that conforms to the RESTful specifications and custom error reporting requirements.

Review Comment:
   Fixed in https://github.com/apache/eventmesh/pull/4524/commits/d91e9e5695a0b7988962e2f346ccf9d07bc9f085.



-- 
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: issues-unsubscribe@eventmesh.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org