Fixed issue #243 and improved Auto Join #256

Zyvoxi · 2024-07-03T19:01:06Z

Fixes for the issue #243

Zyvoxi · 2024-07-04T16:05:41Z

Ready for review

Zyvoxi · 2024-07-04T16:07:30Z

All these changes should make the Auto Join work correctly.

Zyvoxi · 2024-07-05T19:01:34Z

After many tests, it is now truly ready for review.

williambj1

Hi, thanks again for the contribution. Please address the comments.

williambj1 · 2024-07-08T12:13:27Z

HeliPort/Appearance/StatusMenu.swift

        DispatchQueue.global().async {
-            CredentialsManager.instance.setAutoJoin(ssid, false)


Please correct me if I'm wrong, I did recall this is what Apple's implementation used to do back in the days - manually disconnecting a network will opt-out from auto-join, although this is not what the latest macOS versions are doing.

You are correct. Apple’s implementation used to work this way: manually disconnecting from a network would remove it from auto-join. However, more recent versions of macOS no longer follow this behavior; Apple made this change to improve user experience by reducing the need to manually reconfigure network preferences.

Would you prefer to keep this behavior of automatically disabling autojoin when the user disconnects? I think this behavior is not very interesting and many users may not like this behavior. If you prefer to keep this behavior, I think it would be better to add an option in the preferences to activate and deactivate this behavior.

williambj1 · 2024-07-08T12:29:40Z

HeliPort/NetworkManager.swift

@@ -59,7 +59,6 @@ final class NetworkManager {
            if let savedNetworkAuth = CredentialsManager.instance.get(networkInfo) {
                networkInfo.auth = savedNetworkAuth
                Log.debug("Connecting to network \(networkInfo.ssid) with saved password")
-                CredentialsManager.instance.setAutoJoin(networkInfo.ssid, true)


I’m not certain if this is what Apple’s implementation used to do back in the days (feels unlikely and doesn't match with the current implementation). This is the root cause of #243.

williambj1 · 2024-07-08T12:30:43Z

HeliPort/Appearance/StatusMenu.swift

@@ -43,6 +46,11 @@ final class StatusMenu: NSMenu, NSMenuDelegate {

            statusItem.title = NSLocalizedString(status.description)

+            if status != ITL80211_S_RUN && previousStatus == ITL80211_S_RUN && !isDisconnecting {
+                disassociateSSID(disconnectItem)
+                NetworkManager.scanSavedNetworks()


Currently we're only performing auto-join when HeliPort is initially launched. Users might want to temporarily disconnect while keeping WiFi enabled. Apple’s approach supports this (likely to maintain BSSID-based location services). Although there’s minimal justification for us to replicate this behavior aside from consistency with Apple (aligns with user habits and expectations) and allowing users to view the network list while disconnected. See #133.

williambj1 · 2024-07-08T12:31:02Z

HeliPort/Appearance/StatusMenu.swift

@@ -43,6 +46,11 @@ final class StatusMenu: NSMenu, NSMenuDelegate {

            statusItem.title = NSLocalizedString(status.description)

+            if status != ITL80211_S_RUN && previousStatus == ITL80211_S_RUN && !isDisconnecting {


The conditions here are not robust enough. For example, in OpenIntelWireless/itlwm#934 (comment) the router requests a reassociation. If we caught this event, we might mistakenly disconnect from the current network.

Many other factors might cause a change in state as well, such as firmware crash (goes directly back to S_INIT, no intervention from HeliPort required, itlwm will recover by itself), key expiring (-> S_AUTH), etc. The idea is to have our own state adapt and tolerate well with itlwm's internal state.

williambj1 · 2024-07-08T12:37:00Z

HeliPort/Appearance/StatusMenu.swift

@@ -30,9 +30,12 @@ final class StatusMenu: NSMenu, NSMenuDelegate {
    private var networkListUpdateTimer: Timer?
    private var statusUpdateTimer: Timer?

+    private var isDisconnecting: Bool = false


I'm guessing this flag is to prevent race conditions? Justification will be appreciated.

This flag serves so that when the user manually disconnects from the network, the condition on line +49 will not attempt to disconnect again and will not call NetworkManager.scanSavedNetworks(), thus allowing the user to remain disconnected.

williambj1 · 2024-07-08T12:37:49Z

HeliPort/Appearance/StatusMenu.swift

+            DispatchQueue.main.asyncAfter(deadline: .now() + 2.0) {
+                self.isDisconnecting = false
+                Log.debug("Disconnected from \(ssid)")
+            }


Justification required here as well.

These lines serve so that when the user disconnects, the isDisconnecting flag will be true for 2 seconds, thereby preventing the condition on line +49 from attempting to disconnect again and calling NetworkManager.scanSavedNetworks(). This allows the user to remain disconnected, as when isDisconnecting is true, the condition always returns false and does not execute what is inside it.

Zyvoxi · 2024-07-09T23:09:14Z

HeliPort/Appearance/StatusMenu.swift

+            if status == ITL80211_S_RUN {
+                disassociateSSID(disconnectItem)
+            }


When connected, it will disconnect from the current network before turning off the Wi-Fi, thus preventing it from connecting to a network with auto-join disabled when Wi-Fi is turned on (if the previously connected network has auto-join disabled).

With the changes made to .turnWiFiOn and .turnWiFiOff, it behaves the same as Apple's implementation, at least in more recent versions of macOS, as I'm not sure if the same happens in earlier versions.

Zyvoxi · 2024-07-09T23:10:25Z

HeliPort/Appearance/StatusMenu.swift

@@ -435,7 +435,11 @@ final class StatusMenu: NSMenu, NSMenuDelegate {
            }
        case .turnWiFiOn:
            power_on()
+            NetworkManager.scanSavedNetworks()


When the Wi-Fi is turned on, it will attempt to auto-join.

Zyvoxi added 2 commits July 3, 2024 15:53

Update NetworkManager.swift

53201c6

Update StatusMenu.swift

ef86893

Zyvoxi changed the title ~~Fix issue #243~~ Fix issue: [Bug] Auto join preference not saved Jul 3, 2024

Zyvoxi changed the title ~~Fix issue: [Bug] Auto join preference not saved~~ Fix issue: [Bug] Auto join preference not saved(#243) Jul 3, 2024

Zyvoxi changed the title ~~Fix issue: [Bug] Auto join preference not saved(#243)~~ Fixed the issue: [Bug] Auto join preference not saved(#243) Jul 3, 2024

Zyvoxi added 6 commits July 3, 2024 23:52

Merge branch 'OpenIntelWireless:master' into patch-4

31c0c6a

Ensure the functionality of AutoJoin

aad4a90

Fixed my oversight.

8c981b3

Fixed my oversight. Again.

ec2069e

Small changes

821695e

Fix comment

9b2a712

Zyvoxi marked this pull request as draft July 4, 2024 15:42

Auto Join should work perfectly now.

b855c86

Zyvoxi marked this pull request as ready for review July 4, 2024 16:05

Zyvoxi added 3 commits July 4, 2024 13:14

Update StatusMenu.swift

53fb4f3

Update StatusMenu.swift

48ce0ec

Removed changes that are no longer necessary.

4b9b68e

Zyvoxi changed the title ~~Fixed the issue: [Bug] Auto join preference not saved(#243)~~ Fixed issue: (#243) and improved Auto Join Jul 4, 2024

Zyvoxi changed the title ~~Fixed issue: (#243) and improved Auto Join~~ Fixed issue #243 and improved Auto Join Jul 4, 2024

Zyvoxi added 2 commits July 4, 2024 17:49

Fixed a small bug

cb41bb4

Update StatusMenu.swift

c366676

williambj1 requested changes Jul 8, 2024

View reviewed changes

Zyvoxi added 2 commits July 9, 2024 19:45

Update StatusMenu.swift

ba47c0e

Merge branch 'OpenIntelWireless:master' into patch-4

0376e95

Zyvoxi commented Jul 9, 2024

View reviewed changes

Zyvoxi requested a review from williambj1 July 9, 2024 23:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed issue #243 and improved Auto Join #256

Fixed issue #243 and improved Auto Join #256

Zyvoxi commented Jul 3, 2024 •

edited

Loading

Zyvoxi commented Jul 4, 2024

Zyvoxi commented Jul 4, 2024

Zyvoxi commented Jul 5, 2024

williambj1 left a comment

williambj1 Jul 8, 2024

Zyvoxi Jul 8, 2024

Zyvoxi Jul 9, 2024

williambj1 Jul 8, 2024

williambj1 Jul 8, 2024

williambj1 Jul 8, 2024

williambj1 Jul 8, 2024

Zyvoxi Jul 8, 2024

williambj1 Jul 8, 2024

Zyvoxi Jul 8, 2024

Zyvoxi Jul 9, 2024

Zyvoxi Jul 9, 2024

Zyvoxi Jul 9, 2024

		DispatchQueue.global().async {
		CredentialsManager.instance.setAutoJoin(ssid, false)

		@@ -43,6 +46,11 @@ final class StatusMenu: NSMenu, NSMenuDelegate {

		statusItem.title = NSLocalizedString(status.description)

		if status != ITL80211_S_RUN && previousStatus == ITL80211_S_RUN && !isDisconnecting {

Fixed issue #243 and improved Auto Join #256

Are you sure you want to change the base?

Fixed issue #243 and improved Auto Join #256

Conversation

Zyvoxi commented Jul 3, 2024 • edited Loading

Zyvoxi commented Jul 4, 2024

Zyvoxi commented Jul 4, 2024

Zyvoxi commented Jul 5, 2024

williambj1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Zyvoxi commented Jul 3, 2024 •

edited

Loading