Ban

Cargo.toml

@@ -46,17 +46,19 @@ sqlx = { version = "0.6", features = [
     "bigdecimal",
     "runtime-tokio-native-tls",
 ] }
-svc-agent = { version = "0.20", features = ["sqlx"] }
+svc-agent = { version = "0.21", features = ["sqlx"] }
 svc-authn = { version = "0.8", features = ["jose", "sqlx"] }
 svc-authz = "0.12"
-svc-error = { version = "0.5", features = [
+svc-error = { version = "0.6", features = [
     "svc-agent",
     "svc-authn",
     "svc-authz",
     "sentry-extension",
     "sqlx",
 ] }
-svc-utils = { version = "0.7", features = ["log-middleware", "metrics-middleware", "cors-middleware", "authn-extractor"] }
+svc-events = "0.11"
+svc-nats-client = "0.8"
+svc-utils = { version = "0.8", features = ["log-middleware", "metrics-middleware", "cors-middleware", "authn-extractor"] }
 tokio = { version = "1.28", features = ["full"] }
 tower = { version = "0.4", features = [ "timeout" ] }
 tracing = "0.1"

chart/templates/app-cm.yaml

@@ -89,6 +89,26 @@ data:
     {{- end }}
     {{- end }}
 
+    {{- with .Values.nats }}
+    {{- println "" }}
+    [nats]
+    url = {{ .url | quote }}
+    creds = {{ .creds | quote }}
+    subscribe_durable.stream = {{ .subscribe_durable.stream | quote }}
+    subscribe_durable.consumer = {{ .subscribe_durable.consumer | quote }}
+    subscribe_durable.batch = {{ .subscribe_durable.batch }}
+    subscribe_durable.idle_heartbeat = {{ .subscribe_durable.idle_heartbeat | quote }}
+    {{- end }}
+
+    {{- with .Values.nats_consumer }}
+    {{- println "" }}
+    [nats_consumer]
+    suspend_interval = {{ .suspend_interval | quote }}
+    max_suspend_interval = {{ .max_suspend_interval | quote }}
+    suspend_sentry_interval = {{ .suspend_sentry_interval | quote }}
+    resubscribe_interval = {{ .resubscribe_interval | quote }}
+    {{- end }}
+
     [storage]
     {{- if .Values.app.storage }}
     base_url = {{ .Values.app.storage.url | quote }}

chart/values.yaml

@@ -44,6 +44,9 @@ clusterService:
     http: 8080
     metrics: 8888
 
+nats: {}
+nats_consumer: {}
+
 tls:
   secretName: tls-certificates
 

docs/src/SUMMARY.md

@@ -16,3 +16,4 @@
         - [API](minigroups/api.md)
     - [Classes API](classes/api.md)
     - [Transcoding utils](utils/transcoding.md)
+    - [Ban](utils/ban.md)

docs/src/utils/ban.md

@@ -0,0 +1,42 @@
+# API
+
+All routes expect json payloads.
+
+1. Get last ban operation id.
+2. Send it in POST request along with other data.
+If there's an error, return to 1.
+
+### Routes
+Route                           | Method | Short description
+------------------------------- | ------ | ----------
+/api/v1/account/:account_id/ban | POST   | [Bans](#ban) media stream and collaboration for user
+/api/v1/account/:account_id/ban | GET    | [Gets](#get-last-ban-operation) last ban operation id for user
+
+### Ban
+
+Path variable          | Type        | Optional | Description
+---------------------- | ----------- | -------- | --------------
+account_id             | string      |          | Account id we want to ban
+
+JSON payload is required with following attributes:
+
+Attribute              | Type        | Optional | Description
+---------------------- | ----------- | -------- | --------------
+last_seen_op_id        | integer     |          | Last seen operation id which can be found by [GET request](#get-last-ban-operation)
+ban                    | bool        |          | Ban/unban
+class_id               | uuid        |          | User should be banned in this particular classroom 
+
+Response: status 200 and empty payload or json object with an error description.
+
+### Get last ban operation
+
+Path variable          | Type        | Optional | Description
+---------------------- | ----------- | -------- | --------------
+account_id             | string      |          | Account id we want to ban
+
+No JSON payload is expected.
+
+Response: status 200 and following payload or json object with an error description.
+
+Attribute       | Type    | Optional | Description
+last_seen_op_id | integer |          | Last seen operation id which can be used later in POST request

migrations/20230517104549_add_ban_account_op_table.sql

@@ -0,0 +1,8 @@
+CREATE TABLE IF NOT EXISTS ban_account_op (
+    user_account account_id PRIMARY KEY,
+    last_op_id bigint NOT NULL,
+    is_video_streaming_banned boolean NOT NULL DEFAULT false,
+    is_collaboration_banned boolean NOT NULL DEFAULT false
+);
+
+CREATE SEQUENCE IF NOT EXISTS ban_entity_seq_id;

migrations/20230714081909_add_ban_history.sql

@@ -0,0 +1,11 @@
+CREATE TABLE IF NOT EXISTS ban_history (
+    target_account account_id NOT NULL,
+    class_id uuid NOT NULL,
+    banned_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
+    banned_operation_id BIGINT NOT NULL,
+    unbanned_at TIMESTAMPTZ,
+    unbanned_operation_id BIGINT,
+
+    FOREIGN KEY (class_id) REFERENCES class (id) ON DELETE CASCADE,
+    PRIMARY KEY (banned_operation_id)
+);