Obtain features of a node #1062

kwek20 · 2018-10-16T17:08:59Z

Description

This PR adds a field called features to the getNodeInfo() API call.
It includes a list of features this node has enabled.

All features are calculated after construction of the node, and before loading of the node, through the Features enum. This enum also contains all the possible features a node can have.

Discussion: What should the actual feature list be?

Fixes #1039
Solves #854

Type of change

Enhancement (a non-breaking change which adds functionality)

How Has This Been Tested?

Ran getNodeInfo() and the expected features are send back
Unit tests do not break

Checklist:

My code follows the style guidelines for this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

chrisdukakis · 2018-10-17T08:48:03Z

What do you think about a list of accessible commands? Simple as this:

{
    "accessibleCommands": [
        "getTransactionsToApprove",
        "attachToTangle",
        "storeTransactions",
        "etc..."
     ]
}

jakubcech · 2018-10-17T08:58:26Z

src/main/java/com/iota/iri/service/Feature.java

+import com.iota.iri.conf.IotaConfig;
+
+public enum Feature {
+    ATTACH_TO_TANGLE("attachToTange"),


attachToTange -> attachToTangle

jakubcech · 2018-10-17T08:58:33Z

src/main/java/com/iota/iri/service/Feature.java

+
+        for (String disabled : configuration.getRemoteLimitApi()) {
+            switch (disabled) {
+            case "attachToTange":


attachToTange -> attachToTangle

jakubcech · 2018-10-17T09:10:38Z

Not sure if this is expecting some more commits still. Just pointing out that this should have a form of features that are enabled, not just commands that are available. To make the contract clear, you should be able to query a node and discover that PoW is enabled in a clear way, regardless of the logic that enables/disables the remote PoW (which now is attachToTangle not in the remote limit list). Just listing that attachToTangle is available doesn't make that clear unless it's documented (which this should be as a scenario anyway). That's also why we just didn't go with a list of commands after some discussions @chrisdukakis.

Also, #1038 is about request limits.

kwek20 · 2018-10-17T15:22:39Z

@jakubcech I just need to add comments and some test cases i think could be useful
The list of commands should definitely be useful, still don't know why we don't have that in the Api.java.
Not part of this PR though.

Good point on the Abstraction of feature names!

GalRogozinski

Nice docs

Just a few changes please

GalRogozinski · 2018-10-29T10:47:05Z

src/main/java/com/iota/iri/service/Feature.java

+     * @param instance the instance of this node
+     * @return A list of features
+     */
+    public static Feature[] calculateFeatures(Iota instance) {


Can this receive IotaConfig?

It could be, but maybe some day we have to calculate features based on external factors outside of the config. Like only enable X if the database is up to date.

Or want to change to that when we have the need for it, and use config for now?

use configs for now
global scope is evil

GalRogozinski · 2018-10-29T10:47:54Z

src/main/java/com/iota/iri/service/Feature.java

+    /**
+     * Calculates all features for this Iota node
+     * @param instance the instance of this node
+     * @return A list of the features in readable name format


We are returning an array not a list

GalRogozinski · 2018-10-29T10:51:48Z

src/main/java/com/iota/iri/service/Feature.java

+
+        List<String> featureNames = Arrays.stream(features)
+                .map(feature -> feature.toString())
+                .collect(Collectors.toList());


it is better to do .toArray(Sting[]::new)

GalRogozinski · 2018-10-29T10:52:40Z

src/main/java/com/iota/iri/service/Feature.java

+     * @param instance the instance of this node
+     * @return A list of the features in readable name format
+     */
+    public static String[] calculateFeatureNames(Iota instance) {


Can this receive IotaConfig?

It doesn't need the whole instance

GalRogozinski

Can you also add the changes from commit from iotaledger/iri-regression#67 here?
The iri-regression is now part of this repository.

Thanks

GalRogozinski · 2018-10-29T12:21:48Z

src/main/java/com/iota/iri/service/Feature.java

+        Feature[] features = calculateFeatures(instance);
+
+        String[] featureNames = Arrays.stream(features)
+                .map(feature -> feature.toString()).toArray(String[]::new);


just a style thing I want to follow

Can you put the toArray on a new line? like it was before with collect

GalRogozinski · 2018-11-01T16:10:49Z

python-regression/tests/features/machine1/1_api_tests.feature

@@ -22,6 +22,7 @@ Feature: Test API calls on Machine 1
 		|appName					|
 		|appVersion					|
 		|duration					|
+		|features                 |                                                              


indentation

kwek20 added 2 commits October 16, 2018 19:00

Added api features to getNodeInfo

6c3a78c

Documentation for Feature public calls

ae9dfcb

jakubcech reviewed Oct 17, 2018

View reviewed changes

Fixed typo and added comments

464e07c

iotaledger deleted a comment Oct 17, 2018

This was referenced Oct 18, 2018

Update API tests to reflect on added PoW parameters and API limits iotaledger/iri-regression#61

Closed

Update API tests to reflect on added COO address property iotaledger/iri-regression#62

Open

Merge branch 'dev' into nodeinfo-remote-pow

19ce269

iotaledger deleted a comment Oct 25, 2018

javadoc for enum, fixed modificationexception

acffd28

iotaledger deleted a comment Oct 26, 2018

This was referenced Oct 27, 2018

Added features to the list of getNodeInfo responses iotaledger/iri-regression#67

Open

Added features array to nodeinfo iotaledger/iota-java#125

Merged

GalRogozinski suggested changes Oct 29, 2018

View reviewed changes

kwek20 added 2 commits October 29, 2018 12:58

Fixed javadoc and improved stream to array

5dbe1da

Remvoed global scope param in favor of config

f2f4680

GalRogozinski reviewed Nov 1, 2018

View reviewed changes

Added features to regression test machine 1, set .array to a new line

a7fe4c4

GalRogozinski reviewed Nov 1, 2018

View reviewed changes

kwek20 added 2 commits November 1, 2018 17:14

removed old import

1578229

Fixed indentation

1957311

iotaledger deleted a comment Nov 1, 2018

GalRogozinski approved these changes Nov 1, 2018

View reviewed changes

GalRogozinski merged commit bf06dfe into iotaledger:dev Nov 1, 2018

jakubcech mentioned this pull request Nov 1, 2018

[Discussion] Checking if a node supports attachToTangle #854

Closed

GalRogozinski mentioned this pull request Dec 22, 2018

Release v1.5.6 #1251

Merged

todofixthis mentioned this pull request Jan 27, 2019

Detect testnet mode automatically if not specified iotaledger/iota.py#24

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Obtain features of a node #1062

Obtain features of a node #1062

kwek20 commented Oct 16, 2018 •

edited

Loading

chrisdukakis commented Oct 17, 2018

jakubcech Oct 17, 2018

jakubcech Oct 17, 2018

jakubcech commented Oct 17, 2018

kwek20 commented Oct 17, 2018

GalRogozinski left a comment

GalRogozinski Oct 29, 2018

kwek20 Oct 29, 2018

GalRogozinski Oct 29, 2018

GalRogozinski Oct 29, 2018

GalRogozinski Oct 29, 2018

GalRogozinski Oct 29, 2018

GalRogozinski left a comment

GalRogozinski Oct 29, 2018

GalRogozinski Nov 1, 2018

Obtain features of a node #1062

Obtain features of a node #1062

Conversation

kwek20 commented Oct 16, 2018 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

chrisdukakis commented Oct 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakubcech commented Oct 17, 2018

kwek20 commented Oct 17, 2018

GalRogozinski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GalRogozinski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwek20 commented Oct 16, 2018 •

edited

Loading