feat: Use eyeling for reasoning

This removes the need for eye reasoner to be installed

Author: joachimvh

.github/workflows/test.yml

@@ -29,17 +29,6 @@ jobs:
 
     steps:
 
-      - name: Install prolog
-        uses: logtalk-actions/setup-swi-prolog@master
-
-      - name: Clone EYE repo
-        uses: actions/checkout@v4
-        with:
-          repository: eyereasoner/eye
-
-      - name: Build EYE
-        run: bash install.sh --prefix=$HOME/.local # This folder is available on $PATH already
-
       - name: Checkout main branch
         uses: actions/checkout@v4
 

Dockerfile

@@ -1,13 +1,6 @@
 FROM node:22
 ENV NODE_ENV=production
 
-# Install EYE reasoner
-RUN apt-get update  \
- && apt-get install swi-prolog -y \
- && git clone https://github.com/eyereasoner/eye.git \
- && /eye/install.sh --prefix=/usr/local \
- && rm -r /eye
-
 WORKDIR /usr/src/app
 COPY . .
 

README.md

@@ -15,8 +15,7 @@ This repository contains SolidLab research artefacts on use of UMA in the Solid
 
 In order to run this project you need to perform the following steps.
 
-1. Install the [eye reasoner](https://github.com/eyereasoner/eye/) and have `eye` available on your path.
-2. Ensure that you are using Node.js 20 or higher, e.g. by running `nvm use`. (see [.nvmrc](./.nvmrc))
+1. Ensure that you are using Node.js 20 or higher, e.g. by running `nvm use`. (see [.nvmrc](./.nvmrc))
 2. Enable Node.js Corepack with `corepack enable`.
 3. Run `yarn install` in the project root (this will automatically call `yarn build`).
 4. Run `yarn start`.

packages/uma/bin/demo.js

@@ -17,7 +17,6 @@ const launch = async () => {
 
   // variables['urn:uma:variables:policyDir'] = path.join(rootDir, './config/rules/policy');
   variables['urn:uma:variables:policyContainer'] = 'http://localhost:3000/settings/policies/';
-  variables['urn:uma:variables:eyePath'] = 'eye';
   variables['urn:uma:variables:backupFilePath'] = '';
 
   const configPath = path.join(rootDir, './config/demo.json');

packages/uma/bin/main.js

@@ -39,7 +39,6 @@ const launch = async () => {
 
   variables['urn:uma:variables:port'] = argv.port;
   variables['urn:uma:variables:baseUrl'] = argv.baseUrl ?? `http://localhost:${argv.port}/uma`;
-  variables['urn:uma:variables:eyePath'] = 'eye';
   variables['urn:uma:variables:backupFilePath'] = argv.backupFilePath;
 
   const configPath = path.join(rootDir, './config/default.json');

packages/uma/bin/odrl.js

@@ -17,7 +17,6 @@ const launch = async () => {
 
     variables['urn:uma:variables:policyBaseIRI'] = 'http://localhost:3000/';
     variables['urn:uma:variables:policyDir'] = path.join(rootDir, './config/rules/odrl');
-    variables['urn:uma:variables:eyePath'] = 'eye';
     variables['urn:uma:variables:backupFilePath'] = '';
 
     const configPath = path.join(rootDir, './config/odrl.json');

packages/uma/config/odrl.json

@@ -12,7 +12,6 @@
       "overrideInstance": { "@id": "urn:uma:default:Authorizer" },
       "overrideParameters": {
         "@type": "OdrlAuthorizer",
-        "eyePath": { "@id": "urn:uma:variables:eyePath" },
         "policies": {
           "@id": "urn:uma:default:RulesStorage"
         }

packages/uma/config/policies/authorizers/default.json

@@ -52,7 +52,6 @@
       "fallback": {
         "@id": "urn:uma:default:OdrlAuthorizer",
         "@type": "OdrlAuthorizer",
-        "eyePath": { "@id": "urn:uma:variables:eyePath" },
         "policies": {
           "@id": "urn:uma:default:RulesStorage",
           "@type": "FileBackupUCRulesStorage",

packages/uma/config/variables/default.json

@@ -22,11 +22,6 @@
         "@id": "urn:uma:variables:policyBaseIRI",
         "@type": "Variable"
       },
-      {
-        "comment": "Path of the local eye reasoner.",
-        "@id": "urn:uma:variables:eyePath",
-        "@type": "Variable"
-      },
       {
         "comment": "URL of container where policies are stored.",
         "@id": "urn:uma:variables:policyContainer",

packages/uma/src/policies/authorizers/OdrlAuthorizer.ts

@@ -1,7 +1,7 @@
 import { BadRequestHttpError, DC, RDF } from '@solid/community-server';
 import { getLoggerFor } from 'global-logger-factory';
 import { DataFactory, Quad, Store, Writer } from 'n3';
-import { EyeReasoner, ODRLEngineMultipleSteps, ODRLEvaluator } from 'odrl-evaluator';
+import { EyelingReasoner, EyeReasoner, ODRLEngineMultipleSteps, ODRLEvaluator } from 'odrl-evaluator';
 import { CLIENTID, WEBID } from '../../credentials/Claims';
 import { ClaimSet } from '../../credentials/ClaimSet';
 import { basicPolicy } from '../../ucp/policy/ODRL';
@@ -41,16 +41,11 @@ export class OdrlAuthorizer implements Authorizer {
      *
      *
      * @param policies - A store containing the ODRL policy rules.
-     * @param eyePath - The path to run the local EYE reasoner, if there is one.
      */
     constructor(
         private readonly policies: UCRulesStorage,
-        eyePath?: string,
     ) {
-        const engine = eyePath ?
-            new ODRLEngineMultipleSteps({ reasoner: new EyeReasoner(eyePath, ["--quiet", "--nope", "--pass-only-new"]) }) :
-            new ODRLEngineMultipleSteps();
-        this.odrlEvaluator = new ODRLEvaluator(engine);
+        this.odrlEvaluator = new ODRLEvaluator(new ODRLEngineMultipleSteps({ reasoner: new EyelingReasoner()}));
         this.strategy = new PrioritizeProhibitionStrategy();
     }