feat: adds a MongoDB connector (closes smallstep/certificates#141) #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a MongoDB connector. A couple of things to note: - To enable transactions the database must a replica set, I made the connection fail if the condition was not met. MongoDB is a document database, thus concepts translate as: bucket/table = collection key = document value = document value Note: mongo will automatically create a collection if a operation is attempted on one that does not exist. For example: if you delete a table, then call list to check for the contents of the table it will be recreated. closes smallstep/certificates#141
|
|
github-actions
bot
added
the
needs triage
hslatman
reviewed
Jan 30, 2024
|
Thank you, @elasticspoon! We've done a first pass of review. |
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
2 times, most recently
from
7652cc6
to
ae85109
Compare
removes use of github/errors package, uses fmt.Errorf instead changes syntax of error messages changes order of context as a parameter makes sure session is passed down where possible renames bucket to collection other minor fixes for review
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
from
ae85109
to
6fdea12
Compare
hslatman
reviewed
Feb 13, 2024
There was a problem hiding this comment.
Thank you for the improvements, @elasticspoon! 🙂
I've done another pass. It may seem like much, but it's mostly many cases of the same thing. Most things are just textual too.
We're currently working on a new version of nosql that changes some things in terms of the exposed interface. It should be available fairly soon. We aim for no / minimal breaking changes, but at this time I can't say for sure what it'll look like. I don't expect big changes to happen to the core of your implementation. It's probably good to await its release and adapt this PR, so that it starts of in a nice way.
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
from
f2fb331
to
b850638
Compare
Co-authored-by: Herman Slatman <[email protected]>
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
from
b850638
to
00983ad
Compare
hslatman
reviewed
Feb 21, 2024
mongo/mongo.go
Outdated
Comment on lines
144
to
146
| if err = session.StartTransaction(txnOptions); err != nil { | ||
| return fmt.Errorf("failed to pending transaction: %w", err) | ||
| } |
There was a problem hiding this comment.
"failed to 'what' pending ..."
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
4 times, most recently
from
b36b3e2
to
515e0c6
Compare
elasticspoon
commented
Feb 22, 2024
Comment on lines
+304
to
+326
| if err := db.CreateTable(op.Bucket); err != nil { | ||
| return abort(ctx, session, fmt.Errorf("failed creating table %s: %w", op.Bucket, err)) | ||
| } | ||
| case database.DeleteTable: | ||
| if err := db.DeleteTable(op.Bucket); err != nil { | ||
| return abort(ctx, session, fmt.Errorf("failed deleting table %s: %w", op.Bucket, err)) | ||
| } | ||
| case database.Get: | ||
| if op.Result, err = db.get(ctx, op.Bucket, op.Key); err != nil { | ||
| return abort(ctx, session, fmt.Errorf("failed getting %s/%s: %w", op.Bucket, op.Key, err)) | ||
| } | ||
| case database.Set: | ||
| if err := db.set(ctx, op.Bucket, op.Key, op.Value); err != nil { | ||
| return abort(ctx, session, fmt.Errorf("failed setting %s/%s: %w", op.Bucket, op.Key, err)) | ||
| } | ||
| case database.Delete: | ||
| if err := db.del(ctx, op.Bucket, op.Key); err != nil { | ||
| return abort(ctx, session, fmt.Errorf("failed deleting %s/%s: %w", op.Bucket, op.Key, err)) | ||
| } | ||
| case database.CmpAndSwap: | ||
| op.Result, op.Swapped, err = db.cmpAndSwap(ctx, op.Bucket, op.Key, op.CmpValue, op.Value) | ||
| if err != nil { | ||
| return abort(ctx, session, fmt.Errorf("failed load-or-store on %s/%s: %w", op.Bucket, op.Key, err)) |
There was a problem hiding this comment.
I think this is better in terms of error message clarity. Errors will now say what operation an Update failed to followed by the reason that operation failed.
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
from
515e0c6
to
74bf56f
Compare
Changes to error syntax
elasticspoon
force-pushed
the
adds-mongodb-connector
branch
from
74bf56f
to
41c3aba
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a MongoDB connector and closes smallstep/certificates#141
Note: To enable transactions the database must a replica set, I made the connection fail if the condition was not met.
I am not sure if this is the best way to go about it. But I am also not sure how often the basic CRUD operations are used outside of transactions.
MongoDB is a document database, thus concepts translate as:
bucket/table = collection
key = document
value = document value
Name of feature:
MongoDB connector
Pain or issue this feature alleviates:
Closes smallstep/certificates#141
Why is this important to the project (if not answered above):
Closes smallstep/certificates#141
Is there documentation on how to use this feature? If so, where?
Implements the database interface
In what environments or workflows is this feature supported?
Same as all the rest of the connectors. Transactions require Mongo to be configured as a replica set.
In what environments or workflows is this feature explicitly NOT supported (if any)?
Not supported in CI tests.
Supporting links/other PRs/issues: