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.

Sign up for GitHub

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

feat: user usage data assertion #1231

Merged
merged 7 commits into from
Feb 11, 2025
Merged

feat: user usage data assertion #1231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bbc0693
feat: user usage data assertion
peterpeterparker Feb 10, 2025
248716d
feat: cleanup
peterpeterparker Feb 11, 2025
588ae85
chore: remove unused
peterpeterparker Feb 11, 2025
2851006
chore: merge main
peterpeterparker Feb 11, 2025
1700696
chore: redo UserUsageData
peterpeterparker Feb 11, 2025
eb20497
Merge branch 'main' into feat/user-usage-assertion
peterpeterparker Feb 11, 2025
0303fa9
test: assertion struct
peterpeterparker Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/libs/satellite/src/db/assert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use crate::db::types::config::DbConfig;
use crate::db::types::state::{DocAssertDelete, DocAssertSet, DocContext};
use crate::hooks::{invoke_assert_delete_doc, invoke_assert_set_doc};
use crate::types::store::StoreContext;
use crate::usage::assert::increment_and_assert_db_usage;
use crate::usage::assert::{assert_user_usage_collection_data, increment_and_assert_db_usage};
use crate::user::assert::{assert_user_collection_caller_key, assert_user_collection_data};
use crate::{DelDoc, Doc, SetDoc};
use candid::Principal;
Expand Down Expand Up @@ -39,6 +39,8 @@ pub fn assert_set_doc(
assert_user_collection_caller_key(caller, collection, key)?;
assert_user_collection_data(collection, value)?;

assert_user_usage_collection_data(collection, value)?;

invoke_assert_set_doc(
&caller,
&DocContext {
Expand Down
28 changes: 28 additions & 0 deletions src/libs/satellite/src/usage/assert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
use crate::types::state::CollectionType;
use crate::usage::store::increment_usage;
use crate::usage::types::state::UserUsageData;
use crate::usage::utils::{is_db_collection_no_usage, is_storage_collection_no_usage};
use crate::SetDoc;
use junobuild_collections::constants::db::{COLLECTION_USER_USAGE_KEY};
use junobuild_collections::types::core::CollectionKey;
use junobuild_shared::controllers::is_controller;
use junobuild_shared::types::state::{Controllers, UserId};
use junobuild_utils::decode_doc_data;

// ---------------------------------------------------------
// Increment user usage - i.e. when a user edit, create or delete
// ---------------------------------------------------------

pub fn increment_and_assert_db_usage(
caller: UserId,
Expand Down Expand Up @@ -65,3 +73,23 @@ fn increment_and_assert_usage(

Ok(())
}

// ---------------------------------------------------------
// Assert struct - useful when an admit set imperatively a user usage
// ---------------------------------------------------------

pub fn assert_user_usage_collection_data(
collection: &CollectionKey,
doc: &SetDoc,
) -> Result<(), String> {
let user_usage_collection = COLLECTION_USER_USAGE_KEY;

if collection != user_usage_collection {
return Ok(());
}

decode_doc_data::<UserUsageData>(&doc.data)
.map_err(|err| format!("Invalid user usage data: {}", err))?;

Ok(())
}
170 changes: 130 additions & 40 deletions src/tests/specs/satellite.user-usage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,34 +351,79 @@ describe('Satellite User Usage', () => {
actor.setIdentity(controller);
});

it('should set usage for user', async () => {
const { set_doc, get_doc } = actor;
describe('success', () => {
it('should set usage for user', async () => {
const { set_doc, get_doc } = actor;

const key = `${user.getPrincipal().toText()}#db#${TEST_COLLECTION}`;
const key = `${user.getPrincipal().toText()}#db#${TEST_COLLECTION}`;

const currentDoc = await get_doc('#user-usage', key);
const currentDoc = await get_doc('#user-usage', key);

const doc: SetDoc = {
data: await toArray({
changes_count: 345
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};
const doc: SetDoc = {
data: await toArray({
changes_count: 345
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};

const usage = await set_doc('#user-usage', key, doc);

const usageData = await fromArray<UserUsage>(usage.data);

expect(usageData.changes_count).toEqual(345);

const usage = await set_doc('#user-usage', key, doc);
expect(usage.updated_at).not.toBeUndefined();
expect(usage.updated_at).toBeGreaterThan(0n);
expect(usage.created_at).not.toBeUndefined();
expect(usage.created_at).toBeGreaterThan(0n);
expect(usage.updated_at).toBeGreaterThan(usage.created_at);

const usageData = await fromArray<UserUsage>(usage.data);
expect(usage.version).toEqual(toNullable(BigInt(countTotalChanges + 1)));
});
});

describe('error', () => {
it('should not set usage with invalid type', async () => {
const { set_doc, get_doc } = actor;

expect(usageData.changes_count).toEqual(345);
const key = `${user.getPrincipal().toText()}#db#${TEST_COLLECTION}`;

expect(usage.updated_at).not.toBeUndefined();
expect(usage.updated_at).toBeGreaterThan(0n);
expect(usage.created_at).not.toBeUndefined();
expect(usage.created_at).toBeGreaterThan(0n);
expect(usage.updated_at).toBeGreaterThan(usage.created_at);
const currentDoc = await get_doc('#user-usage', key);

const doc: SetDoc = {
data: await toArray({
changes_count: 'invalid'
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};

await expect(set_doc('#user-usage', key, doc)).rejects.toThrow(
'Invalid user usage data: invalid type: string "invalid", expected u32 at line 1 column 26.'
);
});

expect(usage.version).toEqual(toNullable(BigInt(countTotalChanges + 1)));
it('should not set usage with invalid additional data fields', async () => {
const { set_doc, get_doc } = actor;

const key = `${user.getPrincipal().toText()}#db#${TEST_COLLECTION}`;

const currentDoc = await get_doc('#user-usage', key);

const doc: SetDoc = {
data: await toArray({
changes_count: 432,
unknown: 'field'
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};

await expect(set_doc('#user-usage', key, doc)).rejects.toThrow(
'Invalid user usage data: unknown field `unknown`, expected `changes_count` at line 1 column 30.'
);
});
});
});
});
Expand Down Expand Up @@ -628,34 +673,79 @@ describe('Satellite User Usage', () => {
actor.setIdentity(controller);
});

it('should set usage for user', async () => {
const { set_doc, get_doc } = actor;
describe('success', () => {
it('should set usage for user', async () => {
const { set_doc, get_doc } = actor;

const key = `${user.getPrincipal().toText()}#storage#${TEST_COLLECTION}`;
const key = `${user.getPrincipal().toText()}#storage#${TEST_COLLECTION}`;

const currentDoc = await get_doc('#user-usage', key);
const currentDoc = await get_doc('#user-usage', key);

const doc: SetDoc = {
data: await toArray({
changes_count: 456
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};
const doc: SetDoc = {
data: await toArray({
changes_count: 456
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};

const usage = await set_doc('#user-usage', key, doc);

const usageData = await fromArray<UserUsage>(usage.data);

const usage = await set_doc('#user-usage', key, doc);
expect(usageData.changes_count).toEqual(456);

const usageData = await fromArray<UserUsage>(usage.data);
expect(usage.updated_at).not.toBeUndefined();
expect(usage.updated_at).toBeGreaterThan(0n);
expect(usage.created_at).not.toBeUndefined();
expect(usage.created_at).toBeGreaterThan(0n);
expect(usage.updated_at).toBeGreaterThan(usage.created_at);

expect(usageData.changes_count).toEqual(456);
expect(usage.version).toEqual(toNullable(BigInt(countTotalChanges + 1)));
});
});

expect(usage.updated_at).not.toBeUndefined();
expect(usage.updated_at).toBeGreaterThan(0n);
expect(usage.created_at).not.toBeUndefined();
expect(usage.created_at).toBeGreaterThan(0n);
expect(usage.updated_at).toBeGreaterThan(usage.created_at);
describe('error', () => {
it('should not set usage with invalid type', async () => {
const { set_doc, get_doc } = actor;

expect(usage.version).toEqual(toNullable(BigInt(countTotalChanges + 1)));
const key = `${user.getPrincipal().toText()}#storage#${TEST_COLLECTION}`;

const currentDoc = await get_doc('#user-usage', key);

const doc: SetDoc = {
data: await toArray({
changes_count: 'invalid'
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};

await expect(set_doc('#user-usage', key, doc)).rejects.toThrow(
'Invalid user usage data: invalid type: string "invalid", expected u32 at line 1 column 26.'
);
});

it('should not set usage with invalid additional data fields', async () => {
const { set_doc, get_doc } = actor;

const key = `${user.getPrincipal().toText()}#storage#${TEST_COLLECTION}`;

const currentDoc = await get_doc('#user-usage', key);

const doc: SetDoc = {
data: await toArray({
changes_count: 432,
unknown: 'field'
}),
description: toNullable(),
version: fromNullable(currentDoc)?.version ?? []
};

await expect(set_doc('#user-usage', key, doc)).rejects.toThrow(
'Invalid user usage data: unknown field `unknown`, expected `changes_count` at line 1 column 30.'
);
});
});
});
});
Expand Down