[refactor]: INVITE_BASEURL does not meet the semantics in flat-web

[BlackHole1]

INVITE_BASEURL Does not meet the semantics

Originally posted by @BlackHole1 in #829 (comment)

https://github.com/netless-io/flat/pull/834/files#diff-80cd6ff40d48acb0207a9e0780233787449517800f219c43a5d83f1569b344d1R95

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[BlackHole1]

INVITE_BASEURL => WEB_DOMAIN

[LitoMore]

Not sure we support https://example.com/SUB_DIRECTORY/replay/ROOM_TYPE/ROOM_UUID/OWNER_UUID/ kind of link or not.

If we want to support this kind of URL, we should not name it to the domain. base_url is better.

BTW, I noticed we already have the constant FLAT_WEB_DOMAIN in https://github.com/netless-io/flat/blob/main/web/flat-web/src/constants/process.ts.

Use INVITATION_BASE_URL or INVITATION_ENDPOINT instead will be better, IMO.

[BlackHole1]

In #829, our requirement is to open the replay link, so using INVITATION/INVITE is not a good idea in this scenario.

This is because INVITE_BASEURL and FLAT_WEB_DOMAIN have a certain overlap.
Their domain names must be the same

see:

flat/config/.env.development

Lines 12 to 14 in a19b6be

	FLAT_SERVER_DOMAIN=flat-api-dev.whiteboard.agora.io
	UPDATE_DOMAIN=https://flat-storage.oss-cn-hangzhou.aliyuncs.com/versions
	FLAT_WEB_DOMAIN=flat-web-dev.whiteboard.agora.io

cc @LitoMore

[BlackHole1]

Should we only keep FLAT_WEB_DOMAIN? Or, keep FLAT_WEB_DOMAIN and give it a better name, e.g: WEB_DOMAIN?

[LitoMore]

The link https://{DOMAIN} with a protocol (https:) called URL or endpoint.

It's OK to use domain if it does not have the protocol part.

You could try this in Node.js REPL:

> new URL('https://exmaple.com:8080/test/test/file.ext')

The result will be:

URL {
  href: 'https://exmaple.com:8080/test/test/file.ext',
  origin: 'https://exmaple.com:8080',
  protocol: 'https:',
  username: '',
  password: '',
  host: 'exmaple.com:8080',
  hostname: 'exmaple.com',
  port: '8080',
  pathname: '/test/test/file.ext',
  search: '',
  searchParams: URLSearchParams {},
  hash: ''
}

The domain and the hostname are the same thing. Hope this helps you understand the URL.

[BlackHole1]

Thanks for the correction, that might be better called FLAT_WEB_ORIGIN / FLAT_WEB_URL / FLAT_WEB_BASE_URL?

[LitoMore]

The WEB_URL sounds like a full URL. Origin is only used for the HTTP regions, it's not a good choice for URL naming.

FALT_WEB_BASE_URL looks good.

[BlackHole1]

Good. Would anyone like to try and submit a PR for this issue? @netless-io/developers

[LitoMore]

OK, let me solve this.