fix: The save function should not throw an error for name/value properties in arrays #1336
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| import * as assert from 'assert'; | ||
| import {describe} from 'mocha'; | ||
| import {Entities, entity} from '../../src/entity'; | ||
| import findLargeProperties_ = entity.findLargeProperties_; | ||
|
|
||
| const async = require('async'); | ||
|
|
||
| describe('findLargeProperties_', () => { | ||
| const longString = Buffer.alloc(1501, '.').toString(); | ||
| // complexCaseEntities are passed into save for the complex case. | ||
| const complexCaseEntities = { | ||
| longString, | ||
| notMetadata: true, | ||
| longStringArray: [longString], | ||
| metadata: { | ||
| longString, | ||
| otherProperty: 'value', | ||
| obj: { | ||
| longStringArray: [ | ||
| { | ||
| longString, | ||
| nestedLongStringArray: [ | ||
| { | ||
| longString, | ||
| nestedProperty: true, | ||
| }, | ||
| { | ||
| longString, | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| longStringArray: [ | ||
| { | ||
| longString, | ||
| nestedLongStringArray: [ | ||
| { | ||
| longString, | ||
| nestedProperty: true, | ||
| }, | ||
| { | ||
| longString, | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
| async.each( | ||
| [ | ||
| { | ||
| name: 'For a simple case involving a name/value pair', | ||
| entities: { | ||
| name: 'firstElementName', | ||
| value: longString, | ||
| }, | ||
| skipped: false, | ||
| expectedOutput: ['value'], | ||
| }, | ||
| { | ||
| name: 'For a simple case involving a name/value pair in an array', | ||
| entities: [ | ||
| { | ||
| name: 'firstElementName', | ||
| value: longString, | ||
| }, | ||
| ], | ||
| skipped: false, | ||
| expectedOutput: ['[].value'], | ||
| }, | ||
| { | ||
| name: 'For a complex case involving lots of entities', | ||
| entities: complexCaseEntities, | ||
| skipped: false, | ||
| expectedOutput: [ | ||
| 'longString', | ||
| 'longStringArray[]', | ||
| 'metadata.longString', | ||
| 'metadata.obj.longStringArray[].longString', | ||
| 'metadata.obj.longStringArray[].nestedLongStringArray[].longString', | ||
| 'metadata.longStringArray[].longString', | ||
| 'metadata.longStringArray[].nestedLongStringArray[].longString', | ||
| ], | ||
| }, | ||
| { | ||
| name: 'For a complex case involving a name/value pair', | ||
| entities: { | ||
| name: 'firstElementName', | ||
| value: complexCaseEntities, | ||
| }, | ||
| skipped: false, | ||
| expectedOutput: [ | ||
| 'value.longString', | ||
| 'value.longStringArray[]', | ||
| 'value.metadata.longString', | ||
| 'value.metadata.obj.longStringArray[].longString', | ||
| 'value.metadata.obj.longStringArray[].nestedLongStringArray[].longString', | ||
| 'value.metadata.longStringArray[].longString', | ||
| 'value.metadata.longStringArray[].nestedLongStringArray[].longString', | ||
| ], | ||
| }, | ||
| { | ||
| name: 'For a complex case involving and array and name/value', | ||
| entities: [ | ||
| { | ||
| name: 'firstElementName', | ||
| value: complexCaseEntities, | ||
| }, | ||
| ], | ||
| skipped: false, | ||
| expectedOutput: [ | ||
| '[].value.longString', | ||
| '[].value.longStringArray[]', | ||
| '[].value.metadata.longString', | ||
| '[].value.metadata.obj.longStringArray[].longString', | ||
| '[].value.metadata.obj.longStringArray[].nestedLongStringArray[].longString', | ||
| '[].value.metadata.longStringArray[].longString', | ||
| '[].value.metadata.longStringArray[].nestedLongStringArray[].longString', | ||
| ], | ||
| }, | ||
| { | ||
| name: 'For some nested properties that happen to be called value and name', | ||
| entities: { | ||
| metadata: [ | ||
| { | ||
| name: longString, | ||
| value: 'some-value', | ||
| }, | ||
| ], | ||
| }, | ||
| skipped: false, | ||
| expectedOutput: ['metadata[].name'], | ||
| }, | ||
| ], | ||
| (test: { | ||
| name: string; | ||
| entities: Entities; | ||
| expectedOutput: string[]; | ||
| skipped: boolean; | ||
| }) => { | ||
| it(test.name, function () { | ||
| if (test.skipped) { | ||
| this.skip(); | ||
| } | ||
| const output = findLargeProperties_(test.entities, '', []); | ||
| assert.deepStrictEqual(output, test.expectedOutput); | ||
| }); | ||
| } | ||
| ); | ||
| }); |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original intent of this
ifstatement was to deal with arrays passed into the save function. When arrays are passed into the save function, they are normally expected to havenameandvalueproperties defined at the top level and then their proto is encoded using the name as the key so this code addsexcludeFromIndexes:truein the right places for this special encoding.The problem with this if statement is that this function is recursive so this logic will be applied recursively and
excludeFromIndexes: truewill be added recursively, but we only want this logic to be applied at the top level for arrays because the special encoding is only done for arrays at the top level. As it turns out excludeFromIndexes is applied in the right places of the top level here instead so this if block is no longer required and a new testshould save a nested name/value pair with value as a long stringproves this.