Merge pull request #3452 from shirsakm/scrobbler-log-importer

LB-1852: Add file importer for Audioscrobbler spec

Author: MonkeyDo

.gitignore

@@ -148,3 +148,6 @@ listenbrainz_spark/recommendations/html_files*
 
 # IDE configs
 .idea
+
+# Test data
+!**/*.scrobbler.log

admin/sql/create_types.sql

@@ -25,6 +25,6 @@ CREATE TYPE user_data_export_status_type AS ENUM ('in_progress', 'waiting', 'com
 
 CREATE TYPE user_data_export_type_type AS ENUM ('export_all_user_data');
 
-CREATE TYPE user_data_import_service_type AS ENUM ('spotify', 'applemusic', 'listenbrainz', 'librefm', 'maloja', 'panoscrobbler');
+CREATE TYPE user_data_import_service_type AS ENUM ('spotify', 'applemusic', 'listenbrainz', 'librefm', 'maloja', 'panoscrobbler', 'audioscrobbler');
 
 CREATE TYPE data_dump_type_type AS ENUM ('incremental', 'full');

admin/sql/updates/2025-12-16-add-audioscrobbler-data-import-type.sql

@@ -0,0 +1,3 @@
+BEGIN;
+ALTER TYPE user_data_import_service_type ADD VALUE 'audioscrobbler';
+COMMIT;

frontend/js/src/settings/import/ImportListens.tsx

@@ -20,6 +20,8 @@ import Loader from "../../components/Loader";
 
 type ImportListensLoaderData = {
   user_has_email: boolean;
+  pg_timezones: Array<[string, string]>;
+  user_timezone: string;
 };
 
 enum ImportStatus {
@@ -36,6 +38,7 @@ enum Services {
   librefm = "Libre.fm",
   panoscrobbler = "PanoScrobbler",
   maloja = "Maloja",
+  audioscrobbler = "Audioscrobbler/Rockbox",
 }
 const acceptedFileTypes = {
   [Services.spotify]: ".zip",
@@ -44,6 +47,7 @@ const acceptedFileTypes = {
   [Services.librefm]: ".csv",
   [Services.panoscrobbler]: ".jsonl",
   [Services.maloja]: ".json",
+  [Services.audioscrobbler]: ".log",
 };
 type ImportMetadata = {
   filename: string;
@@ -252,7 +256,7 @@ function renderImport(
 
 export default function ImportListens() {
   const data = useLoaderData() as ImportListensLoaderData;
-  const { user_has_email: userHasEmail } = data;
+  const { user_has_email: userHasEmail, pg_timezones, user_timezone } = data;
 
   const { currentUser, APIService } = React.useContext(GlobalAppContext);
 
@@ -511,9 +515,9 @@ export default function ImportListens() {
           <br />
           For <b>{nonZipServices.join(", ")}</b>: please upload single files
           directly (
-          {nonZipServices.map((s) => (
-            <mark>{acceptedFileTypes[s]}, </mark>
-          ))}{" "}
+          <mark>
+            {nonZipServices.map((s) => acceptedFileTypes[s]).join(", ")}
+          </mark>{" "}
           respectively).
         </p>
       </div>
@@ -560,44 +564,84 @@ export default function ImportListens() {
                   onChange={(e) => setFileSelected(!!e.target.files?.length)}
                 />
               </div>
+            </div>
 
-              <div style={{ minWidth: "15em" }}>
-                <label className="form-label" htmlFor="start-datetime">
-                  Start import from (optional):
-                </label>
-                <input
-                  type="date"
-                  id="start-datetime"
-                  className="form-control"
-                  max={new Date().toISOString()}
-                  name="from_date"
-                  title="Date and time to start import at"
-                />
-              </div>
-
-              <div style={{ minWidth: "15em" }}>
-                <label className="form-label" htmlFor="end-datetime">
-                  End date for import (optional):
-                </label>
-                <input
-                  type="date"
-                  id="end-datetime"
-                  className="form-control"
-                  max={new Date().toISOString()}
-                  name="to_date"
-                  title="Date and time to end import at"
+            <details className="mt-3">
+              <summary>
+                <FontAwesomeIcon
+                  icon={faChevronCircleRight}
+                  size="sm"
+                  className="summary-indicator"
                 />
+                Additional options
+              </summary>
+              <div className="flex flex-wrap mt-3" style={{ gap: "1em" }}>
+                <div style={{ minWidth: "15em" }}>
+                  <label className="form-label" htmlFor="start-datetime">
+                    Start import from (optional):
+                  </label>
+                  <input
+                    type="date"
+                    id="start-datetime"
+                    className="form-control"
+                    max={new Date().toISOString()}
+                    name="from_date"
+                    title="Date and time to start import at"
+                  />
+                </div>
+
+                <div style={{ minWidth: "15em" }}>
+                  <label className="form-label" htmlFor="end-datetime">
+                    End date for import (optional):
+                  </label>
+                  <input
+                    type="date"
+                    id="end-datetime"
+                    className="form-control"
+                    max={new Date().toISOString()}
+                    name="to_date"
+                    title="Date and time to end import at"
+                  />
+                </div>
+
+                <div style={{ minWidth: "15em" }}>
+                  <label className="form-label" htmlFor="timezone">
+                    Timezone (optional):
+                  </label>
+                  <select
+                    className="form-select"
+                    id="timezone"
+                    name="timezone"
+                    defaultValue={user_timezone}
+                    title="Timezone fallback for ambiguous timestamps"
+                    disabled={selectedService !== "audioscrobbler"}
+                  >
+                    <option value="">
+                      Use profile timezone ({user_timezone})
+                    </option>
+                    {pg_timezones.map((zone: string[]) => {
+                      return (
+                        <option key={zone[0]} value={zone[0]}>
+                          {zone[0]} ({zone[1]})
+                        </option>
+                      );
+                    })}
+                  </select>
+                </div>
               </div>
-
-              <div style={{ flex: 0, alignSelf: "end", minWidth: "15em" }}>
-                <button
-                  type="submit"
-                  className="btn btn-success"
-                  disabled={hasAnImportInProgress || !fileSelected}
-                >
-                  Import Listens
-                </button>
-              </div>
+            </details>
+
+            <div className="mt-4" style={{ minWidth: "15em" }}>
+              <button
+                type="submit"
+                className="btn btn-success"
+                style={{
+                  padding: "1rem 2.5rem",
+                }}
+                disabled={hasAnImportInProgress || !fileSelected}
+              >
+                Import Listens
+              </button>
             </div>
           </form>
         </div>

frontend/js/tests/user/import-listens/ImportListens.test.tsx

@@ -79,7 +79,15 @@ describe("ImportListensPage", () => {
 
     server = setupServer(
       http.post("/settings/import/", (req) => {
-        return HttpResponse.json({ user_has_email: true });
+        return HttpResponse.json({
+          user_has_email: true,
+          pg_timezones: [
+            ["America/New_York", "UTC-05:00"],
+            ["Europe/London", "UTC+00:00"],
+            ["Asia/Tokyo", "UTC+09:00"],
+          ],
+          user_timezone: "America/New_York",
+        });
       }),
       http.get("/1/import-listens/list/", (req) => {
         return HttpResponse.json(mockImports);
@@ -112,12 +120,39 @@ describe("ImportListensPage", () => {
   it("renders submission form correctly", async () => {
     renderWithProviders(<RouterProvider router={router} />, {}, { wrapper: ReactQueryWrapper }, false);
     await waitFor(() => {
-      expect(screen.getByText(/start import from/i)).toBeInTheDocument();
-      expect(screen.getByText(/end date for import/i)).toBeInTheDocument();
       expect(screen.getByText(/select Service/i)).toBeInTheDocument();
       expect(screen.getByText(/Select your .zip file/i)).toBeInTheDocument();
       expect(screen.getByRole("button", { name: /import listens/i })).toBeInTheDocument();
     });
+
+    const accordionSummary = screen.getByText(/additional options/i);
+    expect(accordionSummary).toBeInTheDocument();
+    await user.click(accordionSummary);
+
+    await waitFor(() => {
+      expect(screen.getByLabelText(/timezone/i)).toBeInTheDocument();
+      expect(screen.getByText(/start import from/i)).toBeInTheDocument();
+      expect(screen.getByText(/end date for import/i)).toBeInTheDocument();
+    });
+  });
+
+  it("disables timezone selection for non-audioscrobbler services", async () => {
+    renderWithProviders(<RouterProvider router={router} />, {}, { wrapper: ReactQueryWrapper }, false);
+    const accordionSummary = screen.getByText(/additional options/i);
+    await user.click(accordionSummary);
+
+    await waitFor(() => {
+      const timezoneSelect = screen.getByLabelText(/timezone/i);
+      expect(timezoneSelect).toBeDisabled();
+    });
+
+    const serviceSelect = screen.getByLabelText(/select service/i);
+    await user.selectOptions(serviceSelect, "audioscrobbler");
+
+    await waitFor(() => {
+      const timezoneSelect = screen.getByLabelText(/timezone/i);
+      expect(timezoneSelect).not.toBeDisabled();
+    });
   });
 
   it("enables the import button after a file is uploaded", async () => {

listenbrainz/background/listens_importer/__init__.py

@@ -7,6 +7,7 @@
 from listenbrainz.background.listens_importer.maloja import MalojaListensImporter
 from listenbrainz.background.listens_importer.spotify import SpotifyListensImporter
 from listenbrainz.background.listens_importer.panoscrobbler import PanoScrobblerListensImporter
+from listenbrainz.background.listens_importer.audioscrobbler import AudioscrobblerListensImporter
 
 
 def import_listens(db_conn, ts_conn, user_id, bg_task_metadata):
@@ -36,6 +37,8 @@ def import_listens(db_conn, ts_conn, user_id, bg_task_metadata):
         importer = PanoScrobblerListensImporter(db_conn, ts_conn)
     elif service == "maloja":
         importer = MalojaListensImporter(db_conn, ts_conn)
+    elif service == "audioscrobbler":
+        importer = AudioscrobblerListensImporter(db_conn, ts_conn)
     else:
         msg = f"Unsupported service: {service}"
         update_import_task(db_conn, import_id, status="failed", progress=msg)