Page MenuHomeSoftware Heritage
Create Task
Maniphest T43

Convention for error passing from storage "backend" to storage "API server" to storage "API client"
Closed, MigratedEdits Locked
Actions

Description

in rDSTO

The swh.storage module is split in three layers :

  • swh.storage.storage, the "local storage" / "storage backend;
  • swh.storage.api, the "Storage API server";
  • swh.storage.remote_storage, the "Storage API client".

Currently, errors/exceptions raised in swh.storage.storage aren't passed through to the upper layers, and you only get an error 500 from the API server. This will become evident once exceptions get tested in swh.storage.storage as the tests for remote_storage are identical.

We need to define and implement a convention to be able to pass through the errors from the bottom layer through to the Storage API client.

Related Objects

Event Timeline

olasd created this task.Sep 24 2015, 2:45 PM
olasd raised the priority of this task from to Needs Triage.
olasd updated the task description. (Show Details)
olasd added a project: Developers.
olasd added a subscriber: olasd.
Herald added a project: Staff. · View Herald TranscriptSep 24 2015, 2:45 PM
olasd added a comment.Sep 24 2015, 2:49 PM

We should standardize on :

  • an HTTP error code (400 / Bad Request ?)
  • a serialization format for the answer (JSON, probably serializing the error type and error args), e.g.
{
    'exception': e.__class__.__name__,
    'args': e.args,
}

and then deserialize that and raise in the client.

zack added a subscriber: zack.Sep 24 2015, 2:58 PM

the {exception:.../args:....} proposal + re-raising in the client looks good to me

olasd triaged this task as High priority.Sep 24 2015, 3:03 PM
olasd closed this task as Resolved.Sep 29 2015, 5:02 PM
olasd claimed this task.

Resolved as of rDSTO2b46e6941afe

The current implementation wraps pickled exceptions in a msgpack request body, which breaks language-agnosticity of the storage API but works...

zack removed projects: Developers, Staff.Mar 10 2016, 5:51 PM
olasd changed the visibility from "All Users" to "Public (No Login Required)".May 13 2016, 5:05 PM
gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 9:55 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal