Skip to content

Commit

Permalink
Merge pull request #19690 from mixonic/mixonic/html-safe-deprecation
Browse files Browse the repository at this point in the history
[BUGFIX release] Deprecate htmlSafe via prototype
  • Loading branch information
mixonic committed Aug 1, 2021
2 parents 2b209f8 + c6c6978 commit 015bd42
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
40 changes: 40 additions & 0 deletions packages/@ember/-internals/glimmer/tests/utils/string-test.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
import { ENV } from '@ember/-internals/environment';

import { SafeString, htmlSafe, isHTMLSafe } from './helpers';

Expand All @@ -11,6 +12,19 @@ moduleFor(
this.assert.ok(safeString instanceof SafeString, 'should be a SafeString');
}

['@test [deprecated] htmlSafe via string prototype should return an instance of SafeString']() {
if (ENV.EXTEND_PROTOTYPES.String) {
let safeString;
expectDeprecation(() => {
safeString = 'you need to be more <b>bold</b>'.htmlSafe();
}, /String prototype extensions are deprecated/);

this.assert.ok(safeString instanceof SafeString, 'should be a SafeString');
} else {
this.assert.expect(0);
}
}

['@test htmlSafe should return an empty string for null']() {
let safeString = htmlSafe(null);

Expand All @@ -24,6 +38,32 @@ moduleFor(
this.assert.equal(safeString instanceof SafeString, true, 'should be a SafeString');
this.assert.equal(safeString.toString(), '', 'should return an empty string');
}

['@test [deprecated] htmlSafe via string prototype should return an instance of SafeString for an empty string']() {
if (ENV.EXTEND_PROTOTYPES.String) {
let safeString;
expectDeprecation(() => {
safeString = ''.htmlSafe();
}, /String prototype extensions are deprecated/);

this.assert.ok(safeString instanceof SafeString, 'should be a SafeString');
} else {
this.assert.expect(0);
}
}

['@test [deprecated] String.prototype.htmlSafe is not modified without EXTEND_PROTOTYPES'](
assert
) {
if (!ENV.EXTEND_PROTOTYPES.String) {
assert.ok(
'undefined' === typeof String.prototype.htmlSafe,
'String.prototype helper disabled'
);
} else {
this.assert.expect(0);
}
}
}
);

Expand Down
13 changes: 13 additions & 0 deletions packages/ember/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,19 @@ Ember._captureRenderTree = captureRenderTree;

if (ENV.EXTEND_PROTOTYPES.String) {
String.prototype.htmlSafe = function () {
deprecate(
`String prototype extensions are deprecated. Please import htmlSafe from '@ember/template' instead.`,
false,
{
id: 'ember-string.prototype-extensions',
for: 'ember-source',
since: {
enabled: '3.27.6',
},
until: '4.0.0',
url: 'https://deprecations.emberjs.com/v3.x/#toc_ember-string-htmlsafe-ishtmlsafe',
}
);
return htmlSafe(this);
};
}
Expand Down

0 comments on commit 015bd42

Please sign in to comment.