changes for Jitpack and readme

StyraInc · Aug 8, 2024 · 802bd92 · 802bd92
1 parent 4ca2ab9
commit 802bd92
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 23 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,12 +1,43 @@
-# Open Policy Agent WebAssemby Java Module
+[![CI](https://github.com/andreaTP/opa-chicory/workflows/CI/badge.svg)](https://github.com/andreaTP/opa-chicory)
+[![](https://jitpack.io/v/andreaTP/opa-chicory.svg)](https://jitpack.io/#andreaTP/opa-chicory)
 
-TODO: take inspiration by this: https://github.com/me-viper/OpaDotNet the docs are pretty cool!
+# Open Policy Agent WebAssemby Java SDK (experimental)
+
+This is SDK for using WebAssembly (wasm) compiled [Open Policy Agent](https://www.openpolicyagent.org/) policies
+with [Chicory](https://github.com/dylibso/chicory), a pure Java Wasm interpreter.
+
+Initial implementation was based
+on [Open Policy Agent WebAssemby NPM Module](https://github.com/open-policy-agent/npm-opa-wasm)
+and [Open Policy Agent Ebassembly dotnet core SDK](https://github.com/me-viper/OpaDotNet)
+
+## Why
+
+We want fast in-process OPA policies evaluations, and avoid network bottlenecks when using [opa-java](https://github.com/StyraInc/opa-java).
 
 # Getting Started
 
 ## Install the module
 
-TODO: Jitpack release
+With Maven:
+
+```
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+```
+
+and:
+
+```
+<dependency>
+    <groupId>com.github.andreaTP.opa-chicory</groupId>
+    <artifactId>opa-chicory</artifactId>
+    <version>main-SNAPSHOT</version>
+</dependency>
+```
 
 ## Usage
 

diff --git a/core/src/main/java/com/github/andreaTP/opa/chicory/Opa.java b/core/src/main/java/com/github/andreaTP/opa/chicory/Opa.java
@@ -77,15 +77,15 @@ public OpaPolicy entrypoint(String entrypoint) {
             return this;
         }
 
-        public int loadJson(String data) {
+        private int loadJson(String data) {
             var dataStrAddr = wasm.opaMalloc(data.length());
             wasm.memory().writeCString(dataStrAddr, data);
             var dstAddr = wasm.opaJsonParse(dataStrAddr, data.length());
             wasm.opaFree(dataStrAddr);
             return dstAddr;
         }
 
-        public String dumpJson(int addr) {
+        private String dumpJson(int addr) {
             int resultStrAddr = wasm.opaJsonDump(addr);
             var result = wasm.memory().readCString(resultStrAddr);
             wasm.opaFree(resultStrAddr);

diff --git a/core/src/main/java/com/github/andreaTP/opa/chicory/OpaWasm.java b/core/src/main/java/com/github/andreaTP/opa/chicory/OpaWasm.java
@@ -352,7 +352,7 @@ public void opaEval(
                         Value.i32(format));
     }
 
-    // helper functions
+    // helper functions - can be written by the end user
     public String readString(int addr) {
         int resultAddr = opaJsonDump(addr);
         var resultStr = memory().readCString(resultAddr);

diff --git a/pom.xml b/pom.xml
@@ -97,23 +97,6 @@
           </systemPropertyVariables>
         </configuration>
       </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>${maven-javadoc-plugin.version}</version>
-        <configuration>
-          <doclint>none</doclint>
-          <source>1.8</source>
-        </configuration>
-        <executions>
-          <execution>
-            <id>attach-javadocs</id>
-            <goals>
-              <goal>jar</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-source-plugin</artifactId>