feat: add post method for the load endpoint (#982). Thanks to @RusovDmitriy

Author: RusovDmitriy

docs/Cube.js-Backend/REST-API.md

@@ -78,12 +78,23 @@ Response
 Example request:
 
 ```bash
+# Request with http method GET
 curl \
  -H "Authorization: EXAMPLE-API-TOKEN" \
  -G \
  --data-urlencode 'query={"measures":["Users.count"]}' \
  http://localhost:4000/cubejs-api/v1/load
-````
+
+# Request with http method POST
+# Use POST to fix problem with query length limits
+curl \
+ -X POST
+ -H "Content-Type: application/json" \
+ -H "Authorization: EXAMPLE-API-TOKEN" \
+ -G \
+ --data '{"query": {"measures":["Users.count"]}}' \
+ http://localhost:4000/cubejs-api/v1/load
+```
 
 Example response:
 

packages/cubejs-api-gateway/index.js

@@ -3,6 +3,7 @@ const R = require('ramda');
 const Joi = require('@hapi/joi');
 const moment = require('moment');
 const uuid = require('uuid/v4');
+const bodyParser = require('body-parser');
 
 const dateParser = require('./dateParser');
 const requestParser = require('./requestParser');
@@ -303,6 +304,15 @@ class ApiGateway {
       });
     }));
 
+    const jsonParser = bodyParser.json({ limit: '1mb' });
+    app.post(`${this.basePath}/v1/load`, jsonParser, this.requestMiddleware, (async (req, res) => {
+      await this.load({
+        query: req.body.query,
+        context: req.context,
+        res: this.resToResultFn(res)
+      });
+    }));
+
     app.get(`${this.basePath}/v1/subscribe`, this.requestMiddleware, (async (req, res) => {
       await this.load({
         query: req.query.query,

packages/cubejs-api-gateway/index.test.js

@@ -121,4 +121,23 @@ describe(`API Gateway`, () => {
 
     expect(res.body.query.order).toStrictEqual([{ id: 'Foo.bar', desc: false }, { id: 'Foo.foo', desc: true }]);
   });
+
+  test(`post http method for load route`, async () => {
+    const query = {
+      measures: ["Foo.bar"],
+      order: [
+        ['Foo.bar', 'asc'],
+        ['Foo.foo', 'desc']
+      ],
+    };
+    const res = await request(app)
+      .post(`/cubejs-api/v1/load`)
+      .set('Content-type', 'application/json')
+      .set('Authorization', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M')
+      .send({ query })
+      .expect(200);
+
+    expect(res.body.query.order).toStrictEqual([{ id: 'Foo.bar', desc: false }, { id: 'Foo.foo', desc: true }]);
+    expect(res.body.query.measures).toStrictEqual(["Foo.bar"]);
+  });
 });

packages/cubejs-api-gateway/package.json

@@ -18,6 +18,7 @@
   "types": "index.d.ts",
   "dependencies": {
     "@hapi/joi": "^15.1.1",
+    "body-parser": "^1.19.0",
     "chrono-node": "1.4.4",
     "jsonwebtoken": "^8.3.0",
     "moment": "^2.24.0",

packages/cubejs-api-gateway/yarn.lock

@@ -697,7 +697,7 @@ binary-extensions@^2.0.0:
   resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-2.1.0.tgz#30fa40c9e7fe07dbc895678cd287024dea241dd9"
   integrity sha512-1Yj8h9Q+QDF5FzhMs/c9+6UntbD5MkRfRwac8DoEm9ZfUBZ7tZ55YcGVAzEe4bXsdQHEk+s9S5wsOKVdZrw0tQ==
 
-body-parser@1.19.0:
+body-parser@1.19.0, body-parser@^1.19.0:
   version "1.19.0"
   resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.19.0.tgz#96b2709e57c9c4e09a6fd66a8fd979844f69f08a"
   integrity sha512-dhEPs72UPbDnAQJ9ZKMNTP6ptJaionhP5cBb541nXPlW60Jepo9RV/a4fX4XWW9CuFNK22krhrj1+rgzifNCsw==