fix(api-gateway): Allow querying time dimensions with custom granularity

[LFischerstrom]

Check List

• Tests has been run in packages where changes made if available
• Linter has been run for changed code
• Tests for the changes have been added if not covered yet
• Docs have been added / updated if required

It's possible to query time dimensions with granularity as a normal dimension but queries with quarter were rejected.

[igorlukanin]

Thanks @LFischerstrom 🙌

Honestly, I didn't even know this is possible to query dimensions like this:

I feel like we'd at least need a test for this.

[LFischerstrom]

@igorlukanin Ok, it's documented here https://cube.dev/docs/product/apis-integrations/rest-api/query-format

It also claims to support custom granularities which I think would rejected by the input validation.

[igorlukanin]

Yeah, you're right:

In the case of a dimension of the time type, a granularity could be optionally added to the name, in the following format: cube_name.time_dimension_name.granularity_name, e.g., stories.time.week. It can be one of the default granularities (e.g., year or week) or a custom granularity.

And I think you're also right wrt custom granularities. I wonder what is the best fix to that. A wildcard match? I bet @KSDaemon definitely has an opinion on this.

[KSDaemon]

@LFischerstrom Let's update it like this. So it will support all granularities :)

It would be awesome if you can add a test for querying time dimension with some granulaties. It should not be hard. Have a look at https://github.com/cube-js/cube/blob/master/packages/cubejs-api-gateway/test/index.test.ts#L306-L339 as example. We just need to check that query is allowed by api qateway.

[LFischerstrom]

Thanks @KSDaemon, will look into adding a tests

[LFischerstrom]

@KSDaemon I'm trying to run the tests locally but it's not working. Are there any instructions that I should follow for setting up the repo to be able to run the tests?

[KSDaemon]

@LFischerstrom Hi! Hm.... Nothing special is required. What tests are you trying to run? What package?
Btw, I see lint fails, you can fix lint errors with yarn run lint:fix in root.

[KSDaemon]

@LFischerstrom Try to follow the commands described in https://github.com/cube-js/cube/blob/master/CONTRIBUTING.md#cube-server

Probably not all required, but at least:

• yarn install
• yarn build
• yarn tsc
  To build/transpile all the code

[LFischerstrom]

Thanks, I tried to running yarn build instead of yarn tsc. After using tsc it worked.

[LFischerstrom]

@KSDaemon Alright, the tests pass for me so if you think the new test looks good I think this is ready.

[KSDaemon]

👍🏻 I think this looks good! @LFischerstrom Thank you for adding the tests!