replace default bolt option with sqlite3 option. the story here is that we just need a working out of the box solution, and sqlite3 is just fine for that (actually, likely better than bolt). with sqlite3 supplanting bolt, we mostly have sql databases. so remove redis and then we just have one package that has a `sql` implementation of the `models.Datastore` and lean on sqlx to do query rewriting. this does mean queries have to be formed a certain way and likely have to be ANSI-SQL (no special features) but we weren't using them anyway and our base api is basically done and we can easily extend this api as needed to only implement certain methods in certain backends if we need to get cute. * remove bolt & redis datastores (can still use as mqs) * make sql queries work on all 3 (maybe?) * remove bolt log store and use sqlite3 * shove the FnLog shit into the datastore shit for now (free pg/mysql logs... just for demos, etc, not prod) * fix up the docs to remove bolt references * add sqlite3, sqlx dep * fix up tests & mock stuff, make validator less insane * remove put & get in datastore layer as nobody is using. this passes tests which at least seem like they test all the different backends. if we trust our tests then this seems to work great. (tests `make docker-test-run-with-*` work now too)
1.2 KiB
Contributing to Oracle Functions
We welcome all contributions!
How to contribute
- Fork the repo
- Fix an issue or create an issue and fix it
- Create a Pull Request that fixes the issue
- Sign the CLA
- Good Job! Thanks for being awesome!
Documentation
When creating a Pull Request, make sure that you also update the documentation accordingly.
Most of the times, when making some behavior more explicit or adding a feature, a documentation update is necessary.
You will either update a file inside docs/ or create one. Prefer the former over the latter. If you are unsure, do not hesitate in open the PR with a comment asking for suggestions on how to address the documentation part.
How to build and get up and running
Build
The first time after you fork or after dependencies get updated, run:
make dep
Then after every change, run
make run
to build and run the functions binary. It will start Functions using an embedded sqlite3 database running on port 8080.
Test
make test
Run in Docker
make docker-run
will start Functions inside a Docker container.
Tests in Docker
make docker-test
will test Functions inside a Docker container.