Fix cached datasets diff #8386

MichaelBuessemeyer · 2025-02-06T14:31:16Z

URL of deployed dev instance (used for testing):

https://___.webknossos.xyz

Steps to test:

I don't have a reliable way to trigger the diff code :/

Issues:

fixes airbrake report https://scm.slack.com/archives/C5AKLAV0B/p1738833496765889

(Please delete unneeded items, merge only when none are left open)

Updated changelog

coderabbitai · 2025-02-06T14:31:22Z

📝 Walkthrough

Walkthrough

The changes update the dataset comparison logic within the diffDatasets function. The previous conditional check against the directoryName property has been removed, resulting in a simplified comparison that only ignores the lastUsedByUser timestamp. Additionally, the changelog has been updated to document new features, bug fixes, and the removal of a feature related to downsampling existing volume annotations. The overall function structure remains unchanged, and there are no modifications to any exported or public entities.

Changes

File	Summary
`frontend/.../dataset/queries.tsx`	Modified `diffDatasets` by removing the `directoryName` check and simplifying the equality logic to ignore only the `lastUsedByUser` timestamp.
`CHANGELOG.unreleased.md`	Updated to include new features, bug fixes, and removal of the downsampling feature; added a fix for a silent bug in the dashboard related to dataset refresh.

Suggested labels

refactoring

Suggested reviewers

philippotto

Poem

Hopping through lines of code so neat,
I found a tweak that's quite a treat.
The extra check has hopped away,
Leaving simple comparisons to play.
With every code change, my heart does sing—
Carrots and clean code make my day spring!
🥕🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b275184 and 2a79d7e.

📒 Files selected for processing (1)

CHANGELOG.unreleased.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

CHANGELOG.unreleased.md

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: circleci_build

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

CHANGELOG.unreleased.md (1)

23-23: Spelling Correction in Changelog Entry

The entry currently reads "silient bug" on line 23. Please correct the typo to "silent bug" for clarity and accuracy.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d16aad9 and bc4ad47.

📒 Files selected for processing (1)

CHANGELOG.unreleased.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: circleci_build

MichaelBuessemeyer

@philippotto Could you please check this PR?

Sadly I did not manage to find a why to test this reliably. Somehow the diff code is triggered relatively arbitrarily. I only managed it on wkorg in our orga and then switching between folders. When I locally switched between folders, it did not work :/

Regarding the two suggestion to fix this: I would prefer to remove the check in total (current version of the branch)

What do you think?

MichaelBuessemeyer · 2025-02-06T14:34:32Z

frontend/javascripts/dashboard/dataset/queries.tsx

-      return !_.isEqualWith(oldDataset, newDataset, (oldValue, newValue, key) => {
-        const didUpgradeToRenamableDS =
-          !("directoryName" in oldValue) && "directoryName" in newValue; // TODO: Can be remove after a few weeks / months.
-        if (key === "lastUsedByUser" || didUpgradeToRenamableDS) {
-          // Ignore the lastUsedByUser timestamp when diffing datasets and migrating datasets to new renamable version.
+      // Ignore updates when migrating to new renamable datasets.
+      const didUpgradeToRenamableDS = ("directoryName" in oldDataset && "directoryName" in newDataset); // TODO: Can be remove after a few weeks / months.
+      if(didUpgradeToRenamableDS) {
+        return false;
+      }
+      return !_.isEqualWith(oldDataset, newDataset, (_oldValue, _newValue, key) => {
+        if (key === "lastUsedByUser") {
+          // Ignore the lastUsedByUser timestamp when diffing datasets.


@philippotto We have 2 possiblilities of fixing this: Either avoid the invalid access by extracting the check from the inner isEqualWith method like done here.

MichaelBuessemeyer · 2025-02-06T14:35:48Z

frontend/javascripts/dashboard/dataset/queries.tsx

-      // Ignore updates when migrating to new renamable datasets.
-      const didUpgradeToRenamableDS = ("directoryName" in oldDataset && "directoryName" in newDataset); // TODO: Can be remove after a few weeks / months.
-      if(didUpgradeToRenamableDS) {
-        return false;
-      }


Or we remove whole check as we think that most of the user already refreshed their cached datasets after the dataset renaming pr. That's why this TODO comment was here.

CHANGELOG.unreleased.md

philippotto · 2025-02-06T14:52:21Z

frontend/javascripts/dashboard/dataset/queries.tsx

-        const didUpgradeToRenamableDS =
-          !("directoryName" in oldValue) && "directoryName" in newValue; // TODO: Can be remove after a few weeks / months.
-        if (key === "lastUsedByUser" || didUpgradeToRenamableDS) {


what will happen if a user hasn't logged into wk for the past few months and logs in now?

I'd say that all dataset are maked as diffs and thus are listed in the notification toast.
See:

webknossos/frontend/javascripts/dashboard/dataset/queries.tsx

Lines 518 to 549 in 5447c6e

export function generateDiffMessage(diff: {

changed: number;

onlyInOld: number;

onlyInNew: number;

}) {

const joinStrings = (a: string, b: string) => {

if (a && b) {

return `${a} ${b}`;

}

return `${a}${b}`;

};

const newOrChangedCount = diff.onlyInNew + diff.changed;

const newStr = diff.onlyInNew > 0 ? `${diff.onlyInNew} new ` : "";

const changedStr = diff.changed > 0 ? `${diff.changed} changed ` : "";

const maybeAnd = changedStr && newStr ? "and " : "";

const maybeAlso = newOrChangedCount ? "Also, " : "";

const removedStr =

diff.onlyInOld > 0

? `${maybeAlso}${diff.onlyInOld} ${Utils.pluralize(

"dataset",

diff.onlyInOld,

)} no longer ${Utils.conjugate("exist", diff.onlyInOld)} in this folder.`

: "";

const maybeNewAndChangedSentence = newOrChangedCount

? `There ${Utils.conjugate(

"are",

newOrChangedCount,

"is",

)} ${newStr}${maybeAnd}${changedStr}${Utils.pluralize("dataset", newOrChangedCount)}.`

: "";

return joinStrings(maybeNewAndChangedSentence, removedStr);

}

And

webknossos/frontend/javascripts/dashboard/dataset/queries.tsx

Lines 204 to 215 in 5447c6e

Toast.info(

<>

{generateDiffMessage(diff)}{" "}

<a href="#" onClick={acceptNewDatasets}>

Show updated list.

</a>

</>,

{

key: `new-datasets-are-available-${folderId || null}`,

timeout: DATASET_POLLING_INTERVAL / 2,

},

);

So it might be confusing 🤷. Alternatively we need to maintain this check for ever or at least some more months 🤔

ok, I think, this is okay as it's low impact :)

Co-authored-by: Philipp Otto <[email protected]>

Michael Büßemeyer added 2 commits February 6, 2025 15:27

fix accessing invalid key access when diffing datasets

bb4e1fa

remove checking for switching cached datasets to new renamable version

d16aad9

MichaelBuessemeyer added bug frontend labels Feb 6, 2025

MichaelBuessemeyer self-assigned this Feb 6, 2025

add changelog entry

bc4ad47

coderabbitai bot reviewed Feb 6, 2025

View reviewed changes

MichaelBuessemeyer commented Feb 6, 2025

View reviewed changes

MichaelBuessemeyer requested a review from philippotto February 6, 2025 14:38

philippotto reviewed Feb 6, 2025

View reviewed changes

Update CHANGELOG.unreleased.md

b275184

Co-authored-by: Philipp Otto <[email protected]>

philippotto approved these changes Feb 6, 2025

View reviewed changes

Merge branch 'master' into fix-cached-datasets-diff

2a79d7e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix cached datasets diff #8386

Fix cached datasets diff #8386

MichaelBuessemeyer commented Feb 6, 2025 •

edited

Loading

coderabbitai bot commented Feb 6, 2025 •

edited

Loading

Walkthrough

Changes

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

MichaelBuessemeyer left a comment

MichaelBuessemeyer Feb 6, 2025

MichaelBuessemeyer Feb 6, 2025

philippotto Feb 6, 2025

MichaelBuessemeyer Feb 6, 2025

philippotto Feb 6, 2025

	export function generateDiffMessage(diff: {
	changed: number;
	onlyInOld: number;
	onlyInNew: number;
	}) {
	const joinStrings = (a: string, b: string) => {
	if (a && b) {
	return `${a} ${b}`;
	}
	return `${a}${b}`;
	};
	const newOrChangedCount = diff.onlyInNew + diff.changed;
	const newStr = diff.onlyInNew > 0 ? `${diff.onlyInNew} new ` : "";
	const changedStr = diff.changed > 0 ? `${diff.changed} changed ` : "";
	const maybeAnd = changedStr && newStr ? "and " : "";
	const maybeAlso = newOrChangedCount ? "Also, " : "";
	const removedStr =
	diff.onlyInOld > 0
	? `${maybeAlso}${diff.onlyInOld} ${Utils.pluralize(
	"dataset",
	diff.onlyInOld,
	)} no longer ${Utils.conjugate("exist", diff.onlyInOld)} in this folder.`
	: "";
	const maybeNewAndChangedSentence = newOrChangedCount
	? `There ${Utils.conjugate(
	"are",
	newOrChangedCount,
	"is",
	)} ${newStr}${maybeAnd}${changedStr}${Utils.pluralize("dataset", newOrChangedCount)}.`
	: "";
	return joinStrings(maybeNewAndChangedSentence, removedStr);
	}

	Toast.info(
	<>
	{generateDiffMessage(diff)}{" "}
	<a href="#" onClick={acceptNewDatasets}>
	Show updated list.
	</a>
	</>,
	{
	key: `new-datasets-are-available-${folderId \|\| null}`,
	timeout: DATASET_POLLING_INTERVAL / 2,
	},
	);

Fix cached datasets diff #8386

Are you sure you want to change the base?

Fix cached datasets diff #8386

Conversation

MichaelBuessemeyer commented Feb 6, 2025 • edited Loading

URL of deployed dev instance (used for testing):

Steps to test:

Issues:

coderabbitai bot commented Feb 6, 2025 • edited Loading

Walkthrough

Changes

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

MichaelBuessemeyer left a comment

Choose a reason for hiding this comment

MichaelBuessemeyer Feb 6, 2025

Choose a reason for hiding this comment

MichaelBuessemeyer Feb 6, 2025

Choose a reason for hiding this comment

philippotto Feb 6, 2025

Choose a reason for hiding this comment

MichaelBuessemeyer Feb 6, 2025

Choose a reason for hiding this comment

philippotto Feb 6, 2025

Choose a reason for hiding this comment

MichaelBuessemeyer commented Feb 6, 2025 •

edited

Loading

coderabbitai bot commented Feb 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)