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

Negative time reported for "time label applied" measurement #282

Closed
smstone opened this issue May 17, 2024 · 0 comments
Closed

Negative time reported for "time label applied" measurement #282

smstone opened this issue May 17, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@smstone
Copy link
Contributor

smstone commented May 17, 2024

Describe the bug

Thank you for this repository.

When I ran issue-metrics v3 against a repository with several GitHub issues that utilize labels, I noticed a few of the "time label applied" measurements are reported as negative time, for example -1 day, 9:07:12. This should not be possible.

Negative time is reported for labels where they have moved from labeled, to unlabeled, to labeled on a given issue. This line skips labels that have been labeled but were at one point unlabeled causing this issue.

To Reproduce

Here is the Issue and respective Issue events for the given label where it displays negative time spent on label.

Issue data:

{
      "closed": True,
      "closedAt": "2024-01-26T09:26:04Z",
      "createdAt": "2024-01-25T16:41:33Z",
      "id": "1234",
      "labels": [
        {
          "id": "1234",
          "name": "waiting",
        }
      ],
      "number": 1234,
      "state": "CLOSED",
      "updatedAt": "2024-02-09T08:00:41Z"
    }

Issue label events data::

{
      "id": 1,
      "event": "labeled",
      "created_at": "2024-01-25T16:41:34Z",
      "label": {
        "name": "waiting",
      },
    },
    {
      "id": 2
      "event": "unlabeled",
      "created_at": "2024-01-25T18:06:47Z",
      "label": {
        "name": "waiting",
      },
    },
    {
      "id": 3
      "event": "labeled",
      "created_at": "2024-01-26T08:59:34Z",
      "label": {
        "name": "waiting",
      },
    }

This can also be reproduced in TestLabels if you add an additional labeled event for the label bug, it shows a negative number:

  MagicMock(
      event="labeled",
      label={"name": "bug"},
      created_at=datetime(2021, 1, 4, tzinfo=pytz.UTC),
  ),

Result:

_______________________________________________________________________________________________________________________________________ TestLabels.test_get_label_metrics_closed_issue _______________________________________________________________________________________________________________________________________

self = <test_labels.TestLabels testMethod=test_get_label_metrics_closed_issue>

    def test_get_label_metrics_closed_issue(self):
        """Test get_label_metrics using a closed issue"""
        labels = ["bug", "feature"]
        metrics = get_label_metrics(self.issue, labels)
>       self.assertEqual(metrics["bug"], timedelta(days=2))
E       AssertionError: datetime.timedelta(days=-367) != datetime.timedelta(days=2)

test_labels.py:57: AssertionError
________________________________________________________________________________________________________________________________________ TestLabels.test_get_label_metrics_open_issue ________________________________________________________________________________________________________________________________________

self = <test_labels.TestLabels testMethod=test_get_label_metrics_open_issue>

    def test_get_label_metrics_open_issue(self):
        """Test get_label_metrics using an open issue"""
        self.issue.state = "open"
        labels = ["bug", "feature"]
        metrics = get_label_metrics(self.issue, labels)
>       self.assertEqual(metrics["bug"], timedelta(days=2))
E       AssertionError: datetime.timedelta(days=-367) != datetime.timedelta(days=2)

Expected behavior

A "time label applied" measurement should not be reported as a negative time duration.

Screenshots

No response

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant