Add version information to API #61

dhanusaputra · 2023-03-13T02:34:24Z

close #47

coveralls · 2023-03-13T02:36:32Z

Coverage: 78.276% (+1.1%) from 77.127% when pulling 2ca9f89 on dhanusaputra:add-version-info into ee4158d on roc-streaming:main.

gavv

Thanks for PR! A few minor comments

roc/version.go

roc/version_test.go

roc/version.go

gavv · 2023-03-22T15:33:15Z

roc/version.go

+			Patch: uint64(cVersion.patch),
+		}
+
+		if info, ok := debug.ReadBuildInfo(); ok {


After reading your comment #61 (comment) I realized that debug.ReadBuildInfo() likely will return the version of main go module, not the version of module from which it is called.

i.e. if user program foo uses roc, ReadBuildInfo() will return version of foo, not version of roc.

Could you please check if this is true? If yes, then ReadBuildInfo is not suitable for us :/

I see the following alternative solution:

hard-code bindings version in source code (like, const bindingsVersion = "1.2.3")

add CI check that runs only for tag (i.e. v*) that verifies, that version in source code and version in git tag are identical

We'll need to update hard-coded version in source code each release. If we forget to do so, CI will notify us.

We use similar approach in roc-droid:

https://github.com/roc-streaming/roc-droid/blob/main/.github/workflows/build.yaml#L40

https://github.com/roc-streaming/roc-droid/blob/main/.github/workflows/build.yaml#L61-L62

https://github.com/roc-streaming/roc-droid/blob/main/app/build.gradle#L18

instead of notify us via CI, maybe can try push the newer version

seems need to give permission to github actions first before it can push some changes
so updated to check only

instead of notify us via CI, maybe can try push the newer version

What do you mean by pushing new version?

gavv · 2023-03-23T18:50:30Z

BTW welcome to matrix chat! https://roc-streaming.org/toolkit/docs/about_project/contacts.html

roc/version.go

Asalle · 2023-03-25T08:37:25Z

Amazing job! It would make it even better if you included some motivation / closes #XX in the commit message to document it a bit more.

Asalle · 2023-03-25T08:41:27Z

roc/version_test.go

+	"github.com/stretchr/testify/require"
+)
+
+func TestVersion(t *testing.T) {


Great test, although it does only test a successful path. I can see that the way Version func is implemented you cannot really inject any test strings into it and test failures here. Have you thought about decoupling it to make it possible? There are a lot of moving parts in Version and it can crap out in e. g. lines 40, 47, 51, 52 and 53. I am not sure if it is vital, but I would suggest it.

Have you thought about decoupling it to make it possible?

yes already thought about this, but seems ok to me to ignore and try to return as much as possible instead of returning error

There are a lot of moving parts in Version and it can crap out in e. g. lines 40, 47, 51, 52 and 53. I am not sure if it is vital, but I would suggest it.

yes those lines can fail when parsing invalid bindingsVersion
let me try add 1 unit test to check whether the bindingsVersion is valid or not so we can check it early in unit test

yes already thought about this, but seems ok to me to ignore and try to return as much as possible instead of returning error

In general, I would not think it's ok to do it, but I can see your motivation, because Version returns {0,0,0} in case of error anyway. Let's see how that discussion plays out, so depending on what we decide, you would leave this func as is or rewrite it a bit to decouple getting the version from C and parsing it to allow for more modularity and testability.

let me try add 1 unit test to check whether the bindingsVersion is valid or not so we can check it early in unit test

I like this idea. User interface is simpler (no need to check for errors from roc.Version), and at the same time our test suite guarantees that failures are not possible (by validating hard-coded version).

The only downside is that the test duplicates parsing logic. If we update version.go and forget version_test.go, then the test's validation may become irrelevant.

So I'd suggest to refactor it to reuse parsing code. One way to do it:

extract private function parseVersion that accepts string, returns version triple, or panics on invalid string format

in roc.Version, use parseVersion

in tests, check that:

parseVersion works on valid input

parseVersion panics on invalid input

parseVersion works in hard-coded bindingsVersion

+1 from me, @Asalle feel free to resolve this

Asalle · 2023-03-25T20:22:33Z

roc/version_test.go

+}
+
+func Test_bindingsVersion(t *testing.T) {
+	bvs := strings.SplitN(bindingsVersion, ".", 3)


Thanks for the update! Does it pass locally for you? I'm not sure where does the var bindingsVersion come from, and on the CI it this test seems to be skipped. I haven't run it locally, let me try it later.

Does it pass locally for you?

yes

I'm not sure where does the var bindingsVersion come from, and on the CI it this test seems to be skipped

it's from latest release, it's skipped because need to push changes with tag

@Asalle see also this #61 (comment)

I originally suggested to use ReadBuildInfo, then we realized that it's not suitable for libs, only for main go module; thus I suggested to hard-code version and in CI step for git tag check that the hard-coded version matches the latest git tag

It means that we'll have to update hard-coded version each release, manually (and CI for release will fail if we forget)

We came to this approach in roc-droid and openfec. I don't like it too much, but I just don't have better ideas. Maybe you have some?

I remember injecting an env var during build like so, with ldflags, didn't try it with libs though, should work with go build, right? Worth a try! Seems like you can inject that stuff into packages as well, not just main.

Discussion moved to chat

roc/version.go

.github/workflows/build.yaml

roc/version_test.go

gavv · 2023-03-28T14:05:12Z

Added 3 minor comments, otherwise looks fine. Waiting for review from Asa.

gavv

LGTM

Asalle

Again, amazing job and thanks for your contribution!

gavv reviewed Mar 13, 2023

View reviewed changes

roc/version.go Outdated Show resolved Hide resolved

roc/version.go Outdated Show resolved Hide resolved

roc/version.go Outdated Show resolved Hide resolved

roc/version_test.go Outdated Show resolved Hide resolved

gavv added the needs revision Pull request should be revised by its author label Mar 13, 2023

dhanusaputra requested a review from gavv March 14, 2023 11:29

gavv added ready for review Pull request can be reviewed and removed needs revision Pull request should be revised by its author labels Mar 15, 2023

gavv reviewed Mar 22, 2023

View reviewed changes

gavv added needs revision Pull request should be revised by its author and removed ready for review Pull request can be reviewed labels Mar 22, 2023

dhanusaputra added 9 commits March 24, 2023 13:59

Add version information to API

7b9aa87

fix review

ee4aaa4

fix review

374a201

test

7eb2d89

fix test

a307ec2

test

6f4682e

test

d80513e

test

af4a377

test

44c20ba

dhanusaputra force-pushed the add-version-info branch from 81e8f36 to 44c20ba Compare March 24, 2023 07:00

dhanusaputra added 10 commits March 24, 2023 14:10

test

a2630ea

test

de81ebd

test

330fde4

test

f341cfb

test

4aaf0b8

test

c4b6d07

test

35e4b21

test

369c9b8

test

3c5212e

test

f6d2281

clean

8fd69df

dhanusaputra requested a review from gavv March 24, 2023 08:53

gavv added ready for review Pull request can be reviewed and removed needs revision Pull request should be revised by its author labels Mar 24, 2023

Asalle reviewed Mar 25, 2023

View reviewed changes

roc/version.go Show resolved Hide resolved

Asalle reviewed Mar 25, 2023

View reviewed changes

closes roc-streaming#47 fix review

9877df2

dhanusaputra requested review from Asalle and removed request for gavv March 25, 2023 17:21

Asalle reviewed Mar 25, 2023

View reviewed changes

Asalle added needs revision Pull request should be revised by its author and removed ready for review Pull request can be reviewed labels Mar 25, 2023

gavv reviewed Mar 27, 2023

View reviewed changes

roc/version.go Outdated Show resolved Hide resolved

gavv reviewed Mar 27, 2023

View reviewed changes

.github/workflows/build.yaml Outdated Show resolved Hide resolved

dhanusaputra added 2 commits March 28, 2023 15:13

close roc-streaming#47 fix review

7c99544

close roc-streaming#47 rename

2ca9f89

gavv added ready for review Pull request can be reviewed and removed needs revision Pull request should be revised by its author labels Mar 28, 2023

gavv reviewed Mar 28, 2023

View reviewed changes

roc/version_test.go Outdated Show resolved Hide resolved

gavv reviewed Mar 28, 2023

View reviewed changes

roc/version_test.go Outdated Show resolved Hide resolved

gavv reviewed Mar 28, 2023

View reviewed changes

roc/version_test.go Outdated Show resolved Hide resolved

gavv requested a review from Asalle March 28, 2023 14:05

close roc-streaming#47 fix review

5c78e2c

gavv approved these changes Mar 29, 2023

View reviewed changes

Asalle approved these changes Apr 2, 2023

View reviewed changes

Asalle merged commit ec43d2b into roc-streaming:main Apr 2, 2023

gavv removed the ready for review Pull request can be reviewed label May 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add version information to API #61

Add version information to API #61

dhanusaputra commented Mar 13, 2023

coveralls commented Mar 13, 2023 •

edited

Loading

gavv left a comment

gavv Mar 22, 2023

dhanusaputra Mar 24, 2023

dhanusaputra Mar 24, 2023

gavv Mar 27, 2023

gavv commented Mar 23, 2023

Asalle commented Mar 25, 2023

Asalle Mar 25, 2023

dhanusaputra Mar 25, 2023

Asalle Mar 25, 2023

gavv Mar 27, 2023 •

edited

Loading

gavv Mar 28, 2023

Asalle Mar 25, 2023

dhanusaputra Mar 27, 2023

gavv Mar 27, 2023

Asalle Apr 2, 2023

gavv Apr 2, 2023

gavv commented Mar 28, 2023 •

edited

Loading

gavv left a comment

Asalle left a comment

Add version information to API #61

Add version information to API #61

Conversation

dhanusaputra commented Mar 13, 2023

coveralls commented Mar 13, 2023 • edited Loading

gavv 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

gavv commented Mar 23, 2023

Asalle commented Mar 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gavv Mar 27, 2023 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gavv commented Mar 28, 2023 • edited Loading

gavv left a comment

Choose a reason for hiding this comment

Asalle left a comment

Choose a reason for hiding this comment

coveralls commented Mar 13, 2023 •

edited

Loading

gavv Mar 27, 2023 •

edited

Loading

gavv commented Mar 28, 2023 •

edited

Loading