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 2020/05/15 06:25:57 UTC

[GitHub] [pulsar] srkukarni opened a new pull request #6964: Change the signature of loadFromSecrets to make it more saner

srkukarni opened a new pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964


   <!--
   ### Contribution Checklist
     
     - Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
       Skip *Issue XYZ* if there is no associated github issue for this pull request.
       Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
   
     - 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.
   
   **(The sections below can be removed for hotfixes of typos)**
   -->
   
   *(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
   
   Fixes #<xyz>
   
   *(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
   
   Master Issue: #<xyz>
   
   ### Motivation
   
   Secrets Unmasking should happen only post object creation. The object creation of the config is actually the job of the connector impl. This decouples the creation of the config object from loading of the secrets.
   
   ### Modifications
   
   *Describe the modifications you've done.*
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   *(Please pick either of the following options)*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This change is already covered by existing tests, such as *(please describe tests)*.
   
   *(or)*
   
   This change added tests and can be verified as follows:
   
   *(example:)*
     - *Added integration tests for end-to-end deployment with large payloads (10MB)*
     - *Extended integration test for recovery after broker failure*
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If `yes` was chosen, please highlight the changes*
   
     - Dependencies (does it add or upgrade a dependency): (yes / no)
     - The public API: (yes / no)
     - The schema: (yes / no / don't know)
     - The default values of configurations: (yes / no)
     - The wire protocol: (yes / no)
     - The rest endpoints: (yes / no)
     - The admin cli options: (yes / no)
     - Anything that affects deployment: (yes / no / don't know)
   
   ### 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.

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



[GitHub] [pulsar] srkukarni commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r425930784



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       I've changed the function name to better describe what the function is doing




----------------------------------------------------------------
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.

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



[GitHub] [pulsar] srkukarni commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r425911440



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       Connectors can construct their config class in any manner they choose to. Mapping from the the Map<String, Object> using object factory is just one way of doing this. The existing method overloads both, when the function name really is about loading the config class with secrets. Hence the change




----------------------------------------------------------------
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.

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



[GitHub] [pulsar] jerrypeng commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r425970662



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       > Connectors can construct their config class in any manner they choose to. Mapping from the the Map<String, Object> using object factory is just one way of doing this.
   
   Sure, but I would say the most common pattern would be the existing one.  Most, if not all connectors, will load a config class from a map where there is a one to one mapping of class field to key. I think it would be extremely uncommon for a connector not to follow that pattern and have some custom mapping scheme implemented. At most I would recommend just adding a helper method "IOConfigUtils.fillWithSecrets" that allows developers to do the "filling" of secrets separately if they want but I wouldn't recommend changing the paradigm for every connector.  




----------------------------------------------------------------
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.

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



[GitHub] [pulsar] jerrypeng commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r425970662



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       > Connectors can construct their config class in any manner they choose to. Mapping from the the Map<String, Object> using object factory is just one way of doing this.
   
   Sure, but I would say the most common pattern would be the existing one.  Most, if not all connectors, will load a config class from a map where is is a one to one mapping of class field to key. I think it would be extremely uncommon for a connector not to follow that pattern and have some custom mapping scheme implemented. At most I would recommend just adding a helper method "IOConfigUtils.fillWithSecrets" that allows developers to do the "filling" of secrets separately if they want but I wouldn't recommend changing the paradigm for every connector.  




----------------------------------------------------------------
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.

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



[GitHub] [pulsar] jerrypeng commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r425601697



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       I don't quite understand why we need to separate this into two calls?  What are we benefiting from doing this?Seems to make things more complicated than necessary?

##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       I don't quite understand why we need to separate this into two calls?  What are we benefiting from doing this? Seems to make things more complicated than necessary?




----------------------------------------------------------------
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.

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



[GitHub] [pulsar] srkukarni commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r426887113



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       Closing this issue, since I now concur with Jerry's views.




----------------------------------------------------------------
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.

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



[GitHub] [pulsar] srkukarni closed pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
srkukarni closed pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964


   


----------------------------------------------------------------
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.

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



[GitHub] [pulsar] jerrypeng commented on a change in pull request #6964: Change the signature of loadFromSecrets to make it more saner

Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #6964:
URL: https://github.com/apache/pulsar/pull/6964#discussion_r425601697



##########
File path: pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java
##########
@@ -72,7 +72,8 @@
 
     @Override
     public void open(Map<String, Object> config, SourceContext sourceContext) throws IOException {
-        TwitterFireHoseConfig hoseConfig = IOConfigUtils.loadWithSecrets(config, TwitterFireHoseConfig.class, sourceContext);
+        TwitterFireHoseConfig hoseConfigWithoutSecrets = TwitterFireHoseConfig.load(config);

Review comment:
       I don't quite understand why we need to separate this into two calls?  Seems to make things more complicated than necessary?




----------------------------------------------------------------
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.

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