Make Caliper an optionally loaded plugin that interfaces with webwork2 via hooks.

This means that the Caliper code does not need to be directly in the
primary webwork2 code, and those that don't use Caliper don't have to
even have it checking to see if it is enabled. Just leave the
`Mojolicious::WeBWorK::Plugin::Caliper` plugin commented out in
`webwork2.mojolicious.yml`. If you want to allow the usage of Caliper on
your server, then uncomment that plugin. Caliper can be configured per
course in `course.conf` files if the plugin is enabled.

This `hook` approach is also extendable. Other plugins, even those not
directly in the webwork2 repository could utilize these hooks.  The
hooks added in this pull request are when user logs in or out, when an
answer is submitted in a regular assignment, and when a page change,
preview, or submission occurs in a test.  Additional hooks could also be
added for further extendability with plugins in the future.

The `$caliper{base_url}` option no longer exists.  Those using Caliper
just need to make sure that the `$server_root_url` and `$webwork_url`
are set correctly in `site.conf`.  The point is that anyone using
webwork2 should do that anyway, so the `$caliper{base_url}` setting was
redundant.

The Caliper packages are heavily updated.  The packages all use
signatures.  Instead of passing both the course environment and database
handle everywhere, just pass the controller which has both of those. In
addition, doing so gives access to do things better. For example, the
environment variable usage (`HTTP_X_FORWARDED_FOR`, `REMOTE_ADDR`,
`HTTP_CLIENT_IP`, `HTTP_USER_AGENT`, and `HTTP_HOST` in
`Caliper/Entity.pm` and `HTTP_REFERER` in `Caliper/Event.pm`) was
clearly broken and not working since the switch to Mojolicious. Since
the controller is now available in those places the things those
environment variables used to provide with modperl and apache can now be
obtained from the controller.

`Mojo::UserAgent` is used instead of `HTTP::Async`. This is the only
place that the outdated and unmaintained `HTTP::Async` package is used.
So drop that dependency.

The UUIDs used now use `create_uuid_as_string` from the `UUID::Tiny`
package, instead of the `Data::UUID` package and essentially
`Data::UUID->new->create_str`. This is done for two reasons.  First,
this is the only use of this dependency.  So that is another dependency
not needed by webwork2.  Second, the Caliper specification recommends
using version 4 UUIDs and `Data::UUID` does not generate version 4
UUIDs, but `UUID::Tiny` does.

The problem source is no longer sent in Caliper events. That really
should never have been done.  That is a large amount of data and is not
needed. This means that even those that do not use Caliper have to
endure the additional server load required to transmit that back from
the rendering process to the main process.  It also makes the Caliper
events much larger in size than they should be. The source file is still
sent and that really should be all that is needed.  The source can be
looked up in the file.

Other than not sending the problem source, everything else sent by the
Caliper implementation is the same. So the implementation still meets
the 1EdTech Caliper specification as much as it did before (the problem
source is certainly not something the specification insists on or is
even considered in the specification). See https://www.imsglobal.org/spec/caliper/v1p2.

Author: drgrice1

Dockerfile

@@ -109,7 +109,6 @@ RUN apt-get update \
 	libgd-perl \
 	libhtml-scrubber-perl \
 	libhtml-template-perl \
-	libhttp-async-perl \
 	libio-compress-perl \
 	libiterator-perl \
 	libiterator-util-perl \
@@ -133,7 +132,6 @@ RUN apt-get update \
 	libnet-ip-perl \
 	libnet-ldap-perl \
 	libnet-oauth-perl \
-	libossp-uuid-perl \
 	libpadwalker-perl \
 	libpandoc-wrapper-perl \
 	libpath-class-perl \
@@ -231,18 +229,18 @@ COPY --from=base /opt/base/pg $APP_ROOT/pg
 RUN echo "PATH=$PATH:$APP_ROOT/webwork2/bin" >> /root/.bashrc \
 	&& mkdir /run/webwork2 /etc/ssl/local \
 	&& cd $APP_ROOT/webwork2/ \
-		&& chown www-data DATA ../courses logs tmp /etc/ssl/local /run/webwork2 \
-		&& chmod -R u+w DATA ../courses logs tmp /run/webwork2 /etc/ssl/local \
+	&& chown www-data DATA ../courses logs tmp /etc/ssl/local /run/webwork2 \
+	&& chmod -R u+w DATA ../courses logs tmp /run/webwork2 /etc/ssl/local \
 	&& echo "en_US ISO-8859-1\nen_US.UTF-8 UTF-8" > /etc/locale.gen \
-		&& /usr/sbin/locale-gen \
-		&& echo "locales locales/default_environment_locale select en_US.UTF-8\ndebconf debconf/frontend select Noninteractive" > /tmp/preseed.txt \
-		&& debconf-set-selections /tmp/preseed.txt \
+	&& /usr/sbin/locale-gen \
+	&& echo "locales locales/default_environment_locale select en_US.UTF-8\ndebconf debconf/frontend select Noninteractive" > /tmp/preseed.txt \
+	&& debconf-set-selections /tmp/preseed.txt \
 	&& rm -f /etc/localtime /etc/timezone && echo "Etc/UTC" > /etc/timezone \
-		&& dpkg-reconfigure -f noninteractive tzdata \
+	&& dpkg-reconfigure -f noninteractive tzdata \
 	&& cd $WEBWORK_ROOT/htdocs \
-		&& npm install \
+	&& npm install \
 	&& cd $PG_ROOT/htdocs \
-		&& npm install
+	&& npm install
 
 # ==================================================================
 # Phase 7 - Final setup and prepare docker-entrypoint.sh

DockerfileStage1

@@ -71,7 +71,6 @@ RUN apt-get update \
 	libgd-perl \
 	libhtml-scrubber-perl \
 	libhtml-template-perl \
-	libhttp-async-perl \
 	libio-compress-perl \
 	libiterator-perl \
 	libiterator-util-perl \
@@ -94,7 +93,6 @@ RUN apt-get update \
 	libnet-ip-perl \
 	libnet-ldap-perl \
 	libnet-oauth-perl \
-	libossp-uuid-perl \
 	libpadwalker-perl \
 	libpandoc-wrapper-perl \
 	libpath-class-perl \

bin/check_modules.pl

@@ -129,12 +129,6 @@ =head1 DESCRIPTION
 			ubuntu => 'libdata-structure-util-perl'
 		}
 	},
-	'Data::UUID' => {
-		package => {
-			ubuntu => 'libossp-uuid-perl',
-			rhel   => 'perl-Data-UUID'
-		}
-	},
 	'Date::Format' => {
 		package => {
 			ubuntu => 'libtimedate-perl',
@@ -283,11 +277,6 @@ =head1 DESCRIPTION
 			rhel   => 'perl-HTML-Parser'
 		}
 	},
-	'HTTP::Async' => {
-		package => {
-			ubuntu => 'libhttp-async-perl'
-		}
-	},
 	'IO::File' => {
 		package => {
 			ubuntu => 'perl-base',

conf/localOverrides.conf.dist

@@ -721,28 +721,35 @@ $mail{feedbackRecipients}    = [
 # Webwork Caliper
 ################################################################################
 
-# enable/disable Caliper for install
-#$caliper{enabled} = 0;
-# base_url should ideally be hard coded to a persistent url pointing to the webwork root
-# (important to keep it consistent over time)
-#$caliper{base_url} = 'https://webwork.elearning.ubc.ca/webwork2/';
-# LRS endpoint
-#$caliper{host} = 'http://caliper.example.host.org/api/endpoint';
+# Set this to 1 to enable Caliper. Note that the
+# Mojolicious::WeBWorK::Plugin::Caliper plugin must also be enabled in
+# conf/webwork2.mojolicous.yml in order for this to work, and all of the
+# $caliper settings below must be uncommented and set except the
+# $caliper{custom_actor_generator}. Note that this and all of the settings below
+# can also be configured per course in the course.conf files.
+$caliper{enabled} = 0;
+
+# LRS endpoint to which the Caliper telemetry data will be sent.
+#$caliper{host} = 'https://caliper.example.host.org/api/endpoint';
+
 # LRS endpoint Bearer API key
 #$caliper{api_key} = '1234567890abcdefg';
-# log file for caliper errors
-#$caliper{errorlog} = $webworkDirs{logs} . "/caliper_errors.log";
-# customized Caliper actor. Useful if persistent identifiers for students are available in WebWork
-# $caliper{custom_actor_generator} = sub {
-# 	my ($ce, $db, $user) = @_;
-# 	# set caliper id as needed
-# 	my $caliper_id = 'http://www.ubc.ca/' . $user->user_id();
-# 	return {
-# 		'id' => $caliper_id,
-# 		'type' => 'Person',
-# 		'name' => $user->first_name() . " " . $user->last_name(),
-# 	};
-# };
+
+# Log file for caliper errors
+#$caliper{errorlog} = "$webworkDirs{logs}/caliper_errors.log";
+
+# Custom Caliper actor generator. This is useful if persistent identifiers for
+# students are available in WebWork.
+#$caliper{custom_actor_generator} = sub {
+#	my ($ce, $db, $user) = @_;
+#	# set caliper id as needed
+#	my $caliper_id = 'http://yourschool.edu/' . $user->user_id;
+#	return {
+#		id   => $caliper_id,
+#		type => 'Person',
+#		name => $user->first_name . ' ' . $user->last_name,
+#	};
+#};
 
 ###############################################################################
 # Test settings

conf/webwork2.mojolicious.dist.yml

@@ -259,3 +259,8 @@ hardcopy:
 # external websites with usernames and passwords embedded in them such as for
 # PreTeXt textbooks.
 allow_unsecured_rpc: 0
+
+plugins:
+  # Uncomment the following to enable Caliper. Also set the Caliper settings in
+  # localOverrides.conf (or per course in course.conf files).
+  #- Mojolicious::WeBWorK::Plugin::Caliper: {}

lib/Caliper/Actor.pm

@@ -1,46 +1,25 @@
 package Caliper::Actor;
-
-##### Library Imports #####
-use strict;
-use warnings;
-use WeBWorK::CourseEnvironment;
-use WeBWorK::DB;
-use Data::Dumper;
+use Mojo::Base -signatures;
 
 use Caliper::ResourceIri;
 
-sub generate_anonymous_actor {
+sub generate_default_actor ($c, $user) {
 	return {
-		'id'   => 'http://purl.imsglobal.org/caliper/Person',
-		'type' => 'Person',
+		id   => Caliper::ResourceIri->new($c->ce)->actor_homepage($user->user_id),
+		type => 'Person',
+		name => $user->first_name . ' ' . $user->last_name
 	};
 }
 
-sub generate_default_actor {
-	my ($ce, $db, $user) = @_;
-	my $resource_iri = Caliper::ResourceIri->new($ce);
-
-	return {
-		'id'   => $resource_iri->actor_homepage($user->user_id()),
-		'type' => 'Person',
-		'name' => $user->first_name() . " " . $user->last_name(),
-	};
-}
+sub generate_actor ($c, $user_id) {
+	return { id => 'http://purl.imsglobal.org/caliper/Person', type => 'Person' } unless defined $user_id;
 
-sub generate_actor {
-	my ($ce, $db, $user_id) = @_;
+	my $user = $c->db->getUser($user_id);
 
-	if (!defined($user_id)) {
-		return Caliper::Entity::generate_anonymous_actor();
-	} else {
-		my $user = $db->getUser($user_id);
+	return $c->ce->{caliper}{custom_actor_generator}($c->ce, $c->db, $user)
+		if ref $c->ce->{caliper}{custom_actor_generator} eq 'CODE';
 
-		if (defined($ce->{caliper}{custom_actor_generator})) {
-			return $ce->{caliper}{custom_actor_generator}($ce, $db, $user);
-		} else {
-			return generate_default_actor($ce, $db, $user);
-		}
-	}
+	return generate_default_actor($c, $user);
 }
 
 1;