-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: disallow keys of JS Object prototype for safety (#236)
- Loading branch information
Showing
6 changed files
with
146 additions
and
88 deletions.
There are no files selected for viewing
This file contains 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
118 changes: 118 additions & 0 deletions
118
packages/entity/src/__tests__/EntityConfiguration-test.ts
This file contains 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,118 @@ | ||
| import EntityConfiguration from '../EntityConfiguration'; | ||
| import { UUIDField, StringField } from '../EntityFields'; | ||
|
|
||
| describe(EntityConfiguration, () => { | ||
| describe('when valid', () => { | ||
| type BlahT = { | ||
| id: string; | ||
| cacheable: string; | ||
| uniqueButNotCacheable: string; | ||
| }; | ||
|
|
||
| type Blah2T = { | ||
| id: string; | ||
| }; | ||
|
|
||
| const blahEntityConfiguration = new EntityConfiguration<BlahT>({ | ||
| idField: 'id', | ||
| tableName: 'blah_table', | ||
| schema: { | ||
| id: new UUIDField({ | ||
| columnName: 'id', | ||
| }), | ||
| cacheable: new StringField({ | ||
| columnName: 'cacheable', | ||
| cache: true, | ||
| }), | ||
| uniqueButNotCacheable: new StringField({ | ||
| columnName: 'unique_but_not_cacheable', | ||
| }), | ||
| }, | ||
| databaseAdapterFlavor: 'postgres', | ||
| cacheAdapterFlavor: 'redis', | ||
| }); | ||
|
|
||
| it('returns correct fields', () => { | ||
| expect(blahEntityConfiguration.idField).toEqual('id'); | ||
| expect(blahEntityConfiguration.tableName).toEqual('blah_table'); | ||
| expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual('postgres'); | ||
| expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual('redis'); | ||
| }); | ||
|
|
||
| it('filters cacheable fields', () => { | ||
| expect(blahEntityConfiguration.cacheableKeys).toEqual(new Set(['cacheable'])); | ||
| }); | ||
|
|
||
| describe('cache key version', () => { | ||
| it('defaults to 0', () => { | ||
| const entityConfiguration = new EntityConfiguration<Blah2T>({ | ||
| idField: 'id', | ||
| tableName: 'blah', | ||
| schema: { | ||
| id: new UUIDField({ | ||
| columnName: 'id', | ||
| }), | ||
| }, | ||
| databaseAdapterFlavor: 'postgres', | ||
| cacheAdapterFlavor: 'redis', | ||
| }); | ||
| expect(entityConfiguration.cacheKeyVersion).toEqual(0); | ||
| }); | ||
|
|
||
| it('sets to custom version', () => { | ||
| const entityConfiguration = new EntityConfiguration<Blah2T>({ | ||
| idField: 'id', | ||
| tableName: 'blah', | ||
| schema: { | ||
| id: new UUIDField({ | ||
| columnName: 'id', | ||
| }), | ||
| }, | ||
| databaseAdapterFlavor: 'postgres', | ||
| cacheAdapterFlavor: 'redis', | ||
| cacheKeyVersion: 100, | ||
| }); | ||
| expect(entityConfiguration.cacheKeyVersion).toEqual(100); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('validation', () => { | ||
| describe('disallows keys of JS Object prototype for safety', () => { | ||
| test.each([ | ||
| 'constructor', | ||
| '__defineGetter__', | ||
| '__defineSetter__', | ||
| 'hasOwnProperty', | ||
| '__lookupGetter__', | ||
| '__lookupSetter__', | ||
| 'isPrototypeOf', | ||
| 'propertyIsEnumerable', | ||
| 'toString', | ||
| 'valueOf', | ||
| '__proto__', | ||
| 'toLocaleString', | ||
| ])('disallows %p as field key', (keyName) => { | ||
| expect( | ||
| () => | ||
| new EntityConfiguration<any>({ | ||
| idField: 'id', | ||
| tableName: 'blah_table', | ||
| schema: { | ||
| id: new UUIDField({ | ||
| columnName: 'id', | ||
| }), | ||
| [keyName]: new StringField({ | ||
| columnName: 'any', | ||
| }), | ||
| }, | ||
| databaseAdapterFlavor: 'postgres', | ||
| cacheAdapterFlavor: 'redis', | ||
| }) | ||
| ).toThrow( | ||
| `Entity field name not allowed to prevent conflicts with standard Object prototype fields: ${keyName}` | ||
| ); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
77 changes: 0 additions & 77 deletions
77
packages/entity/src/__tests__/EntityDataConfiguration-test.ts
This file was deleted.
Oops, something went wrong.
This file contains 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 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 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