feat: Add a helper method to simulate low-memory event

lib/commands/memory.js

@@ -0,0 +1,39 @@
+import {errors} from 'appium/driver';
+import {mixin} from './mixins';
+
+/**
+ * @type {import('./mixins').MemoryMixin & ThisType<import('../driver').AndroidDriver>}
+ * @satisfies {import('@appium/types').ExternalDriver}
+ */
+const MemoryMixin = {
+  /**
+   * Simulates the onTrimMemory() event for the given package.
+   * Read https://developer.android.com/topic/performance/memory
+   * for more details.
+   *
+   * @param {import('./types').SendTrimMemoryOpts} opts
+   */
+  async mobileSendTrimMemory(opts) {
+    const {
+      pkg,
+      level,
+    } = opts;
+
+    if (!pkg) {
+      throw new errors.InvalidArgumentError(`The 'pkg' argument must be provided`);
+    }
+    if (!level) {
+      throw new errors.InvalidArgumentError(`The 'level' argument must be provided`);
+    }
+
+    await this.adb.shell(['am', 'send-trim-memory', pkg, level]);
+  },
+};
+
+mixin(MemoryMixin);
+
+export default MemoryMixin;
+
+/**
+ * @typedef {import('appium-adb').ADB} ADB
+ */

lib/commands/mixins.ts

@@ -927,6 +927,10 @@ export interface DeviceidleMixin {
   mobileDeviceidle(opts: types.DeviceidleOpts): Promise<void>;
 }
 
+export interface MemoryMixin {
+  mobileSendTrimMemory(opts: types.SendTrimMemoryOpts): Promise<void>;
+}
+
 declare module '../driver' {
   interface AndroidDriver
     extends ActionsMixin,
@@ -953,6 +957,7 @@ declare module '../driver' {
       StreamScreenMixin,
       SystemBarsMixin,
       DeviceidleMixin,
+      MemoryMixin,
       TouchMixin {}
 }
 

lib/commands/types.ts

@@ -1101,6 +1101,13 @@ export interface DeviceidleOpts {
   packages?: string|string[];
 }
 
+export interface SendTrimMemoryOpts {
+  /** The package name to send the `trimMemory` event to */
+  pkg: string;
+  /** The actual memory trim level to be sent */
+  level: 'COMPLETE' | 'MODERATE' | 'BACKGROUND' | 'UI_HIDDEN' | 'RUNNING_CRITICAL' | 'RUNNING_LOW' | 'RUNNING_MODERATE';
+}
+
 export interface SetUiModeOpts {
   /**
    * The UI mode to set the value for.