feat: fail if major performance caveat (#587)

* do not fail silently

* normalize error reporting

* Update packages/unity-interface/initializer.ts

* Update packages/unity-interface/initializer.ts

Co-authored-by: Mateo Miccino <mateomiccino@gmail.com>

Author: menduz

packages/entryPoints/index.ts

@@ -3,7 +3,7 @@ declare const globalThis: { DecentralandKernel: IDecentralandKernel }
 import { sdk } from '@dcl/schemas'
 import { createLogger } from 'shared/logger'
 import { IDecentralandKernel, IEthereumProvider, KernelOptions, KernelResult, LoginState } from '@dcl/kernel-interface'
-import { BringDownClientAndShowError, ErrorContext, ReportFatalError } from 'shared/loading/ReportFatalError'
+import { ErrorContext, BringDownClientAndReportFatalError } from 'shared/loading/ReportFatalError'
 import { renderingInBackground, renderingInForeground } from 'shared/loading/types'
 import { gridToWorld, worldToGrid } from '../atomicHelpers/parcelScenePositions'
 import {
@@ -120,8 +120,7 @@ globalThis.DecentralandKernel = {
     setTimeout(
       () =>
         initInternal().catch((err) => {
-          ReportFatalError(err, ErrorContext.WEBSITE_INIT)
-          BringDownClientAndShowError(err.toString())
+          BringDownClientAndReportFatalError(err, ErrorContext.WEBSITE_INIT)
         }),
       0
     )
@@ -223,7 +222,7 @@ async function loadWebsiteSystems(options: KernelOptions['kernelOptions']) {
   const profile = getCurrentUserProfile(store.getState())!
 
   if (!profile) {
-    ReportFatalError(new Error('Profile missing during unity initialization'), 'kernel#init')
+    BringDownClientAndReportFatalError(new Error('Profile missing during unity initialization'), 'kernel#init')
     return
   }
 

packages/shared/analytics/types.ts

@@ -78,4 +78,6 @@ export type TrackEvents = PositionTrackEvents & {
   ['Control Friend deleted']: Record<string, never> // {}
   // TODO - the above metrics are reintroduced for control, remove asap - moliva - 2022/06/01
   ['Remote avatar for profile is invalid']: { avatar: Avatar }
+
+  ['pickedRealm']: { algorithm: string; domain: string }
 }

packages/shared/dao/pick-realm-algorithm/closePeers.ts

@@ -22,7 +22,7 @@ export function closePeersScoreLink({
     name: AlgorithmLinkTypes.CLOSE_PEERS_SCORE,
     pick: (context: AlgorithmContext) => {
       const score = defaultScoreAddons(latencyDeductionsParameters, baseScore, closeUsersScore(context.userParcel))
-      return selectFirstByScore(context, score, definitiveDecisionThreshold, true) // If we have less than 10 users of difference by default, we cannot make a definitive decision. It delegates to the next link
+      return selectFirstByScore(context, score, definitiveDecisionThreshold, true)
     }
   }
 }

packages/shared/dao/pick-realm-algorithm/defaults.ts

@@ -26,7 +26,8 @@ export const defaultAllPeersScoreConfig: AllPeersScoreParameters = {
   baseScore: 40,
   fillTargetPercentage: 0.5,
   discourageFillTargetPercentage: 0.8,
-  definitiveDecisionThreshold: 20,
+  // If we have less than 20 users of difference by default, we cannot make a definitive decision. It delegates to the next link
+  definitiveDecisionThreshold: 10,
   latencyDeductionsParameters: {
     exponentialDivisor: 900,
     multiplier: 60,

packages/shared/dao/pick-realm-algorithm/index.ts

@@ -6,6 +6,7 @@ import { largeLatencyLink } from './largeLatency'
 import { closePeersScoreLink } from './closePeers'
 import { allPeersScoreLink } from './allPeers'
 import { loadBalancingLink } from './loadBalancing'
+import { trackEvent } from 'shared/analytics'
 
 function buildLink(linkConfig: AlgorithmLinkConfig) {
   switch (linkConfig.type) {
@@ -65,6 +66,12 @@ export function createAlgorithm(config: AlgorithmChainConfig) {
         // If a link picks a particular candidate, we return that
         if (context.selected) {
           defaultLogger.log(`Picked candidate using algorithm link: ${link.name}`, context.selected)
+
+          trackEvent('pickedRealm', {
+            algorithm: link.name,
+            domain: context.selected.domain
+          })
+
           return context.selected
         }
 

packages/shared/dao/sagas.ts

@@ -24,12 +24,7 @@ import {
   getUpdateProfileServer
 } from './selectors'
 import { saveToPersistentStorage, getFromPersistentStorage } from '../../atomicHelpers/persistentStorage'
-import {
-  BringDownClientAndShowError,
-  ErrorContext,
-  ReportFatalErrorWithCatalystPayload
-} from 'shared/loading/ReportFatalError'
-import { CATALYST_COULD_NOT_LOAD } from 'shared/loading/types'
+import { BringDownClientAndReportFatalError } from 'shared/loading/ReportFatalError'
 import { gte } from 'semver'
 import { commsLogger } from 'shared/comms/context'
 import { parseParcelPosition } from 'atomicHelpers/parcelScenePositions'
@@ -120,8 +115,7 @@ export function* selectAndReconnectRealm() {
     // if no realm was selected, then do the whole initialization dance
   } catch (e: any) {
     debugger
-    ReportFatalErrorWithCatalystPayload(e, ErrorContext.KERNEL_INIT)
-    BringDownClientAndShowError(CATALYST_COULD_NOT_LOAD)
+    BringDownClientAndReportFatalError(e, 'comms#init')
     throw e
   }
 }

packages/shared/loading/ReportFatalError.ts

@@ -11,8 +11,8 @@ import { globalObservable } from '../observables'
 import { getUnityInstance } from 'unity-interface/IUnityInterface'
 import { store } from 'shared/store/isolatedStore'
 
-export function BringDownClientAndShowError(event: ExecutionLifecycleEvent) {
-  if (ExecutionLifecycleEventsList.includes(event)) {
+export function BringDownClientAndShowError(event: ExecutionLifecycleEvent | string) {
+  if (ExecutionLifecycleEventsList.includes(event as any)) {
     store.dispatch(action(event))
   }
 
@@ -51,12 +51,12 @@ export type ErrorContextTypes =
 
 export function ReportFatalErrorWithCatalystPayload(error: Error, context: ErrorContextTypes) {
   // TODO(Brian): Get some useful catalyst payload to append here
-  ReportFatalError(error, context)
+  BringDownClientAndReportFatalError(error, context)
 }
 
 export function ReportFatalErrorWithCommsPayload(error: Error, context: ErrorContextTypes) {
   // TODO(Brian): Get some useful comms payload to append here
-  ReportFatalError(error, context)
+  BringDownClientAndReportFatalError(error, context)
 }
 
 export function ReportFatalErrorWithUnityPayload(error: Error, context: ErrorContextTypes) {
@@ -69,18 +69,27 @@ export function ReportFatalErrorWithUnityPayload(error: Error, context: ErrorCon
     })
 }
 
-Object.assign(globalThis, { BringDownClientAndShowError, ReportFatalErrorWithUnityPayloadAsync, ReportFatalError })
+Object.assign(globalThis, {
+  BringDownClientAndShowError,
+  ReportFatalErrorWithUnityPayloadAsync,
+  ReportFatalError: BringDownClientAndReportFatalError,
+  BringDownClientAndReportFatalError
+})
 
 export async function ReportFatalErrorWithUnityPayloadAsync(error: Error, context: ErrorContextTypes) {
   try {
     const payload = await getUnityInstance().CrashPayloadRequest()
-    ReportFatalError(error, context, { rendererPayload: payload })
+    BringDownClientAndReportFatalError(error, context, { rendererPayload: payload })
   } catch (e) {
-    ReportFatalError(error, context)
+    BringDownClientAndReportFatalError(error, context)
   }
 }
 
-export function ReportFatalError(error: Error, context: ErrorContextTypes, payload: Record<string, any> = {}) {
+export function BringDownClientAndReportFatalError(
+  error: Error,
+  context: ErrorContextTypes,
+  payload: Record<string, any> = {}
+) {
   let sagaStack: string | undefined = payload['sagaStack']
 
   debugger

packages/shared/profiles/sagas.ts

@@ -38,8 +38,7 @@ import { fetchOwnedENS } from 'shared/web3'
 import { waitForRealmInitialized } from 'shared/dao/sagas'
 import { base64ToBuffer } from 'atomicHelpers/base64ToBlob'
 import { LocalProfilesRepository } from './LocalProfilesRepository'
-import { BringDownClientAndShowError, ErrorContext, ReportFatalError } from 'shared/loading/ReportFatalError'
-import { UNEXPECTED_ERROR } from 'shared/loading/types'
+import { ErrorContext, BringDownClientAndReportFatalError } from 'shared/loading/ReportFatalError'
 import { store } from 'shared/store/isolatedStore'
 import { createFakeName } from './utils/fakeName'
 import { getCommsContext } from 'shared/comms/selectors'
@@ -100,8 +99,7 @@ function* initialRemoteProfileLoad() {
   try {
     profile = yield call(ProfileAsPromise, userId, undefined, isGuest ? ProfileType.LOCAL : ProfileType.DEPLOYED)
   } catch (e: any) {
-    ReportFatalError(e, ErrorContext.KERNEL_INIT, { userId })
-    BringDownClientAndShowError(UNEXPECTED_ERROR)
+    BringDownClientAndReportFatalError(e, ErrorContext.KERNEL_INIT, { userId })
     throw e
   }
 

packages/shared/store/store.ts

@@ -4,7 +4,7 @@ import { createLogger } from 'redux-logger'
 import { reducers } from './rootReducer'
 import { createRootSaga } from './rootSaga'
 import { DEBUG_REDUX } from '../../config'
-import { BringDownClientAndShowError, ErrorContext, ReportFatalError } from '../loading/ReportFatalError'
+import { ErrorContext, BringDownClientAndReportFatalError } from '../loading/ReportFatalError'
 import defaultLogger from '../logger'
 import { setStore } from './isolatedStore'
 import { composeWithDevTools } from 'redux-devtools-extension'
@@ -17,8 +17,7 @@ export const buildStore = () => {
     sagaMonitor,
     onError: (error: Error, { sagaStack }: { sagaStack: string }) => {
       defaultLogger.log('SAGA-ERROR: ', error)
-      ReportFatalError(error, ErrorContext.KERNEL_SAGA, { sagaStack })
-      BringDownClientAndShowError(error.message as any)
+      BringDownClientAndReportFatalError(error, ErrorContext.KERNEL_SAGA, { sagaStack })
     }
   })
 

packages/unity-interface/initializer.ts

@@ -56,6 +56,30 @@ async function loadInjectedUnityDelegate(container: HTMLElement): Promise<UnityG
 
   const { originalUnity, engineStartedFuture } = await createWebRenderer(canvas)
 
+  const ctx: WebGL2RenderingContext = (originalUnity.Module as any).ctx
+
+  const debug_ext = ctx.getExtension('WEBGL_debug_renderer_info')
+  if (debug_ext) {
+    const renderer = ctx.getParameter(debug_ext.UNMASKED_RENDERER_WEBGL)
+    if (renderer.indexOf('SwiftShader') >= 0) {
+      throw new Error(
+        'Your browser is using an emulated software renderer (SwiftShader). This prevents Decentraland from working. This is usually fixed by restarting the computer. In any case, we recommend you to use the Desktop Client instead for a better overall experience. You can find it in https://decentraland.org/download'
+      )
+    }
+  }
+
+  canvas.addEventListener(
+    'webglcontextlost',
+    function (event) {
+      event.preventDefault()
+      BringDownClientAndShowError(
+        'The rendering engine failed. This is an unrecoverable error that is subject to the available memory and resources of your browser.\n' +
+          'For a better experience, we recommend using the Native Desktop Client. You can find it in https://decentraland.org/download'
+      )
+    },
+    false
+  )
+
   // TODO: move to unity-renderer js project
   originalUnity.Module.errorHandler = (message: string, filename: string, lineno: number) => {
     console['error'](message, filename, lineno)