Change header for unchanged notebook meta

We previously changed to always showing the metadata diff in notebook merges, in case the user needs to make manual edits to it even if there are no changes in the merge itself. That change did not take into account that the display behavior here made some assumptions about only being shown when there was a change. Here we make the title conditional on whether there are changes or not, and make sure not to collapse similar changes in the case where there are none.
jupyter · Nov 17, 2023 · 68e1c26 · 68e1c26
1 parent 2f856da
commit 68e1c26
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/packages/nbdime/src/merge/widget/metadata.ts b/packages/nbdime/src/merge/widget/metadata.ts
@@ -17,7 +17,7 @@ import { MergePanel } from '../../common/basepanel';
 
 import type { MetadataMergeModel } from '../model';
 
-const ROOT_METADATA_CLASS = 'jp-Metadata-diff';
+const ROOT_METADATA_CLASS = 'jp-Metadata-merge';
 
 /**
  * MetadataWidget for changes to Notebook-level metadata
@@ -36,18 +36,27 @@ export class MetadataMergeWidget extends MergePanel<MetadataMergeModel> {
 
     // We know/assume that MetadataMergeModel never has
     // null values for local/remote:
+    const viewOptions = {...this._viewOptions};
+    const unchanged = model.decisions.length === 0;
+    if (unchanged) {
+      viewOptions.collapseIdentical = false;
+    }
     this.view = createNbdimeMergeView({
       remote: model.remote,
       local: model.local,
       merged: model.merged,
       factory: this._editorFactory,
       translator: this._translator,
-      ...this._viewOptions,
+      ...viewOptions,
     });
     const trans = this._translator.load('nbdime');
     const wrapper = new CollapsiblePanel(
       this.view,
-      trans.__('Notebook metadata changed'),
+      trans.__(
+        `Notebook metadata ${
+          unchanged ? 'unchanged' : 'changed'
+        }`,
+      ),
       true,
     );
     this.addWidget(wrapper);

diff --git a/packages/nbdime/src/styles/merge.css b/packages/nbdime/src/styles/merge.css
@@ -1,8 +1,8 @@
-.jp-Notebook-merge .jp-Metadata-diff {
+.jp-Notebook-merge .jp-Metadata-merge {
   margin-bottom: 20px;
 }
 
-.jp-Notebook-merge .jp-Metadata-diff .jp-CollapsiblePanel {
+.jp-Notebook-merge .jp-Metadata-merge .jp-CollapsiblePanel {
   border: solid black thin;
 }
 

diff --git a/ui-tests/tests/nbdime-merge-test1.spec.ts b/ui-tests/tests/nbdime-merge-test1.spec.ts
@@ -70,6 +70,11 @@ test.describe('merge test1', () => {
     // Finalize download
     expect(await download1.failure()).toBeNull();
   });
+
+  test('should not collapse source for unchanged metadata', async ({ page }) => {
+    await page.locator('.jp-Metadata-merge .jp-CollapsiblePanel-header-icon').click();
+    expect(await page.locator('#main').screenshot()).toMatchSnapshot();
+  });
 });
 
 test('3 panels view', async ({ page }) => {