Issue 5727 - Create an endpoint to create teamspace #5749
Conversation
| .matches(/^[a-zA-Z0-9]+$/, 'Teamspace name must be alphanumeric and contain no full stops.') | ||
| .max(128, 'Teamspace name must be at most 128 characters long.') | ||
| .required('Teamspace name is required'), | ||
| admin: Yup.string().email('Admin must be a valid email address').optional(), |
There was a problem hiding this comment.
we already have a type for this in backend\src\v5\utils\helper\yup.js
YupHelper.types.strings.email
| req.body = deleteIfUndefined(await schema.validate(req.body, { stripUnknown: true })); | ||
|
|
||
| try { | ||
| teamspaceExists = await getTeamspaceSetting(req.body.name, { _id: 1 }); |
There was a problem hiding this comment.
this should be in a test in name property, take this as an example
| if (teamspaceExists) { | ||
| throw new Error('Teamspace with this name already exists.'); | ||
| } | ||
| if (req.body.admin) await getUserByEmail(req.body.admin); |
There was a problem hiding this comment.
this is not needed, we dont have to check that the user exists, just the format
| Teamspaces.validateCreateTeamspaceData = async (req, res, next) => { | ||
| const schema = Yup.object().shape({ | ||
| name: Yup.string() | ||
| .matches(/^[a-zA-Z0-9]+$/, 'Teamspace name must be alphanumeric and contain no full stops.') |
There was a problem hiding this comment.
we already have this type in we already have a type for this in backend\src\v5\utils\helper\yup.js
YupHelper.validators.alphanumeric
| * type: string | ||
| * description: The account ID the teamspace will belong to | ||
| * example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 | ||
| * owner: |
| FrontEggAccounts.getTeamspaceByAccount.mockResolvedValueOnce(undefined); | ||
|
|
||
| await Teamspaces.validateCreateTeamspaceData(req, {}, mockCB); | ||
| expect(mockCB).toHaveBeenCalledTimes(0); |
There was a problem hiding this comment.
not.ToHaveBeenCalled()
|
|
||
| describe.each([ | ||
| ['if valid name', { body: { name: 'ValidTeamspaceName' } }, true], | ||
| ['if name at max length', { body: { name: 'A'.repeat(128) } }, true], |
There was a problem hiding this comment.
no need to test exactly 128 any length and invalid length would do
| describe.each([ | ||
| ['if valid name', { body: { name: 'ValidTeamspaceName' } }, true], | ||
| ['if name at max length', { body: { name: 'A'.repeat(128) } }, true], | ||
| ['if name too long', { body: { name: 'A'.repeat(129) } }, false], |
There was a problem hiding this comment.
you can call generateRandomString(129)
| ['if valid name', { body: { name: 'ValidTeamspaceName' } }, true], | ||
| ['if name at max length', { body: { name: 'A'.repeat(128) } }, true], | ||
| ['if name too long', { body: { name: 'A'.repeat(129) } }, false], | ||
| ['if name with full stop', { body: { name: 'Invalid.Teamspace.Name' } }, false], |
There was a problem hiding this comment.
if name includes* full stop
| agent = await SuperTest(server); | ||
| const isInternal = [true, false]; | ||
|
|
||
| describe.each(isInternal)('Internal flag set to %s', (internalFlag) => { |
There was a problem hiding this comment.
Im not sure if we have to test all endpoints with different IsInternal flags or just make sure the internal-only are not available in external service @carmenfan could you check this ?
There was a problem hiding this comment.
no just the ones that we have exposed should be checked on both configuration.
If we can conform to the same way we've done it with other endpoints that got merged then it'll be easier for everyone to read.
This fixes #5727
Description
Updated the teamspace endpoints to distinguish between internal and external endpoints.
Created an internal endpoint to allow creation of teamspaces.
Added data validation for the request.
Updated tests for validation and e2e.
Acceptance Criteria