Add DeletePipeline API

[xoxys]

This is just a first step, the final goal is to have an API endpoint to prune Repo Pipelines older than the given date.

@woodpecker-ci/maintainers Can I get some feedback if this is the right direction?

[woodpecker-bot]

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-3506.surge.sh

[xoxys]

Will add some more tests for the delete API later today.

[xoxys]

Should we prevent deleting active pipelines through the exposed api.DeletePipelines?

[6543]

☝️ yes & pending ... as they have to be removed from task queue

[xoxys]

☝️ yes & pending ... as they have to be removed from task queue

I have added a helper function to check the status and applied it to DeletePipelineLogs as well. model.StatusRunning, model.StatusPending, model.StatusBlocked are blocked now, for both delete actions.

[codecov]

Codecov Report

Attention: Patch coverage is 48.10127% with 41 lines in your changes are missing coverage. Please review.

Project coverage is 36.08%. Comparing base (326069c) to head (b92012b).
Report is 12 commits behind head on main.

❗ Current head b92012b differs from pull request most recent head f901408. Consider uploading reports for the commit f901408 to get more accurate results

Files	Patch %	Lines
server/api/pipeline.go	39.34%	33 Missing and 4 partials ⚠️
server/store/datastore/pipeline.go	75.00%	2 Missing and 1 partial ⚠️
server/api/badge.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3506      +/-   ##
==========================================
+ Coverage   36.04%   36.08%   +0.03%     
==========================================
  Files         229      229              
  Lines       15493    15565      +72     
==========================================
+ Hits         5585     5616      +31     
- Misses       9502     9538      +36     
- Partials      406      411       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[anbraten]

@xoxys Is your plan to have something like requested in #1068? (seems to have quite a few 👍🏾) So currently this would be done by calling the api, should we add some cron / ui button as well?

[xoxys]

Is your plan to have something like requested in #1068

In general, yes. My DB is growing constantly already.

should we add some cron / ui button as well?

I would like to separate this. First, let's get the API changes merged. After that, we can add UI components, CLI, etc.
Personally, I don't need a UI, I will just use the CLI to run a scheduled job to clean up old pipelines.

Note: These APIs are about deleting the entire pipeline, not only it logs.

[xoxys]

In addition to this, an API DeletePipelineLogs exists already and there is a PR #3451 to add the ability to delete logs of particular steps.

[anbraten]

In general, yes. My DB is growing constantly already.

I think the same would be of value for the woodpecker project (and probably most others) as well. We normally care about the last 100 pipelines, but I can't imagine looking at pipelines from the last year etc.

[anbraten]

One think I am wondering is, would it be cleaner to have a delete-pipeline endpoint instead of delete-pipelines (as that could be used to delete a single pipeline) similar to delete pipeline-logs of a single pipeline etc. And then the get endpoint with time filters could be used to get all pipelines before and after x and delete them with a script etc by using their id?

[xoxys]

I would like to avoid extra scripting around it. However, I can also add DeletePipeline API that just calls store.DeletePipeline to delete a single pipeline by ID. Or is there any downside to have both API endpoints?

[xoxys]

@woodpecker-ci/maintainers Anything missing for this?

[anbraten]

I would like to avoid extra scripting around it.

I see, but shouldn't we then integrate a cron job doing that based on a setting into wp directly then?

However, I can also add DeletePipeline API that just calls store.DeletePipeline to delete a single pipeline by ID. Or is there any downside to have both API endpoints?

It feels quite powerful to me having an endpoint that could delete all pipelines of a repo.

[xoxys]

It feels quite powerful to me having an endpoint that could delete all pipelines of a repo.

Please make a decision and I'll implement it that way then.

I see, but shouldn't we then integrate a cron job doing that based on a setting into wp directly then?

Again, yes we can add client integrations (UI, CLI) later please let's get the API changes merged first.

[qwerty287]

Didn't test, but seems fine