nax3t / automated-payroll Goto Github PK

Reference: https://github.com/nax3t/automated-payroll/blob/main/app.js#L181-L186

We should receive a web hook to trigger the action to run the service, and setup https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#scheduled-events to be responsible for running the crons.

In order to make the code more readable, and testable we should introduce a service layer to the project. Basically a service is just a function or class that does some work. It just does 1 thing and 1 thing only. GetAccountsPayableService for example.

AC:

• Start moving logic to services. ( GetAccountsPayableService as an example )

Depends on:

• #7

I have a few ideas to help make this a little more readable, and wonder if I worked on this would you accept the pull request.

API Client

We can create an instance of axios client with the base URL, any credentials thats needed. When we call the API we would do so with our instance.

Add Service Layer

Basically a service is just a function or class that does some work. It just does 1 thing and 1 thing only. GetAccountsPayableService for example.

Personal preferences

https://github.com/nax3t/automated-payroll/blob/main/app.js#L72-L73

We can do something like this instead: action.label?.name === 'Ready to pay'

Create a Webhook instead?

At the end of the day we have an interval when we need to do work.

https://github.com/nax3t/automated-payroll/blob/main/app.js#L181-L186

Consider having some other service, like GitHub, handling the cron to send it to our webhook.

https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#scheduled-events

Track payment ledgers

What happens if a payment failed? why? where are we logging it? what would you do right now if payment failed and someone asked you to look into it? When you do track it in a database this is a secondary action so I would take a instance of eventemitter with something like this pattern

https://refactoring.guru/design-patterns/observer

Let's only use the GitHub username to find the member from API to get hourly rates.

Problem:
This line of code is creating a problem because we have led76marx and toledit in our team with led as part of their name.

Due to this reason, toledit was receiving the payment with an hourly rate of led76marx.

Also, we should get rid of this code there are possible edge cases for this too.

What happens if a payment failed? why? where are we logging it? what would you do right now if payment failed and someone asked you to look into it?

Consider:

When you do track it in a database this is a secondary action so I would take a instance of eventemitter with something like this pattern https://refactoring.guru/design-patterns/observer

We can create an instance of axios client with the base URL, any credentials thats needed to make API request. When we call the API we would do so with our instance.

AC:

• Create a Custom Axios Instance
• In at least 1 place call the API with our custom Axios Instance

Expected
When the sender account balance is lower than amount + fees then it should show payment failed.

Actually
Shows payment succeeded but there is no transaction.