Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a caching mechanism for duplicated code flow data #320

Closed
michaelcfanning opened this issue Jan 25, 2019 · 1 comment
Closed

Provide a caching mechanism for duplicated code flow data #320

michaelcfanning opened this issue Jan 25, 2019 · 1 comment
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft design-improvement e-ballot e-ballot-2 impact-non-breaking-change merged Changes merged into provisional draft. resolved-fixed sdk-code-complete

Comments

@michaelcfanning
Copy link
Contributor

michaelcfanning commented Jan 25, 2019

EBALLOT PROPOSAL: provide a mechanism for caching thread flow location data, which is often copious and highly duplicative when producing complex code/dataflow static analysis results.

API IMPACT:
Add run.threadFlowLocations, an array of threadFlowLocation objects cached at the run level, analogous to run.files and run.logicalLocation.
Add threadFlowLocation.index, an index into run.threadFlowLocations.
Add externalPropertyFiles.threadFlowLocations, allowing cached data to be stored in a separate file.

NOTES:
A result-level threadFlowLocation object can specify properties of its own, and also populate its index property. The behavior in this case is that the cached threadFlowLocation is used to initialize the local threadFlowLocation. Any local properties that diverge from the cached copy override the corresponding properties of the cached object. This allows producers to cache locations that share some common subset of properties while permitted the result-published locations to make minor updates to the cached version.

@michaelcfanning michaelcfanning added the 2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. label Jan 25, 2019
@oasis-tcs oasis-tcs deleted a comment Feb 27, 2019
@michaelcfanning michaelcfanning changed the title Consider whether we require caching mechanisms for duplicated code flow data Provide a caching mechanism for duplicated code flow data Feb 27, 2019
@ghost ghost added the to-be-written label Mar 1, 2019
michaelcfanning pushed a commit to microsoft/sarif-sdk that referenced this issue Mar 3, 2019
#1320)

* adding caching mechanism for codeflow data

* releasehistory update

* Update schema comment.
ghost pushed a commit that referenced this issue Mar 4, 2019
ghost pushed a commit that referenced this issue Mar 4, 2019
@ghost ghost added impact-non-breaking-change design-improvement merged Changes merged into provisional draft. labels Mar 15, 2019
ghost pushed a commit that referenced this issue Mar 15, 2019
ghost pushed a commit that referenced this issue Mar 19, 2019
This draft contains all the changes through "e-ballot #2," which
opened on Friday March 15 and will close on Friday March 22. It contains
changes for ballot issues #168, #291, #309, #320, #321, #326, #335,
and #341, as well as for previously approved issue #340.

It does _not_ contain changes for any issues from "e-ballot #3,"
which will open on Friday March 22 and close on Friday March 29.
@ghost ghost self-assigned this Mar 29, 2019
@ghost ghost added resolved-fixed design-approved The TC approved the design and I can write the change draft e-ballot-2 and removed change-draft-available labels Mar 29, 2019
@ghost
Copy link

ghost commented Mar 29, 2019

Approved in e-ballot #2.

@ghost ghost closed this as completed Mar 29, 2019
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.1.0-CSD.1 Will be fixed in SARIF v2.1.0 CSD.1. design-approved The TC approved the design and I can write the change draft design-improvement e-ballot e-ballot-2 impact-non-breaking-change merged Changes merged into provisional draft. resolved-fixed sdk-code-complete
Projects
None yet
Development

No branches or pull requests

1 participant