Forem: M.Hakim Amransyah

I am trying to merge all json data from paginated api responses with Go, this is how it looks like

M.Hakim Amransyah — Thu, 31 Aug 2023 12:49:43 +0000

Background

Once upon a time, I need to consume list of users data from an api which uses json response. As I predicted earlier, the api provider creates a pagination responses when the consumer interacts with list. Unfortunately I need to consume all users which means I have to hit every possible pagination query parameter to fetch all users.

here's the api endpoint

.../api/v2/users?page=1&per_page=4

and here's the api response

{
  "meta": {
    "page": 1,
    "per_page": 5,
    "total_pages": 100
  },
  "data": [
    {
      "id": "ef5b4299-b8d0-40c2-8442-2fdc90e342ae",
      "firstname": "Cale",
      "lastname": "Schmidt",
      "email": "Liana8@gmail.com"
    },
    {
      "id": "c0328632-1f18-4cf6-ad53-17278ffcc7bb",
      "firstname": "Norval",
      "lastname": "Feest",
      "email": "Eleanora.Gleason55@gmail.com"
    },
    {
      "id": "0c467516-444f-4d01-b40d-82f7a646820a",
      "firstname": "Muriel",
      "lastname": "Berge",
      "email": "Clarissa_Simonis44@hotmail.com"
    },
    {
      "id": "2942a4b0-eac4-463c-87e3-6c7d0406cc81",
      "firstname": "Cletus",
      "lastname": "Considine",
      "email": "Casper.Kris77@gmail.com"
    },
    {
      "id": "2942a4b0-eac4-463c-87e3-6c7d0406cc81",
      "firstname": "Cletus",
      "lastname": "Considine",
      "email": "Casper.Kris77@gmail.com"
    }
  ]
}

First thing that comes to my mind when i face this problem is i go to first page and get last page information and then i will iterate to reach every possible page and merge every user from api response. To improve performance then I need to do it asynchronously for each page. As a result the user data I manage to merge is not sequential and I'm ok with that.

Code

I developed a module which provide the functionality as i mention earlier. You can get it in this repository.

Usage

Create a struct that representing json response which bind api response to a static data type.

type Meta struct {
    Page    int `json:"page"`
    PerPage int `json:"per_page"`
    TotalPages int `json:"total_pages"`
}

type User struct {
    Uuid  string `json:"id" gorm:"column:id;primaryKey"`
    FirstName string `json:"firstname" gorm:"column:firstname"`
    LastName  string `json:"lastname" gorm:"column:lastname"`
    Email     string `json:"email" gorm:"column:email"`
}

type Response struct {
    Meta Meta   `json:"meta"`
    User []User `json:"data"`
}

func (resp *Response) GetBoundary() int {
    return resp.Meta.TotalPages
}

In case you're asking about tag "gorm" , yes i will use it.
Then i create module instance with some configurations like this

type Meta struct {
    Page    int `json:"page"`
    PerPage int `json:"per_page"`
    TotalPages int `json:"total_pages"`
}

type User struct {
    Uuid  string `json:"id" gorm:"column:id;primaryKey"`
    FirstName string `json:"firstname" gorm:"column:firstname"`
    LastName  string `json:"lastname" gorm:"column:lastname"`
    Email     string `json:"email" gorm:"column:email"`
}

type Response struct {
    Meta Meta   `json:"meta"`
    User []User `json:"data"`
}

func (resp *Response) GetBoundary() int {
    return resp.Meta.TotalPages
}

func main() {

   var jsonPages Response

  pag, err := paginationaggregator.NewPaginationAggregator( 
    &paginationaggregator.PaginationAggregatorConfig{
      URL:"http://127.0.0.1:3000/api/v2/users?per_page=5&page=%d",
      Client: &http.Client{},
      JsonPage: &jsonPages,
      Concurrent: 5,
    },
  )

}

As you can see, the library provides Concurrent configuration. This configuration means if you need to make 100 requests for each page then there will be 20 batch asynchronous requests or each batch will make 5 asynchronous requests until all page fetched. I think it will prevent api server considers all these requests as DDOS attacks and prevents requests from hitting rate limiters.

Insert user to database

After successfully retrieving all user then I need to insert it into database only if user email does not exist. Rather than waiting for all user successfully retrieved, the library provides a function so we can process it in each batch.

type Meta struct {
   Page       int `json:"page"`
   PerPage    int `json:"per_page"`
   TotalPages int `json:"total_pages"`
}

type User struct {
   Uuid      string `json:"id" gorm:"column:id;primaryKey"`
   FirstName string `json:"firstname" gorm:"column:firstname"`
   LastName  string `json:"lastname" gorm:"column:lastname"`
   Email     string `json:"email" gorm:"column:email"`
}

type Response struct {
   Meta Meta   `json:"meta"`
   User []User `json:"data"`
}

func (resp *Response) GetBoundary() int {
   return resp.Meta.TotalPages
}

var Mysql *gorm.DB

func main() {

  var jsonPages Response

  Mysql = connectMysql()
  defer func() {
     sql, _ := Mysql.DB()
     sql.Close()
  }()

  pag, err := paginationaggregator.NewPaginationAggregator(
   &paginationaggregator.PaginationAggregatorConfig{
      URL:"http://127.0.0.1:3000/api/v2/users?per_page=5&page=%d",
      Client: &http.Client{},
      JsonPage: &jsonPages,
      Concurrent: 5,
      ConcurrentBatch: processingBatch,
     },
  )

  if err != nil {
     fmt.Println(err)
     return
  }

  res, err := pag.Get()

  if err != nil {
     fmt.Println(err)
     return
  }

  for _, val := range res {
     fmt.Println(val.Response.Data)
  }
}

// select and insert user for every batch
func processingBatch(
    batchResult []paginationaggregator.HttpInteraction
) error {

   var newUsers []User

   for _, val := range batchResult {

      resp := Response{}

      if err := json.Unmarshal([]byte(val.Response.Data), 
                   &resp); err != nil {
         continue
      }

      for _, user := range resp.User {

       userTmp := User{}

           // check existing user by email
           if err := Mysql.Where("email = ?", 
                user.Email).First(&userTmp).Error; err != nil {

              if errors.Is(err, gorm.ErrRecordNotFound) {
                       // users not exists so append it
                  newUsers = append(newUsers, user)
              }

             continue

          }
       }
    }

    if err := Mysql.Create(&newUsers).Error; err != nil {
         return err
    }

    return nil
}

func connectMysql() *gorm.DB {

    dsn := "root:yourpassword@tcp(127.0.0.1:3306)/peoples"

    DB, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
        Logger: logger.Default.LogMode(logger.Silent),
    })

    if err != nil {
    panic(err)
    }

    return DB
}

Reference

https://github.com/Mhakimamransyah/go-pagination-aggregate

Di Pandu oleh Iterator Pattern

M.Hakim Amransyah — Fri, 07 Jul 2023 02:02:01 +0000

Artikel Ini adalah lanjutan pembahasan implementasi design-pattern yang sebelumnya dibahas pada Bersolek Ria dengan Decorator-pattern. Domain permasalah dan sources code yang digunakan merupakan lanjutan dari pembahasan sebelumnya.

Prolog

Perusahaan tempat anda bekerja ternyata memiliki segudang ide dan rencana terkait dengan aplikasi yang anda kelola. Hari ini anda, atasan anda dan seorang product owner melakukan virtual meeting terkait enhancement dari aplikasi tersebut. Diskusi berakhir dengan sebuah tugas yang di bebankan kepada anda melalui atasan anda.

Anda diminta untuk menambahkan fungsi untuk memfilter setiap pegawai yang akan dikirimkan notifikasi peringatan ke sources code yang ada. Saat ini aplikasi anda bersifat "buta" dengan mengirimkan notifikasi peringatan kepada seluruh pegawai di setiap level tanpa memperhatikan apakah status pegawai tersebut masih aktif atau tidak.

Open for extension Closed for modification

Atasan anda meminta agar filter yang dibuat bisa digunakan dimanapun ketika ada fitur yang membutuhkan. Filter tersebut juga diharapkan nantinya tidak perlu dimodifikasi apabila ada kebutuhan untuk memfilter pegawai dengan cara yang berbeda. Atasan anda kemudian menyebut sebuah kata yang bisa mengubah hidup anda sepenuhnya, dia berkata

"Coba pelajari iterator pattern"

Iterator

Setelah mendapatkan petunjuk dari atasan anda, anda memutuskan untuk menggunakan iterator pattern pada kasus ini. Anda berencana untuk membuat sebuah objek yang hanya bertanggung jawab untuk memfilter status aktif dari pegawai. Anda juga tahu bahwa dengan menggunakan pattern ini iterator lain bisa dengan mudah ditambahkan apabila nanti dibutuhkan.

iterator.go

type Iterator interface {
    GetNext() Employee
    HasMore() bool
}

active_employee_iterator.go

type ActiveEmployeeIterator struct {
    Employees       []entity.Employee
    CurrentPosition int
    Status          bool
}

func (iter *ActiveEmployeeIterator) GetNext() entity.Employee {

    if !iter.HasMore() {
        return nil
    }

    employee := iter.Employees[iter.CurrentPosition]

    iter.CurrentPosition++

    if employee.GetStatus() {
        return employee
    }

    return iter.GetNext()

}
func (iter *ActiveEmployeeIterator) HasMore() bool {

    if iter.CurrentPosition >= len(iter.Employees) {
        return false
    }

    employee := iter.Employees[iter.CurrentPosition]

    if employee.GetStatus() {
        return iter.CurrentPosition < len(iter.Employees)
    }

    iter.CurrentPosition++

    return iter.HasMore()

}

func NewActiveEmployeeIterator(employees []entity.Employee, status bool) *ActiveEmployeeIterator {
    return &ActiveEmployeeIterator{Employees: employees, Status: status}
}

Panggil iterator pada main program sehingga;

main.go

// iterate only for active employee
    employeesIter := iterator.NewActiveEmployeeIterator(employees, true)

    for employeesIter.HasMore() {

        employee := employeesIter.GetNext()

        // accept performance notification visitor
        employee.Accept(performanceNotification)

        // accept bonus income visitor
        employee.Accept(bonusIncome)

    }

Epilog

Seluruh sources code yang berkaitan dengan artikel ini dapat dilihat pada repository berikut https://github.com/Mhakimamransyah/practice-design-pattern

Referensi Bacaan
https://refactoring.guru/design-patterns/iterator

Author
https://github.com/Mhakimamransyah
https://www.linkedin.com/in/hakim-amr/
mailto: m.hakim.amransyah.hakim@gmail.com

Bersolek Ria dengan Decorator Pattern

M.Hakim Amransyah — Sat, 01 Jul 2023 08:31:29 +0000

Artikel Ini adalah lanjutan pembahasan implementasi design-pattern yang sebelumnya dibahas pada lebih dekat dengan visitor-pattern. Domain permasalah dan sources code yang digunakan merupakan lanjutan dari pembahasan sebelumnya.

Prolog

Pada saat daily standup kemarin anda mendapatkan arahan dari atasan anda untuk melakukan enhance pada fitur pengiriman notifikasi peringatan yang telah dibuat. Sebelumnya anda hanya menggunakan fungsi sederhana untuk mengirimkan notifikasi peringatan ke seluruh level pegawai. Atasan anda meminta agar sources code yang ada mampu mengakomodasi untuk mengirimkan notifikasi menggunakan beberapa media yang berbeda-beda. Adapun ketentuan yang diminta oleh atasan anda adalah;

Seluruh level pegawai akan menerima notifikasi melalui push notification pada aplikasi mobile perusahaan.
Selain push notification, supervisor dapat menerima notifikasi melalui email.
Selain push notification, manajer dapat menerima notifikasi melalui email & pesan whatsapp.

Secara umum saat ini aplikasi anda memiliki relasi kelas sebagai berikut;

Tanggung jawab pengiriman notifikasi peringatan saat ini diemban oleh objek PerformanceWarningVisitor yang merupakan implementasi dari visitor-pattern (dijelaskan pada lebih dekat dengan visitor-pattern ).

Mendekor ulang objek

Anda tahu bahwa saat ini notifikasi peringatan hanya dikirimkan melalui push notifications. Sesuai dengan ketentuan yang diberikan, anda harus menambahkan media notifikasi lainnya tanpa menghapus atau menghilangkan default notifikasi yang saat ini digunakan.

Anda sadar bahwa membuat objek yang berdiri sendiri bukanlah ide yang bagus karena (sekali lagi) setiap jenis notifikasi akan berakumulasi dengan jenis notifikasi lain. Sederhananya ketentuan tersebut dapat dijelaskan seperti berikut

Staf -> Push Notification
Supervisor -> Push Notification | Email
Manajer -> Push Notification | Email | WhatsApp Number

Decorator Pattern

Setelah gugling dan bertapa cukup lama, anda akhirnya memutuskan untuk menggunakan decorator-pattern untuk menangani kasus ini. Anda akan membuat sebuah decorator yang akan mendekorasi ulang fungsi push-notifications sehingga memiliki fungsi notifikasi dengan media yang berbeda-beda.

Anda membuat sebuah kelas factory yang bertugas untuk meng-assemble berbagai macam decorator sesuai dengan level pegawai yang ada. Singkatnya implementasi kelas tersebut adalah sebagai berikut;

notification_factory.go

type NotificatorContract interface {
    StaffNotifier() entity.Notifier
    SupervisorNotifier() entity.Notifier
    ManagerNotifier() entity.Notifier
}

type Notificator struct{}

func (notifier *Notificator) StaffNotifier() entity.Notifier {
    return decorator.NewPushNotificationDecorator()
}

func (notifier *Notificator) SupervisorNotifier() entity.Notifier {
    pushNotification := decorator.NewPushNotificationDecorator()
    emailNotification := decorator.NewEmailDecorator(pushNotification)
    return emailNotification
}

func (notifier *Notificator) ManagerNotifier() entity.Notifier {
    pushNotification := decorator.NewPushNotificationDecorator()
    emailNotification := decorator.NewEmailDecorator(pushNotification)
    whatsAppNotification := decorator.NewWhatsAppDecorator(emailNotification)
    return whatsAppNotification
}

func NewNotificator() *Notificator {
    return &Notificator{}
}

Factory tersebut nantinya akan dimanfaatkan oleh objek PerformanceWarningVisitor.

performance_warning_visitor.go

type PerformanceWarningVisitor struct {
    Notif factory.NotificatorContract
}

func (visitor PerformanceWarningVisitor) VisitStaff(staff *entities.Staff) (interface{}, error) {

    var warningType string

    notification := visitor.Notif.StaffNotifier()

    if staff.PerformancePercentage < 30 {
        warningType = STERN_WARNING
    }

    if staff.PerformancePercentage >= 30 && staff.PerformancePercentage < 67 {
        warningType = WARNING
    }

    notification.SendMessage(
        staff,
        fmt.Sprintf("Notification %s send to staff : %s \n", warningType, staff.Name),
    )

    return warningType, nil
}

func (visitor PerformanceWarningVisitor) VisitSupervisor(spv *entities.Supervisor) (interface{}, error) {

    var warningType string

    durationInYear := (time.Now()).Sub(spv.JoinDate).Hours() / 8760
    notification := visitor.Notif.SupervisorNotifier()

    if spv.PerformancePercentage < 30 {
        warningType = STERN_WARNING
    }

    if durationInYear >= 10 && (spv.PerformancePercentage >= 30 && spv.PerformancePercentage < 60) {
        warningType = WARNING
    }

    if durationInYear < 10 && (spv.PerformancePercentage >= 30 && spv.PerformancePercentage < 70) {
        warningType = WARNING
    }

    notification.SendMessage(
        spv,
        fmt.Sprintf("Notification %s send to supervisor : %s \n", warningType, spv.Name),
    )

    return warningType, nil
}

func (visitor PerformanceWarningVisitor) VisitManager(manager *entities.Manager) (interface{}, error) {

    var warningType string

    Age := (time.Now()).Sub(manager.BirthDate).Hours() / 8760
    notification := visitor.Notif.ManagerNotifier()

    if manager.PerformancePercentage < 40 {
        warningType = STERN_WARNING
    }

    if Age >= 40 && (manager.PerformancePercentage >= 40 && manager.PerformancePercentage < 60) {
        warningType = WARNING
    }

    if Age < 40 && (manager.PerformancePercentage >= 40 && manager.PerformancePercentage < 70) {
        warningType = WARNING
    }

    notification.SendMessage(
        manager,
        fmt.Sprintf("Notification %s send to manager : %s \n", warningType, manager.Name),
    )

    return warningType, nil
}

Epilog

Seluruh sources code yang berkaitan dengan artikel ini dapat dilihat pada repository berikut https://github.com/Mhakimamransyah/practice-design-pattern

Referensi Bacaan
https://refactoring.guru/design-patterns/decorator
https://www.youtube.com/watch?v=metYIcjQLls

Author
https://github.com/Mhakimamransyah
https://www.linkedin.com/in/hakim-amr/
mailto: m.hakim.amransyah.hakim@gmail.com

Lebih Dekat dengan Visitor Pattern

M.Hakim Amransyah — Wed, 28 Jun 2023 08:21:18 +0000

Prolog

Alkisah anda sebagai seorang backend engineer dihadapkan kepada sebuah tugas untuk menambahkan fitur notifikasi peringatan kepada seluruh level pegawai dengan ketentuan yang bervariasi. Ketentuan yang dimaksud antara lain;

Staf
- Staf yang memiliki memiliki KPI dibawah 30% akan menerima notifikasi "peringatan-keras".
- Staf yang memiliki KPI dibawah 67% dan diatas 30% akan menerima notifikasi "peringatan".
Supervisor
- Supervisor yang memiliki memiliki KPI dibawah 30% akan menerima notifikasi "peringatan-keras".
- Supervisor yang memiliki masa kerja di atas 10 tahun dan memiliki KPI diatas 30% dan dibawah 60% akan menerima notifikasi "peringatan".
- Supervisor memiliki masa kerja di bawah 10 tahun dan memiliki KPI diatas 30% dan dibawah 70% akan menerima notifikasi "peringatan".
Manajer
- Manajer yang memiliki memiliki KPI dibawah 40% akan menerima notifikasi "peringatan-keras".
- Manajer yang memiliki usia di atas 40 tahun dan memiliki KPI diatas 40% dan dibawah 60% akan menerima notifikasi "peringatan".
- Manajer yang memiliki usia di bawah 40 tahun dan memiliki KPI diatas 40% dan dibawah 70% akan menerima notifikasi "peringatan".

Aplikasi anda saat ini dibuat menggunakan bahasa pemrograman go dan hanya memiliki 4 kelas yang membedakan setiap level pegawai yang ada. Tugas anda adalah menambahkan fungsionalitas sesuai dengan ketentuan tersebut ke sources code yang ada.

Ide yang Tertolak

Anda berdiskusi dengan atasan anda dan menyampaikan ide bahwa anda akan menambahkan sebuah fungsi sendWarningNotification pada objek Staf, Supervisor dan Manager. Atasan anda mengerenyutkan dahi dan bertanya kepada anda.

Apakah pegawai di perusahaan kita sekarang berperan sebagai seorang pemberi peringatan ?

Diskusi berlanjut dan atasan anda menolak ide anda karena dianggap menambahkan sifat "alien" ke ketiga objek tersebut. Atasan anda juga men-changelle bagaimana ide tersebut nantinya akan mampu mengakomodasi apabila ada penambahan behaviour lagi terhadap ketiga objek ini.

Visitor Pattern

Pada akhirnya anda dan atasan memutuskan untuk menggunakan visitor pattern untuk menangani kasus ini.

Seluruh logika pengiriman notifikasi peringatan akan menjadi tanggung jawab dari objek PerformanceWarningVisitor. Setiap objek turunan employee(Staff, Supervisor dan Manager) tidak perlu tahu definisi dan implementasi pengiriman notifikasi peringatan. Objek Staff, Supervisor dan Manager hanya perlu memanggil method Accept dengan paramater PerformanceWarningVisitor untuk mengirimkan notifikasi peringatan kepada seluruh level pegawai.

main.go

func main() {

    employees := make([]entities.Employee, 0)

    performanceNotification := visitor.PerformanceWarningVisitor{}

    employees = append(employees,
        entities.Staff{
            Id:                    12343,
            Name:                  "Pedro Pacquita",
            JoinDate:              time.Date(2011, time.February, 10, 0, 0, 0, 0, time.UTC),
            BirthDate:             time.Date(1990, time.January, 07, 0, 0, 0, 0, time.UTC),
            PerformancePercentage: 47.5,
        },
        entities.Supervisor{
            Id:                    12342,
            Name:                  "Omar Maulo Atarez",
            JoinDate:              time.Date(2005, time.December, 15, 0, 0, 0, 0, time.UTC),
            BirthDate:             time.Date(1987, time.December, 02, 0, 0, 0, 0, time.UTC),
            PerformancePercentage: 75,
        },
        entities.Manager{
            Id:                    12312,
            Name:                  "Zakaria Owele",
            JoinDate:              time.Date(1993, time.December, 04, 0, 0, 0, 0, time.UTC),
            BirthDate:             time.Date(1971, time.July, 15, 0, 0, 0, 0, time.UTC),
            PerformancePercentage: 50,
        },
    )

    for _, employee := range employees {

        // send performance notification
        employee.Accept(performanceNotification)

    }
}

staff.go

type Staff struct {
    Id                    int
    Name                  string
    JoinDate              time.Time
    BirthDate             time.Time
    PerformancePercentage float32
}

func (staff Staff) Accept(v Visitor) {
    v.VisitStaff(&staff)
}

supervisor.go

type Supervisor struct {
    Id                    int
    Name                  string
    JoinDate              time.Time
    BirthDate             time.Time
    PerformancePercentage float32
}

func (spv Supervisor) Accept(visitor Visitor) {
    visitor.VisitSupervisor(&spv)
}

manager.go

type Manager struct {
    Id                    int
    Name                  string
    JoinDate              time.Time
    BirthDate             time.Time
    PerformancePercentage float32
}

func (manager Manager) Accept(visitor Visitor) {
    visitor.VisitManager(&manager)
}

performance_warning_visitor.go

type PerformanceWarningVisitor struct{}

func (visitor PerformanceWarningVisitor) VisitStaff(staff *entities.Staff) (interface{}, error) {

    var warningType string

    if staff.PerformancePercentage < 30 {
        warningType = STERN_WARNING
    }

    if staff.PerformancePercentage >= 30 && staff.PerformancePercentage < 67 {
        warningType = WARNING
    }

    if warningType != "" {
        fmt.Printf("Notification %s send to staff : %s \n", warningType, staff.Name)
    }

    return warningType, nil
}

func (visitor PerformanceWarningVisitor) VisitSupervisor(spv *entities.Supervisor) (interface{}, error) {

    var warningType string
    durationInYear := (time.Now()).Sub(spv.JoinDate).Hours() / 8760

    if spv.PerformancePercentage < 30 {
        warningType = STERN_WARNING
    }

    if durationInYear >= 10 && (spv.PerformancePercentage >= 30 && spv.PerformancePercentage < 60) {
        warningType = WARNING
    }

    if durationInYear < 10 && (spv.PerformancePercentage >= 30 && spv.PerformancePercentage < 70) {
        warningType = WARNING
    }

    if warningType != "" {
        fmt.Printf("Notification %s send to supervisor : %s \n", warningType, spv.Name)
    }

    return warningType, nil
}

func (visitor PerformanceWarningVisitor) VisitManager(manager *entities.Manager) (interface{}, error) {

    var warningType string
    Age := (time.Now()).Sub(manager.BirthDate).Hours() / 8760

    if manager.PerformancePercentage < 40 {
        warningType = STERN_WARNING
    }

    if Age >= 40 && (manager.PerformancePercentage >= 40 && manager.PerformancePercentage < 60) {
        warningType = WARNING
    }

    if Age < 40 && (manager.PerformancePercentage >= 40 && manager.PerformancePercentage < 70) {
        warningType = WARNING
    }

    if warningType != "" {
        fmt.Printf("Notification %s send to manager : %s \n", warningType, manager.Name)
    }

    return warningType, nil
}

Perubahan adalah Kepastian

Seiring berjalannya waktu prediksi atasan anda akan adanya penambahan fitur yang melibatkan ketiga objek employee ini ternyata menjadi kenyataan.

Anda kembali diminta untuk menambahkan fitur untuk menghitung bonus pendapatan tambahan dari masing-masing level employee dengan ketentuan sebagai berikut ;

Staf
- Setiap staf akan menerima bonus pendapatan tambahan sebesar 1000000 apabila mempeeoleh KPI di atas 87%
Supervisor
- Setiap supervisor akan menerima bonus pendapatan tambahan sebesar 2000000 apabila mempeeoleh KPI di atas 85%
Manajer
- Setiap manajer akan menerima bonus pendapatan tambahan sebesar 5000000 apabila mempeeoleh KPI di atas 80%

Anda dan atasan tahu bahwa sources code yang ada bisa di expand dengan mengikuti pola visitor pattern yang sudah ada.

Anda hanya perlu memanggil kembali method Accept akan tetapi kali ini gunakan BonusIncomeVisitor sebagai parameter nya

for _, employee := range employees {

  // send performance notification
  employee.Accept(performanceNotification)

  // calculate bonus income
  employee.Accept(bonusIncome)

}

Epilog

Seluruh sources code yang berkaitan dengan artikel ini dapat dilihat pada repository berikut https://github.com/Mhakimamransyah/practice-design-pattern.

Bacaan Lanjutan

Decorator Pattern

Referensi Bacaan
https://refactoring.guru/design-patterns/visitor
https://refactoring.guru/design-patterns/visitor/go/example
https://refactoring.guru/design-patterns/visitor-double-dispatch

Author
https://github.com/Mhakimamransyah
https://www.linkedin.com/in/hakim-amr/
mailto: m.hakim.amransyah.hakim@gmail.com

An Implementation of Microservice Messaging Using RabbitMQ and PHP

M.Hakim Amransyah — Fri, 23 Jun 2023 07:28:15 +0000

There are various methods that can be used to establish communication between systems. In the Enterprise Integration Patterns: Designing, Building, and Deploying Messaging Solutions it is stated that there are 65 ways that the author has successfully documented how between systems can communicate (read: https://www.enterpriseintegrationpatterns.com/patterns/messaging/toc.html) .

This article will contain a simple implementation explanation in building communication between systems (services) using RabbitMQ where each services is created using the PHP programming language.

Case study

Once upon a time, in an company information technology ecosystem, there were 3 services consisting of payment-service, logistics-service and notification-service. These three services are able to communicate with each other in 2 ways, namely using API calls and messaging. Specifically for messaging, these three services use rabbitMQ as a message broker.

In this case study, payment-services acts as a message sender (publisher) to the other two services every time there is a verified payment by carrying payment information made by the user.

The other two services will act as consumers and payment-services as publishers and do not need to know what actions the two services will take.

On the other hand, logistics-services besides only acting as consumers when interacting with payment-services can also send messages to notification-services every time a logistics package has reached a certain checkpoint before being received by the user.

Simply put, it can be concluded that;

payment-service acts as a publisher,
notification-service acts as a consumer and
logistic-service acts as a consumer as well as a publisher.

Technology Stack

Configure RabbitMQ

RabbitMQ will act as a message broker whenever the service needs to interact other than using an Api Call. We'll set up a few things about rabbitmq so that each service and rabbitmq can communicate properly.

Exchanger
The exchanger can be thought of as a message distributor to every available queue. Simply put, each service does not need to have its own "logic" for routing where messages should be sent. Each service simply communicates with this exchanger. Each service will have its own exchanger which will be used as a message distributor.

Queue
Queue is a collection of data that will be consumed directly by the consumer. Incoming data is data distributed by related exchangers. Each service that acts as a consumer must later "listen" to the queue related to the features that exist on it.

The description of the configuration that will be implemented is as follows;

Testing Communication

All source code related to this article can be downloaded in the repository https://github.com/Mhakimamransyah/php-long-connection-messaging .

To test the communication related to the approval-payment scenario, we can hit the approval end-point available in the payment-service.



curl --location 'http://127.0.0.1:8001/api/v1/approval' \
--form 'id="12345"' \
--form 'type="VIRTUAL-ACCOUNT"' \
--form 'price="400000"' \
--form 'approved-by="system"' \
--form 'bank="BCA"'

To see if the payment information has been successfully received by the other two services, we can enter the container of each service and see the response via the logs.

To test communication via logistics-services we can hit end-point packages.



curl --location --request PUT 'http://127.0.0.1:8003/api/v1/packages' \
--form 'tracking-number="12345"' \
--form 'status="delivering"' \
--form 'checkpoint="Palembang"'

Thus my brief sharing for this tutorial. See you on another occasion.

https://github.com/Mhakimamransyah
https://www.linkedin.com/in/hakim-amr/
mailto: m.hakim.amransyah.hakim@gmail.com