chore(client): use application errors instead of PlatformErrors

client/src/www/app/app.ts

@@ -17,7 +17,7 @@
 
 import {Clipboard} from './clipboard';
 import {EnvironmentVariables} from './environment';
 import {localizeErrorCode} from './error_localizer';
 import * as config from './outline_server_repository/config';
 import {Settings, SettingsKey} from './settings';
 import {Updater} from './updater';
@@ -330,10 +330,6 @@
       buttonHandler = () => {
         this.showErrorDetailsDialog(error.details);
       };
-    } else if (error instanceof PlatformError) {
-      toastMessage = localizeErrorCode(error.code, this.localize);
-      buttonMessage = this.localize('error-details');
-      buttonHandler = () => this.showErrorDetailsDialog(error.toString());
     } else {
       const hasErrorDetails = Boolean(error.message || error.cause);
       toastMessage = this.localize('error-unexpected');

client/src/www/app/main.cordova.ts

@@ -31,15 +31,11 @@ import {installDefaultMethodChannel, MethodChannel} from './method_channel';
 import {VpnApi} from './outline_server_repository/vpn';
 import {CordovaVpnApi} from './outline_server_repository/vpn.cordova';
 import {OutlinePlatform} from './platform';
-import {
-  OUTLINE_PLUGIN_NAME,
-  pluginExec,
-  pluginExecWithErrorCode,
-} from './plugin.cordova';
+import {OUTLINE_PLUGIN_NAME, pluginExec} from './plugin.cordova';
 import {AbstractUpdater} from './updater';
 import * as interceptors from './url_interceptor';
 import {NoOpVpnInstaller, VpnInstaller} from './vpn_installer';
-import {PlatformError} from '../model/platform_error';
+import {ipcToAppError} from '../model/platform_error';
 import {SentryErrorReporter, Tags} from '../shared/error_reporter';
 
 const hasDeviceSupport = cordova.platformId !== 'browser';
@@ -76,12 +72,12 @@ class CordovaErrorReporter extends SentryErrorReporter {
 }
 
 class CordovaMethodChannel implements MethodChannel {
-  invokeMethod(methodName: string, params: string): Promise<string> {
+  async invokeMethod(methodName: string, params: string): Promise<string> {
     try {
-      return pluginExecWithErrorCode('invokeMethod', methodName, params);
+      return await pluginExec('invokeMethod', methodName, params);
     } catch (e) {
       console.debug('invokeMethod failed', methodName, e);
-      throw PlatformError.parseFrom(e);
+      throw ipcToAppError(e);
     }
   }
 }

client/src/www/app/main.electron.ts

@@ -28,7 +28,7 @@ import {AbstractUpdater} from './updater';
 import {UrlInterceptor} from './url_interceptor';
 import {VpnInstaller} from './vpn_installer';
 import {ErrorCode, OutlinePluginError} from '../model/errors';
-import {PlatformError} from '../model/platform_error';
+import {ipcToAppError} from '../model/platform_error';
 import {
   getSentryBrowserIntegrations,
   OutlineErrorReporter,
@@ -137,7 +137,7 @@ class ElectronMethodChannel implements MethodChannel {
         params
       );
     } catch (e) {
-      throw PlatformError.parseFrom(e);
+      throw ipcToAppError(e);
     }
   }
 }

client/src/www/app/plugin.cordova.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {PlatformError} from '../model/platform_error';
+import {ipcToAppError} from '../model/platform_error';
 
 export const OUTLINE_PLUGIN_NAME = 'OutlinePlugin';
 
@@ -30,6 +30,6 @@ export async function pluginExecWithErrorCode<T>(
   try {
     return await pluginExec<T>(cmd, ...args);
   } catch (e) {
-    throw PlatformError.parseFrom(e);
+    throw ipcToAppError(e);
   }
 }

client/src/www/model/platform_error.ts

@@ -14,6 +14,12 @@
 
 import {CustomError} from '@outline/infrastructure/custom_error';
 
+import * as errors from './errors';
+
+// TODO(fortuna): Remove PlatformError from the model.
+// PlatformError is an implementation detail. It does not belong in the model.
+// It's also about serialization, we should not use it in application code.
+
 /**
  * @fileoverview This file defines types and constants corresponding to the backend Go's
  * `platerrors` package. It will be used to receive native errors from Go, eventually replacing
@@ -80,35 +86,6 @@ function convertRawErrorObjectToPlatformError(rawObj: object): PlatformError {
   return new PlatformError(code, rawObj.message, options);
 }
 
-/**
- * Recursively converts a {@link PlatformError} into a raw JavaScript object that
- * could be converted into a JSON string.
- * @param {PlatformError} platErr Any non-null PlatformError.
- * @returns {object} A plain JavaScript object that can be converted to JSON.
- */
-function convertPlatformErrorToRawErrorObject(platErr: PlatformError): object {
-  const rawObj: {
-    code: string;
-    message: string;
-    details?: ErrorDetails;
-    cause?: object;
-  } = {
-    code: platErr.code,
-    message: platErr.message,
-    details: platErr.details,
-  };
-  if (platErr.cause) {
-    let cause: PlatformError;
-    if (platErr.cause instanceof PlatformError) {
-      cause = platErr.cause;
-    } else {
-      cause = new PlatformError(INTERNAL_ERROR, String(platErr.cause));
-    }
-    rawObj.cause = convertPlatformErrorToRawErrorObject(cause);
-  }
-  return rawObj;
-}
-
 /**
  * ErrorDetails represents the details map of a {@link PlatformError}.
  * The keys in this map are strings, and the values can be of any data type.
@@ -216,14 +193,31 @@ export class PlatformError extends CustomError {
     }
     return result;
   }
+}
 
-  /**
-   * Returns a JSON string of this error with all details and causes.
-   * @returns {string} The JSON string representing this error.
-   */
-  toJSON(): string {
-    const errRawObj = convertPlatformErrorToRawErrorObject(this);
-    return JSON.stringify(errRawObj);
+/**
+ * ipcToAppError converts an Error returned from the MethodChannel IPC to an application error.
+ * MethodChannel errors encode its information as a JSON object in the Error message.
+ */
+export function ipcToAppError(ipcError: Error): CustomError {
+  const platError = convertRawErrorObjectToPlatformError(
+    JSON.parse(ipcError.message)
+  );
+  let options = undefined as {cause?: Error};
+  if (platError.cause instanceof Error) {
+    options = {cause: platError.cause};
+  }
+  switch (platError.code) {
+    case FETCH_CONFIG_FAILED:
+      return new errors.SessionConfigFetchFailed(platError.message, options);
+    case ILLEGAL_CONFIG:
+      return new errors.ServerAccessKeyInvalid(platError.message, options);
+    case PROXY_SERVER_UNREACHABLE:
+      return new errors.ServerUnreachable(platError.message, options);
+    case VPN_PERMISSION_NOT_GRANTED:
+      return new errors.VpnPermissionNotGranted(platError.message, options);
+    default:
+      return platError;
   }
 }
 
@@ -240,13 +234,12 @@ export type ErrorCode = string;
 
 export const INTERNAL_ERROR: ErrorCode = 'ERR_INTERNAL_ERROR';
 
-export const FETCH_CONFIG_FAILED: ErrorCode = 'ERR_FETCH_CONFIG_FAILURE';
-export const ILLEGAL_CONFIG: ErrorCode = 'ERR_ILLEGAL_CONFIG';
+const FETCH_CONFIG_FAILED: ErrorCode = 'ERR_FETCH_CONFIG_FAILURE';
+const ILLEGAL_CONFIG: ErrorCode = 'ERR_ILLEGAL_CONFIG';
 
-export const VPN_PERMISSION_NOT_GRANTED = 'ERR_VPN_PERMISSION_NOT_GRANTED';
+const VPN_PERMISSION_NOT_GRANTED = 'ERR_VPN_PERMISSION_NOT_GRANTED';
 
-export const PROXY_SERVER_UNREACHABLE: ErrorCode =
-  'ERR_PROXY_SERVER_UNREACHABLE';
+const PROXY_SERVER_UNREACHABLE: ErrorCode = 'ERR_PROXY_SERVER_UNREACHABLE';
 
 /** Indicates that the OS routing service is not running (electron only). */
 export const ROUTING_SERVICE_NOT_RUNNING = 'ERR_ROUTING_SERVICE_NOT_RUNNING';