Skip to content

refactor(bindings/C): Alter naming convention for consistency#3282

Merged
Xuanwo merged 18 commits intoapache:mainfrom
xyjixyjixyji:chore_remove_blocking
Oct 21, 2023
Merged

refactor(bindings/C): Alter naming convention for consistency#3282
Xuanwo merged 18 commits intoapache:mainfrom
xyjixyjixyji:chore_remove_blocking

Conversation

@xyjixyjixyji
Copy link
Copy Markdown
Contributor

@xyjixyjixyji xyjixyjixyji commented Oct 14, 2023

We remove blocking for consistency and will add async support in the future, where we will add async keyword to the API.

This PR also rename the opendal_reader_read() first argument from self to reader, since self is not a C convention.

@github-actions github-actions Bot added the releases-note/chore The PR has a title that begins with "chore" or changes other small things that hard to tell label Oct 14, 2023
@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 14, 2023

Relate #3281

@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 14, 2023

Oh, I notice this probably could break the swift, go and zig as well, @Xuanwo . Would you please take a look at that when you got time?

jiaoew1991
jiaoew1991 reviewed Oct 14, 2023
View reviewed changes
Comment thread bindings/c/include/opendal.h Outdated
@jiaoew1991
Copy link
Copy Markdown
Contributor

jiaoew1991 commented Oct 14, 2023

Oh, I notice this probably could break the swift, go and zig as well, @Xuanwo . Would you please take a look at that when you got time?

BTW c binding is used by other language bindings, does it ready to release? 🤔

@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 14, 2023

BTW c binding is used by other language bindings, does it ready to release? 🤔

Hmm I think the major functionalities are already there, list, read, write. But there are still many other functionalities that we do not support.

There are a couple of things to consider

  1. Does C binding always stay sync with other bindings? => For this question I think the answer is no. I would say other bindings that depend on C binding release with a certain version of C binding.
  2. Do we need to align all functionalities that are implemented by other released bindings?

If the answer to the second question is yes, we may need to start figuring out what we are missing.
If the answer is no, i.e. we implement them in the future release, I think the C binding is ready for a release.

In any way this needs some discussions, but it is good to mention this issue up since we do need to make a release soon 🤣

@Xuanwo Xuanwo changed the title chore(bindings/C): Remove blocking from API names for consistency refactor(bindings/C): Remove blocking from API names for consistency Oct 14, 2023
@github-actions github-actions Bot added the releases-note/refactor The PR does a refactor on code or has a title that begins with "refactor" label Oct 14, 2023
@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Oct 14, 2023

Does C binding always stay sync with other bindings?

For now, YES. For always, I don't know either. It depends on the future development of OpenDAL.

Pin exact tags of C binding for other binding is complex and makes the development work much harder.

Xuanwo
Xuanwo reviewed Oct 14, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

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

I'm willing to help address the issues for zig/go/swift. However, I would prefer to address the following comments first:

Comment thread bindings/c/include/opendal.h Outdated
Comment thread bindings/c/include/opendal.h Outdated
Comment thread bindings/c/include/opendal.h Outdated
Comment thread bindings/c/include/opendal.h Outdated
Comment thread bindings/c/include/opendal.h Outdated
Comment thread bindings/c/include/opendal.h Outdated
@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Oct 14, 2023

This is a breaking change, it's better to record it in C binding's upgrade.md.

@Xuanwo Xuanwo removed the releases-note/chore The PR has a title that begins with "chore" or changes other small things that hard to tell label Oct 14, 2023
@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 14, 2023 •
edited
Loading

This is a breaking change, it's better to record it in C binding's upgrade.md.

I will address these issues later today. Thanks for the review.

@jiaoew1991
Copy link
Copy Markdown
Contributor

jiaoew1991 commented Oct 14, 2023

Looking forward to the API stabilizing, so that I can continue with the integration work of Milvus. 😄

Xuanwo
Xuanwo reviewed Oct 16, 2023
View reviewed changes
Comment thread bindings/c/README.md
@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Oct 19, 2023

Looking forward to the API stabilizing, so that I can continue with the integration work of Milvus. 😄

I believe this PR will address most of the API flavor issues.

@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 19, 2023

This seems to be a PR that is related to many things, I will mark this as draft and make this ready for review after some polishments.

@xyjixyjixyji xyjixyjixyji marked this pull request as draft October 19, 2023 04:20
Xuanwo added 4 commits October 20, 2023 17:27
@Xuanwo
Merge remote-tracking branch 'origin/main' into chore_remove_blocking
8cc01da
@Xuanwo
refactor
4dcdb14 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
polish code
9b2d7c5 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
Fix doc
39fe4a9 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Oct 20, 2023

cc @Ji-Xinyou, would you like to take a review? Thanks!

Xuanwo added 3 commits October 20, 2023 18:26
@Xuanwo
format
5460a34 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
Fix go
bd4599a 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
Fix zig
290eda2 
Signed-off-by: Xuanwo <github@xuanwo.io>
Xuanwo added 2 commits October 20, 2023 18:33
@Xuanwo
fix swift
ddb1253 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
Add upgrade docs
5be79ba 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo Xuanwo marked this pull request as ready for review October 20, 2023 10:37
@Xuanwo Xuanwo requested a review from PsiACE as a code owner October 20, 2023 10:37
@Xuanwo
Fix
8396c43 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Oct 20, 2023

cc @jiaoew1991, I have added an upgrade.md docs for C binding, would you like to take a look?

https://github.com/apache/incubator-opendal/blob/8396c4398af9281cbcbc4258e8773b05e85e75cf/bindings/c/upgrade.md

@Xuanwo
polish
97f7051 
Signed-off-by: Xuanwo <github@xuanwo.io>
@Xuanwo Xuanwo changed the title refactor(bindings/C): Remove blocking from API names for consistency refactor(bindings/C): Alter naming convention for consistency Oct 20, 2023
@Xuanwo
Make clippy happy
a5bfa86 
Signed-off-by: Xuanwo <github@xuanwo.io>
@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 20, 2023

cc @jiaoew1991, I have added an upgrade.md docs for C binding, would you like to take a look?

https://github.com/apache/incubator-opendal/blob/8396c4398af9281cbcbc4258e8773b05e85e75cf/bindings/c/upgrade.md

Added commits look perfect to me.

@Xuanwo Xuanwo mentioned this pull request Oct 21, 2023
Merged
@Xuanwo
Copy link
Copy Markdown
Member

Xuanwo commented Oct 21, 2023

cc @Ji-Xinyou, do you think this PR is good to go?

@Xuanwo
Format
b933f70 
Signed-off-by: Xuanwo <github@xuanwo.io>
@xyjixyjixyji
Copy link
Copy Markdown
Contributor Author

xyjixyjixyji commented Oct 21, 2023

cc @Ji-Xinyou, do you think this PR is good to go?

Yes, I think this PR is ready :)

@Xuanwo Xuanwo merged commit c7bfe23 into apache:main Oct 21, 2023
@xyjixyjixyji xyjixyjixyji mentioned this pull request Oct 21, 2023
Closed
@silver-ymz silver-ymz mentioned this pull request Nov 7, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Xuanwo Xuanwo Xuanwo approved these changes

@PsiACE PsiACE Awaiting requested review from PsiACE

+1 more reviewer

@jiaoew1991 jiaoew1991 jiaoew1991 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

releases-note/refactor The PR does a refactor on code or has a title that begins with "refactor"

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@xyjixyjixyji @jiaoew1991 @Xuanwo