feat(core): align GitHub metadata handling with other backends (#3316)

* Revert "Revert "feat(core): Align GitHub metadata handling with other backends (#3292)""

This reverts commit 5bdd3df9ccbb5149c22d79987ebdcd6cab4b261f.

* fix(backend-github): fix migration code

* test(backend-github): fix test

* test(e2e): shorten wait time

* test(e2e): try and fix test on CI

cypress/integration/common/editorial_workflow_migrations.js

@@ -0,0 +1,52 @@
+import '../../utils/dismiss-local-backup';
+import {
+  login,
+  createPostAndExit,
+  goToWorkflow,
+  goToCollections,
+  updateWorkflowStatus,
+  publishWorkflowEntry,
+  assertPublishedEntry,
+} from '../../utils/steps';
+import { workflowStatus } from '../../utils/constants';
+
+const versions = ['2.9.7', '2.10.24'];
+
+export default function({ entries, getUser }) {
+  versions.forEach(version => {
+    it(`migrate from ${version} to latest`, () => {
+      cy.task('switchToVersion', {
+        version,
+      });
+      cy.reload();
+
+      login(getUser());
+      createPostAndExit(entries[0]);
+      createPostAndExit(entries[1]);
+      createPostAndExit(entries[2]);
+      goToWorkflow();
+      updateWorkflowStatus(entries[2], workflowStatus.draft, workflowStatus.ready);
+      // eslint-disable-next-line cypress/no-unnecessary-waiting
+      cy.wait(1500); // older versions of the CMS didn't wait fully for the update to be resolved
+      updateWorkflowStatus(entries[1], workflowStatus.draft, workflowStatus.ready);
+      // eslint-disable-next-line cypress/no-unnecessary-waiting
+      cy.wait(1500); // older versions of the CMS didn't wait fully for the update to be resolved
+      updateWorkflowStatus(entries[0], workflowStatus.draft, workflowStatus.ready);
+      // eslint-disable-next-line cypress/no-unnecessary-waiting
+      cy.wait(1500); // older versions of the CMS didn't wait fully for the update to be resolved
+
+      cy.task('switchToVersion', {
+        version: 'latest',
+      });
+      cy.reload();
+
+      // allow migration code to run for 5 minutes
+      Cypress.config('defaultCommandTimeout', 5 * 60 * 1000);
+      publishWorkflowEntry(entries[2]);
+      publishWorkflowEntry(entries[1]);
+      publishWorkflowEntry(entries[0]);
+      goToCollections();
+      assertPublishedEntry([entries[2], entries[1], entries[0]]);
+    });
+  });
+}

cypress/integration/common/spec_utils.js

@@ -50,3 +50,10 @@ export const afterEach = (taskResult, backend) => {
     Cypress.runner.stop();
   }
 };
+
+export const seedRepo = (taskResult, backend) => {
+  cy.task('seedRepo', {
+    backend,
+    ...taskResult.data,
+  });
+};

cypress/integration/editorial_workflow_migration_spec_github_backend_rest.js

@@ -0,0 +1,38 @@
+import fixture from './common/editorial_workflow_migrations';
+import * as specUtils from './common/spec_utils';
+import { entry1, entry2, entry3 } from './common/entries';
+
+const backend = 'github';
+
+describe('Github Backend Editorial Workflow Migration - REST API', () => {
+  const taskResult = { data: {} };
+
+  before(() => {
+    specUtils.before(
+      taskResult,
+      {
+        backend: { use_graphql: false, open_authoring: false },
+        publish_mode: 'editorial_workflow',
+      },
+      backend,
+    );
+  });
+
+  after(() => {
+    specUtils.after(taskResult, backend);
+  });
+
+  beforeEach(() => {
+    specUtils.beforeEach(taskResult, backend);
+    specUtils.seedRepo(taskResult, backend);
+  });
+
+  afterEach(() => {
+    specUtils.afterEach(taskResult, backend);
+  });
+
+  fixture({
+    entries: [entry1, entry2, entry3],
+    getUser: () => taskResult.data.user,
+  });
+});