Welcome to ACME acounting, this codebase serves as a way for you to know how we at OSOME work and how you work through challenges while adopting an existing codebase.
There are 3 tasks that you need to do to complete this task, all of them must be done for you to move forward.
Keep things elegant, but as simple as possible.
If there are any issues, contact your hiring representative and they will clarify it with you.
If you are to use AI/LLM, DISCLOSE where and how you used it.
We have companies, companies have users.
Every user has a role, which defines what this user does in the
company. There might be multiple users with the same role.
We create tickets in a company and assign them to users.
Every ticket has
- Type - defines the work that should be done by the user
- Single assignee - the user
- Category - every type is under a particular category
- Status - open or resolved
Endpoints
GET api/v1/tickets- returns all tickets in the system. Without pagination. This is only for creating logic testing.POST api/v1/tickets- creates a ticket. It acceptstypeandcompanyIdGET api/v1/report- starts the processing of existing data and builds a report.
Ticket Creation Rules
If a ticket type is managementReport, then the ticket category
should be accounting. The assignee is a user with the role = Accountant.
If there are multiple accountants in the company,
take the most recently created one.
If a ticket type is registrationAddressChange, then the ticket category
should be Corporate. Assignee is a user with the role Corporate secretary.
If there are multiple secretaries, throw an error.
If we cannot find an assignee with the required role, throw an error.
Before working on tasks please clone the repo to your own GitHub account
When done commit the changes and create a PR for the changes in YOUR OWN repository. Send us a link for review.
This service is old, new business requirements have come in and it requires us to change the internals of the service.
Let's generate with fixing the behaviour of the service.
Instructions
- When creating a
registrationAddressChangeticket, if the company already has a ticket with this type, throw a duplication error. - Add a new
Directoruser role. If we create aregistrationAddressChangeticket, and we cannot find a corporate secretary, assign it to theDirector. If there are multiple directors, throw an error.
It seems that companies are closing down more than usual, we never considered this case before. Maybe it's time to add another type of ticket.
Instructions
- Create New Ticket Type
{ "type": "strikeOff", "Category": "Management", "Assignee": "Director" }
Side Effects
- If there are multiple directors, throw an error.
- Resolve all other active tickets in this company (we do not need them anymore as we are closing down the company).
ACME processes tons of data every day. It is essential for us that we make sure that our internal processes and data are provided accurately and on time.
We have a legacy service that processes data for us, but it takes a long time to get the results. Maybe this is a good time to refactor the code.
Instructions
- Optimize the endpoint so that the time it takes to finish an action is marginally faster.
- The endpoint should not hold the connection of the client while processing the data in the background.
- We are looking for performance, not accuracy. If you see numbers not tallying correctly in the report, you may skip it.
Acceptance
- The endpoint should be respond faster than the existing implementation
- Documents should process in the background and the client should be able to check the status of the processing.
- Metrics should be recorded for discussion.
There are common principles in the repository that are intentionally left out and not covered by the base tasks given above. These are common best-practice tasks that you can make in any node project.
Doing more than what is given above will be plus points and will be considered in our code review session.
Here are some of the topics you can consider:
- Code Quality
- Fixing Subtle Errors
- Using Tests
- Performance Considerations
- NPM
$ nvm use
$ npm install- Run the DB container
docker-compose up -d- Run migrations
npm run db:migrate- Start the server
npm startWe use the integration tests instead of a unit ones for controllers. It means we do not mock db requests but perform them on a test db.
To run tests:
1.Run the DB container (if you did not before)
docker-compose up -d2.Create a db
npm run db:create:test- Run migrations
npm run db:migrate:test- Test
npm test