Migration to firebase Authentication #72
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removed previous implementation of custom JWT Authentication All existing controllers such as softwareController and usersController are reimplemented with firebase Authentication implementation Added disabledAPIEndPoint middleware to allow for disabling of API endpoints Disabled /api/auth API endpoint (Possible removing of auth api endpoint in future commits) with the new disabledAPIEndPoint middleware Disabled auth.test.js test suite and moved to disabledAPINotTested directory (with jest.config.js configuration) Refactored API endpoint from /api/softwareds/ to /api/software/ for consistency Amended software model to change platforms field from array to string (Plan for project page in future to support software with multiple platforms) Amended user model's passwordHash field to password field for consistency (It should still store password hash) Refactored all existing requests rest API test cases with the new software API endpoints route amendments, changes to request body and Authorization header Reimplemented all test cases for software.test.js and users.test.js (including their test utilities) with firebase Authentication integration Note: Some test cases are removed from previous test suites as it is handled by firebase Authentication such as email validation. Added firebaseConfig.js firebaseTestUtils.js Removed unused environmental variables from config.js
Improved app-test-container.yml GitHub Actions to support firebase Authentication Added new environmental variables introduced in migration to firebase Authentication in Dockerfile and remove unused environmental variables Improved .gitignore to avoid committing Google service account file for security purposes Added test-ci script in package.json for continuous integration usage Improved comments in software.test.js Added firebase.gpg Added Shell script descrypt_firebase_secret.sh for firebase.gpg decrpytion (This is for continuous integration only) Added Dockerfile-ci which is a separate dockerfile used only by continuous integration Improved docker-compose-test-ci with firebase Authentication support Refactor docker ci files to .github directory
JonathanLeeWH
added
documentation
…softwaredevelopment/SoftwareRepository into migration-to-firebase-auth
JonathanLeeWH
added
bug.resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To address #68
Reimplemented existing source code for firebase Authentication migration
softwareControllerandusersControllerare reimplemented with firebase Authentication implementationdisabledAPIEndPointmiddleware to allow for disabling of API endpoints/api/authAPI endpoint (Possible removing ofauthapi endpoint in future commits) with the new disabledAPIEndPoint middlewareauth.test.jstest suite and moved todisabledAPINotTesteddirectory (with jest.config.js configuration)/api/softwares/to/api/software/for consistencysoftwaremodel to changeplatformsfield toplatformfield and the corresponding type fromarraytostring(Plan for project page in future to support software with multiple platforms)passwordHashfield topasswordfield for consistency (It should still store password hash)Authorizationheadersoftware.test.jsandusers.test.js(including their test utilities) with firebase Authentication integration.Note: Some test cases are removed from previous test suites as it is handled by firebase Authentication such as email validation.
firebaseConfig.jsandfirebaseTestUtils.jsconfig.js.gitignoreto avoid committing Google service account file (Security purposes)The Improved docker support with firebase Authentication
docker-compose-test-ci.ymlto.github/ci/docker-compose-test-ci.ymldecrypt_firebase_secret.shshell script used for continuous integrationdockerfileand removed unused environmental variablesdockerfile-cia custom docker file specifically for continuous integrationOthers
putsoftwareAPI endpoint is doing a partial update of resource in logic which in the concept of Rest API is a behaviour ofpatchhence, the HTTP method is changed fromputtopatchto match the logic used