Merge pull request #44 from gcotelli/allow_to_configure_error_handlers

Allow to configure error handlers in JRPCMessageProcessor

.github/workflows/loading-groups.yml

@@ -0,0 +1,23 @@
+name: Baseline Groups
+
+on: [push,pull_request,workflow_dispatch]
+
+jobs:
+   group-loading:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        smalltalk: [ Pharo64-9.0, Pharo64-8.0 ]
+        load-spec: [ client-deployment, server-deployment, http-transport, tcp-transport, server-logging ]
+    name: ${{ matrix.smalltalk }} + ${{ matrix.load-spec }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: hpi-swa/setup-smalltalkCI@v1
+        with:
+          smalltalk-image: ${{ matrix.smalltalk }}
+      - name: Load group in image
+        run: smalltalkci -s ${{ matrix.smalltalk }} .smalltalkci/.loading.${{ matrix.load-spec }}.ston
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        timeout-minutes: 15

.github/workflows/unit-tests.yml

@@ -0,0 +1,26 @@
+name: Unit Tests
+
+on: [push,pull_request,workflow_dispatch]
+
+jobs:
+   unit-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        smalltalk: [ Pharo64-9.0, Pharo64-8.0, Pharo32-8.0, Pharo64-7.0, Pharo32-7.0 , Pharo32-6.1 ]
+    name: ${{ matrix.smalltalk }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: hpi-swa/setup-smalltalkCI@v1
+        with:
+          smalltalk-image: ${{ matrix.smalltalk }}
+      - name: Load Image and Run Tests
+        run: smalltalkci -s ${{ matrix.smalltalk }} .smalltalkci/.unit-tests.ston
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        timeout-minutes: 15
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          name: ${{matrix.os}}-${{matrix.smalltalk}}
+          token: ${{ secrets.CODECOV_TOKEN }}

.smalltalkci/.loading.client-deployment.ston

@@ -0,0 +1,13 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'JRPC',
+      #directory : '../src',
+      #load : [ 'Client-Deployment' ],
+      #platforms : [  #pharo ]
+    }
+  ],
+  #testing : {
+    #failOnZeroTests : false
+  }
+}

.smalltalkci/.loading.http-transport.ston

@@ -0,0 +1,13 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'JRPC',
+      #directory : '../src',
+      #load : [ 'HTTP-Transport' ],
+      #platforms : [  #pharo ]
+    }
+  ],
+  #testing : {
+    #failOnZeroTests : false
+  }
+}

.smalltalkci/.loading.server-deployment.ston

@@ -0,0 +1,13 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'JRPC',
+      #directory : '../src',
+      #load : [ 'Server-Deployment' ],
+      #platforms : [  #pharo ]
+    }
+  ],
+  #testing : {
+    #failOnZeroTests : false
+  }
+}

.smalltalkci/.loading.server-logging.ston

@@ -0,0 +1,13 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'JRPC',
+      #directory : '../src',
+      #load : [ 'Server-Logging' ],
+      #platforms : [  #pharo ]
+    }
+  ],
+  #testing : {
+    #failOnZeroTests : false
+  }
+}

.smalltalkci/.loading.tcp-transport.ston

@@ -0,0 +1,13 @@
+SmalltalkCISpec {
+  #loading : [
+    SCIMetacelloLoadSpec {
+      #baseline : 'JRPC',
+      #directory : '../src',
+      #load : [ 'TCP-Transport' ],
+      #platforms : [  #pharo ]
+    }
+  ],
+  #testing : {
+    #failOnZeroTests : false
+  }
+}

.smalltalk.ston → .smalltalkci/.unit-tests.ston

@@ -2,14 +2,15 @@ SmalltalkCISpec {
   #loading : [
     SCIMetacelloLoadSpec {
       #baseline : 'JRPC',
-      #directory : 'src',
+      #directory : '../src',
       #load : [ 'CI' ],
-      #platforms : [ #pharo ]
+      #platforms : [  #pharo ]
     }
   ],
   #testing : {
     #coverage : {
-       #packages : [ 'JRPC-Client' , 'JRPC-Server*' , 'JRPC-Tests' ]
+      #packages : [ 'JRPC-Client' , 'JRPC-Server*' , 'JRPC-Tests' ],
+      #format: #lcov
     }
   }
 }

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2019 Julien Delplanque
+Copyright (c) 2018-2021 Julien Delplanque
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,9 @@
 # JRPC
-[![Build Status](https://travis-ci.org/juliendelplanque/JRPC.svg?branch=master)](https://travis-ci.org/juliendelplanque/JRPC)
-[![Coverage Status](https://coveralls.io/repos/github/juliendelplanque/JRPC/badge.svg?branch=master)](https://coveralls.io/github/juliendelplanque/JRPC?branch=master)
+
+[![Unit Tests](https://github.com/juliendelplanque/JRPC/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/juliendelplanque/JRPC/actions/workflows/unit-tests.yml)
+[![Coverage Status](https://codecov.io/github/juliendelplanque/JRPC/coverage.svg?branch=master)](https://codecov.io/gh/juliendelplanque/JRPC/branch/master)
+[![Baseline Groups](https://github.com/juliendelplanque/JRPC/actions/workflows/loading-groups.yml/badge.svg)](https://github.com/juliendelplanque/JRPC/actions/workflows/loading-groups.yml)
+
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 [![Pharo version](https://img.shields.io/badge/Pharo-6.1-%23aac9ff.svg)](https://pharo.org/download)
 [![Pharo version](https://img.shields.io/badge/Pharo-7.0-%23aac9ff.svg)](https://pharo.org/download)

src/JRPC-Server-Core/JRPCAbstractMessageProcessor.class.st

@@ -9,6 +9,12 @@ Class {
 	#category : #'JRPC-Server-Core'
 }
 
+{ #category : #'handlers management' }
+JRPCAbstractMessageProcessor >> addErrorHandler: aBlock [
+
+	self subclassResponsibility
+]
+
 { #category : #'handlers management' }
 JRPCAbstractMessageProcessor >> addHandler: aJRPCHandler [
 	"Adds aJRPCHandler to the list of available handlers."

src/JRPC-Server-Core/JRPCMessageProcessor.class.st

@@ -12,11 +12,18 @@ Class {
 	#classTraits : 'JRPCParser classTrait',
 	#instVars : [
 		'handlers',
-		'debugMode'
+		'debugMode',
+		'errorHandlers'
 	],
 	#category : #'JRPC-Server-Core'
 }
 
+{ #category : #'handlers management' }
+JRPCMessageProcessor >> addErrorHandler: aBlock [
+
+	errorHandlers add: aBlock
+]
+
 { #category : #'handlers management' }
 JRPCMessageProcessor >> addHandler: aJRPCHandler [
 
@@ -32,8 +39,22 @@ JRPCMessageProcessor >> debugMode [
 ]
 
 { #category : #accessing }
-JRPCMessageProcessor >> debugMode: anObject [
-	debugMode := anObject
+JRPCMessageProcessor >> debugMode: aBoolean [
+	debugMode := aBoolean
+]
+
+{ #category : #private }
+JRPCMessageProcessor >> handleErrorsDuring: aBlock for: aJRPCRequestObject [
+
+	^ self debugMode
+		  ifTrue: aBlock
+		  ifFalse: [ 
+			  aBlock
+				  on: Error
+				  do: [ :jrpcError | 
+					  errorHandlers do: [ :handler | handler cull: jrpcError ].
+					  jrpcError return:
+						  (aJRPCRequestObject convertErrorToResponse: jrpcError) ] ]
 ]
 
 { #category : #'handling - jrpc' }
@@ -68,18 +89,16 @@ JRPCMessageProcessor >> handleJRPCNotificationObject: aJRPCNotificationObject [
 { #category : #'handling - jrpc' }
 JRPCMessageProcessor >> handleJRPCRequestObject: aJRPCRequestObject [
 
-	^ [ | handler result |
-
-	handler := self handlerFor: aJRPCRequestObject.
-	handler checkParametersForRequest: aJRPCRequestObject.
-	result := handler executeWithArguments: aJRPCRequestObject params.
-	JRPCSuccessResponseObject id: aJRPCRequestObject id result: result
-	]
-		on: Error
-		do: [ :jrpcError | 
-			self debugMode
-				ifTrue: [ jrpcError pass ]
-				ifFalse: [ jrpcError return: ( aJRPCRequestObject convertErrorToResponse: jrpcError ) ] ]
+	^ self
+		  handleErrorsDuring: [ 
+			  | handler result |
+			  handler := self handlerFor: aJRPCRequestObject.
+			  handler checkParametersForRequest: aJRPCRequestObject.
+			  result := handler executeWithArguments: aJRPCRequestObject params.
+			  JRPCSuccessResponseObject
+				  id: aJRPCRequestObject id
+				  result: result ]
+		  for: aJRPCRequestObject
 ]
 
 { #category : #'handling - json' }
@@ -128,6 +147,7 @@ JRPCMessageProcessor >> initialize [
 
 	super initialize.
 	handlers := OrderedCollection new.
+	errorHandlers := OrderedCollection new.
 	self debugMode: false
 ]
 

src/JRPC-Server-Core/JRPCMessageProcessorDecorator.class.st

@@ -21,6 +21,12 @@ JRPCMessageProcessorDecorator class >> decorate: aMessageProcessor [
 		yourself
 ]
 
+{ #category : #adding }
+JRPCMessageProcessorDecorator >> addErrorHandler: aBlock [
+
+	self decoratedMessageProcessor addErrorHandler: aBlock
+]
+
 { #category : #adding }
 JRPCMessageProcessorDecorator >> addHandler: aJRPCHandler [
 	self decoratedMessageProcessor addHandler: aJRPCHandler

src/JRPC-Server-Core/JRPCServer.class.st

@@ -13,6 +13,12 @@ Class {
 	#category : #'JRPC-Server-Core'
 }
 
+{ #category : #'handlers management' }
+JRPCServer >> addErrorHandler: anErrorHandler [ 
+
+	self messageProcessor addErrorHandler: anErrorHandler 
+]
+
 { #category : #'handlers management' }
 JRPCServer >> addHandler: aJRPCHandler [
 

src/JRPC-Tests/JRPCMessageProcessorTest.class.st

@@ -115,6 +115,65 @@ JRPCMessageProcessorTest >> testDebugModeDoNotCatchError [
 		raise: Error.
 ]
 
+{ #category : #'tests - error handlers' }
+JRPCMessageProcessorTest >> testErrorHandlersAreNotEvaluatedOnSuccess [
+
+	| messageProcessor response |
+	messageProcessor := JRPCMessageProcessor new.
+	messageProcessor
+		addHandlerNamed: 'success' block: [ 'Sucess!' ];
+		addErrorHandler: [ :error | self fail ].
+
+	response := messageProcessor handleJRPCRequestObject:
+		            (JRPCRequestObject new
+			             id: 1;
+			             method: 'success';
+			             yourself).
+
+	self deny: response isError
+]
+
+{ #category : #'tests - error handlers' }
+JRPCMessageProcessorTest >> testErrorHandlersAreNotEvaluatedWhenDebugModeIsEnabled [
+
+	| messageProcessor |
+	messageProcessor := JRPCMessageProcessor new.
+	messageProcessor
+		debugMode: true;
+		addHandlerNamed: 'error' block: [ 1 / 0 ];
+		addErrorHandler: [ :error | self fail ].
+
+	self
+		should: [ 
+			messageProcessor handleJRPCRequestObject: (JRPCRequestObject new
+					 id: 1;
+					 method: 'error';
+					 yourself) ]
+		raise: ZeroDivide
+]
+
+{ #category : #'tests - error handlers' }
+JRPCMessageProcessorTest >> testErrorHandling [
+
+	| messageProcessor errorWasRaised response |
+	errorWasRaised := false.
+
+	messageProcessor := JRPCMessageProcessor new.
+	messageProcessor
+		addHandlerNamed: 'error' block: [ Error signal ];
+		addErrorHandler: [ :error | errorWasRaised := true ].
+
+	response := messageProcessor handleJRPCRequestObject:
+		            (JRPCRequestObject new
+			             id: 1;
+			             method: 'error';
+			             yourself).
+
+	self
+		assert: response isError;
+		assert: errorWasRaised
+]
+
 { #category : #test }
 JRPCMessageProcessorTest >> testHandlerFor [
 	| messageProcessor block handler |
@@ -196,3 +255,26 @@ JRPCMessageProcessorTest >> testRemoveHandler [
 	self assert: messageProcessor handlers size equals: 0.
 
 ]
+
+{ #category : #'tests - error handlers' }
+JRPCMessageProcessorTest >> testSeveralErrorHandlers [
+
+	| messageProcessor response errorCount |
+	errorCount := 0.
+
+	messageProcessor := JRPCMessageProcessor new.
+	messageProcessor
+		addHandlerNamed: 'error' block: [ Error signal ];
+		addErrorHandler: [ :error | errorCount := errorCount + 1 ];
+		addErrorHandler: [ :error | errorCount := errorCount + 1 ].
+
+	response := messageProcessor handleJRPCRequestObject:
+		            (JRPCRequestObject new
+			             id: 1;
+			             method: 'error';
+			             yourself).
+
+	self
+		assert: response isError;
+		assert: errorCount equals: 2
+]