Publishing then checking the same schema no longer can cause a diff (#8361)

Author: jdolle

.changeset/breezy-ears-raise.md

@@ -0,0 +1,6 @@
+---
+'hive': patch
+---
+
+Remove pretty print from check diff view. Add integration and e2e tests to verify publishing then
+checking the same SDL won't cause a difference in the schema check diff viewer

e2e/fixtures.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line import/no-extraneous-dependencies -- required before loading seed helpers
 import 'reflect-metadata';
 import { test as base, expect, type Page } from '@playwright/test';
-import { initSeed } from '../integration-tests/testkit/seed';
+import { initSeed, ProjectType } from '../integration-tests/testkit/seed';
 import { createAppHelper, type AppHelper } from './helpers/app';
 import { createAuthHelper, type AuthHelper } from './helpers/auth';
 import { createLaboratoryHelper, type LaboratoryHelper } from './helpers/laboratory';
@@ -10,7 +10,17 @@ import { createUsageHelper, type UsageHelper } from './helpers/usage';
 
 export type SeedHelper = {
   seedOrg(): Promise<{ slug: string; accessToken: string; refreshToken: string; email: string }>;
-  seedTarget(): Promise<{ slug: string; accessToken: string; refreshToken: string; email: string }>;
+  seedTarget(type: ProjectType): Promise<{
+    slug: string;
+    accessToken: string;
+    refreshToken: string;
+    email: string;
+    resources: {
+      organizationId: string;
+      projectId: string;
+      targetId: string;
+    };
+  }>;
   getEmailConfirmationLink(input: string | { email: string; now: number }): Promise<string>;
   purgeOIDCDomains(): Promise<void>;
   purgeUserByEmail(email: string): Promise<void>;
@@ -50,16 +60,21 @@ async function createSeedHelper(): Promise<SeedHelper> {
         email: owner.ownerEmail,
       };
     },
-    async seedTarget() {
+    async seedTarget(projectType?: ProjectType) {
       const owner = await seed.createOwner();
       const org = await owner.createOrg();
-      const project = await org.createProject();
+      const project = await org.createProject(projectType);
 
       return {
         slug: `${org.organization.slug}/${project.project.slug}/${project.target.slug}`,
         accessToken: owner.ownerToken,
         refreshToken: owner.ownerRefreshToken,
         email: owner.ownerEmail,
+        resources: {
+          organizationId: org.organization.id,
+          projectId: project.project.id,
+          targetId: project.target.id,
+        },
       };
     },
     async getEmailConfirmationLink(input) {

e2e/local.sh

@@ -0,0 +1,81 @@
+import { readFileSync } from 'fs';
+import { checkSchema, publishSchema } from 'testkit/flow';
+import { ProjectType } from 'testkit/seed';
+import { expect, test } from '../fixtures';
+
+test.describe('checks', () => {
+  test('should not show a diff for a version and check with the same SDL', async ({
+    page,
+    seed,
+    auth,
+  }) => {
+    // const { accessToken, refreshToken, slug } = await seed.seedOrg();
+    const { accessToken, refreshToken, slug, resources } = await seed.seedTarget(
+      ProjectType.Federation,
+    );
+    const sdl = readFileSync('integration-tests/fixtures/federation-00.graphql', 'utf-8');
+    await publishSchema(
+      {
+        sdl,
+        service: 'test',
+        url: 'http://localhost:4141/test',
+        target: {
+          byId: resources.targetId,
+        },
+        author: 'e2e',
+        commit: 'xyz',
+      },
+      accessToken,
+    );
+    const check = await checkSchema(
+      {
+        sdl,
+        service: 'test',
+        url: 'http://localhost:4141/test',
+        target: {
+          byId: resources.targetId,
+        },
+      },
+      accessToken,
+    ).then(r => r.expectNoGraphQLErrors());
+    await expect(check.schemaCheck.__typename).toBe('SchemaCheckSuccess');
+    if (check.schemaCheck.__typename === 'SchemaCheckSuccess') {
+      async function editorHasNoDeletions() {
+        let previousScrollTop = -1;
+        let currentScrollTop = 0;
+        while (currentScrollTop !== previousScrollTop) {
+          previousScrollTop = currentScrollTop;
+          currentScrollTop = await page.evaluate(async () => {
+            const scroller = document.querySelector(
+              '.monaco-editor .monaco-scrollable-element',
+            ) as HTMLElement;
+            scroller.scrollTop += 400; // Shift downwards
+            return scroller.scrollTop;
+          });
+          await expect(page.locator('.monaco-editor .gutter-delete')).toBeHidden(); // no "removed" diff element
+          await page.waitForTimeout(50);
+        }
+      }
+
+      await auth.useSession({ refreshToken, accessToken });
+      await page.goto(
+        `/${slug}/checks/${check.schemaCheck.schemaCheck?.id}?filter_changed=false&filter_failed=false`,
+        {
+          waitUntil: 'domcontentloaded',
+        },
+      );
+
+      await page.getByTestId('service-view-btn').click(); // move to service tab
+      await expect(page.locator('.monaco-editor.gutter')).toBeAttached({ timeout: 2000 }); // schema diff editor exists
+      await editorHasNoDeletions();
+
+      await page.getByTestId('schema-view-btn').click(); // move to schema tab
+      await expect(page.locator('.monaco-editor.gutter')).toBeAttached({ timeout: 2000 }); // schema diff editor exists
+      await editorHasNoDeletions();
+
+      await page.getByTestId('supergraph-view-btn').click(); // move to supergraph tab
+      await expect(page.locator('.monaco-editor.gutter')).toBeAttached({ timeout: 2000 }); // schema diff editor exists
+      await editorHasNoDeletions();
+    }
+  });
+});