undergroundwires/privacy.sexy

View on GitHub
src/presentation/electron/preload/ContextBridging/MethodContextBinder.ts

Summary

Maintainability
A
0 mins
Test Coverage
import {
  isArray, isFunction, isNullOrUndefined, isPlainObject,
} from '@/TypeHelpers';

/**
 * Binds method contexts to their original object instances and recursively processes
 * nested objects and arrays. This is particularly useful when exposing objects across
 * different contexts in Electron, such as from the main process to the renderer process
 * via the `contextBridge`.
 *
 * In Electron's context isolation environment, methods of objects passed through the
 * `contextBridge` lose their original context (`this` binding). This function ensures that
 * each method retains its binding to its original object, allowing it to work as intended
 * when invoked from the renderer process.
 *
 * This approach decouples context isolation concerns from class implementations, enabling
 * classes to operate normally without needing explicit binding or arrow functions to maintain
 * the context.
 */
export function bindObjectMethods<T>(obj: T): T {
  if (isNullOrUndefined(obj)) {
    return obj;
  }
  if (isPlainObject(obj)) {
    bindMethodsOfObject(obj);
    Object.values(obj).forEach((value) => {
      if (!isNullOrUndefined(value) && !isFunction(value)) {
        bindObjectMethods(value);
      }
    });
  } else if (isArray(obj)) {
    obj.forEach((item) => bindObjectMethods(item));
  }
  return obj;
}

function bindMethodsOfObject<T>(obj: T): T {
  const prototype = Object.getPrototypeOf(obj);
  if (!prototype) {
    return obj;
  }
  Object.getOwnPropertyNames(prototype).forEach((property) => {
    if (!prototype.hasOwnProperty.call(obj, property)) {
      return; // Skip properties not directly on the prototype
    }
    const value = obj[property];
    if (isFunction(value)) {
      (obj as object)[property] = value.bind(obj);
    }
  });
  return obj;
}