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

Document current $t() and $te() handling for __proto__ #1705

Draft
wants to merge 1 commit into
base: v8.x
Choose a base branch
from
Draft

Document current $t() and $te() handling for __proto__ #1705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
250 changes: 250 additions & 0 deletions test/unit/basic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,180 @@ describe('basic', () => {
)
})
})

describe('__proto__ handling', () => {
describe('top-level prop', () => {
describe('existing key', () => {
let vm;
beforeEach(() => {
const i18n = new VueI18n({
locale: 'en',
fallbackLocale: 'en',
messages: {
en: {
__proto__: 'i exist'
},
ja: {
__proto__: 'i exist (ja)'
},
},
modifiers: {
custom: str => str.replace(/[aeiou]/g, 'x')
}
})
vm = new Vue({ i18n })
})

it('should return string', () => {
// FIXME: should be a string with value 'i exist'?
assert(typeof vm.$t('__proto__') === 'object')
})

it('should return string with locale', () => {
// FIXME: should be a string with value 'i exist (ja)'?
assert(typeof vm.$t('__proto__', 'ja') === 'object')
})
})

describe('not existing key', () => {
it('should return key', () => {
const vm = new Vue({ i18n })
// FIXME: should be key?
assert(typeof vm.$t('__proto__') === 'object')
})

it('should return key with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be key?
assert(typeof vm.$t('__proto__', 'ja') === 'object')
})
})
})

describe('top-level prop with trailing prop', () => {
describe('with top-level prop defined', () => {
let vm;
beforeEach(() => {
const i18n = new VueI18n({
locale: 'en',
fallbackLocale: 'en',
messages: {
en: {
__proto__: {
existing: 'i exist'
}
},
ja: {
__proto__: {
existing: 'i exist (ja)'
}
},
},
modifiers: {
custom: str => str.replace(/[aeiou]/g, 'x')
}
})
vm = new Vue({ i18n })
})

describe('existing key', () => {
it('should return string', () => {
// FIXME: should be a string with value 'i exist'?
assert(vm.$t('__proto__.existing') === 'i exist')
})

it('should return string with locale', () => {
// FIXME: should be a string with value 'i exist (ja)'?
assert(vm.$t('__proto__.existing', 'ja') === 'i exist (ja)')
})
})

describe('not existing key', () => {
it('should return key', () => {
const vm = new Vue({ i18n })
assert(vm.$t('__proto__.missing') === '__proto__.missing')
})

it('should return key with locale', () => {
const vm = new Vue({ i18n })
assert(vm.$t('__proto__.missing', 'ja') === '__proto__.missing')
})
})
})

describe('without top-level prop defined', () => {
it('should return key', () => {
const vm = new Vue({ i18n })
assert(vm.$t('__proto__.missing') === '__proto__.missing')
})

it('should return key with locale', () => {
const vm = new Vue({ i18n })
assert(vm.$t('__proto__.missing', 'ja') === '__proto__.missing')
})
})
})

describe('deep prop', () => {
describe('existing key', () => {
it('should return true', () => {
const vm = new Vue({ i18n })
// FIXME: should be a string with value 'i exist'?
assert(typeof vm.$t('issues.builtins.existing.__proto__') === 'object')
})

it('should return true with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be a string with value 'i exist (ja)'?
assert(typeof vm.$t('issues.builtins.existing.__proto__', 'ja') === 'object')
})
})

describe('not existing key', () => {
it('should return false', () => {
const vm = new Vue({ i18n })
// FIXME: should be key?
assert(typeof vm.$t('issues.builtins.missing.__proto__') === 'object')
})

it('should return false with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be key?
assert(typeof vm.$t('issues.builtins.missing.__proto__', 'ja') === 'object')
})
})
})

describe('deep prop with proto in middle', () => {
describe('existing key', () => {
it('should return true', () => {
const vm = new Vue({ i18n })
// FIXME: should be a string with value 'i exist'?
assert(vm.$t('issues.builtins.__proto__.existing') === 'i exist')
})

it('should return true with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be a string with value 'i exist (ja)'?
assert(vm.$t('issues.builtins.__proto__.existing', 'ja') === 'i exist (ja)')
})
})

describe('not existing key', () => {
it('should return false', () => {
const vm = new Vue({ i18n })
// FIXME: should be key?
assert(vm.$t('issues.builtins.__proto__.missing') === 'issues.builtins.__proto__.missing')
})

it('should return false with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be key?
assert(vm.$t('issues.builtins.__proto__.missing', 'ja') === 'issues.builtins.__proto__.missing')
})
})
})
})
})

describe('$tc', () => {
Expand Down Expand Up @@ -660,6 +834,82 @@ describe('basic', () => {
assert(vm.$te('message.hello', 'xx') === false)
})
})

describe('__proto__ handling', () => {
describe('top-level prop', () => {
describe('existing key', () => {
let vm;
beforeEach(() => {
const i18n = new VueI18n({
locale: 'en',
fallbackLocale: 'en',
messages: {
en: {
__proto__: 'i exist'
},
ja: {
__proto__: 'i exist (ja)'
},
},
modifiers: {
custom: str => str.replace(/[aeiou]/g, 'x')
}
})
vm = new Vue({ i18n })
})

it('should return true', () => {
assert(vm.$te('__proto__') === true)
})

it('should return true with locale', () => {
assert(vm.$te('__proto__', 'ja') === true)
})
})

describe('not existing key', () => {
it('should return false', () => {
const vm = new Vue({ i18n })
assert(vm.$te('__proto__') === true)
})

it('should return false with locale', () => {
const vm = new Vue({ i18n })
assert(vm.$te('__proto__', 'ja') === true)
})
})
})

describe('deep prop', () => {
describe('existing key', () => {
it('should return true', () => {
const vm = new Vue({ i18n })
// FIXME: should be false?
assert(vm.$te('issues.builtins.existing.__proto__') === true)
})

it('should return true with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be false?
assert(vm.$te('issues.builtins.existing.__proto__', 'ja') === true)
})
})

describe('not existing key', () => {
it('should return false', () => {
const vm = new Vue({ i18n })
// FIXME: should be false?
assert(vm.$te('issues.builtins.missing.__proto__') === true)
})

it('should return false with locale', () => {
const vm = new Vue({ i18n })
// FIXME: should be false?
assert(vm.$te('issues.builtins.missing.__proto__', 'ja') === true)
})
})
})
})
})

describe('i18n#locale', () => {
Expand Down
24 changes: 21 additions & 3 deletions test/unit/fixture/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export default {
module.exports = {
en: {
message: {
hello: 'the world',
Expand Down Expand Up @@ -70,7 +70,16 @@ export default {
]
],
issues: {
arrayBugs: ['bug1', 'bug2']
arrayBugs: ['bug1', 'bug2'],
builtins: {
__proto__: {
existing: 'i exist'
},
existing: {
__proto__: 'i exist',
},
missing: {}
}
},
'foo.bar.buz': 'hello flat key!'
},
Expand Down Expand Up @@ -111,7 +120,16 @@ export default {
]
],
issues: {
arrayBugs: ['バグ1', 'バグ2']
arrayBugs: ['バグ1', 'バグ2'],
builtins: {
__proto__: {
existing: 'i exist (ja)'
},
existing: {
__proto__: 'i exist (ja)',
},
missing: {}
}
},
'foo.bar.buz': 'こんにちは、フラットなキーさん！'
}
Expand Down