-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(cm): add content history under future flag (#19315)
feat(cm): add content history
- Loading branch information
Showing
71 changed files
with
3,649 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Specify any environment variables you would like to use for your tests | ||
|
|
||
| # Examples: | ||
| STRAPI_LICENSE=your_license_key | ||
| STRAPI_FEATURES_FUTURE_CONTENT_HISTORY=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| module.exports = ({ env }) => ({ | ||
| future: { | ||
| history: env.bool('STRAPI_FEATURES_FUTURE_CONTENT_HISTORY', false), | ||
| contentReleasesScheduling: env.bool('STRAPI_FEATURES_FUTURE_RELEASES_SCHEDULING', false), | ||
| }, | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| import { test, expect } from '@playwright/test'; | ||
| import { login } from '../../utils/login'; | ||
| import { resetDatabaseAndImportDataFromPath } from '../../scripts/dts-import'; | ||
| import { describeOnCondition } from '../../utils/shared'; | ||
|
|
||
| const hasFutureFlag = process.env.STRAPI_FEATURES_FUTURE_CONTENT_HISTORY === 'true'; | ||
|
|
||
| describeOnCondition(hasFutureFlag)('History', () => { | ||
| test.describe('Collection Type', () => { | ||
| test.beforeEach(async ({ page }) => { | ||
| await resetDatabaseAndImportDataFromPath('./e2e/data/with-admin.tar'); | ||
| await page.goto('/admin'); | ||
| await login({ page }); | ||
| }); | ||
|
|
||
| test('A user should be able create, edit, or publish/unpublish an entry, navigate to the history page, and select versions to view from a list', async ({ | ||
| page, | ||
| }) => { | ||
| const CREATE_URL = | ||
| /\/admin\/content-manager\/collection-types\/api::article.article\/create(\?.*)?/; | ||
| const HISTORY_URL = | ||
| /\/admin\/content-manager\/collection-types\/api::article.article\/[^/]+\/history(\?.*)?/; | ||
| // Navigate to the content-manager - collection type - article | ||
| await page.getByRole('link', { name: 'Content Manager' }).click(); | ||
| await page.getByRole('combobox', { name: 'Select a locale' }).click(); | ||
| await page.getByRole('option', { name: 'French (fr)' }).click(); | ||
| await page.getByRole('link', { name: /Create new entry/, exact: true }).click(); | ||
| await page.waitForURL(CREATE_URL); | ||
|
|
||
| /** | ||
| * Create | ||
| */ | ||
| const titleInput = await page.getByRole('textbox', { name: 'title' }); | ||
| // Create a french version | ||
| const frenchTitle = "N'importe quoi"; | ||
| await titleInput.fill(frenchTitle); | ||
| await page.getByRole('button', { name: 'Save' }).click(); | ||
| // Go to the history page | ||
| await page.getByRole('link', { name: 'History' }).click(); | ||
| await page.waitForURL(HISTORY_URL); | ||
| await expect(titleInput).toHaveValue(frenchTitle); | ||
|
|
||
| // Go back to the CM to create a new english entry | ||
| await page.goto('/admin'); | ||
| await page.getByRole('link', { name: 'Content Manager' }).click(); | ||
| await page.getByRole('link', { name: /Create new entry/, exact: true }).click(); | ||
| await page.waitForURL(CREATE_URL); | ||
|
|
||
| // Create an english version | ||
| const englishTitle = 'Being from Kansas is a pity'; | ||
| await titleInput.fill(englishTitle); | ||
| await page.getByRole('button', { name: 'Save' }).click(); | ||
| // Go to the history page | ||
| await page.getByRole('link', { name: 'History' }).click(); | ||
| await page.waitForURL(HISTORY_URL); | ||
| const versionCards = await page.getByRole('listitem', { name: 'Version card' }); | ||
| await expect(versionCards).toHaveCount(1); | ||
| // Assert the id was added after page load | ||
| const idRegex = /id=\d+/; | ||
| await expect(idRegex.test(page.url())).toBe(true); | ||
| // Assert the most recent version is the current version | ||
| const currentVersion = versionCards.nth(0); | ||
| await expect(currentVersion.getByText('(current)')).toBeVisible(); | ||
| await expect(currentVersion.getByText('Draft')).toBeVisible(); | ||
| await expect(titleInput).toBeDisabled(); | ||
| await expect(titleInput).toHaveValue(englishTitle); | ||
| // Assert only the english versions are available | ||
| await expect(page.getByText(frenchTitle)).not.toBeVisible(); | ||
|
|
||
| // Go back to the entry | ||
| await page.getByRole('link', { name: 'Back' }).click(); | ||
|
|
||
| /** | ||
| * Update | ||
| */ | ||
| await titleInput.fill('Being from Kansas City'); | ||
| await page.getByRole('button', { name: 'Save' }).click(); | ||
| // Go to the history page | ||
| await page.getByRole('link', { name: 'History' }).click(); | ||
| await expect(versionCards).toHaveCount(2); | ||
| // Assert the most recent version is the current version | ||
| versionCards.first().click(); | ||
| await expect(titleInput).toHaveValue('Being from Kansas City'); | ||
| // Assert the previous version in the list is the expected version | ||
| const previousVersion = versionCards.nth(1); | ||
| previousVersion.click(); | ||
| await expect(titleInput).toHaveValue('Being from Kansas is a pity'); | ||
| await expect(previousVersion.getByText('(current)')).not.toBeVisible(); | ||
|
|
||
| // Go back to the entry | ||
| // await page.getByRole('link', { name: 'Back' }).click(); | ||
|
|
||
| /** | ||
| * Publish | ||
| * | ||
| * TODO: Fix publish | ||
| * The publish action in the middleware used to create history versions has a different shape than the other actions. | ||
| * This leaves us with null for status and relatedDocumentId in the history version. | ||
| * | ||
| */ | ||
| // await page.getByRole('button', { name: 'Publish' }).click(); | ||
| // await page.getByRole('link', { name: 'History' }).click(); | ||
| // await page.waitForURL( | ||
| // '**/content-manager/collection-types/api::article.article/*/history?plugins\\[i18n\\]\\[locale\\]=en' | ||
| // ); | ||
| // await expect(versionCards).toHaveCount(3); | ||
| // // Assert the current version is the most recent published version | ||
| // await expect(titleInput).toHaveValue('Being from Kansas City'); | ||
| // await expect(currentVersion.getByText('Published')).toBeVisible(); | ||
| // // Assert the previous version in the list is the expected version | ||
| // await expect(versionCards.nth(1).getByText('Draft')).toBeVisible(); | ||
| // versionCards.nth(1).click(); | ||
| // await expect(titleInput).toHaveValue('Being from Kansas City'); | ||
| }); | ||
| }); | ||
|
|
||
| test.describe('Single Type', () => { | ||
| test.beforeEach(async ({ page }) => { | ||
| await resetDatabaseAndImportDataFromPath('./e2e/data/with-admin.tar'); | ||
| await page.goto('/admin'); | ||
| await login({ page }); | ||
| }); | ||
|
|
||
| test('A user should be able create, edit, or publish/unpublish an entry, navigate to the history page, and select versions to view from a list', async ({ | ||
| page, | ||
| }) => { | ||
| const HISTORY_URL = | ||
| /\/admin\/content-manager\/single-types\/api::homepage.homepage\/history(\?.*)?/; | ||
|
|
||
| // Navigate to the content-manager - single type - homepage | ||
| await page.getByRole('link', { name: 'Content Manager' }).click(); | ||
| await page.getByRole('link', { name: 'Homepage' }).click(); | ||
| await page.getByRole('combobox', { name: 'Locales' }).click(); | ||
| await page.getByRole('option', { name: 'French (fr)' }).click(); | ||
|
|
||
| /** | ||
| * Create | ||
| */ | ||
| const titleInput = await page.getByRole('textbox', { name: 'title' }); | ||
| // Create a french version | ||
| const frenchTitle = 'Paris Saint-Germain'; | ||
| await titleInput.fill(frenchTitle); | ||
| await page.getByRole('button', { name: 'Save' }).click(); | ||
| // Go to the history page | ||
| await page.getByRole('link', { name: 'History' }).click(); | ||
| await page.waitForURL(HISTORY_URL); | ||
| await expect(titleInput).toHaveValue(frenchTitle); | ||
|
|
||
| // Go back to the CM to create a new english entry | ||
| await page.getByRole('link', { name: 'Back' }).click(); | ||
| await page.getByRole('combobox', { name: 'Locales' }).click(); | ||
| await page.getByRole('option', { name: 'English (en)' }).click(); | ||
|
|
||
| // Create an english version | ||
| const englishTitle = 'AFC Richmond'; | ||
| await titleInput.fill(englishTitle); | ||
| await page.getByRole('button', { name: 'Save' }).click(); | ||
| // Go to the history page | ||
| await page.getByRole('link', { name: 'History' }).click(); | ||
| await page.waitForURL(HISTORY_URL); | ||
| const versionCards = await page.getByRole('listitem', { name: 'Version card' }); | ||
| await expect(versionCards).toHaveCount(1); | ||
| // Assert the id was added after page load | ||
| const idRegex = /id=\d+/; | ||
| await expect(idRegex.test(page.url())).toBe(true); | ||
| // Assert the most recent version is the current version | ||
| const currentVersion = versionCards.nth(0); | ||
| await expect(currentVersion.getByText('(current)')).toBeVisible(); | ||
| await expect(currentVersion.getByText('Draft')).toBeVisible(); | ||
| await expect(titleInput).toBeDisabled(); | ||
| await expect(titleInput).toHaveValue(englishTitle); | ||
| // Assert only the english versions are available | ||
| await expect(page.getByText(frenchTitle)).not.toBeVisible(); | ||
|
|
||
| // Go back to the entry | ||
| await page.getByRole('link', { name: 'Back' }).click(); | ||
|
|
||
| /** | ||
| * Update | ||
| */ | ||
| await page.getByRole('textbox', { name: 'title' }).fill('Welcome to AFC Richmond'); | ||
| await page.getByRole('button', { name: 'Save' }).click(); | ||
| await page.getByRole('link', { name: 'History' }).click(); | ||
| await expect(versionCards).toHaveCount(2); | ||
| // Assert the most recent version is the current version | ||
| versionCards.first().click(); | ||
| await expect(titleInput).toHaveValue('Welcome to AFC Richmond'); | ||
| // Assert the previous version in the list is the expected version | ||
| versionCards.nth(1).click(); | ||
| await expect(titleInput).toHaveValue('AFC Richmond'); | ||
|
|
||
| // Go back to the entry | ||
| // await page.getByRole('link', { name: 'Back' }).click(); | ||
|
|
||
| /** | ||
| * Publish | ||
| * | ||
| * TODO: Fix publish | ||
| * The publish action in the middleware used to create history versions has a different shape than the other actions. | ||
| * This leaves us with null for status and relatedDocumentId in the history version. | ||
| * | ||
| */ | ||
| // await page.getByRole('button', { name: 'Publish' }).click(); | ||
| // await page.getByRole('link', { name: 'History' }).click(); | ||
| // await page.waitForURL('**/content-manager/single-types/api::homepage.homepage/history**'); | ||
| // await expect(versionCards).toHaveCount(3); | ||
| // // Assert the current version is the most recent published version | ||
| // await expect(titleInput).toHaveValue('Welcome to AFC Richmond!'); | ||
| // // TODO: Assert the version is marked as published when publishing works | ||
| // await expect(currentVersion.getByText('Published')).toBeVisible(); | ||
| // // Assert the previous version in the list is the expected version | ||
| // await expect(versionCards.nth(1).getByText('Draft')).toBeVisible(); | ||
| // versionCards.nth(1).click(); | ||
| // await expect(titleInput).toHaveValue('Welcome to AFC Richmond'); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| module.exports = ({ env }) => ({ | ||
| future: { | ||
| history: env.bool('STRAPI_FEATURES_FUTURE_CONTENT_HISTORY', false), | ||
| contentReleasesScheduling: env.bool('STRAPI_FUTURE_CONTENT_RELEASES_SCHEDULING', false), | ||
| }, | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| If you or the company you represent has entered into a written agreement referencing the Enterprise Edition of the Strapi source code available at https://github.com/strapi/strapi, then such agreement applies to your use of the Enterprise Edition of the Strapi Software. If you or the company you represent is using the Enterprise Edition of the Strapi Software in connection with a subscription to our cloud offering, then the agreement you have agreed to with respect to our cloud offering and the licenses included in such agreement apply to your use of the Enterprise Edition of the Strapi Software. Otherwise, the Strapi Enterprise Software License Agreement (found here https://strapi.io/enterprise-terms) applies to your use of the Enterprise Edition of the Strapi Software. BY ACCESSING OR USING THE ENTERPRISE EDITION OF THE STRAPI SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE RELEVANT REFERENCED AGREEMENT. IF YOU ARE NOT AUTHORIZED TO ACCEPT THESE TERMS ON BEHALF OF THE COMPANY YOU REPRESENT OR IF YOU DO NOT AGREE TO ALL OF THE RELEVANT TERMS AND CONDITIONS REFERENCED AND YOU HAVE NOT OTHERWISE EXECUTED A WRITTEN AGREEMENT WITH STRAPI, YOU ARE NOT AUTHORIZED TO ACCESS OR USE OR ALLOW ANY USER TO ACCESS OR USE ANY PART OF THE ENTERPRISE EDITION OF THE STRAPI SOFTWARE. YOUR ACCESS RIGHTS ARE CONDITIONAL ON YOUR CONSENT TO THE RELEVANT REFERENCED TERMS TO THE EXCLUSION OF ALL OTHER TERMS; IF THE RELEVANT REFERENCED TERMS ARE CONSIDERED AN OFFER BY YOU, ACCEPTANCE IS EXPRESSLY LIMITED TO THE RELEVANT REFERENCED TERMS. |
25 changes: 25 additions & 0 deletions
25
packages/core/admin/admin/src/content-manager/history/components/InjectedLink.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import * as React from 'react'; | ||
|
|
||
| import { LinkButton } from '@strapi/design-system/v2'; | ||
| import { useQueryParams } from '@strapi/helper-plugin'; | ||
| import { stringify } from 'qs'; | ||
| import { NavLink } from 'react-router-dom'; | ||
|
|
||
| /** | ||
| * This is a temporary component to easily access the history page. | ||
| * TODO: delete it when the document actions API is ready | ||
| */ | ||
|
|
||
| const InjectedLink = () => { | ||
| const [{ query }] = useQueryParams<{ plugins?: Record<string, unknown> }>(); | ||
| const pluginsQueryParams = stringify({ plugins: query.plugins }, { encode: false }); | ||
|
|
||
| return ( | ||
| // @ts-expect-error - types are not inferred correctly through the as prop. | ||
| <LinkButton as={NavLink} variant="primary" to={`history?${pluginsQueryParams}`}> | ||
| History | ||
| </LinkButton> | ||
| ); | ||
| }; | ||
|
|
||
| export { InjectedLink }; |
Oops, something went wrong.