Merge pull request #145 from satisfactorymodding/bork-fixes

2.22.11 - mediaonly forums, fixes, CI improvements

.github/workflows/docker-publish.yml

@@ -40,12 +40,18 @@ jobs:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+
 
       - name: Extract Docker metadata
         id: meta
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=ref,event=pr
+            type=sha
 
 
       - uses: docker/setup-buildx-action@v3

README.md

@@ -20,11 +20,6 @@ Docker is for making containers. If you're not sure what that means, look it up
 You can get docker [here](https://docs.docker.com/engine/install/). For Linux, make sure to **not** use Docker Desktop. For Windows, it is the easiest way.
 If you don't want to install Docker (especially on Windows where Docker Desktop can take up resources and requires virtualisation to be enabled), you can also manually set up a PostgreSQL DB and configure Fred to point to it. More on that later.
 
-#### (Optional) Dialogflow auth
-
-This is optional because this feature is currently disabled in Fred.
-You'll have get authentication information for dialogflow if you want to work on that.
-
 ### Setup
 
 Two choices here: All through docker or hybrid local/docker.

docker-compose-deps.yml

@@ -1,6 +1,6 @@
 services:
     postgres:
-        image: postgres:14.0-alpine
+        image: postgres:14-alpine
         environment:
             POSTGRES_PASSWORD: fred
             POSTGRES_USER: fred
@@ -14,7 +14,7 @@ services:
     pgadmin:
         depends_on:
             - postgres
-        image: dpage/pgadmin4:6
+        image: dpage/pgadmin4:8
         environment:
             PGADMIN_DEFAULT_EMAIL: '[email protected]'
             PGADMIN_DEFAULT_PASSWORD: 'fred'

docker-compose.yml

@@ -1,3 +1,5 @@
+include:
+    - docker-compose-deps.yml
 services:
     fred:
         depends_on:
@@ -16,27 +18,4 @@ services:
             FRED_SQL_HOST: postgres
             FRED_SQL_PORT: 5432
         ports:
-            - "80:80"
-
-    postgres:
-        image: postgres:14.0-alpine
-        environment:
-            POSTGRES_PASSWORD: fred
-            POSTGRES_USER: fred
-            PGDATA: /var/lib/postgresql/data/pgdata
-        volumes:
-            - pgdata:/var/lib/postgresql/data/pgdata:z
-            - ./docker/exampledb.sql:/docker-entrypoint-initdb.d/exampledb.sql
-
-    pgadmin:
-        depends_on:
-            - postgres
-        image: dpage/pgadmin4:6
-        environment:
-            PGADMIN_DEFAULT_EMAIL: '[email protected]'
-            PGADMIN_DEFAULT_PASSWORD: 'fred'
-        ports:
-            - "8080:80"
-
-volumes:
-    pgdata:
+            - "80:80"

docker/Dockerfile

@@ -1,32 +1,35 @@
-FROM python:3.12-alpine AS runtime
+FROM alpine AS runtime
 #FROM python:3.12-slim AS runtime
 
 VOLUME /config
 WORKDIR /app
 
-RUN apk update; apk add --no-cache tesseract-ocr-data-eng re2-dev
+RUN apk update; apk add --no-cache python3 tesseract-ocr-data-eng re2-dev
 #ENV DEBIAN_FRONTEND=noninteractive APT="apt-get -qq"
 #RUN $APT update;  \
 #    $APT install tesseract-ocr;  \
 #    $APT clean; \
 #    rm -rf /var/lib/apt/lists/*
 
-FROM python:3.12-alpine AS build
+FROM alpine AS build
 #FROM python:3.12-slim AS build
 
 WORKDIR /deps
 
-RUN pip --no-cache-dir install --progress-bar=off "poetry==1.8"
-RUN apk update; apk add g++ git re2-dev
-COPY pyproject.toml .
-COPY poetry.lock .
-RUN poetry install -nvvv --only main --no-root
-RUN mv $(poetry env info --path) ./venv
+#RUN pip --no-cache-dir install --progress-bar=off "poetry==1.8"
+RUN apk update
+RUN apk add --no-cache g++ git re2-dev poetry python3-dev
+COPY pyproject.toml poetry.lock poetry.toml ./
+RUN python -VV
+RUN poetry env use $(which python)
+RUN poetry install -nvvv --no-root --compile --only main
+COPY fred ./fred/
+RUN poetry install -nvvv --only-root --compile
 
 FROM runtime
 
-COPY --from=build /deps/venv ./venv
+COPY --from=build /deps/.venv ./venv
 COPY fred ./fred/
 COPY *.env .
-
-CMD ./venv/bin/python3 -m fred
+RUN pwd
+CMD ./venv/bin/python -m fred

docker/exampledb.sql

@@ -140,124 +140,6 @@ ALTER TABLE public.crashes_id_seq OWNER TO fred;
 
 ALTER SEQUENCE public.crashes_id_seq OWNED BY public.crashes.id;
 
-
---
--- TOC entry 211 (class 1259 OID 16442)
--- Name: dialogflow; Type: TABLE; Schema: public; Owner: fred
---
-
-CREATE TABLE public.dialogflow (
-    id integer NOT NULL,
-    intent_id text,
-    data text,
-    response text,
-    has_followup boolean
-);
-
-
-ALTER TABLE public.dialogflow OWNER TO fred;
-
---
--- TOC entry 207 (class 1259 OID 16426)
--- Name: dialogflow_channels; Type: TABLE; Schema: public; Owner: fred
---
-
-CREATE TABLE public.dialogflow_channels (
-    id integer NOT NULL,
-    channel_id bigint
-);
-
-
-ALTER TABLE public.dialogflow_channels OWNER TO fred;
-
---
--- TOC entry 206 (class 1259 OID 16424)
--- Name: dialogflow_channels_id_seq; Type: SEQUENCE; Schema: public; Owner: fred
---
-
-CREATE SEQUENCE public.dialogflow_channels_id_seq
-    AS integer
-    START WITH 1
-    INCREMENT BY 1
-    NO MINVALUE
-    NO MAXVALUE
-    CACHE 1;
-
-
-ALTER TABLE public.dialogflow_channels_id_seq OWNER TO fred;
-
---
--- TOC entry 3077 (class 0 OID 0)
--- Dependencies: 206
--- Name: dialogflow_channels_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: fred
---
-
-ALTER SEQUENCE public.dialogflow_channels_id_seq OWNED BY public.dialogflow_channels.id;
-
-
---
--- TOC entry 209 (class 1259 OID 16434)
--- Name: dialogflow_exception_roles; Type: TABLE; Schema: public; Owner: fred
---
-
-CREATE TABLE public.dialogflow_exception_roles (
-    id integer NOT NULL,
-    role_id bigint
-);
-
-
-ALTER TABLE public.dialogflow_exception_roles OWNER TO fred;
-
---
--- TOC entry 208 (class 1259 OID 16432)
--- Name: dialogflow_exception_roles_id_seq; Type: SEQUENCE; Schema: public; Owner: fred
---
-
-CREATE SEQUENCE public.dialogflow_exception_roles_id_seq
-    AS integer
-    START WITH 1
-    INCREMENT BY 1
-    NO MINVALUE
-    NO MAXVALUE
-    CACHE 1;
-
-
-ALTER TABLE public.dialogflow_exception_roles_id_seq OWNER TO fred;
-
---
--- TOC entry 3078 (class 0 OID 0)
--- Dependencies: 208
--- Name: dialogflow_exception_roles_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: fred
---
-
-ALTER SEQUENCE public.dialogflow_exception_roles_id_seq OWNED BY public.dialogflow_exception_roles.id;
-
-
---
--- TOC entry 210 (class 1259 OID 16440)
--- Name: dialogflow_id_seq; Type: SEQUENCE; Schema: public; Owner: fred
---
-
-CREATE SEQUENCE public.dialogflow_id_seq
-    AS integer
-    START WITH 1
-    INCREMENT BY 1
-    NO MINVALUE
-    NO MAXVALUE
-    CACHE 1;
-
-
-ALTER TABLE public.dialogflow_id_seq OWNER TO fred;
-
---
--- TOC entry 3079 (class 0 OID 0)
--- Dependencies: 210
--- Name: dialogflow_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: fred
---
-
-ALTER SEQUENCE public.dialogflow_id_seq OWNED BY public.dialogflow.id;
-
-
 --
 -- TOC entry 205 (class 1259 OID 16418)
 -- Name: media_only_channels; Type: TABLE; Schema: public; Owner: fred
@@ -788,7 +670,7 @@ COPY public.crashes (id, name, crash, response) FROM stdin;
 54	.netmissing	Install a version of .NET Framework SDK at	Your .NET Framework install is either missing or oudated. Please download and install the latest one from https://dotnet.microsoft.com/download/visual-studio-sdks. Make sure to download the .NET **Framework**SDK
 55	noautomationtool	UATHelper: Package Mod Task (Windows): RunUAT.bat ERROR: Visual studio and/or AutomationTool.csproj was not found, nor was Engine\\Binaries\\DotNET\\AutomationTool.exe. Can't run the automation tool.	Open your .sln with Visual Studio/Rider and build the project for Shipping
 64	tolowercase	c\\.toLowerCase is not a function	>tolowercase
-68	flip	\\(╯°□°\\）╯︵ ┻━┻	┬─┬ ノ( ゜-゜ノ)
+68	flip	\\(╯°□°\\)╯︵ ┻━┻	┬─┬ ノ( ゜-゜ノ)
 69	fixit	Can we (fix\\s*it|ficsit)\\s*?	Yes we can!
 70	oldproject	ERROR: Cannot find game version file	Your project is outdated. Please update it
 71	needcompile	Module\\s+[‘‘'’`]*FactoryGame[‘‘'’`]*\\s+could\\s+not\\s+be\\s+found	Please open your .sln with Visual Studio/Rider and build the project for both Development Editor and Shipping

fred/__init__.py

@@ -19,7 +19,6 @@
     "FRED_SQL_PASSWORD",
     "FRED_SQL_HOST",
     "FRED_SQL_PORT",
-    # "DIALOGFLOW_AUTH",
 )
 
 for var in ENVVARS:

fred/__main__.py

@@ -4,12 +4,16 @@
 from .fred import Bot, nextcord
 
 
-async def main():  # this is so poetry can run a function from here properly
+async def a_main():
     intents = nextcord.Intents.all()
 
     client = Bot("?", help_command=None, intents=intents, chunk_guilds_at_startup=False)
     await client.start(getenv("FRED_TOKEN"), reconnect=True)
 
 
+def main():  # this is so poetry can run a function from here properly
+    asyncio.run(a_main())
+
+
 if __name__ == "__main__":
-    asyncio.run(main())
+    main()

fred/cogs/crashes.py

@@ -182,7 +182,7 @@ async def mass_regex(self, text: str) -> AsyncIterator[CrashResponse]:
                         if command_response.startswith(self.bot.command_prefix):  # is alias
                             command = config.Commands.fetch(command_response.strip(self.bot.command_prefix))
                         yield CrashResponse(
-                            name=command["name"],
+                            name=crash["name"],
                             value=command["content"],
                             attachment=command["attachment"],
                             inline=True,
@@ -472,6 +472,29 @@ def from_metadata_json(cls: Type[InstallInfo], file: IO[bytes], filename: str) -
                     game_command_line=selected_installation.get("launchPath", ""),
                     installed_mods=installed_mods,
                 )
+
+            case {
+                # SMM 2 format - keys missing when generated when no installs found
+                "installsFound": _installations,
+                "selectedInstall": selected_installation,
+                "profiles": _profiles,
+                "selectedProfile": _selected_profile,
+                "smmVersion": smm_version,
+                "modsEnabled": _mods_enabled,
+            }:
+                # if there is no install everything can default to None
+                selected_installation = selected_installation or {}
+                return cls(
+                    filename,
+                    smm_version=smm_version,
+                    sml_version="",
+                    game_version=selected_installation.get("version", ""),
+                    game_type="WindowsClient",  # SMM 2 only supports this one and therefore doesn't specify otherwise
+                    game_path=selected_installation.get("installLocation", ""),
+                    game_command_line=selected_installation.get("launchPath", ""),
+                    installed_mods={},
+                )
+
             case _:
                 logger.exception(ValueError("Invalid SMM metadata json"))
                 return None
@@ -500,7 +523,7 @@ def update_from_fg_log(self, log_file: IO[bytes]):
                     p1 = p1.lower()
                     p2 = p2.lower()
                 if Path(p1) != Path(p2):
-                    self.mismatches.append(f"Game Path: (`{path}`)")
+                    self.mismatches.append(f"Game Path: ({path})")
             else:
                 self.game_path = path
 
@@ -516,15 +539,17 @@ def update_from_fg_log(self, log_file: IO[bytes]):
 
     @staticmethod
     def _get_fg_log_details(log_file: IO[bytes]):
-        lines = log_file.readlines()
+        # This function uses lazy evaluation to get the info we need without performing regex on the whole log
+        # It used to matter more when we were using slower regex libraries. - Borketh
 
-        vanilla_info_search_area = filter(lambda l: re2.match("^LogInit", str(l)), lines)
+        lines: list[bytes] = log_file.readlines()
+        vanilla_info_search_area = filter(lambda l: re2.match("^LogInit", l), map(bytes.decode, lines))
 
         info = {}
         patterns = [
             re2.compile(r"Net CL: (?P<game_version>\d+)"),
-            re2.compile(r"Command Line: (?P<cli>.*)"),
-            re2.compile(r"Base Directory: (?P<path>.+)"),
+            re2.compile(r"Command Line:(?P<cli>.*)"),
+            re2.compile(r"Base Directory:(?P<path>.+)"),
             re2.compile(r"Launcher ID: (?P<launcher>\w+)"),
         ]
 
@@ -540,9 +565,10 @@ def _get_fg_log_details(log_file: IO[bytes]):
                 info |= match.groupdict()
                 patterns.pop(0)
         else:
-            logger.info("Didn't find all four pieces of information normally found in a log")
+            logger.info("Didn't find all four pieces of information normally found in a log!")
+            logger.debug(json.dumps(info, indent=2))
 
-        mod_loader_logs = filter(lambda l: re2.match("LogSatisfactoryModLoader", str(l)), lines)
+        mod_loader_logs = filter(lambda l: re2.match("LogSatisfactoryModLoader", l), map(bytes.decode, lines))
         for line in mod_loader_logs:
             if match := re2.search(r"(?<=v\.)(?P<sml>[\d.]+)", line):
                 info |= match.groupdict()
@@ -557,7 +583,7 @@ def _get_fg_log_details(log_file: IO[bytes]):
         return info
 
     def _version_info(self) -> str:
-        # note: (str that defaults to "") and (f-string) is shorthand for if str: f-string
+        # note: `(str that defaults to "") and (f-string)` is shorthand for if str: f-string
         version_info = (
             "```\n"
             + (self.smm_version and f"SMM Version: {self.smm_version}\n")
@@ -574,7 +600,7 @@ def _version_info(self) -> str:
                 + self.game_type
                 + f" CL {self.game_version}"
                 + (self.game_launcher_id and f" from {self.game_launcher_id}")
-                + (self.game_path and f"\nPath: `{self.game_path}`")
+                + (self.game_path and f"\nPath: `{self.game_path.strip()}`")
                 + "\n"
             )