🥅 Stricter types in apply()#4
Merged
Merged
Conversation
Fixes: ottypes#37 # Background There are some corner cases that arise in the `json0` library because - given an object `obj`, and an array `arr` -these statements are both `true` in JavaScript: ```js obj['123'] === obj[123] arr['123'] === arr[123] ``` The fact that these statements are true can lead to some unexpected silent `transform()` failures: ```js const op1 = [{p: ['a', '1', 0], si: 'hi'}] const op2 = [{p: ['a', 1], lm: 0}] json0.transform(op1, op2, 'left') ``` Actual result: `[{p: ["a", 2, 0], si: "hi"}]` Expected result: `[{p: ["a", 0, 0], si: "hi"}]` # Solution In order to prevent this, it's been decided that arrays should *always* be indexed by `number`, and objects should *always* be indexed by `string`. This change enforces stricter type checks when calling `apply()`, and now throws in the following cases: - When a `number` is used to key an object property: `type.apply({'1': 'a'}, [{p:[1], od: 'a'}])` - When a `string` is used to key an array property: `type.apply(['a'], [{p:['0'], ld: 'a'}])` - When adding a `string` to a `number`: `type.apply(1, [{p:[], na: 'a}])` - When adding a `number` to a `string`: `type.apply('a', [{p:[], na: 1}])` - When applying a string operation to a non-string: `type.apply(1, [{p: [0], si: 'a'}])`
fyvfyv
approved these changes
Jul 7, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: ottypes#37
Background
There are some corner cases that arise in the
json0library because -given an object
obj, and an arrayarr-these statements are bothtruein JavaScript:The fact that these statements are true can lead to some unexpected
silent
transform()failures:Actual result:
[{p: ["a", 2, 0], si: "hi"}]Expected result:
[{p: ["a", 0, 0], si: "hi"}]Solution
In order to prevent this, it's been decided that arrays should always
be indexed by
number, and objects should always be indexed bystring.This change enforces stricter type checks when calling
apply(), andnow throws in the following cases:
numberis used to key an object property:type.apply({'1': 'a'}, [{p:[1], od: 'a'}])stringis used to key an array property:type.apply(['a'], [{p:['0'], ld: 'a'}])stringto anumber:type.apply(1, [{p:[], na: 'a}])numberto astring:type.apply('a', [{p:[], na: 1}])type.apply(1, [{p: [0], si: 'a'}])