ag-admin/OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Include new transaction mode for bulk actions

Browse Source
This commit is contained in:
Finn Stutzenstein 2020-11-19 13:52:39 +01:00
parent 8cfa7d0a51
commit a73ae9961f
No known key found for this signature in database
GPG Key ID: 9042F605C6324654
1 changed files with 35 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
docs/interfaces/action-service.txt
View File

@ -1,33 +1,28 @@
# Actions Service Interface // Actions Service Interface
/**
* JSON resonse with a status code of !=200:
* {
* success: false;
* message: string;
* }
*
*/
Exception ActionException(message: string);
/** /**
* Executes multiple actions in the context of the user given by the user_id. * Executes multiple actions in the context of the user given by the user_id.
* All actions are depdend: If one fails, nothing is written to the DataStore. * There are two modes of execution:
* It can be seen as one transaction. * single_validation=false (default):
* * All actions are validated in common, so if one action or one payload of
* For each action an ActionResult is returned. If an action has an error, * one action fails, the request is aborted with an ActionException indicating
* ActionError is used in combination wuth error_index to indicate, which action * the problematic action with both indices.
* resulted in an error. * single_validation=true:
* Each action is validated by it's own. If there is an error, the error must
* be reported via an ActionError in the ActionsResponse. The actions result
* is not written into the Datastore. It might raise an ActionException if the
* single write request to the Datastore fails (e.g. because of locking there)
* *
* For general, non specific action-related, errors an ActionException is used. * For general, non specific action-related, errors an ActionException is used.
* *
* @throws ActionException * @throws ActionException
*/ */
handle_request (payload: Action[], user_id: Id): ActionsResponse | ActionError handle_request(payload: Action[], user_id: Id): ActionsResponse
interface Action { interface Action {
action: string; action: string;
data: object[]; # An array of action specific data. data: object[];
single_validation?: boolean;
} }
interace ActionsResponse { interace ActionsResponse {
@ -35,19 +30,21 @@ interace ActionsResponse {
message: string; message: string;
/** /**
* this is a potentially double-array with entries for each action * This is a potentially double-array with entries for each action
* and, if not null, an array for each data provided for each action. * and, if not null, an array for each data provided for each action.
* *
* * If an action does not produce a result, the inner array can be omitted and
* If an action does not producy a result, the inner array can be omitted and
* null can be used. If the inner array is given, each entry must be an object * null can be used. If the inner array is given, each entry must be an object
* with the result (e.g. for a create action `{id: <the id>}`) or null. * with the result (e.g. for a create action `{id: <the id>}`) or null.
*
* E.g. for valid arrays (two actions with two data entries each): * E.g. for valid arrays (two actions with two data entries each):
* - [null, null] * - [null, null]
* - [null, [null, null]] * - [null, [null, null]]
* - [null, [{id: 2}, null]] * - [null, [{id: 2}, null]]
* - [[{id: 2}, {id: 3}], [{id: 5}, {id: 8}]] * - [[{id: 2}, {id: 3}], [{id: 5}, {id: 8}]]
*
*
* To report errors, use the ActionError format!
**/ **/
results: ((object | null)[] | null )[] results: ((object | null)[] | null )[]
} }
@ -55,5 +52,19 @@ interace ActionsResponse {
interface ActionError { interface ActionError {
success: false; success: false;
message: string; message: string;
error_index: number; }
/**
* JSON resonse with a status code of !=200. If a specific action raised the error,
* use the action_error_index and action_payload_error_index to indicate the errored
* action and payload. If there were general errors, both indices must be omitted.
*
* If the single_validation Flag was true in the request, it is not allowed to send
* action-specific errors with this exception. It must be responded through ActionsResponse.
*/
Exception ActionException {
success: false;
message: string;
action_error_index: number;
action_payload_error_index: number;
} }