pkgs/unified_analytics/lib/src/session.dart

// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:convert';

import 'package:clock/clock.dart';
import 'package:file/file.dart';
import 'package:path/path.dart' as p;

import 'constants.dart';

class Session {
  final Directory homeDirectory;
  final FileSystem fs;
  final File _sessionFile;
  int _sessionId;
  int _lastPing;

  /// This constructor will go to the session json file in
  /// the user's home directory and extract the necessary fields from
  /// the json file
  factory Session({
    required Directory homeDirectory,
    required FileSystem fs,
  }) {
    final File sessionFile = fs.file(
        p.join(homeDirectory.path, kDartToolDirectoryName, kSessionFileName));

    final String sessionFileContents = sessionFile.readAsStringSync();
    final Map<String, Object?> sessionObj = jsonDecode(sessionFileContents);
    final int sessionId = sessionObj['session_id'] as int;
    final int lastPing = sessionObj['last_ping'] as int;

    return Session._(
      homeDirectory: homeDirectory,
      fs: fs,
      sessionFile: sessionFile,
      sessionId: sessionId,
      lastPing: lastPing,
    );
  }

  /// Private constructor that will have the variables necessary already parsed
  Session._({
    required this.homeDirectory,
    required this.fs,
    required File sessionFile,
    required int sessionId,
    required int lastPing,
  })  : _sessionFile = sessionFile,
        _sessionId = sessionId,
        _lastPing = lastPing;

  /// This will use the data parsed from the
  /// session json file in the dart-tool directory
  /// to get the session id if the last ping was within
  /// [sessionDurationMinutes]
  ///
  /// If time since last ping exceeds the duration, then the file
  /// will be updated with a new session id and that will be returned
  ///
  /// Note, the file will always be updated when calling this method
  /// because the last ping variable will always need to be persisted
  int getSessionId() {
    _refreshSessionData();
    final DateTime now = clock.now();

    // Convert the epoch time from the last ping into datetime and
    // check if we are within the [sessionDurationMinutes]
    final DateTime lastPingDateTime =
        DateTime.fromMillisecondsSinceEpoch(_lastPing);
    if (now.difference(lastPingDateTime).inMinutes > kSessionDurationMinutes) {
      // In this case, we will need to change both the session id
      // and the last ping value
      _sessionId = now.millisecondsSinceEpoch;
    }

    // Update the last ping to reflect session activity continuing
    _lastPing = now.millisecondsSinceEpoch;

    // Rewrite the session object back to the file to persist
    // for future events
    _sessionFile.writeAsStringSync(toJson());

    return _sessionId;
  }

  /// Return a json formatted representation of the class
  String toJson() => jsonEncode(<String, int>{
        'session_id': _sessionId,
        'last_ping': _lastPing,
      });

  /// This will go to the session file within the dart-tool
  /// directory and fetch the latest data from the json to update
  /// the class's variables
  ///
  /// This allows the session data in this class to always be up
  /// to date incase another tool is also calling this package and
  /// making updates to the session file
  void _refreshSessionData() {
    final String sessionFileContents = _sessionFile.readAsStringSync();
    final Map<String, Object?> sessionObj = jsonDecode(sessionFileContents);
    _sessionId = sessionObj['session_id'] as int;
    _lastPing = sessionObj['last_ping'] as int;
  }
}