feat: improve batching of credential requests (#170)

* feat: improve batching of credential requests

* update tests, update gradle to 8.12

* checkstyle

* revert lic header change

artifacts/gradle/wrapper/gradle-wrapper.properties

@@ -11,9 +11,11 @@
 #       Metaform Systems, Inc. - initial API and implementation
 #
 #
-#Tue Oct 29 12:58:29 CET 2024
+
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

artifacts/gradlew

@@ -1,17 +1,19 @@
 #!/bin/sh
 
 #
-#  Copyright (c) 2024 Metaform Systems, Inc.
+# Copyright © 2015-2021 the original authors.
 #
-#  This program and the accompanying materials are made available under the
-#  terms of the Apache License, Version 2.0 which is available at
-#  https://www.apache.org/licenses/LICENSE-2.0
+# 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
 #
-#  SPDX-License-Identifier: Apache-2.0
-#
-#  Contributors:
-#       Metaform Systems, Inc. - initial API and implementation
+#      https://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.
 #
 
 ##############################################################################
@@ -53,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -78,13 +80,11 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -131,22 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -191,18 +198,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \
         -classpath "$CLASSPATH" \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

artifacts/gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +41,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

artifacts/src/main/resources/context/dcp.jsonld

@@ -69,11 +69,9 @@
     "CredentialRequestMessage": {
       "@id": "dcp:CredentialRequestMessage",
       "@context": {
-        "format": "dcp:format",
-        "credentialType": {
-          "@id": "dcp:credentialType",
-          "@type": "@vocab",
-          "@container": "@set"
+        "credentials": {
+          "@id": "dcp:credentials",
+          "@type": "@json"
         }
       }
     },

artifacts/src/main/resources/issuance/credential-message-schema.json

@@ -24,9 +24,12 @@
         "requestId": {
           "type": "string"
         },
-        "type": {
+        "credentialType": {
           "type": "string",
           "const": "CredentialMessage"
+        },
+        "format":{
+          "type": "string"
         }
       },
       "required": [
@@ -51,7 +54,8 @@
       },
       "required": [
         "payload",
-        "type"
+        "credentialType",
+        "format"
       ]
     }
   }

artifacts/src/main/resources/issuance/credential-request-message-schema.json

@@ -15,25 +15,32 @@
         "@context": {
           "$ref": "https://w3id.org/dspace-dcp/v1.0/common/context-schema.json"
         },
-        "format": {
+        "type": {
           "type": "string"
         },
-        "credentialType": {
+        "credentials": {
           "type": "array",
           "items": {
-            "type": "string"
+            "type": "object",
+            "properties": {
+              "format": {
+                "type": "string"
+              },
+              "credentialType": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "credentialType",
+              "format"
+            ]
           }
-        },
-        "type": {
-          "type": "string",
-          "const": "CredentialRequestMessage"
         }
       },
       "required": [
         "@context",
-        "type",
-        "format",
-        "credentialType"
+        "credentials",
+        "type"
       ]
     }
   }

artifacts/src/main/resources/issuance/example/credential-message.json

@@ -5,8 +5,14 @@
   "type": "CredentialMessage",
   "credentials": [
     {
-      "type": "CredentialContainer",
-      "payload": "jwt"
+      "credentialType": "MembershipCredential",
+      "payload": "<JWT-STRING>",
+      "format": "jwt"
+    },
+    {
+      "credentialType": "OrganizationCredential",
+      "payload": "<LD-Object>",
+      "format": "json-ld"
     }
   ],
   "requestId": "requestId"

artifacts/src/main/resources/issuance/example/credential-request-message.json

@@ -1,13 +1,21 @@
 {
   "@context": [
-    "https://w3id.org/dspace-dcp/v1.0/dcp.jsonld",
-    "https://www.w3.org/2018/credentials/v1",
-    "https://www.w3.org/2018/credentials/examples/v1"
+    "https://w3id.org/dspace-dcp/v1.0/dcp.jsonld"
   ],
   "type": "CredentialRequestMessage",
-  "format": "jwt_vc_json",
-  "credentialType": [
-    "VerifiableCredential",
-    "OrganizationCredential"
+  "credentials": [
+    {
+      "credentialType": "MembershipCredential",
+      "format": "vcdm11_jwt"
+    },
+    {
+      "credentialType": "OrganizationCredential",
+      "format": "vcdm11_ld"
+    },
+    {
+      "credentialType": "Iso9001Credential",
+      "format": "vcdm20_jose"
+    }
+
   ]
 }

artifacts/src/test/java/org/eclipse/dcp/context/fixtures/AbstractJsonLdTest.java

@@ -111,7 +111,7 @@ protected void verifyRoundTrip(JsonObject message, String schemaFile) {
 
             var schema = schemaFactory.getSchema(SchemaLocation.of(DCP_PREFIX + schemaFile));
             var result = schema.validate(mapper.convertValue(compacted, JsonNode.class));
-            assertThat(result.isEmpty()).isTrue();
+            assertThat(result.isEmpty()).describedAs(String.join(", ", result.stream().map(Object::toString).toList())).isTrue();
             assertThat(compacted).isEqualTo(message);
         } catch (JsonLdError e) {
             throw new RuntimeException(e);