42 Commits

• Add support for grouping beatmaps by collections

  Takes changes in https://github.com/ppy/osu/pull/34233 and removes *all*
  of the complexity.
  
  Supersedes and closes #34233.
  
  Contains same caveat that we can only display one beatmap once in the
  carousel; this will be addressed separately.

  Dean Herbert · 2025-08-01 16:23:26 +09:00
  c3396a93a6
• Fix dodgy threading

  The fact that the stuff "just worked" previously due to one load-bearing
  detach in a random location is really scary because a lot of this was
  just not written the way it is supposed to be.

  Bartłomiej Dach · 2025-06-30 14:17:27 +02:00
  2e0e7ff3c2
• Update realm xmldoc references
  Dean Herbert · 2025-01-08 01:35:56 +09:00
  125d652dd8
• Enable recommended rules for documentation
  Huo Yaoyuan · 2024-11-28 20:41:32 +08:00
  c57ace0b5f
• Inhibit original callback from firing when sending initial changeset
  Dean Herbert · 2024-07-09 16:05:58 +09:00
  ee9e329db3
• Ensure realm subscriptions always fire initial callback with null ChangeSet

  We expect this to be the case, but it turns out that it [may be
  coalesced](https://www.mongodb.com/docs/realm-sdks/dotnet/latest/reference/Realms.IRealmCollection-1.html#Realms_IRealmCollection_1_SubscribeForNotifications_Realms_NotificationCallbackDelegate__0__Realms_KeyPathsCollection_):
  
  > Notifications are delivered via the standard event loop, and so can't
  > be delivered while the event loop is blocked by other activity. When
  > notifications can't be delivered instantly, multiple notifications may
  > be coalesced into a single notification. This can include the
  > notification with the initial collection.
  
  Rather than struggle with handling this locally every time, let's fix
  the callback at our end to ensure we receive the initial null case.
  
  I've raised concern for the API being a bit silly with realm
  (https://github.com/realm/realm-dotnet/issues/3641).

  Dean Herbert · 2024-07-09 15:47:43 +09:00
  2423bbb776
• Remove outdated xmldoc
  Bartłomiej Dach · 2023-07-06 22:01:02 +02:00
  1473abd909
• Bring realm library up-to-date
  Dean Herbert · 2023-07-06 13:37:43 +09:00
  a98a36872e
• Add logging and Debug.Fail on detached beatmap detection
  Dean Herbert · 2023-06-28 12:21:05 +09:00
  99e55bb9c0
• Fix incorrect realm copy logic when a beatmap becomes detached from its set

  The code here was assuming that if the beatmap which is having changes
  copied across does not exist within the `BeatmapSet.Beatmaps` list, it
  was not yet persisted to realm.
  
  In some edge case, it can happen that the beatmap *is* persisted to
  realm but not correctly attached to the beatmap set. I don't yet know
  how this occurs, but it has caused loss of data for at least two users.
  
  The fix here is to check realm-wide for the beatmap (using its primary
  key) rather than only in the list. We then handle the scenario where the
  beatmap needs to be reattached to the set as a seprate step.
  
  ---
  
  This does raise others questions like "are we even structuring this
  correctly? couldn't a single beatmap exist in two different sets?"
  
  Maybe, but let's deal with that if/when it comes up.

  Dean Herbert · 2023-06-27 18:20:01 +09:00
  8e80e2fa32
• Update parameter discards
  Dean Herbert · 2022-06-24 21:26:19 +09:00
  31a447fda0
• Automated #nullable processing
  Dan Balasescu · 2022-06-17 16:37:17 +09:00
  f8830c6850
• Add detach mapping for BeatmapUserSettings
  Dean Herbert · 2022-03-01 20:12:59 +09:00
  7d11cfb301
• Add support for creating new blank difficulties
  Bartłomiej Dach · 2022-02-02 21:55:33 +01:00
  dc96c4888b
• Remove collection ToLive helper method to avoid confusion
  Dean Herbert · 2022-01-26 18:26:37 +09:00
  45636ce04b
• Remove ILive<> interface (and use abstract Live<> instead)
  Dean Herbert · 2022-01-26 13:38:56 +09:00
  cd71ec0edd
• Rename RealmContextFactory to RealmAccess
  Dean Herbert · 2022-01-24 20:38:07 +09:00
  6eb2c28e41
• Rename register methods to better explain their purpose
  Dean Herbert · 2022-01-24 14:37:36 +09:00
  40aa873190
• Add Register method for subscription purposes and update safeties
  Dean Herbert · 2022-01-21 19:06:18 +09:00
  18bf690a30
• Avoid constructor overhead for realm BeatmapSetInfo parameterless constructor
  Dean Herbert · 2022-01-20 17:03:44 +09:00
  ccddf9b47d
• Merge branch 'master' into optimise-set-detach-part-2
  Dan Balasescu · 2022-01-19 13:20:38 +09:00
  2556f1cb87
• Add comment explaining ignore rule
  Dean Herbert · 2022-01-19 09:44:21 +09:00
  761e161eec
• Avoid file retrieval overhead when detaching BeatmapSetInfo

  It seems that no usages of `BeatmapSetInfo` detaches require files - a
  `WorkingBeatmap` is always obtained before doing further lookups.
  
  Therefore we can omit this include unless the detaching object is a
  `BeatmapInfo`. A refetch is performed when retrieving a
  `WorkingBeatmap` to complete the equation.

  Dean Herbert · 2022-01-19 00:49:18 +09:00
  60b80c88b6
• Create separate automapper configurations to reduce cyclic detach overhead

  This optimises the `BeatmapSetInfo` detach operation by avoiding
  detaching `BeatmapSetInfo.Beatmaps[].BeatmapSetInfo` a second time over.

  Dean Herbert · 2022-01-19 00:03:24 +09:00
  f2b151023e
• Update automapper spec in line with v11

  See https://docs.automapper.org/en/latest/11.0-Upgrade-Guide.html for
   more details.

  Dean Herbert · 2022-01-18 15:23:28 +09:00
  9a43ed742b
• Fix stray bracket
  Dean Herbert · 2022-01-13 13:03:57 +09:00
  085893c9b4
• Make copying detached changes to realm only exposed for BeatmapSet

  Also fixes remaining issues with the copy process.

  Dean Herbert · 2022-01-12 17:49:11 +09:00
  f24b2b1be3
• Combine mapper configurations and add more explanation about special cases
  Dean Herbert · 2022-01-12 17:49:11 +09:00
  580ad03f8d
• Handle automapper realm cyclic references via AfterMaps

  This may not be the cleanest solution, but there don't seem to be any
  way towards this either.
  
  - `UseDestinationValue` has been inherited by default as noted in
  https://docs.automapper.org/en/stable/10.0-Upgrade-Guide.html#usedestinationvalue-is-now-inherited-by-default, and its behaviour in this case would be using the nested **managed** realm object for the destination member rather than creating an unmanaged version.
  
  - `MaxDepth` already sets `PreserveReferences` so there's no point of using it.
  
  - `MaxDepth` should probably not be set for all maps, only for those with
  cyclic references, to avoid the expensive overhead of `PreserveReferences`, as mentioned in https://docs.automapper.org/en/stable/5.0-Upgrade-Guide.html#circular-references.
  
  That aside, `MaxDepth` should actually only be set to `1` for
  `BeatmapSetInfo` mapping, because we don't want AutoMapper to create a
  nested instance of `BeatmapSetInfo` in each mapped/detached beatmap, but
  for some reason, doing that will cause automapper to not map any beatmap
  inside the set and leave it with 0 beatmaps.
  
  While on the other hand, using `MaxDepth(2)` for `BeatmapSetInfo` works,
  but creates an unused instance of a `BeatmapSetInfo` inside each mapped
  beatmap, which may not be ideal.
  
  For `BeatmapInfo`, it has to be `MaxDepth(2)`, in which the first
  `BeatmapInfo` depth would be itself (when detaching a beatmap), and the
  second would be nested beatmaps inside the mapped/detached
  `BeatmapSetInfo` within the beatmap. (note that when detaching a beatmap
  set, the unused instance of `BeatmapSetInfo` within each beatmap of that
  beatmap set doesn't also have a list of unused beatmaps as one might expect from the depth specification, it surprisingly has 0 beatmaps)
  
  This causes it to create an unused instance of `BeatmapInfo` in the beatmap set resembling the root mapped/detached beatmap, but that one might be inevitable.

  Salman Ahmed · 2022-01-12 17:49:11 +09:00
  6db3c32dd1
• Add basic write support via automapper
  Dean Herbert · 2022-01-12 17:49:11 +09:00
  f986c3ebd4
• Handle ignored mappings locally in Detach configuration
  Dean Herbert · 2022-01-12 17:00:17 +09:00
  aaefd72c69
• Detach and reattach scores to make work
  Dean Herbert · 2022-01-12 17:00:16 +09:00
  2b8706b6ce
• BeatmapSetInfo detach support
  Dean Herbert · 2022-01-12 17:00:16 +09:00
  8461eaab46
• Add mention to detach methods of only running once
  Dean Herbert · 2022-01-10 13:09:26 +09:00
  d072f1d08d
• Split out unmanaged implementation of RealmLive into its own class
  Dean Herbert · 2021-12-16 15:23:55 +09:00
  a9dbcd92a1
• Provide a realm factory to usages of ToLive/RealmLive
  Dean Herbert · 2021-12-14 14:26:34 +09:00
  441b7baa93
• Replace 'skin' in comments with 'instance'
  Dan Balasescu · 2021-12-01 20:17:38 +09:00
  685bdd522e
• Add missing returns additional documentation to main method call
  Dean Herbert · 2021-12-01 15:27:10 +09:00
  09817ff161
• Add extension methods to add extra safety to realm subscriptions

  Also adjusts the naming and documentation to make it (hopefully) easier
  to understand what this method/process implies.

  Dean Herbert · 2021-12-01 15:09:53 +09:00
  4306420922
• Return ILive from ToLive calls instead of realm-typed instance
  Dean Herbert · 2021-11-29 14:12:22 +09:00
  21e8ab8357
• Add RealmLive implementation
  Dean Herbert · 2021-10-11 15:36:41 +09:00
  b01d82b3fd
• Refine RealmContext implementation API
  Dean Herbert · 2021-09-30 23:56:38 +09:00
  9fa901f6aa