Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SPIKE: PaperTrail ? #106

Closed
1 task
nelsonic opened this issue Oct 4, 2022 · 7 comments
Closed
1 task

SPIKE: PaperTrail ? #106

nelsonic opened this issue Oct 4, 2022 · 7 comments
Assignees
Labels
discuss Share your constructive thoughts on how to make progress with this issue help wanted If you can help make progress with this issue, please comment! priority-1 Highest priority issue. This is costing us money every minute that passes. question A question needs to be answered before progress can be made on this issue research Research required; be specific T1h Time Estimate 1 Hour technical A technical issue that requires understanding of the code, infrastructure or dependencies

Comments

@nelsonic
Copy link
Member

nelsonic commented Oct 4, 2022

Investigate if we can use PaperTrail: https://github.com/izelnakri/paper_trail
to store version history of items in our App (MVP).

Todo

Ultimately what we want is an Operational Transform Log dwyl/app#276
so that changes made in our App can easily be "replayed" by someone joining a team
or undone if the change is not desired.

If PaperTrail can enable this, we should consider using it because it appears to be maintained. 💭

@nelsonic nelsonic added help wanted If you can help make progress with this issue, please comment! question A question needs to be answered before progress can be made on this issue priority-1 Highest priority issue. This is costing us money every minute that passes. discuss Share your constructive thoughts on how to make progress with this issue T1h Time Estimate 1 Hour technical A technical issue that requires understanding of the code, infrastructure or dependencies research Research required; be specific labels Oct 4, 2022
@nelsonic nelsonic self-assigned this Oct 4, 2022
@nelsonic nelsonic changed the title PaperTrail ? SPIKE: PaperTrail ? Oct 5, 2022
@nelsonic nelsonic pinned this issue Oct 7, 2022
@nelsonic
Copy link
Member Author

image

https://github.com/zaboople/klonk/blob/master/TheGURQ.md https://news.ycombinator.com/item?id=33560275

@LuchoTurtle
Copy link
Member

After mentioning in dwyl/app#276 (comment), I look at other options but only Delta for Elixir seemed to exist when it comes to OT. PaperTrail seems the better option for me, though. If we are using OT just for logging and we want to store them, PaperTrail seems to do just what we want. If we used Quill's or Delta for Elixir, we would have to repeat the work PaperTrail did by setting up this behaviour with a database.

@nelsonic
Copy link
Member Author

@LuchoTurtle thanks for taking a look at this. 👍
We need to understand what the pros/cons of using PaperTrail will be.
If you want to dive into this, go for it.
Basically we want to maintain a complete history of every action performed in the App
so that people can easily undo/redo any change that they make.
We need to store the data in the most efficient means possible so that our storage costs don't break us.
If we need to derive our own algorithm we will. But if something already exists, we should 100% use it. 💭

@LuchoTurtle
Copy link
Member

From what I've tinkered with PaperTrail, it seems to work perfectly fine out-of-the-box and does exactly what is written on the tin. I've noticed that only insert, update and delete operations are "tracked". I thought, from a logging and analytics perspective, tracking queries would also be a bit useful (though not as much).
I understand that mutations and actions that change the data are much more important but I thought I'd share this.

@nelsonic
Copy link
Member Author

@LuchoTurtle thank you for insightful Demo during standup. It looks like we can use PaperTrail for our MVP. 🤞
We need to have a standalone demo App for PaperTrail so that everyone in the team/community can understand it. 👌
The https://github.com/dwyl/phoenix-papertrail-demo README.md outline should be a good guide. 📝
But if you have any specific questions, please ask. 🙏

@LuchoTurtle
Copy link
Member

This should be closed due to https://github.com/dwyl/phoenix-papertrail-demo

@nelsonic
Copy link
Member Author

Thanks again @LuchoTurtle 👍

@nelsonic nelsonic unpinned this issue Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Share your constructive thoughts on how to make progress with this issue help wanted If you can help make progress with this issue, please comment! priority-1 Highest priority issue. This is costing us money every minute that passes. question A question needs to be answered before progress can be made on this issue research Research required; be specific T1h Time Estimate 1 Hour technical A technical issue that requires understanding of the code, infrastructure or dependencies
Projects
None yet
Development

No branches or pull requests

2 participants