cancellation handler #4173

tomerd · 2022-02-24T05:19:07Z

motivation: allow clients of SwiftPM to cancel background activities

changes:

introduce new "cancellator" utility that is a registry for cancellation handlers
use the "cancellator" instead of ProcessSet to manage the cancellation of active processes (eg git, tests) and build system
add cancel method to GitRepositoryProvider protocol so that it can be interuppted
add cancel methods to RepositoryManager, RegistryDownloadManager and HTTPClient so that it can be interrupted
change workspace initializer to take a terminator so that CLI and other consumer of libSwiftPM can interrupt
register interruption points mentioned above in workspace
adjust related call sites, ie CLI signal handler now uses the workspace terminator to interrupt
add tests

rdar://64900054
rdar://63723896

Sources/Basics/Terminator.swift

Sources/SPMTestSupport/GitRepositoryExtensions.swift

abertelrud · 2022-02-28T19:05:23Z

Sources/Commands/SwiftTool.swift

@@ -430,8 +424,7 @@ public class SwiftTool {

                // Terminate all processes on receiving an interrupt signal.
                DefaultPluginScriptRunner.cancelAllRunningPlugins()


Looking forward to replacing this line with the new API you're adding (in a follow-on PR)! :)

happy to try and do a follow up PR for that, need to learn more about how plugin cancellation could work

abertelrud

This looks great!

tomerd · 2022-03-01T19:52:43Z

@swift-ci please smoke test

tomerd · 2022-03-01T20:48:08Z

Sources/Basics/Cancellator.swift

+
+public typealias CancellationHandler = (DispatchTime) throws -> Void
+
+public class Cancellator: Cancellable {


Originally was named "terminator" which is cute but less accurate. Happy to take suggestions for a nicer name

tomerd · 2022-03-01T22:11:18Z

@swift-ci please smoke test

tomerd · 2022-03-01T23:18:23Z

@swift-ci please smoke test

tomerd · 2022-03-02T00:54:40Z

@abertelrud this is ready for review

@compnerd could you help make sure this builds / works on Windows

compnerd

Delta: ~30KiB
Basics.dll: 276,992 -> 297,984
Commands.dll: 5,531,648 -> 5,532,672
Workspace.dll: 1,356,800 -> 1,3564,992

I'll play around with it itself to see if there are any issues, though I suspect not.

Sources/Commands/SwiftTool.swift

tomerd · 2022-03-02T01:37:03Z

@swift-ci please smoke test

tomerd · 2022-03-04T00:43:43Z

@swift-ci please smoke test

tomerd · 2022-03-05T01:03:32Z

@swift-ci please smoke test

abertelrud · 2022-03-07T18:43:54Z

Sources/Basics/Archiver+Zip.swift

        }

+        /*


left-over debugging?

motivation: allow clients of SwiftPM to terminate background activities changes: * introduce new terminator class that is a registry for termination handlers * use the terminator instad of ProcessSet to manage the termination of active processes (eg git, tests) and build system * add cancel method to GitRepositoryProvider protocol so that it can be interuppted * add cancel methods to RepositoryManager, RegistryDownloadManager and HTTPClient so that it can be interuppted * change workspace initializer to take a terminator so that CLI and other consumer of libSwiftPM can interrupt * register intrupption points mentioned above in workspace * adjust related call sites, ie CLI signal handler now uses the workspace terminator to interuupt * add tests rdar://64900054 rdar://63723896

tomerd · 2022-03-07T19:32:31Z

@swift-ci please smoke test

compnerd · 2022-03-12T17:27:03Z

This seemed to have dropped the Windows fixes and has broken the windows build: https://ci-external.swift.org/job/oss-swift-windows-toolchain-x86_64-vs2019/1130/console

This reverts commit a1c8482.

This reverts commit c948a86.

* Revert "Revert "cancellation handler (#4173)"" This reverts commit c948a86. * windows fix

tomerd requested review from abertelrud, neonichu and elsh as code owners February 24, 2022 05:19

tomerd added the WIP Work in progress label Feb 24, 2022

tomerd changed the title ~~termination handler~~ [wip] termination handler Feb 24, 2022

tomerd force-pushed the feature/interrupt branch from 297ec80 to d64126c Compare February 24, 2022 05:20

tomerd mentioned this pull request Feb 24, 2022

move global functions to a namespace #4174

Merged

tomerd force-pushed the feature/interrupt branch 4 times, most recently from 6ff0d9a to ff62b8b Compare February 24, 2022 05:39

abertelrud reviewed Feb 24, 2022

View reviewed changes

Sources/Basics/Terminator.swift Outdated Show resolved Hide resolved

abertelrud reviewed Feb 24, 2022

View reviewed changes

Sources/Basics/Terminator.swift Outdated Show resolved Hide resolved

abertelrud reviewed Feb 24, 2022

View reviewed changes

Sources/SPMTestSupport/GitRepositoryExtensions.swift Outdated Show resolved Hide resolved

tomerd force-pushed the feature/interrupt branch 3 times, most recently from 05e5d6f to 1ddac2a Compare February 24, 2022 23:02

tomerd mentioned this pull request Feb 25, 2022

improve repository manager lookup concurrency control #4177

Merged

tomerd force-pushed the feature/interrupt branch 2 times, most recently from 4eef326 to f99b761 Compare February 26, 2022 01:26

abertelrud reviewed Feb 28, 2022

View reviewed changes

abertelrud approved these changes Feb 28, 2022

View reviewed changes

tomerd force-pushed the feature/interrupt branch 2 times, most recently from 5112b06 to 4aece57 Compare March 1, 2022 02:33

tomerd mentioned this pull request Mar 1, 2022

refactor how plugins call the build system when using the CLI #4185

Merged

tomerd force-pushed the feature/interrupt branch 3 times, most recently from d529594 to 3fc7a50 Compare March 1, 2022 19:46

tomerd changed the title ~~[wip] termination handler~~ termination handler Mar 1, 2022

tomerd changed the title ~~termination handler~~ cancellation handler Mar 1, 2022

tomerd added ready Author believes the PR is ready to be merged & any feedback has been addressed and removed WIP Work in progress labels Mar 1, 2022

tomerd commented Mar 1, 2022

View reviewed changes

tomerd force-pushed the feature/interrupt branch from e42de3a to a322bf7 Compare March 1, 2022 23:18

compnerd reviewed Mar 2, 2022

View reviewed changes

Sources/Commands/SwiftTool.swift Show resolved Hide resolved

tomerd self-assigned this Mar 3, 2022

tomerd force-pushed the feature/interrupt branch from c961e2c to 0041ad0 Compare March 4, 2022 00:43

tomerd force-pushed the feature/interrupt branch from 0041ad0 to c138638 Compare March 5, 2022 01:03

abertelrud reviewed Mar 7, 2022

View reviewed changes

tomerd force-pushed the feature/interrupt branch from c138638 to ead18a6 Compare March 7, 2022 19:32

tomerd added 2 commits March 7, 2022 11:32

skip signal tests on linux / docker

680e9ea

tomerd force-pushed the feature/interrupt branch from ead18a6 to 680e9ea Compare March 7, 2022 19:32

neonichu approved these changes Mar 11, 2022

View reviewed changes

tomerd merged commit a1c8482 into swiftlang:main Mar 11, 2022

compnerd added a commit that referenced this pull request Mar 12, 2022

Revert "cancellation handler (#4173)"

3d28dc9

This reverts commit a1c8482.

compnerd mentioned this pull request Mar 12, 2022

Revert "cancellation handler" #4209

Merged

compnerd added a commit that referenced this pull request Mar 12, 2022

Revert "cancellation handler (#4173)"

c948a86

This reverts commit a1c8482.

tomerd added a commit that referenced this pull request Mar 13, 2022

Revert "Revert "cancellation handler (#4173)""

840c3d2

This reverts commit c948a86.

tomerd mentioned this pull request Mar 13, 2022

cancellation handler #4211

Merged

tomerd added a commit that referenced this pull request Mar 13, 2022

cancellation handler (#4211)

ae35ad7

* Revert "Revert "cancellation handler (#4173)"" This reverts commit c948a86. * windows fix

		@@ -430,8 +424,7 @@ public class SwiftTool {

		// Terminate all processes on receiving an interrupt signal.
		DefaultPluginScriptRunner.cancelAllRunningPlugins()


		public typealias CancellationHandler = (DispatchTime) throws -> Void

		public class Cancellator: Cancellable {

cancellation handler #4173

cancellation handler #4173

Uh oh!

Conversation

tomerd commented Feb 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abertelrud Feb 28, 2022

Choose a reason for hiding this comment

Uh oh!

tomerd Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

abertelrud left a comment

Choose a reason for hiding this comment

Uh oh!

tomerd commented Mar 1, 2022

Uh oh!

tomerd Mar 1, 2022

Choose a reason for hiding this comment

Uh oh!

tomerd commented Mar 1, 2022

Uh oh!

tomerd commented Mar 1, 2022

Uh oh!

tomerd commented Mar 2, 2022

Uh oh!

compnerd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tomerd commented Mar 2, 2022

Uh oh!

tomerd commented Mar 4, 2022

Uh oh!

tomerd commented Mar 5, 2022

Uh oh!

abertelrud Mar 7, 2022

Choose a reason for hiding this comment

Uh oh!

tomerd Mar 7, 2022

Choose a reason for hiding this comment

Uh oh!

tomerd commented Mar 7, 2022

Uh oh!

compnerd commented Mar 12, 2022

Uh oh!

Uh oh!

tomerd commented Feb 24, 2022 •

edited

Loading