Bc-5596-poc-update-feathersjs-mongoose

package.json

@@ -95,8 +95,10 @@
 	},
 	"dependencies": {
 		"@aws-sdk/lib-storage": "^3.100.0",
+		"@feathersjs/adapter-commons": "^5.0.11",
 		"@feathersjs/authentication": "^5.0.11",
 		"@feathersjs/authentication-local": "^5.0.11",
+		"@feathersjs/commons": "^5.0.11",
 		"@feathersjs/configuration": "^5.0.11",
 		"@feathersjs/errors": "^5.0.11",
 		"@feathersjs/express": "^5.0.11",
@@ -161,7 +163,6 @@
 		"express-openapi-validator": "^4.13.2",
 		"express-session": "^1.17.3",
 		"feathers-hooks-common": "^8.1.1",
-		"feathers-mongoose": "^6.3.0",
 		"feathers-swagger": "^3.0.0",
 		"file-type": "^18.5.0",
 		"freeport": "^1.0.5",
@@ -178,7 +179,7 @@
 		"mixwith": "^0.1.1",
 		"moment": "^2.19.2",
 		"mongodb-uri": "^0.9.7",
-		"mongoose": "^5.13.20",
+		"mongoose": "^6.5.4",
 		"mongoose-delete": "^0.5.4",
 		"mongoose-id-validator": "^0.6.0",
 		"mongoose-lean-virtuals": "^0.8.1",

src/components/helper/repo.helper.js

@@ -1,17 +1,21 @@
 const { error } = require('../../logger');
 
 /**
- * Converts an mongoose update many result to an internal TO
+ * TODO Check this https://mongoosejs.com/docs/6.x/docs/api/query.html#query_Query-updateMany
+ * the given example references nModified, so why must we change it to modifiedCount?
+ *
+ *
+ * * Converts an mongoose update many result to an internal TO
  * @param {*} param0
  * @param {1|0} param0.ok 0 for error
  * @param {Integer} param0.n Number of elements matched the given filter
- * @param {Integer} param0.nModified Number of elements updated
+ * @param {Integer} param0.modifiedCount Number of elements updated
  */
-const updateManyResult = ({ ok, n, nModified }) => {
+const updateManyResult = ({ ok, n, modifiedCount }) => {
 	if (ok !== 1) {
-		error('mongoose updateMany has failed', { ok, n, nModified });
+		error('mongoose updateMany has failed', { ok, n, modifiedCount });
 	}
-	return { success: ok === 1, modifiedDocuments: nModified };
+	return { success: ok === 1, modifiedDocuments: modifiedCount };
 };
 
 /**

src/services/activation/services/ActivationModelService.js

@@ -1,4 +1,4 @@
-const feathersMongooseService = require('feathers-mongoose');
+const feathersMongooseService = require('../../../utils/feathers-mongoose');
 const auth = require('@feathersjs/authentication');
 const { iff, isProvider, disallow } = require('feathers-hooks-common');
 const { activationModel } = require('../model');

src/services/base64Files/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/consent/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/content/index.js

@@ -1,5 +1,5 @@
 // eslint-disable-next-line max-classes-per-file
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 const material = require('./material-model');

src/services/datasources/services/datasources.js

@@ -1,5 +1,5 @@
 const Ajv = require('ajv');
-const service = require('feathers-mongoose');
+const service = require('../../../utils/feathers-mongoose');
 const { authenticate } = require('@feathersjs/authentication');
 const { iff, isProvider, validateSchema, disallow } = require('feathers-hooks-common');
 const { datasourceModel } = require('../model');

src/services/federalState/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/fileStorage/model-service.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { FileModel } = require('./model');
 const hooks = require('./hooks/model-hooks');
 

src/services/helpdesk/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 
@@ -9,7 +9,11 @@ const { BODYPARSER_JSON_LIMIT, MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE } =
 
 if (BODYPARSER_JSON_LIMIT === undefined) {
 	/* eslint-disable-next-line  */
-	logger.warning(`please set the environment variable BODYPARSER_JSON_LIMIT to min. '${Math.ceil(1.36*(MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE/1024/1024))}mb' for helpdesk to work correctly! (Currently: ${BODYPARSER_JSON_LIMIT})`);
+	logger.warning(
+		`please set the environment variable BODYPARSER_JSON_LIMIT to min. '${Math.ceil(
+			1.36 * (MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE / 1024 / 1024)
+		)}mb' for helpdesk to work correctly! (Currently: ${BODYPARSER_JSON_LIMIT})`
+	);
 }
 
 module.exports = function () {

src/services/homework/model-service.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { homeworkModel, submissionModel } = require('./model');
 const hooks = require('./hooks');
 const submissionHooks = require('./hooks/submissions');

src/services/lesson/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/link/index.js

@@ -1,7 +1,7 @@
 /* eslint-disable max-classes-per-file */
 const { Configuration } = require('@hpi-schul-cloud/commons');
 const queryString = require('qs');
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 const { BadRequest } = require('@feathersjs/errors');

src/services/ltiTool/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { authenticate } = require('@feathersjs/authentication');
 const fs = require('fs');
 const jwt = require('jsonwebtoken');

src/services/news/index.js

@@ -4,7 +4,7 @@
  * The public API has been moved to apps/server/src/modules/news
  */
 
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 
 const { newsModel } = require('./model');
 const newsModelHooks = require('./hooks/newsModel.hooks');

src/services/pseudonym/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/releases/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const request = require('request-promise-native');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');

src/services/role/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/school/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { Configuration } = require('@hpi-schul-cloud/commons');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');

src/services/serviceTemplate/services/modelService.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../../utils/feathers-mongoose');
 const Ajv = require('ajv');
 const auth = require('@feathersjs/authentication');
 const { iff, isProvider, validateSchema, disallow } = require('feathers-hooks-common');

src/services/storageProvider/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/system/index.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/teams/index.js

@@ -1,5 +1,5 @@
 // eslint-disable-next-line max-classes-per-file
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { Configuration } = require('@hpi-schul-cloud/commons');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');

src/services/teams/model.js

@@ -51,6 +51,8 @@ const teamsSchema = getUserGroupSchema({
 	color: { type: String, default: '#ACACAC' },
 	features: [{ type: String, enum: Object.values(TEAM_FEATURES) }],
 	filePermission: [permissionSchema],
+	// https://mongoosejs.com/docs/migrating_to_6.html#strictpopulate
+	ltiToolIds: [{ type: Schema.Types.ObjectId, required: true, ref: 'ltiTool' }],
 });
 
 /*

src/services/user-group/hooks/courses.js

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const { Configuration } = require('@hpi-schul-cloud/commons/lib');
-const { service } = require('feathers-mongoose');
+const { service } = require('../../../utils/feathers-mongoose');
 
 const { BadRequest } = require('../../../errors');
 const globalHooks = require('../../../hooks');

src/services/user-group/services/classModelService.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../../utils/feathers-mongoose');
 const { iff, isProvider, disallow } = require('feathers-hooks-common');
 const auth = require('@feathersjs/authentication');
 

src/services/user-group/services/courseGroupModelService.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../../utils/feathers-mongoose');
 const { iff, isProvider, disallow } = require('feathers-hooks-common');
 const auth = require('@feathersjs/authentication');
 

src/services/user-group/services/courseModelService.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../../utils/feathers-mongoose');
 const { iff, isProvider, disallow } = require('feathers-hooks-common');
 const auth = require('@feathersjs/authentication');
 

src/services/user/index.js

@@ -1,5 +1,5 @@
 const hooks = require('feathers-hooks-common');
-const service = require('feathers-mongoose');
+const service = require('../../utils/feathers-mongoose');
 const { static: staticContent } = require('@feathersjs/express');
 const path = require('path');
 

src/services/user/services/UsersModelService.js

@@ -1,6 +1,6 @@
-const feathersMongooseService = require('feathers-mongoose');
 const auth = require('@feathersjs/authentication');
 const { iff, isProvider, disallow } = require('feathers-hooks-common');
+const feathersMongooseService = require('../../../utils/feathers-mongoose');
 const { userModel } = require('../model');
 const { addDates: addConsentDate } = require('../hooks/consent');
 const { enableQuery, enableQueryAfter, resolveToIds } = require('../../../hooks');

src/services/webuntis/services/webuntisMetadata.js

@@ -1,4 +1,4 @@
-const service = require('feathers-mongoose');
+const service = require('../../../utils/feathers-mongoose');
 // const Ajv = require('ajv');
 const auth = require('@feathersjs/authentication');
 const { iff, isProvider, /* validateSchema, */ disallow } = require('feathers-hooks-common');

src/utils/database.js

@@ -88,11 +88,8 @@ function connect() {
 
 	const mongooseOptions = {
 		autoIndex: NODE_ENV !== ENVIRONMENTS.PRODUCTION,
-		poolSize: MONGOOSE_CONNECTION_POOL_SIZE,
+		minPoolSize: MONGOOSE_CONNECTION_POOL_SIZE, //https://mongoosejs.com/docs/migrating_to_6.html#mongodb-driver-40 ??
 		useNewUrlParser: true,
-		useFindAndModify: false,
-		useCreateIndex: true,
-		useUnifiedTopology: true,
 	};
 
 	addAuthenticationToMongooseOptions(options.username, options.password, mongooseOptions);

src/utils/feathers-mongoose/error-handler.js

@@ -0,0 +1,53 @@
+const errors = require('@feathersjs/errors');
+
+const ERROR = Symbol('feathers-mongoose/error');
+
+const wrap = (error, original) => Object.assign(error, { [ERROR]: original });
+
+exports.ERROR = ERROR;
+
+exports.errorHandler = (error) => {
+	if (error.code === 11000 || error.code === 11001) {
+		// NOTE (EK): Error parsing as discussed in this github thread
+		// https://github.com/Automattic/mongoose/issues/2129
+		const match1 = error.message.match(/_?([a-zA-Z]*)_?\d?\s*dup key/i);
+		const match2 = error.message.match(/\s*dup key:\s*\{\s*:\s*"?(.*?)"?\s*\}/i);
+
+		const key = match1 ? match1[1] : 'path';
+		let value = match2 ? match2[1] : 'value';
+
+		if (value === 'null') {
+			value = null;
+		} else if (value === 'undefined') {
+			value = undefined;
+		}
+
+		error.message = `${key}: ${value} already exists.`;
+		error.errors = {
+			[key]: value,
+		};
+
+		return Promise.reject(wrap(new errors.Conflict(error), error));
+	}
+
+	if (error.name) {
+		switch (error.name) {
+			case 'ValidationError':
+			case 'ValidatorError':
+			case 'CastError':
+			case 'VersionError':
+				return Promise.reject(wrap(new errors.BadRequest(error), error));
+			case 'OverwriteModelError':
+				return Promise.reject(wrap(new errors.Conflict(error), error));
+			case 'MissingSchemaError':
+			case 'DivergentArrayError':
+				return Promise.reject(wrap(new errors.GeneralError(error), error));
+			case 'MongoError':
+				return Promise.reject(wrap(new errors.GeneralError(error), error));
+			default:
+				return Promise.reject(wrap(new errors.GeneralError(error), error));
+		}
+	}
+
+	return Promise.reject(error);
+};

src/utils/feathers-mongoose/hooks.js

@@ -0,0 +1,31 @@
+exports.toObject =
+	(options = {}, dataField = 'data') =>
+	(hook) => {
+		// Only perform this if it's used as an after hook.
+		if (hook.result) {
+			const data = hook.result[dataField] || hook.result;
+			let res;
+
+			// Handle multiple mongoose models
+			if (Array.isArray(data)) {
+				res = data.map((obj) => {
+					if (typeof obj.toObject === 'function') {
+						return obj.toObject(options);
+					}
+
+					return obj;
+				});
+			} else if (typeof data.toObject === 'function') {
+				// Handle single mongoose models
+				res = data.toObject(options);
+			}
+			// If our data is transformed set it to appropriate location on the hook
+			if (res) {
+				if (hook.result[dataField]) {
+					hook.result[dataField] = res;
+				} else {
+					hook.result = res;
+				}
+			}
+		}
+	};

src/utils/feathers-mongoose/index.js

@@ -0,0 +1,6 @@
+const hooks = require('./hooks');
+const service = require('./service');
+
+Object.assign(service, { hooks, service });
+
+module.exports = service;