Page MenuHomePhabricator
Differential D7661

[Tunnelbroker] Add integration tests
ClosedPublic
Actions

Authored by • jon on Apr 27 2023, 7:21 AM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Apr 3, 10:46 PM
Unknown Object (File)
Tue, Mar 11, 12:50 AM
Unknown Object (File)
Tue, Mar 11, 12:47 AM
Unknown Object (File)
Tue, Mar 11, 12:47 AM
Unknown Object (File)
Tue, Mar 11, 12:42 AM
Unknown Object (File)
Feb 24 2025, 9:12 AM
Unknown Object (File)
Feb 24 2025, 1:52 AM
Unknown Object (File)
Feb 24 2025, 12:32 AM
View All Files
Subscribers
ashoat
atul
tomek

Details

Reviewers
varun
bartek
Commits
rCOMM2bead14e6f9c: [Tunnelbroker] Add integration tests
Summary

For some features, it's easier to just have a unittest demonstrate
the expected behavior. This sets up that framework, and modifies
the existing code to make it more explicit as to what is going on
when debugging.

Depends on D7659

Test Plan
(cd services/tunnelbroker && RUST_LOG=debug cargo run &)
cd services/commtest && cargo test --test tunnelbroker_integration_test

Diff Detail

Repository
rCOMM Comm
Branch
jonringer/tunnelbroker-connections (branched from master)
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

• jon created this revision.Apr 27 2023, 7:21 AM
Herald added subscribers: atul, tomek, ashoat. · View Herald TranscriptApr 27 2023, 7:21 AM
Harbormaster completed remote builds in B18867: Diff 25845.Apr 27 2023, 7:39 AM
• jon requested review of this revision.Apr 27 2023, 7:39 AM
• jon edited the summary of this revision. (Show Details)Apr 27 2023, 8:55 AM
bartek added inline comments.Apr 29 2023, 9:51 AM
services/commtest/tests/tunnelbroker_integration_test.rs
4–5

I know this is a "hello world" test, but just two considerations for future design:

  • Is this function intended to be a test? Or a utility to open a connection?
  • Isn't it better to keep the anyhow::Result<()> return type? Anyway, it's an easy change if ever needed. When opening a connection for tests, panicking makes sense
services/tunnelbroker/src/websockets/mod.rs
70

I'd consider it trace! because it feels redundant as there's already a debug log in line 45

bartek accepted this revision.Apr 29 2023, 11:38 AM
This revision is now accepted and ready to land.Apr 29 2023, 11:38 AM
• jon marked 2 inline comments as done.Apr 30 2023, 10:28 PM
• jon added inline comments.
services/commtest/tests/tunnelbroker_integration_test.rs
4–5

Is this function intended to be a test? Or a utility to open a connection?

It is meant to be a test. It's easier for me to iterate with rust than JS. So I've been implementing it first in rust to just to ensure that the rust is working before trying to debug stuff in JS.

Isn't it better to keep the anyhow::Result<()> return type?

The test is meant to a be a happy case, if it panics or returns an Err it will still fail the test. I don't feel super strongly about this, and might make the transition in the future to use anyhow. Still not sure if anyhow or retaining the original error is more beneficial

services/tunnelbroker/src/websockets/mod.rs
70

line 45 doesn't get executed until a message is received, where as this gets emitted right before it begins polling for an event.

Closed by commit rCOMM2bead14e6f9c: [Tunnelbroker] Add integration tests (authored by • jon). · Explain WhyApr 30 2023, 10:31 PM
This revision was automatically updated to reflect the committed changes.
• jon marked 2 inline comments as done.
• jon added a commit: rCOMM2bead14e6f9c: [Tunnelbroker] Add integration tests.
bartek added a child revision: D7765: [native] Add thumbHash prop to image components.May 9 2023, 8:08 AM
bartek removed a child revision: D7765: [native] Add thumbHash prop to image components.May 9 2023, 8:14 AM
kamil mentioned this in D9142: [Tunnelbroker] Fix integration tests.Sep 12 2023, 4:01 AM
kamil mentioned this in rCOMM08a58fec2081: [Tunnelbroker] Fix integration tests.Sep 12 2023, 4:44 AM

Revision Contents
Changeset List

PathSize
services/
commtest/
3 lines
src/
tunnelbroker/
3 lines
tests/
77 lines
tunnelbroker/
2 lines
src/
3 lines
10 lines
websockets/
27 lines
shared/
tunnelbroker_messages/
src/
messages/
1 line

Diff 25845

View Options

services/commtest/Cargo.lock

Show First 20 Lines • Show All 342 Lines • ▼ Show 20 Lines query.append(SQL`
ORDER BY tw.threadID, tw.time DESC, tw.id DESC ORDER BY tw.threadID, tw.time DESC, tw.id DESC
`); `);
const [result] = await dbQuery(query); const [result] = await dbQuery(query);
const derivedMessages = await fetchDerivedMessages(result, viewer); const derivedMessages = await fetchDerivedMessages(result, viewer);
const messages = await parseMessageSQLResult(result, derivedMessages, viewer); const messages = await parseMessageSQLResult(result, derivedMessages, viewer);
const rawMessageInfos = []; const rawMessageInfos = [];
const threadToMessageCount = new Map(); const threadToMessageCount = new Map<string, number>();
for (const message of messages) { for (const message of messages) {
const { rawMessageInfo } = message; const { rawMessageInfo } = message;
rawMessageInfos.push(rawMessageInfo); rawMessageInfos.push(rawMessageInfo);
const { threadID } = rawMessageInfo; const { threadID } = rawMessageInfo;
const currentCountValue = threadToMessageCount.get(threadID); const currentCountValue = threadToMessageCount.get(threadID);
const currentCount = currentCountValue ? currentCountValue : 0; const currentCount = currentCountValue ? currentCountValue : 0;
threadToMessageCount.set(threadID, currentCount + 1); threadToMessageCount.set(threadID, currentCount + 1);
} }
▲ Show 20 Lines • Show All 479 Lines • ▼ Show 20 Lines SELECT m.id, (
ORDER BY time DESC, id DESC ORDER BY time DESC, id DESC
LIMIT 1 LIMIT 1
) content ) content
FROM messages m FROM messages m
WHERE m.id IN(${messageIDs}) WHERE m.id IN(${messageIDs})
`; `;
const [result] = await dbQuery(latestEditedMessageQuery); const [result] = await dbQuery(latestEditedMessageQuery);
const latestContentByID = new Map(); const latestContentByID = new Map<string, EditMessageContent>();
for (const row of result) { for (const row of result) {
if (!row.content) { if (!row.content) {
continue; continue;
} }
const content = JSON.parse(row.content); const content = JSON.parse(row.content);
latestContentByID.set(row.id.toString(), content); latestContentByID.set(row.id.toString(), content);
} }
▲ Show 20 Lines • Show All 181 Lines • Show Last 20 Lines
View Options

services/commtest/Cargo.toml

Show First 20 Lines • Show All 342 Lines • ▼ Show 20 Lines query.append(SQL`
ORDER BY tw.threadID, tw.time DESC, tw.id DESC ORDER BY tw.threadID, tw.time DESC, tw.id DESC
`); `);
const [result] = await dbQuery(query); const [result] = await dbQuery(query);
const derivedMessages = await fetchDerivedMessages(result, viewer); const derivedMessages = await fetchDerivedMessages(result, viewer);
const messages = await parseMessageSQLResult(result, derivedMessages, viewer); const messages = await parseMessageSQLResult(result, derivedMessages, viewer);
const rawMessageInfos = []; const rawMessageInfos = [];
const threadToMessageCount = new Map(); const threadToMessageCount = new Map<string, number>();
for (const message of messages) { for (const message of messages) {
const { rawMessageInfo } = message; const { rawMessageInfo } = message;
rawMessageInfos.push(rawMessageInfo); rawMessageInfos.push(rawMessageInfo);
const { threadID } = rawMessageInfo; const { threadID } = rawMessageInfo;
const currentCountValue = threadToMessageCount.get(threadID); const currentCountValue = threadToMessageCount.get(threadID);
const currentCount = currentCountValue ? currentCountValue : 0; const currentCount = currentCountValue ? currentCountValue : 0;
threadToMessageCount.set(threadID, currentCount + 1); threadToMessageCount.set(threadID, currentCount + 1);
} }
▲ Show 20 Lines • Show All 479 Lines • ▼ Show 20 Lines SELECT m.id, (
ORDER BY time DESC, id DESC ORDER BY time DESC, id DESC
LIMIT 1 LIMIT 1
) content ) content
FROM messages m FROM messages m
WHERE m.id IN(${messageIDs}) WHERE m.id IN(${messageIDs})
`; `;
const [result] = await dbQuery(latestEditedMessageQuery); const [result] = await dbQuery(latestEditedMessageQuery);
const latestContentByID = new Map(); const latestContentByID = new Map<string, EditMessageContent>();
for (const row of result) { for (const row of result) {
if (!row.content) { if (!row.content) {
continue; continue;
} }
const content = JSON.parse(row.content); const content = JSON.parse(row.content);
latestContentByID.set(row.id.toString(), content); latestContentByID.set(row.id.toString(), content);
} }
▲ Show 20 Lines • Show All 181 Lines • Show Last 20 Lines
View Options

services/commtest/src/tunnelbroker/mod.rs

Show First 20 Lines • Show All 342 Lines • ▼ Show 20 Lines query.append(SQL`
ORDER BY tw.threadID, tw.time DESC, tw.id DESC ORDER BY tw.threadID, tw.time DESC, tw.id DESC
`); `);
const [result] = await dbQuery(query); const [result] = await dbQuery(query);
const derivedMessages = await fetchDerivedMessages(result, viewer); const derivedMessages = await fetchDerivedMessages(result, viewer);
const messages = await parseMessageSQLResult(result, derivedMessages, viewer); const messages = await parseMessageSQLResult(result, derivedMessages, viewer);
const rawMessageInfos = []; const rawMessageInfos = [];
const threadToMessageCount = new Map(); const threadToMessageCount = new Map<string, number>();
for (const message of messages) { for (const message of messages) {
const { rawMessageInfo } = message; const { rawMessageInfo } = message;
rawMessageInfos.push(rawMessageInfo); rawMessageInfos.push(rawMessageInfo);
const { threadID } = rawMessageInfo; const { threadID } = rawMessageInfo;
const currentCountValue = threadToMessageCount.get(threadID); const currentCountValue = threadToMessageCount.get(threadID);
const currentCount = currentCountValue ? currentCountValue : 0; const currentCount = currentCountValue ? currentCountValue : 0;
threadToMessageCount.set(threadID, currentCount + 1); threadToMessageCount.set(threadID, currentCount + 1);
} }
▲ Show 20 Lines • Show All 479 Lines • ▼ Show 20 Lines SELECT m.id, (
ORDER BY time DESC, id DESC ORDER BY time DESC, id DESC
LIMIT 1 LIMIT 1
) content ) content
FROM messages m FROM messages m
WHERE m.id IN(${messageIDs}) WHERE m.id IN(${messageIDs})
`; `;
const [result] = await dbQuery(latestEditedMessageQuery); const [result] = await dbQuery(latestEditedMessageQuery);
const latestContentByID = new Map(); const latestContentByID = new Map<string, EditMessageContent>();
for (const row of result) { for (const row of result) {
if (!row.content) { if (!row.content) {
continue; continue;
} }
const content = JSON.parse(row.content); const content = JSON.parse(row.content);
latestContentByID.set(row.id.toString(), content); latestContentByID.set(row.id.toString(), content);
} }
▲ Show 20 Lines • Show All 181 Lines • Show Last 20 Lines
View Options

services/commtest/src/tunnelbroker/new_session.rs

Show First 20 Lines • Show All 342 Lines • ▼ Show 20 Lines query.append(SQL`
ORDER BY tw.threadID, tw.time DESC, tw.id DESC ORDER BY tw.threadID, tw.time DESC, tw.id DESC
`); `);
const [result] = await dbQuery(query); const [result] = await dbQuery(query);
const derivedMessages = await fetchDerivedMessages(result, viewer); const derivedMessages = await fetchDerivedMessages(result, viewer);
const messages = await parseMessageSQLResult(result, derivedMessages, viewer); const messages = await parseMessageSQLResult(result, derivedMessages, viewer);
const rawMessageInfos = []; const rawMessageInfos = [];
const threadToMessageCount = new Map(); const threadToMessageCount = new Map<string, number>();
for (const message of messages) { for (const message of messages) {
const { rawMessageInfo } = message; const { rawMessageInfo } = message;
rawMessageInfos.push(rawMessageInfo); rawMessageInfos.push(rawMessageInfo);
const { threadID } = rawMessageInfo; const { threadID } = rawMessageInfo;
const currentCountValue = threadToMessageCount.get(threadID); const currentCountValue = threadToMessageCount.get(threadID);
const currentCount = currentCountValue ? currentCountValue : 0; const currentCount = currentCountValue ? currentCountValue : 0;
threadToMessageCount.set(threadID, currentCount + 1); threadToMessageCount.set(threadID, currentCount + 1);
} }
▲ Show 20 Lines • Show All 479 Lines • ▼ Show 20 Lines SELECT m.id, (
ORDER BY time DESC, id DESC ORDER BY time DESC, id DESC
LIMIT 1 LIMIT 1
) content ) content
FROM messages m FROM messages m
WHERE m.id IN(${messageIDs}) WHERE m.id IN(${messageIDs})
`; `;
const [result] = await dbQuery(latestEditedMessageQuery); const [result] = await dbQuery(latestEditedMessageQuery);
const latestContentByID = new Map(); const latestContentByID = new Map<string, EditMessageContent>();
for (const row of result) { for (const row of result) {
if (!row.content) { if (!row.content) {
continue; continue;
} }
const content = JSON.parse(row.content); const content = JSON.parse(row.content);
latestContentByID.set(row.id.toString(), content); latestContentByID.set(row.id.toString(), content);
} }
▲ Show 20 Lines • Show All 181 Lines • Show Last 20 Lines
View Options

services/commtest/src/tunnelbroker/tunnelbroker_utils.rs

Show First 20 Lines • Show All 342 Lines • ▼ Show 20 Lines query.append(SQL`
ORDER BY tw.threadID, tw.time DESC, tw.id DESC ORDER BY tw.threadID, tw.time DESC, tw.id DESC
`); `);
const [result] = await dbQuery(query); const [result] = await dbQuery(query);
const derivedMessages = await fetchDerivedMessages(result, viewer); const derivedMessages = await fetchDerivedMessages(result, viewer);
const messages = await parseMessageSQLResult(result, derivedMessages, viewer); const messages = await parseMessageSQLResult(result, derivedMessages, viewer);
const rawMessageInfos = []; const rawMessageInfos = [];
const threadToMessageCount = new Map(); const threadToMessageCount = new Map<string, number>();
for (const message of messages) { for (const message of messages) {
const { rawMessageInfo } = message; const { rawMessageInfo } = message;
rawMessageInfos.push(rawMessageInfo); rawMessageInfos.push(rawMessageInfo);
const { threadID } = rawMessageInfo; const { threadID } = rawMessageInfo;
const currentCountValue = threadToMessageCount.get(threadID); const currentCountValue = threadToMessageCount.get(threadID);
const currentCount = currentCountValue ? currentCountValue : 0; const currentCount = currentCountValue ? currentCountValue : 0;
threadToMessageCount.set(threadID, currentCount + 1); threadToMessageCount.set(threadID, currentCount + 1);
} }
▲ Show 20 Lines • Show All 479 Lines • ▼ Show 20 Lines SELECT m.id, (
ORDER BY time DESC, id DESC ORDER BY time DESC, id DESC
LIMIT 1 LIMIT 1
) content ) content
FROM messages m FROM messages m
WHERE m.id IN(${messageIDs}) WHERE m.id IN(${messageIDs})
`; `;
const [result] = await dbQuery(latestEditedMessageQuery); const [result] = await dbQuery(latestEditedMessageQuery);
const latestContentByID = new Map(); const latestContentByID = new Map<string, EditMessageContent>();
for (const row of result) { for (const row of result) {
if (!row.content) { if (!row.content) {
continue; continue;
} }
const content = JSON.parse(row.content); const content = JSON.parse(row.content);
latestContentByID.set(row.id.toString(), content); latestContentByID.set(row.id.toString(), content);
} }
▲ Show 20 Lines • Show All 181 Lines • Show Last 20 Lines
View Options

services/commtest/tests/tunnelbroker_integration_test.rs

Show First 20 Lines • Show All 342 Lines • ▼ Show 20 Lines query.append(SQL`
ORDER BY tw.threadID, tw.time DESC, tw.id DESC ORDER BY tw.threadID, tw.time DESC, tw.id DESC
`); `);
const [result] = await dbQuery(query); const [result] = await dbQuery(query);
const derivedMessages = await fetchDerivedMessages(result, viewer); const derivedMessages = await fetchDerivedMessages(result, viewer);
const messages = await parseMessageSQLResult(result, derivedMessages, viewer); const messages = await parseMessageSQLResult(result, derivedMessages, viewer);
const rawMessageInfos = []; const rawMessageInfos = [];
const threadToMessageCount = new Map(); const threadToMessageCount = new Map<string, number>();
for (const message of messages) { for (const message of messages) {
const { rawMessageInfo } = message; const { rawMessageInfo } = message;
rawMessageInfos.push(rawMessageInfo); rawMessageInfos.push(rawMessageInfo);
const { threadID } = rawMessageInfo; const { threadID } = rawMessageInfo;
const currentCountValue = threadToMessageCount.get(threadID); const currentCountValue = threadToMessageCount.get(threadID);
const currentCount = currentCountValue ? currentCountValue : 0; const currentCount = currentCountValue ? currentCountValue : 0;
threadToMessageCount.set(threadID, currentCount + 1); threadToMessageCount.set(threadID, currentCount + 1);
} }
▲ Show 20 Lines • Show All 479 Lines • ▼ Show 20 Lines SELECT m.id, (
ORDER BY time DESC, id DESC ORDER BY time DESC, id DESC
LIMIT 1 LIMIT 1
) content ) content
FROM messages m FROM messages m
WHERE m.id IN(${messageIDs}) WHERE m.id IN(${messageIDs})
`; `;
const [result] = await dbQuery(latestEditedMessageQuery); const [result] = await dbQuery(latestEditedMessageQuery);
const latestContentByID = new Map(); const latestContentByID = new Map<string, EditMessageContent>();
for (const row of result) { for (const row of result) {
if (!row.content) { if (!row.content) {
continue; continue;
} }
const content = JSON.parse(row.content); const content = JSON.parse(row.content);
latestContentByID.set(row.id.toString(), content); latestContentByID.set(row.id.toString(), content);
} }
▲ Show 20 Lines • Show All 181 Lines • Show Last 20 Lines
View Options

services/tunnelbroker/Cargo.lock

Loading...
View Options

services/tunnelbroker/Cargo.toml

Loading...
View Options

services/tunnelbroker/src/constants.rs

Loading...
View Options

services/tunnelbroker/src/main.rs

Loading...
View Options

services/tunnelbroker/src/websockets/mod.rs

Loading...
View Options

shared/tunnelbroker_messages/src/messages/mod.rs

Loading...