Refactor ForexRateAPI integration to load API key from .env file and enhance error handling

Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
2026-03-19 23:48:26 +01:00
parent a775a20dd2
commit e6c16967f9
8 changed files with 244 additions and 81 deletions
@@ -2,6 +2,7 @@ import 'dart:convert';
 import 'dart:io';

 import 'package:flutter/foundation.dart';
+import 'package:flutter_dotenv/flutter_dotenv.dart';
 import 'package:http/http.dart' as http;
 import 'package:intl/intl.dart';
 import 'package:path_provider/path_provider.dart';
@@ -13,8 +14,6 @@ import 'package:rental_income_tracker/services/storage_service.dart';
 import 'package:rental_income_tracker/services/time_service.dart';
 import 'package:timezone/timezone.dart' as tz;

-const String forexRateApiKey = 'REPLACE_WITH_YOUR_FOREXRATE_API_KEY';
-
 class RentTableRow {
  RentTableRow({
    required this.year,
@@ -23,6 +22,7 @@ class RentTableRow {
    required this.status,
    required this.usdAmount,
    required this.sekAmount,
+    required this.effectiveUsdToSekRate,
    required this.runningUsd,
    required this.runningSek,
  });
@@ -33,6 +33,7 @@ class RentTableRow {
  final PaymentStatus status;
  final double? usdAmount;
  final double? sekAmount;
+  final double? effectiveUsdToSekRate;
  final double runningUsd;
  final double runningSek;
 }
@@ -46,11 +47,24 @@ class RentController extends ChangeNotifier {
           exchangeService ??
           ForexRateApiService(
             httpClient: http.Client(),
-             apiKey: forexRateApiKey,
+             apiKey: _exchangeRateApiKeyFromEnv(),
           ) {
    _notificationService = NotificationService(_onNotificationAction);
  }

+  static String _exchangeRateApiKeyFromEnv() {
+    final key = dotenv.env['EXCHANGE_RATE_API_KEY']?.trim() ?? '';
+    if (key.isEmpty) {
+      if (kDebugMode) {
+        debugPrint(
+          '[RentController] EXCHANGE_RATE_API_KEY missing in .env, API calls will fail until set.',
+        );
+      }
+      return 'REPLACE_WITH_YOUR_EXCHANGE_RATE_API_KEY';
+    }
+    return key;
+  }
+
  final StorageService _storageService;
  final ForexRateApiService _exchangeService;
  late NotificationService _notificationService;
@@ -138,6 +152,12 @@ class RentController extends ChangeNotifier {
    _errorMessage = null;
    _setLoading(true);

+    if (kDebugMode) {
+      debugPrint(
+        '[RentController] markMonthPaid start year=$year month=$month source=$source assumeOnTime=$assumeOnTime',
+      );
+    }
+
    try {
      if (_isNotOccupiedMonth(year, month)) {
        throw StateError('Cannot mark a non-occupied month as paid.');
@@ -148,6 +168,11 @@ class RentController extends ChangeNotifier {

      final key = TimeService.monthKey(year, month);
      if (_records.containsKey(key)) {
+        if (kDebugMode) {
+          debugPrint(
+            '[RentController] markMonthPaid skipped API call; cached record exists for key=$key',
+          );
+        }
        await _notificationService.cancelForMonth(year, month);
        await _syncNotificationScheduleForCurrentMonth();
        return;
@@ -161,6 +186,11 @@ class RentController extends ChangeNotifier {
        estDate: estDate,
        amount: usd,
      );
+      if (kDebugMode) {
+        debugPrint(
+          '[RentController] markMonthPaid conversion success quote=${conversion.quote} result=${conversion.result} usd=$usd estDate=$estDate',
+        );
+      }
      final onTime =
          assumeOnTime || TimeService.isOnTimeByDeadline(paidAt, year, month);

@@ -178,9 +208,19 @@ class RentController extends ChangeNotifier {
      _records[record.key] = record;
      await _storageService.saveRecords(_records);

+      if (kDebugMode) {
+        debugPrint(
+          '[RentController] markMonthPaid stored record key=${record.key}',
+        );
+      }
+
      await _notificationService.cancelForMonth(year, month);
      await _syncNotificationScheduleForCurrentMonth();
-    } catch (err) {
+    } catch (err, stackTrace) {
+      if (kDebugMode) {
+        debugPrint('[RentController] markMonthPaid failed: $err');
+        debugPrint(stackTrace.toString());
+      }
      _errorMessage = err.toString();
    } finally {
      _setLoading(false);
@@ -191,48 +231,93 @@ class RentController extends ChangeNotifier {
    _errorMessage = null;
    _setLoading(true);

+    if (kDebugMode) {
+      debugPrint('[RentController] backfillLastYear start');
+    }
+
    try {
      if (_settings.rentUsd <= 0) {
        throw StateError('Set rent amount in Settings before backfill.');
      }

      final year = DateTime.now().year - 1;
+      var savedMonths = 0;
+      var pausedByRateLimit = false;
+
      for (var month = 1; month <= 12; month++) {
        final key = TimeService.monthKey(year, month);
        if (_records.containsKey(key)) {
+          if (kDebugMode) {
+            debugPrint('[RentController] backfill skip cached key=$key');
+          }
          continue;
        }

-        final usd = _settings.rentUsd;
-        final estDate = DateTime(year, month, 1);
-        final conversion = await _exchangeService.convertUsdToSek(
-          estDate: estDate,
-          amount: usd,
-        );
+        try {
+          final usd = _settings.rentUsd;
+          final estDate = DateTime(year, month, 1);
+          final conversion = await _exchangeService.convertUsdToSek(
+            estDate: estDate,
+            amount: usd,
+          );

-        final paidAtUtc = tz.TZDateTime(
-          TimeService.est,
-          year,
-          month,
-          1,
-          12,
-        ).toUtc();
+          if (kDebugMode) {
+            debugPrint(
+              '[RentController] backfill conversion year=$year month=$month quote=${conversion.quote} result=${conversion.result}',
+            );
+          }

-        _records[key] = MonthlyRentRecord(
-          year: year,
-          month: month,
-          usdAmount: usd,
-          sekAmount: conversion.result,
-          usdToSekRate: conversion.quote,
-          paidAtUtc: paidAtUtc,
-          onTime: true,
-          source: 'backfill',
-        );
+          final paidAtUtc = tz.TZDateTime(
+            TimeService.est,
+            year,
+            month,
+            1,
+            12,
+          ).toUtc();
+
+          _records[key] = MonthlyRentRecord(
+            year: year,
+            month: month,
+            usdAmount: usd,
+            sekAmount: conversion.result,
+            usdToSekRate: conversion.quote,
+            paidAtUtc: paidAtUtc,
+            onTime: true,
+            source: 'backfill',
+          );
+          await _storageService.saveRecords(_records);
+          savedMonths++;
+        } catch (err) {
+          final errorText = err.toString();
+          if (errorText.contains('429') ||
+              errorText.toLowerCase().contains('rate_limit_reached')) {
+            pausedByRateLimit = true;
+            _errorMessage =
+                'Backfill paused by API rate limits after $savedMonths new month(s). Run backfill again in a minute to continue.';
+            if (kDebugMode) {
+              debugPrint(
+                '[RentController] backfill paused by rate limit after $savedMonths month(s)',
+              );
+            }
+            break;
+          }
+          rethrow;
+        }
      }

-      await _storageService.saveRecords(_records);
+      if (kDebugMode) {
+        debugPrint(
+          pausedByRateLimit
+              ? '[RentController] backfillLastYear paused by rate limit'
+              : '[RentController] backfillLastYear completed',
+        );
+      }
      notifyListeners();
-    } catch (err) {
+    } catch (err, stackTrace) {
+      if (kDebugMode) {
+        debugPrint('[RentController] backfillLastYear failed: $err');
+        debugPrint(stackTrace.toString());
+      }
      _errorMessage = err.toString();
    } finally {
      _setLoading(false);
@@ -280,10 +365,12 @@ class RentController extends ChangeNotifier {

      double? usd;
      double? sek;
+      double? rate;

      if (record != null) {
        usd = record.usdAmount;
        sek = record.sekAmount;
+        rate = record.usdToSekRate;
        runningUsd += usd;
        runningSek += sek;
      }
@@ -296,6 +383,7 @@ class RentController extends ChangeNotifier {
          status: status,
          usdAmount: usd,
          sekAmount: sek,
+          effectiveUsdToSekRate: rate,
          runningUsd: runningUsd,
          runningSek: runningSek,
        ),