Merge pull request #1754 from nextcloud/refactor/use_timezone_datetime

refactor(nextcloud): use package:timezone TZDateTime for dates

.github/renovate.json

@@ -47,6 +47,12 @@
       "matchCurrentVersion": "/^0/",
       "enabled": false
     },
+    {
+      "matchManagers": ["pub"],
+      "matchPackageNames": ["timezone"],
+      "rangeStrategy": "bump",
+      "enabled": true
+    },
     {
       "groupName": "built_value",
       "matchPackagePatterns": "^built"

packages/neon/neon_files/lib/src/blocs/files.dart

@@ -19,6 +19,7 @@ import 'package:path_provider/path_provider.dart';
 import 'package:queue/queue.dart';
 import 'package:rxdart/rxdart.dart';
 import 'package:share_plus/share_plus.dart';
+import 'package:timezone/timezone.dart' as tz;
 import 'package:universal_io/io.dart';
 
 sealed class FilesBloc implements InteractiveBloc {
@@ -30,7 +31,7 @@ sealed class FilesBloc implements InteractiveBloc {
 
   void uploadFile(PathUri uri, String localPath);
 
-  void uploadMemory(PathUri uri, Uint8List bytes, {DateTime? lastModified});
+  void uploadMemory(PathUri uri, Uint8List bytes, {tz.TZDateTime? lastModified});
 
   void openFile(PathUri uri, String etag, String? mimeType);
 
@@ -115,7 +116,7 @@ class _FilesBloc extends InteractiveBloc implements FilesBloc {
   }
 
   @override
-  Future<void> uploadMemory(PathUri uri, Uint8List bytes, {DateTime? lastModified}) async {
+  Future<void> uploadMemory(PathUri uri, Uint8List bytes, {tz.TZDateTime? lastModified}) async {
     await wrapAction(
       () async {
         final task = FilesUploadTaskMemory(

packages/neon/neon_files/lib/src/models/file_details.dart

@@ -1,6 +1,7 @@
 import 'package:meta/meta.dart';
 import 'package:neon_files/src/utils/task.dart';
 import 'package:nextcloud/webdav.dart';
+import 'package:timezone/timezone.dart' as tz;
 
 @immutable
 class FileDetails {
@@ -73,7 +74,7 @@ class FileDetails {
 
   final String? mimeType;
 
-  final DateTime? lastModified;
+  final tz.TZDateTime? lastModified;
 
   final bool? hasPreview;
 

packages/neon/neon_files/lib/src/utils/task.dart

@@ -3,6 +3,7 @@ import 'dart:typed_data';
 
 import 'package:meta/meta.dart';
 import 'package:nextcloud/nextcloud.dart';
+import 'package:timezone/timezone.dart' as tz;
 import 'package:universal_io/io.dart';
 
 sealed class FilesTask {
@@ -34,7 +35,7 @@ sealed class FilesUploadTask extends FilesTask {
 
   final int? size;
 
-  final DateTime? lastModified;
+  final tz.TZDateTime? lastModified;
 }
 
 sealed class FilesTaskIO extends FilesTask {
@@ -83,10 +84,10 @@ class FilesUploadTaskIO extends FilesTaskIO implements FilesUploadTask {
   late final FileStat _stat = file.statSync();
 
   @override
-  late int? size = _stat.size;
+  late int size = _stat.size;
 
   @override
-  late DateTime? lastModified = _stat.modified;
+  late tz.TZDateTime lastModified = tz.TZDateTime.from(_stat.modified, tz.UTC);
 
   Future<void> execute(NextcloudClient client) async {
     await client.webdav.putFile(
@@ -129,7 +130,7 @@ class FilesUploadTaskMemory extends FilesTaskMemory implements FilesUploadTask {
   final int? size;
 
   @override
-  final DateTime? lastModified;
+  final tz.TZDateTime? lastModified;
 
   Future<void> execute(NextcloudClient client) async {
     await client.webdav.putStream(

packages/neon/neon_files/pubspec.yaml

@@ -36,6 +36,7 @@ dependencies:
   queue: ^3.0.0
   rxdart: ^0.27.0
   share_plus: ^7.0.0
+  timezone: ^0.9.2
   universal_io: ^2.0.0
 
 dev_dependencies:

packages/neon/neon_news/lib/src/widgets/articles_view.dart

@@ -18,6 +18,7 @@ import 'package:neon_news/src/sort/articles.dart';
 import 'package:neon_news/src/widgets/feed_icon.dart';
 import 'package:nextcloud/news.dart' as news;
 import 'package:nextcloud/utils.dart';
+import 'package:timezone/timezone.dart' as tz;
 import 'package:url_launcher/url_launcher_string.dart';
 
 final _log = Logger('NewsArticlesView');
@@ -165,8 +166,8 @@ class _NewsArticlesViewState extends State<NewsArticlesView> {
             ),
             RelativeTime(
               date: DateTimeUtils.fromSecondsSinceEpoch(
+                tz.UTC,
                 article.pubDate,
-                isUtc: true,
               ),
               style: const TextStyle(
                 fontWeight: FontWeight.w300,

packages/neon/neon_news/pubspec.yaml

@@ -26,6 +26,7 @@ dependencies:
   nextcloud: ^5.0.2
   rxdart: ^0.27.0
   share_plus: ^7.0.0
+  timezone: ^0.9.2
   url_launcher: ^6.0.0
   wakelock_plus: ^1.0.0
   webview_flutter: ^4.0.0

packages/neon/neon_notes/lib/src/widgets/notes_view.dart

@@ -13,6 +13,7 @@ import 'package:neon_notes/src/sort/notes.dart';
 import 'package:neon_notes/src/utils/category_color.dart';
 import 'package:nextcloud/notes.dart' as notes;
 import 'package:nextcloud/utils.dart';
+import 'package:timezone/timezone.dart' as tz;
 
 class NotesView extends StatelessWidget {
   const NotesView({
@@ -60,8 +61,8 @@ class NotesView extends StatelessWidget {
           children: [
             RelativeTime(
               date: DateTimeUtils.fromSecondsSinceEpoch(
+                tz.UTC,
                 note.modified,
-                isUtc: true,
               ),
             ),
             if (note.category.isNotEmpty) ...[

packages/neon/neon_notes/pubspec.yaml

@@ -26,6 +26,7 @@ dependencies:
   nextcloud: ^5.0.2
   queue: ^3.0.0
   rxdart: ^0.27.0
+  timezone: ^0.9.2
   url_launcher: ^6.0.0
   wakelock_plus: ^1.0.0
 

packages/neon/neon_notifications/lib/src/pages/main.dart

@@ -10,6 +10,7 @@ import 'package:neon_notifications/l10n/localizations.dart';
 import 'package:neon_notifications/src/blocs/notifications.dart';
 import 'package:nextcloud/ids.dart';
 import 'package:nextcloud/notifications.dart' as notifications;
+import 'package:timezone/timezone.dart' as tz;
 
 class NotificationsMainPage extends StatefulWidget {
   const NotificationsMainPage({
@@ -84,7 +85,7 @@ class _NotificationsMainPageState extends State<NotificationsMainPage> {
             ),
           ],
           RelativeTime(
-            date: DateTime.parse(notification.datetime).toUtc(),
+            date: tz.TZDateTime.parse(tz.UTC, notification.datetime),
           ),
         ],
       ),

packages/neon/neon_notifications/pubspec.yaml

@@ -23,6 +23,7 @@ dependencies:
       path: packages/neon_framework
   nextcloud: ^5.0.2
   rxdart: ^0.27.0
+  timezone: ^0.9.2
 
 dev_dependencies:
   build_runner: ^2.4.8

packages/neon/neon_talk/lib/src/widgets/message.dart

@@ -6,6 +6,7 @@ import 'package:neon_talk/src/widgets/actor_avatar.dart';
 import 'package:neon_talk/src/widgets/reactions.dart';
 import 'package:nextcloud/spreed.dart' as spreed;
 import 'package:nextcloud/utils.dart';
+import 'package:timezone/timezone.dart' as tz;
 
 final _timeFormat = DateFormat.jm();
 
@@ -233,14 +234,14 @@ class TalkCommentMessage extends StatelessWidget {
     final textTheme = Theme.of(context).textTheme;
 
     final date = DateTimeUtils.fromSecondsSinceEpoch(
+      tz.UTC,
       chatMessage.timestamp,
-      isUtc: true,
     );
-    DateTime? previousDate;
+    tz.TZDateTime? previousDate;
     if (previousChatMessage != null) {
       previousDate = DateTimeUtils.fromSecondsSinceEpoch(
+        tz.UTC,
         previousChatMessage!.timestamp,
-        isUtc: true,
       );
     }
 

packages/neon/neon_talk/pubspec.yaml

@@ -23,6 +23,7 @@ dependencies:
       path: packages/neon_framework
   nextcloud: ^5.0.2
   rxdart: ^0.27.0
+  timezone: ^0.9.2
 
 dev_dependencies:
   build_runner: ^2.4.8

packages/neon_framework/lib/src/blocs/user_status.dart

@@ -15,6 +15,7 @@ import 'package:nextcloud/nextcloud.dart';
 import 'package:nextcloud/user_status.dart' as user_status;
 import 'package:nextcloud/utils.dart';
 import 'package:rxdart/rxdart.dart';
+import 'package:timezone/timezone.dart' as tz;
 import 'package:window_manager/window_manager.dart';
 
 /// Bloc for managing user statuses.
@@ -42,14 +43,14 @@ abstract class UserStatusBloc implements InteractiveBloc {
   /// Predefined status messages received from [predefinedStatuses].
   void setPredefinedMessage({
     required String id,
-    required DateTime? clearAt,
+    required tz.TZDateTime? clearAt,
   });
 
   /// Set a custom status [message] with the [icon] and [clearAt].
   void setCustomMessage({
     required String? message,
     required String? icon,
-    required DateTime? clearAt,
+    required tz.TZDateTime? clearAt,
   });
 
   /// Clear the current status message.
@@ -211,7 +212,7 @@ class _UserStatusBloc extends InteractiveBloc implements UserStatusBloc {
   @override
   Future<void> setPredefinedMessage({
     required String id,
-    required DateTime? clearAt,
+    required tz.TZDateTime? clearAt,
   }) async {
     await wrapAction(
       () async {
@@ -230,7 +231,7 @@ class _UserStatusBloc extends InteractiveBloc implements UserStatusBloc {
   Future<void> setCustomMessage({
     required String? message,
     required String? icon,
-    required DateTime? clearAt,
+    required tz.TZDateTime? clearAt,
   }) async {
     await wrapAction(
       () async {

packages/neon_framework/lib/src/pages/settings.dart

@@ -28,6 +28,7 @@ import 'package:neon_framework/src/widgets/dialog.dart';
 import 'package:neon_framework/src/widgets/error.dart';
 import 'package:nextcloud/utils.dart';
 import 'package:package_info_plus/package_info_plus.dart';
+import 'package:timezone/timezone.dart' as tz;
 import 'package:url_launcher/url_launcher_string.dart';
 
 final _log = Logger('SettingsPage');
@@ -249,7 +250,7 @@ class _SettingsPageState extends State<SettingsPage> {
                 final settingsExportHelper = _buildSettingsExportHelper(context);
 
                 try {
-                  final fileName = 'nextcloud-neon-settings-${DateTime.timestamp().secondsSinceEpoch}.json';
+                  final fileName = 'nextcloud-neon-settings-${tz.TZDateTime.now(tz.UTC).secondsSinceEpoch}.json';
 
                   final data = settingsExportHelper.exportToFile();
                   await NeonPlatform.instance.saveFileWithPickDialog(fileName, 'application/json', data);

packages/neon_framework/lib/src/storage/request_cache.dart

@@ -7,6 +7,7 @@ import 'package:neon_framework/src/utils/request_manager.dart';
 import 'package:path/path.dart' as p;
 import 'package:path_provider/path_provider.dart';
 import 'package:sqflite_common_ffi/sqflite_ffi.dart';
+import 'package:timezone/timezone.dart' as tz;
 
 final _log = Logger('RequestCache');
 
@@ -168,9 +169,9 @@ CREATE TABLE "cache" (
     return CacheParameters(
       etag: row?['etag'] as String?,
       expires: expires != null
-          ? DateTime.fromMillisecondsSinceEpoch(
+          ? tz.TZDateTime.fromMillisecondsSinceEpoch(
+              tz.UTC,
               expires,
-              isUtc: true,
             )
           : null,
     );

packages/neon_framework/lib/src/utils/push_utils.dart

@@ -25,6 +25,7 @@ import 'package:neon_framework/src/utils/request_manager.dart';
 import 'package:neon_framework/storage.dart';
 import 'package:nextcloud/notifications.dart' as notifications;
 import 'package:rxdart/rxdart.dart';
+import 'package:timezone/timezone.dart' as tz;
 
 final _log = Logger('PushUtils');
 
@@ -152,7 +153,7 @@ class PushUtils {
           }
           final title = (notification?.subject ?? pushNotification.subject.subject)!;
           final message = (notification?.message.isNotEmpty ?? false) ? notification!.message : null;
-          final when = notification != null ? DateTime.parse(notification.datetime).toUtc() : null;
+          final when = notification != null ? tz.TZDateTime.parse(tz.UTC, notification.datetime) : null;
 
           await localNotificationsPlugin.show(
             _getNotificationID(instance, pushNotification),

packages/neon_framework/lib/src/utils/relative_time.dart

@@ -1,20 +1,21 @@
 import 'package:meta/meta.dart';
 import 'package:neon_framework/l10n/localizations.dart';
+import 'package:timezone/timezone.dart' as tz;
 
-/// Extension for formatting the difference between two [DateTime]s.
+/// Extension for formatting the difference between two [tz.TZDateTime]s.
 @internal
-extension RelativeTimeFormatDateTime on DateTime {
+extension RelativeTimeFormatDateTime on tz.TZDateTime {
   /// Format the relative time between this and [to].
   ///
-  /// If [to] is unspecified [DateTime.timestamp] will be used.
+  /// If [to] is unspecified the current time in the 'UTC' timezone will be used.
   /// Set [includeSign] to skip the parts that tell if the difference is into the future or into the past.
   /// It should only be used if it is already clear from the context if it is about the future or the past.
   String formatRelative(
     NeonLocalizations localizations, {
     bool includeSign = true,
-    DateTime? to,
+    tz.TZDateTime? to,
   }) =>
-      difference(to ?? DateTime.timestamp()).formatRelative(
+      difference(to ?? tz.TZDateTime.now(tz.UTC)).formatRelative(
         localizations,
         includeSign: includeSign,
       );

packages/neon_framework/lib/src/utils/request_manager.dart

@@ -14,6 +14,7 @@ import 'package:neon_framework/src/models/account.dart';
 import 'package:neon_framework/storage.dart';
 import 'package:nextcloud/nextcloud.dart';
 import 'package:rxdart/rxdart.dart';
+import 'package:timezone/timezone.dart' as tz;
 import 'package:xml/xml.dart' as xml;
 
 final _log = Logger('RequestManager');
@@ -365,7 +366,12 @@ class CacheParameters {
 
   /// Parse the cache parameters from HTTP response headers.
   factory CacheParameters.parseHeaders(Map<String, dynamic> headers) {
-    final expiry = headers.containsKey('expires') ? parseHttpDate(headers['expires']! as String) : null;
+    tz.TZDateTime? expiry;
+    if (headers.containsKey('expires')) {
+      final parsed = parseHttpDate(headers['expires']! as String);
+      expiry = tz.TZDateTime.from(parsed, tz.UTC);
+    }
+
     return CacheParameters(
       etag: headers['etag'] as String?,
       expires: _isExpired(expiry) ? null : expiry,
@@ -376,12 +382,12 @@ class CacheParameters {
   final String? etag;
 
   /// `Expires` of the resource.
-  final DateTime? expires;
+  final tz.TZDateTime? expires;
 
   /// Whether the resource has expired based on [expires].
   bool get isExpired => _isExpired(expires);
 
-  static bool _isExpired(DateTime? date) => date?.isBefore(DateTime.timestamp()) ?? true;
+  static bool _isExpired(tz.TZDateTime? date) => date?.isBefore(tz.TZDateTime.now(tz.UTC)) ?? true;
 
   @override
   bool operator ==(Object other) => other is CacheParameters && other.etag == etag && other.expires == expires;