Move super_logging to internal codebase

lib/core/configuration.dart

@@ -8,6 +8,7 @@ import 'package:flutter_sodium/flutter_sodium.dart';
 import 'package:logging/logging.dart';
 import 'package:path_provider/path_provider.dart';
 import 'package:photos/core/constants.dart';
+import 'package:photos/core/error-reporting/super_logging.dart';
 import 'package:photos/core/event_bus.dart';
 import 'package:photos/db/collections_db.dart';
 import 'package:photos/db/files_db.dart';
@@ -28,7 +29,6 @@ import 'package:photos/services/memories_service.dart';
 import 'package:photos/services/sync_service.dart';
 import 'package:photos/utils/crypto_util.dart';
 import 'package:shared_preferences/shared_preferences.dart';
-import 'package:super_logging/super_logging.dart';
 import 'package:uuid/uuid.dart';
 
 class Configuration {

thirdparty/super_logging/lib/super_logging.dart → lib/core/error-reporting/super_logging.dart

@@ -2,6 +2,7 @@ library super_logging;
 
 import 'dart:async';
 import 'dart:collection';
+import 'dart:core';
 import 'dart:io';
 
 import 'package:flutter/foundation.dart';
@@ -13,7 +14,7 @@ import 'package:path/path.dart';
 import 'package:path_provider/path_provider.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
 
-typedef FutureOr<void> FutureOrVoidCallback();
+typedef FutureOrVoidCallback = FutureOr<void> Function();
 
 extension SuperString on String {
   Iterable<String> chunked(int chunkSize) sync* {
@@ -33,7 +34,7 @@ extension SuperString on String {
 }
 
 extension SuperLogRecord on LogRecord {
-  String toPrettyString([String? extraLines]) {
+  String toPrettyString([String extraLines]) {
     var header = "[$loggerName] [$level] [$time]";
 
     var msg = "$header $message";
@@ -71,7 +72,7 @@ class LogConfig {
   /// ```
   ///
   /// If this is [null], Sentry logger is completely disabled (default).
-  String? sentryDsn;
+  String sentryDsn;
 
   /// A built-in retry mechanism for sending errors to sentry.
   ///
@@ -88,7 +89,7 @@ class LogConfig {
   /// A non-empty string will be treated as an explicit path to a directory.
   ///
   /// The chosen directory can be accessed using [SuperLogging.logFile.parent].
-  String? logDirPath;
+  String logDirPath;
 
   /// The maximum number of log files inside [logDirPath].
   ///
@@ -106,12 +107,12 @@ class LogConfig {
   /// any uncaught errors during its execution will be reported.
   ///
   /// Works by using [FlutterError.onError] and [runZoned].
-  FutureOrVoidCallback? body;
+  FutureOrVoidCallback body;
 
   /// The date format for storing log files.
   ///
   /// `DateFormat('y-M-d')` by default.
-  DateFormat? dateFmt;
+  DateFormat dateFmt;
 
   String prefix;
 
@@ -134,9 +135,9 @@ class SuperLogging {
   static final $ = Logger('ente_logging');
 
   /// The current super logging configuration
-  static late LogConfig config;
+  static LogConfig config;
 
-  static Future<void> main([LogConfig? config]) async {
+  static Future<void> main([LogConfig config]) async {
     config ??= LogConfig();
     SuperLogging.config = config;
 
@@ -173,12 +174,12 @@ class SuperLogging {
     if (enable) {
       await SentryFlutter.init(
         (options) {
-          options.dsn = config!.sentryDsn;
+          options.dsn = config.sentryDsn;
         },
-        appRunner: () => config!.body!(),
+        appRunner: () => config.body(),
       );
     } else {
-      await config.body!();
+      await config.body();
     }
   }
 
@@ -187,8 +188,7 @@ class SuperLogging {
     $.info("setting sentry user ID to: $userID");
   }
 
-  static Future<void> _sendErrorToSentry(
-      Object? error, StackTrace? stack) async {
+  static Future<void> _sendErrorToSentry(Object error, StackTrace stack) async {
     try {
       await Sentry.captureException(
         error,
@@ -200,11 +200,11 @@ class SuperLogging {
     }
   }
 
-  static String? _lastExtraLines = '';
+  static String _lastExtraLines = '';
 
   static Future onLogRecord(LogRecord rec) async {
     // log misc info if it changed
-    String? extraLines = "app version: '$appVersion'\n";
+    String extraLines = "app version: '$appVersion'\n";
     if (extraLines != _lastExtraLines) {
       _lastExtraLines = extraLines;
     } else {
@@ -258,7 +258,7 @@ class SuperLogging {
   static final sentryQueueControl = StreamController<Error>();
 
   /// Whether sentry logging is currently enabled or not.
-  static late bool sentryIsEnabled;
+  static bool sentryIsEnabled;
 
   static Future<void> setupSentry() async {
     await for (final error in sentryQueueControl.stream.asBroadcastStream()) {
@@ -281,17 +281,17 @@ class SuperLogging {
   }
 
   /// The log file currently in use.
-  static late File logFile;
+  static File logFile;
 
   /// Whether file logging is currently enabled or not.
-  static late bool fileIsEnabled;
+  static bool fileIsEnabled;
 
   static Future<void> setupLogDir() async {
-    var dirPath = config.logDirPath!;
+    var dirPath = config.logDirPath;
 
     // choose [logDir]
     if (dirPath.isEmpty) {
-      var root = await (getExternalStorageDirectory() as FutureOr<Directory>);
+      var root = await getExternalStorageDirectory();
       dirPath = '${root.path}/logs';
     }
 
@@ -305,7 +305,7 @@ class SuperLogging {
     // collect all log files with valid names
     await for (final file in dir.list()) {
       try {
-        var date = config.dateFmt!.parse(basename(file.path));
+        var date = config.dateFmt.parse(basename(file.path));
         dates[file as File] = date;
         files.add(file);
       } on FormatException {}
@@ -314,7 +314,7 @@ class SuperLogging {
     // delete old log files, if [maxLogFiles] is exceeded.
     if (files.length > config.maxLogFiles) {
       // sort files based on ascending order of date (older first)
-      files.sort((a, b) => dates[a]!.compareTo(dates[b]!));
+      files.sort((a, b) => dates[a].compareTo(dates[b]));
 
       final extra = files.length - config.maxLogFiles;
       final toDelete = files.sublist(0, extra);
@@ -329,13 +329,13 @@ class SuperLogging {
       }
     }
 
-    logFile = File("$dirPath/${config.dateFmt!.format(DateTime.now())}.txt");
+    logFile = File("$dirPath/${config.dateFmt.format(DateTime.now())}.txt");
   }
 
   /// Current app version, obtained from package_info plugin.
   ///
   /// See: [getAppVersion]
-  static String? appVersion;
+  static String appVersion;
 
   static Future<String> getAppVersion() async {
     var pkgInfo = await PackageInfo.fromPlatform();

lib/main.dart

@@ -11,6 +11,7 @@ import 'package:path_provider/path_provider.dart';
 import 'package:photos/app.dart';
 import 'package:photos/core/configuration.dart';
 import 'package:photos/core/constants.dart';
+import 'package:photos/core/error-reporting/super_logging.dart';
 import 'package:photos/core/network.dart';
 import 'package:photos/db/upload_locks_db.dart';
 import 'package:photos/services/app_lifecycle_service.dart';
@@ -31,7 +32,6 @@ import 'package:photos/utils/crypto_util.dart';
 import 'package:photos/utils/file_uploader.dart';
 import 'package:photos/utils/local_settings.dart';
 import 'package:shared_preferences/shared_preferences.dart';
-import 'package:super_logging/super_logging.dart';
 
 final _logger = Logger("main");
 

lib/utils/email_util.dart

@@ -8,11 +8,11 @@ import 'package:flutter/widgets.dart';
 import 'package:flutter_email_sender/flutter_email_sender.dart';
 import 'package:logging/logging.dart';
 import 'package:path_provider/path_provider.dart';
+import 'package:photos/core/error-reporting/super_logging.dart';
 import 'package:photos/ui/common/dialogs.dart';
 import 'package:photos/ui/log_file_viewer.dart';
 import 'package:photos/utils/dialog_util.dart';
 import 'package:share_plus/share_plus.dart';
-import 'package:super_logging/super_logging.dart';
 
 final Logger _logger = Logger('email_util');
 

pubspec.lock

@@ -591,7 +591,7 @@ packages:
     source: hosted
     version: "0.15.0"
   http:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: http
       url: "https://pub.dartlang.org"
@@ -1008,7 +1008,7 @@ packages:
     source: hosted
     version: "6.5.1"
   sentry_flutter:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: sentry_flutter
       url: "https://pub.dartlang.org"
@@ -1187,13 +1187,6 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "1.1.0"
-  super_logging:
-    dependency: "direct main"
-    description:
-      path: "thirdparty/super_logging"
-      relative: true
-    source: path
-    version: "1.3.4"
   syncfusion_flutter_core:
     dependency: "direct main"
     description:

pubspec.yaml

@@ -61,6 +61,7 @@ dependencies:
   fluttercontactpicker: ^4.7.0
   fluttertoast: ^8.0.6
   google_nav_bar: ^5.0.5
+  http: ^0.13.4
   image: ^3.0.2
   image_editor: ^1.0.0
   implicitly_animated_reorderable_list: ^0.4.0
@@ -89,13 +90,12 @@ dependencies:
   receive_sharing_intent: ^1.4.5
   scrollable_positioned_list: ^0.2.2
   sentry: ^6.5.1
+  sentry_flutter: ^6.5.1
   share_plus: ^4.0.4
   shared_preferences: ^2.0.5
   sqflite: ^2.0.0+3
   sqflite_migration: ^0.3.0
   step_progress_indicator: ^1.0.2
-  super_logging:
-    path: thirdparty/super_logging
   syncfusion_flutter_core: ^19.2.49
   syncfusion_flutter_sliders: ^19.2.49
   tuple: ^2.0.0

thirdparty/super_logging/.gitignore

@@ -1,239 +0,0 @@
-.DS_Store
-.dart_tool/
-
-flutter_export_environment.sh
-.flutter-plugins-dependencies
-
-.packages
-.pub/
-
-build/
-ios/.generated/
-ios/Flutter/Generated.xcconfig
-ios/Runner/GeneratedPluginRegistrant.*
-
-**/.idea
-.flutter-plugins
-
-android/
-
-# Created by https://www.gitignore.io/api/dart,android,androidstudio
-# Edit at https://www.gitignore.io/?templates=dart,android,androidstudio
-
-### Android ###
-# Built application files
-*.apk
-*.ap_
-*.aab
-
-# Files for the ART/Dalvik VM
-*.dex
-
-# Java class files
-*.class
-
-# Generated files
-bin/
-gen/
-out/
-
-# Gradle files
-.gradle/
-build/
-
-# Local configuration file (sdk path, etc)
-local.properties
-
-# Proguard folder generated by Eclipse
-proguard/
-
-# Log Files
-*.log
-
-# Android Studio Navigation editor temp files
-.navigation/
-
-# Android Studio captures folder
-captures/
-
-# IntelliJ
-*.iml
-.idea/workspace.xml
-.idea/tasks.xml
-.idea/gradle.xml
-.idea/assetWizardSettings.xml
-.idea/dictionaries
-.idea/libraries
-.idea/caches
-# Android Studio 3 in .gitignore file.
-.idea/caches/build_file_checksums.ser
-.idea/modules.xml
-
-# Keystore files
-# Uncomment the following lines if you do not want to check your keystore files in.
-#*.jks
-#*.keystore
-
-# External native build folder generated in Android Studio 2.2 and later
-.externalNativeBuild
-
-# Google Services (e.g. APIs or Firebase)
-# google-services.json
-
-# Freeline
-freeline.py
-freeline/
-freeline_project_description.json
-
-# fastlane
-fastlane/report.xml
-fastlane/Preview.html
-fastlane/screenshots
-fastlane/test_output
-fastlane/readme.md
-
-# Version control
-vcs.xml
-
-# lint
-lint/intermediates/
-lint/generated/
-lint/outputs/
-lint/tmp/
-# lint/reports/
-
-### Android Patch ###
-gen-external-apklibs
-output.json
-
-### AndroidStudio ###
-# Covers files to be ignored for android development using Android Studio.
-
-# Built application files
-
-# Files for the ART/Dalvik VM
-
-# Java class files
-
-# Generated files
-
-# Gradle files
-.gradle
-
-# Signing files
-.signing/
-
-# Local configuration file (sdk path, etc)
-
-# Proguard folder generated by Eclipse
-
-# Log Files
-
-# Android Studio
-/*/build/
-/*/local.properties
-/*/out
-/*/*/build
-/*/*/production
-*.ipr
-*~
-*.swp
-
-# Android Patch
-
-# External native build folder generated in Android Studio 2.2 and later
-
-# NDK
-obj/
-
-# IntelliJ IDEA
-*.iws
-/out/
-
-# User-specific configurations
-.idea/caches/
-.idea/libraries/
-.idea/shelf/
-.idea/.name
-.idea/compiler.xml
-.idea/copyright/profiles_settings.xml
-.idea/encodings.xml
-.idea/misc.xml
-.idea/scopes/scope_settings.xml
-.idea/vcs.xml
-.idea/jsLibraryMappings.xml
-.idea/datasources.xml
-.idea/dataSources.ids
-.idea/sqlDataSources.xml
-.idea/dynamic.xml
-.idea/uiDesigner.xml
-
-# OS-specific files
-.DS_Store
-.DS_Store?
-._*
-.Spotlight-V100
-.Trashes
-ehthumbs.db
-Thumbs.db
-
-# Legacy Eclipse project files
-.classpath
-.project
-.cproject
-.settings/
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.war
-*.ear
-
-# virtual machine crash logs (Reference: http://www.java.com/en/download/help/error_hotspot.xml)
-hs_err_pid*
-
-## Plugin-specific files:
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Mongo Explorer plugin
-.idea/mongoSettings.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-### AndroidStudio Patch ###
-
-!/gradle/wrapper/gradle-wrapper.jar
-
-### Dart ###
-# See https://www.dartlang.org/guides/libraries/private-files
-
-# Files and directories created by pub
-.dart_tool/
-.packages
-# If you're building an application, you may want to check-in your pubspec.lock
-pubspec.lock
-
-# Directory created by dartdoc
-# If you don't generate documentation locally you can remove this line.
-doc/api/
-
-# Avoid committing generated Javascript files:
-*.dart.js
-*.info.json      # Produced by the --dump-info flag.
-*.js             # When generated by dart2js. Don't specify *.js if your
-                 # project includes source files written in JavaScript.
-*.js_
-*.js.deps
-*.js.map
-
-# End of https://www.gitignore.io/api/dart,android,androidstudio

thirdparty/super_logging/.metadata

@@ -1,10 +0,0 @@
-# This file tracks properties of this Flutter project.
-# Used by Flutter tool to assess capabilities and perform upgrades etc.
-#
-# This file should be version controlled and should not be manually edited.
-
-version:
-  revision: 8661d8aecd626f7f57ccbcb735553edc05a2e713
-  channel: stable
-
-project_type: package

thirdparty/super_logging/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 PyCampers
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

thirdparty/super_logging/README.md

@@ -1,54 +0,0 @@
-# Super Logging
-
-[![Sponsor](https://img.shields.io/badge/Sponsor-jaaga_labs-red.svg?style=for-the-badge)](https://www.jaaga.in/labs)
-
-[![pub package](https://img.shields.io/pub/v/super_logging.svg?style=for-the-badge)](https://pub.dartlang.org/packages/super_logging)
-
-This package lets you easily log to:
-- stdout
-- disk
-- sentry.io
-
-```dart
-import 'package:super_logging/super_logging.dart';
-import 'package:logging/logging.dart';
-
-final logger = Logger("main");
-
-main() async {
-  // just call once, and let it handle the rest!
-  await SuperLogging.main();
-  
-  logger.info("hello!");
-}
-```
-
-(Above example will log to stdout and disk.)
-
-## Logging to sentry.io
-
-Just specify your sentry DSN.
-
-```dart
-SuperLogging.main(LogConfig(
-  sentryDsn: 'https://xxxx@sentry.io/yyyy',
-));
-```
-
-## Log uncaught errors
-
-Just provide the contents of your `main()` function to super logging.
-
-```dart
-void main() {
-  SuperLogging.main(LogConfig(
-    body: _main,
-  ));
-}
-
-void _main() {
-  runApp(MyApp());
-}
-```
-
-[Read the docs](https://pub.dev/documentation/super_logging/latest/super_logging/super_logging-library.html) to know about more customization options.

thirdparty/super_logging/pubspec.yaml

@@ -1,61 +0,0 @@
-name: super_logging
-description: The usual dart logging module, but with superpowers! Let's you easily log to stdout, disk and sentry.io.
-version: 1.3.4
-author: Dev Aggarwal <devpxy@gmail.com>
-homepage: https://github.com/scientifichackers/super_logging
-
-environment:
-  sdk: '>=2.12.0 <3.0.0'
-
-dependencies:
-  flutter:
-    sdk: flutter
-
-  package_info_plus: ^1.0.1
-  device_info: ^2.0.2
-  logging: ^1.0.1
-  intl: ^0.17.0
-  path: ^1.6.4
-  path_provider: ^2.0.1
-  sentry_flutter: ^6.5.1
-
-dev_dependencies:
-  flutter_test:
-    sdk: flutter
-
-# For information on the generic Dart part of this file, see the
-# following page: https://www.dartlang.org/tools/pub/pubspec
-
-# The following section is specific to Flutter.
-flutter:
-
-# To add assets to your package, add an assets section, like this:
-# assets:
-#  - images/a_dot_burr.jpeg
-#  - images/a_dot_ham.jpeg
-#
-# For details regarding assets in packages, see
-# https://flutter.io/assets-and-images/#from-packages
-#
-# An image asset can refer to one or more resolution-specific "variants", see
-# https://flutter.io/assets-and-images/#resolution-aware.
-
-# To add custom fonts to your package, add a fonts section here,
-# in this "flutter" section. Each entry in this list should have a
-# "family" key with the font family name, and a "fonts" key with a
-# list giving the asset and other descriptors for the font. For
-# example:
-# fonts:
-#   - family: Schyler
-#     fonts:
-#       - asset: fonts/Schyler-Regular.ttf
-#       - asset: fonts/Schyler-Italic.ttf
-#         style: italic
-#   - family: Trajan Pro
-#     fonts:
-#       - asset: fonts/TrajanPro.ttf
-#       - asset: fonts/TrajanPro_Bold.ttf
-#         weight: 700
-#
-# For details regarding fonts in packages, see
-# https://flutter.io/custom-fonts/#from-packages

thirdparty/super_logging/test/test_string_chunked.dart

@@ -1,55 +0,0 @@
-import 'dart:math';
-
-import 'package:flutter_test/flutter_test.dart';
-import 'package:super_logging/super_logging.dart';
-
-var random = Random();
-
-void main() {
-  final chunkSize = SuperLogging.logChunkSize;
-
-  test('test with empty text', () {
-    var text = randomText(0);
-
-    var actual = text.chunked(chunkSize).toList();
-    var expected = [];
-
-    expect(expected, actual);
-  });
-
-  test('test with length < chunk size', () {
-    var text = randomText(chunkSize ~/ 2.5);
-
-    var actual = text.chunked(chunkSize).toList();
-    var expected = [text];
-
-    expect(expected, actual);
-  });
-
-  test('test with length = chunk size', () {
-    var text = randomText(chunkSize);
-
-    var actual = text.chunked(chunkSize).toList();
-    var expected = [text];
-
-    expect(expected, actual);
-  });
-
-  test('test with length > chunk size', () {
-    var text = randomText((chunkSize * 2.5).toInt());
-
-    var actual = text.chunked(chunkSize).toList();
-    var expected = [
-      text.substring(0, chunkSize),
-      text.substring(chunkSize, chunkSize * 2),
-      text.substring(chunkSize * 2)
-    ];
-
-    expect(expected, actual);
-  });
-}
-
-String randomText(int len) {
-  var charCodes = List.generate(len, (index) => random.nextInt(0x10FFFF));
-  return String.fromCharCodes(charCodes).substring(0, len);
-}