From 4b8fd09b272fc8cbc22a2f705e216f1eb6238722 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Mon, 2 Jan 2023 05:59:16 +0100
Subject: [PATCH] move traewelling sync to a separate command

---
 examples/travelynx.conf              |  16 +++
 lib/Travelynx/Command/traewelling.pm | 146 +++++++++++++++++++++++++++
 lib/Travelynx/Command/work.pm        |  98 ++----------------
 3 files changed, 171 insertions(+), 89 deletions(-)
 create mode 100644 lib/Travelynx/Command/traewelling.pm

diff --git a/examples/travelynx.conf b/examples/travelynx.conf
index 535fb43..c717376 100644
--- a/examples/travelynx.conf
+++ b/examples/travelynx.conf
@@ -94,5 +94,21 @@
 		die("Changeme!"),
 	],
 
+	traewelling => {
+		# By default, the "work" or "worker" command does not just update
+		# real-time data of active journeys, but also performs push and pull
+		# synchronization with traewelling for accounts that have configured it.
+		# Traewelling pull synchronization currently relies on polling the user
+		# status on traewelling.de, so large travelynx instances may want to
+		# run pull synchronization less frequently than regular "work" commands
+		# and traewelling push synchronization.
+		#
+		# To do so, uncomment "separate_worker" below and create a cronjob that
+		# periodically runs "perl index.pl traewelling" (push and pull) or
+		# two separate cronjobs that run "perl index.pl traewelling push" and
+		# "perl index.pl traewelling pull", respectively.
+		## separate_worker => 1,
+	},
+
 	version => qx{git describe --dirty} // 'experimental',
 };
diff --git a/lib/Travelynx/Command/traewelling.pm b/lib/Travelynx/Command/traewelling.pm
new file mode 100644
index 0000000..5967b28
--- /dev/null
+++ b/lib/Travelynx/Command/traewelling.pm
@@ -0,0 +1,146 @@
+package Travelynx::Command::traewelling;
+
+# Copyright (C) 2023 Daniel Friesel
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+use Mojo::Base 'Mojolicious::Command';
+use Mojo::Promise;
+
+use DateTime;
+use JSON;
+use List::Util;
+
+has description => 'Synchronize with Traewelling';
+
+has usage => sub { shift->extract_usage };
+
+sub pull_sync {
+	my ($self) = @_;
+	my $request_count = 0;
+	for my $account_data ( $self->app->traewelling->get_pull_accounts ) {
+
+		my $in_transit = $self->app->in_transit->get(
+			uid => $account_data->{user_id},
+		);
+		if ($in_transit) {
+			$self->app->log->debug(
+"Skipping Traewelling status pull for UID $account_data->{user_id}: already checked in"
+			);
+			next;
+		}
+
+		# $account_data->{user_id} is the travelynx uid
+		# $account_data->{user_name} is the Träwelling username
+		$request_count += 1;
+		$self->app->log->debug(
+"Scheduling Traewelling status pull for UID $account_data->{user_id}"
+		);
+
+		# In 'work', the event loop is not running,
+		# so there's no need to multiply by $request_count at the moment
+		Mojo::Promise->timer(0.5)->then(
+			sub {
+				return $self->app->traewelling_api->get_status_p(
+					username => $account_data->{data}{user_name},
+					token    => $account_data->{token}
+				);
+			}
+		)->then(
+			sub {
+				my ($traewelling) = @_;
+				$self->app->traewelling_to_travelynx(
+					traewelling => $traewelling,
+					user_data   => $account_data
+				);
+			}
+		)->catch(
+			sub {
+				my ($err) = @_;
+				$self->app->traewelling->log(
+					uid      => $account_data->{user_id},
+					message  => "Fehler bei der Status-Abfrage: $err",
+					is_error => 1
+				);
+				$self->app->log->debug("Error $err");
+			}
+		)->wait;
+	}
+}
+
+sub push_sync {
+	my ($self) = @_;
+
+	for my $candidate ( $self->app->traewelling->get_pushable_accounts ) {
+		$self->app->log->debug(
+			"Pushing to Traewelling for UID $candidate->{uid}");
+		my $trip_id = $candidate->{journey_data}{trip_id};
+		if ( not $trip_id ) {
+			$self->app->log->debug("... trip_id is missing");
+			$self->app->traewelling->log(
+				uid     => $candidate->{uid},
+				message =>
+"Konnte $candidate->{train_type} $candidate->{train_no} nicht übertragen: Keine trip_id vorhanden",
+				is_error => 1
+			);
+			next;
+		}
+		if (    $candidate->{data}{latest_push_ts}
+			and $candidate->{data}{latest_push_ts} == $candidate->{checkin_ts} )
+		{
+			$self->app->log->debug("... already handled");
+			next;
+		}
+		$self->app->traewelling_api->checkin( %{$candidate},
+			trip_id => $trip_id );
+	}
+}
+
+sub run {
+	my ( $self, $direction ) = @_;
+
+	my $now        = DateTime->now( time_zone => 'Europe/Berlin' );
+	my $started_at = $now;
+
+	if ( not $direction or $direction eq 'push' ) {
+		$self->push_sync;
+	}
+
+	my $trwl_push_finished_at = DateTime->now( time_zone => 'Europe/Berlin' );
+
+	if ( not $direction or $direction eq 'pull' ) {
+		$self->pull_sync;
+	}
+
+	my $trwl_pull_finished_at = DateTime->now( time_zone => 'Europe/Berlin' );
+
+	my $trwl_push_duration = $trwl_push_finished_at->epoch - $started_at->epoch;
+	my $trwl_pull_duration
+	  = $trwl_pull_finished_at->epoch - $trwl_push_finished_at->epoch;
+	my $trwl_duration = $trwl_pull_finished_at->epoch - $started_at->epoch;
+
+	if ( $self->app->config->{influxdb}->{url} ) {
+		my $report = "sync_runtime_seconds=${trwl_duration}";
+		if ( not $direction or $direction eq 'push' ) {
+			$report .= ",push_runtime_seconds=${trwl_push_duration}";
+		}
+		if ( not $direction or $direction eq 'pull' ) {
+			$report .= ",pull_runtime_seconds=${trwl_pull_duration}";
+		}
+		$self->app->ua->post_p( $self->app->config->{influxdb}->{url},
+			"traewelling ${report}" )->wait;
+	}
+}
+
+1;
+
+__END__
+
+=head1 SYNOPSIS
+
+  Usage: index.pl traewelling [direction]
+
+  Performs both push and pull synchronization by default.
+  If "direction" is specified, only synchronizes in the specified direction
+  ("push" or "pull")
+
+  Should be called from a cronjob every three to ten minutes.
diff --git a/lib/Travelynx/Command/work.pm b/lib/Travelynx/Command/work.pm
index 05ebb16..2cf3784 100644
--- a/lib/Travelynx/Command/work.pm
+++ b/lib/Travelynx/Command/work.pm
@@ -1,6 +1,6 @@
 package Travelynx::Command::work;
 
-# Copyright (C) 2020 Daniel Friesel
+# Copyright (C) 2020-2023 Daniel Friesel
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
 use Mojo::Base 'Mojolicious::Command';
@@ -10,8 +10,7 @@ use DateTime;
 use JSON;
 use List::Util;
 
-has description =>
-  'Perform automatic checkout when users arrive at their destination';
+has description => 'Update real-time data of active journeys';
 
 has usage => sub { shift->extract_usage };
 
@@ -182,95 +181,16 @@ sub run {
 
 	my $started_at       = $now;
 	my $main_finished_at = DateTime->now( time_zone => 'Europe/Berlin' );
-
-	for my $candidate ( $self->app->traewelling->get_pushable_accounts ) {
-		$self->app->log->debug(
-			"Pushing to Traewelling for UID $candidate->{uid}");
-		my $trip_id = $candidate->{journey_data}{trip_id};
-		if ( not $trip_id ) {
-			$self->app->log->debug("... trip_id is missing");
-			$self->app->traewelling->log(
-				uid     => $candidate->{uid},
-				message =>
-"Konnte $candidate->{train_type} $candidate->{train_no} nicht übertragen: Keine trip_id vorhanden",
-				is_error => 1
-			);
-			next;
-		}
-		if (    $candidate->{data}{latest_push_ts}
-			and $candidate->{data}{latest_push_ts} == $candidate->{checkin_ts} )
-		{
-			$self->app->log->debug("... already handled");
-			next;
-		}
-		$self->app->traewelling_api->checkin( %{$candidate},
-			trip_id => $trip_id );
-	}
-	my $trwl_push_finished_at = DateTime->now( time_zone => 'Europe/Berlin' );
-
-	my $request_count = 0;
-	for my $account_data ( $self->app->traewelling->get_pull_accounts ) {
-
-		my $in_transit = $self->app->in_transit->get(
-			uid => $account_data->{user_id},
-		);
-		if ($in_transit) {
-			$self->app->log->debug(
-"Skipping Traewelling status pull for UID $account_data->{user_id}: already checked in"
-			);
-			next;
-		}
-
-		# $account_data->{user_id} is the travelynx uid
-		# $account_data->{user_name} is the Träwelling username
-		$request_count += 1;
-		$self->app->log->debug(
-"Scheduling Traewelling status pull for UID $account_data->{user_id}"
-		);
-
-		# In 'work', the event loop is not running,
-		# so there's no need to multiply by $request_count at the moment
-		Mojo::Promise->timer(0.5)->then(
-			sub {
-				return $self->app->traewelling_api->get_status_p(
-					username => $account_data->{data}{user_name},
-					token    => $account_data->{token}
-				);
-			}
-		)->then(
-			sub {
-				my ($traewelling) = @_;
-				$self->app->traewelling_to_travelynx(
-					traewelling => $traewelling,
-					user_data   => $account_data
-				);
-			}
-		)->catch(
-			sub {
-				my ($err) = @_;
-				$self->app->traewelling->log(
-					uid      => $account_data->{user_id},
-					message  => "Fehler bei der Status-Abfrage: $err",
-					is_error => 1
-				);
-				$self->app->log->debug("Error $err");
-			}
-		)->wait;
-	}
-	my $trwl_pull_finished_at = DateTime->now( time_zone => 'Europe/Berlin' );
-
-	my $worker_duration = $main_finished_at->epoch - $started_at->epoch;
-	my $trwl_push_duration
-	  = $trwl_push_finished_at->epoch - $main_finished_at->epoch;
-	my $trwl_pull_duration
-	  = $trwl_pull_finished_at->epoch - $trwl_push_finished_at->epoch;
-	my $trwl_duration
-	  = $trwl_pull_finished_at->epoch - $main_finished_at->epoch;
+	my $worker_duration  = $main_finished_at->epoch - $started_at->epoch;
 
 	if ( $self->app->config->{influxdb}->{url} ) {
 		$self->app->ua->post_p( $self->app->config->{influxdb}->{url},
-"worker main_seconds=${worker_duration},traewelling_push_seconds=${trwl_push_duration},traewelling_pull_seconds=${trwl_pull_duration},traewelling_seconds=${trwl_duration},errors=${errors}"
-		)->wait;
+			"worker runtime_seconds=${worker_duration},errors=${errors}" )
+		  ->wait;
+	}
+
+	if ( not $self->app->config->{traewelling}->{separate_worker} ) {
+		$self->app->start('traewelling');
 	}
 }