May 22, 2023 · May 11, 2023 · May 12, 2023 · May 12, 2023 · May 12, 2023 · May 12, 2023
diff --git a/site/src/contexts/ProxyContext.test.tsx b/site/src/contexts/ProxyContext.test.tsx
      <div data-testid="isLoading" title={isLoading.toString()}></div>
      <div
        data-testid="preferredProxy"
        title={proxy.selectedProxy && proxy.selectedProxy.id}
        title={proxy.proxy && proxy.proxy.id}
      ></div>
      <div data-testid="userProxy" title={userProxy && userProxy.id}></div>
      <button data-testid="clearProxy" onClick={clearProxy}></button>

 describe("ProxyContextSelection", () => {
  beforeEach(() => {
    // Object.defineProperty(window, "localStorage", { value: localStorageMock })
    window.localStorage.clear()
  })

diff --git a/site/src/contexts/ProxyContext.tsx b/site/src/contexts/ProxyContext.tsx
 }

 interface PreferredProxy {
  //selectedProxy is the preferred proxy being used. It is provided for
  //proxy is the proxy being used. It is provided for
  // getting the fields such as "display_name" and "id"
  // Do not use the fields 'path_app_url' or 'wildcard_hostname' from this
  // object. Use the preferred fields.
 selectedProxy: Region | undefined
 proxy: Region | undefined
  // PreferredPathAppURL is the URL of the proxy or it is the empty string
  // to indicate using relative paths. To add a path to this:
  //  PreferredPathAppURL + "/path/to/app"

  // As the proxies are being loaded, default to using the saved proxy.
  // If the saved proxy is not valid when the async fetch happens, the
  // selectedProxy will be updated accordingly.
  let defaultPreferredProxy: PreferredProxy = {
    selectedProxy: savedProxy,
    preferredPathAppURL: savedProxy?.path_app_url.replace(/\/$/, "") || "",
    preferredWildcardHostname: savedProxy?.wildcard_hostname || "",
  }
  // proxy will be updated accordingly.
  let defaultPreferredProxy = computeUsableURLS(savedProxy)

  if (!savedProxy) {
    // If no preferred proxy is saved, then default to using relative paths
    // and no subdomain support until the proxies are properly loaded.
 }

 /**
 *getURLs is a helper function to calculate the urls to use for a given proxy configuration. By default, it is
 *getPreferredProxy is a helper function to calculate the urls to use for a given proxy configuration. By default, it is
 * assumed no proxy is configured and relative paths should be used.
 * Exported for testing.
 *
 * @param proxies Is the list of proxies returned by coderd. If this is empty, default behavior is used.
 * @param selectedProxy Is the proxythe user has selected. If this is undefined, default behavior is used.
 * @param selectedProxy Is the proxysaved in local storage. If this is undefined, default behavior is used.
 * @param latencies If provided, this is used to determine the best proxy to default to.
 *                  If not, `primary` is always the best default.
 */
  selectedProxy?: Region,
  latencies?: Record<string, ProxyLatencyReport>,
 ): PreferredProxy => {
  // By default we set the path app to relative and disable wildcard hostnames.
  // We will set these values if we find a proxy we can use that supports them.
  let pathAppURL = ""
  let wildcardHostname = ""

  // If a proxy is selected, make sure it is in the list of proxies. If it is not
  // we should default to the primary.
  selectedProxy = proxies.find(
    }
  }

  // Only use healthy proxies.
  if (selectedProxy && selectedProxy.healthy) {
  return computeUsableURLS(selectedProxy)
 }

 const computeUsableURLS = (proxy?: Region): PreferredProxy => {
  if (!proxy) {
    // By default use relative links for the primary proxy.
    // This is the default, and we should not change it.
    if (selectedProxy.name !== "primary") {
      pathAppURL = selectedProxy.path_app_url
    return {
      proxy: undefined,
      preferredPathAppURL: "",
      preferredWildcardHostname: "",
    }
    wildcardHostname = selectedProxy.wildcard_hostname
  }

  // TODO: @emyrk Should we notify the user if they had an unhealthy proxy selected?
  let pathAppURL = proxy?.path_app_url.replace(/\/$/, "")
  // Primary proxy uses relative paths. It's the only exception.
  if (proxy.name === "primary") {
    pathAppURL = ""
  }

  return {
 selectedProxy: selectedProxy,
 proxy: proxy,
    // Trim trailing slashes to be consistent
    preferredPathAppURL: pathAppURL.replace(/\/$/, ""),
    preferredWildcardHostname:wildcardHostname,
    preferredPathAppURL: pathAppURL,
    preferredWildcardHostname:proxy.wildcard_hostname,
  }
 }

diff --git a/site/src/pages/TerminalPage/TerminalPage.test.tsx b/site/src/pages/TerminalPage/TerminalPage.test.tsx
            value={{
              proxyLatencies: MockProxyLatencies,
              proxy: {
 selectedProxy: MockPrimaryWorkspaceProxy,
 proxy: MockPrimaryWorkspaceProxy,
                preferredPathAppURL: "",
                preferredWildcardHostname: "",
              },
diff --git a/site/src/pages/UserSettingsPage/WorkspaceProxyPage/WorkspaceProxyPage.tsx b/site/src/pages/UserSettingsPage/WorkspaceProxyPage/WorkspaceProxyPage.tsx
        isLoading={proxiesLoading}
        hasLoaded={proxiesFetched}
        getWorkspaceProxiesError={proxiesError}
        preferredProxy={proxy.selectedProxy}
        preferredProxy={proxy.proxy}
        onSelect={(proxy) => {
          if (!proxy.healthy) {
            displayError("Please select a healthy workspace proxy.")
Original file line number	Diff line number	Diff line change
Expand Up		@@ -146,7 +146,7 @@ const TestingScreen = () => {
		<div data-testid="isLoading" title={isLoading.toString()}></div>
		<div
		data-testid="preferredProxy"
		title={proxy.selectedProxy && proxy.selectedProxy.id}
		title={proxy.proxy && proxy.proxy.id}
		></div>
		<div data-testid="userProxy" title={userProxy && userProxy.id}></div>
		<button data-testid="clearProxy" onClick={clearProxy}></button>
Expand DownExpand Up		@@ -187,7 +187,6 @@ interface ProxyContextSelectionTest {

		describe("ProxyContextSelection", () => {
		beforeEach(() => {
		// Object.defineProperty(window, "localStorage", { value: localStorageMock })
		window.localStorage.clear()
		})

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -58,11 +58,11 @@ export interface ProxyContextValue {
		}

		interface PreferredProxy {
		//selectedProxy is the preferred proxy being used. It is provided for
		//proxy is the proxy being used. It is provided for
		// getting the fields such as "display_name" and "id"
		// Do not use the fields 'path_app_url' or 'wildcard_hostname' from this
		// object. Use the preferred fields.
		selectedProxy: Region \| undefined
		proxy: Region \| undefined
		// PreferredPathAppURL is the URL of the proxy or it is the empty string
		// to indicate using relative paths. To add a path to this:
		// PreferredPathAppURL + "/path/to/app"
Expand All		@@ -86,12 +86,9 @@ export const ProxyProvider: FC<PropsWithChildren> = ({ children }) => {

		// As the proxies are being loaded, default to using the saved proxy.
		// If the saved proxy is not valid when the async fetch happens, the
		// selectedProxy will be updated accordingly.
		let defaultPreferredProxy: PreferredProxy = {
		selectedProxy: savedProxy,
		preferredPathAppURL: savedProxy?.path_app_url.replace(/\/$/, "") \|\| "",
		preferredWildcardHostname: savedProxy?.wildcard_hostname \|\| "",
		}
		// proxy will be updated accordingly.
		let defaultPreferredProxy = computeUsableURLS(savedProxy)

		if (!savedProxy) {
		// If no preferred proxy is saved, then default to using relative paths
		// and no subdomain support until the proxies are properly loaded.
Expand DownExpand Up		@@ -206,12 +203,12 @@ export const useProxy = (): ProxyContextValue => {
		}

		/**
		*getURLs is a helper function to calculate the urls to use for a given proxy configuration. By default, it is
		*getPreferredProxy is a helper function to calculate the urls to use for a given proxy configuration. By default, it is
		* assumed no proxy is configured and relative paths should be used.
		* Exported for testing.
		*
		* @param proxies Is the list of proxies returned by coderd. If this is empty, default behavior is used.
		* @param selectedProxy Is the proxythe user has selected. If this is undefined, default behavior is used.
		* @param selectedProxy Is the proxysaved in local storage. If this is undefined, default behavior is used.
		* @param latencies If provided, this is used to determine the best proxy to default to.
Emyrk marked this conversation as resolved. Show resolvedHide resolved
		* If not, `primary` is always the best default.
		*/
Expand All		@@ -220,11 +217,6 @@ export const getPreferredProxy = (
		selectedProxy?: Region,
		latencies?: Record<string, ProxyLatencyReport>,
		): PreferredProxy => {
		// By default we set the path app to relative and disable wildcard hostnames.
		// We will set these values if we find a proxy we can use that supports them.
		let pathAppURL = ""
		let wildcardHostname = ""

		// If a proxy is selected, make sure it is in the list of proxies. If it is not
		// we should default to the primary.
		selectedProxy = proxies.find(
Expand DownExpand Up		@@ -263,23 +255,31 @@ export const getPreferredProxy = (
		}
		}

		// Only use healthy proxies.
		if (selectedProxy && selectedProxy.healthy) {
		return computeUsableURLS(selectedProxy)
		}

		const computeUsableURLS = (proxy?: Region): PreferredProxy => {
Emyrk marked this conversation as resolved. Show resolvedHide resolved
		if (!proxy) {
		// By default use relative links for the primary proxy.
		// This is the default, and we should not change it.
		if (selectedProxy.name !== "primary") {
		pathAppURL = selectedProxy.path_app_url
		return {
		proxy: undefined,
		preferredPathAppURL: "",
		preferredWildcardHostname: "",
		}
		wildcardHostname = selectedProxy.wildcard_hostname
		}

		// TODO: @emyrk Should we notify the user if they had an unhealthy proxy selected?
		let pathAppURL = proxy?.path_app_url.replace(/\/$/, "")
		// Primary proxy uses relative paths. It's the only exception.
		if (proxy.name === "primary") {
		pathAppURL = ""
		}

		return {
		selectedProxy: selectedProxy,
		proxy: proxy,
		// Trim trailing slashes to be consistent
		preferredPathAppURL: pathAppURL.replace(/\/$/, ""),
		preferredWildcardHostname:wildcardHostname,
		preferredPathAppURL: pathAppURL,
		preferredWildcardHostname:proxy.wildcard_hostname,
		}
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -46,7 +46,7 @@ const renderTerminal = () => {
		value={{
		proxyLatencies: MockProxyLatencies,
		proxy: {
		selectedProxy: MockPrimaryWorkspaceProxy,
		proxy: MockPrimaryWorkspaceProxy,
		preferredPathAppURL: "",
		preferredWildcardHostname: "",
		},
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,7 +36,7 @@ export const WorkspaceProxyPage: FC<PropsWithChildren<unknown>> = () => {
		isLoading={proxiesLoading}
		hasLoaded={proxiesFetched}
		getWorkspaceProxiesError={proxiesError}
		preferredProxy={proxy.selectedProxy}
		preferredProxy={proxy.proxy}
		onSelect={(proxy) => {
		if (!proxy.healthy) {
		displayError("Please select a healthy workspace proxy.")
Expand Down