opengamedata-common 0.0.1__tar.gz

opengamedata_common-0.0.1/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

opengamedata_common-0.0.1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.1
+Name: opengamedata-common
+Version: 0.0.1
+Summary: A package for shared code used by other packages/tools in the OpenGameData software ecosystem.
+Author-email: Luke Swanson <superscription58@gmail.com>, David Gagnon <djgagnon@wisc.edu>
+Project-URL: Homepage, https://github.com/opengamedata/ogd-common
+Project-URL: Bug Tracker, https://github.com/opengamedata/ogd-common/issues
+Project-URL: Documentation, https://opengamedata-doc.readthedocs.io/en/latest/index.html
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gitdb>=4.0.11
+Requires-Dist: GitPython>=3.1.31
+Requires-Dist: google-cloud-bigquery==3.19.0
+Requires-Dist: mysql-connector-python==8.0.25
+Requires-Dist: numpy==1.26.*
+Requires-Dist: pandas==2.2.*
+Requires-Dist: sshtunnel==0.4.0
+
+# ogd-common
+Repository for commonly-shared components across OpenGameData projects, especially schemas and interfaces/outerfaces.

opengamedata_common-0.0.1/README.md

@@ -0,0 +1,2 @@
+# ogd-common
+Repository for commonly-shared components across OpenGameData projects, especially schemas and interfaces/outerfaces.

opengamedata_common-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = [
+    "build == 1.2.*",
+    "setuptools == 74.1.*",
+    "setuptools-git-versioning == 2.0.*",
+    "twine == 5.1.*",
+    "wheel == 0.44.*"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools-git-versioning]
+enabled = true
+
+[project]
+name = "opengamedata-common"
+dynamic = ["version", "dependencies"]
+authors = [
+   { name="Luke Swanson", email="superscription58@gmail.com" },
+   { name="David Gagnon", email="djgagnon@wisc.edu" }
+]
+description = "A package for shared code used by other packages/tools in the OpenGameData software ecosystem."
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/opengamedata/ogd-common"
+"Bug Tracker" = "https://github.com/opengamedata/ogd-common/issues"
+"Documentation" = "https://opengamedata-doc.readthedocs.io/en/latest/index.html"

opengamedata_common-0.0.1/requirements.txt

@@ -0,0 +1,7 @@
+gitdb>=4.0.11
+GitPython>=3.1.31
+google-cloud-bigquery==3.19.0
+mysql-connector-python==8.0.25
+numpy==1.26.*
+pandas==2.2.*
+sshtunnel==0.4.0

opengamedata_common-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

opengamedata_common-0.0.1/src/ogd/common/interfaces/BQFirebaseInterface.py

@@ -0,0 +1,217 @@
+import json
+import logging
+import os
+from datetime import datetime
+from typing import Dict, Final, List, Tuple, Optional
+# import locals
+from ogd.common.interfaces.BigQueryInterface import BigQueryInterface
+from ogd.common.models.enums.IDMode import IDMode
+from ogd.common.schemas.configs.GameSourceSchema import GameSourceSchema
+from ogd.core.utils.Logger import Logger
+
+AQUALAB_MIN_VERSION : Final[float] = 6.2
+
+class BQFirebaseInterface(BigQueryInterface):
+    """Subclass of the general BigQueryInterface, with re-implemented queries to handle old Firebase unnest bullshit.
+    """
+
+    # *** BUILT-INS ***
+
+    def __init__(self, game_id:str, config:GameSourceSchema, fail_fast:bool):
+        super().__init__(game_id=game_id, config=config, fail_fast=fail_fast)
+        self.Open()
+
+    # *** RE-IMPLEMENT ABSTRACT FUNCTIONS ***
+
+    def _allIDs(self) -> List[str]:
+        query = f"""
+            SELECT DISTINCT param.value.int_value AS session_id
+            FROM `{self.DBPath()}`,
+            UNNEST(event_params) AS param
+            WHERE param.key = "ga_session_id"
+        """
+        Logger.Log(f"BQ-Firebase: Running query for all ids:\n{query}", logging.DEBUG, depth=3)
+        data = self._client.query(query)
+        ids = [str(row['session_id']) for row in data]
+        return ids if ids != None else []
+
+    def _fullDateRange(self) -> Dict[str, datetime]:
+        query = f"""
+            WITH datetable AS
+            (
+                SELECT event_date, event_timestamp,
+                FORMAT_DATE('%m-%d-%Y', PARSE_DATE('%Y%m%d', event_date)) AS date, 
+                FORMAT_TIME('%T', TIME(TIMESTAMP_MICROS(event_timestamp))) AS time,
+                FROM `{self.DBPath()}`
+            )
+            SELECT MIN(concat(date, ' ', time)), MAX(concat(date, ' ', time))
+            FROM datetable
+        """
+        Logger.Log(f"BQ-Firebase: Running query for full date range:\n{query}", logging.DEBUG, depth=3)
+        data = list(self._client.query(query))
+        return {'min':data[0][0], 'max':data[0][1]}
+
+    def _rowsFromIDs(self, id_list:List[str], id_mode:IDMode=IDMode.SESSION, versions:Optional[List[int]] = None, exclude_rows:Optional[List[str]]=None) -> List[Tuple]:
+        events = None
+        if self._client != None:
+            query = self._generateRowFromIDQuery(id_list=id_list, id_mode=id_mode, exclude_rows=exclude_rows)
+            Logger.Log(f"BQ-Firebase: Running query for rows from IDs:\n{query}", logging.DEBUG, depth=3)
+            data = self._client.query(query)
+            events = []
+            for row in data:
+                items = tuple(row.items())
+                event = []
+                for item in items:
+                    match item[0]:
+                        case "event_params":
+                            _params = {param['key']:param['value'] for param in item[1]}
+                            event.append(json.dumps(_params, sort_keys=True))
+                        case "device":
+                            event.append(json.dumps(item[1], sort_keys=True))
+                        case _:
+                            event.append(item[1])
+                events.append(tuple(event))
+        return events if events != None else []
+
+    def _IDsFromDates(self, min:datetime, max:datetime, versions:Optional[List[int]] = None) -> List[str]:
+        ret_val = []
+        str_min, str_max = min.strftime("%Y%m%d"), max.strftime("%Y%m%d")
+        query = f"""
+            SELECT DISTINCT param.value.int_value AS session_id
+            FROM `{self.DBPath(min_date=min.date(), max_date=max.date())}`,
+            UNNEST(event_params) AS param
+            WHERE param.key = "ga_session_id"
+            AND _TABLE_SUFFIX BETWEEN '{str_min}' AND '{str_max}'
+        """
+        Logger.Log(f"BQ-Firebase: Running query for ids from dates:\n{query}", logging.DEBUG, depth=3)
+        data = self._client.query(query)
+        ids = [str(row['session_id']) for row in data]
+        if ids is not None:
+            ret_val = ids
+        return ret_val
+
+    def _datesFromIDs(self, id_list:List[str], id_mode:IDMode=IDMode.SESSION, versions:Optional[List[int]] = None) -> Dict[str, datetime]:
+        match id_mode:
+            case IDMode.SESSION:
+                id_string = ','.join([f"{x}" for x in id_list])
+                where_clause = f"""
+                    WHERE param.key = "ga_session_id"
+                    AND param.value.int_value IN ({id_string})
+                """
+            case IDMode.USER:
+                id_string = ','.join([f"'{x}'" for x in id_list])
+                where_clause = f"""
+                    WHERE param.key = "user_code"
+                    AND param.value.string_value IN ({id_string})
+                """
+            case _:
+                Logger.Log(f"Invalid ID mode given (name={id_mode.name}, val={id_mode.value}), defaulting to session mode.", logging.WARNING, depth=3)
+                id_string = ','.join([f"{x}" for x in id_list])
+                where_clause = f"""
+                    WHERE param.key = "ga_session_id"
+                    AND param.value.int_value IN ({id_string})
+                """
+        query = f"""
+            WITH datetable AS
+            (
+                SELECT event_date, event_timestamp, event_params,
+                FORMAT_DATE('%m-%d-%Y', PARSE_DATE('%Y%m%d', event_date)) AS date, 
+                FORMAT_TIME('%T', TIME(TIMESTAMP_MICROS(event_timestamp))) AS time,
+                FROM `{self.DBPath()}`
+            )
+            SELECT MIN(concat(date, ' ', time)), MAX(concat(date, ' ', time))
+            FROM datetable,
+            UNNEST(event_params) AS param
+            {where_clause}
+        """
+        Logger.Log(f"BQ-Firebase: Running query for dates from IDs:\n{query}", logging.DEBUG, depth=3)
+        data = list(self._client.query(query))
+        ret_val : Dict[str, datetime] = {}
+        if len(data) == 1:
+            dates = data[0]
+            if len(dates) == 2 and dates[0] is not None and dates[1] is not None:
+                ret_val = {'min':datetime.strptime(dates[0], "%m-%d-%Y %H:%M:%S"), 'max':datetime.strptime(dates[1], "%m-%d-%Y %H:%M:%S")}
+            else:
+                Logger.Log(f"BQFirebaseInterface query did not give both a min and a max, setting both to 'now'", logging.WARNING, depth=3)
+                ret_val = {'min':datetime.now(), 'max':datetime.now()}
+        else:
+            Logger.Log(f"BQ-Firebase: Query did not return any results, setting both min and max to 'now'", logging.WARNING, depth=3)
+            ret_val = {'min':datetime.now(), 'max':datetime.now()}
+        return ret_val
+
+    # *** PUBLIC STATICS ***
+
+    # *** PUBLIC METHODS ***
+
+    # *** PROPERTIES ***
+
+    # *** PRIVATE STATICS ***
+
+    # *** PRIVATE METHODS ***
+
+    def _generateRowFromIDQuery(self, id_list:List[str], id_mode:IDMode, exclude_rows:Optional[List[str]]=None) -> str:
+    # 2) Set up clauses to select based on Session ID or Player ID.
+        session_clause : str = ""
+        player_clause  : str = ""
+        match id_mode:
+            case IDMode.SESSION:
+                id_string = ','.join([f"{x}" for x in id_list])
+                session_clause = f"param_session.key = 'ga_session_id' AND param_session.value.int_value IN ({id_string})"
+                player_clause  = f"(param_user.key   = 'user_code'     OR  param_user.key = 'undefined')"
+            case IDMode.USER:
+                id_string = ','.join([f"'{x}'" for x in id_list])
+                session_clause = f"param_session.key = 'ga_session_id'"
+                player_clause  = f"(param_user.key   = 'user_code' OR param_user.key = 'undefined') AND param_user.value.string_value IN ({id_string})"
+            case _:
+                Logger.Log(f"BQ-Firebase: Invalid ID mode given (name={id_mode.name}, val={id_mode.value}), defaulting to session mode.", logging.WARNING, depth=3)
+                id_string = ','.join([f"{x}" for x in id_list])
+                session_clause = f"param_session.key = 'ga_session_id' AND param_session.value.int_value IN ({id_string})"
+                player_clause  = f"(param_user.key   = 'user_code' OR param_user.key = 'undefined')"
+    # 3) Set up WHERE clause based on whether we need Aqualab min version or not.
+        match self._game_id:
+            case "SHADOWSPECT" | "SHIPWRECKS":
+                where_clause = \
+                f"WHERE {session_clause}"
+            case _:
+                where_clause = \
+                f"""WHERE param_app_version.key = 'app_version'
+                    AND   param_log_version.key = 'log_version'
+                    AND   {session_clause}
+                    AND   {player_clause}"""
+    # 4) Set up actual query
+        query = ""
+        match self._game_id:
+            case "SHADOWSPECT" | "SHIPWRECKS":
+                query = f"""
+                    SELECT event_name, event_params, device, platform,
+                    concat(FORMAT_DATE('%Y-%m-%d', PARSE_DATE('%Y%m%d', event_date)), FORMAT_TIME('T%H:%M:%S.00', TIME(TIMESTAMP_MICROS(event_timestamp)))) AS timestamp,
+                    null as app_version,
+                    null as log_version,
+                    param_session.value.int_value as session_id,
+                    null as fd_user_id
+                    FROM `{self.DBPath()}`
+                    CROSS JOIN UNNEST(event_params) AS param_session
+                    {where_clause}
+                    ORDER BY `session_id`, `timestamp` ASC;
+                """
+            case _:
+                # TODO Order by user_id, and by timestamp within that.
+                # Note that this could prove to be wonky when we have more games without user ids,
+                # will need to really rethink this when we start using new system.
+                # Still, not a huge deal because most of these will be rewritten at that time anyway.
+                query = f"""
+                    SELECT event_name, event_params, device, platform,
+                    concat(FORMAT_DATE('%Y-%m-%d', PARSE_DATE('%Y%m%d', event_date)), FORMAT_TIME('T%H:%M:%S.00', TIME(TIMESTAMP_MICROS(event_timestamp)))) AS timestamp,
+                    param_app_version.value.string_value as app_version,
+                    param_log_version.value.int_value as log_version,
+                    param_session.value.int_value as session_id,
+                    param_user.value.string_value as fd_user_id
+                    FROM `{self.DBPath()}`
+                    CROSS JOIN UNNEST(event_params) AS param_app_version
+                    CROSS JOIN UNNEST(event_params) AS param_log_version
+                    CROSS JOIN UNNEST(event_params) AS param_session
+                    CROSS JOIN UNNEST(event_params) AS param_user
+                    {where_clause}
+                    ORDER BY `fd_user_id`, `timestamp` ASC;
+                """
+        return query