kibble/api/pages/code/punchcard.py

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

########################################################################
# OPENAPI-URI: /api/code/punchcard
########################################################################
# get:
#   responses:
#     '200':
#       content:
#         application/json:
#           schema:
#             $ref: '#/components/schemas/Timeseries'
#       description: 200 Response
#     default:
#       content:
#         application/json:
#           schema:
#             $ref: '#/components/schemas/Error'
#       description: unexpected error
#   security:
#   - cookieAuth: []
#   summary: Show commits as a timeseries
# post:
#   requestBody:
#     content:
#       application/json:
#         schema:
#           $ref: '#/components/schemas/defaultWidgetArgs'
#   responses:
#     '200':
#       content:
#         application/json:
#           schema:
#             $ref: '#/components/schemas/Timeseries'
#       description: 200 Response
#     default:
#       content:
#         application/json:
#           schema:
#             $ref: '#/components/schemas/Error'
#       description: unexpected error
#   security:
#   - cookieAuth: []
#   summary: Show commits as a timeseries
#
########################################################################


"""
This is the commit punch-card renderer for Kibble
"""

import json
import time
import hashlib


def run(API, environ, indata, session):

    # We need to be logged in for this!
    if not session.user:
        raise API.exception(403, "You must be logged in to use this API endpoint! %s")

    now = time.time()

    # First, fetch the view if we have such a thing enabled
    viewList = []
    if indata.get("view"):
        viewList = session.getView(indata.get("view"))
    if indata.get("subfilter"):
        viewList = session.subFilter(indata.get("subfilter"), view=viewList)

    dateTo = indata.get("to", int(time.time()))
    dateFrom = indata.get(
        "from", dateTo - (86400 * 30 * 6)
    )  # Default to a 6 month span

    which = "committer_email"
    role = "committer"
    if indata.get("author", False):
        which = "author_email"
        role = "author"

    interval = indata.get("interval", "day")

    ####################################################################
    ####################################################################
    dOrg = session.user["defaultOrganisation"] or "apache"
    query = {
        "query": {
            "bool": {
                "must": [
                    {"range": {"tsday": {"from": dateFrom, "to": dateTo}}},
                    {"term": {"organisation": dOrg}},
                ]
            }
        }
    }
    # Source-specific or view-specific??
    if indata.get("source"):
        query["query"]["bool"]["must"].append(
            {"term": {"sourceID": indata.get("source")}}
        )
    elif viewList:
        query["query"]["bool"]["must"].append({"terms": {"sourceID": viewList}})
    if indata.get("email"):
        query["query"]["bool"]["should"] = [
            {"term": {"committer_email": indata.get("email")}},
            {"term": {"author_email": indata.get("email")}},
        ]
        query["query"]["bool"]["minimum_should_match"] = 1

    # Path filter?
    if indata.get("pathfilter"):
        pf = indata.get("pathfilter")
        if "!" in pf:
            pf = pf.replace("!", "")
            query["query"]["bool"]["must_not"] = query["query"]["bool"].get(
                "must_not", []
            )
            query["query"]["bool"]["must_not"].append({"regexp": {"files_changed": pf}})
        else:
            query["query"]["bool"]["must"].append({"regexp": {"files_changed": pf}})

    # Get number of committers, this period
    query["aggs"] = {
        "commits": {
            "date_histogram": {"field": "date", "interval": "hour", "format": "E - k"}
        }
    }
    res = session.DB.ES.search(
        index=session.DB.dbname, doc_type="code_commit", size=0, body=query
    )

    timeseries = {}
    for bucket in res["aggregations"]["commits"]["buckets"]:
        ts = bucket["key_as_string"]
        count = bucket["doc_count"]
        timeseries[ts] = timeseries.get(ts, 0) + count

    JSON_OUT = {
        "widgetType": {"chartType": "punchcard"},  # Recommendation for the UI
        "timeseries": timeseries,
        "interval": interval,
        "okay": True,
        "responseTime": time.time() - now,
    }
    yield json.dumps(JSON_OUT)