Compliance API to report the node usage data

[sonali523]

🔩 Description: What code changed, and why?

Automate compliance API to to report the node usage data
This API report back the count of unique nodes with lastRun in a given time.

⛓️ Related Resources

#5861

👍 Definition of Done

I have added the API in compliance service to report back the count of unique nodes with lastRun in a given time.
The time duration is between the last time Telemetry data sent and the current date.
If the duration < 15 days --> 15 days
duration > 15 days --> duration

👟 How to Build and Test the Change

Steps to build:

rebuild components/automate-gateway
rebuild components/compliance-service

Steps to test:

Request

This is a get request
curl -sSkH "api-token: $(get_admin_token)" 'https://a2-dev.test/api/v0/compliance/reporting/stats/nodes/count'

Response

{
    "days_since_last_post": "10",
    "node_cnt": "2"
}

✅ Checklist

All PRs must tick these:

• I have read the CONTRIBUTING document.
• All commits signed-off for the Developer Certification of Origin.

With occasional exceptions, all PRs from Progress employees must tick these:

• Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
• Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
• Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
• Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
• Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)

All PRs from Progress employees should tick these if appropriate:

• Tests added/updated? (all new code needs new tests)
• Docs added/updated? (all customer-facing changes)

Please add a note next to any checkbox above if you are NOT ticking it.

📷 Screenshots, if applicable

[rickmarry]

This func computes the days between two dates. it's misleading that it returns 15 if fromTime is zero.
I would remove the part that returns 15 if fromTime is zero and do that check before calling this func instead.
This way, the func can serve as a util func. We could then put it in the utils package and reuse it

[sonali523]

Added this daysBetween() func in utils package

[rickmarry]

here I would check for telemetry.LastTelemetryReportedAt and if it's 0 then set daysSinceLastPost to 15

[sonali523]

Added the suggested changes. Thanks!!

[rickmarry]

could you have done this instead?:
days := toTime.Sub(fromTime).Hours() / 24

[sonali523]

Yes, I already tried it but with this the issue is, it computes the days with 24 hours
If less than 24 hrs then it did not consider that day

[kalroy]

should not be current date but the day before that

[sonali523]

Did the changes

[kalroy]

Suggested change

	var rangeQueryThreshold *elastic.RangeQuery
	var rangeQueryThreshold *elastic.RangeQuery
	t := time.Now().AddDate(0, 0, -1)
	yesterdayEODTimeStamp := time.Date(t.Year(), t.Month(), t.Day(), 23, 59, 59, t.Nanosecond(), t.Location())

[sonali523]

Added the changes. Thanks!!

[kalroy]

We need to evaluate from yesterday timestamp

Suggested change

	rangeQueryThreshold = elastic.NewRangeQuery("last_run").From(lastTelemetryReportedAt).To(time.Now())
	rangeQueryThreshold = elastic.NewRangeQuery("last_run").From(lastTelemetryReportedAt).To(yesterdayEODTimeStamp)

[sonali523]

Did the suggested changes.

[kalroy]

We need to modify this too. May be like this:

Suggested change

	rangeQueryThreshold = elastic.NewRangeQuery("last_run").Gte("now-" + "15d")
	startTimeStamp := yesterdayEODTimeStamp.AddDate(0,0,-16)
	rangeQueryThreshold = elastic.NewRangeQuery("last_run").From(startTimeStamp).To(yesterdayEODTimeStamp)

[sonali523]

Added the changes

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication