Feature/simple rules

backend/business-partner-agent/pom.xml

@@ -396,7 +396,7 @@
                                 </goals>
                                 <configuration>
                                     <!-- See https://nodejs.org/en/download/ -->
-                                    <nodeVersion>v14.17.0</nodeVersion>
+                                    <nodeVersion>v14.17.1</nodeVersion>
                                     <npmVersion>6.14.13</npmVersion>
                                 </configuration>
                             </execution>

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/controller/AriesWebhookController.java

@@ -31,6 +31,7 @@
 import org.hyperledger.aries.webhook.EventHandler;
 
 import javax.inject.Inject;
+import javax.inject.Named;
 
 /**
  * Handles incoming aca-py webhook events
@@ -46,7 +47,12 @@ public class AriesWebhookController {
     public static final String WEBHOOK_CONTROLLER_PATH = "/log/topic";
 
     @Inject
-    EventHandler handler;
+    @Named("aries")
+    EventHandler ariesEventHandler;
+
+    @Inject
+    @Named("rules")
+    EventHandler rulesEventHandler;
 
     @Post(WEBHOOK_CONTROLLER_PATH + "/{eventType}")
     public void logEvent(
@@ -55,6 +61,7 @@ public void logEvent(
 
         log.info("Webhook received, type: {}", eventType);
 
-        handler.handleEvent(eventType, eventBody);
+        ariesEventHandler.handleEvent(eventType, eventBody);
+        rulesEventHandler.handleEvent(eventType, eventBody); // rules always run after
     }
 }

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/controller/RulesController.java

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2020-2021 - for information on the respective copyright owner
+ * see the NOTICE file and/or the repository at
+ * https://github.com/hyperledger-labs/business-partner-agent
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hyperledger.bpa.controller;
+
+import io.micronaut.http.HttpResponse;
+import io.micronaut.http.annotation.*;
+import io.micronaut.scheduling.TaskExecutors;
+import io.micronaut.scheduling.annotation.ExecuteOn;
+import io.micronaut.security.annotation.Secured;
+import io.micronaut.security.rules.SecurityRule;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.hyperledger.bpa.controller.api.rules.RuleRequest;
+import org.hyperledger.bpa.impl.rules.RulesData;
+import org.hyperledger.bpa.impl.rules.RulesService;
+
+import javax.inject.Inject;
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+
+@Controller("/api/rules")
+@Tag(name = "Rules")
+@Secured(SecurityRule.IS_AUTHENTICATED)
+@ExecuteOn(TaskExecutors.IO)
+public class RulesController {
+
+    @Inject
+    RulesService rules;
+
+    /**
+     * Add new rule with trigger and action
+     * 
+     * @param ruleRequest {@link RuleRequest}
+     * @return {@link RulesData}
+     */
+    @Post
+    public HttpResponse<RulesData> addRule(@Body RuleRequest ruleRequest) {
+        return HttpResponse.ok(rules.add(ruleRequest.getTrigger(), ruleRequest.getAction()));
+    }
+
+    /**
+     * Update rule
+     * 
+     * @param id          {@link UUID} rule id
+     * @param ruleRequest {@link RuleRequest}
+     * @return {@link RulesData}
+     */
+    @Put("/{id}")
+    public HttpResponse<RulesData> updateRule(@PathVariable String id, @Body RuleRequest ruleRequest) {
+        Optional<RulesData> updated = rules.update(
+                UUID.fromString(id), ruleRequest.getTrigger(), ruleRequest.getAction());
+        if (updated.isPresent()) {
+            return HttpResponse.ok(updated.get());
+        }
+        return HttpResponse.notFound();
+    }
+
+    /**
+     * Dele rule by id
+     * 
+     * @param id {@link UUID} rule id
+     * @return {@link HttpResponse}
+     */
+    @Delete("/{id}")
+    public HttpResponse<Void> deleteRule(@PathVariable String id) {
+        rules.delete(UUID.fromString(id));
+        return HttpResponse.ok();
+    }
+
+    /**
+     * List configured rules
+     * 
+     * @return list of {@link RulesData}
+     */
+    @Get
+    public HttpResponse<List<RulesData>> listRules() {
+        return HttpResponse.ok(rules.getAll());
+    }
+
+    /**
+     * Get configured rule by id
+     * 
+     * @param id {@link UUID} rule id
+     * @return {@link RulesData}
+     */
+    @Get("/{id}")
+    public HttpResponse<RulesData> getById(@PathVariable String id) {
+        Optional<RulesData> rule = rules.get(UUID.fromString(id));
+        if (rule.isPresent()) {
+            return HttpResponse.ok(rule.get());
+        }
+        return HttpResponse.notFound();
+    }
+}

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/controller/api/rules/RuleRequest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2020-2021 - for information on the respective copyright owner
+ * see the NOTICE file and/or the repository at
+ * https://github.com/hyperledger-labs/business-partner-agent
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hyperledger.bpa.controller.api.rules;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.hyperledger.bpa.impl.rules.RulesData;
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class RuleRequest {
+    private RulesData.Trigger trigger;
+    private RulesData.Action action;
+}

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/impl/aries/ConnectionManager.java

@@ -253,15 +253,12 @@ private void resolveAndSend(ConnectionRecord record, Partner p) {
         // only incoming connections in state request
         if (ConnectionState.REQUEST.equals(record.getState())) {
             didResolver.lookupIncoming(p);
-            sendConnectionEvent(record, conv.toAPIObject(p));
-        }
-    }
-
-    private void sendConnectionEvent(@NonNull ConnectionRecord record, @NonNull PartnerAPI p) {
-        // TODO both or either?
-        messageService.sendMessage(WebSocketMessageBody.partnerReceived(p));
-        if (isConnectionRequest(record)) {
-            messageService.sendMessage(WebSocketMessageBody.partnerConnectionRequest(p));
+            // TODO both or either?
+            PartnerAPI pApi = conv.toAPIObject(p);
+            messageService.sendMessage(WebSocketMessageBody.partnerReceived(pApi));
+            if (isConnectionRequest(record)) {
+                messageService.sendMessage(WebSocketMessageBody.partnerConnectionRequest(pApi));
+            }
         }
     }
 

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/impl/rules/EventContext.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2020-2021 - for information on the respective copyright owner
+ * see the NOTICE file and/or the repository at
+ * https://github.com/hyperledger-labs/business-partner-agent
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hyperledger.bpa.impl.rules;
+
+import io.micronaut.context.ApplicationContext;
+import lombok.Builder;
+import lombok.Data;
+import org.hyperledger.aries.api.connection.ConnectionRecord;
+import org.hyperledger.aries.api.present_proof.PresentationExchangeRecord;
+import org.hyperledger.bpa.model.Partner;
+
+@Data
+@Builder
+public class EventContext {
+    private Partner partner;
+    private PresentationExchangeRecord presEx;
+    private ConnectionRecord connRec;
+    private ApplicationContext ctx;
+}

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/impl/rules/RulesData.java

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2020-2021 - for information on the respective copyright owner
+ * see the NOTICE file and/or the repository at
+ * https://github.com/hyperledger-labs/business-partner-agent
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.hyperledger.bpa.impl.rules;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import lombok.*;
+import lombok.extern.slf4j.Slf4j;
+import org.hyperledger.aries.api.connection.ConnectionRecord;
+import org.hyperledger.aries.api.connection.ConnectionState;
+import org.hyperledger.aries.api.connection.ConnectionTheirRole;
+import org.hyperledger.bpa.model.ActiveRules;
+
+import java.util.UUID;
+
+@Slf4j
+@Data
+@Builder
+public class RulesData {
+
+    private UUID ruleId;
+    private Trigger trigger;
+    private Action action;
+
+    @JsonTypeInfo(
+            use = JsonTypeInfo.Id.NAME,
+            property = "type")
+    @JsonSubTypes({
+            @JsonSubTypes.Type(value = Trigger.ConnectionTrigger.class, name = Trigger.CONNECTION_TRIGGER_NAME),
+            @JsonSubTypes.Type(value = Trigger.ProofReceivedTrigger.class, name = Trigger.PROOF_RECEIVED_TRIGGER_NAME)
+    })
+    @NoArgsConstructor
+    public abstract static class Trigger {
+
+        public static final String CONNECTION_TRIGGER_NAME = "connection";
+        public static final String PROOF_RECEIVED_TRIGGER_NAME = "proof_received";
+
+        abstract boolean apply(EventContext ctx);
+
+        @SuppressWarnings("unused")
+        private String type;
+
+        @JsonTypeName(Trigger.CONNECTION_TRIGGER_NAME)
+        @Builder
+        @Data
+        @EqualsAndHashCode(callSuper = true)
+        @NoArgsConstructor
+        @AllArgsConstructor
+        public static class ConnectionTrigger extends Trigger {
+            private ConnectionTheirRole role;
+            private String tag;
+            private String goalCode;
+
+            @Override
+            public boolean apply(EventContext ctx) {
+                ConnectionRecord connRec = ctx.getConnRec();
+                boolean apply = connRec != null && ConnectionState.REQUEST.equals(connRec.getState());
+                if (role != null) {
+                    apply = apply && role.equals(connRec.getTheirRole());
+                }
+                return apply;
+            }
+        }
+
+        @JsonTypeName(Trigger.PROOF_RECEIVED_TRIGGER_NAME)
+        @Builder
+        @Data
+        @EqualsAndHashCode(callSuper = true)
+        @NoArgsConstructor
+        @AllArgsConstructor
+        public static class ProofReceivedTrigger extends Trigger {
+            private String tag;
+            private UUID proofTemplateId;
+
+            @Override
+            public boolean apply(EventContext ctx) {
+                return false;
+            }
+        }
+    }
+
+    @JsonTypeInfo(
+            use = JsonTypeInfo.Id.NAME,
+            property = "type")
+    @JsonSubTypes({
+            @JsonSubTypes.Type(value = Action.TagConnection.class, name = Action.TAG_CONNECTION_ACTION_NAME),
+            @JsonSubTypes.Type(value = Action.SendProofRequest.class, name = Action.SEND_PROOF_REQUEST_ACTION_NAME)
+    })
+    @NoArgsConstructor
+    public abstract static class Action {
+
+        public static final String TAG_CONNECTION_ACTION_NAME = "tag_connection";
+        public static final String SEND_PROOF_REQUEST_ACTION_NAME = "send_proof_request";
+
+        abstract void run(EventContext ctx);
+
+        @SuppressWarnings("unused")
+        private String type;
+
+        @JsonTypeName(Action.TAG_CONNECTION_ACTION_NAME)
+        @Builder
+        @Data
+        @EqualsAndHashCode(callSuper = true)
+        @NoArgsConstructor
+        @AllArgsConstructor
+        public static class TagConnection extends Action {
+            private String connectionId;
+            private String tag;
+
+            @Override
+            void run(EventContext ctx) {
+                log.debug("tag: {}", tag);
+            }
+        }
+
+        @JsonTypeName(Action.SEND_PROOF_REQUEST_ACTION_NAME)
+        @Builder
+        @Data
+        @EqualsAndHashCode(callSuper = true)
+        @NoArgsConstructor
+        @AllArgsConstructor
+        public static class SendProofRequest extends Action {
+            private String connectionId;
+            private UUID proofTemplateId;
+
+            @Override
+            void run(EventContext ctx) {
+
+            }
+        }
+    }
+
+    public static RulesData fromActive(@NonNull ActiveRules ar) {
+        return RulesData.builder()
+                .ruleId(ar.getId())
+                .trigger(ar.getTrigger())
+                .action(ar.getAction())
+                .build();
+    }
+}