Psalm 5.14.0 and higher triggers issues with defined array-shapes

[jaytaph]

Array shape declaration of certain methods are not compatible with psalm 5.14.0+.

InvalidArgument - src/Service/Elastic/IndexService.php:114:55 - Argument 1 of Elastic\Elasticsearch\Endpoints\Indices::exists expects array{allow_no_indices: bool, error_trace: bool, expand_wildcards: Elastic\Elasticsearch\Endpoints\enum, filter_path: list<mixed>, flat_settings: bool, human: bool, ignore_unavailable: bool, include_defaults: bool, index: list<mixed>, local: bool, pretty: bool, source: string}, but array{index: string} provided (see https://psalm.dev/004)
        $response = $this->elastic->indices()->exists(['index' => $indexName]);

This works correctly in psalm 5.13.1 or lower, but at 5.14.0 there has been some changes that will generate errors when not given all keys found in the definition.

	 * @param array{
	 *     index: list, // (REQUIRED) A comma-separated list of index names
	 *     local: boolean, // Return local information, do not retrieve the state from master node (default: false)
	 *     ignore_unavailable: boolean, // Ignore unavailable indexes (default: false)
	 *     allow_no_indices: boolean, // Ignore if a wildcard expression resolves to no concrete indices (default: false)
	 *     expand_wildcards: enum, // Whether wildcard expressions should get expanded to open or closed indices (default: open)
	 *     flat_settings: boolean, // Return settings in flat format (default: false)
	 *     include_defaults: boolean, // Whether to return all default setting for each of the indices.
	 *     pretty: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
	 *     human: boolean, // Return human readable values for statistics. (DEFAULT: true)
	 *     error_trace: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
	 *     source: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
	 *     filter_path: list, // A comma-separated list of filters used to reduce the response.
	 * } $params

This will probably function properly by adding a ? after the keyname in the array-shape.

	 * @param array{
	 *     index: list, // (REQUIRED) A comma-separated list of index names
	 *     local?: boolean, // Return local information, do not retrieve the state from master node (default: false)
	 *     ignore_unavailable?: boolean, // Ignore unavailable indexes (default: false)
	 *     allow_no_indices?: boolean, // Ignore if a wildcard expression resolves to no concrete indices (default: false)
	 *     expand_wildcards?: enum, // Whether wildcard expressions should get expanded to open or closed indices (default: open)
	 *     flat_settings?: boolean, // Return settings in flat format (default: false)
	 *     include_defaults?: boolean, // Whether to return all default setting for each of the indices.
	 *     pretty?: boolean, // Pretty format the returned JSON response. (DEFAULT: false)
	 *     human?: boolean, // Return human readable values for statistics. (DEFAULT: true)
	 *     error_trace?: boolean, // Include the stack trace of returned errors. (DEFAULT: false)
	 *     source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
	 *     filter_path?: list, // A comma-separated list of filters used to reduce the response.
	 * } $params

See:

https://psalm.dev/r/fae4b76358 vs https://psalm.dev/r/9b72fe22b5

[ezimuel]

@jaytaph thanks for this PR, I'll have a look. Your proposal sounds good. I need to update the code generator, since these comments are generated using a separate tool.

[MidnightDesign]

@ezimuel Where can I find the codegen? I'd like to give it a shot.

[reinschaap]

@ezimuel what is the current status and planning for this issue?

[reinschaap]

@ezimuel again my question since you did not (yet) give us any answers.

what is the current status and planning for resolving this issue?

[pluk]

Hi!

@ezimuel are there any updates?

[ezimuel]

@pluk , @reinschaap, @MidnightDesign @jaytaph I'm working on this issue, discussed also in #1423, #1424, #1425. Sorry for the late reply.

[momala454]

thanks for the update. Is there any reason to have the generator not open source ?

[ezimuel]

@momala454 We do not believe that the PHP code generator would provide value to the open-source community, and as a company policy, we have chosen not to release it publicly. Moreover, the code contains many Elastic specific details about our CI systems.
The more important parts are the rest-api-spec and elasticsearch-specification projects, which are public. These specifications contain all the necessary information to generate any client libraries.

[ezimuel]

I just sent this PR #1439 to fix the issue

[AJenbo]

... and elasticsearch-specification projects, which are public.

dead link

[reinschaap]

... and elasticsearch-specification projects, which are public.

dead link

I think he means to link here: https://github.com/elastic/elasticsearch-specification

[ezimuel]

Just released v8.17.1 with the fix in the PR #1442