|
| 1 | +// Copyright 2024 The Chromium Authors. All rights reserved. |
| 2 | +// Use of this source code is governed by a BSD-style license that can be |
| 3 | +// found in the LICENSE file. |
| 4 | + |
| 5 | +import * as Host from '../../core/host/host.js'; |
| 6 | +import type * as Platform from '../../core/platform/platform.js'; |
| 7 | +import { |
| 8 | + describeWithEnvironment, |
| 9 | +} from '../../testing/EnvironmentHelpers.js'; |
| 10 | +import type * as Buttons from '../../ui/components/buttons/buttons.js'; |
| 11 | +import type * as UI from '../../ui/legacy/legacy.js'; |
| 12 | + |
| 13 | +import * as WhatsNew from './whats_new.js'; |
| 14 | + |
| 15 | +const CONTENT1 = 'Something something topic-1.\n'; |
| 16 | +const CONTENT2 = 'Something something topic-2.\n'; |
| 17 | + |
| 18 | +describeWithEnvironment('Release Note View', () => { |
| 19 | + before(() => { |
| 20 | + WhatsNew.ReleaseNoteText.setReleaseNoteForTest( |
| 21 | + { |
| 22 | + version: 99, |
| 23 | + header: 'What\'s new in DevTools 100', |
| 24 | + markdownLinks: [ |
| 25 | + { |
| 26 | + key: 'topic-1', |
| 27 | + link: 'https://google.com.com/#topic-1', |
| 28 | + }, |
| 29 | + ], |
| 30 | + link: 'https://google.com', |
| 31 | + }, |
| 32 | + ); |
| 33 | + }); |
| 34 | + |
| 35 | + it('splits up markdown file content into separate sections', async () => { |
| 36 | + const h1 = '### [Topic 1](topic-1)\n'; |
| 37 | + const h2 = '### [Topic 2](topic-2)\n'; |
| 38 | + |
| 39 | + const content = [h1, CONTENT1, h2, CONTENT2]; |
| 40 | + const notes = content.join(''); |
| 41 | + |
| 42 | + sinon.stub(WhatsNew.ReleaseNoteView.ReleaseNoteView, 'getFileContent').returns(Promise.resolve(notes)); |
| 43 | + const splitContent = await WhatsNew.ReleaseNoteView.getMarkdownContent(); |
| 44 | + assert.lengthOf(splitContent, 2); |
| 45 | + |
| 46 | + for (let i = 0; i < 2; ++i) { |
| 47 | + assert.lengthOf(splitContent[i], 2); |
| 48 | + assert.deepStrictEqual(splitContent[i][0].type, 'heading'); |
| 49 | + assert.deepStrictEqual(splitContent[i][1].type, 'paragraph'); |
| 50 | + assert.deepStrictEqual(splitContent[i][0].raw, content[i * 2]); |
| 51 | + assert.deepStrictEqual(splitContent[i][1].raw, content[i * 2 + 1]); |
| 52 | + } |
| 53 | + }); |
| 54 | + |
| 55 | + it('groups nested markdown headers into one', async () => { |
| 56 | + const h1 = '### [Topic 1](topic-1)\n'; |
| 57 | + const h2 = '#### [Topic 2](topic-2)\n'; |
| 58 | + |
| 59 | + const content = [h1, CONTENT1, h2, CONTENT2]; |
| 60 | + const notes = content.join(''); |
| 61 | + |
| 62 | + sinon.stub(WhatsNew.ReleaseNoteView.ReleaseNoteView, 'getFileContent').returns(Promise.resolve(notes)); |
| 63 | + const splitContent = await WhatsNew.ReleaseNoteView.getMarkdownContent(); |
| 64 | + assert.lengthOf(splitContent, 1); |
| 65 | + assert.lengthOf(splitContent[0], 4); |
| 66 | + |
| 67 | + assert.deepStrictEqual(splitContent[0][0].raw, h1); |
| 68 | + assert.deepStrictEqual(splitContent[0][1].raw, CONTENT1); |
| 69 | + assert.deepStrictEqual(splitContent[0][2].raw, h2); |
| 70 | + assert.deepStrictEqual(splitContent[0][3].raw, CONTENT2); |
| 71 | + }); |
| 72 | + |
| 73 | + it('splits headerless paragraphs into its own section', async () => { |
| 74 | + const h1 = '### [Topic 1](topic-1)\n'; |
| 75 | + const content = [CONTENT1, h1]; |
| 76 | + const notes = content.join(''); |
| 77 | + |
| 78 | + sinon.stub(WhatsNew.ReleaseNoteView.ReleaseNoteView, 'getFileContent').returns(Promise.resolve(notes)); |
| 79 | + const splitContent = await WhatsNew.ReleaseNoteView.getMarkdownContent(); |
| 80 | + assert.lengthOf(splitContent, 2); |
| 81 | + assert.lengthOf(splitContent[0], 1); |
| 82 | + assert.lengthOf(splitContent[1], 1); |
| 83 | + |
| 84 | + assert.deepStrictEqual(splitContent[0][0].raw, CONTENT1); |
| 85 | + assert.deepStrictEqual(splitContent[1][0].raw, h1); |
| 86 | + }); |
| 87 | + |
| 88 | + it('renders markdown content', async () => { |
| 89 | + sinon.stub(WhatsNew.ReleaseNoteView.ReleaseNoteView, 'getFileContent').returns(Promise.resolve(CONTENT1)); |
| 90 | + const releaseNoteView = new WhatsNew.ReleaseNoteView.ReleaseNoteView(); |
| 91 | + await releaseNoteView.pendingUpdate(); |
| 92 | + |
| 93 | + const markdown = releaseNoteView.contentElement.querySelector('devtools-markdown-view'); |
| 94 | + assert.isNotNull(markdown); |
| 95 | + }); |
| 96 | + |
| 97 | + it('renders link to video', async () => { |
| 98 | + sinon.stub(WhatsNew.ReleaseNoteView.ReleaseNoteView, 'getFileContent').returns(Promise.resolve(CONTENT1)); |
| 99 | + const releaseNoteView = new WhatsNew.ReleaseNoteView.ReleaseNoteView(); |
| 100 | + await releaseNoteView.pendingUpdate(); |
| 101 | + const link = releaseNoteView.contentElement.querySelector<UI.XLink.XLink>('x-link'); |
| 102 | + assert.isNotNull(link); |
| 103 | + assert.deepStrictEqual(link.href, 'https://google.com/'); |
| 104 | + }); |
| 105 | + |
| 106 | + it('renders button that links to blogpost', async () => { |
| 107 | + sinon.stub(WhatsNew.ReleaseNoteView.ReleaseNoteView, 'getFileContent').returns(Promise.resolve(CONTENT1)); |
| 108 | + const releaseNoteView = new WhatsNew.ReleaseNoteView.ReleaseNoteView(); |
| 109 | + await releaseNoteView.pendingUpdate(); |
| 110 | + const button = releaseNoteView.contentElement.querySelector<Buttons.Button.Button>('devtools-button'); |
| 111 | + assert.isNotNull(button); |
| 112 | + const openInNewTabStub = sinon.stub(Host.InspectorFrontendHost.InspectorFrontendHostInstance, 'openInNewTab'); |
| 113 | + |
| 114 | + button.click(); |
| 115 | + assert.strictEqual(openInNewTabStub.callCount, 1); |
| 116 | + assert.isTrue( |
| 117 | + openInNewTabStub.firstCall.calledWith('https://google.com' as Platform.DevToolsPath.UrlString), |
| 118 | + 'openInNewTab was not called with the expected URL.'); |
| 119 | + }); |
| 120 | +}); |
0 commit comments