IPA-110: Pagination (links array and includeCount not required)

[yelizhenden-mdb]

Proposed changes

Jira ticket: CLOUDP-304954 and CLOUDP-304956

  xgen-IPA-110-collections-request-includeCount-not-required:
    description: |
      If the request supports an includeCount query parameter, it must not be required.

      ##### Implementation details
      Rule checks for the following conditions:
        - Only applies to List methods (GET on resource collection paths)
        - Checks if includeCount query parameter exists
        - If it exists, verifies the includeCount parameter is not required
    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-110-collections-request-includeCount-not-required'
    severity: warn
    given: '$.paths[*].get'
    then:
      function: 'IPA110CollectionsRequestIncludeCountNotRequired'
  xgen-IPA-110-collections-response-define-links-array:
    description: |
      The response for collections should define a links array field, providing links to next and previous pages.

      ##### Implementation details
      Rule checks for the following conditions:
        - Only applies to List methods (GET operations that return collections of resources)
        - Verifies the response schema includes a links field of type array
    message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-110-collections-response-define-links-array'
    severity: warn
    given: '$.paths[*].get.responses.200.content'
    then:
      field: '@key'
      function: 'IPA110CollectionsResponseDefineLinksArray'

No violations found for xgen-IPA-110-collections-request-includeCount-not-required
11 violations found for xgen-IPA-110-collections-response-define-links-array (similar to ones that does not have results array in the response)

Checklist

• I have signed the MongoDB CLA
• I have added tests that prove my fix is effective or that my feature works

Changes to Spectral

• I have read the README file for Spectral Updates

Further comments

[wtrocki]

LGTM. Glad to see those

[gssbzn]

are we allowed to use moderm js?

Suggested change

	const parameters = input.parameters;
	if (!parameters) {
	return;
	}
	const includeCountParam = parameters.find((p) => p.name === 'includeCount' && p.in === 'query');
	if (!includeCountParam) {
	return;
	}
	const includeCountParam = input?.parameters?.find((p) => p.name === 'includeCount' && p.in === 'query');
	if (!includeCountParam) {
	return;
	}

[wtrocki]

Yes. We run above >18. ? operator was introduced 6 years ago to Node 14.

[yelizhenden-mdb]

Addressed 👍

[gssbzn]

Suggested change

	if (includeCountParam.required === true) {
	if (!!includeCountParam.required) {

[wtrocki]

We use eslint for such style enforcement.
IMHO we can enable this rule https://eslint.org/docs/latest/rules/no-extra-boolean-cast

[yelizhenden-mdb]

Added no-extra-boolean-cast to eslint config with enforceForLogicalOperands: true

It does not allow if(!!includeCountParam.required), because JS already coerces the includeCountParam.required to boolean in if. I replaced it with if(includeCountParam.required)

[gssbzn]

isn't this the same as

!isResourceCollectionIdentifier(resourcePath) || isSingletonResource(getResourcePathItems(resourcePath, oas.paths)

!A || (A && B) = (!A || A) && (!A || B) 
(!A || A) && (!A || B) = true && (!A || B)
true && (!A || B) = !A || B

[yelizhenden-mdb]

Yes, it is :D It is widely used, so I will share another PR to fix this