Merge pull request #3 from LemmyNet/rust-allowed-voters

Add Rust example

Author: Nutomic

.gitignore

@@ -3,13 +3,18 @@
 .vscode
 
 # tests
-**/node_modules
-plugins/typescript_push_webhook/dist
+node_modules
 tests/.yalc
 tests/yalc.lock
 tests/pict-rs
 tests/log
 
+# plugins
+plugins/rust_allowed_voters/target
+plugins/rust_allowed_voters/Cargo.lock
+plugins/typescript_push_webhook/dist
+plugins/typescript_push_webhook/node_modules
+
 # lemmy plugins
 *.wasm
 

.woodpecker.yml

@@ -6,6 +6,16 @@ steps:
     when:
       - event: pull_request
 
+  build_rust_plugin:
+    image: rust:1.81
+    commands:
+      - rustup target add wasm32-unknown-unknown
+      - cd plugins/rust_allowed_voters
+      - cargo build
+      - cp target/wasm32-unknown-unknown/debug/rust_allowed_voters.wasm ..
+    when:
+      - event: [pull_request, tag]
+
   build_typescript_plugin:
     # need to use ubuntu instead of debian because extism-js requires newer glibc version
     # https://github.com/extism/js-pdk/issues/129
@@ -60,6 +70,7 @@ steps:
     image: woodpeckerci/plugin-release
     settings:
       files:
+        - plugins/rust_allowed_voters.wasm
         - plugins/go_replace_words.wasm
         - plugins/typescript_push_webhook.wasm
       title: ${CI_COMMIT_TAG##v}

README.md

@@ -29,6 +29,19 @@ npm install
 npm run build
 ```
 
+## Rust: Allowed Voters
+
+Listens to `new_vote` hook, then calls `/api/v4/person` to get details about the voter. It only allows downvotes if the user has made at least 5 posts before. See [rust-pdk readme](https://github.com/extism/rust-pdk?tab=readme-ov-file) for setup and detailed documentation.
+
+Use the following steps to compile it:
+
+```bash
+apt install cargo
+cd plugins/rust_allowed_voters
+cargo build
+cp target/wasm32-unknown-unknown/debug/rust_allowed_voters.wasm ..
+```
+
 ## Tests
 
-This repository contains test cases for the plugins. To run them install `pnpm` and `postgresql`, with a database `postgres://lemmy:password@localhost:5432/lemmy`. Then go into `tests` folder and execute `./run.sh`.
+This repository contains test cases for the plugins. To run them install `pnpm` and `postgresql`, with a database `postgres://lemmy:password@localhost:5432/lemmy`. Then compile all the plugins as described above, go into `tests` folder and execute `./run.sh`.

lemmy_server

@@ -0,0 +1,8 @@
+{
+  "wasm": [
+    {
+      "path": "plugins/rust_allowed_voters.wasm"
+    }
+  ],
+  "allowed_hosts": ["0.0.0.0"]
+}

plugins/rust_allowed_voters.json

@@ -0,0 +1,2 @@
+[build]
+target = "wasm32-unknown-unknown"

plugins/rust_allowed_voters/.cargo/config.toml

@@ -0,0 +1,2 @@
+/target
+Cargo.lock

plugins/rust_allowed_voters/.gitignore

@@ -0,0 +1,12 @@
+[package]
+name = "rust_allowed_voters"
+version = "0.1.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+extism-pdk = "1.3.0"
+serde = { version = "1", features = ["derive"] }
+lemmy_api_common = { git = "https://github.com/LemmyNet/lemmy.git" }

plugins/rust_allowed_voters/Cargo.toml

@@ -0,0 +1,43 @@
+use crate::json::Value;
+use extism_pdk::*;
+use lemmy_api_common::person::GetPersonDetailsResponse;
+use serde::Serialize;
+use std::collections::HashMap;
+
+#[derive(Serialize)]
+struct Metadata {
+    name: String,
+    url: String,
+    description: String,
+}
+
+// Returns info about the plugin which gets included in /api/v4/site
+//go:wasmexport metadata
+#[plugin_fn]
+pub fn metadata() -> FnResult<Json<Metadata>> {
+    Ok(Json(Metadata {
+        name: "Test Plugin".to_string(),
+        url: "https://example.com".to_string(),
+        description: "Plugin to test Lemmy feature".to_string(),
+    }))
+}
+
+#[plugin_fn]
+pub fn post_vote(
+    Json(vote): Json<HashMap<String, Value>>,
+) -> FnResult<Json<HashMap<String, Value>>> {
+    let lemmy_url = config::get("lemmy_url")?.unwrap();
+    let person_id = vote.get("person_id").unwrap();
+    let req = HttpRequest {
+        url: format!("{lemmy_url}api/v4/person?person_id={person_id}"),
+        headers: Default::default(),
+        method: Some("GET".to_string()),
+    };
+    let res: GetPersonDetailsResponse = http::request::<()>(&req, None)?.json()?;
+    let person_post_count = res.person_view.person.post_count;
+    let vote_score = vote.get("like_score").and_then(Value::as_i64).unwrap();
+    if person_post_count < 5 && vote_score == -1 {
+        return Err(Error::msg("user is not allowed to downvote").into());
+    }
+    Ok(Json(vote))
+}

plugins/rust_allowed_voters/src/lib.rs

@@ -10,7 +10,7 @@
   "scripts": {
     "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check 'src/**/*.ts'",
     "fix": "prettier --write src && eslint --fix src",
-    "test": "jest -i typescript.spec.ts && jest -i golang.spec.ts"
+    "test": "jest -i rust.spec.ts && jest -i golang.spec.ts && jest -i typescript.spec.ts"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",