issue: gocql import results in discrepancy due to replace not cascading to users of magic

[Lutherwaves]

Check Existing Issues

• I have searched the existing issues and discussions.

Expected Behavior

Expected behavior is for the correct upstream dependencies to automatically be pulled using go's built package manager.

Actual Behavior

Users of magic must explicitly set replace github.com/gocql/gocql => github.com/scylladb/gocql v1.17.0

Steps to Reproduce

1. go get github.com/tink3rlabs/magic inside a service
2. Make sure the service go.mod doesn't have the gocql replace directive
3. go build will result in

# github.com/scylladb/gocqlx/v3
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:21:20: s.Session.Batch undefined (type *gocql.Session has no field or method Batch)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:28:20: s.Session.Batch undefined (type *gocql.Session has no field or method Batch)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:35:20: s.Session.Batch undefined (type *gocql.Session has no field or method Batch)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:42:17: b.Batch.GetRequestTimeout undefined (type *gocql.Batch has no field or method GetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:48:10: b.Batch.SetRequestTimeout undefined (type *gocql.Batch has no field or method SetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:57:10: b.Batch.SetHostID undefined (type *gocql.Batch has no field or method SetHostID)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:136:28: cannot use cons (variable of uint16 type gocql.Consistency) as gocql.SerialConsistency value in argument to b.Batch.SerialConsistency
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:154:17: q.Query.GetRequestTimeout undefined (type *gocql.Query has no field or method GetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:160:10: q.Query.SetRequestTimeout undefined (type *gocql.Query has no field or method SetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:169:10: q.Query.SetHostID undefined (type *gocql.Query has no field or method SetHostID)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:169:10: too many errors

Logs & Screenshots

github.com/scylladb/gocqlx/v3

../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:21:20: s.Session.Batch undefined (type *gocql.Session has no field or method Batch)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:28:20: s.Session.Batch undefined (type *gocql.Session has no field or method Batch)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:35:20: s.Session.Batch undefined (type *gocql.Session has no field or method Batch)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:42:17: b.Batch.GetRequestTimeout undefined (type *gocql.Batch has no field or method GetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:48:10: b.Batch.SetRequestTimeout undefined (type *gocql.Batch has no field or method SetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:57:10: b.Batch.SetHostID undefined (type *gocql.Batch has no field or method SetHostID)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/batchx.go:136:28: cannot use cons (variable of uint16 type gocql.Consistency) as gocql.SerialConsistency value in argument to b.Batch.SerialConsistency
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:154:17: q.Query.GetRequestTimeout undefined (type *gocql.Query has no field or method GetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:160:10: q.Query.SetRequestTimeout undefined (type *gocql.Query has no field or method SetRequestTimeout)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:169:10: q.Query.SetHostID undefined (type *gocql.Query has no field or method SetHostID)
../../go/pkg/mod/github.com/scylladb/gocqlx/v3@v3.0.4/queryx.go:169:10: too many errors

Additional Information

No response

[Lutherwaves]

@ayashjorden please check

[ayashjorden]

This is due to how Scylladb forked gocql, scylladb/gocql declares itself like gocql/gocql, overriding apache's gocql.
This is why the additional line in go.mod is required.

go: github.com/tink3rlabs/magic/storage imports
        github.com/scylladb/gocql: github.com/scylladb/gocql@v1.17.0: parsing go.mod:
        module declares its path as: github.com/gocql/gocql
                but was required as: github.com/scylladb/gocql

There are ways to overcome this, but it'll make the code spaghetti-hell.

[deanefrati]

@ayashjorden i'm not sure how to fix it though... my services are currently broken and can't build due to it what do i do to fix it?

[Lutherwaves]

@ayashjorden i'm not sure how to fix it though... my services are currently broken and can't build due to it what do i do to fix it?

@deanefrati the only way is to add 'replace github.com/gocql/gocql => github.com/scylladb/gocql v1.17.0' in the go.mod of your services manually. I would prefer we find a permanent fix as well.

Happy new year

[deanefrati]

No that's not a viable solution, i have dozens of repos at this point across multiple orgs using this library. Adding a manual replace in each is not feasible for me. I'm going to revert this feature until we come up with a better way. I can't stay broken.

[Lutherwaves]

No that's not a viable solution, i have dozens of repos at this point across multiple orgs using this library. Adding a manual replace in each is not feasible for me. I'm going to revert this feature until we come up with a better way. I can't stay broken.

Agreed, raised the bug to track the issue, feel free to revert meanwhile.

[deanefrati]

See #131 I commented out the relevant parts instead of fully reverting it so it will be easier to work on a permanent fix while keeping users functioning.