p5.js-web-editor/server/controllers/project.controller/__test__/createProject.test.js
Andrew Nicolaou d44a058fd8 Public API: Create new project (fixes #1095) (#1106)
* Converts import script to use public API endpoints

The endpoints don't exist yet, but this is a good way to see how
the implementation of the data structures differ.

* Exposes public API endpoint to fetch user's sketches

* Implements public API delete endpoint

* Adds helper to create custom ApplicationError classes

* Adds create project endpoint that understand API's data structure

This transforms the nested tree of file data into a mongoose
Project model

* Returns '201 Created' to match API spec

* Removes 'CustomError' variable assignment as it shows up in test output

* transformFiles will return file validation errors

* Tests API project controller

* Tests toModel()

* Creates default files if no root-level .html file is provided

* Do not auto-generate a slug if it is provided

Fixes a bug where the slug was auto-generated using the sketch name,
even if a slug property had been provided.

* Validates uniqueness of slugs for projects created by the public API

* Adds tests for slug uniqueness

* Configures node's Promise implementation for mongoose (fixes warnings)

* Moves createProject tests to match controller location

* Adds support for code to ApplicationErrors

* deleteProject controller tests

* getProjectsForUser controller tests

- implements tests
- update apiKey tests to use new User mocks

* Ensure error objects have consistent property names

`message` is used as a high-level description of the errors
`detail` is optional and has an plain language explanation of the
individual errors
`errors` is an array of each individual problem from `detail` in a
machine-readable format

* Assert environment variables are provided at script start

* Version public API

* Expect "files" property to always be provided

* Fixes linting error

* Converts import script to use public API endpoints

The endpoints don't exist yet, but this is a good way to see how
the implementation of the data structures differ.

* Exposes public API endpoint to fetch user's sketches

* Implements public API delete endpoint

* Adds helper to create custom ApplicationError classes

* Adds create project endpoint that understand API's data structure

This transforms the nested tree of file data into a mongoose
Project model

* Returns '201 Created' to match API spec

* Removes 'CustomError' variable assignment as it shows up in test output

* transformFiles will return file validation errors

* Tests API project controller

* Tests toModel()

* Creates default files if no root-level .html file is provided

* Do not auto-generate a slug if it is provided

Fixes a bug where the slug was auto-generated using the sketch name,
even if a slug property had been provided.

* Validates uniqueness of slugs for projects created by the public API

* Adds tests for slug uniqueness

* Configures node's Promise implementation for mongoose (fixes warnings)

* Moves createProject tests to match controller location

* deleteProject controller tests

* Adds support for code to ApplicationErrors

* getProjectsForUser controller tests

- implements tests
- update apiKey tests to use new User mocks

* Ensure error objects have consistent property names

`message` is used as a high-level description of the errors
`detail` is optional and has an plain language explanation of the
individual errors
`errors` is an array of each individual problem from `detail` in a
machine-readable format

* Assert environment variables are provided at script start

* Version public API

* Expect "files" property to always be provided

* Fixes linting error

* Checks that authenticated user has permission to create under this namespace

Previously, the project was always created under the authenticated user's
namespace, but this not obvious behaviour.
2019-08-30 14:26:57 -04:00

391 lines
9.9 KiB
JavaScript

/**
* @jest-environment node
*/
import { Response } from 'jest-express';
import Project, { createMock, createInstanceMock } from '../../../models/project';
import createProject, { apiCreateProject } from '../createProject';
jest.mock('../../../models/project');
describe('project.controller', () => {
describe('createProject()', () => {
let ProjectMock;
beforeEach(() => {
ProjectMock = createMock();
});
afterEach(() => {
ProjectMock.restore();
});
it('fails if create fails', (done) => {
const error = new Error('An error');
ProjectMock
.expects('create')
.rejects(error);
const request = { user: {} };
const response = new Response();
const promise = createProject(request, response);
function expectations() {
expect(response.json).toHaveBeenCalledWith({ success: false });
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('extracts parameters from request body', (done) => {
const request = {
user: { _id: 'abc123' },
body: {
name: 'Wriggly worm',
files: [{ name: 'file.js', content: 'var hello = true;' }]
}
};
const response = new Response();
ProjectMock
.expects('create')
.withArgs({
user: 'abc123',
name: 'Wriggly worm',
files: [{ name: 'file.js', content: 'var hello = true;' }]
})
.resolves();
const promise = createProject(request, response);
function expectations() {
expect(response.json).toHaveBeenCalled();
done();
}
promise.then(expectations, expectations).catch(expectations);
});
// TODO: This should be extracted to a new model object
// so the controllers just have to call a single
// method for this operation
it('populates referenced user on project creation', (done) => {
const request = { user: { _id: 'abc123' } };
const response = new Response();
const result = {
_id: 'abc123',
id: 'abc123',
name: 'Project name',
serveSecure: false,
files: []
};
const resultWithUser = {
...result,
user: {}
};
ProjectMock
.expects('create')
.withArgs({ user: 'abc123' })
.resolves(result);
ProjectMock
.expects('populate')
.withArgs(result)
.yields(null, resultWithUser)
.resolves(resultWithUser);
const promise = createProject(request, response);
function expectations() {
const doc = response.json.mock.calls[0][0];
expect(response.json).toHaveBeenCalled();
expect(JSON.parse(JSON.stringify(doc))).toMatchObject(resultWithUser);
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('fails if referenced user population fails', (done) => {
const request = { user: { _id: 'abc123' } };
const response = new Response();
const result = {
_id: 'abc123',
id: 'abc123',
name: 'Project name',
serveSecure: false,
files: []
};
const error = new Error('An error');
ProjectMock
.expects('create')
.resolves(result);
ProjectMock
.expects('populate')
.yields(error)
.resolves(error);
const promise = createProject(request, response);
function expectations() {
expect(response.json).toHaveBeenCalledWith({ success: false });
done();
}
promise.then(expectations, expectations).catch(expectations);
});
});
describe('apiCreateProject()', () => {
let ProjectMock;
let ProjectInstanceMock;
beforeEach(() => {
ProjectMock = createMock();
ProjectInstanceMock = createInstanceMock();
});
afterEach(() => {
ProjectMock.restore();
ProjectInstanceMock.restore();
});
it('returns 201 with id of created sketch', (done) => {
const request = {
user: { _id: 'abc123', username: 'alice' },
params: { username: 'alice' },
body: {
name: 'My sketch',
files: {}
}
};
const response = new Response();
const result = {
_id: 'abc123',
id: 'abc123',
name: 'Project name',
serveSecure: false,
files: []
};
ProjectInstanceMock.expects('isSlugUnique')
.resolves({ isUnique: true, conflictingIds: [] });
ProjectInstanceMock.expects('save')
.resolves(new Project(result));
const promise = apiCreateProject(request, response);
function expectations() {
const doc = response.json.mock.calls[0][0];
expect(response.status).toHaveBeenCalledWith(201);
expect(response.json).toHaveBeenCalled();
expect(JSON.parse(JSON.stringify(doc))).toMatchObject({
id: 'abc123'
});
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('fails if slug is not unique', (done) => {
const request = {
user: { _id: 'abc123', username: 'alice' },
params: { username: 'alice' },
body: {
name: 'My sketch',
slug: 'a-slug',
files: {}
}
};
const response = new Response();
const result = {
_id: 'abc123',
id: 'abc123',
name: 'Project name',
// slug: 'a-slug',
serveSecure: false,
files: []
};
ProjectInstanceMock.expects('isSlugUnique')
.resolves({ isUnique: false, conflictingIds: ['cde123'] });
ProjectInstanceMock.expects('save')
.resolves(new Project(result));
const promise = apiCreateProject(request, response);
function expectations() {
const doc = response.json.mock.calls[0][0];
expect(response.status).toHaveBeenCalledWith(409);
expect(response.json).toHaveBeenCalled();
expect(JSON.parse(JSON.stringify(doc))).toMatchObject({
message: 'Sketch Validation Failed',
detail: 'Slug "a-slug" is not unique. Check cde123'
});
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('fails if user does not have permission', (done) => {
const request = {
user: { _id: 'abc123', username: 'alice' },
params: {
username: 'dana',
},
body: {
name: 'My sketch',
slug: 'a-slug',
files: {}
}
};
const response = new Response();
const result = {
_id: 'abc123',
id: 'abc123',
name: 'Project name',
serveSecure: false,
files: []
};
ProjectInstanceMock.expects('isSlugUnique')
.resolves({ isUnique: true, conflictingIds: [] });
ProjectInstanceMock.expects('save')
.resolves(new Project(result));
const promise = apiCreateProject(request, response);
function expectations() {
expect(response.status).toHaveBeenCalledWith(401);
expect(response.json).toHaveBeenCalled();
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('returns validation errors on files input', (done) => {
const request = {
user: { username: 'alice' },
params: { username: 'alice' },
body: {
name: 'My sketch',
files: {
'index.html': {
// missing content or url
}
}
}
};
const response = new Response();
const promise = apiCreateProject(request, response);
function expectations() {
const doc = response.json.mock.calls[0][0];
const responseBody = JSON.parse(JSON.stringify(doc));
expect(response.status).toHaveBeenCalledWith(422);
expect(responseBody.message).toBe('File Validation Failed');
expect(responseBody.detail).not.toBeNull();
expect(responseBody.errors.length).toBe(1);
expect(responseBody.errors).toEqual([
{ name: 'index.html', message: 'missing \'url\' or \'content\'' }
]);
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('rejects file parameters not in object format', (done) => {
const request = {
user: { _id: 'abc123', username: 'alice' },
params: { username: 'alice' },
body: {
name: 'Wriggly worm',
files: [{ name: 'file.js', content: 'var hello = true;' }]
}
};
const response = new Response();
const promise = apiCreateProject(request, response);
function expectations() {
const doc = response.json.mock.calls[0][0];
const responseBody = JSON.parse(JSON.stringify(doc));
expect(response.status).toHaveBeenCalledWith(422);
expect(responseBody.message).toBe('File Validation Failed');
expect(responseBody.detail).toBe('\'files\' must be an object');
done();
}
promise.then(expectations, expectations).catch(expectations);
});
it('rejects if files object in not provided', (done) => {
const request = {
user: { _id: 'abc123', username: 'alice' },
params: { username: 'alice' },
body: {
name: 'Wriggly worm',
// files: {} is missing
}
};
const response = new Response();
const promise = apiCreateProject(request, response);
function expectations() {
const doc = response.json.mock.calls[0][0];
const responseBody = JSON.parse(JSON.stringify(doc));
expect(response.status).toHaveBeenCalledWith(422);
expect(responseBody.message).toBe('File Validation Failed');
expect(responseBody.detail).toBe('\'files\' must be an object');
done();
}
promise.then(expectations, expectations).catch(expectations);
});
});
});