Remove "x-opencmw-method" header and "bodyOverride"

frankosterfeld · frankosterfeld · commit a234878d05af · 2025-06-24T16:50:30.000+02:00
HTTP GET is majordomo Get, HTTP PUT/POST is majordomo Set, GET with
"LongPollingIdx" query parameter retrieves cached NOTIFY messages, we
don't need more at the moment.
diff --git a/concepts/client/pre.js b/concepts/client/pre.js
@@ -47,8 +47,8 @@ if (typeof XMLHttpRequest === 'undefined') {
 
                     // Set the additional headers
                     res.setHeader('Keep-Alive', 'timeout=5, max=5');
-                    res.setHeader('X-OPENCMW-SERVICE-NAME', 'dns');
-                    res.setHeader('X-OPENCMW-TOPIC', '//s?signal_type=&signal_unit=&signal_name=&service_type=&service_name=&port=-1&hostname=&protocol=&signal_rate=nan&contextType=application%2Foctet-stream');
+                    res.setHeader('x-opencmw-service-name', 'dns');
+                    res.setHeader('x-opencmw-topic', '//s?signal_type=&signal_unit=&signal_name=&service_type=&service_name=&port=-1&hostname=&protocol=&signal_rate=nan&contextType=application%2Foctet-stream');
 
                     // Send the binary response
                     const binaryData = Buffer.from('ffffffff040000005961530001000000602f0da036000000e4010000250000006f70656e636d773a3a736572766963653a3a646e733a3a466c6174456e7472794c69737400ff988e0ac51a000000150000000900000070726f746f636f6c00010000000100000001000000050000006874747000ff335c21ee1a0000002100000009000000686f73746e616d650001000000010000000100000011000000746573742e6578616d706c652e636f6d006881983400160000001000000005000000706f72740001000000010000000100000039050000ffd55573151e000000150000000d000000736572766963655f6e616d6500010000000100000001000000050000007465737400ff846a76151e000000110000000d000000736572766963655f74797065000100000001000000010000000100000000ffc2ad1b281d000000160000000c0000007369676e616c5f6e616d650001000000010000000100000005000000746573743100ffbb0c1f281d000000110000000c0000007369676e616c5f756e69740001000000010000000100000001000000006a17801d281d000000100000000c0000007369676e616c5f726174650001000000010000000100000000007a44ff71c21e281d000000110000000c0000007369676e616c5f74797065000100000001000000010000000100000000fe602f0da03600000000000000250000006f70656e636d773a3a736572766963653a3a646e733a3a466c6174456e7472794c69737400', 'hex');
diff --git a/concepts/majordomo/assets/mustache/ServicesList.mustache b/concepts/majordomo/assets/mustache/ServicesList.mustache
@@ -96,9 +96,7 @@ input.topicInput { border: 0; width: 100px; border-bottom: 1px solid silver; }
             };
 
             listenButton.onclick = () => {
-                        let post = { method: 'GET', headers: { 'x-opencmw-method' : 'POLL' } };
-
-                fetch(href + "/" + topicInput.value, post)
+                fetch(href + "/" + topicInput.value)
                     .then(response => response.text())
                     .then(data => {
                         notificationLabel.innerHTML = data;
diff --git a/concepts/majordomo/assets/mustache/default.mustache b/concepts/majordomo/assets/mustache/default.mustache
@@ -174,14 +174,13 @@
     }
 
     function pollingHandler() {
-        let get = { method: 'GET', headers: { 'x-opencmw-method' : 'POLL' } };
-
         let queryParams = window.opencmwActiveSubscriptionQueryParams;
 
         if (!window.opencmwActiveSubscriptionQueryParams) {
             let formMeta = window.opencmwWebForms.replyContextForm;
 
             queryParams = new URLSearchParams();
+            queryParams.append("LongPollingIdx", "Next");
 
             for (const [key, fieldMeta] of Object.entries(formMeta)) {
                 const field = document.getElementById(fieldMeta.formId + "_" + fieldMeta.name);
@@ -205,14 +204,14 @@
         }
 
         let url = getPageBaseUrl();
-        url.searchParams.append("LongPollingIdx", "Next");
+        url.searchParams.set("LongPollingIdx", "Next");
         let currentObject = (new URL(document.URL)).pathname;
-        url.searchParams.append("SubscriptionContext", currentObject + "?" + queryParams.toString());
+        url.searchParams.set("SubscriptionContext", currentObject + "?" + queryParams.toString());
         let address = url.href;
 
         console.log(address);
 
-        fetch(address, get)
+        fetch(address)
             .then(response => response.text())
             .then(data => {
                 var checkbox = document.getElementById("subscriptionPollingCheckbox");
@@ -308,12 +307,10 @@
                     request.send(formData);
 
                 } else {
-                    address += '&_bodyOverride=' + JSON.stringify(json);
                     let post = {
-                            method:  'POST',
-                            headers: { 'Accept' : 'application/json',
-                                       'Content-Type': 'application/json',
-                                       'X-OPENCMW-METHOD-DIS' : 'SET' },
+                            method: 'POST',
+                            headers: { 'Accept' : 'application/json', 'Content-Type': 'application/json' },
+                            body: JSON.stringify(json),
                         };
 
                     fetch(address, post)
diff --git a/docs/RestUriMapping.md b/docs/RestUriMapping.md
@@ -15,23 +15,13 @@ There is no topic in this case.
 # Request type specification
 
 The REST backend maps HTTP requests to Majordomo requests.
-By default, `PUT` and `POST` HTTP requests are mapped to Majordomo's `Post`,
+By default, `PUT` and `POST` HTTP requests are mapped to Majordomo's `Set`,
 and `GET` HTTP request is mapped to Majordomo's `Get` request.
 
-It also defines two non-standard HTTP requests -- `SUB`,
-which maps to Majordomo's `Subscribe`
-and `POLL` which maps to `LongPoll`.
+Requests with a query parameter `LongPollingIdx` are treated as `LongPoll` request subscribing to the
+given topic (consisting of URI path and other query parameters), with the possible values:
 
-For clients that don't support a custom request operation,
-the non-standard HTTP requests can be invoked by defining the
-`x-opencmw-method` HTTP header.
-
-If this header is defined, its value is used to override
-the HTTP request method.
-This means that if HTTP method is `GET` and `x-opencmw-method=POLL`,
-that the REST backend will treat it as `LongPoll` request.
-
-Alternatively, one can override the Majordomo method
-by setting the `LongPollingIdx` query parameter.
-The `Subscription` value of this parameter is mapped to Majordomo's `Subscription` method,
-while an integer value will activate the `LongPoll` method.
+ - `Next`: Redirects to the next notification message that arrives after the request has been processed.
+ - `Last`: Redirects to the most recent notification message that is in the cache when the request is
+ processed. If there is no such entry yet, it's treated like `Next`, i.e. waits for the next notification.
+ - a positive integer value, to retrieve a specific cache entry.
diff --git a/src/client/include/RestClientEmscripten.hpp b/src/client/include/RestClientEmscripten.hpp
@@ -303,19 +303,18 @@ class RestClient : public ClientBase {
         emscripten_fetch_attr_t attr;
         emscripten_fetch_attr_init(&attr);
 
-        std::string body(cmd.data.asString());
+        auto payload  = std::make_unique<detail::FetchPayload>(std::move(cmd));
+        attr.userData = payload.get();
 
-        if (cmd.command == opencmw::mdp::Command::Set) {
+        if (payload->command.command == opencmw::mdp::Command::Set) {
             strcpy(attr.requestMethod, "POST");
-            attr.requestData     = reinterpret_cast<const char *>(body.data());
+            auto body            = payload->command.data.asString();
+            attr.requestData     = body.data();
             attr.requestDataSize = body.size();
         } else {
             strcpy(attr.requestMethod, "GET");
         }
 
-        auto payload  = std::make_unique<detail::FetchPayload>(std::move(cmd));
-        attr.userData = payload.get();
-        detail::fetchPayloads.insert(std::move(payload));
         static auto getPayload = [](emscripten_fetch_t *fetch) {
             auto *rawPayload = fetch->userData;
             auto  it         = detail::fetchPayloads.find(rawPayload);
@@ -339,8 +338,8 @@ class RestClient : public ClientBase {
 
         // TODO: Pass the payload as POST body: emscripten_fetch(&attr, uri.relativeRef()->data());
 
-        const auto uri = URI<>::factory(cmd.topic).addQueryParameter("_bodyOverride", body).build();
-        emscripten_fetch(&attr, uri.str().data());
+        emscripten_fetch(&attr, payload->command.topic.str().data());
+        detail::fetchPayloads.insert(std::move(payload));
     }
 
     void startSubscription(Command &&cmd) {
diff --git a/src/client/include/RestClientNative.hpp b/src/client/include/RestClientNative.hpp
@@ -63,8 +63,9 @@ struct SharedQueue {
 
 struct RequestResponse {
     // request data
-    client::Command request;
-    std::string     normalizedTopic;
+    client::Command           request;
+    std::unique_ptr<IoBuffer> body;
+    std::string               normalizedTopic;
 
     // response data
     std::string                  responseStatus;
@@ -168,11 +169,6 @@ struct ClientSessionBase {
     }
 
     void submitRequest(client::Command &&cmd, SubscriptionMode mode, std::string preferredMimeType, std::optional<std::uint64_t> longPollIdx) {
-        auto topic = cmd.topic;
-        if (cmd.command == mdp::Command::Set) {
-            topic = URI<>::UriFactory(topic).addQueryParameter("_bodyOverride", std::string{ cmd.data.asString() }).build();
-        }
-
         std::string longPollIdxParam;
         if (longPollIdx) {
             longPollIdxParam = std::to_string(*longPollIdx);
@@ -188,6 +184,8 @@ struct ClientSessionBase {
                 break;
             }
         }
+
+        auto topic = cmd.topic;
         if (!longPollIdxParam.empty()) {
             topic = URI<>::UriFactory(topic).addQueryParameter("LongPollingIdx", longPollIdxParam).build();
         }
@@ -199,10 +197,13 @@ struct ClientSessionBase {
         const auto ts = std::to_string(opencmw::load_test::timestamp().count());
 #endif
         constexpr uint8_t noCopy  = NGHTTP2_NV_FLAG_NO_COPY_NAME | NGHTTP2_NV_FLAG_NO_COPY_VALUE;
+
+        const auto        method  = (cmd.command == mdp::Command::Set) ? u8span("POST") : u8span("GET");
+
         auto              headers = std::vector{
-            nv(u8span(":method"), u8span("GET"), noCopy), //
-            nv(u8span(":path"), u8span(path)),            //
-            nv(u8span(":scheme"), u8span(scheme)),        //
+            nv(u8span(":method"), method, noCopy), //
+            nv(u8span(":path"), u8span(path)),     //
+            nv(u8span(":scheme"), u8span(scheme)), //
             nv(u8span(":authority"), u8span(host)),
 #ifdef OPENCMW_PROFILE_HTTP
             nv(u8span("x-timestamp"), u8span(ts))
@@ -212,9 +213,6 @@ struct ClientSessionBase {
             headers.push_back(nv(u8span("accept"), u8span(preferredMimeType)));
             headers.push_back(nv(u8span("content-type"), u8span(preferredMimeType)));
         }
-        if (cmd.command == mdp::Command::Set) {
-            headers.push_back(nv(u8span("x-opencmw-method"), u8span("PUT"), noCopy));
-        }
 
         RequestResponse rr;
         rr.request = std::move(cmd);
@@ -224,7 +222,12 @@ struct ClientSessionBase {
             rr.normalizedTopic = rr.request.topic.str();
         }
 
-        const TStreamId streamId = self().submitRequestImpl(headers);
+        if (!rr.request.data.empty()) {
+            // we need a pointer that survives rr being moved
+            rr.body = std::make_unique<IoBuffer>(std::move(rr.request.data));
+        }
+
+        const TStreamId streamId = self().submitRequestImpl(headers, rr.body.get());
         if (streamId < 0) {
             rr.reportError(std::format("Could not submit request: {}", nghttp2_strerror(streamId)));
             return;
@@ -486,8 +489,25 @@ struct Http2ClientSession : public ClientSessionBase<Http2ClientSession, int32_t
         return _socket._state == TcpSocket::Connected ? _writeBuffer.wantsToWrite(_session) : (_socket._state == TcpSocket::Connecting || _socket._state == TcpSocket::SSLConnectWantsWrite);
     }
 
-    int32_t submitRequestImpl(const std::vector<nghttp2_nv> &headers) {
-        auto streamId = nghttp2_submit_request(_session, nullptr, headers.data(), headers.size(), nullptr, nullptr);
+    int32_t submitRequestImpl(const std::vector<nghttp2_nv> &headers, IoBuffer *body) {
+        nghttp2_data_provider2 data_prd;
+        data_prd.read_callback = nullptr;
+
+        if (body && !body->empty()) {
+            data_prd.source.ptr    = body;
+            data_prd.read_callback = [](nghttp2_session *, int32_t /*stream_id*/, uint8_t *buf, size_t length, uint32_t *data_flags, nghttp2_data_source *source, void * /*user_data*/) {
+                auto              ioBuffer = static_cast<IoBuffer *>(source->ptr);
+                const std::size_t copy_len = std::min(length, ioBuffer->size() - ioBuffer->position());
+                std::copy(ioBuffer->data() + ioBuffer->position(), ioBuffer->data() + ioBuffer->position() + copy_len, buf);
+                ioBuffer->skip(static_cast<int>(copy_len));
+                if (ioBuffer->position() == ioBuffer->size()) {
+                    *data_flags |= NGHTTP2_DATA_FLAG_EOF;
+                }
+                return static_cast<ssize_t>(copy_len);
+            };
+        }
+
+        auto streamId = nghttp2_submit_request2(_session, nullptr, headers.data(), headers.size(), &data_prd, nullptr);
         if (streamId < 0) {
             HTTP_DBG("Client::submitRequest: nghttp2_submit_request failed: {}", nghttp2_strerror(streamId));
         }
diff --git a/src/client/test/pre.js b/src/client/test/pre.js
@@ -38,8 +38,8 @@ if (typeof XMLHttpRequest === 'undefined') {
                     // Set the additional headers
                     //res.setHeader('Access-Control-Allow-Origin', '127.0.0.1,localhost');
                     res.setHeader('Keep-Alive', 'timeout=5, max=5');
-                    res.setHeader('X-OPENCMW-SERVICE-NAME', 'dns');
-                    res.setHeader('X-OPENCMW-TOPIC', '//s?signal_type=&signal_unit=&signal_name=&service_type=&service_name=&port=-1&hostname=&protocol=&signal_rate=nan&contextType=application%2Foctet-stream');
+                    res.setHeader('x-opencmw-service-name', 'dns');
+                    res.setHeader('x-opencmw-topic', '//s?signal_type=&signal_unit=&signal_name=&service_type=&service_name=&port=-1&hostname=&protocol=&signal_rate=nan&contextType=application%2Foctet-stream');
 
                     // Send the binary response
                     const binaryData = Buffer.from('ffffffff040000005961530001000000602f0da036000000e4010000250000006f70656e636d773a3a736572766963653a3a646e733a3a466c6174456e7472794c69737400ff988e0ac51a000000150000000900000070726f746f636f6c00010000000100000001000000050000006874747000ff335c21ee1a0000002100000009000000686f73746e616d650001000000010000000100000011000000746573742e6578616d706c652e636f6d006881983400160000001000000005000000706f72740001000000010000000100000039050000ffd55573151e000000150000000d000000736572766963655f6e616d6500010000000100000001000000050000007465737400ff846a76151e000000110000000d000000736572766963655f74797065000100000001000000010000000100000000ffc2ad1b281d000000160000000c0000007369676e616c5f6e616d650001000000010000000100000005000000746573743100ffbb0c1f281d000000110000000c0000007369676e616c5f756e69740001000000010000000100000001000000006a17801d281d000000100000000c0000007369676e616c5f726174650001000000010000000100000000007a44ff71c21e281d000000110000000c0000007369676e616c5f74797065000100000001000000010000000100000000fe602f0da03600000000000000250000006f70656e636d773a3a736572766963653a3a646e733a3a466c6174456e7472794c69737400', 'hex');
diff --git a/src/majordomo/include/majordomo/RestServer.hpp b/src/majordomo/include/majordomo/RestServer.hpp
@@ -260,8 +260,7 @@ enum class RestMethod {
 
 inline RestMethod parseMethod(std::string_view methodString) {
     using enum RestMethod;
-    return methodString == "POLL" ? LongPoll
-         : methodString == "PUT"  ? Post
+    return methodString == "PUT"  ? Post
          : methodString == "POST" ? Post
          : methodString == "GET"  ? Get
                                   : Invalid;
@@ -585,7 +584,6 @@ struct SessionBase {
 
         std::string      path;
         std::string_view method;
-        std::string_view xOpencmwMethod;
 
         for (const auto &[name, value] : request.rawHeaders) {
             if (name == ":path") {
@@ -596,8 +594,6 @@ struct SessionBase {
                 request.contentType = value;
             } else if (name == "accept") {
                 request.accept = value;
-            } else if (name == "x-opencmw-method") {
-                xOpencmwMethod = value;
             }
         }
 
@@ -630,8 +626,6 @@ struct SessionBase {
                 } else if (qkey == "SubscriptionContext") {
                     request.topic           = mdp::Topic::fromMdpTopic(URI<>(qvalue.value_or("")));
                     haveSubscriptionContext = true;
-                } else if (qkey == "_bodyOverride") {
-                    request.payload = qvalue.value_or("");
                 } else {
                     if (qvalue) {
                         factory = std::move(factory).addQueryParameter(qkey, qvalue.value());
@@ -652,9 +646,6 @@ struct SessionBase {
             return;
         }
 
-        if (request.method == RestMethod::Invalid && !xOpencmwMethod.empty()) {
-            request.method = parseMethod(xOpencmwMethod);
-        }
         if (request.method == RestMethod::Invalid) {
             request.method = parseMethod(method);
         }
