API: Display membership status while fetching workspace members

[rajdip-b]

Description

When we hit the /api/workspace/{workspaceId}/members endpoint to fetch all the members of a workspace, we also want to get the membership status of the member, i.e, if they have accepted the invitation or not.

Currently, we just get the id, user and the roles they have.

Solution

We would want the return type to also include a active field that will be true if the user has accepted the invitation, false otherwise.

• Update this function to fetch the necessary data:

  keyshade/apps/api/src/workspace/service/workspace.service.ts

  Lines 453 to 517 in fedc43b

  	async getAllMembersOfWorkspace(
  	user: User,
  	workspaceId: Workspace['id'],
  	page: number,
  	limit: number,
  	sort: string,
  	order: string,
  	search: string
  	) {
  	await this.authorityCheckerService.checkAuthorityOverWorkspace({
  	userId: user.id,
  	entity: { id: workspaceId },
  	authority: Authority.READ_USERS,
  	prisma: this.prisma
  	})
  	//get all members of workspace for page with limit
  	const items = await this.prisma.workspaceMember.findMany({
  	skip: page * limit,
  	take: limit,
  	orderBy: {
  	workspace: {
  	[sort]: order
  	}
  	},
  	where: {
  	workspaceId,
  	user: {
  	OR: [
  	{
  	name: {
  	contains: search
  	}
  	},
  	{
  	email: {
  	contains: search
  	}
  	}
  	]
  	}
  	},
  	select: {
  	id: true,
  	user: true,
  	roles: {
  	select: {
  	id: true,
  	role: {
  	select: {
  	id: true,
  	name: true,
  	description: true,
  	colorCode: true,
  	authorities: true,
  	projects: {
  	select: {
  	id: true
  	}
  	}
  	}
  	}
  	}
  	}
  	}
  	})

• The model responsible for storing the invitation status:

  keyshade/apps/api/src/prisma/schema.prisma

  Lines 330 to 340 in fedc43b

  	model WorkspaceMember {
  	id String @id @default(cuid())
  	user User @relation(fields: [userId], references: [id], onDelete: Cascade, onUpdate: Cascade)
  	userId String
  	workspace Workspace @relation(fields: [workspaceId], references: [id], onDelete: Cascade, onUpdate: Cascade)
  	workspaceId String
  	invitationAccepted Boolean @default(false)
  	roles WorkspaceMemberRoleAssociation[]
  	@@unique([workspaceId, userId])
  	}

• Include tests.

[lakshay-saini-au8]

/attempt

[github-actions]

Assigned the issue to @lakshay-saini-au8!

[lakshay-saini-au8]

@rajdip-b if possible can you share what will be the expected response

[lakshay-saini-au8]

is it like

`{
id : "",
type:{active:},
user:{}

`

[rajdip-b]

Hey @lakshay-saini-au8! Sorry about the late reply, must have overlooked your comments.

We just want something like this:

{
  // ...other fields,
  membershipAccepted: true/false
}

[rajdip-b]

@lakshay-saini-au8 any updates on this yet?

[rothardo]

Hi @rajdip-b I would like to work on this issue as I think this is pending since more then 12 weeks,
please let me know if this is up for grabs

[rajdip-b]

Sure, do go ahead!

[rothardo]

Hi @rajdip-b ,

I hope you're doing well. I've been working on setting up the project according to the guidelines, but I've encountered a problem that's been quite bothersome.

I've followed the recommendations regarding PostgreSQL issues, and while I'm using WSL, which has been consuming a lot of memory, I’m managing that.

However, I would really appreciate your help in resolving the issue shown below so I can move forward:

Thank you!

[rajdip-b]

Hey, can you please open up a github discussion for this issue? I feel that a lot of people will benefit from that. We are facing this issue quite often.

[rothardo]

@rajdip-b I have opened a discussion on the same,
thank you

[rothardo]

Hi there! I’m having trouble with the login process, and the documentation isn’t very clear about which modules to run. Could you guide me on how to run the project in full-stack mode? The backend is up and running, but I’m not sure where to find the UI or which directory to check. Thanks! @rajdip-b

[rajdip-b]

The UI is still under works. The designs are incomplete. All of the api dev is currently being done using postman. So it's pointless in running the UI since it can only do so much. I recommend you to go through the postman api docs. You can find the link in readme.

[rajdip-b]

@rothardo any luck?

[rothardo]

@rajdip-b yes, will raise pr soon

[rajdip-b]

Looking forward to it!

[rothardo]

Hey @rajdip-b I was caught up in some important work, I will raise a PR on Monday mostly for this one

[rothardo]

Hey, @rajdip-b I was trying to import the collections and this is what the error was
import collection failed anything exitcode

and also is this causing the problem?

[rajdip-b]

I really don't think that this has got anything to do with our codebase. Also, never faced this error before. If you have followed the steps from our docs and you are facing this, I would suggest you to raise a ticket with Bruno. Those folks are really helpful :D