Page MenuHomePhabricator
Differential D11259

[lib] Create a redux store where ops will be stored
ClosedPublic
Actions

Authored by tomek on Mar 6 2024, 9:54 AM.
Tags
None
Referenced Files
F5099617: D11259.id.diff
Mon, Mar 31, 7:47 AM
F5097428: D11259.id38356.diff
Sun, Mar 30, 11:25 PM
F5095643: D11259.id38258.diff
Sun, Mar 30, 6:24 PM
Unknown Object (File)
Sun, Mar 30, 10:09 AM
Unknown Object (File)
Sun, Mar 30, 4:46 AM
Unknown Object (File)
Sun, Mar 30, 4:31 AM
Unknown Object (File)
Sun, Mar 30, 12:03 AM
Unknown Object (File)
Sat, Mar 29, 6:09 PM
View All Files
Subscribers
ashoat

Details

Reviewers
kamil
inka
will
Commits
rCOMMa6d8818e3171: [lib] Create a redux store where ops will be stored
Summary

Create the store. By default, it should contain an empty array.

https://linear.app/comm/issue/ENG-7096/add-a-new-field-in-redux-where-ops-are-stored

Test Plan

Inspect Redux on web and native and check if the store is present. Also close and reopen the app to make sure that there are no inconsistencies.

Diff Detail

Repository
rCOMM Comm
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

tomek created this revision.Mar 6 2024, 9:54 AM
Herald added a subscriber: ashoat. · View Herald TranscriptMar 6 2024, 9:54 AM
Harbormaster completed remote builds in B27364: Diff 37895.Mar 6 2024, 10:51 AM
tomek requested review of this revision.Mar 6 2024, 10:51 AM
inka added a comment.Mar 7 2024, 12:17 AM

Can you explain why we don't want to persist ops? Wouldn't it be a problem if redux store got updated, but the app was closed before ops had the time to update the db?

lib/types/db-ops-types.js
6 ↗(On Diff #37895)

What is this used for?

12 ↗(On Diff #37895)

What is this used for?

kamil added a comment.Mar 7 2024, 4:30 AM
In D11259#325290, @inka wrote:

Can you explain why we don't want to persist ops? Wouldn't it be a problem if redux store got updated, but the app was closed before ops had the time to update the db?

In the current design the flow should be like this:

  1. Receive message
  2. Decrypt
  3. Processing in redux and database
  4. Confirm

If we want to persist this, we could end up in a scenario where we open the app, and we have:

  1. Processing in redux and database
  2. Confirm

This requires implementing some additional things like remembering messageIDs, confirming not from the socket level but from the component responsible for processing etc.. With the current approach we will just start the flow again, it could be improved in the future but I think for now it might not be worth it.

tomek added inline comments.Mar 7 2024, 7:59 AM
lib/types/db-ops-types.js
6 ↗(On Diff #37895)

We need a mapping between actions and ops - https://linear.app/comm/issue/ENG-7094/introduce-a-mapping-between-actions-and-ops. The plan is for each action that we want to track, to introduce an ID which then can be used when an ops processing finishes.

12 ↗(On Diff #37895)

If an action doesn't generate ops we can immediately report its completion to the caller. This array allows us to do that because we don't need to wait for other ops to complete.

tomek added a child revision: D11279: [lib] Add an action representing a successful processing.Mar 8 2024, 12:31 AM
kamil accepted this revision.Mar 11 2024, 4:01 AM
kamil added inline comments.
lib/types/db-ops-types.js
12 ↗(On Diff #37895)

it could be helpful to add comment in code explaining this

This revision is now accepted and ready to land.Mar 11 2024, 4:01 AM
tomek updated this revision to Diff 38258.Mar 21 2024, 4:56 AM

Add a comment. Update the types.

tomek updated this revision to Diff 38259.Mar 21 2024, 4:59 AM

Update types

Harbormaster completed remote builds in B27637: Diff 38258.Mar 21 2024, 5:12 AM
Harbormaster completed remote builds in B27638: Diff 38259.
tomek updated this revision to Diff 38264.Mar 21 2024, 8:02 AM

We don't need a second ID - removing the ops ID

Harbormaster completed remote builds in B27643: Diff 38264.Mar 21 2024, 8:18 AM
tomek updated this revision to Diff 38356.Mar 27 2024, 4:36 AM

Keep only one queue
https://linear.app/comm/issue/ENG-7040/implement-generating-and-awaiting-processed-ops#comment-bc0834f4

Harbormaster completed remote builds in B27699: Diff 38356.Mar 27 2024, 4:52 AM
tomek updated this revision to Diff 38365.Mar 27 2024, 7:26 AM

Update the types

tomek edited the summary of this revision. (Show Details)Mar 27 2024, 7:27 AM
Harbormaster completed remote builds in B27702: Diff 38365.Mar 27 2024, 7:45 AM
tomek updated this revision to Diff 38446.Mar 28 2024, 7:41 AM

Rebase

Harbormaster completed remote builds in B27766: Diff 38446.Mar 28 2024, 7:56 AM
Closed by commit rCOMMa6d8818e3171: [lib] Create a redux store where ops will be stored (authored by tomek). · Explain WhyMar 28 2024, 8:11 AM
This revision was automatically updated to reflect the committed changes.
tomek added a commit: rCOMMa6d8818e3171: [lib] Create a redux store where ops will be stored.

Revision Contents
Changeset List

PathSize
lib/
types/
18 lines
2 lines
utils/
4 lines
native/
redux/
4 lines
1 line
2 lines
web/
redux/
4 lines
2 lines

Diff 38258

View Options

lib/types/db-ops-types.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

lib/types/redux-types.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

lib/utils/reducers-utils.test.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

native/redux/default-state.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

native/redux/persist.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

native/redux/state-types.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

web/redux/default-state.js

  • This file was added.
use lazy_static::lazy_static;
use regex::Regex;
use std::path::PathBuf;
lazy_static! {
static ref BACKUP_DATA_FILE_REGEX: Regex = Regex::new(
r"^backup-(?<backup_id>[^-]*)(?:-log-(?<log_id>\d*))?(?<additional_data>-userkeys|-attachments)?$"
)
.expect("Regex compilation failed");
}
#[derive(Debug)]
pub struct BackupFileInfo {
pub backup_id: String,
pub log_id: Option<usize>,
pub additional_data: Option<String>,
}
impl TryFrom<PathBuf> for BackupFileInfo {
type Error = ();
fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
let Some(file_name) = value.file_name() else {
return Err(());
};
let file_name = file_name.to_string_lossy();
let Some(captures) = BACKUP_DATA_FILE_REGEX.captures(&file_name) else {
return Err(());
};
let Some(backup_id) = captures
.name("backup_id")
.map(|re_match| re_match.as_str().to_string())
else {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'backup_id' from backup filename: {file_name:?}"
);
return Err(());
};
let log_id = match captures
.name("log_id")
.map(|re_match| re_match.as_str().parse::<usize>())
{
None => None,
Some(Ok(log_id)) => Some(log_id),
Some(Err(err)) => {
// Should never happen happen because regex matched the filename
println!(
"Couldn't parse 'log_id' from backup filename: {file_name:?}. \
Error: {err:?}"
);
return Err(());
}
};
let additional_data = captures
.name("additional_data")
.map(|m| m.as_str().to_string());
Ok(Self {
backup_id,
log_id,
additional_data,
})
}
}
View Options

web/redux/redux-setup.js

Loading...