Adding utilities file #1

AYAHASSAN287 · 2025-01-12T18:20:07Z

This PR includes :

1- Adding initial structure of test framework as following

1- tests include 1 test file example_test.go Testsuite "TestSubscribeNodetoTopic" does the following
- Config and create waku node
- Subscribe to default pubsubtopic
- get the ENR
- Stop and Destroy waku node
2- wrappers include wrapper file with APIs to wrap the waku-go internal APIs
3- utilities includes all support files to ease the functionality in wrappers & tests and logs file
4- libs contains waku-go internal APIs which is used directly from nwaku repo
5- nwaku repo is added as submodule in folder src

NOTE: framework will be modified un next task to allow dynamic assignation of parameters when creating new node

fbarbu15

Structure looks good to me
I like how the wrappers are used
What I'm not sure if it exists and we will surely need is logging capabilities. Ideally both test logs (what the test framework is dooing) and also node logs (what waku is logging)

fbarbu15 · 2025-01-13T14:11:30Z

src/framework_design.png

it should be nwaku internal APIs

AYAHASSAN287 · 2025-01-14T11:04:14Z

Structure looks good to me I like how the wrappers are used What I'm not sure if it exists and we will surely need is logging capabilities. Ideally both test logs (what the test framework is dooing) and also node logs (what waku is logging)

Yes I agree . I will add logging module and use it in wrappers & tests

fbarbu15

Thanks Aya, code looks good in most of the parts.
Left some minor comments.
Also @romanzac please review it

fbarbu15 · 2025-01-17T11:50:54Z

src/images/framework_design.png

I think waku internal APIs is better instead of go-waku

What does each arrow mean? not sure I can follow the diagram.
But I agree that go-waku should probably be out of the picture

fbarbu15 · 2025-01-17T11:51:38Z

src/libs/waku.go

do we need this file to be commited?

fbarbu15 · 2025-01-17T11:56:11Z

src/libs/waku_wrappers.go

+	return nil
+}
+
+func StartWakuNodeWithDefaultValues(host string, port int, nodeKey string, enableRelay bool, logLevel string) (*LocalWakuNode, error) {


the function parameters are not used
If it's with default values then probably you don't need no params

can we have some linters that could catch such issues automatically?
@romanzac do you know of such tools in golang?

can we have some linters that could catch such issues automatically? @romanzac do you know of such tools in golang?

Yes, I have used golangci-lint

fbarbu15 · 2025-01-17T11:58:57Z

src/libs/waku_wrappers.go

+		return nil, err
+	}
+
+	fmt.Println("WakuNode created successfully!")


I guess we should use the logger and not print

fbarbu15 · 2025-01-17T11:59:51Z

src/libs/waku_wrappers.go

-		EnableRelay: enableRelay,
-		LogLevel:    logLevel,
+		LocalConfigData: golang.WakuConfig{
+			Host:        utilities.IfEmpty(host, "127.0.0.1"),


I think we should define the defaults/constants into a separate module/file

fbarbu15 · 2025-01-17T12:03:49Z

src/libs/waku_wrappers.go

-func (node *WakuNode) RelayUnsubscribe(pubSubTopic string) error {
-	return node.WakuRelayUnsubscribe(pubSubTopic)
+// Function publishes a message to a pubsub topic.
+


fbarbu15 · 2025-01-17T12:04:18Z

tests/example_test.go

+	"time"
+	"waku-go-bindings-tests/src/libs"
+	"waku-go-bindings-tests/src/utilities"
+	//"github.com/stretchr/testify/assert"


why commented, shouldn't the test contain some assertings?

fbarbu15 · 2025-01-17T12:05:23Z

tests/example_test.go

+		}
+	}()
+
+	utilities.LogDebug("Sleep for 2 seconds")


maybe we should have a utility function called delay that can also do the sleep and log the reasons for the sleep ex
utilities.delay(2 * time.Second, "Sleep for 2 seconds because...")

fbarbu15 · 2025-01-17T12:05:53Z

tests/waku_node.log

this file should eb gitignored

fbarbu15 · 2025-01-17T12:06:36Z

tests/example_test.go

-		NodeKey:     "11d0dcea28e86f81937a3bd1163473c7fbc0a0db54fd72914849bc47bdf78710",
-		EnableRelay: true,
-		LogLevel:    "DEBUG",
+func TestSubscribeNodetoTopic(t *testing.T) {


nice test but would be even nicer if we could have 2 nodes connected between them, one node sends a message and the 2nd one receives it

fbarbu15 · 2025-01-17T12:09:47Z

Also a question, should we use nwaku to build the waku go bindings or https://github.com/waku-org/waku-go-bindings?
cc @gabrielmer

gabrielmer

Thanks so much! 😍

We should integrate https://github.com/waku-org/waku-go-bindings instead of the golang examples in the nwaku repo. As you will see, that repo is much more developed and has its features tested at a high level. I think it will make the work of testing way easier, there's already lots of functionalities developed and examples/tests to use as reference.

Great job so far!

gabrielmer · 2025-01-17T12:35:28Z

src/images/framework_design.png

What does each arrow mean? not sure I can follow the diagram.
But I agree that go-waku should probably be out of the picture

gabrielmer · 2025-01-17T12:37:01Z

README.md

+
+3. **Modify Package Name:**
+   - Navigate to `src/nwaku/example/golang`


We should test the interfaces provided by the https://github.com/waku-org/waku-go-bindings/tree/master repo instead of the golang examples in nwaku

I also created a super simple example of waku-go-bindings integrated into a Go project here

gabrielmer · 2025-01-17T13:45:10Z

src/libs/waku_wrappers.go

I think many of these wrappers won't be necessary once we use waku-go-bindings instead of the example? Maybe I'm missing something, but the wrappers look very similar to existing functions

gabrielmer · 2025-01-17T13:47:19Z

tests/example_test.go

Notice that in https://github.com/waku-org/waku-go-bindings/blob/master/waku/nwaku_test.go there's simple tests for most of the features that can be used as reference

Thanks @gabrielmer I don't think we were aware of this repo, at least I wasn't until today.
Yes, it seems that this already has a lot of stuff implemented, nice!
Should we create tests directly in this repo?

Apologies for the misunderstanding!

Either in that repo or in a separate one are good for me :)) I think it makes sense to have everything in one repo, but if there's any upside of doing it separately then it's also good.

@Ivansete-status @richard-ramos any preferences?

gabrielmer · 2025-01-17T13:54:03Z

Also a question, should we use nwaku to build the waku go bindings or https://github.com/waku-org/waku-go-bindings? cc @gabrielmer

We should use https://github.com/waku-org/waku-go-bindings :)

Let me know if you run into any issues using it! The README explains how to integrate it into a new Go project, and we have a small example of a project in which it's integrated

gabrielmer · 2025-01-17T17:33:41Z

Oh an before I forget! Not sure if Store enters to the scope of the testing, but it currently doesn't work in waku-go-bindings. However, I have a PR open adding some missing things and including a test for Store

So if later we need to add more Store tests, we will be able to use it as a reference. That PR can take some days to be merged because there's a breaking change in nwaku we are introducing and we might need to wait a few days to update their dependent projects. So don't try to use Store until that is merged :))

romanzac · 2025-01-17T12:50:46Z

src/libs/waku_wrappers.go

-	return node.WakuVersion()
+// Function to return formatted contetn topic
+func (localNode *LocalWakuNode) FormatContentTopic(appName string, appVersion int,
+	contentTopicName string,


is it just me or the formating here is off? @romanzac what do you use for code formatting in go?

I'm using JetBrains IDE. Command line is https://go.dev/blog/gofmt.

romanzac · 2025-01-18T04:28:29Z

src/utilities/utilities.go

+		return defaultValue
+	}
+	return value
+}


Great work so far!

Depends how much you would like to learn Go. I would recommend to have a look at generics. It could sometimes save typing:

package utilities func OrDefault[T comparable](val, def T) T { var zero T if val == zero { return def } return val }

Usage:

s := OrDefault("", "default string") i := OrDefault(0, 42)

Interesting book I own myself as well: https://100go.co/

AYAHASSAN287 and others added 7 commits January 12, 2025 20:19

Adding utilities file

c963dc6

restructure repo folders

a30b2eb

Add files via upload

2fb069f

Update README.md

82d33d3

Update README.md

aacd64f

Add default values to wrappers

724c668

Merge remote-tracking branch 'origin/go_wrappers' into go_wrappers

4369740

fbarbu15 self-requested a review January 13, 2025 14:12

fbarbu15 reviewed Jan 13, 2025

View reviewed changes

src/framework_design.png Outdated

Copy link

Collaborator

fbarbu15 Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should be nwaku internal APIs

Add nwaku as submodule

48aaf2e

AYAHASSAN287 and others added 10 commits January 15, 2025 18:06

Make changes in wrappers

fa1bb47

Add log file and use it in wrappers

48348e1

Adding more in wrappers

9d0a657

Add test to subscribe to relay

30e0e8f

Change test name

63c2e97

Add readme file details for the repo

18e3b97

Update README.md

b0bd69d

Update README.md

a0a4b18

Update README.md

3740ef9

Update README.md

7566cbd

AYAHASSAN287 requested a review from fbarbu15 January 17, 2025 10:24

fbarbu15 requested a review from romanzac January 17, 2025 11:57

fbarbu15 requested changes Jan 17, 2025

View reviewed changes

fbarbu15 requested a review from gabrielmer January 17, 2025 12:10

gabrielmer reviewed Jan 17, 2025

View reviewed changes

romanzac approved these changes Jan 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding utilities file #1

Adding utilities file #1

AYAHASSAN287 commented Jan 12, 2025 •

edited

Loading

fbarbu15 left a comment

fbarbu15 Jan 13, 2025

AYAHASSAN287 commented Jan 14, 2025

fbarbu15 left a comment

fbarbu15 Jan 17, 2025

gabrielmer Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

romanzac Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 Jan 17, 2025

fbarbu15 commented Jan 17, 2025

gabrielmer left a comment

gabrielmer Jan 17, 2025

gabrielmer Jan 17, 2025 •

edited

Loading

gabrielmer Jan 17, 2025

gabrielmer Jan 17, 2025

fbarbu15 Jan 17, 2025

gabrielmer Jan 17, 2025

gabrielmer commented Jan 17, 2025

gabrielmer commented Jan 17, 2025

romanzac Jan 17, 2025

romanzac Jan 18, 2025


		3. Modify Package Name:
		- Navigate to `src/nwaku/example/golang`

Adding utilities file #1

Are you sure you want to change the base?

Adding utilities file #1

Conversation

AYAHASSAN287 commented Jan 12, 2025 • edited Loading

fbarbu15 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AYAHASSAN287 commented Jan 14, 2025

fbarbu15 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

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

fbarbu15 commented Jan 17, 2025

gabrielmer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabrielmer Jan 17, 2025 • edited Loading

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

gabrielmer commented Jan 17, 2025

gabrielmer commented Jan 17, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AYAHASSAN287 commented Jan 12, 2025 •

edited

Loading

gabrielmer Jan 17, 2025 •

edited

Loading