presetshare-comments-service

About

The service is written in c++ and uses boost, cassandra-cpp-driver, nlohmann_json, ScyllaDB.

Conan and cmake are used to download packages and build the project.

Documentation

ScyllaDB

KEYSPACE	TABLE
keyspace_comments	comments

column name	-	entity	comment id	author	text	deleted	created_by	created_time	updated_time
data type	-	text	uuid	text	text	boolean	bigint	bigint	bigint

Additional details:

• **REPLICATION = {'class' : 'SimpleStrategy', 'replication_factor' : 3}**

• **CLUSTERING ORDER BY (created_time DESC)**

• **PRIMARY KEY ((entity), created_time, comment_id)**

• Flags in docker-compose:

  • **--seeds=scylla-node1** seed nodes are the initial contact points for a ScyllaDB cluster
  • **--smp 1** number of cpu cores available for ScyllaDB
  • **--memory 750M** maximum amount of memory ScyllaDB should use
  • **--ovrprovisioned 1** indicates that ScyllaDB is running on an overprovisioned machine
  • **--api-adress 0.0.0.0** the Scylla API will listen on all network interfaces available to the container

API

GET {URL}/comments

---

Returns a json list of comments from newest to oldest.

Request:

---

Headers:

Key	Value
Entity	preset-1
Pagination-Page	1
Pagination-Per-Page	30

Pagination-Per-Page boundaries are 1 >= and <= 100, in case if data is given above or below the boundary, will the value be set to 1 or 100, respectively

If Pagenation-Page < 0, it will be set to 1

Body: Empty

Response:

---

Headers:

Key	Value
Pagination-Current-Page	1
Pagination-Per-Page	30
Pagination-Total-Pages	1
Pagination-Total-Comments	3

Body:

[
    {
        "author": "user4",
        "comment_id": "39fc5e75-b6db-4c24-827a-0354caf640d4",
        "created_by": 4,
        "created_time": 1706649049615,
        "entity": "preset-12345",
        "text": "i love it!!!!",
        "updated_time": 1706649049615
    },
    {
        "author": "user23",
        "comment_id": "8f216a3e-2856-4c4f-99e9-2f2b74350e6a",
        "created_by": 20,
        "created_time": 1706649030666,
        "entity": "preset-12345",
        "text": "AWESOME",
        "updated_time": 1706649030666
    },
    {
        "author": "user2",
        "comment_id": "dcf0edf4-ef0f-481f-aab5-2a2af6e421e2",
        "created_by": 1,
        "created_time": 1706649015549,
        "entity": "preset-12345",
        "text": "Best MUSIC",
        "updated_time": 1706649015549
    }
]

POST {URL}/comments/make

---

Adds new comment to the database.

Request:

---

Headers:

Key	Value
Entity	preset-1
Author	Gleb123
Created_by	15

Body:

{
    "text": "New comment!"
}

Response:

---

Headers: Empty

Body: Empty

PATCH {URL}/comments/delete

---

Changes deleted value to true, so that comment will not be sent from GET {URL}/comments.

Request:

---

Headers:

Key	Value
Entity	preset-1
Comment_id	280f0208-b56a-4bb7-bcb1-a2f7988cf647
Created_time	1706531307174

Body: Empty

Response:

---

Headers: Empty

Body: Empty

PATCH {URL}/comments/change

---

Changes text value and updates updated_time to NOW().

Request:

---

Headers:

Key	Value
Entity	preset-1
Comment_id	280f0208-b56a-4bb7-bcb1-a2f7988cf647
Created_time	1706531307174

Body:

{
    "text": "Updated comment!"
}

Response:

---

Headers: Empty

Body: Empty

Usage

First of all you need to install make, docker and docker-compose:

sudo apt update && sudo apt install -y make docker-ce docker-ce-cli containerd.io docker-compose-plugin

Clone the repository:

git clone https://github.com/d33fur/presetshare-comments-service.git && cd presetshare-comments-service

Start all

make all

Wait a bit and

make db-init

Logs

make logs

More commands:

Start

make start

Stop

make stop

Restart

make restart

Clear

make clear

To enter db sqlsh

make db-cqlsh

---

Also i made a Dockerfile if you want to use scylla-cpp-driver(I do not know if the current code is compatible):

FROM ubuntu:18.04 AS build

ENV DEBIAN_FRONTEND=noninteractive
ENV TZ=Europe/Moscow

COPY ./comments-service /comments-service
WORKDIR /comments-service/build

SHELL ["/bin/bash", "-c"]

RUN apt-get update && \
    apt-get install -y \
    software-properties-common \
    python3-pip \
    libuv1 \
    openssl \
    libssl-dev \
    zlib1g \
    wget && \
    wget https://github.com/scylladb/cpp-driver/releases/download/2.15.2-1/scylla-cpp-driver_2.15.2-1_amd64.deb \
    https://github.com/scylladb/cpp-driver/releases/download/2.15.2-1/scylla-cpp-driver-dev_2.15.2-1_amd64.deb && \
    wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null && \
    apt-add-repository 'deb https://apt.kitware.com/ubuntu/ bionic main' && \
    apt-get update && \
    apt-get install -y \
    cmake \
    ./scylla-cpp-driver_2.15.2-1_amd64.deb \
    ./scylla-cpp-driver-dev_2.15.2-1_amd64.deb && \
    pip3 install conan --upgrade && \
    conan profile detect && \
    conan install .. --output-folder=. --build=missing && \ 
    source conanbuild.sh && \
    cmake -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release .. && \
    cmake --build . && \
    source deactivate_conanbuild.sh

FROM ubuntu:18.04

RUN groupadd dev && useradd -g dev dev
USER dev
COPY --chown=dev:dev --from=build /comments-service/build/comments-service /app/comments-service

CMD ["/app/comments-service", "0.0.0.0", "8080"]
EXPOSE 8080