├── .gitignore ├── .rustfmt.toml ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples ├── fileserver.rs └── server.rs ├── src ├── errors.rs ├── lib.rs └── macros.rs └── test.py /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | Cargo.lock 4 | -------------------------------------------------------------------------------- /.rustfmt.toml: -------------------------------------------------------------------------------- 1 | use_small_heuristics = "off" 2 | match_block_trailing_comma = true 3 | struct_lit_single_line = false 4 | overflow_delimited_expr = true 5 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "rocket_failure" 3 | version = "0.1.2" 4 | description = "Failure like error handling for rocket" 5 | authors = ["kpcyrd "] 6 | license = "MIT/Apache-2.0" 7 | repository = "https://github.com/kpcyrd/rocket_failure" 8 | keywords = ["rocket", "failure", "errors", "api"] 9 | readme = "README.md" 10 | edition = "2018" 11 | 12 | #[badges] 13 | #travis-ci = { repository = "kpcyrd/rocket_failure" } 14 | 15 | [features] 16 | with-rocket = ["rocket", "serde_json"] 17 | 18 | [dependencies] 19 | serde = "1.0" 20 | serde_derive = "1.0" 21 | serde_json = { version = "1.0", optional = true } 22 | rocket = { version = "0.4", default-features = false, optional = true } 23 | 24 | [dev-dependencies] 25 | failure = "0.1" 26 | 27 | [package.metadata.docs.rs] 28 | all-features = true 29 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # rocket_failure 2 | 3 | Semantic error handling for rocket applications. 4 | 5 | To enable this crate in your server add this line to your `Cargo.toml`: 6 | ```toml 7 | rocket_failure = { version="0.1", features = ["with-rocket"] } 8 | ``` 9 | 10 | ```rust 11 | #![feature(proc_macro_hygiene, decl_macro)] 12 | 13 | #[macro_use] extern crate rocket; 14 | #[macro_use] extern crate rocket_failure; 15 | 16 | use rocket_failure::errors::*; 17 | use std::fs; 18 | 19 | #[get("/")] 20 | fn index(file: String) -> ApiResult> { 21 | if !file.chars().all(|c| char::is_alphanumeric(c) || c == '-' || c == '.') { 22 | bad_request!("file contains forbidden characters") 23 | } 24 | 25 | // if this returns an Err(_), return a standard 404 26 | let content = fs::read(&file) 27 | .not_found()?; 28 | 29 | // detailed errors are hidden by default 30 | // we can publish the actual error if we want to 31 | /* 32 | let content = fs::read(&file) 33 | .not_found() 34 | .publish_error()?; 35 | */ 36 | 37 | // or we can set a public error while preserving the actual error 38 | /* 39 | let content = fs::read(&file) 40 | .not_found() 41 | .public_context("That didn't work")?; 42 | */ 43 | 44 | Ok(content) 45 | } 46 | 47 | fn main() { 48 | rocket::ignite().mount("/", routes![index]).launch(); 49 | } 50 | ``` 51 | 52 | You can run this example with: 53 | ``` 54 | cargo +nightly run --example fileserver --features=with-rocket 55 | ``` 56 | 57 | With you want to use the `ApiResult` type in your api client to consume the 58 | api, omit the `with-rocket` feature: 59 | 60 | ```toml 61 | rocket_failure = "0.1" 62 | ``` 63 | 64 | ## License 65 | 66 | rocket_failure is licensed under either of the following, at your option: 67 | 68 | * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 69 | * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 70 | -------------------------------------------------------------------------------- /examples/fileserver.rs: -------------------------------------------------------------------------------- 1 | #![feature(proc_macro_hygiene, decl_macro)] 2 | 3 | #[macro_use] 4 | extern crate rocket; 5 | #[macro_use] 6 | extern crate rocket_failure; 7 | 8 | use rocket_failure::errors::*; 9 | use std::fs; 10 | 11 | #[get("/")] 12 | fn index(file: String) -> ApiResult> { 13 | if !file.chars().all(|c| char::is_alphanumeric(c) || c == '-' || c == '.') { 14 | bad_request!("file contains forbidden characters") 15 | } 16 | 17 | // if this returns an Err(_), return a standard 404 18 | let content = fs::read(&file) 19 | .not_found()?; 20 | 21 | // detailed errors are hidden by default 22 | // we can publish the actual error if we want to 23 | /* 24 | let content = fs::read(&file) 25 | .not_found() 26 | .publish_error()?; 27 | */ 28 | 29 | // or we can set a public error while preserving the actual error 30 | /* 31 | let content = fs::read(&file) 32 | .not_found() 33 | .public_context("That didn't work")?; 34 | */ 35 | 36 | Ok(content) 37 | } 38 | 39 | fn main() { 40 | rocket::ignite().mount("/", routes![index]).launch(); 41 | } 42 | -------------------------------------------------------------------------------- /examples/server.rs: -------------------------------------------------------------------------------- 1 | #![feature(proc_macro_hygiene, decl_macro)] 2 | 3 | #[macro_use] 4 | extern crate rocket; 5 | #[macro_use] 6 | extern crate failure; 7 | 8 | use rocket_failure::errors::*; 9 | 10 | #[get("/")] 11 | fn index() -> &'static str { 12 | "Hello, world!" 13 | } 14 | 15 | #[get("/internal//")] 16 | fn internal(x: String, y: String) -> ApiResult> { 17 | let result = if x == y { 18 | Ok(x) 19 | } else { 20 | Err(format_err!("this error is sensitive")) 21 | }; 22 | 23 | let x = result?; 24 | 25 | Ok(ApiResponse::Success(x)) 26 | } 27 | 28 | #[get("/404//")] 29 | fn notfound(x: String, y: String) -> ApiResult> { 30 | let result = if x == y { 31 | Ok(x) 32 | } else { 33 | Err(format_err!("this error is sensitive")) 34 | }; 35 | 36 | let x = result 37 | .not_found()?; 38 | 39 | Ok(ApiResponse::Success(x)) 40 | } 41 | 42 | #[get("/with-msg/internal//")] 43 | fn internal_with_msg(x: String, y: String) -> ApiResult> { 44 | let result = if x == y { 45 | Ok(x) 46 | } else { 47 | Err(format_err!("this error is sensitive")) 48 | }; 49 | 50 | let x = result 51 | .public_context("hello")?; 52 | 53 | Ok(ApiResponse::Success(x)) 54 | } 55 | 56 | #[get("/with-msg/404//")] 57 | fn notfound_with_msg(x: String, y: String) -> ApiResult> { 58 | let result = if x == y { 59 | Ok(x) 60 | } else { 61 | Err(format_err!("this error is sensitive")) 62 | }; 63 | 64 | let x = result 65 | .not_found() 66 | .public_context("hello")?; 67 | 68 | Ok(ApiResponse::Success(x)) 69 | } 70 | 71 | #[get("/public-err/internal//")] 72 | fn internal_public_err(x: String, y: String) -> ApiResult> { 73 | let result = if x == y { 74 | Ok(x) 75 | } else { 76 | Err(format_err!("this error is ok to leak")) 77 | }; 78 | 79 | let x = result 80 | .publish_error()?; 81 | 82 | Ok(ApiResponse::Success(x)) 83 | } 84 | 85 | #[get("/public-err/404//")] 86 | fn notfound_public_err(x: String, y: String) -> ApiResult> { 87 | let result = if x == y { 88 | Ok(x) 89 | } else { 90 | Err(format_err!("this error is ok to leak")) 91 | }; 92 | 93 | let x = result 94 | .not_found() 95 | .publish_error()?; 96 | 97 | Ok(ApiResponse::Success(x)) 98 | } 99 | 100 | fn main() { 101 | rocket::ignite() 102 | .mount("/", routes![ 103 | index, 104 | internal, 105 | notfound, 106 | internal_with_msg, 107 | notfound_with_msg, 108 | internal_public_err, 109 | notfound_public_err, 110 | ]) 111 | .launch(); 112 | } 113 | -------------------------------------------------------------------------------- /src/errors.rs: -------------------------------------------------------------------------------- 1 | use rocket::http::ContentType; 2 | pub use rocket::http::Status; 3 | use rocket::response::Responder; 4 | use rocket::Request; 5 | use serde_json; 6 | use std::fmt::Display; 7 | use std::io::Cursor; 8 | 9 | pub trait ApiResultExt { 10 | fn private_context(self, context: D) -> Result 11 | where 12 | D: Display + Send + Sync + 'static, 13 | Self: Sized; 14 | 15 | fn public_context(self, context: D) -> Result 16 | where 17 | D: Display + Send + Sync + 'static, 18 | Self: Sized; 19 | 20 | fn publish_error(self) -> Result 21 | where 22 | Self: Sized; 23 | 24 | fn bad_request(self) -> Result 25 | where 26 | Self: Sized; 27 | 28 | fn forbidden(self) -> Result 29 | where 30 | Self: Sized; 31 | 32 | fn not_found(self) -> Result 33 | where 34 | Self: Sized; 35 | } 36 | 37 | impl ApiResultExt for Result 38 | where 39 | E: WebFail, 40 | { 41 | fn private_context(self, context: D) -> Result 42 | where 43 | D: Display + Send + Sync + 'static, 44 | Self: Sized, 45 | { 46 | self.map_err(|err| err.fail().with_private_error(context)) 47 | } 48 | 49 | fn public_context(self, context: D) -> Result 50 | where 51 | D: Display + Send + Sync + 'static, 52 | Self: Sized, 53 | { 54 | self.map_err(|err| err.fail().with_public_error(context)) 55 | } 56 | 57 | fn publish_error(self) -> Result 58 | where 59 | Self: Sized, 60 | { 61 | self.map_err(|err| err.fail().publish_error()) 62 | } 63 | 64 | fn bad_request(self) -> Result 65 | where 66 | Self: Sized, 67 | { 68 | // 400 69 | self.map_err(|err| err.fail().with_status(Status::BadRequest)) 70 | } 71 | 72 | fn forbidden(self) -> Result 73 | where 74 | Self: Sized, 75 | { 76 | // 403 77 | self.map_err(|err| err.fail().with_status(Status::Forbidden)) 78 | } 79 | 80 | fn not_found(self) -> Result 81 | where 82 | Self: Sized, 83 | { 84 | // 404 85 | self.map_err(|err| err.fail().with_status(Status::NotFound)) 86 | } 87 | } 88 | 89 | pub type ApiResult = ::std::result::Result; 90 | 91 | #[derive(Debug)] 92 | pub enum ApiResponse { 93 | Success(T), 94 | Error(WebError), 95 | } 96 | 97 | impl ApiResponse { 98 | pub fn into_strict(self) -> (StrictApiResponse, ResponseHints) { 99 | match self { 100 | ApiResponse::Success(x) => (StrictApiResponse::Success(x), ResponseHints::ok()), 101 | ApiResponse::Error(x) => { 102 | let msg = x.public_error(); 103 | let hints = ResponseHints::err(&x); 104 | (StrictApiResponse::Error(msg), hints) 105 | }, 106 | } 107 | } 108 | } 109 | 110 | #[derive(Debug, Serialize, Deserialize)] 111 | pub enum StrictApiResponse { 112 | #[serde(rename = "success")] 113 | Success(T), 114 | #[serde(rename = "error")] 115 | Error(String), 116 | } 117 | 118 | pub struct ResponseHints { 119 | status: Status, 120 | } 121 | 122 | impl ResponseHints { 123 | pub fn ok() -> ResponseHints { 124 | ResponseHints { 125 | status: Status::Ok, 126 | } 127 | } 128 | 129 | pub fn err(err: &WebError) -> ResponseHints { 130 | let status = err.status.unwrap_or(Status::InternalServerError); 131 | 132 | ResponseHints { 133 | status, 134 | } 135 | } 136 | } 137 | 138 | impl<'r, T> Responder<'r> for ApiResponse 139 | where 140 | T: serde::Serialize, 141 | { 142 | fn respond_to(self, _req: &Request) -> ::std::result::Result, Status> { 143 | let (response, hints) = self.into_strict(); 144 | let body = serde_json::to_string(&response).map_err(|_| Status::InternalServerError)?; 145 | 146 | rocket::Response::build() 147 | .status(hints.status) 148 | .header(ContentType::JSON) 149 | .sized_body(Cursor::new(body)) 150 | .ok() 151 | } 152 | } 153 | 154 | #[derive(Debug)] 155 | pub struct WebError { 156 | status: Option, 157 | private_error: String, 158 | public_error: Option, 159 | } 160 | 161 | impl WebError { 162 | pub fn new(error: D) -> WebError { 163 | WebError { 164 | status: None, 165 | private_error: error.to_string(), 166 | public_error: None, 167 | } 168 | } 169 | 170 | pub fn with_status(mut self, status: Status) -> WebError { 171 | self.status = Some(status); 172 | self 173 | } 174 | 175 | pub fn with_private_error(mut self, error: D) -> WebError { 176 | self.private_error = error.to_string(); 177 | self 178 | } 179 | 180 | pub fn with_public_error(mut self, error: D) -> WebError { 181 | self.public_error = Some(error.to_string()); 182 | self 183 | } 184 | 185 | pub fn publish_error(mut self) -> WebError { 186 | self.public_error = Some(self.private_error.clone()); 187 | self 188 | } 189 | 190 | pub fn public_error(&self) -> String { 191 | self.public_error.as_ref() 192 | .map(|x| x.to_string()) 193 | .unwrap_or_else(|| match self.status { 194 | Some(status) => status.reason, 195 | _ => Status::InternalServerError.reason, 196 | }.to_string()) 197 | } 198 | } 199 | 200 | impl From for WebError { 201 | fn from(e: E) -> WebError { 202 | WebError::new(e) 203 | } 204 | } 205 | 206 | impl<'r> Responder<'r> for WebError { 207 | fn respond_to(self, _req: &Request) -> ::std::result::Result, Status> { 208 | ApiResponse::Error::<()>(self).respond_to(_req) 209 | } 210 | } 211 | 212 | pub trait WebFail: Send + Sync + 'static { 213 | fn fail(self) -> WebError 214 | where 215 | Self: Sized; 216 | } 217 | 218 | impl WebFail for E { 219 | fn fail(self) -> WebError 220 | where 221 | Self: Sized, 222 | { 223 | WebError::new(self) 224 | } 225 | } 226 | 227 | impl WebFail for WebError { 228 | fn fail(self) -> WebError 229 | where 230 | Self: Sized, 231 | { 232 | self 233 | } 234 | } 235 | 236 | pub fn err_msg(status: Status, msg: D) -> WebError { 237 | WebError { 238 | status: Some(status), 239 | private_error: msg.to_string(), 240 | public_error: Some(msg.to_string()), 241 | } 242 | } 243 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #[macro_use] 2 | extern crate serde_derive; 3 | 4 | use std::fmt; 5 | 6 | #[cfg(feature = "with-rocket")] 7 | pub mod errors; 8 | #[cfg(feature = "with-rocket")] 9 | pub mod macros; 10 | 11 | #[derive(Debug, Serialize, Deserialize)] 12 | pub enum StrictApiResponse { 13 | #[serde(rename = "success")] 14 | Success(T), 15 | #[serde(rename = "error")] 16 | Error(String), 17 | } 18 | 19 | impl StrictApiResponse { 20 | pub fn success(self) -> Result { 21 | match self { 22 | StrictApiResponse::Success(x) => Ok(x), 23 | StrictApiResponse::Error(err) => Err(ApiError(err)), 24 | } 25 | } 26 | } 27 | 28 | #[derive(Debug)] 29 | pub struct ApiError(String); 30 | 31 | impl fmt::Display for ApiError { 32 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 33 | write!(f, "api error: {:?}", self.0) 34 | } 35 | } 36 | 37 | impl std::error::Error for ApiError {} 38 | 39 | #[cfg(test)] 40 | mod tests { 41 | #[test] 42 | fn it_works() { 43 | assert_eq!(2 + 2, 4); 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /src/macros.rs: -------------------------------------------------------------------------------- 1 | #[macro_export] 2 | macro_rules! bad_request { 3 | ($e:expr) => { 4 | return Err($crate::errors::err_msg($crate::errors::Status::BadRequest, $e)); 5 | }; 6 | ($fmt:expr, $($arg:tt)+) => { 7 | return Err($crate::errors::err_msg($crate::errors::Status::BadRequest, format!($fmt, $($arg)+))); 8 | }; 9 | } 10 | 11 | #[macro_export] 12 | macro_rules! not_found { 13 | ($e:expr) => { 14 | return Err($crate::errors::err_msg($crate::errors::Status::NotFound, $e)); 15 | }; 16 | ($fmt:expr, $($arg:tt)+) => { 17 | return Err($crate::errors::err_msg($crate::errors::Status::NotFound, format!($fmt, $($arg)+))); 18 | }; 19 | } 20 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import requests 3 | 4 | for prefix in ['', 'with-msg/', 'public-err/']: 5 | for error_case in ['internal', '404']: 6 | for a in ['a', 'b']: 7 | url = 'http://localhost:8000/' + prefix + error_case + '/a/' + a 8 | print('[*] ' + url) 9 | r = requests.get(url) 10 | status = r.status_code 11 | json = r.json() 12 | 13 | if a == 'a': 14 | if status != 200: 15 | raise Exception('Wrong status code') 16 | body = json['success'] 17 | else: 18 | if error_case == 'internal' and status != 500: 19 | raise Exception('Wrong status code') 20 | if error_case == '404' and status != 404: 21 | raise Exception('Wrong status code') 22 | body = json['error'] 23 | 24 | if prefix == 'with-msg/' and body != 'hello': 25 | raise Exception('Wrong response body') 26 | if prefix == 'public-err/' and body != 'this error is ok to leak': 27 | raise Exception('Wrong response body') 28 | --------------------------------------------------------------------------------