RFC: Retrieve LeagueClientUx.exe process info without WMI

[jlcarvalho]

RFC: Retrieve LeagueClientUx.exe process info without WMI

Summary

This RFC proposes adding the @tipspace/get-command-line package as an optional dependency into league-connect to retrieve the command line of the LeagueClientUx.exe process in cases where WMI is broken or unavailable.

Motivation

Currently, league-connect uses WMI to retrieve command line information of LeagueClientUx.exe, but in cases where WMI is broken or unavailable, both, Get-CimInstance and wmic will fail. We have over 200k players on Tipspace and WMI is broken for about 1% of them. Because of that, I created a package written in Rust to retrieve command line string manually, getting the process infos from memory using native Windows DLLs. This package is heavely inspired by LeagueAkari's C++ implementation.

We're already using it at Tipspace by retrieving the command line string, parsing it (using a duplicate code from League Connect) and then authenticating in League Connect using the credentials object.

Detailed Design

Prerequisites

• Ensure that the project has Node.js (>= 18.x) installed.

Installation

To install the package as an optional dependency, run:

yarn add @tipspace/get-command-line --optional
# or
npm install @tipspace/get-command-line --save-optional

Usage

try {
  const { getProcessCommandLine } = await import('@tipspace/get-command-line');
  const commandLine = getProcessCommandLine('LeagueClientUx.exe');
  console.log(`Command Line: ${commandLine}`);
} catch (err) {
  console.error(`Error: ${err.message}`);
}

Drawbacks

• Because this package creates a native node module, some build environments may need to include the native modules manually. But, since the package would be a optional dependency, this shouldn't be an issue.

[junlarsen]

Thanks for taking the initiative on this!

I'm personally a little skeptical to directly depend on native module code (I believe you have good intentions, but it's harder for end users of the package to trust its behavior), but I'm still not against the idea.

Would it maybe be easier to allow the user to pass a custom getProcessCommandLine function to the options, where we could state that tipspace has a package that works well? Otherwise fallback to wmic etc?

What do you think?

[jlcarvalho]

I like the approach. That way people can use the package/code that they trust more or are more familiar with.

Works for us. I'll change my PR to reflect your suggestion.

[jlcarvalho]

I updated the PR #125, should be ok now.