Refactor/collection pages refactor #215
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
controllers/CollectionController.js
Outdated
|
|
||
| const GitHubService = require("@services/db/GitHubService") | ||
| const CollectionPageService = require("@services/fileServices/MdPageServices/CollectionPageService") | ||
| const ThirdNavPageService = require("@services/fileServices/MdPageServices/ThirdNavPageService") |
There was a problem hiding this comment.
Could we rename ThirdNavPageService to SubCollectionPageService for clarity? What do y'all think?
kwajiehao
approved these changes
Aug 11, 2021
There was a problem hiding this comment.
Lgtm!
I have a slightly unrelated comment: the current refactor document is sprawling and it's a little hard to see what the plan is, and thus whether we're implementing this according to our plan - I was thinking that having a new document with our finalized backend structure + diagram with the updated controller hierarchy might be helpful. What do y'all think? @prestonlimlianjie @alexanderleegs
Let's do it! |
* Refactor: Githubservice into class * Refactor: dependency injection for services * Refactor: dependency injection for controller * Refactor: router into class * Refactor: initialisation of services in server * Fix: standardise returned object parameter names in third nav page service * Refactor: use axiosInstance as a dependency injection for githubService * Fix: standardise new files being added to top of the order * Fix: allow empty page body in schema * Fix: retrieve router * Fix: throw appropriate error for bad requests * Fix: change expected request body for create and update to match object returned * Fix: update rename collection and third nav pages to not reorder collection.yml * Fix: update schema to allow blank new name * Chore: suppress log statements in test environment * Nit: rename third nav to subcollection * fix: small change in RequestSchema structure * style: convert to camel case (#253) * style: move file to validators folder * style: rename GitHubService methods to camel case * style: rename CollectionYmlService methods to camel case * style: rename NavYmlService methods to camel case * style: rename SubcollectionPageService methods to camel case * style: rename CollectionPageService methods to camel case * style: rename CollectionController methods to camel case * style: rename collectionPages methods to camel case * style: update import alias for validators * style: renaming method that was previously missed * Chore: install auto-bind * Fix: replace manual binding with autoBind * Fix: remove unused variables in GItHubService * style: remove unnecessary imports (#254) * Fix: handle update when no sha is provided correctly * Fix: reference to axios instance in githubservice * style: update comment to reflect code (#260) Code now obtains the index of first file in collection/subcollection using `_.findIndex` * Refactor: collection page tests (#259) * fix: get module alias to work with jest and install new packages * Chore: move directory of tests * Fix: add checks for test environment * Feat: add collection controller tests * Feat: add collection and third nav page tests * Feat: add collectionYmlService tests * Fix: update collection and third nav tests * Feat: add collection page route tests * Nit: rename third nav to subcollection * Style: change called methods to camelCase * Fix: missing camel case change * Fix: update module alias for jest * Feat: add githubService tests * Fix: change test name for github service * Fix: remove unused code * Fix: correct test name for specified index * Fix: check that deleteItemFromOrder is called for delete tests * Fix: capitalise test names and use path alias Co-authored-by: Alexis <gweiying@gmail.com> Co-authored-by: Preston Lim <prestonlimlianjie@gmail.com>
alexanderleegs
force-pushed
the
refactor/collection-pages-refactor
branch
from
f3c0eb3 to
fd9530d
Compare
lamkeewei
added a commit
that referenced
this pull request
Aug 23, 2021
* develop: (24 commits) Refactor/collection pages refactor (#215) build(deps): bump dompurify from 2.3.0 to 2.3.1 (#264) Introduce standard issue templates (#58) build(deps): bump cookie-parser from 1.4.4 to 1.4.5 (#261) build(deps): bump path-parse from 1.0.6 to 1.0.7 (#255) build(deps-dev): bump eslint-plugin-prettier from 3.3.1 to 3.4.0 (#229) build(deps-dev): bump lint-staged from 11.0.0 to 11.1.2 (#251) build(deps): bump morgan from 1.9.1 to 1.10.0 (#228) build(deps-dev): bump eslint-plugin-import from 2.22.1 to 2.23.4 (#223) build(deps): bump moment-timezone from 0.5.31 to 0.5.33 (#221) fix: upgrade bluebird from 3.7.0 to 3.7.2 (#239) fix: upgrade http-errors from 1.6.3 to 1.8.0 (#238) fix: upgrade js-base64 from 2.5.1 to 2.6.4 (#237) build(deps): bump dotenv from 8.1.0 to 10.0.0 (#219) fix: upgrade query-string from 6.8.3 to 6.14.1 (#235) [develop] fix: update logout (#252) feat: validate and sanitize media files (#249) Fix: update path to netlify.toml (#248) fix: add helmet for security (#243) fix: upgrade dependencies (#242) ...
lamkeewei
added a commit
that referenced
this pull request
Aug 23, 2021
…token-middleware * feat/identity/database-models: (25 commits) feat: add github_id column to user model Refactor/collection pages refactor (#215) build(deps): bump dompurify from 2.3.0 to 2.3.1 (#264) Introduce standard issue templates (#58) build(deps): bump cookie-parser from 1.4.4 to 1.4.5 (#261) build(deps): bump path-parse from 1.0.6 to 1.0.7 (#255) build(deps-dev): bump eslint-plugin-prettier from 3.3.1 to 3.4.0 (#229) build(deps-dev): bump lint-staged from 11.0.0 to 11.1.2 (#251) build(deps): bump morgan from 1.9.1 to 1.10.0 (#228) build(deps-dev): bump eslint-plugin-import from 2.22.1 to 2.23.4 (#223) build(deps): bump moment-timezone from 0.5.31 to 0.5.33 (#221) fix: upgrade bluebird from 3.7.0 to 3.7.2 (#239) fix: upgrade http-errors from 1.6.3 to 1.8.0 (#238) fix: upgrade js-base64 from 2.5.1 to 2.6.4 (#237) build(deps): bump dotenv from 8.1.0 to 10.0.0 (#219) fix: upgrade query-string from 6.8.3 to 6.14.1 (#235) [develop] fix: update logout (#252) feat: validate and sanitize media files (#249) Fix: update path to netlify.toml (#248) fix: add helmet for security (#243) ...
lamkeewei
added a commit
that referenced
this pull request
Aug 23, 2021
…/email-login * feat/identity/site-token-middleware: (25 commits) feat: add github_id column to user model Refactor/collection pages refactor (#215) build(deps): bump dompurify from 2.3.0 to 2.3.1 (#264) Introduce standard issue templates (#58) build(deps): bump cookie-parser from 1.4.4 to 1.4.5 (#261) build(deps): bump path-parse from 1.0.6 to 1.0.7 (#255) build(deps-dev): bump eslint-plugin-prettier from 3.3.1 to 3.4.0 (#229) build(deps-dev): bump lint-staged from 11.0.0 to 11.1.2 (#251) build(deps): bump morgan from 1.9.1 to 1.10.0 (#228) build(deps-dev): bump eslint-plugin-import from 2.22.1 to 2.23.4 (#223) build(deps): bump moment-timezone from 0.5.31 to 0.5.33 (#221) fix: upgrade bluebird from 3.7.0 to 3.7.2 (#239) fix: upgrade http-errors from 1.6.3 to 1.8.0 (#238) fix: upgrade js-base64 from 2.5.1 to 2.6.4 (#237) build(deps): bump dotenv from 8.1.0 to 10.0.0 (#219) fix: upgrade query-string from 6.8.3 to 6.14.1 (#235) [develop] fix: update logout (#252) feat: validate and sanitize media files (#249) Fix: update path to netlify.toml (#248) fix: add helmet for security (#243) ...
harishv7
pushed a commit
that referenced
this pull request
Feb 17, 2023
* Chore: update import paths * Feat: add base github service * Feat: add util service classes * Feat: add collection and third nav page services * Create CollectionController.js * Feat: add new routes for collection pages * Feat: add new v2 collection page routes * Feat: add new endpoints for v2 * Chore: install packages * Feat: add page request schemas * Feat: add schema validation in route * Fix: update name of returned object to pageBody * Refactor/dependency injection conversion (#234) * Refactor: Githubservice into class * Refactor: dependency injection for services * Refactor: dependency injection for controller * Refactor: router into class * Refactor: initialisation of services in server * Fix: standardise returned object parameter names in third nav page service * Refactor: use axiosInstance as a dependency injection for githubService * Fix: standardise new files being added to top of the order * Fix: allow empty page body in schema * Fix: retrieve router * Fix: throw appropriate error for bad requests * Fix: change expected request body for create and update to match object returned * Fix: update rename collection and third nav pages to not reorder collection.yml * Fix: update schema to allow blank new name * Chore: suppress log statements in test environment * Nit: rename third nav to subcollection * fix: small change in RequestSchema structure * style: convert to camel case (#253) * style: move file to validators folder * style: rename GitHubService methods to camel case * style: rename CollectionYmlService methods to camel case * style: rename NavYmlService methods to camel case * style: rename SubcollectionPageService methods to camel case * style: rename CollectionPageService methods to camel case * style: rename CollectionController methods to camel case * style: rename collectionPages methods to camel case * style: update import alias for validators * style: renaming method that was previously missed * Chore: install auto-bind * Fix: replace manual binding with autoBind * Fix: remove unused variables in GItHubService * style: remove unnecessary imports (#254) * Fix: handle update when no sha is provided correctly * Fix: reference to axios instance in githubservice * style: update comment to reflect code (#260) Code now obtains the index of first file in collection/subcollection using `_.findIndex` * Refactor: collection page tests (#259) * fix: get module alias to work with jest and install new packages * Chore: move directory of tests * Fix: add checks for test environment * Feat: add collection controller tests * Feat: add collection and third nav page tests * Feat: add collectionYmlService tests * Fix: update collection and third nav tests * Feat: add collection page route tests * Nit: rename third nav to subcollection * Style: change called methods to camelCase * Fix: missing camel case change * Fix: update module alias for jest * Feat: add githubService tests * Fix: change test name for github service * Fix: remove unused code * Fix: correct test name for specified index * Fix: check that deleteItemFromOrder is called for delete tests * Fix: capitalise test names and use path alias Co-authored-by: Alexis <gweiying@gmail.com> Co-authored-by: Preston Lim <prestonlimlianjie@gmail.com> Co-authored-by: Alexis <gweiying@gmail.com> Co-authored-by: Preston Lim <prestonlimlianjie@gmail.com>
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.
This PR introduces a new set of endpoints for collection pages, as part of our ongoing refactor for the CMS.
Introduced in this PR: