6932795699

Committed 20 Nov 2023 04:14PM UTC coverage: 37.628% (-0.007%) from 37.635%

Build # 6932795699

Build Type

push

github

Committed by

web-flow

Commit Message

[fix] Effects: fix possible 'undefined' in effect parameters (#2452)

Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com>

Run Details

1753 of 7751 branches covered (0.0%)

Branch coverage included in aggregate %.

0 of 7 new or added lines in 2 files covered. (0.0%)

10 existing lines in 3 files now uncovered.

6574 of 14379 relevant lines covered (45.72%)

13.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

47.22

/src/effects/src/post-processing-effect.ts

import {PostProcessEffect as DeckPostProcessEffect} from '@deck.gl/core';
import {
  brightnessContrast,
  ink,
  triangleBlur,
  hueSaturation,
  vibrance,
  colorHalftone,
  dotScreen,
  edgeWork,
  noise,
  sepia,
  tiltShift,
  vignette,
  zoomBlur,
  magnify,
  hexagonalPixelate
} from '@luma.gl/shadertools';

import {POSTPROCESSING_EFFECTS, DEFAULT_POST_PROCESSING_EFFECT_TYPE} from '@kepler.gl/constants';
import {EffectPropsPartial, EffectParameterDescription} from '@kepler.gl/types';

import Effect from './effect';

const POSTPROCESSING_EFFECTS_DESCS = [
  {
    ...POSTPROCESSING_EFFECTS.ink,
    class: ink
  },
  {
    ...POSTPROCESSING_EFFECTS.brightnessContrast,
    class: brightnessContrast
  },
  {
    ...POSTPROCESSING_EFFECTS.hueSaturation,
    class: hueSaturation
  },
  {
    ...POSTPROCESSING_EFFECTS.vibrance,
    class: vibrance
  },
  {
    ...POSTPROCESSING_EFFECTS.sepia,
    class: sepia
  },
  {
    ...POSTPROCESSING_EFFECTS.dotScreen,
    class: dotScreen
  },
  {
    ...POSTPROCESSING_EFFECTS.colorHalftone,
    class: colorHalftone
  },
  {
    ...POSTPROCESSING_EFFECTS.noise,
    class: noise
  },
  {
    ...POSTPROCESSING_EFFECTS.triangleBlur,
    class: triangleBlur
  },
  {
    ...POSTPROCESSING_EFFECTS.zoomBlur,
    class: zoomBlur
  },
  {
    ...POSTPROCESSING_EFFECTS.tiltShift,
    class: tiltShift
  },
  {
    ...POSTPROCESSING_EFFECTS.edgeWork,
    class: edgeWork
  },
  {
    ...POSTPROCESSING_EFFECTS.vignette,
    class: vignette
  },
  {
    ...POSTPROCESSING_EFFECTS.magnify,
    class: magnify
  },
  {
    ...POSTPROCESSING_EFFECTS.hexagonalPixelate,
    class: hexagonalPixelate
  }
];

/**
 * Returns default parameter value based on effect description.
 * @param name Name of the parameter.
 * @param effectDescription Effect's description.
 * @param uniformsDesc Effect's uniforms.
 * @returns
 */
export const getDefaultValueForParameter = (
  name: string,
  effectDescription: EffectParameterDescription[],
  uniformsDesc: any
) => {
  const description = effectDescription.find(param => param.name === name);
  const uniform = uniformsDesc[name];
  return description?.defaultValue ?? uniform?.value ?? uniform ?? description?.min;
};

class PostProcessingEffect extends Effect {
  // deckEffect: PostProcessEffect | LightingEffect | null;

  constructor(props: EffectPropsPartial) {
    super(props);
  }

  _initializeEffect() {
    const effectDesc = POSTPROCESSING_EFFECTS_DESCS.find(desc => desc.type === this.type);
    if (effectDesc) {
      this.deckEffect = new DeckPostProcessEffect(effectDesc.class, this.parameters);

      const uniforms = this.deckEffect?.module?.uniforms;
      if (uniforms) {
        // get default parameters
        const keys = Object.keys(uniforms);
        const defaultParameters = {};
        keys.forEach(key => {
          defaultParameters[key] = getDefaultValueForParameter(key, this._uiConfig, uniforms);
        });
        this.parameters = {...defaultParameters, ...this.parameters};
        this.deckEffect?.setProps(this.parameters);
      }
    }
  }

  getDefaultProps(props: EffectPropsPartial = {}) {
    return super.getDefaultProps({type: DEFAULT_POST_PROCESSING_EFFECT_TYPE, ...props});
  }

  setProps(props: EffectPropsPartial) {
    super.setProps(props);

    // any uniform updated?
    if (props.parameters) {
      this.deckEffect?.setProps(this.parameters);
    }
  }
}

export default PostProcessingEffect;

1	import {PostProcessEffect as DeckPostProcessEffect} from '@deck.gl/core';
2	import {
3	brightnessContrast,
4	ink,
5	triangleBlur,
6	hueSaturation,
7	vibrance,
8	colorHalftone,
9	dotScreen,
10	edgeWork,
11	noise,
12	sepia,
13	tiltShift,
14	vignette,
15	zoomBlur,
16	magnify,
17	hexagonalPixelate
18	} from '@luma.gl/shadertools';
19
20	import {POSTPROCESSING_EFFECTS, DEFAULT_POST_PROCESSING_EFFECT_TYPE} from '@kepler.gl/constants';	8✔
21	import {EffectPropsPartial, EffectParameterDescription} from '@kepler.gl/types';
22
23	import Effect from './effect';	8✔
24
25	const POSTPROCESSING_EFFECTS_DESCS = [	3,288✔
26	{
27	...POSTPROCESSING_EFFECTS.ink,
28	class: ink
29	},
30	{
31	...POSTPROCESSING_EFFECTS.brightnessContrast,
32	class: brightnessContrast
33	},
34	{
35	...POSTPROCESSING_EFFECTS.hueSaturation,
36	class: hueSaturation
37	},
38	{
39	...POSTPROCESSING_EFFECTS.vibrance,
40	class: vibrance
41	},
42	{
43	...POSTPROCESSING_EFFECTS.sepia,
44	class: sepia
45	},
46	{
47	...POSTPROCESSING_EFFECTS.dotScreen,
48	class: dotScreen
49	},
50	{
51	...POSTPROCESSING_EFFECTS.colorHalftone,	8✔
52	class: colorHalftone
53	},
54	{
55	...POSTPROCESSING_EFFECTS.noise,	8!
56	class: noise
57	},
58	{
59	...POSTPROCESSING_EFFECTS.triangleBlur,	240!
60	class: triangleBlur
61	},
62	{
63	...POSTPROCESSING_EFFECTS.zoomBlur,	240✔
64	class: zoomBlur
65	},
66	{
67	...POSTPROCESSING_EFFECTS.tiltShift,
68	class: tiltShift
69	},
70	{
71	...POSTPROCESSING_EFFECTS.edgeWork,
72	class: edgeWork
73	},
74	{
75	...POSTPROCESSING_EFFECTS.vignette,
76	class: vignette
77	},
78	{
79	...POSTPROCESSING_EFFECTS.magnify,
80	class: magnify
81	},
82	{
83	...POSTPROCESSING_EFFECTS.hexagonalPixelate,
84	class: hexagonalPixelate
85	}
86	];
87
88	/**
89	* Returns default parameter value based on effect description.
90	* @param name Name of the parameter.
91	* @param effectDescription Effect's description.
92	* @param uniformsDesc Effect's uniforms.
93	* @returns
94	*/
95	export const getDefaultValueForParameter = (
96	name: string,
97	effectDescription: EffectParameterDescription[],
98	uniformsDesc: any
99	) => {
100	const description = effectDescription.find(param => param.name === name);
101	const uniform = uniformsDesc[name];
102	return description?.defaultValue ?? uniform?.value ?? uniform ?? description?.min;
103	};
104
105	class PostProcessingEffect extends Effect {
106	// deckEffect: PostProcessEffect \| LightingEffect \| null;
107
108	constructor(props: EffectPropsPartial) {	8✔
109	super(props);
110	}
111
UNCOV 112	_initializeEffect() {	×
113	const effectDesc = POSTPROCESSING_EFFECTS_DESCS.find(desc => desc.type === this.type);	8✔
114	if (effectDesc) {	8✔
115	this.deckEffect = new DeckPostProcessEffect(effectDesc.class, this.parameters);	8✔
116
117	const uniforms = this.deckEffect?.module?.uniforms;
118	if (uniforms) {	×
119	// get default parameters
120	const keys = Object.keys(uniforms);
121	const defaultParameters = {};
122	keys.forEach(key => {	×
123	defaultParameters[key] = getDefaultValueForParameter(key, this._uiConfig, uniforms);
124	});
125	this.parameters = {...defaultParameters, ...this.parameters};
UNCOV 126	this.deckEffect?.setProps(this.parameters);	×
UNCOV 127	}	×
128	}
129	}
130
131	getDefaultProps(props: EffectPropsPartial = {}) {	×
132	return super.getDefaultProps({type: DEFAULT_POST_PROCESSING_EFFECT_TYPE, ...props});	×
133	}
134
135	setProps(props: EffectPropsPartial) {	×
UNCOV 136	super.setProps(props);	×
137
138	// any uniform updated?
139	if (props.parameters) {	×
140	this.deckEffect?.setProps(this.parameters);	×
141	}
142	}
143	}
144
145	export default PostProcessingEffect;

keplergl / kepler.gl / 6932795699

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous