From f003149678ca5c844ecb54249afc32b7c43b3d96 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Sun, 24 Mar 2024 02:57:46 +0100 Subject: [PATCH] Initital version --- .gitignore | 1 + LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 65 +++++++++++++++++ go.mod | 18 +++++ go.sum | 39 ++++++++++ main.go | 114 +++++++++++++++++++++++++++++ message.tpl | 13 ++++ query.go | 163 ++++++++++++++++++++++++++++++++++++++++++ schema.sql | 15 ++++ struct.go | 25 +++++++ 10 files changed, 655 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main.go create mode 100644 message.tpl create mode 100644 query.go create mode 100644 schema.sql create mode 100644 struct.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ee48d47 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +twitch-bot-streak diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e5bb0bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024- Knut Ahlers + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..a2d5bec --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# Luzifer / twitch-bot-streak + +Addon for my [twitch-bot](https://github.com/Luzifer/twitch-bot) executed through the [Execute Script / Command](https://luzifer.github.io/twitch-bot/configuration/actors/#execute-script--command) action to build a custom watch-streak feature. + +## Features + +- By default uses same database connection as the bot through the same environment variable +- Needs two tables (see `schema.sql`) to store its data +- Reward is only counted once per stream (in case Twitch messes up stuff) +- If a stream goes offline for a few minutes a grace period (30m) is taken which will not reset the stream streak + +## Usage + +The program is used by three rules to register the `stream_online` and `stream_offline` events and to count user presence through a `channelpoint_redeem`: + +```yaml +- uuid: 67f0b5cf-f20d-4900-8e0d-63d20e550c2a + description: 'Stream-Streak: Stream-Online' + actions: + - type: script + attributes: + command: + - /data/bin/twitch-bot-streak + - --action=stream_start + - type: respond + attributes: + message: | + /me Der Stream ist gestartet, vergesst nicht euren + Stream-Streak zu verlängern! Einfach in den Kanalpunkten + "Stream-Streak: Ich bin da!" einlösen… luzife4Kluk + match_channels: + - '#luziferus' + match_event: stream_online + +# -- + +- uuid: 682707c1-5080-4eba-9100-e75bf89fe6e7 + description: 'Stream-Streak: Stream-Offline' + actions: + - type: script + attributes: + command: + - /data/bin/twitch-bot-streak + - --action=stream_offline + match_channels: + - '#luziferus' + match_event: stream_offline + +# -- + +- uuid: 34b9f1bc-cc3b-4003-8a0d-ed5d82e0b96e + description: 'Stream-Streak: Count Presence' + actions: + - type: script + attributes: + command: + - /data/bin/twitch-bot-streak + - --action=count_stream + - --twitch-id={{ .user_id }} + - --twitch-username={{ .user }} + match_channels: + - '#luziferus' + match_event: channelpoint_redeem + disable_on_template: '{{ ne .reward_id "b98b9175-a50b-4fb0-9c12-85f07ba6d555" }}' +``` diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..2ffe2e4 --- /dev/null +++ b/go.mod @@ -0,0 +1,18 @@ +module git.luzifer.io/luzifer/twitch-bot-streak + +go 1.22.1 + +require ( + github.com/Luzifer/rconfig/v2 v2.5.0 + github.com/go-sql-driver/mysql v1.6.0 + github.com/jmoiron/sqlx v1.3.5 + github.com/pkg/errors v0.9.1 + github.com/sirupsen/logrus v1.9.3 +) + +require ( + github.com/spf13/pflag v1.0.5 // indirect + golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect + gopkg.in/validator.v2 v2.0.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..796752e --- /dev/null +++ b/go.sum @@ -0,0 +1,39 @@ +github.com/Luzifer/rconfig/v2 v2.5.0 h1:zx5lfQbNX3za4VegID97IeY+M+BmfgHxWJTYA94sxok= +github.com/Luzifer/rconfig/v2 v2.5.0/go.mod h1:eGWUPQeCPv/Pr/p0hjmwFgI20uqvwi/Szen69hUzGzU= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE= +github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= +github.com/jmoiron/sqlx v1.3.5 h1:vFFPA71p1o5gAeqtEAwLU4dnX2napprKtHr7PYIcN3g= +github.com/jmoiron/sqlx v1.3.5/go.mod h1:nRVWtLre0KfCLJvgxzCsLVMogSvQ1zNJtpYr2Ccp0mQ= +github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI= +github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/lib/pq v1.2.0 h1:LXpIM/LZ5xGFhOpXAQUIMM1HdyqzVYM13zNdjCEEcA0= +github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= +github.com/mattn/go-sqlite3 v1.14.6 h1:dNPt6NO46WmLVt2DLNpwczCmdV5boIZ6g/tlDrlRUbg= +github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= +github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/validator.v2 v2.0.1 h1:xF0KWyGWXm/LM2G1TrEjqOu4pa6coO9AlWSf3msVfDY= +gopkg.in/validator.v2 v2.0.1/go.mod h1:lIUZBlB3Im4s/eYp39Ry/wkR02yOPhZ9IwIRBjuPuG8= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/main.go b/main.go new file mode 100644 index 0000000..d8d5e7c --- /dev/null +++ b/main.go @@ -0,0 +1,114 @@ +package main + +import ( + "bytes" + _ "embed" + "encoding/json" + "os" + "regexp" + "text/template" + + _ "github.com/go-sql-driver/mysql" + "github.com/jmoiron/sqlx" + "github.com/pkg/errors" + "github.com/sirupsen/logrus" + + "github.com/Luzifer/rconfig/v2" +) + +var ( + cfg = struct { + Action string `flag:"action,a" description:"Which action to perform"` + TwitchID uint64 `flag:"twitch-id" description:"ID of the user to access the streak of"` + TwitchUsername string `flag:"twitch-username" description:"Username of the user to update in streaks table"` + + StorageConnString string `flag:"storage-conn-string" description:"How to connect to the database"` + LogLevel string `flag:"log-level" default:"info" description:"Log level (debug, info, warn, error, fatal)"` + VersionAndExit bool `flag:"version" default:"false" description:"Prints current version and exits"` + }{} + + version = "dev" + + //go:embed message.tpl + messageTemplate string +) + +func initApp() error { + rconfig.AutoEnv(true) + if err := rconfig.ParseAndValidate(&cfg); err != nil { + return errors.Wrap(err, "parsing cli options") + } + + l, err := logrus.ParseLevel(cfg.LogLevel) + if err != nil { + return errors.Wrap(err, "parsing log-level") + } + logrus.SetLevel(l) + + return nil +} + +func main() { + var err error + if err = initApp(); err != nil { + logrus.WithError(err).Fatal("initializing app") + } + + if cfg.VersionAndExit { + logrus.WithField("version", version).Info("twitch-bot-streak") + os.Exit(0) + } + + tpl, err := template.New("tpl").Parse(messageTemplate) + if err != nil { + logrus.WithError(err).Fatal("parsing message template") + } + + db, err := sqlx.Open("mysql", cfg.StorageConnString) + if err != nil { + logrus.WithError(err).Fatal("connecting to database") + } + + switch cfg.Action { + case "stream_start": + if err = startStream(db); err != nil { + logrus.WithError(err).Fatal("starting stream") + } + + case "stream_offline": + if err = setStreamOffline(db); err != nil { + logrus.WithError(err).Fatal("stopping stream") + } + + case "count_stream": + if err = startStream(db); err != nil { + logrus.WithError(err).Fatal("starting stream") + } + + user, err := countStreak(db, cfg.TwitchID, cfg.TwitchUsername) + if err != nil { + logrus.WithError(err).Fatal("counting streak") + } + + buf := new(bytes.Buffer) + if err = tpl.Execute(buf, user); err != nil { + logrus.WithError(err).Fatal("rendering template") + } + + msg := regexp.MustCompile(`\s+`).ReplaceAllString(buf.String(), " ") + + if err = json.NewEncoder(os.Stdout).Encode([]botResponse{ + { + Type: "respond", + Attributes: map[string]any{ + "message": msg, + }, + }, + }); err != nil { + logrus.WithError(err).Fatal("encoding bot response") + } + + default: + logrus.Fatalf("unknown action %q", cfg.Action) + } +} diff --git a/message.tpl b/message.tpl new file mode 100644 index 0000000..1288f77 --- /dev/null +++ b/message.tpl @@ -0,0 +1,13 @@ +{{- if eq .StreamsCount 1 -}} +@{{ .Username }} du hast dich das erste Mal registriert. +{{- else -}} + {{- if eq .CurrentStreak 1 -}} + @{{ .Username }} deine Stream-Serie ist leider gebrochen, du bist + zurück bei einem Stream. + {{- else -}} + @{{ .Username }} du hast deine Stream-Serie auf {{ .CurrentStreak }} + verlängert. + {{- end }} +Insgesamt hast du dich {{ .StreamsCount }}x registriert und deine +längste Serie ist {{ .MaxStreak }} Streams. +{{- end -}} diff --git a/query.go b/query.go new file mode 100644 index 0000000..a4c3c53 --- /dev/null +++ b/query.go @@ -0,0 +1,163 @@ +package main + +import ( + "database/sql" + "errors" + "fmt" + "time" + + "github.com/jmoiron/sqlx" +) + +const streamOfflineGrace = 30 * time.Minute + +func countStreak(db *sqlx.DB, twitchID uint64, username string) (user streakUser, err error) { + if err = withTx(db, func(tx *sqlx.Tx) (err error) { + if err = tx.Get(&user, "SELECT * FROM streak_users WHERE twitch_id = ?", twitchID); err != nil { + if !errors.Is(err, sql.ErrNoRows) { + return fmt.Errorf("getting user: %w", err) + } + + // User was not yet inserted + user = streakUser{ + TwitchID: twitchID, + Username: username, + StreamsCount: 0, + CurrentStreak: 0, + MaxStreak: 0, + StreakStatus: statusBroken, + } + } + + switch user.StreakStatus { + case statusActive: + // User has an active streak, do nothing + return nil + + case statusBroken: + // User needs a new streak + user.CurrentStreak = 1 + + case statusPending: + // User can prolong their streak + user.CurrentStreak += 1 + } + + // In any case set the streak active and count the current stream + user.StreamsCount++ + user.StreakStatus = statusActive + if user.CurrentStreak > user.MaxStreak { + user.MaxStreak = user.CurrentStreak + } + + if _, err = db.NamedExec( + `INSERT INTO streak_users VALUES (:twitch_id, :username, :streams_count, :current_streak, :max_streak, :streak_status) + ON DUPLICATE KEY UPDATE username=:username, streams_count=:streams_count, current_streak=:current_streak, max_streak=:max_streak, streak_status=:streak_status`, + user, + ); err != nil { + return fmt.Errorf("updating user streak status: %w", err) + } + + return nil + }); err != nil { + return user, fmt.Errorf("counting streak for user: %w", err) + } + + return user, nil +} + +func getTimeFromMeta(tx *sqlx.Tx, key string) (t time.Time, err error) { + var lastOfflineStr string + if err = tx.Get(&lastOfflineStr, "SELECT value FROM streak_meta WHERE `key` = ?", key); err != nil { + if !errors.Is(err, sql.ErrNoRows) { + return t, fmt.Errorf("getting last %s time: %w", key, err) + } + + lastOfflineStr = time.Date(1970, 1, 1, 0, 0, 0, 0, time.UTC).Format(time.RFC3339Nano) + } + + t, err = time.Parse(time.RFC3339Nano, lastOfflineStr) + if err != nil { + return t, fmt.Errorf("parsing offline time: %w", err) + } + + return t, nil +} + +func setStreamOffline(db *sqlx.DB) (err error) { + return withTx(db, func(tx *sqlx.Tx) error { + return storeTimeToMeta(tx, "stream_offline", time.Now()) + }) +} + +func startStream(db *sqlx.DB) (err error) { + if err = withTx(db, func(tx *sqlx.Tx) (err error) { + lastOffline, err := getTimeFromMeta(tx, "stream_offline") + if err != nil { + return fmt.Errorf("getting offline time: %w", err) + } + + lastOnline, err := getTimeFromMeta(tx, "stream_online") + if err != nil { + return fmt.Errorf("getting online time: %w", err) + } + + if err = storeTimeToMeta(tx, "stream_online", time.Now()); err != nil { + return fmt.Errorf("storing stream start: %w", err) + } + + if time.Since(lastOffline) < streamOfflineGrace || lastOnline.After(lastOffline) { + // We only had a short break or the stream was already started + return nil + } + + if _, err = tx.Exec("UPDATE streak_users SET streak_status = ?, current_streak = 0 WHERE streak_status = ?", statusBroken, statusPending); err != nil { + return fmt.Errorf("breaking streaks for pending users: %w", err) + } + + if _, err = tx.Exec("UPDATE streak_users SET streak_status = ? WHERE streak_status = ?", statusPending, statusActive); err != nil { + return fmt.Errorf("breaking streaks for pending users: %w", err) + } + + return nil + }); err != nil { + return fmt.Errorf("starting stream: %w", err) + } + + return nil +} + +func storeTimeToMeta(tx *sqlx.Tx, key string, t time.Time) (err error) { + if _, err = tx.NamedExec( + `INSERT INTO streak_meta VALUES (:key, :value) + ON DUPLICATE KEY UPDATE value = :value`, + map[string]any{ + "key": key, + "value": t.Format(time.RFC3339Nano), + }, + ); err != nil { + return fmt.Errorf("updating stream meta: %w", err) + } + + return nil +} + +func withTx(db *sqlx.DB, fn func(*sqlx.Tx) error) error { + tx, err := db.Beginx() + if err != nil { + return fmt.Errorf("starting transaction: %w", err) + } + + if err = fn(tx); err != nil { + if rerr := tx.Rollback(); rerr != nil { + return fmt.Errorf("rolling back after error: %w", rerr) + } + return fmt.Errorf("executing transaction (rolled back): %w", err) + } + + if err = tx.Commit(); err != nil { + return fmt.Errorf("committing transaction: %w", err) + } + + return nil +} diff --git a/schema.sql b/schema.sql new file mode 100644 index 0000000..33bbc65 --- /dev/null +++ b/schema.sql @@ -0,0 +1,15 @@ +CREATE TABLE `streak_meta` ( + `key` varchar(255) NOT NULL, + `value` varchar(255) DEFAULT NULL, + PRIMARY KEY (`key`) +) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci; + +CREATE TABLE `streak_users` ( + `twitch_id` bigint(20) unsigned NOT NULL, + `username` varchar(255) NOT NULL, + `streams_count` int(10) unsigned NOT NULL DEFAULT 0, + `current_streak` int(10) unsigned NOT NULL DEFAULT 0, + `max_streak` int(10) unsigned NOT NULL DEFAULT 0, + `streak_status` enum('broken','pending','active') NOT NULL DEFAULT 'broken', + PRIMARY KEY (`twitch_id`) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci; diff --git a/struct.go b/struct.go new file mode 100644 index 0000000..29210e6 --- /dev/null +++ b/struct.go @@ -0,0 +1,25 @@ +package main + +type ( + botResponse struct { + Type string `json:"type"` + Attributes map[string]any `json:"attributes"` + } + + streakUser struct { + TwitchID uint64 `db:"twitch_id"` + Username string `db:"username"` + StreamsCount uint64 `db:"streams_count"` + CurrentStreak uint64 `db:"current_streak"` + MaxStreak uint64 `db:"max_streak"` + StreakStatus status `db:"streak_status"` + } + + status string +) + +const ( + statusBroken status = "broken" // Streak is broken and must be started anew + statusPending status = "pending" // Streak is pending to be broken and can be continued + statusActive status = "active" // Streak is active (renewed in current stream) +)