diff --git a/packages/playwright-core/ThirdPartyNotices.txt b/packages/playwright-core/ThirdPartyNotices.txt index 457f3e632b..89a6418ab8 100644 --- a/packages/playwright-core/ThirdPartyNotices.txt +++ b/packages/playwright-core/ThirdPartyNotices.txt @@ -16,7 +16,7 @@ This project incorporates components from the projects listed below. The origina - concat-map@0.0.1 (https://github.com/substack/node-concat-map) - debug@4.3.4 (https://github.com/debug-js/debug) - define-lazy-prop@2.0.0 (https://github.com/sindresorhus/define-lazy-prop) -- diff-match-patch@1.0.5 (https://github.com/JackuB/diff-match-patch) +- diff@7.0.0 (https://github.com/kpdecker/jsdiff) - dotenv@16.4.5 (https://github.com/motdotla/dotenv) - end-of-stream@1.4.4 (https://github.com/mafintosh/end-of-stream) - escape-string-regexp@2.0.0 (https://github.com/sindresorhus/escape-string-regexp) @@ -352,211 +352,39 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ========================================= END OF define-lazy-prop@2.0.0 AND INFORMATION -%% diff-match-patch@1.0.5 NOTICES AND INFORMATION BEGIN HERE +%% diff@7.0.0 NOTICES AND INFORMATION BEGIN HERE ========================================= -Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ +BSD 3-Clause License - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION +Copyright (c) 2009-2015, Kevin Decker +All rights reserved. - 1. Definitions. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ========================================= -END OF diff-match-patch@1.0.5 AND INFORMATION +END OF diff@7.0.0 AND INFORMATION %% dotenv@16.4.5 NOTICES AND INFORMATION BEGIN HERE ========================================= diff --git a/packages/playwright-core/bundles/utils/package-lock.json b/packages/playwright-core/bundles/utils/package-lock.json index 06ef45a297..6d9b0562e3 100644 --- a/packages/playwright-core/bundles/utils/package-lock.json +++ b/packages/playwright-core/bundles/utils/package-lock.json @@ -11,7 +11,7 @@ "colors": "1.4.0", "commander": "8.3.0", "debug": "^4.3.4", - "diff-match-patch": "^1.0.5", + "diff": "^7.0.0", "dotenv": "^16.4.5", "graceful-fs": "4.2.10", "https-proxy-agent": "7.0.5", @@ -31,7 +31,7 @@ }, "devDependencies": { "@types/debug": "^4.1.7", - "@types/diff-match-patch": "^1.0.36", + "@types/diff": "^6.0.0", "@types/mime": "^2.0.3", "@types/minimatch": "^3.0.5", "@types/pngjs": "^6.0.1", @@ -51,11 +51,12 @@ "@types/ms": "*" } }, - "node_modules/@types/diff-match-patch": { - "version": "1.0.36", - "resolved": "https://registry.npmjs.org/@types/diff-match-patch/-/diff-match-patch-1.0.36.tgz", - "integrity": "sha512-xFdR6tkm0MWvBfO8xXCSsinYxHcqkQUlcHeSpMC2ukzOb6lwQAfDmW+Qt0AvlGd8HpsS28qKsB+oPeJn9I39jg==", - "dev": true + "node_modules/@types/diff": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@types/diff/-/diff-6.0.0.tgz", + "integrity": "sha512-dhVCYGv3ZSbzmQaBSagrv1WJ6rXCdkyTcDyoNu1MD8JohI7pR7k8wdZEm+mvdxRKXyHVwckFzWU1vJc+Z29MlA==", + "dev": true, + "license": "MIT" }, "node_modules/@types/mime": { "version": "2.0.3", @@ -209,10 +210,14 @@ "node": ">=8" } }, - "node_modules/diff-match-patch": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/diff-match-patch/-/diff-match-patch-1.0.5.tgz", - "integrity": "sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==" + "node_modules/diff": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-7.0.0.tgz", + "integrity": "sha512-PJWHUb1RFevKCwaFA9RlG5tCd+FO5iRh9A8HEtkmBH2Li03iJriB6m6JIN4rGz3K3JLawI7/veA1xzRKP6ISBw==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } }, "node_modules/dotenv": { "version": "16.4.5", @@ -469,10 +474,10 @@ "@types/ms": "*" } }, - "@types/diff-match-patch": { - "version": "1.0.36", - "resolved": "https://registry.npmjs.org/@types/diff-match-patch/-/diff-match-patch-1.0.36.tgz", - "integrity": "sha512-xFdR6tkm0MWvBfO8xXCSsinYxHcqkQUlcHeSpMC2ukzOb6lwQAfDmW+Qt0AvlGd8HpsS28qKsB+oPeJn9I39jg==", + "@types/diff": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@types/diff/-/diff-6.0.0.tgz", + "integrity": "sha512-dhVCYGv3ZSbzmQaBSagrv1WJ6rXCdkyTcDyoNu1MD8JohI7pR7k8wdZEm+mvdxRKXyHVwckFzWU1vJc+Z29MlA==", "dev": true }, "@types/mime": { @@ -606,10 +611,10 @@ "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz", "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==" }, - "diff-match-patch": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/diff-match-patch/-/diff-match-patch-1.0.5.tgz", - "integrity": "sha512-IayShXAgj/QMXgB0IWmKx+rOPuGMhqm5w6jvFxmVenXKIzRqTAAsbBPT3kWQeGANj3jGgvcvv4yK6SxqYmikgw==" + "diff": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-7.0.0.tgz", + "integrity": "sha512-PJWHUb1RFevKCwaFA9RlG5tCd+FO5iRh9A8HEtkmBH2Li03iJriB6m6JIN4rGz3K3JLawI7/veA1xzRKP6ISBw==" }, "dotenv": { "version": "16.4.5", diff --git a/packages/playwright-core/bundles/utils/package.json b/packages/playwright-core/bundles/utils/package.json index 2e3a92919c..1900d423f5 100644 --- a/packages/playwright-core/bundles/utils/package.json +++ b/packages/playwright-core/bundles/utils/package.json @@ -12,7 +12,7 @@ "colors": "1.4.0", "commander": "8.3.0", "debug": "^4.3.4", - "diff-match-patch": "^1.0.5", + "diff": "^7.0.0", "dotenv": "^16.4.5", "graceful-fs": "4.2.10", "https-proxy-agent": "7.0.5", @@ -32,7 +32,7 @@ }, "devDependencies": { "@types/debug": "^4.1.7", - "@types/diff-match-patch": "^1.0.36", + "@types/diff": "^6.0.0", "@types/mime": "^2.0.3", "@types/minimatch": "^3.0.5", "@types/pngjs": "^6.0.1", diff --git a/packages/playwright-core/bundles/utils/src/utilsBundleImpl.ts b/packages/playwright-core/bundles/utils/src/utilsBundleImpl.ts index ba8bc8d90b..5c8434f907 100644 --- a/packages/playwright-core/bundles/utils/src/utilsBundleImpl.ts +++ b/packages/playwright-core/bundles/utils/src/utilsBundleImpl.ts @@ -20,8 +20,8 @@ export const colors = colorsLibrary; import debugLibrary from 'debug'; export const debug = debugLibrary; -import diffMatchPatchLibrary from 'diff-match-patch'; -export const diffMatchPatch = diffMatchPatchLibrary; +import * as diffLibrary from 'diff'; +export const diff = diffLibrary; import dotenvLibrary from 'dotenv'; export const dotenv = dotenvLibrary; diff --git a/packages/playwright-core/src/utils/comparators.ts b/packages/playwright-core/src/utils/comparators.ts index da707e20c4..acf897af49 100644 --- a/packages/playwright-core/src/utils/comparators.ts +++ b/packages/playwright-core/src/utils/comparators.ts @@ -16,9 +16,10 @@ */ import { colors, jpegjs } from '../utilsBundle'; -const pixelmatch = require('../third_party/pixelmatch'); +// @ts-ignore +import pixelmatch from '../third_party/pixelmatch'; import { compare } from '../image_tools/compare'; -const { diffMatchPatch } = require('../utilsBundle'); +import { diff } from '../utilsBundle'; import { PNG } from '../utilsBundle'; export type ImageComparatorOptions = { threshold?: number, maxDiffPixels?: number, maxDiffPixelRatio?: number, comparator?: string }; @@ -106,40 +107,28 @@ function validateBuffer(buffer: Buffer, mimeType: string): void { } function compareText(actual: Buffer | string, expectedBuffer: Buffer): ComparatorResult { - const { diff_match_patch } = diffMatchPatch; if (typeof actual !== 'string') return { errorMessage: 'Actual result should be a string' }; const expected = expectedBuffer.toString('utf-8'); if (expected === actual) return null; - const dmp = new diff_match_patch(); - const d = dmp.diff_main(expected, actual); - dmp.diff_cleanupSemantic(d); + const diffs = diff.diffChars(expected, actual); return { - errorMessage: diff_prettyTerminal(d) + errorMessage: diff_prettyTerminal(diffs), }; } -function diff_prettyTerminal(diffs: [number, string][]) { - const { DIFF_INSERT, DIFF_DELETE, DIFF_EQUAL } = diffMatchPatch; - const html = []; - for (let x = 0; x < diffs.length; x++) { - const op = diffs[x][0]; // Operation (insert, delete, equal) - const data = diffs[x][1]; // Text of change. - const text = data; - switch (op) { - case DIFF_INSERT: - html[x] = colors.green(text); - break; - case DIFF_DELETE: - html[x] = colors.reset(colors.strikethrough(colors.red(text))); - break; - case DIFF_EQUAL: - html[x] = text; - break; - } - } - return html.join(''); +function diff_prettyTerminal(diffs: Diff.Change[]): string { + const result = diffs.map(part => { + const text = part.value; + if (part.added) + return colors.green(text); + else if (part.removed) + return colors.reset(colors.strikethrough(colors.red(text))); + else + return text; + }); + return result.join(''); } function resizeImage(image: ImageData, size: { width: number, height: number }): ImageData { diff --git a/packages/playwright-core/src/utils/index.ts b/packages/playwright-core/src/utils/index.ts index c570e7b32e..0bc7a75b08 100644 --- a/packages/playwright-core/src/utils/index.ts +++ b/packages/playwright-core/src/utils/index.ts @@ -33,7 +33,6 @@ export * from './isomorphic/stringUtils'; export * from './isomorphic/urlMatch'; export * from './multimap'; export * from './network'; -export * from './patch'; export * from './processLauncher'; export * from './profiler'; export * from './rtti'; diff --git a/packages/playwright-core/src/utils/patch.ts b/packages/playwright-core/src/utils/patch.ts deleted file mode 100644 index 91fa31b8f3..0000000000 --- a/packages/playwright-core/src/utils/patch.ts +++ /dev/null @@ -1,127 +0,0 @@ -/** - * Copyright (c) Microsoft Corporation. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import { diffMatchPatch } from '../utilsBundle'; - -type Hunk = { - lines: string[]; - startNew: number; - startOld: number; - contextBefore: number; - contextAfter: number; -}; - -export function generateUnifiedDiff(text1: string, text2: string, relativeName: string = 'file'): string { - const { diff_match_patch, DIFF_EQUAL, DIFF_DELETE, DIFF_INSERT } = diffMatchPatch; - const dmp = new diff_match_patch(); - - const a = text1.replace(/\r\n/g, '\n'); - const b = text2.replace(/\r\n/g, '\n'); - - const { chars1, chars2, lineArray } = dmp.diff_linesToChars_(a, b); - const diffs = dmp.diff_main(chars1, chars2, false); - dmp.diff_charsToLines_(diffs, lineArray); - - const contextSize = 3; - const hunks: Hunk[] = []; - let lineOld = 1; - let lineNew = 1; - let hunk: Hunk | null = null; - let contextBuffer: string[] = []; - - for (const diff of diffs) { - const op = diff[0]; - const data = diff[1]; - const lines = data.split('\n'); - - // Remove the last empty line if data ends with '\n' - if (lines[lines.length - 1] === '') - lines.pop(); - - for (const line of lines) { - if (op === DIFF_EQUAL) { - if (hunk) { - hunk.lines.push(' ' + line); - hunk.contextAfter++; - - if (hunk.contextAfter >= contextSize) { - // Close the hunk - hunks.push(hunk); - hunk = null; - contextBuffer = []; - } - } else { - contextBuffer.push(' ' + line); - if (contextBuffer.length > contextSize) - contextBuffer.shift(); - } - lineOld++; - lineNew++; - } else { - if (!hunk) { - // Start a new hunk - const hunkStartOld = lineOld - contextBuffer.length; - const hunkStartNew = lineNew - contextBuffer.length; - hunk = { - startOld: hunkStartOld, - startNew: hunkStartNew, - lines: [...contextBuffer], - contextBefore: contextBuffer.length, - contextAfter: 0, - }; - } - hunk.contextAfter = 0; - - if (op === DIFF_DELETE) { - hunk.lines.push('-' + line); - lineOld++; - } else if (op === DIFF_INSERT) { - hunk.lines.push('+' + line); - lineNew++; - } - } - } - } - - if (hunk) - hunks.push(hunk); - - // Build the unified diff text - let diffText = `--- a/${relativeName}\n+++ b/${relativeName}\n`; - for (const hunk of hunks) { - // Calculate hunk ranges - const oldRangeStart = hunk.startOld; - const newRangeStart = hunk.startNew; - let oldRangeLines = 0; - let newRangeLines = 0; - - for (const line of hunk.lines) { - if (line.startsWith('-') || line.startsWith(' ')) - oldRangeLines++; - if (line.startsWith('+') || line.startsWith(' ')) - newRangeLines++; - } - - // Adjust starting line numbers when range is empty - const oldStartLine = oldRangeLines === 0 ? oldRangeStart - 1 : oldRangeStart; - const newStartLine = newRangeLines === 0 ? newRangeStart - 1 : newRangeStart; - - diffText += `@@ -${oldStartLine},${oldRangeLines} +${newStartLine},${newRangeLines} @@\n`; - diffText += hunk.lines.map(line => line + '\n').join(''); - } - - return diffText; -} diff --git a/packages/playwright-core/src/utilsBundle.ts b/packages/playwright-core/src/utilsBundle.ts index f57a6346f7..72bcee397e 100644 --- a/packages/playwright-core/src/utilsBundle.ts +++ b/packages/playwright-core/src/utilsBundle.ts @@ -19,7 +19,7 @@ import path from 'path'; export const colors: typeof import('../bundles/utils/node_modules/colors/safe') = require('./utilsBundleImpl').colors; export const debug: typeof import('../bundles/utils/node_modules/@types/debug') = require('./utilsBundleImpl').debug; -export const diffMatchPatch: typeof import('../bundles/utils/node_modules/@types/diff-match-patch') = require('./utilsBundleImpl').diffMatchPatch; +export const diff: typeof import('../bundles/utils/node_modules/@types/diff') = require('./utilsBundleImpl').diff; export const dotenv: typeof import('../bundles/utils/node_modules/dotenv') = require('./utilsBundleImpl').dotenv; export const getProxyForUrl: typeof import('../bundles/utils/node_modules/@types/proxy-from-env').getProxyForUrl = require('./utilsBundleImpl').getProxyForUrl; export const HttpsProxyAgent: typeof import('../bundles/utils/node_modules/https-proxy-agent').HttpsProxyAgent = require('./utilsBundleImpl').HttpsProxyAgent; diff --git a/packages/playwright/src/runner/rebase.ts b/packages/playwright/src/runner/rebase.ts index 7863f4d124..24f37ca7f7 100644 --- a/packages/playwright/src/runner/rebase.ts +++ b/packages/playwright/src/runner/rebase.ts @@ -19,8 +19,7 @@ import fs from 'fs'; import type { T } from '../transform/babelBundle'; import { types, traverse, babelParse } from '../transform/babelBundle'; import { MultiMap } from 'playwright-core/lib/utils'; -import { generateUnifiedDiff } from 'playwright-core/lib/utils'; -import { colors } from 'playwright-core/lib/utilsBundle'; +import { colors, diff } from 'playwright-core/lib/utilsBundle'; import type { FullConfigInternal } from '../common/config'; import { filterProjects } from './projectUtils'; import type { InternalReporter } from '../reporters/internalReporter'; @@ -95,7 +94,7 @@ export async function applySuggestedRebaselines(config: FullConfigInternal, repo const relativeName = path.relative(process.cwd(), fileName); files.push(relativeName); - patches.push(generateUnifiedDiff(source, result, relativeName.replace(/\\/g, '/'))); + patches.push(createPatch(relativeName, source, result)); } const patchFile = path.join(project.project.outputDir, 'rebaselines.patch'); @@ -105,3 +104,14 @@ export async function applySuggestedRebaselines(config: FullConfigInternal, repo const fileList = files.map(file => ' ' + colors.dim(file)).join('\n'); reporter.onStdErr(`\nNew baselines created for:\n\n${fileList}\n\n ` + colors.cyan('git apply ' + path.relative(process.cwd(), patchFile)) + '\n'); } + +function createPatch(fileName: string, before: string, after: string) { + const file = fileName.replace(/\\/g, '/'); + const text = diff.createPatch(file, before, after, undefined, undefined, { context: 3 }); + return [ + 'diff --git a/' + file + ' b/' + file, + '--- a/' + file, + '+++ b/' + file, + ...text.split('\n').slice(4) + ].join('\n'); +} diff --git a/tests/library/unit/patch.spec.ts b/tests/library/unit/patch.spec.ts deleted file mode 100644 index 1188faff6b..0000000000 --- a/tests/library/unit/patch.spec.ts +++ /dev/null @@ -1,260 +0,0 @@ -/** - * Copyright (c) Microsoft Corporation. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - -import { test as it, expect } from '@playwright/test'; -import { generateUnifiedDiff } from '../../../packages/playwright-core/lib/utils/patch'; - -it('Identical texts should produce an empty diff', () => { - const text1 = `line1 -line2 -line3`; - const text2 = `line1 -line2 -line3`; - - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toBe(`--- a/file -+++ b/file -`); -}); - -it('Text with an inserted line', () => { - const text1 = `line1 -line2 -line3`; - const text2 = `line1 -line2 -line2.5 -line3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,4 @@ - line1 - line2 -+line2.5 - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Text with a deleted line', () => { - const text1 = `line1 -line2 -line3`; - const text2 = `line1 -line3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,2 @@ - line1 --line2 - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Text with modified line', () => { - const text1 = `line1 -line2 -line3`; - const text2 = `line1 -line2 modified -line3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,3 @@ - line1 --line2 -+line2 modified - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Empty original text', () => { - const text1 = ``; - const text2 = `line1 -line2`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -0,0 +1,2 @@ -+line1 -+line2 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Empty modified text', () => { - const text1 = `line1 -line2`; - const text2 = ``; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,2 +0,0 @@ --line1 --line2 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Handling different line endings (CRLF vs LF)', () => { - const text1 = `line1\r\nline2\r\nline3`; - const text2 = `line1\nline2 modified\nline3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,3 @@ - line1 --line2 -+line2 modified - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Large text diff', () => { - const text1 = Array(1000) - .fill('line') - .join('\n'); - const text2 = Array(1000) - .fill('line') - .map((line, index) => (index === 500 ? 'modified line' : line)) - .join('\n'); - - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain('-line\n+modified line'); -}); - -it('Unicode characters', () => { - const text1 = `こんにちは -世界`; - const text2 = `こんにちは -世界！ -さようなら`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,2 +1,3 @@ - こんにちは --世界 -+世界！ -+さようなら -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Texts with only whitespace differences', () => { - const text1 = `line1 -line2 -line3`; - const text2 = `line1 -line2 -line3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,3 @@ - line1 --line2 -+line2 - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toBe(expectedDiff); -}); - -it('Custom file names in diff header', () => { - const text1 = `line1 -line2 -line3`; - const text2 = `line1 -line2 modified -line3`; - - const diff = generateUnifiedDiff(text1, text2, 'original.txt'); - expect(diff.startsWith('--- a/original.txt\n+++ b/original.txt\n')).toBe(true); -}); - -it('Multiple consecutive insertions and deletions', () => { - const text1 = `line1 -line2 -line3 -line4 -line5`; - const text2 = `line1 -line2 modified -line3 -line4 modified -line5`; - - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain('-line2\n+line2 modified'); - expect(diff).toContain('-line4\n+line4 modified'); -}); - -it('Handling tabs and special characters', () => { - const text1 = `line1 -line\t2 -line3`; - const text2 = `line1 -line2 -line3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,3 @@ - line1 --line\t2 -+line2 - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); - -it('Texts with leading and trailing whitespace differences', () => { - const text1 = ` line1 -line2 -line3`; - const text2 = `line1 -line2 -line3`; - - const expectedDiff = `--- a/file -+++ b/file -@@ -1,3 +1,3 @@ -- line1 --line2 -+line1 -+line2 - line3 -`; - const diff = generateUnifiedDiff(text1, text2); - expect(diff).toContain(expectedDiff); -}); diff --git a/tests/playwright-test/update-aria-snapshot.spec.ts b/tests/playwright-test/update-aria-snapshot.spec.ts index 2a831521a7..57424b7bc6 100644 --- a/tests/playwright-test/update-aria-snapshot.spec.ts +++ b/tests/playwright-test/update-aria-snapshot.spec.ts @@ -40,7 +40,8 @@ test('should update snapshot with the update-snapshots flag', async ({ runInline expect(result.exitCode).toBe(0); const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/a.spec.ts + expect(trimPatch(data)).toBe(`diff --git a/a.spec.ts b/a.spec.ts +--- a/a.spec.ts +++ b/a.spec.ts @@ -3,7 +3,7 @@ test('test', async ({ page }) => { @@ -51,6 +52,7 @@ test('should update snapshot with the update-snapshots flag', async ({ runInline \`); }); +\\ No newline at end of file `); expect(stripAnsi(result.output).replace(/\\/g, '/')).toContain(`New baselines created for: @@ -87,7 +89,8 @@ test('should update missing snapshots', async ({ runInlineTest }, testInfo) => { const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/a.spec.ts + expect(trimPatch(data)).toBe(`diff --git a/a.spec.ts b/a.spec.ts +--- a/a.spec.ts +++ b/a.spec.ts @@ -2,6 +2,8 @@ import { test, expect } from '@playwright/test'; @@ -99,6 +102,7 @@ test('should update missing snapshots', async ({ runInlineTest }, testInfo) => { + \`); }); +\\ No newline at end of file `); execSync(`patch -p1 < ${patchPath}`, { cwd: testInfo.outputPath() }); @@ -131,7 +135,8 @@ test('should generate baseline with regex', async ({ runInlineTest }, testInfo) expect(result.exitCode).toBe(0); const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/a.spec.ts + expect(trimPatch(data)).toBe(`diff --git a/a.spec.ts b/a.spec.ts +--- a/a.spec.ts +++ b/a.spec.ts @@ -13,6 +13,18 @@
  • /Regex 1/
    • @@ -153,6 +158,7 @@ test('should generate baseline with regex', async ({ runInlineTest }, testInfo) + \`); }); +\\ No newline at end of file `); execSync(`patch -p1 < ${patchPath}`, { cwd: testInfo.outputPath() }); @@ -189,7 +195,8 @@ test('should generate baseline with special characters', async ({ runInlineTest expect(result.exitCode).toBe(0); const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/a.spec.ts + expect(trimPatch(data)).toBe(`diff --git a/a.spec.ts b/a.spec.ts +--- a/a.spec.ts +++ b/a.spec.ts @@ -17,6 +17,27 @@
  • Item: 1
    • @@ -220,6 +227,7 @@ test('should generate baseline with special characters', async ({ runInlineTest + \`); }); +\\ No newline at end of file `); execSync(`patch -p1 < ${patchPath}`, { cwd: testInfo.outputPath() }); @@ -251,7 +259,8 @@ test('should update missing snapshots in tsx', async ({ runInlineTest }, testInf expect(result.exitCode).toBe(0); const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/src/button.test.tsx + expect(trimPatch(data)).toBe(`diff --git a/src/button.test.tsx b/src/button.test.tsx +--- a/src/button.test.tsx +++ b/src/button.test.tsx @@ -4,6 +4,8 @@ @@ -263,6 +272,7 @@ test('should update missing snapshots in tsx', async ({ runInlineTest }, testInf + \`); }); +\\ No newline at end of file `); execSync(`patch -p1 < ${patchPath}`, { cwd: testInfo.outputPath() }); @@ -313,7 +323,8 @@ test('should update multiple files', async ({ runInlineTest }, testInfo) => { const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/src/button-1.test.tsx + expect(trimPatch(data)).toBe(`diff --git a/src/button-1.test.tsx b/src/button-1.test.tsx +--- a/src/button-1.test.tsx +++ b/src/button-1.test.tsx @@ -4,6 +4,8 @@ @@ -325,7 +336,9 @@ test('should update multiple files', async ({ runInlineTest }, testInfo) => { + \`); }); +\\ No newline at end of file +diff --git a/src/button-2.test.tsx b/src/button-2.test.tsx --- a/src/button-2.test.tsx +++ b/src/button-2.test.tsx @@ -4,6 +4,8 @@ @@ -338,6 +351,7 @@ test('should update multiple files', async ({ runInlineTest }, testInfo) => { + \`); }); +\\ No newline at end of file `); execSync(`patch -p1 < ${patchPath}`, { cwd: testInfo.outputPath() }); @@ -359,7 +373,8 @@ test('should generate baseline for input values', async ({ runInlineTest }, test expect(result.exitCode).toBe(0); const patchPath = testInfo.outputPath('test-results/rebaselines.patch'); const data = fs.readFileSync(patchPath, 'utf-8'); - expect(trimPatch(data)).toBe(`--- a/a.spec.ts + expect(trimPatch(data)).toBe(`diff --git a/a.spec.ts b/a.spec.ts +--- a/a.spec.ts +++ b/a.spec.ts @@ -2,6 +2,8 @@ import { test, expect } from '@playwright/test'; @@ -371,6 +386,7 @@ test('should generate baseline for input values', async ({ runInlineTest }, test + \`); }); +\\ No newline at end of file `); execSync(`patch -p1 < ${patchPath}`, { cwd: testInfo.outputPath() });