Merge branch '19-kafka-websocket-user-driven-gateway' into kafka-streams-module

Author: mjbmarques

README.md

@@ -1 +1,44 @@
-"# kafka-web-gateway" 
+# kafka-web-gateway
+
+**Enter project directory**
+
+```
+cd ./code/kafka-web-gateway/
+```
+
+**Generate uberJar with gradle task extractUberJar**
+
+```
+./gradlew task extractUberJar
+```
+
+**Start docker containers**
+
+* PostgreSQL Database
+* 2 Gateway's
+* 3 Apache Kafka Servers/Nodes
+* 3 ZooKeeper's Servers
+* Nginx
+
+```
+./gradlew task composeUp
+```
+
+* If preferred, use docker compose
+
+```
+docker compose up --build --force-recreate
+```
+
+**Utils**
+
+* Start shell on postgres container
+
+```
+docker exec -ti db-g06-tests bash
+```
+
+* Start `psql` inside postgres container
+
+```
+psql -U gateway_user -d gateway_db

code/kafka-web-gateway/.gitignore

@@ -0,0 +1,37 @@
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/

code/kafka-web-gateway/build.gradle

@@ -0,0 +1,65 @@
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    id("org.springframework.boot") version "2.7.12"
+    id("io.spring.dependency-management") version "1.1.0"
+    kotlin("jvm") version "1.7.22"
+    kotlin("plugin.spring") version "1.7.22"
+}
+
+group = "com.isel.ps"
+version = "0.0.1-SNAPSHOT"
+java.sourceCompatibility = JavaVersion.VERSION_17
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("org.springframework.boot:spring-boot-starter-websocket")
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
+    implementation("org.jetbrains.kotlin:kotlin-reflect")
+    implementation("org.springframework.kafka:spring-kafka")
+    implementation("org.springframework.security:spring-security-core")
+
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+    implementation("org.springframework.boot:spring-boot-starter-jdbc")
+    annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
+    runtimeOnly("org.postgresql:postgresql")
+
+    implementation("org.springdoc:springdoc-openapi-ui:1.6.15")
+    runtimeOnly("org.springdoc:springdoc-openapi-kotlin:1.6.15")
+
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.springframework.kafka:spring-kafka-test")
+}
+
+tasks.withType<KotlinCompile> {
+    kotlinOptions {
+        freeCompilerArgs = listOf("-Xjsr305=strict")
+        jvmTarget = "17"
+    }
+}
+
+tasks.withType<Test> {
+    enabled = false
+    useJUnitPlatform()
+}
+
+task<Copy>("extractUberJar") {
+    dependsOn("assemble")
+    // opens the JAR containing everything...
+    from(zipTree("$buildDir/libs/${rootProject.name}-$version.jar"))
+    // ... into the 'build/dependency' folder
+    into("build/dependency")
+}
+
+task<Exec>("composeUp") {
+    commandLine("docker-compose", "up", "--build", "--force-recreate")
+    dependsOn("extractUberJar")
+}
+
+tasks.named("build") {
+    dependsOn("assemble", "extractUberJar")
+}

code/kafka-web-gateway/build.gradle.kts

@@ -0,0 +1,96 @@
+create table if not exists client
+(
+    client_id bigint primary key
+);
+
+create table if not exists gateway
+(
+    gateway_id     bigint primary key,
+    topic_clients  varchar(255) not null,
+    topic_commands varchar(255) not null,
+    active         boolean      not null,
+    updated_at     timestamp    not null
+);
+
+create table if not exists session
+(
+    session_id bigint primary key,
+    client_id  bigint references client (client_id) on delete cascade on update cascade,
+    gateway_id bigint references gateway (gateway_id) on delete cascade on update cascade,
+    created_at timestamp default now(),
+    updated_at timestamp not null,
+    active     boolean   not null
+);
+
+create table if not exists subscription
+(
+    subscription_id int generated always as identity primary key,
+    session_id      bigint       not null references session (session_id) on delete cascade on update cascade,
+    topic           varchar(255) not null,
+    key             varchar(255),
+    unique (session_id, topic, key)
+);
+
+create table if not exists role
+(
+    role_id     int generated always as identity primary key,
+    name        varchar(36) unique not null,
+    description varchar(255)
+);
+
+create table if not exists client_role
+(
+    client_id bigint references client (client_id) on delete cascade on update cascade,
+    role_id   int references role (role_id) on delete cascade on update cascade,
+    primary key (client_id, role_id)
+);
+
+create table if not exists permission
+(
+    permission_id int generated always as identity primary key,
+    topic         varchar(255) not null,
+    key           varchar(255),
+    read          boolean      NOT NULL,
+    write         boolean      NOT NULL,
+    unique (topic, key, read, write)
+);
+
+create table if not exists role_permission
+(
+    role_id       int references role (role_id) on delete cascade on update cascade,
+    permission_id int references permission (permission_id) on delete cascade on update cascade,
+    primary key (role_id, permission_id)
+);
+
+create table if not exists client_permission
+(
+    client_id     bigint references client (client_id) on delete cascade on update cascade,
+    permission_id int references permission (permission_id) on delete cascade on update cascade,
+    primary key (client_id, permission_id)
+);
+
+create table if not exists admin
+(
+    admin_id       int generated always as identity primary key,
+    name           varchar(64) not null,
+    description    varchar(255),
+    owner          boolean     not null,
+    administrative boolean     not null,
+    permission     boolean     not null
+);
+
+create table if not exists admin_token
+(
+    token_validation varchar(255) primary key,
+    admin_id         int       not null references admin (admin_id) on delete cascade on update cascade,
+    created_at       timestamp not null default now(),
+    last_used_at     timestamp not null
+);
+
+create table if not exists setting
+(
+    name        varchar(64) primary key,
+    value       varchar(255) not null,
+    description varchar(255),
+    updated_at  timestamp    not null
+);

code/kafka-web-gateway/db/create_table.sql

@@ -0,0 +1,12 @@
+delete from client_permission;
+delete from client_role;
+delete from role_permission;
+delete from role;
+delete from subscription;
+delete from session;
+delete from gateway;
+delete from admin_token;
+delete from setting;
+delete from admin;
+delete from client;
+delete from permission;

code/kafka-web-gateway/db/delete_data.sql

@@ -0,0 +1,12 @@
+drop table if exists client_permission;
+drop table if exists client_role;
+drop table if exists role_permission;
+drop table if exists role;
+drop table if exists subscription;
+drop table if exists session;
+drop table if exists gateway;
+drop table if exists admin_token;
+drop table if exists setting;
+drop table if exists admin;
+drop table if exists client;
+drop table if exists permission;

code/kafka-web-gateway/db/drop_table.sql

@@ -0,0 +1,35 @@
+INSERT INTO client (client_id)
+VALUES (1);
+
+INSERT INTO gateway (gateway_id, topic_clients, topic_commands, active, updated_at)
+VALUES (1, 'topic1', 'command1', true, current_timestamp);
+
+INSERT INTO session (session_id, client_id, gateway_id, updated_at, active)
+VALUES (1, 1, 1, current_timestamp, true);
+
+INSERT INTO subscription (session_id, topic, key)
+VALUES (1, 'topic1', 'key1');
+
+INSERT INTO role (name, description)
+VALUES ('role1', 'Role 1 Description');
+
+INSERT INTO client_role (client_id, role_id)
+VALUES (1, 1);
+
+INSERT INTO permission (topic, key, read, write)
+VALUES ('topic1', 'key1', true, true);
+
+INSERT INTO role_permission (role_id, permission_id)
+VALUES (1, 1);
+
+INSERT INTO client_permission (client_id, permission_id)
+VALUES (1, 1);
+
+INSERT INTO admin (name, description, owner, administrative, permission)
+VALUES ('admin1', 'Admin 1 Description', true, true, true);
+
+INSERT INTO admin_token (token_validation, admin_id, created_at, last_used_at)
+VALUES ('token1', 1, current_timestamp, current_timestamp);
+
+INSERT INTO setting (name, value, description, updated_at)
+VALUES ('setting1', 'value1', 'Setting 1 Description', current_timestamp);