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.

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

fix(core): Ensure inviter and invitee are set correctly in invite link #7943

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 packages/cli/src/controllers/users.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ export class UsersController {
const users = await this.userService.findMany(findManyOptions);

const publicUsers: Array<Partial<PublicUser>> = await Promise.all(
users.map(async (u) => this.userService.toPublic(u, { withInviteUrl: true })),
users.map(async (u) =>
this.userService.toPublic(u, { withInviteUrl: true, inviterId: req.user.id }),
),
);

return listQueryOptions
Expand Down
29 changes: 19 additions & 10 deletions packages/cli/src/services/user.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { createPasswordSha } from '@/auth/jwt';
import { UserManagementMailer } from '@/UserManagement/email';
import { InternalHooks } from '@/InternalHooks';
import { RoleService } from '@/services/role.service';
import { ErrorReporterProxy as ErrorReporter } from 'n8n-workflow';
import { ApplicationError, ErrorReporterProxy as ErrorReporter } from 'n8n-workflow';
import type { UserRequest } from '@/requests';
import { InternalServerError } from '@/errors/response-errors/internal-server.error';

Expand Down Expand Up @@ -123,7 +123,12 @@ export class UserService {

async toPublic(
user: User,
options?: { withInviteUrl?: boolean; posthog?: PostHogClient; withScopes?: boolean },
options?: {
withInviteUrl?: boolean;
inviterId?: string;
posthog?: PostHogClient;
withScopes?: boolean;
},
) {
const { password, updatedAt, apiKey, authIdentities, mfaRecoveryCodes, mfaSecret, ...rest } =
user;
Expand All @@ -136,30 +141,34 @@ export class UserService {
hasRecoveryCodesLeft: !!user.mfaRecoveryCodes?.length,
};

if (options?.withScopes) {
publicUser.globalScopes = user.globalScopes;
if (options?.withInviteUrl && !options?.inviterId) {
throw new ApplicationError('Inviter ID is required to generate invite URL');
}

if (options?.withInviteUrl && publicUser.isPending) {
publicUser = this.addInviteUrl(publicUser, user.id);
if (options?.withInviteUrl && options?.inviterId && publicUser.isPending) {
publicUser = this.addInviteUrl(options.inviterId, publicUser);
}

if (options?.posthog) {
publicUser = await this.addFeatureFlags(publicUser, options.posthog);
}

if (options?.withScopes) {
publicUser.globalScopes = user.globalScopes;
}

return publicUser;
}

private addInviteUrl(user: PublicUser, inviterId: string) {
private addInviteUrl(inviterId: string, invitee: PublicUser) {
const url = new URL(getInstanceBaseUrl());
url.pathname = '/signup';
url.searchParams.set('inviterId', inviterId);
url.searchParams.set('inviteeId', user.id);
url.searchParams.set('inviteeId', invitee.id);

user.inviteAcceptUrl = url.toString();
invitee.inviteAcceptUrl = url.toString();

return user;
return invitee;
}

private async addFeatureFlags(publicUser: PublicUser, posthog: PostHogClient) {
Expand Down
23 changes: 15 additions & 8 deletions packages/cli/test/unit/services/user.service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,22 +50,29 @@ describe('UserService', () => {
});

it('should add scopes if requested', async () => {
const scopeless = await userService.toPublic(commonMockUser, { withScopes: false });

const scoped = await userService.toPublic(commonMockUser, { withScopes: true });
const unscoped = await userService.toPublic(commonMockUser);

expect(Array.isArray(scopeless.globalScopes)).toBe(false);
expect(Array.isArray(scoped.globalScopes)).toBe(true);
expect(scoped.globalScopes).toEqual([]);
expect(unscoped.globalScopes).toBeUndefined();
});

it('should add invite URL if requested', async () => {
const mockUser = Object.assign(new User(), { id: uuid(), isPending: true });
const firstUser = Object.assign(new User(), { id: uuid() });
const secondUser = Object.assign(new User(), { id: uuid(), isPending: true });

const withUrl = await userService.toPublic(mockUser, { withInviteUrl: true });
const withoutUrl = await userService.toPublic(mockUser, { withInviteUrl: false });
const withoutUrl = await userService.toPublic(secondUser);
const withUrl = await userService.toPublic(secondUser, {
withInviteUrl: true,
inviterId: firstUser.id,
});

expect(typeof withUrl.inviteAcceptUrl === 'string').toBe(true);
expect(withoutUrl.inviteAcceptUrl).toBeUndefined();

const url = new URL(withUrl.inviteAcceptUrl ?? '');

expect(url.searchParams.get('inviterId')).toBe(firstUser.id);
expect(url.searchParams.get('inviteeId')).toBe(secondUser.id);
});
});

Expand Down
Loading