From b047e8e5520fc3d39606feb9ee28d04861050cf8 Mon Sep 17 00:00:00 2001
From: Bozana Bokan <bozana.bokan@posteo.net>
Date: Thu, 18 Aug 2022 13:45:14 +0200
Subject: [PATCH] pkp/pkp-lib#6782 do not use installation migrations in the
 upgrade

---
 .../v3_4_0/I6782_CreateNewMetricsTables.php   | 229 ++++++++++++++++++
 dbscripts/xml/upgrade.xml                     |   4 +-
 2 files changed, 231 insertions(+), 2 deletions(-)
 create mode 100644 classes/migration/upgrade/v3_4_0/I6782_CreateNewMetricsTables.php

diff --git a/classes/migration/upgrade/v3_4_0/I6782_CreateNewMetricsTables.php b/classes/migration/upgrade/v3_4_0/I6782_CreateNewMetricsTables.php
new file mode 100644
index 0000000000..73bfe00b8b
--- /dev/null
+++ b/classes/migration/upgrade/v3_4_0/I6782_CreateNewMetricsTables.php
@@ -0,0 +1,229 @@
+<?php
+
+/**
+ * @file classes/migration/install/I6782_CreateNewMetricsTables.inc.php
+ *
+ * Copyright (c) 2022 Simon Fraser University
+ * Copyright (c) 2022 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I6782_CreateNewMetricsTables
+ * @brief Describe database table structures.
+ */
+
+namespace APP\migration\upgrade\v3_4_0;
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema as Schema;
+use PKP\install\DowngradeNotSupportedException;
+use PKP\migration\Migration;
+
+class I6782_CreateNewMetricsTables extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        // Metrics tables
+        Schema::create('metrics_context', function (Blueprint $table) {
+            $table->string('load_id', 255);
+            $table->bigInteger('context_id');
+            $table->date('date');
+            $table->integer('metric');
+            $table->foreign('context_id')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->index(['load_id'], 'metrics_context_load_id');
+            $table->index(['context_id'], 'metrics_context_context_id');
+        });
+        Schema::create('metrics_submission', function (Blueprint $table) {
+            $table->string('load_id', 255);
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->bigInteger('representation_id')->nullable();
+            $table->bigInteger('submission_file_id')->unsigned()->nullable();
+            $table->bigInteger('file_type')->nullable();
+            $table->bigInteger('assoc_type');
+            $table->date('date');
+            $table->integer('metric');
+            $table->foreign('context_id')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->foreign('representation_id')->references('galley_id')->on('publication_galleys')->onDelete('cascade');
+            $table->foreign('submission_file_id')->references('submission_file_id')->on('submission_files')->onDelete('cascade');
+            $table->index(['load_id'], 'ms_load_id');
+            $table->index(['context_id', 'submission_id', 'assoc_type', 'file_type'], 'ms_context_id_submission_id_assoc_type_file_type');
+        });
+        Schema::create('metrics_counter_submission_daily', function (Blueprint $table) {
+            $table->string('load_id', 255);
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->date('date');
+            $table->integer('metric_investigations');
+            $table->integer('metric_investigations_unique');
+            $table->integer('metric_requests');
+            $table->integer('metric_requests_unique');
+            $table->foreign('context_id', 'msd_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'msd_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->index(['load_id'], 'msd_load_id');
+            $table->index(['context_id', 'submission_id'], 'msd_context_id_submission_id');
+            $table->unique(['load_id', 'context_id', 'submission_id', 'date'], 'msd_uc_load_id_context_id_submission_id_date');
+        });
+        Schema::create('metrics_counter_submission_monthly', function (Blueprint $table) {
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->integer('month');
+            $table->integer('metric_investigations');
+            $table->integer('metric_investigations_unique');
+            $table->integer('metric_requests');
+            $table->integer('metric_requests_unique');
+            $table->foreign('context_id', 'msm_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'msm_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->index(['context_id', 'submission_id'], 'msm_context_id_submission_id');
+            $table->unique(['context_id', 'submission_id', 'month'], 'msm_uc_context_id_submission_id_month');
+        });
+        Schema::create('metrics_counter_submission_institution_daily', function (Blueprint $table) {
+            $table->string('load_id', 255);
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->bigInteger('institution_id');
+            $table->date('date');
+            $table->integer('metric_investigations');
+            $table->integer('metric_investigations_unique');
+            $table->integer('metric_requests');
+            $table->integer('metric_requests_unique');
+            $table->foreign('context_id', 'msid_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'msid_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->foreign('institution_id', 'msid_institution_id_foreign')->references('institution_id')->on('institutions')->onDelete('cascade');
+            $table->index(['load_id'], 'msid_load_id');
+            $table->index(['context_id', 'submission_id'], 'msid_context_id_submission_id');
+            $table->unique(['load_id', 'context_id', 'submission_id', 'institution_id', 'date'], 'msid_uc_load_id_context_id_submission_id_institution_id_date');
+        });
+        Schema::create('metrics_counter_submission_institution_monthly', function (Blueprint $table) {
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->bigInteger('institution_id');
+            $table->integer('month');
+            $table->integer('metric_investigations');
+            $table->integer('metric_investigations_unique');
+            $table->integer('metric_requests');
+            $table->integer('metric_requests_unique');
+            $table->foreign('context_id', 'msim_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'msim_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->foreign('institution_id', 'msim_institution_id_foreign')->references('institution_id')->on('institutions')->onDelete('cascade');
+            $table->index(['context_id', 'submission_id'], 'msim_context_id_submission_id');
+            $table->unique(['context_id', 'submission_id', 'institution_id', 'month'], 'msim_uc_context_id_submission_id_institution_id_month');
+        });
+        Schema::create('metrics_submission_geo_daily', function (Blueprint $table) {
+            $table->string('load_id', 255);
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->string('country', 2)->default('');
+            $table->string('region', 3)->default('');
+            $table->string('city', 255)->default('');
+            $table->date('date');
+            $table->integer('metric');
+            $table->integer('metric_unique');
+            $table->foreign('context_id', 'msgd_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'msgd_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->index(['load_id'], 'msgd_load_id');
+            $table->index(['context_id', 'submission_id'], 'msgd_context_id_submission_id');
+            $table->unique(['load_id', 'context_id', 'submission_id', 'country', 'region', 'city', 'date'], 'msgd_uc_load_context_submission_c_r_c_date');
+        });
+        Schema::create('metrics_submission_geo_monthly', function (Blueprint $table) {
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->string('country', 2)->default('');
+            $table->string('region', 3)->default('');
+            $table->string('city', 255)->default('');
+            $table->integer('month');
+            $table->integer('metric');
+            $table->integer('metric_unique');
+            $table->foreign('context_id', 'msgm_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'msgm_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->index(['context_id', 'submission_id'], 'msgm_context_id_submission_id');
+            $table->unique(['context_id', 'submission_id', 'country', 'region', 'city', 'month'], 'msgm_uc_context_submission_c_r_c_month');
+        });
+        // Usage stats total item temporary records
+        Schema::create('usage_stats_total_temporary_records', function (Blueprint $table) {
+            $table->dateTime('date', $precision = 0);
+            $table->string('ip', 255);
+            $table->string('user_agent', 255);
+            $table->bigInteger('line_number');
+            $table->string('canonical_url', 255);
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id')->nullable();
+            $table->bigInteger('representation_id')->nullable();
+            $table->bigInteger('submission_file_id')->unsigned()->nullable();
+            $table->bigInteger('assoc_type');
+            $table->smallInteger('file_type')->nullable();
+            $table->string('country', 2)->default('');
+            $table->string('region', 3)->default('');
+            $table->string('city', 255)->default('');
+            $table->string('load_id', 255);
+            $table->foreign('context_id', 'ust_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'ust_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->foreign('representation_id', 'ust_representation_id_foreign')->references('galley_id')->on('publication_galleys')->onDelete('cascade');
+            $table->foreign('submission_file_id', 'ust_submission_file_id_foreign')->references('submission_file_id')->on('submission_files')->onDelete('cascade');
+        });
+        // Usage stats unique item investigations temporary records
+        Schema::create('usage_stats_unique_item_investigations_temporary_records', function (Blueprint $table) {
+            $table->dateTime('date', $precision = 0);
+            $table->string('ip', 255);
+            $table->string('user_agent', 255);
+            $table->bigInteger('line_number');
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->bigInteger('representation_id')->nullable();
+            $table->bigInteger('submission_file_id')->unsigned()->nullable();
+            $table->bigInteger('assoc_type');
+            $table->smallInteger('file_type')->nullable();
+            $table->string('country', 2)->default('');
+            $table->string('region', 3)->default('');
+            $table->string('city', 255)->default('');
+            $table->string('load_id', 255);
+            $table->foreign('context_id', 'usii_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'usii_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->foreign('representation_id', 'usii_representation_id_foreign')->references('galley_id')->on('publication_galleys')->onDelete('cascade');
+            $table->foreign('submission_file_id', 'usii_submission_file_id_foreign')->references('submission_file_id')->on('submission_files')->onDelete('cascade');
+        });
+        // Usage stats unique item requests temporary records
+        Schema::create('usage_stats_unique_item_requests_temporary_records', function (Blueprint $table) {
+            $table->dateTime('date', $precision = 0);
+            $table->string('ip', 255);
+            $table->string('user_agent', 255);
+            $table->bigInteger('line_number');
+            $table->bigInteger('context_id');
+            $table->bigInteger('submission_id');
+            $table->bigInteger('representation_id')->nullable();
+            $table->bigInteger('submission_file_id')->unsigned()->nullable();
+            $table->bigInteger('assoc_type');
+            $table->smallInteger('file_type')->nullable();
+            $table->string('country', 2)->default('');
+            $table->string('region', 3)->default('');
+            $table->string('city', 255)->default('');
+            $table->string('load_id', 255);
+            $table->foreign('context_id', 'usir_context_id_foreign')->references('server_id')->on('servers')->onDelete('cascade');
+            $table->foreign('submission_id', 'usir_submission_id_foreign')->references('submission_id')->on('submissions')->onDelete('cascade');
+            $table->foreign('representation_id', 'usir_representation_id_foreign')->references('galley_id')->on('publication_galleys')->onDelete('cascade');
+            $table->foreign('submission_file_id', 'usir_submission_file_id_foreign')->references('submission_file_id')->on('submission_files')->onDelete('cascade');
+        });
+        // Usage stats institution temporary records
+        // This table is needed because of data normalization
+        Schema::create('usage_stats_institution_temporary_records', function (Blueprint $table) {
+            $table->string('load_id', 255);
+            $table->bigInteger('line_number');
+            $table->bigInteger('institution_id');
+            $table->foreign('institution_id', 'usi_institution_id_foreign')->references('institution_id')->on('institutions')->onDelete('cascade');
+            $table->unique(['load_id', 'line_number', 'institution_id'], 'usitr_load_id_line_number_institution_id');
+        });
+    }
+
+    /**
+     * Reverse the downgrades
+     *
+     * @throws DowngradeNotSupportedException
+     */
+    public function down(): void
+    {
+        throw new DowngradeNotSupportedException();
+    }
+}
diff --git a/dbscripts/xml/upgrade.xml b/dbscripts/xml/upgrade.xml
index c00fba2370..4a3e0ed2d1 100644
--- a/dbscripts/xml/upgrade.xml
+++ b/dbscripts/xml/upgrade.xml
@@ -51,10 +51,10 @@
 		<data file="dbscripts/xml/upgrade/3.4.0_preupdate_email_templates.xml" />
 		<code function="installEmailTemplate" key="EDITOR_DECISION_NOTIFY_OTHER_AUTHORS" locales="en_US" />
 		<code function="installEmailTemplate" key="EDITOR_DECISION_REVERT_INITIAL_DECLINE" locales="en_US" />
-		<migration class="PKP\migration\install\InstitutionsMigration" />
+		<migration class="PKP\migration\upgrade\v3_4_0\I6895_CreateNewInstitutionsTables" />
 		<migration class="APP\migration\upgrade\v3_4_0\I6782_OrphanedMetrics" />
 		<migration class="PKP\migration\upgrade\v3_4_0\I6782_UsageStatsSettings" />
-		<migration class="APP\migration\install\MetricsMigration" />
+		<migration class="APP\migration\upgrade\v3_4_0\I6782_CreateNewMetricsTables" />
 		<migration class="APP\migration\upgrade\v3_4_0\I6782_MetricsContext" />
 		<migration class="APP\migration\upgrade\v3_4_0\I6782_MetricsSubmission" />
 		<migration class="APP\migration\upgrade\v3_4_0\I6782_MetricsGeo" />