Merge branch 'master' into staging

Author: carmenfan

backend/VERSION.json

@@ -1,4 +1,4 @@
-{ "VERSION" : "5.14.0",
+{ "VERSION" : "5.14.1",
   "unity" : {
 	"current" : "5.20.0",
 	"supported": []

backend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "3drepo.io",
-  "version": "5.14.0",
+  "version": "5.14.1",
   "engines": {
     "node": "18.x.x"
   },

backend/src/v4/models/project.js

@@ -24,9 +24,11 @@
 	const responseCodes = require("../response_codes.js");
 	const utils = require("../utils");
 	const _ = require("lodash");
-	const { changePermissions, findModelSettings, removePermissionsFromModels } = require("./modelSetting");
 	const { publish } = require(`${v5Path}/services/eventsManager/eventsManager`);
 	const { events } = require(`${v5Path}/services/eventsManager/eventsManager.constants`);
+	const { changePermissions, prepareDefaultView, findModelSettings, findPermissionByUser, removePermissionsFromModels } = require("./modelSetting");
+	const { getTeamspaceSettings } = require("./teamspaceSetting");
+	const PermissionTemplates = require("./permissionTemplates");
 
 	const PROJECTS_COLLECTION_NAME = "projects";
 
@@ -300,6 +302,49 @@
 		return projects.map(p => p.name);
 	};
 
+	Project.listModels = async function(account, project, username, filters) {
+		const AccountPermissions = require("./accountPermissions");
+		const ModelHelper = require("./helper/model");
+		const [dbUser, projectObj] = await Promise.all([
+			getTeamspaceSettings(account),
+			Project.findOneProject(account, {name: project})
+		]);
+		if (!projectObj) {
+			throw responseCodes.PROJECT_NOT_FOUND;
+		}
+		if (filters && filters.name) {
+			filters.name = new RegExp(".*" + filters.name + ".*", "i");
+		}
+		let modelsSettings =  await findModelSettings(account, { _id: { $in : projectObj.models }, ...filters});
+		let permissions = [];
+		const accountPerm = AccountPermissions.findByUser(dbUser, username);
+		const projectPerm = projectObj.permissions.find(p=> p.user === username);
+		if (accountPerm && accountPerm.permissions) {
+			permissions = permissions.concat(ModelHelper.flattenPermissions(accountPerm.permissions));
+		}
+		if (projectPerm && projectPerm.permissions) {
+			permissions  = permissions.concat(ModelHelper.flattenPermissions(projectPerm.permissions));
+		}
+		modelsSettings = await Promise.all(modelsSettings.map(async setting => {
+			const template = await findPermissionByUser(account, setting._id, username);
+			let settingsPermissions = [];
+			if(template) {
+				const permissionTemplate = PermissionTemplates.findById(dbUser, template.permission);
+				if (permissionTemplate && permissionTemplate.permissions) {
+					settingsPermissions = settingsPermissions.concat(ModelHelper.flattenPermissions(permissionTemplate.permissions, true));
+				}
+			}
+			setting = await prepareDefaultView(account, setting._id, setting);
+			setting.permissions = _.uniq(permissions.concat(settingsPermissions));
+			setting.model = setting._id;
+			setting.account = account;
+			setting.subModels = await ModelHelper.listSubModels(account, setting._id, C.MASTER_BRANCH_NAME);
+			setting.headRevisions = {};
+			return setting;
+		}));
+		return modelsSettings;
+	};
+
 	Project.isProjectAdmin = async function(teamspace, model, user) {
 		const projection = { "permissions": { "$elemMatch": { user: user } }};
 		const project = await Project.findOneProject(teamspace, {models: model}, projection);

backend/src/v4/routes/apidoc.json

@@ -1,3 +1,3 @@
 {
-	"version": "5.14.0"
+	"version": "5.14.1"
 }

backend/src/v4/routes/project.js

@@ -18,6 +18,7 @@
 "use strict";
 (function() {
 
+	const _ = require("lodash");
 	const express = require("express");
 	const router = express.Router({mergeParams: true});
 	const responseCodes = require("../response_codes");
@@ -205,6 +206,133 @@
 	 */
 	router.patch("/projects/:project", middlewares.project.canUpdate, updateProject);
 
+	/**
+	 * @api {get} /:teamspace/projects/:project/models List models of the project
+	 * @apiName listModels
+	 * @apiGroup Project
+	 *
+	 * @apiDescription It returns a list of models .
+	 *
+	 * @apiPermission canListProjects
+	 *
+	 * @apiParam {String} teamspace Name of the teamspace
+	 * @apiParam {String} project The name of the project to list models
+	 *
+	 * @apiParam (Query) {String} [name] Filters models by name
+	 *
+	 *
+	 * @apiExample {get} Example usage:
+	 * GET /teamSpace1/projects/Bim%20Logo/models?name=log HTTP/1.1
+	 *
+	 * @apiSuccessExample {json} Success:
+	 * [
+	 *   {
+	 *     "_id": "5ce7dd19-1252-4548-a9c9-4a5414f2e0c5",
+	 *     "federate": true,
+	 *     "desc": "",
+	 *     "name": "Full Logo",
+	 *     "__v": 17,
+	 *     "timestamp": "2019-05-02T16:17:37.902Z",
+	 *     "type": "Federation",
+	 *     "subModels": [
+	 *       {
+	 *         "database": "teamSpace1",
+	 *         "model": "b1fceab8-b0e9-4e45-850b-b9888efd6521",
+	 *         "name": "block"
+	 *       },
+	 *       {
+	 *         "database": "teamSpace1",
+	 *         "model": "7cf61b4f-acdf-4295-b2d0-9b45f9f27418",
+	 *         "name": "letters"
+	 *       },
+	 *       {
+	 *         "database": "teamSpace1",
+	 *         "model": "2710bd65-37d3-4e7f-b2e0-ffe743ce943f",
+	 *         "name": "pipes"
+	 *       }
+	 *     ],
+	 *     "surveyPoints": [
+	 *       {
+	 *         "position": [
+	 *           0,
+	 *           0,
+	 *           0
+	 *         ],
+	 *         "latLong": [
+	 *           -34.459127,
+	 *           0
+	 *         ]
+	 *       }
+	 *     ],
+	 *     "properties": {
+	 *       "unit": "mm",
+	 *       "topicTypes": [
+	 *         {
+	 *           "label": "Clash",
+	 *           "value": "clash"
+	 *         },
+	 *         {
+	 *           "label": "Diff",
+	 *           "value": "diff"
+	 *         },
+	 *         {
+	 *           "label": "RFI",
+	 *           "value": "rfi"
+	 *         },
+	 *         {
+	 *           "label": "Risk",
+	 *           "value": "risk"
+	 *         },
+	 *         {
+	 *           "label": "H&S",
+	 *           "value": "hs"
+	 *         },
+	 *         {
+	 *           "label": "Design",
+	 *           "value": "design"
+	 *         },
+	 *         {
+	 *           "label": "Constructibility",
+	 *           "value": "constructibility"
+	 *         },
+	 *         {
+	 *           "label": "GIS",
+	 *           "value": "gis"
+	 *         },
+	 *         {
+	 *           "label": "For information",
+	 *           "value": "for_information"
+	 *         },
+	 *         {
+	 *           "label": "VR",
+	 *           "value": "vr"
+	 *         }
+	 *       ]
+	 *     },
+	 *     "permissions": [
+	 *       "change_model_settings",
+	 *       "upload_files",
+	 *       "create_issue",
+	 *       "comment_issue",
+	 *       "view_issue",
+	 *       "view_model",
+	 *       "download_model",
+	 *       "edit_federation",
+	 *       "delete_federation",
+	 *       "delete_model",
+	 *       "manage_model_permission"
+	 *     ],
+	 *     "status": "ok",
+	 *     "id": "5ce7dd19-1252-4548-a9c9-4a5414f2e0c5",
+	 *     "model": "5ce7dd19-1252-4548-a9c9-4a5414f2e0c5",
+	 *     "account": "teamSpace1",
+	 *     "headRevisions": {
+	 *     }
+	 *   }
+	 * ]	 *
+	 */
+	router.get("/projects/:project/models", middlewares.project.canList, listModels);
+
 	/**
 	 * @api {get} /:teamspace/projects List projects
 	 * @apiName listProjects
@@ -446,6 +574,16 @@
 		});
 	}
 
+	function listModels(req, res, next) {
+		const filters = _.pick(req.query, "name");
+		const username = req.session.user.username;
+		Project.listModels(req.params.account, req.params.project, username, filters).then(models => {
+			responseCodes.respond(utils.APIInfo(req), req, res, next, responseCodes.OK, models);
+		}).catch(err => {
+			responseCodes.respond(utils.APIInfo(req), req, res, next, err, err);
+		});
+	}
+
 	module.exports = router;
 
 }());

backend/tests/v4/integrated/project.js

@@ -616,6 +616,77 @@ describe('Projects', () => {
 			});
 	});
 
+	it('list all project models should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal(goldenFullModelList);
+				done(err);
+			});
+	});
+
+	it("list all project models from project that doesn't exist should fail", async () => {
+		const { body } = await agent.get(`/${username}/projects/notexist/models`)
+			.expect(404);
+
+		expect(body.value).to.equal(responseCodes.PROJECT_NOT_FOUND.value);
+	});
+
+	it('list project models matching query name should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models?name=RandomName`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal(goldenRandomNameList);
+				done(err);
+			});
+	});
+
+	it('list project models matching partial query name (start) should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models?name=TestModel`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal(goldenTestModelList);
+				done(err);
+			});
+	});
+
+	it('list project models matching partial query name (middle) should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models?name=Model`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal(goldenTestModelList);
+				done(err);
+			});
+	});
+
+	it('list project models matching partial query name (end) should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models?name=Name`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal(goldenRandomNameList);
+				done(err);
+			});
+	});
+
+	it('list project models query with different casing should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models?name=testmodel`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal(goldenTestModelList);
+				done(err);
+			});
+	});
+
+	it('list project models matching no names should succeed', (done) => {
+		agent.get(`/${username}/projects/${projectName}/models?name=DOESNTEXIST`)
+			.expect(200, (err, res) => {
+				expect(res.body).to.deep.equal([]);
+				done(err);
+			});
+	});
+
+	it("list all project models with name query from project that doesn't exist should fail", (done) => {
+		agent.get(`/${username}/projects/notexist/models?name=TestModel`)
+			.expect(404, (err, res) => {
+				expect(res.body.value).to.equal(responseCodes.PROJECT_NOT_FOUND.value);
+				done(err);
+			});
+	});
+
 	it('should able to delete project', (done) => {
 		const project = {
 			name: 'project_exists',

frontend/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "3drepo.io-frontend",
-	"version": "5.14.0",
+	"version": "5.14.1",
 	"description": "The frontend for 3drepo.io",
 	"engines": {
 		"node": "18.x.x"

frontend/src/v5/validation/containerAndFederationSchemes/federationSchemes.ts

@@ -14,7 +14,17 @@
  *  You should have received a copy of the GNU Affero General Public License
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-import { SettingsSchemaWithGeoPosition, SettingsSchema } from './settingsSchemes';
+import { name, desc } from '../shared/validators';
+import { SettingsSchemaWithGeoPosition } from './settingsSchemes';
+import * as Yup from 'yup';
+import { unit, code } from './validators';
+
+
+export const NewFederationSettingsSchema = Yup.object().shape({
+	name,
+	desc,
+	unit,
+	code,
+});
 
-export const NewFederationSettingsSchema = SettingsSchema;
 export const FederationSettingsSchema = SettingsSchemaWithGeoPosition;

frontend/src/v5/validation/containerAndFederationSchemes/settingsSchemes.ts

@@ -19,17 +19,14 @@ import * as Yup from 'yup';
 import { formatMessage } from '@/v5/services/intl';
 import { EMPTY_VIEW } from '@/v5/store/store.helpers';
 import { unit, code, nullableNumberField } from './validators';
-import { desc, name } from '../shared/validators';
+import { name, nullableDesc } from '../shared/validators';
 import { isNumber } from 'lodash';
 
-export const SettingsSchema = Yup.object().shape({
+export const SettingsSchemaWithGeoPosition = Yup.object().shape({
 	name,
-	desc,
+	desc: nullableDesc,
 	unit,
 	code,
-});
-
-export const SettingsSchemaWithGeoPosition = SettingsSchema.shape({
 	defaultView: Yup.string()
 		.nullable()
 		.transform((value) => (value === EMPTY_VIEW._id ? null : value)),

frontend/src/v5/validation/shared/validators.ts

@@ -88,8 +88,17 @@ export const name = trimmedString
 		},
 	);
 
-export const desc = nullableString.max(660,
+export const nullableDesc = nullableString.max(660,
 	formatMessage({
 		id: 'validation.model.description.error.max',
 		defaultMessage: 'Description is limited to 660 characters',
 	}));
+
+export const desc = Yup.lazy((value) => (
+	stripIfBlankString(value)
+		.max(660,
+			formatMessage({
+				id: 'validation.model.description.error.max',
+				defaultMessage: 'Description is limited to 660 characters',
+			}))
+));