Skip to content

feat: introduce FederationSDK class #292

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

Merged
ggazzo merged 10 commits into from
Nov 3, 2025
Merged

feat: introduce FederationSDK class #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ed5a20a
feat: create federation sdk class
sampaiodiego Oct 30, 2025
8902694
add emitter and missing methods
sampaiodiego Oct 31, 2025
eeb4cfc
config service as singleton
sampaiodiego Oct 31, 2025
723ef4e
use new getConfig for individual values
sampaiodiego Oct 31, 2025
fdd0b5f
add new edu config options
sampaiodiego Oct 31, 2025
28bf661
startup staging area
sampaiodiego Oct 31, 2025
4389136
fix lint
sampaiodiego Oct 31, 2025
5ec0f4e
text: mock getConfig
sampaiodiego Oct 31, 2025
9408507
tests: fix DatabaseConnectionService
sampaiodiego Oct 31, 2025
126d650
code cleanup
sampaiodiego Nov 3, 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
142 changes: 0 additions & 142 deletions packages/federation-sdk/src/container.ts
View file
Open in desktop

This file was deleted.

28 changes: 0 additions & 28 deletions packages/federation-sdk/src/federation.module.ts
View file
Open in desktop

This file was deleted.

187 changes: 86 additions & 101 deletions packages/federation-sdk/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
import type { Membership, MessageType } from '@rocket.chat/federation-core';
import type { EventID, PduForType } from '@rocket.chat/federation-room';
import 'reflect-metadata';

import type { Emitter } from '@rocket.chat/emitter';
import type {
EventStagingStore,
Membership,
MessageType,
} from '@rocket.chat/federation-core';
import type {
EventID,
EventStore,
PduForType,
} from '@rocket.chat/federation-room';
import { Collection } from 'mongodb';
import { container } from 'tsyringe';
import { ConfigService } from './services/config.service';
import { EduService } from './services/edu.service';
import { EventAuthorizationService } from './services/event-authorization.service';
import { StagingAreaListener } from './listeners/staging-area.listener';
import { Key } from './repositories/key.repository';
import { Lock } from './repositories/lock.repository';
import { Room } from './repositories/room.repository';
import { Server } from './repositories/server.repository';
import { StateGraphStore } from './repositories/state-graph.repository';
import { Upload } from './repositories/upload.repository';
import { FederationSDK } from './sdk';
import { DatabaseConnectionService } from './services/database-connection.service';
import { EventEmitterService } from './services/event-emitter.service';
import { EventService } from './services/event.service';
import { FederationRequestService } from './services/federation-request.service';
import { InviteService } from './services/invite.service';
import { MediaService } from './services/media.service';
import { MessageService } from './services/message.service';
import { ProfilesService } from './services/profiles.service';
import { RoomService } from './services/room.service';
import { SendJoinService } from './services/send-join.service';
import { ServerService } from './services/server.service';
import { StateService } from './services/state.service';
import { WellKnownService } from './services/well-known.service';

export type {
Pdu,
Expand All @@ -38,7 +45,6 @@ export type {
} from '@rocket.chat/federation-core';
export { generateEd25519RandomSecretKey } from '@rocket.chat/federation-crypto';

export { FederationEndpoints } from './specs/federation-api';
export type {
MakeJoinResponse,
SendJoinResponse,
Expand All @@ -49,38 +55,6 @@ export type {
Version,
} from './specs/federation-api';

export { FederationModule } from './federation.module';

export { FederationRequestService } from './services/federation-request.service';
export { FederationService } from './services/federation.service';
export { WellKnownService } from './services/well-known.service';
export { ConfigService } from './services/config.service';
export type { AppConfig } from './services/config.service';
export { DatabaseConnectionService } from './services/database-connection.service';
export { EduService } from './services/edu.service';

export { ServerService } from './services/server.service';
export { EventAuthorizationService } from './services/event-authorization.service';
export { MissingEventService } from './services/missing-event.service';
export { ProfilesService } from './services/profiles.service';
export { EventFetcherService } from './services/event-fetcher.service';
export type { FetchedEvents } from './services/event-fetcher.service';
export { InviteService } from './services/invite.service';
export type { ProcessInviteEvent } from './services/invite.service';
export { MessageService } from './services/message.service';
export { EventService } from './services/event.service';
export { RoomService } from './services/room.service';
export { StateService } from './services/state.service';
export { StagingAreaService } from './services/staging-area.service';
export { SendJoinService } from './services/send-join.service';
export { EventEmitterService } from './services/event-emitter.service';
export { MediaService } from './services/media.service';
// Repository interfaces and implementations

// Queue implementations
export { BaseQueue, type QueueHandler } from './queues/base.queue';
export { StagingAreaQueue } from './queues/staging-area.queue';

// Utility exports
export { getErrorMessage } from './utils/get-error-message';
export { USERNAME_REGEX, ROOM_ID_REGEX } from './utils/validation-regex';
Expand All @@ -92,29 +66,6 @@ export {
export { errCodes } from './utils/response-codes';
export { NotAllowedError } from './services/invite.service';

export { EventRepository } from './repositories/event.repository';
export { RoomRepository } from './repositories/room.repository';
export { ServerRepository } from './repositories/server.repository';
export { KeyRepository } from './repositories/key.repository';

export interface HomeserverServices {
room: RoomService;
message: MessageService;
event: EventService;
invite: InviteService;
wellKnown: WellKnownService;
profile: ProfilesService;
state: StateService;
sendJoin: SendJoinService;
server: ServerService;
config: ConfigService;
edu: EduService;
media: MediaService;
request: FederationRequestService;
federationAuth: EventAuthorizationService;
emitter: EventEmitterService;
}

type RelatesTo =
| {
rel_type: 'm.replace';
Expand Down Expand Up @@ -304,37 +255,71 @@ export type HomeserverEventSignatures = {
};
};

export function getAllServices(): HomeserverServices {
return {
room: container.resolve(RoomService),
message: container.resolve(MessageService),
event: container.resolve(EventService),
invite: container.resolve(InviteService),
wellKnown: container.resolve(WellKnownService),
profile: container.resolve(ProfilesService),
state: container.resolve(StateService),
sendJoin: container.resolve(SendJoinService),
server: container.resolve(ServerService),
config: container.resolve(ConfigService),
edu: container.resolve(EduService),
media: container.resolve(MediaService),
request: container.resolve(FederationRequestService),
federationAuth: container.resolve(EventAuthorizationService),
emitter: container.resolve(EventEmitterService),
};
}

export { StagingAreaListener } from './listeners/staging-area.listener';

export {
createFederationContainer,
type FederationContainerOptions,
} from './container';

export { DependencyContainer } from 'tsyringe';

export {
roomIdSchema,
userIdSchema,
eventIdSchema,
} from '@rocket.chat/federation-room';

export async function init({
emitter,
dbConfig,
}: {
emitter?: Emitter<HomeserverEventSignatures>;
dbConfig: {
uri: string;
name: string;
poolSize: number;
};
}) {
const dbConnection = new DatabaseConnectionService(dbConfig);
const db = await dbConnection.getDb();

container.register<Collection<EventStore>>('EventCollection', {
useValue: db.collection<EventStore>('rocketchat_federation_events'),
});

container.register<Collection<EventStagingStore>>('EventStagingCollection', {
useValue: db.collection<EventStagingStore>(
'rocketchat_federation_events_staging',
),
});

container.register<Collection<Key>>('KeyCollection', {
useValue: db.collection<Key>('rocketchat_federation_keys'),
});

container.register<Collection<Lock>>('LockCollection', {
useValue: db.collection<Lock>('rocketchat_federation_locks'),
});

container.register<Collection<Room>>('RoomCollection', {
useValue: db.collection<Room>('rocketchat_federation_rooms'),
});

container.register<Collection<Server>>('ServerCollection', {
useValue: db.collection<Server>('rocketchat_federation_servers'),
});

container.register<Collection<Upload>>('UploadCollection', {
useValue: db.collection<Upload>('rocketchat_uploads'),
});

container.register<Collection<StateGraphStore>>('StateGraphCollection', {
useValue: db.collection<StateGraphStore>(
'rocketchat_federation_state_graphs',
),
});

const eventEmitterService = container.resolve(EventEmitterService);
if (emitter) {
eventEmitterService.setEmitter(emitter);
} else {
eventEmitterService.initializeStandalone();
}

// this is required to initialize the listener and register the queue handler
container.resolve(StagingAreaListener);
}

export const federationSDK = container.resolve(FederationSDK);
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Delay federationSDK resolution until after init.

Resolving FederationSDK at module load happens before init() registers the Mongo-backed tokens (e.g., RoomCollection). Tsyringe then fails with ResolutionError: Attempted to resolve unregistered dependency token "RoomCollection" as soon as any consumer imports { federationSDK }, preventing the app from ever calling init(). Please defer the resolution until after init completes—store the instance during init or expose a lazy getter that resolves once the container setup is done. For example:

-export const federationSDK = container.resolve(FederationSDK);
+let federationSDKInstance: FederationSDK | null = null;
+
+export function getFederationSDK(): FederationSDK {
+	if (!federationSDKInstance) {
+		throw new Error('Call init() before accessing federationSDK');
+	}
+	return federationSDKInstance;
+}

and set federationSDKInstance = container.resolve(FederationSDK); at the end of init().

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In packages/federation-sdk/src/index.ts around line 325, the module currently
resolves FederationSDK at import time which triggers a ResolutionError because
init() hasn't registered required tokens like RoomCollection; change this so the
container.resolve(FederationSDK) is not called at module load: remove the
immediate export and instead provide a variable (e.g., federationSDKInstance)
that is set inside init() after all tokens are registered or replace the
exported value with a lazy getter function that calls
container.resolve(FederationSDK) on first access; ensure init() assigns the
instance at the end and exports either the instance or the getter so consumers
get a resolved SDK only after init completes.

Loading