💥 Rename Ember specific scope option #631
Conversation
This SDK compensates for Ember's testing UI by utilizing a `scope` option to dump the contents of that scoped element into the document body. We semi-recently implemented a new type of `scope` option directly in our API that allows scoping snapshots to specific elements in the DOM. With this feature, the two scope options conflict, and this SDK cannot use the new element scoping feature while the Ember testing UI scope feature exists. Rather than rename the element scoping option for this SDK only, to keep all SDKs consistent we've decided to rename the existing Ember SDK scope option to `emberTestingScope`. Unfortunately, that makes this a breaking change for anybody relying on the old `scope` option behavior. When upgrading, if not renamed, the new `scope` option will take effect and any cropping for that scoped element will be done by our infrastructure and might have unexpected results.
delete-merged-branch
bot
deleted the
ww/rename-ember-specific-scope-option
branch
|
@wwilsman Does it mean that we should change all occurrences of When not migrating to
In some other cases, it does work. There are some changes but not as dramatic:
After changing
TBH that doesn't worry me 🤷♂️ Most of the screenshots are fine now ☝️ but there are some problems with scope:
The same toolbar as above is stretched 🤔 I can work on that and investigate more but could you confirm the migration path? Would it be worth documenting |
|
@tniezurawski could you move the details and create a new issue? We'll have a look. Also possible to share a reproducible sample as part of the issue? |
|
@itsjwala Sure, I could do it but I don't know how to describe the issue 😅 First I would have to get a confirmation that upgrading to await percySnapshot('Add an appointment - clients list', {
scope: '[data-test-appointment-slide-over-dialog]',
}); |
What is this?
This SDK compensates for Ember's testing UI by utilizing a
scopeoption to dump the contents of that scoped element into the document body. We semi-recently implemented a new type ofscopeoption directly in our API that allows scoping snapshots to specific elements in the DOM. With this feature, the two scope options conflict, and this SDK cannot use the new element scoping feature while the Ember testing UI scope feature exists.Rather than rename the element scoping option for this SDK only, to keep all SDKs consistent we've decided to rename the existing Ember SDK scope option to
emberTestingScope. Unfortunately, that makes this a breaking change for anybody relying on the oldscopeoption behavior. When upgrading, if not renamed, the newscopeoption will take effect and any cropping for that scoped element will be done by our infrastructure and might have unexpected results.