How to Write and Integrate Custom Storage Backend?

[abrahimzaman360]

I'm working on a simple app for myself that uses surrealdb. I wrote the storage backend, but I'm unsure how to integrate it into the authentication framework.
Help with that, please!
What I thought but didn't work:
let mut auth = AuthFramework::new(config, custom_storage);

#update:
Bringing SurealDB as Storage Engine in New PR

[abrahimzaman360]

@ciresnave Unable to build the project!
Could you please share your dev env etc?

[ciresnave]

Ha! Thank you for highlighting something I missed when building auth-framework. I had always planned to provide the ability to add other storage backends but never finished that aspect of the project. The inner plumbing is there already but I never surfaced it. I'll do that now and have a new version out shortly. Probably later today if I don't have an emergency pull me away from this.

As for you being unable to build the project, what types of errors are you seeing? I run a pretty up to date system and don't tend to test on older versions of Rust. Could that be causing you issues? I'll run cargo msrv on auth-framework to determine what version of Rust it requires and get that added to the Cargo.toml. I build on both Windows 11 and Debian Linux so I doubt it's an operating system issue unless you're running on one of the platforms I don't test like BSD or an embedded environment.

[ciresnave]

It appears I left the repo in quite a sloppy state with some half-finished changes in it the last time I worked on it. The releases were good but the repo needs work. I'm attempting to get it back up to a clean, usable state now. Sorry for the delays. I will still try to have it completed and ready for your work later today...assuming my wife doesn't have other plans for my Saturday. :)

[ciresnave]

Okay. The PR I was working on got merged. I think I accidentally deleted your PR in the process somehow...but I liked where you were headed with it. I'm improving the .gitignore now and will push a comprehensive version soon, trimmed out a lot of files that shouldn't have been pushed to the repo but were because I was the only developer, and am beginning the process of revamping the examples so they are closer to what should exist in the real world (like actually having authorization checks like you added). Good calls on all of your changes.

Now back to your question here about how to write and integrate custom storage backends...

I had Claude generate a couple quick guides:

https://github.com/ciresnave/auth-framework/blob/fix/custom-storage-tests/docs/guides/custom-storage-implementation.md

https://github.com/ciresnave/auth-framework/blob/fix/custom-storage-tests/docs/guides/third-party-storage-usage.md

I'm out of time to work on this today but if you'd like to take a look at those, tell me what you think. I normally go through anything AIs generate before I push it to GitHub but don't have the time to look at those just now. It used the current codebase of this project for reference so the guides should be pretty correct...but you never know with AI-generated text.

Oh... I pushed the new .gitignore as well so see if you think that covers everything that should be ignored. If not, we can add more.

[ciresnave]

Oh. Since the PR where you asked about Discord is closed... I am CireSnave on Discord and just about everywhere else. Feel free to send me a message there, on Messenger, or wherever.