halkyon/packages/halkyon_base_server/test/integration/instance/instance_test.dart
Tizian 「ティツィアーン」 554e1604b4
feat(base,app,learn): invitations to shared spaces by mail and by link
The instance's half of Halkyon's ADR 0044, step 5 (D37 to D40).

An invitation by mail (sharedSpace.inviteByEmail) goes out through the
register (send-space-invitation), naming who invites by their handle
and nothing of what is shared, with a link to /join/<token>. The
instance keeps only the address's keyed hash, as for sign-in, and the
SHA-256 of the token. Whoever opens it joins with a code mailed to that
address (EmailCodePurpose.joinSpace, proven through the register,
prove-address-code), so a forwarded mail admits nobody else; a code
proving another address is refused. It lapses after 14 days, and the
hourly pruning forgets it; inviting the address again replaces it.

A space's own link (setJoinLink, the Owner's) admits whoever opens it
as a Viewer (joinByLink) while it is on; switched off and on, it gets a
new token. Its token is kept as it is, so that whoever may invite copies
the link again (joinLink). The page at /join/<token>, in English and
German, says who invites and as whom; preview tells the app the same.

A membership someone else made is new to its member until they mark it
seen (isNew, addedBy; mine names who shared it), for the Inbox.

halkyon_app learns the two new refusals (handleNeeded, otherAddress),
which Learn reports as not allowed until its screens offer these ways
in. The ADR records D37 to D40 and how the instance's half is built.

The migration, the same in the module and in each server including it
(Learn, Meditate, Todo, Train):

  ALTER TABLE "shared_space" ADD COLUMN "joinToken" text;
  CREATE UNIQUE INDEX "shared_space_join_token_idx"
    ON "shared_space" ("joinToken");
  CREATE TABLE "shared_space_email_invitation" (…), with its unique
    indexes on the space and address hash, and on the token's hash,
    and its foreign key to "shared_space" ON DELETE CASCADE;
  ALTER TABLE "shared_space_member" ADD COLUMN "addedBy" uuid;
  ALTER TABLE "shared_space_member"
    ADD COLUMN "isNew" boolean NOT NULL DEFAULT false;

Every space gets no token, and the unique index allows any number of
nulls; every membership gets no one who added it and isn't new, so
nothing already shared shows in an Inbox. The new table starts empty.
None of it rewrites a table, and the server before the switch names its
own columns, so it keeps working.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
2026-11-11 18:36:21 +01:00

112 lines
3.1 KiB
Dart

import 'package:halkyon_base_server/base.dart';
import 'package:serverpod/serverpod.dart';
import 'package:test/test.dart';
import '../support/fixtures.dart';
import '../test_tools/serverpod_test_tools.dart';
/// Keeps nothing; there to say the instance can mail codes.
final class _NoMail implements CodeMailer {
@override
Future<void> send(
Session session, {
required String to,
required String code,
required EmailCodePurpose purpose,
required String language,
}) async {}
@override
Future<void> sendResetNotice(
Session session, {
required String to,
required AccountResetKind kind,
required DateTime takesEffectAt,
required String language,
}) async {}
@override
Future<void> sendCodesWaitNotice(
Session session, {
required String to,
required DateTime until,
required String language,
}) async {}
@override
Future<void> sendInvitation(
Session session, {
required String to,
required String inviter,
required String app,
required Uri link,
required DateTime lapsesAt,
required String language,
}) async {}
}
void main() {
withServerpod('What every instance tells its apps', (
sessionBuilder,
endpoints,
) {
late InstanceBasics basics;
setUp(() async {
useBase(sessionBuilder);
basics = await endpoints.instance.basics(
sessionBuilder.copyWith(
authentication: AuthenticationOverride.unauthenticated(),
),
);
});
test('names the app it serves, so an app recognises its own instances', () {
expect(basics.app, testApp);
});
test("names where the host's project publishes its source when the "
'operator set nothing', () {
// The tests run without SOURCE_URL.
expect(basics.sourceCodeUrl, testUpstreamSourceCodeUrl);
});
test('names the oldest app build the host works with, to anyone, so an '
'older app can say it needs an update', () {
expect(basics.minimumAppBuild, testMinimumAppBuild);
});
test('says nothing of where its data and backups are where the '
'operator said nothing', () {
// The tests run without DATA_LOCATION and BACKUP_LOCATION.
expect(basics.dataLocation, isNull);
expect(basics.backupLocation, isNull);
});
test('serves no GitHub sign-in: GitHub signs nobody in any more (ADR '
'0020, D36)', () {
final pod = sessionBuilder.build().serverpod;
expect(pod.server.endpoints.getConnectorByName('gitHubSignIn'), isNull);
});
test('offers email sign-in only where it can mail codes', () async {
final codes = EmailCodes.of(sessionBuilder.build().serverpod);
final unauthenticated = sessionBuilder.copyWith(
authentication: AuthenticationOverride.unauthenticated(),
);
addTearDown(() => codes.mailer = null);
codes.mailer = null;
expect(
(await endpoints.instance.basics(unauthenticated)).emailSignIn,
isFalse,
);
codes.mailer = _NoMail();
expect(
(await endpoints.instance.basics(unauthenticated)).emailSignIn,
isTrue,
);
});
});
}