From e14f630f916fb3306468b0a2ca0f38cfcb0541e3 Mon Sep 17 00:00:00 2001 From: Eric Seidel Date: Thu, 7 Sep 2023 07:38:15 -0700 Subject: [PATCH] refactor: move shorebird_code_push_io and _web into src/ (#75) * break: move shorebird_code_push_io and _web into src/ Users were sometimes importing the _web version thinking it was the "web safe" import, rather than shorebird_code_push.dart and then being surprised when ShorebirdCodePush did nothing. Fixes https://github.com/shorebirdtech/shorebird/issues/1209 * Update formating for Dart 3.1 --- shorebird_code_push/CHANGELOG.md | 6 +++ .../lib/shorebird_code_push.dart | 4 +- .../lib/src/generated/updater_bindings.g.dart | 53 +++++++++++-------- .../lib/{ => src}/shorebird_code_push_io.dart | 3 ++ .../{ => src}/shorebird_code_push_web.dart | 3 ++ .../test/shorebird_code_push_io_test.dart | 2 +- 6 files changed, 46 insertions(+), 25 deletions(-) rename shorebird_code_push/lib/{ => src}/shorebird_code_push_io.dart (93%) rename shorebird_code_push/lib/{ => src}/shorebird_code_push_web.dart (71%) diff --git a/shorebird_code_push/CHANGELOG.md b/shorebird_code_push/CHANGELOG.md index 67f3da4..2f96889 100644 --- a/shorebird_code_push/CHANGELOG.md +++ b/shorebird_code_push/CHANGELOG.md @@ -1,3 +1,9 @@ +# 1.2.0 +- break: `package:shorebird_code_push/shorebird_code_push_io.dart` and + `package:shorebird_code_push/shorebird_code_push_web.dart` have moved into + `src/` to discourage accidental direct import of these files. Please import + `package:shorebird_code_push/shorebird_code_push.dart` instead. + # 1.1.0 - feat: introduce `isShorebirdAvailable` to determine whether the Shorebird Engine is detected diff --git a/shorebird_code_push/lib/shorebird_code_push.dart b/shorebird_code_push/lib/shorebird_code_push.dart index eb0e5a9..60924c4 100644 --- a/shorebird_code_push/lib/shorebird_code_push.dart +++ b/shorebird_code_push/lib/shorebird_code_push.dart @@ -1,5 +1,5 @@ /// Get info about your Shorebird code push app library shorebird_code_push; -export 'shorebird_code_push_io.dart' - if (dart.library.html) 'shorebird_code_push_web.dart'; +export 'src/shorebird_code_push_io.dart' + if (dart.library.html) 'src/shorebird_code_push_web.dart'; diff --git a/shorebird_code_push/lib/src/generated/updater_bindings.g.dart b/shorebird_code_push/lib/src/generated/updater_bindings.g.dart index 55e528d..564c264 100644 --- a/shorebird_code_push/lib/src/generated/updater_bindings.g.dart +++ b/shorebird_code_push/lib/src/generated/updater_bindings.g.dart @@ -295,8 +295,9 @@ class UpdaterBindings { } late final _callocPtr = _lookup< - ffi.NativeFunction< - ffi.Pointer Function(ffi.Size, ffi.Size)>>('calloc'); + ffi + .NativeFunction Function(ffi.Size, ffi.Size)>>( + 'calloc'); late final _calloc = _callocPtr.asFunction Function(int, int)>(); @@ -356,8 +357,9 @@ class UpdaterBindings { } late final _aligned_allocPtr = _lookup< - ffi.NativeFunction< - ffi.Pointer Function(ffi.Size, ffi.Size)>>('aligned_alloc'); + ffi + .NativeFunction Function(ffi.Size, ffi.Size)>>( + 'aligned_alloc'); late final _aligned_alloc = _aligned_allocPtr.asFunction Function(int, int)>(); @@ -614,8 +616,9 @@ class UpdaterBindings { } late final _mblenPtr = _lookup< - ffi.NativeFunction< - ffi.Int Function(ffi.Pointer, ffi.Size)>>('mblen'); + ffi + .NativeFunction, ffi.Size)>>( + 'mblen'); late final _mblen = _mblenPtr.asFunction, int)>(); @@ -873,8 +876,9 @@ class UpdaterBindings { } late final _wctombPtr = _lookup< - ffi.NativeFunction< - ffi.Int Function(ffi.Pointer, ffi.WChar)>>('wctomb'); + ffi + .NativeFunction, ffi.WChar)>>( + 'wctomb'); late final _wctomb = _wctombPtr.asFunction, int)>(); @@ -942,8 +946,9 @@ class UpdaterBindings { } late final _erand48Ptr = _lookup< - ffi.NativeFunction< - ffi.Double Function(ffi.Pointer)>>('erand48'); + ffi + .NativeFunction)>>( + 'erand48'); late final _erand48 = _erand48Ptr.asFunction)>(); @@ -1052,8 +1057,9 @@ class UpdaterBindings { } late final _jrand48Ptr = _lookup< - ffi.NativeFunction< - ffi.Long Function(ffi.Pointer)>>('jrand48'); + ffi + .NativeFunction)>>( + 'jrand48'); late final _jrand48 = _jrand48Ptr.asFunction)>(); @@ -1079,8 +1085,9 @@ class UpdaterBindings { } late final _lcong48Ptr = _lookup< - ffi.NativeFunction< - ffi.Void Function(ffi.Pointer)>>('lcong48'); + ffi + .NativeFunction)>>( + 'lcong48'); late final _lcong48 = _lcong48Ptr.asFunction)>(); @@ -1137,8 +1144,9 @@ class UpdaterBindings { } late final _nrand48Ptr = _lookup< - ffi.NativeFunction< - ffi.Long Function(ffi.Pointer)>>('nrand48'); + ffi + .NativeFunction)>>( + 'nrand48'); late final _nrand48 = _nrand48Ptr.asFunction)>(); @@ -1391,9 +1399,9 @@ class UpdaterBindings { } late final _arc4random_bufPtr = _lookup< - ffi.NativeFunction< - ffi.Void Function( - ffi.Pointer, ffi.Size)>>('arc4random_buf'); + ffi + .NativeFunction, ffi.Size)>>( + 'arc4random_buf'); late final _arc4random_buf = _arc4random_bufPtr .asFunction, int)>(); @@ -1677,8 +1685,9 @@ class UpdaterBindings { } late final _getloadavgPtr = _lookup< - ffi.NativeFunction< - ffi.Int Function(ffi.Pointer, ffi.Int)>>('getloadavg'); + ffi + .NativeFunction, ffi.Int)>>( + 'getloadavg'); late final _getloadavg = _getloadavgPtr.asFunction, int)>(); @@ -2228,7 +2237,7 @@ final class __mbstate_t extends ffi.Union { final class __darwin_pthread_handler_rec extends ffi.Struct { external ffi - .Pointer)>> + .Pointer)>> __routine; external ffi.Pointer __arg; diff --git a/shorebird_code_push/lib/shorebird_code_push_io.dart b/shorebird_code_push/lib/src/shorebird_code_push_io.dart similarity index 93% rename from shorebird_code_push/lib/shorebird_code_push_io.dart rename to shorebird_code_push/lib/src/shorebird_code_push_io.dart index 0a20dcd..2b6e888 100644 --- a/shorebird_code_push/lib/shorebird_code_push_io.dart +++ b/shorebird_code_push/lib/src/shorebird_code_push_io.dart @@ -4,6 +4,9 @@ import 'package:shorebird_code_push/src/shorebird_code_push_ffi.dart'; import 'package:shorebird_code_push/src/shorebird_code_push_noop.dart'; import 'package:shorebird_code_push/src/updater.dart'; +/// Applications should not import this file directly, but +/// import `package:shorebird_code_push/shorebird_code_push.dart` instead. + /// {@template shorebird_code_push} /// Get info about your Shorebird code push app. /// {@endtemplate} diff --git a/shorebird_code_push/lib/shorebird_code_push_web.dart b/shorebird_code_push/lib/src/shorebird_code_push_web.dart similarity index 71% rename from shorebird_code_push/lib/shorebird_code_push_web.dart rename to shorebird_code_push/lib/src/shorebird_code_push_web.dart index f540852..fcf788e 100644 --- a/shorebird_code_push/lib/shorebird_code_push_web.dart +++ b/shorebird_code_push/lib/src/shorebird_code_push_web.dart @@ -1,6 +1,9 @@ import 'package:shorebird_code_push/src/shorebird_code_push_base.dart'; import 'package:shorebird_code_push/src/shorebird_code_push_noop.dart'; +/// Applications should not import this file directly, but +/// import `package:shorebird_code_push/shorebird_code_push.dart` instead. + /// {@template shorebird_code_push} /// Get info about your Shorebird code push app. /// {@endtemplate} diff --git a/shorebird_code_push/test/shorebird_code_push_io_test.dart b/shorebird_code_push/test/shorebird_code_push_io_test.dart index be1cfc8..abbc145 100644 --- a/shorebird_code_push/test/shorebird_code_push_io_test.dart +++ b/shorebird_code_push/test/shorebird_code_push_io_test.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'package:mocktail/mocktail.dart'; -import 'package:shorebird_code_push/shorebird_code_push_io.dart'; +import 'package:shorebird_code_push/src/shorebird_code_push_io.dart'; import 'package:shorebird_code_push/src/updater.dart'; import 'package:test/test.dart';