feat(db): add repository package for persistence #170
Conversation
pkg/repository/repository.go
Outdated
| } | ||
|
|
||
| // Factory pattern to create new Database | ||
| func Factory(databaseImplementation string) (Database, error) { |
There was a problem hiding this comment.
You probably want to define a database enum instead of using a string
There was a problem hiding this comment.
For databases that are backed by a provided service, i.e. Redis (or anything not in memory or a persistent volume), you will need to pass the url, host, port, user, pass, etc... I think it would be worth creating a config struct in the repository package for these values and passing that to the factory too. All keys would be optional and you would rely on code documentation to state which keys are required for each implementation.
You could include the databaseImplementation value as part of this config struct too.
Depending on the flexibility required, you could create a config struct based on a free-form map[string]string. This wouldn't force you to pre-define the keys required for a Database instance, but instead you would rely on database implementations clearly documenting the required key-value config entries required. An example of this is here: https://matthewbrown.io/2016/01/23/factory-pattern-in-golang
pkg/repository/repository.go
Outdated
| package repository | ||
|
|
||
| // Database abstraction | ||
| type Database interface { |
There was a problem hiding this comment.
You might want to call it KVStore or something like that. It's not really a "database".
There was a problem hiding this comment.
You might also consider including mocked implementations of this interface to encourage that testing pattern.
Codecov Report
@@ Coverage Diff @@
## main #170 +/- ##
==========================================
- Coverage 76.12% 75.00% -1.13%
==========================================
Files 5 5
Lines 1001 1012 +11
==========================================
- Hits 762 759 -3
- Misses 210 218 +8
- Partials 29 35 +6
|
glimchb
force-pushed
the
repo
branch
2 times, most recently
from
a510fe3
to
19cf57d
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
glimchb
force-pushed
the
repo
branch
3 times, most recently
from
c29493a
to
be89c12
Compare
glimchb
force-pushed
the
repo
branch
2 times, most recently
from
48779ac
to
fbabfc8
Compare
cmd/main.go
Outdated
| @@ -28,6 +29,12 @@ func main() { | |||
| if err != nil { | |||
| log.Fatalf("failed to listen: %v", err) | |||
| } | |||
| db, err := repository.Factory("memory") | |||
There was a problem hiding this comment.
I assume the Database interface (or db instance here) would be passed to subsequent services, right? Allowing you to pass a mock database to those services during testing.
This is not full implementation yet, just the start Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>
| @@ -0,0 +1,38 @@ | |||
| // SPDX-License-Identifier: Apache-2.0 | |||
| // Copyright (c) 2022-2023 Dell Inc, or its subsidiaries. | |||
There was a problem hiding this comment.
moved to a separate PR #267
| // SPDX-License-Identifier: Apache-2.0 | ||
| // Copyright (c) 2022-2023 Dell Inc, or its subsidiaries. | ||
|
|
||
| // Package repository is the database abstraction implementing repository design pattern |
There was a problem hiding this comment.
moved to a separate PR #267
This is not full implementation yet, just the start
Signed-off-by: Boris Glimcher Boris.Glimcher@emc.com