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

feat(core): Create names for personal projects in one place and resuse it #8995

Merged
merged 3 commits into from
Apr 8, 2024
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
5 changes: 4 additions & 1 deletion packages/cli/src/databases/entities/Project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import Container from 'typedi';
import { ProjectRepository } from '../repositories/project.repository';
import { ApplicationError, ErrorReporterProxy } from 'n8n-workflow';
import { Logger } from '@/Logger';
import { UserRepository } from '../repositories/user.repository';

export type ProjectType = 'personal' | 'team' | 'public';

Expand Down Expand Up @@ -49,7 +50,9 @@ export class UserSubscriber implements EntitySubscriberInterface<User> {
fields.includes('email')
) {
const oldUser = event.databaseEntity;
const name = `${newUserData.firstName} ${newUserData.lastName} <${newUserData.email}>`;
const name = Container.get(UserRepository)
.create(newUserData)
.createPersonalProjectName();

const project = await Container.get(ProjectRepository).getPersonalProjectForUser(
oldUser.id,
Expand Down
10 changes: 10 additions & 0 deletions packages/cli/src/databases/entities/User.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,14 @@ export class User extends WithTimestamps implements IUser {
const { password, apiKey, mfaSecret, mfaRecoveryCodes, ...rest } = this;
return rest;
}

createPersonalProjectName() {
if (this.firstName && this.lastName && this.email) {
return `${this.firstName} ${this.lastName} <${this.email}>`;
} else if (this.email) {
return `<${this.email}>`;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@krynble This is what it generates for shell accounts.

Copy link
Contributor

Choose a reason for hiding this comment

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

One thing I'm wondering is the fact that we tested a lot of places that use this function but we haven't tested this function itself. We have 3 possible outcomes and we have no tests for it.

Would you mind adding a few tests for it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

} else {
return 'Unnamed Project';
}
}
}
1 change: 1 addition & 0 deletions packages/cli/src/databases/repositories/user.repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ export class UserRepository extends Repository<User> {
const savedProject = await entityManager.save<Project>(
entityManager.create(Project, {
type: 'personal',
name: savedUser.createPersonalProjectName(),
}),
);
await entityManager.save<ProjectRelation>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ describe('InvitationController', () => {
});

expect(projectRelation).not.toBeUndefined();
expect(projectRelation.project.name).toBeNull();
expect(projectRelation.project.name).toBe(storedUser.createPersonalProjectName());
expect(projectRelation.project.type).toBe('personal');
});

Expand Down
21 changes: 10 additions & 11 deletions packages/cli/test/integration/credentials.ee.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ describe('GET /credentials', () => {
expect(ownerCredential.homeProject).toMatchObject({
id: ownerPersonalProject.id,
type: 'personal',
name: 'My n8n',
name: owner.createPersonalProjectName(),
});

expect(Array.isArray(ownerCredential.sharedWithProjects)).toBe(true);
Expand All @@ -132,14 +132,13 @@ describe('GET /credentials', () => {
expect(sharee).toMatchObject({
id: orderedSharedWith[idx].id,
type: orderedSharedWith[idx].type,
name: 'My n8n',
});
});

expect(memberCredential.homeProject).toMatchObject({
id: member1PersonalProject.id,
type: member1PersonalProject.type,
name: 'My n8n',
name: member1.createPersonalProjectName(),
});

expect(Array.isArray(memberCredential.sharedWithProjects)).toBe(true);
Expand Down Expand Up @@ -177,14 +176,14 @@ describe('GET /credentials', () => {

expect(member1Credential.homeProject).toMatchObject({
id: member1PersonalProject.id,
name: 'My n8n',
name: member1.createPersonalProjectName(),
type: member1PersonalProject.type,
});

expect(member1Credential.sharedWithProjects).toHaveLength(1);
expect(member1Credential.sharedWithProjects[0]).toMatchObject({
id: member2PersonalProject.id,
name: 'My n8n',
name: member2.createPersonalProjectName(),
type: member2PersonalProject.type,
});
});
Expand Down Expand Up @@ -232,7 +231,7 @@ describe('GET /credentials/:id', () => {

expect(firstCredential.homeProject).toMatchObject({
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: ownerPersonalProject.type,
});
expect(firstCredential.sharedWithProjects).toHaveLength(0);
Expand Down Expand Up @@ -271,13 +270,13 @@ describe('GET /credentials/:id', () => {
expect(credential).toMatchObject({
homeProject: {
id: member1PersonalProject.id,
name: 'My n8n',
name: member1.createPersonalProjectName(),
type: member1PersonalProject.type,
},
sharedWithProjects: [
{
id: member2PersonalProject.id,
name: 'My n8n',
name: member2.createPersonalProjectName(),
type: member2PersonalProject.type,
},
],
Expand Down Expand Up @@ -322,18 +321,18 @@ describe('GET /credentials/:id', () => {
expect(firstCredential).toMatchObject({
homeProject: {
id: member1PersonalProject.id,
name: 'My n8n',
name: member1.createPersonalProjectName(),
type: 'personal',
},
sharedWithProjects: expect.arrayContaining([
{
id: member2PersonalProject.id,
name: 'My n8n',
name: member2.createPersonalProjectName(),
type: member2PersonalProject.type,
},
{
id: member3PersonalProject.id,
name: 'My n8n',
name: member3.createPersonalProjectName(),
type: member3PersonalProject.type,
},
]),
Expand Down
16 changes: 5 additions & 11 deletions packages/cli/test/integration/me.api.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,7 @@ describe('Owner shell', () => {
ProjectRepository,
).getPersonalProjectForUserOrFail(storedOwnerShell.id);

expect(storedPersonalProject.name).toBe(
`${storedOwnerShell.firstName} ${storedOwnerShell.lastName} <${storedOwnerShell.email}>`,
);
expect(storedPersonalProject.name).toBe(storedOwnerShell.createPersonalProjectName());
}
});

Expand All @@ -91,7 +89,7 @@ describe('Owner shell', () => {
ProjectRepository,
).getPersonalProjectForUserOrFail(storedOwnerShell.id);

expect(storedPersonalProject.name).toBeNull();
expect(storedPersonalProject.name).toBe(storedOwnerShell.createPersonalProjectName());
}
});

Expand Down Expand Up @@ -224,9 +222,7 @@ describe('Member', () => {
const storedPersonalProject =
await Container.get(ProjectRepository).getPersonalProjectForUserOrFail(id);

expect(storedPersonalProject.name).toBe(
`${storedMember.firstName} ${storedMember.lastName} <${storedMember.email}>`,
);
expect(storedPersonalProject.name).toBe(storedMember.createPersonalProjectName());
}
});

Expand All @@ -244,7 +240,7 @@ describe('Member', () => {
ProjectRepository,
).getPersonalProjectForUserOrFail(storedMember.id);

expect(storedPersonalProject.name).toBeNull();
expect(storedPersonalProject.name).toBe(storedMember.createPersonalProjectName());
}
});

Expand Down Expand Up @@ -367,9 +363,7 @@ describe('Owner', () => {
ProjectRepository,
).getPersonalProjectForUserOrFail(storedOwner.id);

expect(storedPersonalProject.name).toBe(
`${storedOwner.firstName} ${storedOwner.lastName} <${storedOwner.email}>`,
);
expect(storedPersonalProject.name).toBe(storedOwner.createPersonalProjectName());
}
});
});
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/test/integration/project.api.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ describe('GET /projects/', () => {
return false;
}
const u = [testUser1, testUser2, testUser3][i];
return p.name === `${u.firstName} ${u.lastName}`;
return p.name === u.createPersonalProjectName();
}),
).toBe(true);
expect(respProjects.find((p) => p.id === teamProject1.id)).not.toBeUndefined();
Expand Down Expand Up @@ -107,7 +107,7 @@ describe('GET /projects/', () => {
return false;
}
const u = [ownerUser, testUser1, testUser2, testUser3][i];
return p.name === `${u.firstName} ${u.lastName}`;
return p.name === u.createPersonalProjectName();
}),
).toBe(true);
expect(respProjects.find((p) => p.id === teamProject1.id)).not.toBeUndefined();
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/test/integration/users.api.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import { RESPONSE_ERROR_MESSAGES } from '@/constants';
import { ProjectRepository } from '@/databases/repositories/project.repository';
import { createTeamProject, getPersonalProject, linkUserToProject } from './shared/db/projects';
import { ProjectRelationRepository } from '@/databases/repositories/projectRelation.repository';
import { v4 as uuid } from 'uuid';

mockInstance(ExecutionService);

Expand Down Expand Up @@ -543,7 +544,7 @@ describe('DELETE /users/:id', () => {
});

test('should fail to delete a user that does not exist', async () => {
await ownerAgent.delete('/users/foobar').query({ transferId: '' }).expect(404);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unrelated fix for the postgres tests.

await ownerAgent.delete(`/users/${uuid()}`).query({ transferId: '' }).expect(404);
});

test('should fail to transfer to a project that does not exist', async () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ describe('GET /workflows/:id', () => {

expect(responseWorkflow.homeProject).toMatchObject({
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: 'personal',
});

Expand All @@ -313,14 +313,14 @@ describe('GET /workflows/:id', () => {

expect(responseWorkflow.homeProject).toMatchObject({
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: 'personal',
});

expect(responseWorkflow.sharedWithProjects).toHaveLength(1);
expect(responseWorkflow.sharedWithProjects[0]).toMatchObject({
id: memberPersonalProject.id,
name: 'My n8n',
name: member.createPersonalProjectName(),
type: 'personal',
});
});
Expand All @@ -334,7 +334,7 @@ describe('GET /workflows/:id', () => {

expect(responseWorkflow.homeProject).toMatchObject({
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: 'personal',
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ describe('GET /workflows', () => {
versionId: any(String),
homeProject: {
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: ownerPersonalProject.type,
},
sharedWithProjects: [],
Expand All @@ -358,7 +358,7 @@ describe('GET /workflows', () => {
versionId: any(String),
homeProject: {
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: ownerPersonalProject.type,
},
sharedWithProjects: [],
Expand Down Expand Up @@ -704,7 +704,7 @@ describe('GET /workflows', () => {
id: any(String),
homeProject: {
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: ownerPersonalProject.type,
},
sharedWithProjects: [],
Expand All @@ -713,7 +713,7 @@ describe('GET /workflows', () => {
id: any(String),
homeProject: {
id: ownerPersonalProject.id,
name: 'My n8n',
name: owner.createPersonalProjectName(),
type: ownerPersonalProject.type,
},
sharedWithProjects: [],
Expand Down
18 changes: 18 additions & 0 deletions packages/cli/test/unit/databases/entities/user.entity.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,22 @@ describe('User Entity', () => {
);
});
});

describe('createPersonalProjectName', () => {
test.each([
['Nathan', 'Nathaniel', '[email protected]', 'Nathan Nathaniel <[email protected]>'],
[undefined, 'Nathaniel', '[email protected]', '<[email protected]>'],
['Nathan', undefined, '[email protected]', '<[email protected]>'],
[undefined, undefined, '[email protected]', '<[email protected]>'],
[undefined, undefined, undefined, 'Unnamed Project'],
['Nathan', 'Nathaniel', undefined, 'Unnamed Project'],
])(
'given fistName: %s, lastName: %s and email: %s this gives the projectName: "%s"',
async (firstName, lastName, email, projectName) => {
const user = new User();
Object.assign(user, { firstName, lastName, email });
expect(user.createPersonalProjectName()).toBe(projectName);
},
);
});
});
Loading