Bump Cloudflare-Go #2298

dmizelle · 2021-09-15T22:55:32Z

Description
In order for us to use some new features provided by cloudflare-go for
the cloudflare provider (mainly around Cloudflare Access, etc.) we need
to bump the version of cloudflare-go used.

The only real change that needed to be done was that the Proxied field
on cloudflare.DNSRecord structs changed from bool -> *bool.
Upstream did this because in certain cases, a user could not flip from
proxied -> DNS only (the library omitted sending proxied = false to
the API)

Other decent change was that most methods exported by the library now
require context.Context to be passed in. Was rather trivial to get up.

cloudflare/cloudflare-go#595

Signed-off-by: Devon Mizelle [email protected]

Checklist

Unit tests updated
[N/A] End user documentation updated

dmizelle · 2021-09-15T22:56:28Z

provider/cloudflare/cloudflare_test.go

-					TTL:     120,
-					Content: "1.2.3.4",
-					Proxied: test.RecordsAreProxied,
+		t.Run(test.Name, func(t *testing.T) {


Decided to do this as it was hard to figure out what test case was failing.

dmizelle · 2021-09-15T22:57:20Z

provider/cloudflare/cloudflare.go

+// see: https://github.com/cloudflare/cloudflare-go/pull/595
+
+// ProxyEnabled is a pointer to a bool true showing the record should be proxied through cloudflare
+var ProxyEnabled *bool = &[]bool{true}[0]


tbh im not really happy about this message thing of creating a slice of bool, setting first element to true, and getting that element.

i wish there was a better way to do this, and am 500% all ears.

👋🏻 WDYT about creating a helper function which return a bool pointer? I think this used in a lot of packages (IIRC aws-sdk-go definitely has this), it's a bit more readable IMHO.

func Bool() *bool { b := true return &b }

it should be also proxyEnabled.

dmizelle · 2021-09-15T23:54:31Z

Hm, this breaks when doing local testing unfortunately:

INFO[0000] Created Kubernetes client https://0.0.0.0:42077
FATA[0000] unexpected pagination options passed to functions that handle pagination automatically

will look further

dmizelle · 2021-09-16T00:52:09Z

Looks like they made ListZonesContext not take pagination anymore, and the function itself does the pagination for you:

https://github.com/cloudflare/cloudflare-go/blob/v0.22.0/zone.go#L441-L443

Introduced in cloudflare/cloudflare-go#674

Should be ready for review.

In order for us to use some new features provided by cloudflare-go for the cloudflare provider (mainly around Cloudflare Access, etc.) we need to bump the version of cloudflare-go used. The only real change that needed to be done was that the `Proxied` field on `cloudflare.DNSRecord` structs changed from `bool` -> `*bool`. Upstream did this because in certain cases, a user could not flip from proxied -> DNS only (the library omitted sending `proxied = false` to the API) Other decent change was that most methods exported by the library now require `context.Context` to be passed in. Was rather trivial to get up. cloudflare/cloudflare-go#595 Signed-off-by: Devon Mizelle <[email protected]>

njuettner

Small nits, but lgtm.

njuettner · 2021-10-14T07:26:01Z

provider/cloudflare/cloudflare.go

+// see: https://github.com/cloudflare/cloudflare-go/pull/595
+
+// ProxyEnabled is a pointer to a bool true showing the record should be proxied through cloudflare
+var ProxyEnabled *bool = &[]bool{true}[0]


👋🏻 WDYT about creating a helper function which return a bool pointer? I think this used in a lot of packages (IIRC aws-sdk-go definitely has this), it's a bit more readable IMHO.

func Bool() *bool { b := true return &b }

njuettner · 2021-10-14T07:27:40Z

provider/cloudflare/cloudflare.go

+// see: https://github.com/cloudflare/cloudflare-go/pull/595
+
+// ProxyEnabled is a pointer to a bool true showing the record should be proxied through cloudflare
+var ProxyEnabled *bool = &[]bool{true}[0]


it should be also proxyEnabled.

njuettner · 2021-10-14T07:29:11Z

provider/cloudflare/cloudflare.go

+var ProxyEnabled *bool = &[]bool{true}[0]
+
+// ProxyDisabled is a pointer to a bool false showing the record should not be proxied through cloudflare
+var ProxyDisabled *bool = &[]bool{false}[0]


Can we use !proxyEnabled instead or do you think it's more readable having proxyDisabled?

i think its more readable/explicit this way

njuettner · 2021-10-14T07:32:54Z

provider/cloudflare/cloudflare.go

@@ -177,24 +186,20 @@ func (p *CloudFlareProvider) Zones(ctx context.Context) ([]cloudflare.Zone, erro
 	}

 	log.Debugln("no zoneIDFilter configured, looking at all zones")
-	for {
-		zonesResponse, err := p.Client.ListZonesContext(ctx, cloudflare.WithPagination(p.PaginationOptions))


Is there no pagination needed anymore? We had to implement it if you'd have more than x zones in Cloudflare otherwise it wouldn't change all DNS zones.

Yep! See #2298 (comment)

Makes it easier for us :)

njuettner · 2021-10-14T07:36:46Z

go.mod

@@ -17,7 +17,7 @@ require (
 	github.com/aliyun/alibaba-cloud-sdk-go v1.61.357
 	github.com/aws/aws-sdk-go v1.40.38
 	github.com/bodgit/tsig v0.0.2
-	github.com/cloudflare/cloudflare-go v0.13.2
+	github.com/cloudflare/cloudflare-go v0.22.0


also can we bump this to 0.25.0? I saw dependabot wanted to update it.

* Bump cloudflare-go to 0.25.0 * Use a function for pointer booleans rather than hardcoding it.

dmizelle · 2021-10-18T19:48:05Z

hey @njuettner -- thanks for the review. updated with a new commit.

njuettner

/lgtm

k8s-ci-robot · 2021-12-17T09:27:37Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dmizelle, njuettner

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [njuettner]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 15, 2021

k8s-ci-robot requested review from Raffo and seanmalloy September 15, 2021 22:55

dmizelle commented Sep 15, 2021

View reviewed changes

k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Sep 29, 2021

Devon Mizelle added 3 commits September 30, 2021 21:30

ListZonesContext no longer takes paginationOptions

0c42582

go.sum update

369376f

dmizelle force-pushed the mine/bump-cloudflare-go branch from a4edf79 to 369376f Compare October 1, 2021 01:35

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 1, 2021

njuettner reviewed Oct 14, 2021

View reviewed changes

njuettner self-assigned this Oct 14, 2021

njuettner reviewed Oct 14, 2021

View reviewed changes

njuettner mentioned this pull request Oct 18, 2021

Cloudflare wildcard records in enterprise plan #2354

Closed

2 tasks

PR Comment Fixes

d1d14d3

* Bump cloudflare-go to 0.25.0 * Use a function for pointer booleans rather than hardcoding it.

njuettner approved these changes Dec 17, 2021

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 17, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 17, 2021

k8s-ci-robot merged commit 58bc1df into kubernetes-sigs:master Dec 17, 2021

arturhoo mentioned this pull request Feb 3, 2023

cloudflare - customizable pagination when listing DNS records #3364

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump Cloudflare-Go #2298

Bump Cloudflare-Go #2298

dmizelle commented Sep 15, 2021

dmizelle Sep 15, 2021

dmizelle Sep 15, 2021

njuettner Oct 14, 2021

njuettner Oct 14, 2021

dmizelle commented Sep 15, 2021

dmizelle commented Sep 16, 2021 •

edited

Loading

njuettner left a comment

njuettner Oct 14, 2021

njuettner Oct 14, 2021

njuettner Oct 14, 2021

dmizelle Oct 18, 2021

njuettner Oct 14, 2021

dmizelle Oct 18, 2021

njuettner Oct 14, 2021

dmizelle commented Oct 18, 2021

njuettner left a comment

k8s-ci-robot commented Dec 17, 2021

Bump Cloudflare-Go #2298

Bump Cloudflare-Go #2298

Conversation

dmizelle commented Sep 15, 2021

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

dmizelle commented Sep 15, 2021

dmizelle commented Sep 16, 2021 • edited Loading

njuettner 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

dmizelle commented Oct 18, 2021

njuettner left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 17, 2021

dmizelle commented Sep 16, 2021 •

edited

Loading