create-nextblock 0.16.1 → 0.16.2

package/templates/nextblock-template/lib/seo/robots-settings-signature.test.ts

@@ -1,102 +1,102 @@
-import { describe, expect, it } from 'vitest';
-import type { RobotsSettings } from '@nextblock-cms/utils/seo';
-
-import { robotsSettingsSignature } from './robots-settings-signature';
-
-function settings(overrides: Partial<RobotsSettings> = {}): RobotsSettings {
-  return {
-    customRules: '',
-    isIndexingEnabled: true,
-    sitemapEnabled: true,
-    userAgentRules: [{ allow: ['/'], disallow: ['/cms'], userAgent: '*' }],
-    ...overrides,
-  };
-}
-
-describe('robotsSettingsSignature', () => {
-  it('matches for two structurally identical objects that are not the same object', () => {
-    // This is the case that matters most: a server component hands down a brand-new object
-    // on every render, and re-seeding the form on that would destroy in-progress typing.
-    expect(robotsSettingsSignature(settings())).toBe(robotsSettingsSignature(settings()));
-  });
-
-  it('ignores the key order of the object literal it is handed', () => {
-    const alphabetical = settings();
-    const reordered = {
-      userAgentRules: [{ userAgent: '*', disallow: ['/cms'], allow: ['/'] }],
-      sitemapEnabled: true,
-      isIndexingEnabled: true,
-      customRules: '',
-    } as RobotsSettings;
-
-    expect(robotsSettingsSignature(reordered)).toBe(robotsSettingsSignature(alphabetical));
-    // The old comparison this replaces was raw JSON.stringify, which does not.
-    expect(JSON.stringify(reordered)).not.toBe(JSON.stringify(alphabetical));
-  });
-
-  it('changes when the server normalises a path the operator typed', () => {
-    const typed = settings({ userAgentRules: [{ allow: ['/'], disallow: ['cms'], userAgent: '*' }] });
-    const normalised = settings({
-      userAgentRules: [{ allow: ['/'], disallow: ['/cms'], userAgent: '*' }],
-    });
-
-    expect(robotsSettingsSignature(typed)).not.toBe(robotsSettingsSignature(normalised));
-  });
-
-  it('changes when a rule is dropped, added, or emptied', () => {
-    expect(robotsSettingsSignature(settings({ userAgentRules: [] }))).not.toBe(
-      robotsSettingsSignature(settings())
-    );
-    expect(
-      robotsSettingsSignature(
-        settings({
-          userAgentRules: [
-            { allow: ['/'], disallow: ['/cms'], userAgent: '*' },
-            { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
-          ],
-        })
-      )
-    ).not.toBe(robotsSettingsSignature(settings()));
-  });
-
-  it('changes when only the order of the user-agent blocks differs', () => {
-    const first = settings({
-      userAgentRules: [
-        { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
-        { allow: ['/'], disallow: [], userAgent: '*' },
-      ],
-    });
-    const swapped = settings({
-      userAgentRules: [
-        { allow: ['/'], disallow: [], userAgent: '*' },
-        { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
-      ],
-    });
-
-    expect(robotsSettingsSignature(first)).not.toBe(robotsSettingsSignature(swapped));
-  });
-
-  it('changes for each of the scalar fields', () => {
-    expect(robotsSettingsSignature(settings({ customRules: '# hi' }))).not.toBe(
-      robotsSettingsSignature(settings())
-    );
-    expect(robotsSettingsSignature(settings({ isIndexingEnabled: false }))).not.toBe(
-      robotsSettingsSignature(settings())
-    );
-    expect(robotsSettingsSignature(settings({ sitemapEnabled: false }))).not.toBe(
-      robotsSettingsSignature(settings())
-    );
-  });
-
-  it('does not confuse an allow list with a disallow list of the same paths', () => {
-    expect(
-      robotsSettingsSignature(
-        settings({ userAgentRules: [{ allow: ['/a'], disallow: [], userAgent: '*' }] })
-      )
-    ).not.toBe(
-      robotsSettingsSignature(
-        settings({ userAgentRules: [{ allow: [], disallow: ['/a'], userAgent: '*' }] })
-      )
-    );
-  });
-});
+import { describe, expect, it } from 'vitest';
+import type { RobotsSettings } from '@nextblock-cms/utils/seo';
+
+import { robotsSettingsSignature } from './robots-settings-signature';
+
+function settings(overrides: Partial<RobotsSettings> = {}): RobotsSettings {
+  return {
+    customRules: '',
+    isIndexingEnabled: true,
+    sitemapEnabled: true,
+    userAgentRules: [{ allow: ['/'], disallow: ['/cms'], userAgent: '*' }],
+    ...overrides,
+  };
+}
+
+describe('robotsSettingsSignature', () => {
+  it('matches for two structurally identical objects that are not the same object', () => {
+    // This is the case that matters most: a server component hands down a brand-new object
+    // on every render, and re-seeding the form on that would destroy in-progress typing.
+    expect(robotsSettingsSignature(settings())).toBe(robotsSettingsSignature(settings()));
+  });
+
+  it('ignores the key order of the object literal it is handed', () => {
+    const alphabetical = settings();
+    const reordered = {
+      userAgentRules: [{ userAgent: '*', disallow: ['/cms'], allow: ['/'] }],
+      sitemapEnabled: true,
+      isIndexingEnabled: true,
+      customRules: '',
+    } as RobotsSettings;
+
+    expect(robotsSettingsSignature(reordered)).toBe(robotsSettingsSignature(alphabetical));
+    // The old comparison this replaces was raw JSON.stringify, which does not.
+    expect(JSON.stringify(reordered)).not.toBe(JSON.stringify(alphabetical));
+  });
+
+  it('changes when the server normalises a path the operator typed', () => {
+    const typed = settings({ userAgentRules: [{ allow: ['/'], disallow: ['cms'], userAgent: '*' }] });
+    const normalised = settings({
+      userAgentRules: [{ allow: ['/'], disallow: ['/cms'], userAgent: '*' }],
+    });
+
+    expect(robotsSettingsSignature(typed)).not.toBe(robotsSettingsSignature(normalised));
+  });
+
+  it('changes when a rule is dropped, added, or emptied', () => {
+    expect(robotsSettingsSignature(settings({ userAgentRules: [] }))).not.toBe(
+      robotsSettingsSignature(settings())
+    );
+    expect(
+      robotsSettingsSignature(
+        settings({
+          userAgentRules: [
+            { allow: ['/'], disallow: ['/cms'], userAgent: '*' },
+            { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
+          ],
+        })
+      )
+    ).not.toBe(robotsSettingsSignature(settings()));
+  });
+
+  it('changes when only the order of the user-agent blocks differs', () => {
+    const first = settings({
+      userAgentRules: [
+        { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
+        { allow: ['/'], disallow: [], userAgent: '*' },
+      ],
+    });
+    const swapped = settings({
+      userAgentRules: [
+        { allow: ['/'], disallow: [], userAgent: '*' },
+        { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
+      ],
+    });
+
+    expect(robotsSettingsSignature(first)).not.toBe(robotsSettingsSignature(swapped));
+  });
+
+  it('changes for each of the scalar fields', () => {
+    expect(robotsSettingsSignature(settings({ customRules: '# hi' }))).not.toBe(
+      robotsSettingsSignature(settings())
+    );
+    expect(robotsSettingsSignature(settings({ isIndexingEnabled: false }))).not.toBe(
+      robotsSettingsSignature(settings())
+    );
+    expect(robotsSettingsSignature(settings({ sitemapEnabled: false }))).not.toBe(
+      robotsSettingsSignature(settings())
+    );
+  });
+
+  it('does not confuse an allow list with a disallow list of the same paths', () => {
+    expect(
+      robotsSettingsSignature(
+        settings({ userAgentRules: [{ allow: ['/a'], disallow: [], userAgent: '*' }] })
+      )
+    ).not.toBe(
+      robotsSettingsSignature(
+        settings({ userAgentRules: [{ allow: [], disallow: ['/a'], userAgent: '*' }] })
+      )
+    );
+  });
+});

package/templates/nextblock-template/lib/seo/robots-settings-signature.ts

@@ -1,41 +1,41 @@
-/**
- * A canonical, order-independent fingerprint of a `RobotsSettings` value.
- *
- * `RobotsCard` needs the same question answered twice, and both answers have to be about
- * VALUES rather than object identity. It asks "has the operator changed anything?" to gate
- * the Save button, and "did the settings the server sent actually change?" to decide
- * whether to re-seed its local state from the prop. The second question is the one that
- * used to go unasked: the card seeded its state once and never looked at the prop again,
- * so after a save the server's normalised row — blank paths dropped, leading slashes added
- * — arrived and was ignored, leaving the dirty indicator lit forever and the preview
- * showing rules that had already been tidied away.
- *
- * The naive fix, an effect keyed on the `settings` object, is wrong in the other
- * direction, and for a reason worth writing down: a server component hands down a fresh
- * object on every render, so `settings` changes identity on every `router.refresh()` even
- * when nothing about it changed. Keying on identity would therefore blow away whatever the
- * operator was typing whenever anything else on the page revalidated. Comparing
- * fingerprints reduces "the prop changed" to "the prop's content changed", which is the
- * only version of the question that is safe to act on.
- *
- * Serialising an explicit array rather than `JSON.stringify(settings)` removes the last
- * hidden assumption in the old dirty check: `JSON.stringify` preserves insertion order, so
- * that comparison silently relied on the form's object literal and
- * `normalizeRobotsSettings`' object literal listing their keys identically. They do today
- * — the house convention is alphabetical — but a future reorder would have turned a clean
- * form permanently dirty, and nothing would have pointed at the cause.
- */
-
-import type { RobotsSettings } from '@nextblock-cms/utils/seo';
-
-export function robotsSettingsSignature(settings: RobotsSettings): string {
-  return JSON.stringify([
-    settings.customRules,
-    settings.isIndexingEnabled,
-    settings.sitemapEnabled,
-    // Rule ORDER is deliberately significant: robots.txt groups are matched in order, so
-    // two settings differing only in how their user-agent blocks are sequenced are two
-    // different files and must not fingerprint the same.
-    settings.userAgentRules.map((rule) => [rule.userAgent, rule.allow, rule.disallow]),
-  ]);
-}
+/**
+ * A canonical, order-independent fingerprint of a `RobotsSettings` value.
+ *
+ * `RobotsCard` needs the same question answered twice, and both answers have to be about
+ * VALUES rather than object identity. It asks "has the operator changed anything?" to gate
+ * the Save button, and "did the settings the server sent actually change?" to decide
+ * whether to re-seed its local state from the prop. The second question is the one that
+ * used to go unasked: the card seeded its state once and never looked at the prop again,
+ * so after a save the server's normalised row — blank paths dropped, leading slashes added
+ * — arrived and was ignored, leaving the dirty indicator lit forever and the preview
+ * showing rules that had already been tidied away.
+ *
+ * The naive fix, an effect keyed on the `settings` object, is wrong in the other
+ * direction, and for a reason worth writing down: a server component hands down a fresh
+ * object on every render, so `settings` changes identity on every `router.refresh()` even
+ * when nothing about it changed. Keying on identity would therefore blow away whatever the
+ * operator was typing whenever anything else on the page revalidated. Comparing
+ * fingerprints reduces "the prop changed" to "the prop's content changed", which is the
+ * only version of the question that is safe to act on.
+ *
+ * Serialising an explicit array rather than `JSON.stringify(settings)` removes the last
+ * hidden assumption in the old dirty check: `JSON.stringify` preserves insertion order, so
+ * that comparison silently relied on the form's object literal and
+ * `normalizeRobotsSettings`' object literal listing their keys identically. They do today
+ * — the house convention is alphabetical — but a future reorder would have turned a clean
+ * form permanently dirty, and nothing would have pointed at the cause.
+ */
+
+import type { RobotsSettings } from '@nextblock-cms/utils/seo';
+
+export function robotsSettingsSignature(settings: RobotsSettings): string {
+  return JSON.stringify([
+    settings.customRules,
+    settings.isIndexingEnabled,
+    settings.sitemapEnabled,
+    // Rule ORDER is deliberately significant: robots.txt groups are matched in order, so
+    // two settings differing only in how their user-agent blocks are sequenced are two
+    // different files and must not fingerprint the same.
+    settings.userAgentRules.map((rule) => [rule.userAgent, rule.allow, rule.disallow]),
+  ]);
+}