Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #6959 UI issue after clear cache and apply LRC with certain template #30

Merged
merged 5 commits into from
Oct 9, 2024
Merged

Closes #6959 UI issue after clear cache and apply LRC with certain template #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b2fc2f2
Release v1.0.6 (PR #29)
wordpressfan Sep 16, 2024
464467f
Add new method to avoid conflicts with lrc -- :closes: wp-media/wp-ro…
Khadreal Oct 7, 2024
79e760c
Add tests for lrc conflicts method
Khadreal Oct 7, 2024
ae2ec05
Fixed codacy error
Khadreal Oct 7, 2024
e301435
:sparkles: fixed codacy issues
Khadreal Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions src/BeaconLrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,57 @@ class BeaconLrc {
return false;
}

_checkLcrConflict(element) {
const conflictingElements = [];
const computedStyle = window.getComputedStyle(element);

const validMargins = ['marginTop', 'marginRight', 'marginBottom', 'marginLeft'];

const negativeMargins = validMargins
.some(margin => parseFloat(computedStyle[margin]) < 0);

const currentElementConflicts = negativeMargins ||
computedStyle.contentVisibility === 'auto' ||
computedStyle.contentVisibility === 'hidden';

if (currentElementConflicts) {
conflictingElements.push({
element,
conflicts: [
negativeMargins && 'negative margin',
computedStyle.contentVisibility === 'auto' && 'content-visibility:auto',
computedStyle.contentVisibility === 'hidden' && 'content-visibility:hidden'
].filter(Boolean)
});
}

Array.from(element.children).forEach(child => {
const childStyle = window.getComputedStyle(child);

const validMargins = ['marginTop', 'marginRight', 'marginBottom', 'marginLeft'];

const childNegativeMargins = validMargins
.some(margin => parseFloat(childStyle[margin]) < 0);

const childConflicts = childNegativeMargins ||
childStyle.position === 'absolute' ||
childStyle.position === 'fixed';

if (childConflicts) {
conflictingElements.push({
element: child,
conflicts: [
childNegativeMargins && 'negative margin',
childStyle.position === 'absolute' && 'position:absolute',
childStyle.position === 'fixed' && 'position:fixed'
].filter(Boolean)
});
}
});

return conflictingElements;
}

_processElements(elements) {
elements.forEach(({ element, depth, distance, hash }) => {
if (this._shouldSkipElement(element, this.config.exclusions || [])) {
Expand All @@ -82,6 +133,12 @@ class BeaconLrc {
return;
}

const conflicts = this._checkLcrConflict(element);
if (conflicts.length > 0) {
this.logger.logMessage('Skipping element due to conflicts:', conflicts);
return;
}

const can_push_hash = element.parentElement && this._getElementDistance(element.parentElement) < this.config.lrc_threshold && distance >= this.config.lrc_threshold;

const color = can_push_hash ? "green" : distance === 0 ? "red" : "";
Expand Down
104 changes: 100 additions & 4 deletions test/BeaconLrc.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ describe('BeaconLrc', function() {
},
getAttribute: () => 'hash1',
hasAttribute: () => true,
dataset: { rocketLocationHash: 'hash1' }
dataset: { rocketLocationHash: 'hash1' },
children: []
},
{
getBoundingClientRect: () => {
Expand All @@ -26,7 +27,8 @@ describe('BeaconLrc', function() {
},
getAttribute: () => 'hash2',
hasAttribute: () => true,
dataset: { rocketLocationHash: 'hash2' }
dataset: { rocketLocationHash: 'hash2' },
children: []
},
{
getBoundingClientRect: () => {
Expand All @@ -36,7 +38,8 @@ describe('BeaconLrc', function() {
},
getAttribute: () => 'hash3',
hasAttribute: () => true,
dataset: { rocketLocationHash: 'hash3' }
dataset: { rocketLocationHash: 'hash3' },
children: []
},
{
getBoundingClientRect: () => {
Expand All @@ -46,7 +49,8 @@ describe('BeaconLrc', function() {
},
getAttribute: () => 'hash4',
hasAttribute: () => true,
dataset: { rocketLocationHash: 'hash4' }
dataset: { rocketLocationHash: 'hash4' },
children: []
},
];

Expand Down Expand Up @@ -74,6 +78,18 @@ describe('BeaconLrc', function() {

// Mocking window.pageYOffset
global.window = { pageYOffset: 100, innerHeight: 500 };

if (typeof global.window.getComputedStyle !== 'function') {
global.window.getComputedStyle = () => ({
marginTop: '0px',
marginRight: '0px',
marginBottom: '0px',
marginLeft: '0px',
contentVisibility: 'visible',
position: 'static',
overflow: 'visible'
});
}
});

afterEach(function() {
Expand Down Expand Up @@ -232,4 +248,84 @@ describe('BeaconLrc', function() {

_getElementXPathStub.restore();
});

it('should detect conflict when element has negative margins', () => {
const element = mockElements[0];

sinon.stub(window, 'getComputedStyle').callsFake(() => ({
marginTop: '-10px',
marginRight: '0px',
marginBottom: '0px',
marginLeft: '0px',
contentVisibility: 'visible',
position: 'static',
overflow: 'visible'
}));

const result = beaconLrc._checkLcrConflict(element);

assert.strictEqual(result.length, 1);
assert.strictEqual(result[0].conflicts.includes('negative margin'), true);
window.getComputedStyle.restore();
});

it('should detect conflict when content visibility is hidden', () => {
const element = mockElements[0];

sinon.stub(window, 'getComputedStyle').callsFake(() => ({
marginTop: '0px',
marginRight: '0px',
marginBottom: '0px',
marginLeft: '0px',
contentVisibility: 'hidden',
position: 'static',
overflow: 'visible'
}));

const result = beaconLrc._checkLcrConflict(element);

assert.strictEqual(result.length, 1);
assert.strictEqual(result[0].conflicts.includes('content-visibility:hidden'), true);
window.getComputedStyle.restore();
});

it('should detect conflict when child has negative margins', () => {
const element = mockElements[0];

const child = {
getBoundingClientRect: () => ({ top: 500 }),
getAttribute: () => null,
hasAttribute: () => false,
children: []
};
element.children = [child];

sinon.stub(window, 'getComputedStyle')
.onCall(0).returns({
marginTop: '0px',
marginRight: '0px',
marginBottom: '0px',
marginLeft: '0px',
contentVisibility: 'visible',
position: 'static',
overflow: 'visible'
})
.onCall(1).returns({
marginTop: '-20px',
marginRight: '0px',
marginBottom: '0px',
marginLeft: '0px',
contentVisibility: 'visible',
position: 'absolute',
overflow: 'visible'
});

const result = beaconLrc._checkLcrConflict(element);

assert.strictEqual(result.length, 1);
assert.strictEqual(result[0].element, child);
assert.strictEqual(result[0].conflicts.includes('negative margin'), true);

window.getComputedStyle.restore();
})
});
Loading