Skip to content

fix(PM-1168): invite user when assigning as copilot #809

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

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from

Conversation

hentrymartin
Copy link
Collaborator

What's in this PR?

  • invite user when assigning as copilot

Ticket link - https://topcoder.atlassian.net/browse/PM-1168

RESOURCES.PROJECT_MEMBER_INVITE,
invite.toJSON());

const initiator = await util.getMemberDetailsByUserIds([req.authUser.userId], req.log, req.id);

Choose a reason for hiding this comment

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

Check if util.getMemberDetailsByUserIds can return an empty result or error, and handle such cases to avoid potential runtime errors.

email: existingUser.email,
})

console.log("aftr create", invite)

Choose a reason for hiding this comment

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

Remove the console.log statement before merging the code. Debugging statements should not be present in production code.

],
}],
},
recipients: [existingUser.email],

Choose a reason for hiding this comment

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

The change from invite.email to existingUser.email suggests that the email recipient is now being set to an existing user's email. Ensure that existingUser is properly defined and initialized before this line to avoid potential runtime errors.

},
});

req.log.info("before create", existingUser)

Choose a reason for hiding this comment

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

Consider removing or modifying the log statement req.log.info("before create", existingUser) if it is not necessary for production. Logging sensitive information or excessive logging can lead to performance issues and security concerns.

email: existingUser.email,
})

req.log.info("aftr create", invite)

Choose a reason for hiding this comment

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

Consider correcting the typo in the log message from "aftr create" to "after create" for better readability and consistency.

},
});

const applicationUser = await util.getMemberDetailsByUserIds([userId], req.log, req.id)[0];

Choose a reason for hiding this comment

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

It seems like util.getMemberDetailsByUserIds([userId], req.log, req.id) returns a promise, but the code attempts to access the first element directly without awaiting the promise. Consider using await to ensure applicationUser is correctly assigned.

email: applicationUser.email,
})

req.log.info("aftr create", invite)

Choose a reason for hiding this comment

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

Typo in log message: 'aftr' should be corrected to 'after'.

],
}],
},
recipients: [applicationUser.email],

Choose a reason for hiding this comment

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

It seems like the recipient email has been changed from existingUser.email to applicationUser.email. Ensure that applicationUser is correctly defined and initialized before this line, and that it contains the expected email address for the invitation process.


const applicationUser = await util.getMemberDetailsByUserIds([userId], req.log, req.id);

req.log.info("before create", applicationUser, userId)

Choose a reason for hiding this comment

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

Consider verifying if userId is necessary in the log statement. If applicationUser already contains relevant information about the user, logging userId might be redundant.


const applicationUser = await util.getMemberDetailsByUserIds([userId], req.log, req.id);

req.log.info("before create", applicationUser, userId, applicationUser[0].email)

Choose a reason for hiding this comment

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

Ensure that applicationUser[0] is not undefined before accessing .email to prevent potential runtime errors. Consider adding a check to verify that applicationUser[0] exists.

@hentrymartin hentrymartin requested a review from kkartunov May 21, 2025 13:14
Copy link
Contributor

@kkartunov kkartunov left a comment

Choose a reason for hiding this comment

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

We should handle only of the invitation is accepted by the copilot. As currently implemented this directly accepts and modifies records which should be done only after invitation is accepted.

@@ -0,0 +1,18 @@
module.exports = {
up: async (queryInterface, Sequelize) => {
await queryInterface.addColumn('project_member_invites', 'applicationId', {

Choose a reason for hiding this comment

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

Consider specifying an index on the applicationId column for improved query performance, especially if this column will be frequently used in WHERE clauses or joins.

},
});

if (existingInvite) {

Choose a reason for hiding this comment

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

The findAll method returns an array, so existingInvite will always be truthy even if it's empty. Consider using findOne if you expect a single result, or check if existingInvite.length > 0.

});

if (existingInvite) {
const err = new Error(`User already has an pending invite to the project`);

Choose a reason for hiding this comment

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

The error message contains a grammatical error. It should be 'a pending invite' instead of 'an pending invite'.

title: config.get('inviteEmailSectionTitle'),
projectName: project.name,
projectId,
initiator: authUserDetails[0],

Choose a reason for hiding this comment

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

The removal of the code block that updates the status of CopilotRequest, opportunity, and CopilotApplication might lead to inconsistencies in the database. Ensure that these status updates are handled elsewhere if they are still necessary for the application's logic.

@@ -119,7 +119,9 @@ module.exports = [
};
return util
.addUserToProject(req, member)
.then(() => res.json(util.postProcessInvites('$.email', updatedInvite, req)))
.then(async () => {

Choose a reason for hiding this comment

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

The use of async in the then block seems unnecessary here since there is no await expression inside the block. Consider removing async to simplify the code.

@@ -44,11 +44,12 @@ module.exports = function defineProjectMember(sequelize, DataTypes) {
})
.then(res => _.without(_.map(res, 'projectId'), null));

ProjectMember.getActiveProjectMembers = projectId => ProjectMember.findAll({
ProjectMember.getActiveProjectMembers = (projectId, t) => ProjectMember.findAll({

Choose a reason for hiding this comment

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

Consider adding a default value for the transaction parameter t to ensure backward compatibility if the function is called without this argument.

@@ -13,6 +13,16 @@ module.exports = function defineProjectMemberInvite(sequelize, DataTypes) {
isEmail: true,
},
},
applicationId: {
type: DataTypes.BIGINT,
allowNull: true,

Choose a reason for hiding this comment

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

Consider adding a validation to ensure applicationId is a positive integer if it is not null. This can help prevent invalid data from being stored in the database.

key: 'id',
},
onUpdate: 'CASCADE',
onDelete: 'CASCADE',

Choose a reason for hiding this comment

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

Ensure that the onDelete: 'CASCADE' behavior aligns with the intended data integrity rules. This setting will automatically delete the invite if the associated copilot application is deleted, which may not always be desirable.

where: {
id: projectId,
},
transaction: t,

Choose a reason for hiding this comment

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

Ensure that the transaction t is properly initialized and managed. If t is not defined or handled correctly, it could lead to issues with database operations.

role: PROJECT_MEMBER_ROLE.COPILOT,
status: INVITE_STATUS.PENDING,
},
transaction: t,

Choose a reason for hiding this comment

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

The addition of transaction: t seems to be intended for ensuring that the invite creation is part of a transaction. Ensure that t is a valid transaction object and is correctly managed (e.g., committed or rolled back) in the surrounding code to prevent potential issues with database consistency.

@@ -94,7 +94,7 @@ module.exports = [
if (updatedInvite.status === INVITE_STATUS.ACCEPTED ||
updatedInvite.status === INVITE_STATUS.REQUEST_APPROVED) {
return models.ProjectMember.getActiveProjectMembers(projectId)
.then((members) => {
.then(async (members) => {

Choose a reason for hiding this comment

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

Using async in a .then() callback can be confusing and is generally not recommended. Consider refactoring the code to use async/await throughout for better readability and consistency.

.addUserToProject(req, member)
.then(() => res.json(util.postProcessInvites('$.email', updatedInvite, req)))
.catch(err => next(err));
const t = await models.sequelize.transaction();

Choose a reason for hiding this comment

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

Consider adding error handling for the transaction creation to ensure that any issues during transaction initialization are caught and handled appropriately.

const t = await models.sequelize.transaction();
try {
await util.addUserToProject(req, member, t);
if (invite.applicationId) {

Choose a reason for hiding this comment

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

The invite.applicationId check assumes that invite is always defined. Consider adding a check to ensure invite is not null or undefined before accessing its properties to prevent potential runtime errors.

try {
await util.addUserToProject(req, member, t);
if (invite.applicationId) {
const application = await models.CopilotApplication.findOne({

Choose a reason for hiding this comment

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

The findOne operation on CopilotApplication does not handle the case where no application is found. Consider adding a check to handle the scenario where application is null, which could prevent potential errors when attempting to update a non-existent record.

transaction: t
});

const opportunity = await models.CopilotOpportunity.findOne({

Choose a reason for hiding this comment

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

Similar to the previous comment, ensure that the findOne operation on CopilotOpportunity handles the case where no opportunity is found. This will prevent errors when trying to update a null object.

transaction: t,
});

const request = await models.CopilotRequest.findOne({

Choose a reason for hiding this comment

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

Ensure that the findOne operation on CopilotRequest handles the case where no request is found. This will prevent errors when trying to update a null object.

Copy link
Contributor

@kkartunov kkartunov left a comment

Choose a reason for hiding this comment

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

Looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants