Integrate CouchDB

[lmarschall]

Hey @Arkensor,

really appreciate this framework, I'm currently also thinking about a good persistence solution for the Enfusion engine and stumbled across the NOSQL CouchDB, which seems to be a great fit, because it does support HTTP calls directly which comes out of the box in the Enfusion engine now. If you don't mind, I would like to start implementing a CouchDB driver for this framework.

Cheers,

Lukas

[Arkensor]

Hey @lmarschall,

thank you for looking into this framework. I am currently writing an HTTP base driver that integrates with MongoDB as a test subject. I have discovered a few things I need to do differently in the query building so external APIs have all the info needed for complex query evaluation. I do not know yet when it's ready and it's too heavy WIP to push anything because I change everything every couple of hours >.> Maybe by the end of next week or so I might have it sorted out (even if performance is not the best then maybe). There are some caveats with using the HTTP client which you can save yourself from getting stuck on by waiting a little bit to see how I did in my basic implementation. But some updates to this will make their way into AR soon.

Single insert/delete/get by id is easy, but complex query evaluation is more difficult. You are of course free to say you only want to support the basics that are needed for e.g. the built-on-top persistency framework but a if you have experience with it and are looking maybe for a little challenge too a full implementation would of course be neat.

I am not sure how couch db handles access but keep in mind that we do not have any header params and can not even set the content type, so right now we are forced to either use a proxy to make "proper" requests to the "real" endpoint or configure e.g. couchdb in a way to accept www-form-urlencoded body data.

[lmarschall]

Hey @Arkensor,

sounds good, there is no need to hurry with your implementation. I just recently started to adopt myself with the Enfusion Engine, departing from SQF. Today I've implemented the basic CRUD implementations, here is the code to create a document:

CreateData createData = new CreateData(); // JsonApiStructure
createData.title = "There is Nothing Left to Lose";
createData.artist = "Foo Fighters";
createData.Pack();
Print(createData.AsString());
string contextURL = "http://admin:admin@127.0.0.1:5984/enfusion-data/";
RestContext context = GetGame().GetRestApi().GetContext(contextURL);
context.PUT(m_callbackExample, uuid, createData.AsString());

I'm still trying to wrap my head around the async await functionality in the Enfusion Engine, so it will take some time until I'm ready to produce some valid code :) I'll keep myself updated with this repo 👍

[Arkensor]

Hey @lmarschall

after lots of trial and error on the design, I was able to pretty much get everything working with MongoDB that I hoped for. The 0.9.10 or 0.9.11 update will make the RestApi script API even more useful (fixing the _now variants, allowing for blocking calls - especially useful for unit testing. Also adding the ability to set a few headers ... finally).

But the current prototype works out fine so far so maybe it will be interesting to you to see what I did there:

• EDF_WebProxyDbDriverBase.c
• https://github.com/Arkensor/EnfusionDatabaseFramework.Drivers.WebProxy.Core
• https://github.com/Arkensor/EnfusionDatabaseFramework.Drivers.WebProxy.MongoDB

[lmarschall]

Hey @Arkensor

thank you very much for the heads up. I'm very happy they finally got the _now endpoints working, I was following your ticket, https://feedback.bistudio.com/T166390 and was hoping to see it resolved. My current time schedule is pretty tight, but I hope to find some spare time over the weekend to take a look at your new implementation 👍

[lmarschall]

Hey @Arkensor

one minor question, I was just looking at your code, specificically at this line,

EnfusionDatabaseFramework/src/Scripts/Game/Drivers/WebProxy/EDF_WebProxyDbDriverBase.c

Line 290 in 78dded3

url += string.Format("://%1:%2/%3/", webConnectInfo.m_sProxyHost, webConnectInfo.m_iProxyPort, webConnectInfo.m_sDatabaseName);

and I was wondering at //%1:%2/%3/ if there is missing the username and password section as described for mongodb as well, mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]] or can we use these as arguments?

[Arkensor]

That is not the direct connect URL to MongoDB but to the web proxy, as MongoDB servers have no HTTP API on their own.
For your own implementation, this method can be overridden to inject more info into it or build the url differently. But this is a good point, I will make the URL building into its own method so specific drivers that re-use the logic can adjust more specific aspects without the need to override the whole method.

[lmarschall]

Ah ok, good to know, does the actual experimental build contain the changes to the GET_now functions? Yesterday I was looking into the Arma Reforger Experimental software and the version was something with 0.9.9.x.

[Arkensor]

There were changes but we can not access the GET_now result string yet. Sadly.