[pbs-devel] [PATCH backup] api: add world accessible ping dummy endpoint

[pbs-devel] [PATCH backup] api: add world accessible ping dummy endpoint

[Thomas Lamprecht]

This is indented to be used for the PVE storage library, replacing
the missuse of the much more expensive status API call.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
---

I initially thought about adding this to the proxmox-backup-client as command,
but it's not much of use there (user can just use the version command) and for
the PVE integration we can do a simple http request with LWP, which is much
cheaper than fork+exec the client there.

 src/api2.rs      |  2 ++
 src/api2/ping.rs | 29 +++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 src/api2/ping.rs

diff --git a/src/api2.rs b/src/api2.rs
index 85d29ed2..27ef2975 100644
--- a/src/api2.rs
+++ b/src/api2.rs
@@ -7,6 +7,7 @@ pub mod reader;
 pub mod status;
 pub mod types;
 pub mod version;
+pub mod ping;
 pub mod pull;
 mod helpers;
 
@@ -22,6 +23,7 @@ pub const SUBDIRS: SubdirMap = &[
     ("backup", &backup::ROUTER),
     ("config", &config::ROUTER),
     ("nodes", &NODES_ROUTER),
+    ("ping", &ping::ROUTER),
     ("pull", &pull::ROUTER),
     ("reader", &reader::ROUTER),
     ("status", &status::ROUTER),
diff --git a/src/api2/ping.rs b/src/api2/ping.rs
new file mode 100644
index 00000000..087b1377
--- /dev/null
+++ b/src/api2/ping.rs
@@ -0,0 +1,29 @@
+use anyhow::{Error};
+use serde_json::{json, Value};
+
+use proxmox::api::{api, Router, Permission};
+
+#[api(
+    returns: {
+        description: "Dummy ping",
+        type: Object,
+        properties: {
+            pong: {
+                description: "Always true",
+                type: bool,
+            }
+        }
+    },
+    access: {
+        description: "Anyone can access this, because it's used for a cheap check if the API daemon is online.",
+        permission: &Permission::World,
+    }
+)]
+/// Dummy method which replies with `{ "pong": True }`
+fn ping() -> Result<Value, Error> {
+    Ok(json!({
+        "pong": true,
+    }))
+}
+pub const ROUTER: Router = Router::new()
+    .get(&API_METHOD_PING);
-- 
2.27.0

Re: [pbs-devel] [PATCH backup] api: add world accessible ping dummy endpoint

[Thomas Lamprecht]

On 05.10.20 16:57, Thomas Lamprecht wrote:
> This is indented to be used for the PVE storage library, replacing
> the missuse of the much more expensive status API call.
> 
> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
> ---
> 
> I initially thought about adding this to the proxmox-backup-client as command,
> but it's not much of use there (user can just use the version command) and for
> the PVE integration we can do a simple http request with LWP, which is much
> cheaper than fork+exec the client there.
> 

any objections to this? Else I'd apply it as is..

>  src/api2.rs      |  2 ++
>  src/api2/ping.rs | 29 +++++++++++++++++++++++++++++
>  2 files changed, 31 insertions(+)
>  create mode 100644 src/api2/ping.rs
> 
> diff --git a/src/api2.rs b/src/api2.rs
> index 85d29ed2..27ef2975 100644
> --- a/src/api2.rs
> +++ b/src/api2.rs
> @@ -7,6 +7,7 @@ pub mod reader;
>  pub mod status;
>  pub mod types;
>  pub mod version;
> +pub mod ping;
>  pub mod pull;
>  mod helpers;
>  
> @@ -22,6 +23,7 @@ pub const SUBDIRS: SubdirMap = &[
>      ("backup", &backup::ROUTER),
>      ("config", &config::ROUTER),
>      ("nodes", &NODES_ROUTER),
> +    ("ping", &ping::ROUTER),
>      ("pull", &pull::ROUTER),
>      ("reader", &reader::ROUTER),
>      ("status", &status::ROUTER),
> diff --git a/src/api2/ping.rs b/src/api2/ping.rs
> new file mode 100644
> index 00000000..087b1377
> --- /dev/null
> +++ b/src/api2/ping.rs
> @@ -0,0 +1,29 @@
> +use anyhow::{Error};
> +use serde_json::{json, Value};
> +
> +use proxmox::api::{api, Router, Permission};
> +
> +#[api(
> +    returns: {
> +        description: "Dummy ping",
> +        type: Object,
> +        properties: {
> +            pong: {
> +                description: "Always true",
> +                type: bool,
> +            }
> +        }
> +    },
> +    access: {
> +        description: "Anyone can access this, because it's used for a cheap check if the API daemon is online.",
> +        permission: &Permission::World,
> +    }
> +)]
> +/// Dummy method which replies with `{ "pong": True }`
> +fn ping() -> Result<Value, Error> {
> +    Ok(json!({
> +        "pong": true,
> +    }))
> +}
> +pub const ROUTER: Router = Router::new()
> +    .get(&API_METHOD_PING);
> 

Re: [pbs-devel] [PATCH backup] api: add world accessible ping dummy endpoint

[Fabian Grünbichler]

On October 21, 2020 8:32 pm, Thomas Lamprecht wrote:
> On 05.10.20 16:57, Thomas Lamprecht wrote:
>> This is indented to be used for the PVE storage library, replacing
>> the missuse of the much more expensive status API call.
>> 
>> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
>> ---
>> 
>> I initially thought about adding this to the proxmox-backup-client as command,
>> but it's not much of use there (user can just use the version command) and for
>> the PVE integration we can do a simple http request with LWP, which is much
>> cheaper than fork+exec the client there.
>> 
> 
> any objections to this? Else I'd apply it as is..

LGTM, maybe besides that having a separate file for this instead of just 
inlining it into api2.rs seems overkill :-P

> 
>>  src/api2.rs      |  2 ++
>>  src/api2/ping.rs | 29 +++++++++++++++++++++++++++++
>>  2 files changed, 31 insertions(+)
>>  create mode 100644 src/api2/ping.rs
>> 
>> diff --git a/src/api2.rs b/src/api2.rs
>> index 85d29ed2..27ef2975 100644
>> --- a/src/api2.rs
>> +++ b/src/api2.rs
>> @@ -7,6 +7,7 @@ pub mod reader;
>>  pub mod status;
>>  pub mod types;
>>  pub mod version;
>> +pub mod ping;
>>  pub mod pull;
>>  mod helpers;
>>  
>> @@ -22,6 +23,7 @@ pub const SUBDIRS: SubdirMap = &[
>>      ("backup", &backup::ROUTER),
>>      ("config", &config::ROUTER),
>>      ("nodes", &NODES_ROUTER),
>> +    ("ping", &ping::ROUTER),
>>      ("pull", &pull::ROUTER),
>>      ("reader", &reader::ROUTER),
>>      ("status", &status::ROUTER),
>> diff --git a/src/api2/ping.rs b/src/api2/ping.rs
>> new file mode 100644
>> index 00000000..087b1377
>> --- /dev/null
>> +++ b/src/api2/ping.rs
>> @@ -0,0 +1,29 @@
>> +use anyhow::{Error};
>> +use serde_json::{json, Value};
>> +
>> +use proxmox::api::{api, Router, Permission};
>> +
>> +#[api(
>> +    returns: {
>> +        description: "Dummy ping",
>> +        type: Object,
>> +        properties: {
>> +            pong: {
>> +                description: "Always true",
>> +                type: bool,
>> +            }
>> +        }
>> +    },
>> +    access: {
>> +        description: "Anyone can access this, because it's used for a cheap check if the API daemon is online.",
>> +        permission: &Permission::World,
>> +    }
>> +)]
>> +/// Dummy method which replies with `{ "pong": True }`
>> +fn ping() -> Result<Value, Error> {
>> +    Ok(json!({
>> +        "pong": true,
>> +    }))
>> +}
>> +pub const ROUTER: Router = Router::new()
>> +    .get(&API_METHOD_PING);
>> 
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
> 

Re: [pbs-devel] [PATCH backup] api: add world accessible ping dummy endpoint

[Thomas Lamprecht]

On 22.10.20 10:18, Fabian Grünbichler wrote:
> On October 21, 2020 8:32 pm, Thomas Lamprecht wrote:
>> On 05.10.20 16:57, Thomas Lamprecht wrote:
>>> This is indented to be used for the PVE storage library, replacing
>>> the missuse of the much more expensive status API call.
>>>
>>> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
>>> ---
>>>
>>> I initially thought about adding this to the proxmox-backup-client as command,
>>> but it's not much of use there (user can just use the version command) and for
>>> the PVE integration we can do a simple http request with LWP, which is much
>>> cheaper than fork+exec the client there.
>>>
>>
>> any objections to this? Else I'd apply it as is..
> 
> LGTM, maybe besides that having a separate file for this instead of just 
> inlining it into api2.rs seems overkill :-P
> 

Thought so first too, but it made the top level API entry point quite a bit uglier,
more noisier, and as the separate file does not costs much I went for that way :)

[pbs-devel] applied: [PATCH backup] api: add world accessible ping dummy endpoint

[Thomas Lamprecht]

On 05.10.20 16:57, Thomas Lamprecht wrote:
> This is indented to be used for the PVE storage library, replacing
> the missuse of the much more expensive status API call.
> 
> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
> ---
> 
> I initially thought about adding this to the proxmox-backup-client as command,
> but it's not much of use there (user can just use the version command) and for
> the PVE integration we can do a simple http request with LWP, which is much
> cheaper than fork+exec the client there.
> 
>  src/api2.rs      |  2 ++
>  src/api2/ping.rs | 29 +++++++++++++++++++++++++++++
>  2 files changed, 31 insertions(+)
>  create mode 100644 src/api2/ping.rs
> 
>

applied