chore: replace local module with shared folder #1144
Merged
Conversation
This file contains 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
lamkeewei
force-pushed
the
shared-folder
branch
from
e0fa59b
to
2e85a11
Compare
lamkeewei
force-pushed
the
shared-folder
branch
from
2e85a11
to
e0c461e
Compare
* develop: refactor: use shared function to initialize models (#1172) chore: setup scaffolding for backend tests (#940) 1.23.0 fix(frontend): fix frontend test flakiness (#1162) fix: update successful delivery status only if error does not exist (#1150) chore: upgrade dependencies (#1153) feat: add unit tests for error states in critical workflows (#1118) feat: support whitelisting domains through `agencies` table (#1141) feat: add tests for happy paths in critical workflows (#1110) fix: prevent campaign names from causing dashboard rows to overflow (#1147) fix(email): Fix SendGrid fallback integration (#1026)
Removed npm test:watch as we can just use npm t -- --watch instead. Did this to avoid duplicating pretest step.
miazima
reviewed
May 17, 2021
| script: | ||
| - npm run build |
There was a problem hiding this comment.
Could you help explain why we didn't need the build step previously but have included it now? I guess its to build the shared module, but where was the backend being built previously
There was a problem hiding this comment.
Yep - this is to build the shared module. Previously there was not need to separate build the backend because npm test handles it. However, ts-jest does not automatically compile project references.
miazima
approved these changes
May 17, 2021
lamkeewei
added a commit
that referenced
this pull request
May 27, 2021
* develop: chore: replace local module with shared folder (#1144) 1.24.0
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.
Problem
Closes #1139
Solution
Use Typescript project references to reference shared module
I've chosen to take a slightly different approach to referencing the shared module in
tsconfigas compared to the vaccinegovsg-clinic repository. Instead of adding the shared folder path in theincludeoption, I've chosen to make use of project references instead.The main advantage for this approach is that we can avoid having to manually keep in sync the dependencies for the
sharedfolder and the other modules. For example, if we were to use theincludeapproach, thexsslibrary has to be in each of thepackage.jsonforbackend,frontendandworker. Keeping all the differentpackage.jsonin sync is a non-trivial problem and is prone to developer error.The drawback of this approach is that we have to manually
npm installinside the shared folder to install its dependencies. The necessary changes to.travis.ymland the respectiveDockerfilehave been made.Manually patch
moduleNameMapperrather than usealiasJestThe default
aliasJestfunction provided by react-app-rewire-alias does not work for our setup. The main reason for this is that the library assumes that our aliases would follow the pattern ofmodule/submodule. However, there are quite a number of instances in our code that references aliases directly without a submodule (e.g.import config from 'config').Tests
Apart from changing the structure of the code, this PR should not modify or introduce any behaviour. To verify that everything works as expected:
In addition, hot reload should also work now for the shared module. Changing code in the shared module should automatically trigger a recompilation for any other module depending on it.