diff --git a/README.md b/README.md new file mode 100644 index 0000000..781bc71 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +DigiComp.FlowSessionLock +------------------------ + +By default the session established by Flow is not "protected" in any way. +This package restricts every request to load the session only, if there are no other requests having it in access currently. +It allows to set custom pointcut which will set the session in "ReadOnly" mode, which allows concurrent requests to read, but disallows the current request to write the session. + +If you want to allow concurrent access somewhere, you can add your trigger pointcut in Settings.yaml like such: + + DigiComp: + FlowSessionLock: + readOnlyExpressions: + 'AcmeLock': 'method(Acme/SuperPackage/Controller/ConcurrentController->concurrentAction())' diff --git a/composer.json b/composer.json index 308915f..811e3c2 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,21 @@ { "name": "digicomp/flowsessionlock", - "description": "Sesion locking for Neos Flow", "type": "neos-package", + "description": "Sesion locking for Neos Flow - it secures the session becoming corrupted by concurrent access to the same session by different requests", + "keywords": [ + "flow", + "neos" + ], + "authors": [ + { + "name": "Ferdinand Kuhl", + "email": "f.kuhl@digital-competence.de", + "homepage": "http://www.digital-competence.de", + "role": "Developer" + } + ], + "license": "MIT", + "homepage": "https://github.com/digicomp/DigiComp.FlowSessionLock", "require": { "neos/flow": "^6.2", "php": "^7.4",