fix(rest): make sure basePath is included in RestServer.url

[raymondfeng]

RestServer.url does not reflect basePath. The problem can be reproduced by adding basePath: '/api' to examples/todo/index.js and run npm build:

The url is printed as http://127.0.0.1:3000, which returns 404. I think the url should include the basePath, i.e., 'http://127.0.0.1:3000/api'.

See #2554 (comment)

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• API Documentation in code was updated
• Documentation in /docs/site was updated
• Affected artifact templates in packages/cli were updated
• Affected example projects in examples/* were updated

[bajtos]

I wish we had a TSDoc comment for the url property to make it clear what is the expected value. The property was added by @hacksparrow in 18b3408. @hacksparrow do you remember what was your intention for adding this property and whether it's ok to include basePath?

@raymondfeng please add a new test (or more) to directly and explicitly verify the behavior of url property when basePath is set. See the test added by 18b3408 to packages/rest/test/integration/rest.server.integration.ts, I think new tests should be added to the same place.

Personally, I'd create a new describe block to group all url-related tests.

describe('RestServer (integration)', () => {
  describe('url', () => {
    it('provides URL of the server'); // the existing test
    it('includes basePath when set'); // a new test to add
  });
  // no changes in other tests
});

[hacksparrow]

@bajtos I added as a way to access this._httpServer.url. Don't remember adding any functionality based around it.

[bajtos]

The change looks much better now! Let's do few more improvements though.

[bajtos]

👏