Skip to content

Conversation

jeongsoolee09
Copy link
Contributor

What This PR Contributes

This PR fixes false negative cases where the current CAP remote flow source definition UserProvidedPropertyReadOfHandlerParameterOfExposedService is missing detections from the code that comes in the following form:

import cds from "@sap/cds";

module.exports = (srv) => { srv.on(...) }

Two things are notable in the above case:

  1. The code is mixing ES2015 modules and CommonJS modules with regards to importing and exporting values.
  2. The service is implemented in a form of a function (or closure) exported by this module.

Unfortunately, the CodeQL Standard Library for JavaScript cannot detect the above (srv) => { srv.on(...) } element due to some limitations (see issue #221). Therefore, we directly describe the above pattern module.exports = (...) => { ... } as a hack around it.

Other than that, the code changes include:

  • Extension to definitions:
    • Add an explicit case named ExportedClosureApplicationServiceDefinition of a UserDefinedApplicationService that is defined in the form of an exported function whose first parameter represents the service instance.
    • Add a definition ServiceInstanceFromExportedClosureParameter that matches above class.
  • Bug fixes:
    • Address a bug in the UserDefinedApplicationService.isExposed/0 where a simple negation also captured cases where CDS declarations were missing.
    • Address a bug in the HandlerParameterOfExposedService where the trailing .getCdsDeclaration() was missing.

Future Works

Remove the "hack around it" once the relevant portion of the library is patched and released.

…ervice`

- Extension to definitions:
  - Add an explicit case named `ExportedClosureApplicationServiceDefinition` of a `UserDefinedApplicationService` that is defined in the form of an exported function whose first parameter represents the service instance.
  - Add a definition `ServiceInstanceFromExportedClosureParameter` that matches above class.
- Bug fixes:
  - Address a bug in the `UserDefinedApplicationService.isExposed/0` where a simple negation also captured cases where CDS declarations were missing.
  - Address a bug in the `HandlerParameterOfExposedService` where the trailing `.getCdsDeclaration()` was missing.

NOTE: See issue #221 to learn more about the `HACK` block comment.
@jeongsoolee09 jeongsoolee09 self-assigned this Aug 15, 2025
* This class captures the `srv` parameter of the exported arrow function. Also see
* `ServiceInstanceFromImplMethodCallClosureParameter` which is similar to this.
*/
class ServiceInstanceFromExportedClosureParameter extends ServiceInstance {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this also extend ParameterNode like ServiceInstanceFromImplMethodCallClosureParameter does? not too sure if its really necessary/makes anything easier predicate availability wise tho

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 6514387.

@knewbury01
Copy link
Contributor

overall this looks really good to me!

couple of small extra things

  1. I think maybe should we add a change notes
  2. less sure, but do we want to add anything to our UserDefinedService unit test or to remote flow source unit test maybe as extra doc of this extra coverage?

@jeongsoolee09
Copy link
Contributor Author

@knewbury01 Additional cases are added to userdefinedservice, HandlerParameterOfExposedService (formerly ExposedService) and RemoteFlowSource.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants