Modified DocumentMapper to use ServiceUrlProvider for generating document self links

[pekka-ia]

This allows for relative urls (by emptying crnk.domain-name) and also improves configurability in situations where the system runs behind a proxy.

Fixes #789

[pekka-ia]

Taking another look at this, there was something odd with the behaviour in tests vs. behaviour in use.

[pekka-ia]

I think I have a solid fix now. Instead of attempting to use ServiceUrlProvider, using requestContext.getBaseUrl() seems to yield exactly the same results and it doesn't break functionality within reactive context.

When the below config is applied:

crnk.domain-name: ""

then

GET http://localhost:21120/api/incentive-programs?fields[incentive-programs]=name

{
    "data": [
        {
            "links": {
                "self": "/api/incentive-programs/8377ecb2-d516-4ee1-9fd3-259c54a9119f"
            }
            // rest of the object
        }
    ],
    "links": {
        "self": "/api/incentive-programs?fields[incentive-programs]=name"
    }
}

With an explicit domain set, it looks like this:

crnk.domain-name: "https://www.nbc.com"

GET http://localhost:21120/api/incentive-programs?fields[incentive-programs]=name

{
    "data": [
        {
            "links": {
                "self": "https://www.nbc.com/api/incentive-programs/a2081411-5961-4841-8570-6d538ad51f11"
            }
            // rest of the object
        }
    ],
    "links": {
        "self": "https://www.nbc.com/api/incentive-programs?fields[incentive-programs]=name"
    }
}

and with no domain-name configuration set at all, it still works as expected

GET http://localhost:21120/api/incentive-programs?fields[incentive-programs]=name
{
    "data": [
        {
            "links": {
                "self": "http://localhost:21120/api/incentive-programs/bf871ce6-8f25-45c9-ae69-71823bbef46b"
            }
            // rest of the object
        }
    ],
    "links": {
        "self": "http://localhost:21120/api/incentive-programs?fields[incentive-programs]=name"
    }
}

[remmeier]

It is a bit a dangerous area for changes because of the variety of integrations (servlet, etc.). Where have you seen that reqestUri != baseUrl + path? Because that would be wrong and in need for fixing. There might be other places where reqestUri is used and also breaks.

[pekka-ia]

Finally got back to this. Basically there is similar behaviour here:

https://github.com/crnk-project/crnk-framework/blob/master/crnk-core/src/main/java/io/crnk/core/engine/internal/registry/ResourceRegistryImpl.java#L117-L120

https://github.com/crnk-project/crnk-framework/blob/master/crnk-core/src/main/java/io/crnk/core/engine/internal/registry/ResourceRegistryImpl.java#L143-L147

where QueryContext is the source of the baseUrl.

[vicmosin]

@remmeier Can we please merge this change? I need self link to be generated based on ServiceUrlProvider as well

[remmeier]

what isnwring with the request uri? maybe a fix should be applied there if necessary. currently the code is inconsitent, having null check for resourceuri, but does not make use it.

[vicmosin]

@pekka-ia are you gonna provide the changes @remmeier asked for?

[pekka-ia]

@pekka-ia are you gonna provide the changes @remmeier asked for?

I don't think I can currently do it. I don't have a good environment for doing Java development currently (this PR was opened while I was working for my former employer). :/