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: Allow sharing to and from team projects (no-changelog) #10144

Merged
Show file tree
Hide file tree
Changes from 5 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
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,18 @@ export = {
transferCredential: [
projectScope('credential:move', 'credential'),
async (req: CredentialRequest.Transfer, res: express.Response) => {
const body = z.object({ destinationProjectId: z.string() }).parse(req.body);
const body = z
.object({
destinationProjectId: z.string(),
shareWithOriginalProject: z.boolean().optional(),
})
.parse(req.body);

await Container.get(EnterpriseCredentialsService).transferOne(
req.user,
req.params.workflowId,
body.destinationProjectId,
body.shareWithOriginalProject ?? false,
);

res.status(204).send();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ put:
destinationProjectId:
type: string
description: The ID of the project to transfer the credential to.
shareWithOriginalProject:
type: boolean
description: Share the transferred credential to the project it originated from.
required:
- destinationProjectId
required: true
Expand Down
25 changes: 15 additions & 10 deletions packages/cli/src/credentials/credentials.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -291,25 +291,22 @@ export class CredentialsController {
let newShareeIds: string[] = [];

await Db.transaction(async (trx) => {
const currentPersonalProjectIDs = credential.shared
const currentProjectIds = credential.shared
.filter((sc) => sc.role === 'credential:user')
.map((sc) => sc.projectId);
const newPersonalProjectIds = shareWithIds;
const newProjectIds = shareWithIds;

const toShare = utils.rightDiff(
[currentPersonalProjectIDs, (id) => id],
[newPersonalProjectIds, (id) => id],
);
const toShare = utils.rightDiff([currentProjectIds, (id) => id], [newProjectIds, (id) => id]);
const toUnshare = utils.rightDiff(
[newPersonalProjectIds, (id) => id],
[currentPersonalProjectIDs, (id) => id],
[newProjectIds, (id) => id],
[currentProjectIds, (id) => id],
);

const deleteResult = await trx.delete(SharedCredentials, {
credentialsId: credentialId,
projectId: In(toUnshare),
});
await this.enterpriseCredentialsService.shareWithProjects(credential, toShare, trx);
await this.enterpriseCredentialsService.shareWithProjects(req.user, credential, toShare, trx);

if (deleteResult.affected) {
amountRemoved = deleteResult.affected;
Expand Down Expand Up @@ -342,12 +339,20 @@ export class CredentialsController {
@Put('/:credentialId/transfer')
@ProjectScope('credential:move')
async transfer(req: CredentialRequest.Transfer) {
const body = z.object({ destinationProjectId: z.string() }).parse(req.body);
// TODO: make shareWithOriginalProject non-optional once the frontend
// has support
const body = z
.object({
destinationProjectId: z.string(),
shareWithOriginalProject: z.boolean().optional(),
})
.parse(req.body);

return await this.enterpriseCredentialsService.transferOne(
req.user,
req.params.credentialId,
body.destinationProjectId,
body.shareWithOriginalProject ?? false,
);
}
}
70 changes: 56 additions & 14 deletions packages/cli/src/credentials/credentials.service.ee.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { Project } from '@/databases/entities/Project';
import { ProjectService } from '@/services/project.service';
import { TransferCredentialError } from '@/errors/response-errors/transfer-credential.error';
import { SharedCredentials } from '@/databases/entities/SharedCredentials';
import { RoleService } from '@/services/role.service';

@Service()
export class EnterpriseCredentialsService {
Expand All @@ -20,29 +21,47 @@ export class EnterpriseCredentialsService {
private readonly ownershipService: OwnershipService,
private readonly credentialsService: CredentialsService,
private readonly projectService: ProjectService,
private readonly roleService: RoleService,
) {}

async shareWithProjects(
user: User,
credential: CredentialsEntity,
shareWithIds: string[],
entityManager?: EntityManager,
) {
const em = entityManager ?? this.sharedCredentialsRepository.manager;

const projects = await em.find(Project, {
where: { id: In(shareWithIds), type: 'personal' },
where: [
{
id: In(shareWithIds),
type: 'team',
// if user can see all projects, don't check project access
// if they can't, find projects they can list
...(user.hasGlobalScope('project:list')
? {}
: {
projectRelations: {
userId: user.id,
role: In(this.roleService.rolesWithScope('project', 'project:list')),
},
}),
},
{
id: In(shareWithIds),
type: 'personal',
},
],
});

const newSharedCredentials = projects
// We filter by role === 'project:personalOwner' above and there should
// always only be one owner.
.map((project) =>
this.sharedCredentialsRepository.create({
credentialsId: credential.id,
role: 'credential:user',
projectId: project.id,
}),
);
const newSharedCredentials = projects.map((project) =>
this.sharedCredentialsRepository.create({
credentialsId: credential.id,
role: 'credential:user',
projectId: project.id,
}),
);

return await em.save(newSharedCredentials);
}
Expand Down Expand Up @@ -97,7 +116,12 @@ export class EnterpriseCredentialsService {
return { ...rest };
}

async transferOne(user: User, credentialId: string, destinationProjectId: string) {
async transferOne(
user: User,
credentialId: string,
destinationProjectId: string,
shareWithSource: boolean,
ivov marked this conversation as resolved.
Show resolved Hide resolved
) {
// 1. get credential
const credential = await this.sharedCredentialsRepository.findCredentialForUser(
credentialId,
Expand Down Expand Up @@ -147,8 +171,26 @@ export class EnterpriseCredentialsService {

await this.sharedCredentialsRepository.manager.transaction(async (trx) => {
// 6. transfer the credential
// remove all sharings
await trx.remove(credential.shared);

// remove original owner sharing
await trx.remove(ownerSharing);

// share it back as a user if asked to
if (shareWithSource) {
await trx.save(
trx.create(SharedCredentials, {
credentialsId: credential.id,
projectId: sourceProject.id,
role: 'credential:user',
}),
);
}

// remove any previous sharings with the new owner
await trx.delete(SharedCredentials, {
credentialsId: credential.id,
projectId: destinationProjectId,
});

// create new owner-sharing
await trx.save(
Expand Down
27 changes: 27 additions & 0 deletions packages/cli/src/credentials/credentials.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ export class CredentialsService {
let credentials = await this.credentialsRepository.findMany(options.listQueryOptions);

if (isDefaultSelect) {
// Since we're filtering using project ID as part of the relation,
// we end up filtering out all the other relations, meaning that if
// it's shared to a project, it won't be able to find the home project.
// To solve this, we have to get all the relation now, even though
// we're deleting them later.
if ((options.listQueryOptions?.filter?.shared as { projectId?: string })?.projectId) {
const relations = await this.sharedCredentialsRepository.getAllRelationsForCredentials(
credentials.map((c) => c.id),
);
credentials.forEach((c) => {
c.shared = relations.filter((r) => r.credentialsId === c.id);
});
}
credentials = credentials.map((c) => this.ownershipService.addOwnedByAndSharedWith(c));
}

Expand Down Expand Up @@ -130,6 +143,20 @@ export class CredentialsService {
);

if (isDefaultSelect) {
// Since we're filtering using project ID as part of the relation,
// we end up filtering out all the other relations, meaning that if
// it's shared to a project, it won't be able to find the home project.
// To solve this, we have to get all the relation now, even though
// we're deleting them later.
if ((options.listQueryOptions?.filter?.shared as { projectId?: string })?.projectId) {
const relations = await this.sharedCredentialsRepository.getAllRelationsForCredentials(
credentials.map((c) => c.id),
);
credentials.forEach((c) => {
c.shared = relations.filter((r) => r.credentialsId === c.id);
});
}

credentials = credentials.map((c) => this.ownershipService.addOwnedByAndSharedWith(c));
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,13 @@ export class SharedCredentialsRepository extends Repository<SharedCredentials> {
})
)?.project;
}

async getAllRelationsForCredentials(credentialIds: string[]) {
return await this.find({
where: {
credentialsId: In(credentialIds),
},
relations: ['project'],
});
}
}
1 change: 1 addition & 0 deletions packages/cli/src/permissions/project-roles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export const REGULAR_PROJECT_ADMIN_SCOPES: Scope[] = [
'credential:delete',
'credential:list',
'credential:move',
'credential:share',
'project:list',
'project:read',
'project:update',
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/requests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ export declare namespace CredentialRequest {
type Transfer = AuthenticatedRequest<
{ credentialId: string },
{},
{ destinationProjectId: string }
{ destinationProjectId: string; shareWithOriginalProject?: boolean }
>;

type ForWorkflow = AuthenticatedRequest<
Expand Down
Loading
Loading