Integrate with frontend web app

[JonathanLeeWH]

API Related

• Added POST users/check API endpoint for check on username availability
• Amended POST users API endpoint logic to add custom claims (username field) to firebase Authentication
• Resolved naming error with regards to the naming of the users controller method for users/check API endpoints
• Amended error message for missing and invalid authentication token with consistent message
• Added support for api/search/software to allow for integration with frontend typeahead search bar component (including page and per_page query params support`

Note: This does not use mongodb build in text search (https://docs.mongodb.com/manual/text-search/) due to lack of support for partial text search.

Potential Alternative is to use Mongodb Atlas Search (https://www.mongodb.com/atlas/search and https://www.mongodb.com/blog/post/mongodb-atlas-search-now-ga) but it will mean require depending on a third party service.

Another alternative is to use elasticsearch

• Added api/software/added/recent and api/software/updates/recent API endpoints
• Resolved a bug in POST software API endpoint where the software model meta properties are not updated

Model Related

• Removed username minlength of 6 constraint from user model
• Refactored ALLOWED_USERNAME_REGEX to utils/config.js
• Amended Allowed username regex to only allow alphanumeric characters (uppercase letter not included as all letters will be converted lowercase letters when saved to database) and underscores
• Added additional test scenario in users.test.js when no Authorization token is provided
• Added corresponding test cases for users/check API endpoints in users.test.js
• Amended software model by changing developedBy and maintainedBy fields from reference to user to an array of String

Note: This is due to the fact that the developer(s) or maintainer(s) may not be a registered user

• Improved software model with shortDescription, pricing, videoLink and twitterUsername fields

Note: videoLink field validates if the video link is either youtube.com or vimeo.com as the plan is to initially support only youtube and vimeo as video hosting websites

Test Related

• Added the corresponding requests API endpoint test file for POST users/check API endpoint
• Resolved a bug in the requests API endpoint test file file for POST users API endpoint
• Removed users.test.js test scenario where username provided is less than 6 characters in line with the removal of username minlength of 6 from user model
• Amended test/utils/databaseSetup.js setBackendDefaultUser method with the additional custom claims (username) for firebase Authentication (Part of frontend Integration)
• Amended softwareTestUtils.js to match the updated software model
• Amended post_software.rest test API endpoint file to match the updated software model
• Amended patch_softwareById.rest test API endpoint file to PATCH HTTP method from PUT HTTP method
• Added get_recentAddedSoftware.rest and get_recentUpdatedSoftware.rest test API endpoints files

Others

• Added additional check involving username in database for verifyAuthToken method when checkDatabase argument is set to true
• Refactored checkUsernameValidity as a separate method in utils/usersUtils.js for improved cohesion
• Refactored code with ALLOWED_VIDEO_HOST_WHITELIST now available in utils/config.js for easier configuration (Improved code quality)

To be considered

• To consider whether license field should be added in software model and whether it should accept a String (license type) or url type (the url to license)