Add macOS split tunneling GUI #6277

raksooo · 2024-05-24T09:17:50Z

This PR adds the macOS split tunneling GUI. It looks the same as Windows.

Added dependencies:

simple-plist (https://socket.dev/npm/package/simple-plist)

This change is

linear · 2024-05-24T09:17:53Z

DES-786 Implement macOS split tunneling GUI

gui/src/main/macos-split-tunneling.ts

dlon

Reviewed 5 of 5 files at r1, 1 of 1 files at r2, 7 of 9 files at r3, 6 of 8 files at r4, 4 of 6 files at r5, 2 of 2 files at r6, all commit messages.
Reviewable status: 21 of 22 files reviewed, 13 unresolved discussions (waiting on @MrChocolatine and @raksooo)

gui/src/main/index.ts line 73 at r3 (raw file):

// Only import split tunneling library on correct OS.
const linuxSplitTunneling = process.platform === 'linux' && require('./linux-split-tunneling');
const splitTunneling: ISplitTunnelingAppListRetriever | undefined = importSplitTunneling();

Add a comment clarifying that this is used for Windows and macOS, maybe?

gui/src/main/macos-split-tunneling.ts line 38 at r7 (raw file):

    // Update cache if requested or if cache is empty.
    if (updateCaches || this.applicationCache.isEmpty()) {
      fromCache = false;

Same as below.

gui/src/main/windows-split-tunneling.ts line 71 at r3 (raw file):

  private additionalShortcuts: ShortcutDetails[] = [];
  // Finds applications by searching through the startmenu for shortcuts with and exe-file as target.
  // If applicationPaths has a value, the returned applications are only the ones corresponding to

applicationPaths is no longer present.

gui/src/main/windows-split-tunneling.ts line 80 at r3 (raw file):

    let fromCache = true;
    if (updateCaches || cacheIsEmpty) {
      fromCache = false;

let fromCache = !updateCaches && !cacheIsEmpty;
if (!fromCache) {

Code quote:

    let fromCache = true;
    if (updateCaches || cacheIsEmpty) {
      fromCache = false;

gui/src/renderer/components/SplitTunnelingSettings.tsx line 506 at r2 (raw file):

      <StyledListContainer>
        <List
          items={props.applications.sort((a, b) => a.name.localeCompare(b.name))}

Sorting can probably be removed in linux-split-tunneling.ts and windows-split-tunneling.ts now.

gui/src/renderer/components/SplitTunnelingSettings.tsx line 321 at r7 (raw file):

    if (fromCache) {
      const { applications } = await getSplitTunnelingApplications(true);

Why call getSplitTunnelingApplications() once and then again if fromCache is true? This seems like a roundabout way of always calling getSplitTunnelingApplications(true).

gui/src/shared/application-types.ts line 37 at r7 (raw file):

  /**
   * Returns an ISplitTunnelingApplication object containing the metadata related to the provided

Nit: Does it not return an array of ISplitTunnelingApplication objects?

gui/test/e2e/setup/main.ts line 177 at r7 (raw file):

      navigationHistory: undefined,
      scrollPositions: {},
      isMacOs13OrNewer: true,

Should this be hardcoded to true? We still test on macOS 12.

dlon

Reviewed 1 of 1 files at r7.
Reviewable status: all files reviewed, 13 unresolved discussions (waiting on @MrChocolatine and @raksooo)

dlon

Reviewable status: all files reviewed, 15 unresolved discussions (waiting on @MrChocolatine and @raksooo)

gui/src/main/macos-split-tunneling.ts line 37 at r7 (raw file):

    // Update cache if requested or if cache is empty.
    if (updateCaches || this.applicationCache.isEmpty()) {

Does updateCaches imply that this.applicationCache should be cleared?

gui/src/main/macos-split-tunneling.ts line 40 at r7 (raw file):

      fromCache = false;

      const applicationBundlePaths = await this.findApplicationBundlePaths();

Not too important, but I suspect that this could be simplified. For example, "additional applications" don't need to be contained in the cache, and deletable could be implied by "(only) present in additionalApplications".

Would it be possible to remove getApplication and just replace this with

    this.applicationCache = await this.findExecutablePaths();
}

// return this.applicationCache + this.additionalApplications

?

gui/src/main/macos-split-tunneling.ts

raksooo

Reviewable status: 18 of 23 files reviewed, 10 unresolved discussions (waiting on @dlon and @MrChocolatine)

gui/src/main/index.ts line 73 at r3 (raw file):