fadhilmuh/bambangshop-receiver

BambangShop Receiver App

Tutorial and Example for Advanced Programming 2024 - Faculty of Computer Science, Universitas Indonesia

---

About this Project

In this repository, we have provided you a REST (REpresentational State Transfer) API project using Rocket web framework.

This project consists of four modules:

1. controller: this module contains handler functions used to receive request and send responses. In Model-View-Controller (MVC) pattern, this is the Controller part.
2. model: this module contains structs that serve as data containers. In MVC pattern, this is the Model part.
3. service: this module contains structs with business logic methods. In MVC pattern, this is also the Model part.
4. repository: this module contains structs that serve as databases. You can use methods of the struct to get list of objects, or operating an object (create, read, update, delete).

This repository provides a Rocket web framework skeleton that you can work with.

As this is an Observer Design Pattern tutorial repository, you need to implement a feature: Notification. This feature will receive notifications of creation, promotion, and deletion of a product, when this receiver instance is subscribed to a certain product type. The notification will be sent using HTTP POST request, so you need to make the receiver endpoint in this project.

API Documentations

You can download the Postman Collection JSON here: https://ristek.link/AdvProgWeek7Postman

After you download the Postman Collection, you can try the endpoints inside "BambangShop Receiver" folder.

Postman is an installable client that you can use to test web endpoints using HTTP request. You can also make automated functional testing scripts for REST API projects using this client. You can install Postman via this website: https://www.postman.com/downloads/

How to Run in Development Environment

1. Set up environment variables first by creating .env file. Here is the example of .env file:

   ROCKET_PORT=8001
   APP_INSTANCE_ROOT_URL=http://localhost:${ROCKET_PORT}
   APP_PUBLISHER_ROOT_URL=http://localhost:8000
   APP_INSTANCE_NAME=Safira Sudrajat

   Here are the details of each environment variable:

   variable	type	description
   ROCKET_PORT	string	Port number that will be listened by this receiver instance.
   APP_INSTANCE_ROOT_URL	string	URL address where this receiver instance can be accessed.
   APP_PUUBLISHER_ROOT_URL	string	URL address where the publisher instance can be accessed.
   APP_INSTANCE_NAME	string	Name of this receiver instance, will be shown on notifications.

2. Use cargo run to run this app. (You might want to use cargo check if you only need to verify your work without running the app.)

3. To simulate multiple instances of BambangShop Receiver (as the tutorial mandates you to do so), you can open new terminal, then edit ROCKET_PORT in .env file, then execute another cargo run.

   For example, if you want to run 3 (three) instances of BambangShop Receiver at port 8001, 8002, and 8003, you can do these steps:

   • Edit ROCKET_PORT in .env to 8001, then execute cargo run.
   • Open new terminal, edit ROCKET_PORT in .env to 8002, then execute cargo run.
   • Open another new terminal, edit ROCKET_PORT in .env to 8003, then execute cargo run.

Mandatory Checklists (Subscriber)

• Clone https://gitlab.com/ichlaffterlalu/bambangshop-receiver to a new repository.
• STAGE 1: Implement models and repositories
  • Commit: Create Notification model struct.
  • Commit: Create SubscriberRequest model struct.
  • Commit: Create Notification database and Notification repository struct skeleton.
  • Commit: Implement add function in Notification repository.
  • Commit: Implement list_all_as_string function in Notification repository.
  • Write answers of your learning module's "Reflection Subscriber-1" questions in this README.
• STAGE 3: Implement services and controllers
  • Commit: Create Notification service struct skeleton.
  • Commit: Implement subscribe function in Notification service.
  • Commit: Implement subscribe function in Notification controller.
  • Commit: Implement unsubscribe function in Notification service.
  • Commit: Implement unsubscribe function in Notification controller.
  • Commit: Implement receive_notification function in Notification service.
  • Commit: Implement receive function in Notification controller.
  • Commit: Implement list_messages function in Notification service.
  • Commit: Implement list function in Notification controller.
  • Write answers of your learning module's "Reflection Subscriber-2" questions in this README.

Your Reflections

This is the place for you to write reflections:

Mandatory (Subscriber) Reflections

Reflection Subscriber-1

1. Penggunaan RwLock<> untuk mensinkronisasi penggunaan Vec dari Notifikasi diperlukan dalam kasus ini karena memungkinkan akses bersama untuk pembaca (readers) dan eksklusif untuk penulis (writer). Dalam konteks notifikasi, banyak subscriber mungkin akan membaca data notifikasi secara bersamaan, sementara proses penulisan (seperti menambah atau menghapus notifikasi) harus dilakukan secara eksklusif untuk menghindari kondisi race dan konsistensi data. RwLock<> memungkinkan banyak pembaca untuk mengakses data secara bersamaan tanpa blok, sementara hanya satu penulis yang dapat mengakses data pada satu waktu.

   Kita tidak menggunakan Mutex<> karena Mutex<> hanya memungkinkan satu thread untuk memiliki akses eksklusif pada suatu waktu. Dalam kasus notifikasi di mana banyak pembaca mungkin akan mengakses data secara bersamaan, menggunakan Mutex<> dapat mengakibatkan performa yang buruk karena pembaca harus secara bergantian bersaing untuk mendapatkan akses eksklusif. RwLock<> lebih cocok karena memungkinkan pembaca untuk mengakses data secara bersamaan tanpa memblokir satu sama lain, sementara proses penulisan tetap eksklusif.

2. Penggunaan lazy_static eksternal library untuk mendefinisikan Vec dan DashMap sebagai variabel "static" dibutuhkan karena Rust memiliki aturan yang ketat terkait dengan penyimpanan variabel statis. Dalam Rust, variabel statis defaultnya tidak dapat diubah, dan mengizinkan mutasi langsung dari variabel statis bisa memunculkan masalah keamanan dan thread safety. Oleh karena itu, Rust memerlukan pendekatan yang lebih hati-hati dalam penggunaan variabel statis, dan menggunakan lazy_static memungkinkan kita untuk menginisialisasi variabel statis dengan cara yang aman dan dapat diprediksi pada waktu runtime. Hal ini membantu menjaga keamanan dan integritas data dalam aplikasi Rust.

Reflection Subscriber-2

1. Saya telah melakukan eksplorasi ke beberapa bagian di luar tahap-tahap yang dijelaskan dalam tutorial, termasuk src/lib.rs. Dari pemeriksaan tersebut, saya memahami bahwa lib.rs berperan sebagai modul utama yang menyediakan informasi penting yang digunakan oleh bagian-bagian lain dari aplikasi. Ini termasuk penanganan kesalahan, definisi root URL, dan pembuatan singleton untuk konfigurasi aplikasi.

2. Ya, dengan menerapkan pola Observer, menambahkan lebih banyak subscriber menjadi lebih mudah karena program telah dirancang dengan prinsip open-close. Ini berarti kita dapat menambahkan fungsionalitas baru tanpa harus mengubah kode yang sudah ada. Ketika menginstansiasi lebih dari satu Main App, ini masih memungkinkan karena mendaftarkan subscriber ke aplikasi yang berbeda dapat dilakukan dengan mengakses API yang sesuai.

   Penggunaan Observer pattern mempermudah penambahan lebih banyak subscriber ke sistem karena subscriber dapat ditambahkan atau dihapus dengan relatif mudah tanpa memengaruhi komponen lain dalam sistem. Hal ini karena setiap subscriber terisolasi dari yang lain dan tidak bergantung pada detail implementasi internal dari sistem. Dengan menggunakan pattern Observer, kita dapat dengan fleksibel menyambungkan dan memutuskan hubungan antara publisher dan subscriber tanpa mengubah struktur fundamental dari aplikasi.

3. Saya telah mencoba membuat pengujian sendiri dan meningkatkan dokumentasi dalam koleksi Postman saya. Fitur ini sangat berguna untuk pekerjaan saya karena memungkinkan saya untuk menguji fungsionalitas API yang saya kembangkan dan memastikan bahwa semua kasus penggunaan tercakup dengan baik. Selain itu, meningkatkan dokumentasi Postman membantu saya dalam memahami dengan lebih baik bagaimana menggunakan API yang telah kami buat dan memudahkan proses integrasi dengan aplikasi lainnya.