feat: make ConnectivityListener configurable, and remove unnecessary network availability checks #1100

gkc · 2023-07-29T13:20:35Z

See analysis here which led to the changes in this PR

Eliminate direct use of InternetConnectivityChecker from at_client package except for a method in RemoteSecondary which (a) is unused and now marked @Deprecated and where (b) the usage is non-problematic (checks if atServer's host and port are reachable)
Eliminate wrapper class at_client.NetworkUtil and all its usages in at_client
Eliminate indirect (via at_client.ConnectivityListener) use of InternetConnectivityChecker from at_client package
For backwards compatibility, still exports ConnectivityListener (which is in use by multiple programs including sshnpd), but
- (a) adds optional constructor parameters which programs can use if they wish to continue to use ConnectivityListener
- (b) ConnectivityListener is marked deprecated as connectivity listening is not functionality which at_client should export

- What I did

- How I did it

- How to verify it
Tests pass

- Description for the changelog
feat: Make ConnectivityListener configurable by adding optional parameters to its constructor.
feat: Remove unnecessary use of network availability checks in various places

…etely unused)

refactor: refactored Monitor unit tests to depend on ability to create a connection rather than network availability

…workAvailable

…ing AtConnectExceptions where previously they relied on having calls to a mockNetworkUtil.isNetworkAvailable return false

…or existence of an atSign

…eImpl (not part of public interface of that class, only used for testing

…o ConnectivityListener constructor and use accordingly

cconstab

I hate that connectivity listener uses tcp rather than ICMP

cconstab · 2023-07-29T18:30:04Z

Another process wrap but well done

https://pub.dev/packages/dart_ping

And some discussion on the topic

dart-lang/sdk#33764

gkc · 2023-07-29T19:00:35Z

I hate that connectivity listener uses tcp rather than ICMP

ConnectivityListener is ours; it wraps InternetConnectivityChecker

Neither are being used by at_client any more so 🤷‍♂️

…gurable-network-checks # Conflicts: # packages/at_client/CHANGELOG.md

gkc · 2023-07-29T19:49:46Z

Another process wrap but well done

https://pub.dev/packages/dart_ping

And some discussion on the topic

dart-lang/sdk#33764

Now that at_client makes no use of it, I'd be happy to mark at_client's ConnectivityListener class as Deprecated and leave it to programs to use whatever they want to instead, since really it's nothing to do with AtClient

docs: update `@Deprecated` message for `RemoteSecondary.isAvailable`

- add direct dependency on asn1lib - pin versions for asnlib, crypton and encrypt packages

gkc · 2023-07-30T12:24:08Z

Checks currently failing because one of our cicd hosts is down

gkc · 2023-07-30T15:18:52Z

Checks complete thank you @cpswan

gkc · 2023-07-30T17:01:13Z

packages/at_client/lib/src/converters/encryption/aes_converter.dart

@@ -111,7 +111,8 @@ class AESDecryptionSink extends ChunkedConversionSink<List<int>> {

 IV getIV(String? ivBase64) {
  if (ivBase64 == null) {
-    return IV.fromLength(16);
+    // From the bad old days when we weren't setting IVs
+    return IV(Uint8List(16));


This change is a defensive measure to prevent the next release of the encrypt package from causing us problems, as the behaviour of IV.fromLength has changed

gkc · 2023-07-30T17:02:27Z

packages/at_client/lib/src/util/encryption_util.dart

@@ -12,7 +12,8 @@ class EncryptionUtil {

  static IV getIV(String? ivBase64) {
    if (ivBase64 == null) {
-      return IV.fromLength(16);
+      // From the bad old days when we weren't setting IVs
+      return IV(Uint8List(16));


This change is a defensive measure to prevent the next release of the encrypt package from causing us problems, as the behaviour of IV.fromLength has changed

cconstab · 2023-07-30T17:07:12Z

Everything works as expected thanks @gkc

cconstab

Tested by hand as well as via Ci/CD

gkc added 12 commits July 29, 2023 13:20

feat: deprecated RemoteSecondary.isAvailable() method (which is compl…

e1f3644

…etely unused)

feat: removed network availability check from Monitor

25a6a44

refactor: refactored Monitor unit tests to depend on ability to create a connection rather than network availability

feat: removed NotificationServiceImpl's use of ConnectivityListener

4fc4a46

feat: Remove SyncServiceImpl's unnecessary usage of NetworkUtil.isNet…

73efe60

…workAvailable

refactor: Make sync unit tests simulate atServer unreachable by throw…

3a3e342

…ing AtConnectExceptions where previously they relied on having calls to a mockNetworkUtil.isNetworkAvailable return false

feat: remove AtClientValidation.validateAtKey's unnecessary check f…

e05ddc2

…or existence of an atSign

feat: remove AtClientValidation.validateAtKey's unnecessary check f…

ae93b76

…or existence of an atSign

refactor: remove unused networkUtil instance variable from SyncServic…

f4144e5

…eImpl (not part of public interface of that class, only used for testing

refactor: remove unused NetworkUtil class and file network_util.dart

5358f45

feat: Add hostname, port and a checkInterval as optional parameters t…

1ce9264

…o ConnectivityListener constructor and use accordingly

style: ran dart format

1846ddd

build: update CHANGELOG, pubspec and AtClientConfig for 3.0.64

c7d804d

gkc marked this pull request as ready for review July 29, 2023 17:28

cconstab reviewed Jul 29, 2023

View reviewed changes

Merge remote-tracking branch 'origin/trunk' into gkc-fewer-more-confi…

a9998a8

…gurable-network-checks # Conflicts: # packages/at_client/CHANGELOG.md

refactor: remove unused stuff from remote_secondary_test.dart

e04b53e

docs: update `@Deprecated` message for `RemoteSecondary.isAvailable`

gkc requested a review from cconstab July 29, 2023 19:54

gkc added 2 commits July 30, 2023 12:22

build: software supply chain management

f6e6a84

- add direct dependency on asn1lib - pin versions for asnlib, crypton and encrypt packages

feat: Deprecate ConnectivityListener class

c5e9816

gkc mentioned this pull request Jul 30, 2023

Make use of Internet connection checker more configurable atsign-foundation/noports#292

Closed

gkc commented Jul 30, 2023

View reviewed changes

gkc requested a review from cpswan July 30, 2023 17:04

cconstab approved these changes Jul 30, 2023

View reviewed changes

Merge branch 'trunk' into gkc-fewer-more-configurable-network-checks

17502b2

gkc merged commit 65fb64b into trunk Aug 1, 2023

gkc mentioned this pull request Aug 1, 2023

feat: cease using internet_connection_checker atsign-foundation/noports#298

Merged

gkc deleted the gkc-fewer-more-configurable-network-checks branch February 4, 2024 11:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make ConnectivityListener configurable, and remove unnecessary network availability checks #1100

feat: make ConnectivityListener configurable, and remove unnecessary network availability checks #1100

gkc commented Jul 29, 2023 •

edited

Loading

cconstab left a comment

cconstab commented Jul 29, 2023 •

edited

Loading

gkc commented Jul 29, 2023

gkc commented Jul 29, 2023

gkc commented Jul 30, 2023

gkc commented Jul 30, 2023

gkc Jul 30, 2023

gkc Jul 30, 2023

cconstab commented Jul 30, 2023 •

edited

Loading

cconstab left a comment

feat: make ConnectivityListener configurable, and remove unnecessary network availability checks #1100

feat: make ConnectivityListener configurable, and remove unnecessary network availability checks #1100

Conversation

gkc commented Jul 29, 2023 • edited Loading

cconstab left a comment

Choose a reason for hiding this comment

cconstab commented Jul 29, 2023 • edited Loading

gkc commented Jul 29, 2023

gkc commented Jul 29, 2023

gkc commented Jul 30, 2023

gkc commented Jul 30, 2023

gkc Jul 30, 2023

Choose a reason for hiding this comment

gkc Jul 30, 2023

Choose a reason for hiding this comment

cconstab commented Jul 30, 2023 • edited Loading

cconstab left a comment

Choose a reason for hiding this comment

gkc commented Jul 29, 2023 •

edited

Loading

cconstab commented Jul 29, 2023 •

edited

Loading

cconstab commented Jul 30, 2023 •

edited

Loading