Add support for non-pretty URLs

[cboulanger]

Hi, I am just evaluating your library, to replace the no-longer maintained cranetm/yii2-json-rpc-2.0.

I am running functional tests with codeception, making the JSORPC calls to the backend.

Unfortunately, I haven't been successful yet, I am getting Method georgique\\yii2\\jsonrpc\\Action::run() does not exist without any usable stack trace.

Do you have an idea what could be wrong?

[cboulanger]

Looking through the source, I can see that in https://github.com/georgique/yii2-jsonrpc/blob/master/JsonRpcRequest.php#L157 , the route is re-parsed even though the method has already been determined. If I replace $routeParsed with $route in https://github.com/georgique/yii2-jsonrpc/blob/master/JsonRpcRequest.php#L187 , the error goes away (I have a different error now, but that's a different question). Why would you call the action on the original route, which is to the JsonRpcController instead of on the new route that is parsed from the JsonRpc method call?

[georgique]

Hi @cboulanger, I don't think your conclusion is correct. Line 157 is needed for splitting the route from query parameters, so can't really say it's "reparsed". Would you be able to show values for your $routeParsed and $route at the moment of line 187 execution?

[cboulanger]

Hi, thanks for looking into this! Here's a screenshot of my IDE - I am using my fork which replaces $routeParsed with $route(because it wouldn't work otherwise). Thw screenshot shows the content of both variables: $routeParsed (incorrectly) contains /json-rpc, whereas $route (correctly) contains access/username.

[cboulanger]

It might have something to do that these are codeception functional tests that work without a webserver. But they should work anyways. Can you explain what $routeParsed is supposed to contain that is not already in $route? Because I couldn't figure that out...

[georgique]

@cboulanger Basically $routeParsed has to contain URI before "?" mark. I.e. for $route = "user/view?id=1", $routeParsed should become "user/view" and $params should become ['id' = 1]. From the screenshot I can see that it doesn't work properly for you. I guess it's because of codeception. I would look into it, but would you be able to chare your codeception configuration so I can reproduce the problem on my side? Also please provide your Yii version.

[cboulanger]

ok, I think I have an idea what could be the problem. Since my Yii2 app is an API backend and not a html web application which shows the URL, I am not using pretty urls (domain.com/endpoint/json-rpc), but the simple domain.com/endpoint/?r=json-rpc configuration. I assume your jsonrpc implementation assumes a pretty url syntax ...

[cboulanger]

versions: yii ^2.0.32, codeception ^4.0, codeception config is here. But very likely the problem is the non-pretty-url stuff. I can try and enable it to see if the problem goes away.

[georgique]

Non-pretty urls explanation sounds like it. If you can try with pretty urls and let me know - that'd be helpful.

[cboulanger]

I just enabled pretty urls and after reverting the changes in my fork, my tests started to pass with your original code! It would be great if you could also support the "default URL format". I have one request to add a catch block for yii\web\UnauthorizedHttpException, I'll submit a PR for that.

[georgique]

@cboulanger I'll work on it. Will try to do as soon as possible

[cboulanger]

I am still having problems, even with pretty URLs turned on. This time using acceptance tests, where the codeception test suite makes a POST request to the web server. The JSONRPC method is correctly translated into $route, but $routeWithParams = $app->request->resolve(); then reverts to the /json-rpc Yii2 controller path. I still don't understand why you need to re-read the route from the original request when you already have it in $route? Unfortunately, I have to go back to my fork :-( which replaces $routeParsed with $route... I wonder what I am doing wrong.