feat: add method to get a base URL, allow to pass remote base

[Antreesy]

PR is adding:

• getBaseUrl method to get the current instance;
• UrlOptions.remoteBase to alter base URL in server request (if needed).

I'd say, there are most prominent use-cases which I see:

• nextcloud-vue (to check for internal links);
• Talk Federation (connecting to remote server with local credentials).

Tests:

getBaseUrl()
generateOcsUrl('apps/spreed/api/v4/room/{token}', { token: 'sfbhcekd' })
generateOcsUrl('apps/spreed/api/v4/room/{token}', { token: 'sfbhcekd' }, { remoteBase: 'https://remote.base.com' })

[ShGKme]

New option is defined for

• generateUrl
• generateOcsUrl

But implementation only covers:

• generateOcsUrl

[Antreesy]

• generateUrl

This method doesn't have a base part, so I assume, it's not applicable here?

nextcloud-router/lib/index.ts

Lines 101 to 111 in e3c586b

	export const generateUrl = (url: string, params?: object, options?: UrlOptions) => {
	const allOptions = Object.assign({
	noRewrite: false
	}, options || {})
	if (window?.OC?.config?.modRewriteWorking === true && !allOptions.noRewrite) {
	return getRootUrl() + _generateUrlPath(url, params, options);
	}
	return getRootUrl() + '/index.php' + _generateUrlPath(url, params, options);
	}

[nickvergessen]

This method doesn't have a base part, so I assume, it's not applicable here?

But you need to overwrite getRootUrl() ?

What about generateRemoteUrl and linkToRemoteBase for attachment handling?

[Antreesy]

But you need to overwrite getRootUrl() ?

getBaseUrl already includes getRootUrl as suffix (at the end of string). But in places, where only root is used, we need to consider it somehow, you're right

What about generateRemoteUrl and linkToRemoteBase for attachment handling?

These methods are not affected by current changes.
We don't have yet a precedent, there it is needed, but if there is a necessity to connect to remote 'dav' service, then yes, I could modify it as well.

UPD: Covered now, I beleive

[skjnldsv]

remoteBase seems confusing to me.
It looks like we're talking about remote.php 😬

Do you have any other ideas for this variable name?

[nickvergessen]

federation?

[skjnldsv]

Or proxy something as a reverse proxy is a pretty standard concept.

[Antreesy]

I'd call it as it actually should be called, baseURL, like here, but this name is already used by Axios as one of the request options, and I'm afraid of interfering

[skjnldsv]

baseURL seems to be the same as our use case?
Let's go for this?

[Antreesy]

Let's go for this?

Tested, won't be a problem, unless you pass a relative URL to axios request

[susnux]

@Antreesy looks good to me, could you rebase and maybe add tests for the changed behavior?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (571c42f) 97.28% compared to head (bec5dd4) 97.54%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #558      +/-   ##
==========================================
+ Coverage   97.28%   97.54%   +0.25%     
==========================================
  Files           1        1              
  Lines         221      244      +23     
  Branches       33       36       +3     
==========================================
+ Hits          215      238      +23     
  Misses          5        5              
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.