Page MenuHomePhabricator
Differential D8472

[native] add entity and methods for redux-persist storage
ClosedPublic
Actions

Authored by kamil on Jul 11 2023, 4:19 AM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Apr 17, 12:06 PM
Unknown Object (File)
Mar 19 2025, 11:29 PM
Unknown Object (File)
Mar 15 2025, 6:10 PM
Unknown Object (File)
Mar 6 2025, 5:32 PM
Unknown Object (File)
Mar 6 2025, 5:32 PM
Unknown Object (File)
Mar 6 2025, 5:32 PM
Unknown Object (File)
Mar 6 2025, 5:28 PM
Unknown Object (File)
Mar 6 2025, 5:58 AM
View All Files
Subscribers
ashoat

Details

Reviewers
michal
tomek
Commits
rCOMM6d72d08d6592: [native] add entity and methods for redux-persist storage
Summary

Mapping web methods: storage-engine-queries

Depends on D8471

Test Plan

Tests from D8557

Diff Detail

Repository
rCOMM Comm
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

kamil created this revision.Jul 11 2023, 4:19 AM
kamil held this revision as a draft.
Herald added a subscriber: ashoat. · View Herald TranscriptJul 11 2023, 4:19 AM
Harbormaster completed remote builds in B20866: Diff 28585.Jul 11 2023, 4:36 AM
kamil added a child revision: D8487: [native] replace `folly::Optional` with `std::optional`.Jul 12 2023, 6:15 AM
kamil published this revision for review.Jul 12 2023, 6:21 AM
michal requested changes to this revision.Jul 14 2023, 2:12 AM

Looks good, just some questions:

  • would it make sense to make these methods more inline with others? So e.g. setPersistStorageItem getting PersistItem as an argument, or getPersistStorageItem returning PersistItem or null instead of string?
  • can we test these methods, and amend the test plan?
This revision now requires changes to proceed.Jul 14 2023, 2:12 AM
kamil removed a child revision: D8487: [native] replace `folly::Optional` with `std::optional`.Jul 19 2023, 6:46 AM
kamil added a child revision: D8553: [web] add SQLiteQueryExecutor bindings and type.Jul 19 2023, 6:49 AM
kamil added a child revision: D8487: [native] replace `folly::Optional` with `std::optional`.Jul 20 2023, 6:32 AM
kamil removed a child revision: D8487: [native] replace `folly::Optional` with `std::optional`.Jul 20 2023, 6:33 AM
kamil requested review of this revision.Jul 20 2023, 7:07 AM
In D8472#250668, @michal wrote:

Looks good, just some questions:

  • would it make sense to make these methods more inline with others? So e.g. setPersistStorageItem getting PersistItem as an argument, or getPersistStorageItem returning PersistItem or null instead of string?

That's an alternative approach, but I would prefer to stick to the current one:

  • this is key-value table, I would prefer to match other key-value APIs (see metadata)
  • this should replace the previous storage engine, eg. localstorage, and those functions match that API better
  • when we try to retrieve item at given key, I do not see a reason to return the object with key
  • can we test these methods, and amend the test plan?

Yes! I tested this in D8557 where I change tests to use new API

kamil edited the test plan for this revision. (Show Details)Jul 20 2023, 7:07 AM
michal accepted this revision.Jul 21 2023, 4:36 AM

Makes sense!

This revision is now accepted and ready to land.Jul 21 2023, 4:36 AM
Closed by commit rCOMM6d72d08d6592: [native] add entity and methods for redux-persist storage (authored by kamil). · Explain WhyJul 21 2023, 7:26 AM
This revision was automatically updated to reflect the committed changes.
kamil added a commit: rCOMM6d72d08d6592: [native] add entity and methods for redux-persist storage.

Revision Contents
Changeset List

PathSize
native/
cpp/
CommonCpp/
DatabaseManagers/
5 lines
3 lines
28 lines
entities/
12 lines

Diff 28932

View Options

native/cpp/CommonCpp/DatabaseManagers/DatabaseQueryExecutor.h

#pragma once #pragma once
#include "../CryptoTools/Persist.h" #include "../CryptoTools/Persist.h"
#include "entities/Draft.h" #include "entities/Draft.h"
#include "entities/Media.h" #include "entities/Media.h"
#include "entities/Message.h" #include "entities/Message.h"
#include "entities/MessageStoreThread.h" #include "entities/MessageStoreThread.h"
#include "entities/OlmPersistAccount.h" #include "entities/OlmPersistAccount.h"
#include "entities/OlmPersistSession.h" #include "entities/OlmPersistSession.h"
#include "entities/PersistItem.h"
#include "entities/Report.h" #include "entities/Report.h"
#include "entities/Thread.h" #include "entities/Thread.h"
#include <folly/Optional.h> #include <folly/Optional.h>
#include <jsi/jsi.h> #include <jsi/jsi.h>
#include <string> #include <string>
▲ Show 20 Lines • Show All 43 Lines • ▼ Show 20 Linespublic:
virtual std::vector<Thread> getAllThreads() const = 0; virtual std::vector<Thread> getAllThreads() const = 0;
virtual void removeThreads(std::vector<std::string> ids) const = 0; virtual void removeThreads(std::vector<std::string> ids) const = 0;
virtual void replaceThread(const Thread &thread) const = 0; virtual void replaceThread(const Thread &thread) const = 0;
virtual void removeAllThreads() const = 0; virtual void removeAllThreads() const = 0;
virtual void replaceReport(const Report &report) const = 0; virtual void replaceReport(const Report &report) const = 0;
virtual void removeReports(const std::vector<std::string> &ids) const = 0; virtual void removeReports(const std::vector<std::string> &ids) const = 0;
virtual void removeAllReports() const = 0; virtual void removeAllReports() const = 0;
virtual std::vector<Report> getAllReports() const = 0; virtual std::vector<Report> getAllReports() const = 0;
virtual void
setPersistStorageItem(std::string key, std::string item) const = 0;
virtual void removePersistStorageItem(std::string key) const = 0;
virtual std::string getPersistStorageItem(std::string key) const = 0;
virtual void beginTransaction() const = 0; virtual void beginTransaction() const = 0;
virtual void commitTransaction() const = 0; virtual void commitTransaction() const = 0;
virtual void rollbackTransaction() const = 0; virtual void rollbackTransaction() const = 0;
virtual std::vector<OlmPersistSession> getOlmPersistSessionsData() const = 0; virtual std::vector<OlmPersistSession> getOlmPersistSessionsData() const = 0;
virtual std::optional<std::string> getOlmPersistAccountData() const = 0; virtual std::optional<std::string> getOlmPersistAccountData() const = 0;
virtual void storeOlmPersistData(crypto::Persist persist) const = 0; virtual void storeOlmPersistData(crypto::Persist persist) const = 0;
virtual void setNotifyToken(std::string token) const = 0; virtual void setNotifyToken(std::string token) const = 0;
virtual void clearNotifyToken() const = 0; virtual void clearNotifyToken() const = 0;
virtual void setCurrentUserID(std::string userID) const = 0; virtual void setCurrentUserID(std::string userID) const = 0;
virtual std::string getCurrentUserID() const = 0; virtual std::string getCurrentUserID() const = 0;
virtual void setDeviceID(std::string deviceID) const = 0; virtual void setDeviceID(std::string deviceID) const = 0;
virtual std::string getDeviceID() const = 0; virtual std::string getDeviceID() const = 0;
}; };
} // namespace comm } // namespace comm
View Options

native/cpp/CommonCpp/DatabaseManagers/SQLiteQueryExecutor.h

Show First 20 Lines • Show All 57 Lines • ▼ Show 20 Linespublic:
std::vector<Thread> getAllThreads() const override; std::vector<Thread> getAllThreads() const override;
void removeThreads(std::vector<std::string> ids) const override; void removeThreads(std::vector<std::string> ids) const override;
void replaceThread(const Thread &thread) const override; void replaceThread(const Thread &thread) const override;
void removeAllThreads() const override; void removeAllThreads() const override;
void replaceReport(const Report &report) const override; void replaceReport(const Report &report) const override;
void removeReports(const std::vector<std::string> &ids) const override; void removeReports(const std::vector<std::string> &ids) const override;
void removeAllReports() const override; void removeAllReports() const override;
std::vector<Report> getAllReports() const override; std::vector<Report> getAllReports() const override;
void setPersistStorageItem(std::string key, std::string item) const override;
void removePersistStorageItem(std::string key) const override;
std::string getPersistStorageItem(std::string key) const override;
void beginTransaction() const override; void beginTransaction() const override;
void commitTransaction() const override; void commitTransaction() const override;
void rollbackTransaction() const override; void rollbackTransaction() const override;
std::vector<OlmPersistSession> getOlmPersistSessionsData() const override; std::vector<OlmPersistSession> getOlmPersistSessionsData() const override;
std::optional<std::string> getOlmPersistAccountData() const override; std::optional<std::string> getOlmPersistAccountData() const override;
void storeOlmPersistData(crypto::Persist persist) const override; void storeOlmPersistData(crypto::Persist persist) const override;
void setNotifyToken(std::string token) const override; void setNotifyToken(std::string token) const override;
void clearNotifyToken() const override; void clearNotifyToken() const override;
void setCurrentUserID(std::string userID) const override; void setCurrentUserID(std::string userID) const override;
std::string getCurrentUserID() const override; std::string getCurrentUserID() const override;
void setDeviceID(std::string deviceID) const override; void setDeviceID(std::string deviceID) const override;
std::string getDeviceID() const override; std::string getDeviceID() const override;
static void clearSensitiveData(); static void clearSensitiveData();
}; };
} // namespace comm } // namespace comm
View Options

native/cpp/CommonCpp/DatabaseManagers/SQLiteQueryExecutor.cpp

Show First 20 Lines • Show All 924 Lines • ▼ Show 20 Lines static auto storage = make_storage(
make_column("id", &MessageStoreThread::id, unique(), primary_key()), make_column("id", &MessageStoreThread::id, unique(), primary_key()),
make_column("start_reached", &MessageStoreThread::start_reached), make_column("start_reached", &MessageStoreThread::start_reached),
make_column( make_column(
"last_navigated_to", &MessageStoreThread::last_navigated_to), "last_navigated_to", &MessageStoreThread::last_navigated_to),
make_column("last_pruned", &MessageStoreThread::last_pruned)), make_column("last_pruned", &MessageStoreThread::last_pruned)),
make_table( make_table(
"reports", "reports",
make_column("id", &Report::id, unique(), primary_key()), make_column("id", &Report::id, unique(), primary_key()),
make_column("report", &Report::report))); make_column("report", &Report::report)),
make_table(
"persist_storage",
make_column("key", &PersistItem::key, unique(), primary_key()),
make_column("item", &PersistItem::item))
);
storage.on_open = on_database_open; storage.on_open = on_database_open;
return storage; return storage;
} }
void SQLiteQueryExecutor::initialize(std::string &databasePath) { void SQLiteQueryExecutor::initialize(std::string &databasePath) {
std::call_once(SQLiteQueryExecutor::initialized, [&databasePath]() { std::call_once(SQLiteQueryExecutor::initialized, [&databasePath]() {
SQLiteQueryExecutor::sqliteFilePath = databasePath; SQLiteQueryExecutor::sqliteFilePath = databasePath;
CommSecureStore commSecureStore{}; CommSecureStore commSecureStore{};
▲ Show 20 Lines • Show All 227 Lines • ▼ Show 20 Linesvoid SQLiteQueryExecutor::removeReports(
SQLiteQueryExecutor::getStorage().remove_all<Report>( SQLiteQueryExecutor::getStorage().remove_all<Report>(
where(in(&Report::id, ids))); where(in(&Report::id, ids)));
} }
std::vector<Report> SQLiteQueryExecutor::getAllReports() const { std::vector<Report> SQLiteQueryExecutor::getAllReports() const {
return SQLiteQueryExecutor::getStorage().get_all<Report>(); return SQLiteQueryExecutor::getStorage().get_all<Report>();
} }
void SQLiteQueryExecutor::setPersistStorageItem(
std::string key,
std::string item) const {
PersistItem entry{
key,
item,
};
SQLiteQueryExecutor::getStorage().replace(entry);
}
void SQLiteQueryExecutor::removePersistStorageItem(std::string key) const {
SQLiteQueryExecutor::getStorage().remove<PersistItem>(key);
}
std::string SQLiteQueryExecutor::getPersistStorageItem(std::string key) const {
std::unique_ptr<PersistItem> entry =
SQLiteQueryExecutor::getStorage().get_pointer<PersistItem>(key);
return (entry == nullptr) ? "" : entry->item;
}
void SQLiteQueryExecutor::beginTransaction() const { void SQLiteQueryExecutor::beginTransaction() const {
SQLiteQueryExecutor::getStorage().begin_transaction(); SQLiteQueryExecutor::getStorage().begin_transaction();
} }
void SQLiteQueryExecutor::commitTransaction() const { void SQLiteQueryExecutor::commitTransaction() const {
SQLiteQueryExecutor::getStorage().commit(); SQLiteQueryExecutor::getStorage().commit();
} }
▲ Show 20 Lines • Show All 91 Lines • Show Last 20 Lines
View Options

native/cpp/CommonCpp/DatabaseManagers/entities/PersistItem.h

  • This file was added.
#pragma once
#include <string>
namespace comm {
struct PersistItem {
std::string key;
std::string item;
};
} // namespace comm