On 11/3/2020 1:45 PM, Eric Sunshine wrote:
> On Tue, Nov 3, 2020 at 9:05 AM Derrick Stolee via GitGitGadget
> <gitgitgadget@xxxxxxxxx> wrote:
>> maintenance: use launchctl on macOS
>
> A few comments below (not necessarily worth a re-roll)...
>
>> The launchctl command needs to be aligned with a user id in order
>> to initialize the command environment. This must be done using
>> the 'launchctl bootstrap' subcommand. This subcommand is new as
>> of macOS 10.11, which was released in September 2015. Before that
>> release the 'launchctl load' subcommand was recommended. The best
>> source of information on this transition I have seen is available
>> at [2].
>
> It's not clear whether or not this is saying that git-maintenance will
> dynamically adapt to work with modern and older 'launchctl'. A glance
> at the actual code reveals that it knows only about modern
> 'bootstrap'. Perhaps this could be a bit clearer by saying that it
> only supports modern versions, and that support for older versions can
> be added later if needed. (For those of us who are stuck with 10-20
> year old hardware and OS versions, 2015 isn't that long ago.)
Yes, this is a strange place to be. How far do we go back to support
as many users as possible? How many users will be simultaneously
stuck on an old version of macOS _and_ interested in updating to this
latest version of Git? Is that worth the extra functionality to detect
the the OS version and change commands?
The good news is that this patch doesn't lock us in to the
boot(strap|out) subcommands too much. We could add in load/unload
subcommands for systems that are too old. However, I did think it
was prudent to take the currently-recommended option for fear that
Apple will completely _delete_ the load/unload options in an
upcoming release.
This makes me realize that I should update the documentation to give
pointers for how to view the schedules for each platform:
- Windows: Open "Task Scheduler"
- macOS: 'launchctl list | grep org.git-scm.git'
- Others: 'crontab -l'
>> +static int bootstrap(const char *filename)
>> +{
>> + int result;
>> + struct strvec args = STRVEC_INIT;
>> + char *uid = get_uid();
>> + const char *launchctl = getenv("GIT_TEST_CRONTAB");
>> + if (!launchctl)
>> + launchctl = "/bin/launchctl";
>> +
>> + strvec_split(&args, launchctl);
>> + strvec_push(&args, "bootstrap");
>> + strvec_pushf(&args, "gui/%s", uid);
>> + strvec_push(&args, filename);
>> +
>> + result = run_command_v_opt(args.v, 0);
>> +
>> + strvec_clear(&args);
>> + free(uid);
>> + return result;
>> +}
>
> The bootout() and bootstrap() functions seem to be identical except
> for one string literal. Code could be reduced by refactoring and
> passing that string literal in as an argument.
Good point. Or a simple boolean value for "add" or "remove".
>> +static int remove_plist(enum schedule_priority schedule)
>> +{
>> + const char *frequency = get_frequency(schedule);
>> + char *name = get_service_name(frequency);
>> + char *filename = get_service_filename(name);
>> + int result = bootout(filename);
>> + free(filename);
>> + free(name);
>> + return result;
>> +}
>
> The result of get_service_name() is only ever passed to
> get_service_filename(). If get_service_filename() made the call to
> get_service_name() itself, it would free up callers from having to
> remember to free(name), thus reducing the likelihood of a possible
> leak.
You're right. In an earlier version I thought I needed to add the
name in the XML, but it turns out I did not.
>> +static int schedule_plist(const char *exec_path, enum schedule_priority schedule)
>> +{
>> + plist = fopen(filename, "w");
>> +
>> + if (!plist)
>> + die(_("failed to open '%s'"), filename);
>
> You can replace the fopen() and die() with a single call to xfopen().
Thanks! I'll use that in several places and try to remember next time.
>> + /* bootout might fail if not already running, so ignore */
>> + bootout(filename);
>> + if (bootstrap(filename))
>> + die(_("failed to bootstrap service %s"), filename);
>
> I'm guessing that 'launchctl bootout' won't print a confusing and
> unexpected error message if the plist is not presently registered?
You're right, it does. It also returns with a non-zero exit code.
Along with your later suggestion to clear the .plist files, we will
want to have several conditions to not error out during a case where
the task is not scheduled.
>> diff --git a/t/t7900-maintenance.sh b/t/t7900-maintenance.sh
>> @@ -389,12 +389,58 @@ test_expect_success 'stop from existing schedule' '
>> +test_expect_success MACOS_MAINTENANCE 'start and stop macOS maintenance' '
>> + echo "#!/bin/sh\necho \$@ >>args" >print-args &&
>> + chmod a+x print-args &&
>
> Note that $@ loses its special magic if not surrounded by quotes, thus
> acts just like $*. So, either use "$@" or $* depending upon your
> requirements, but in the case of 'echo', it's just not going to matter
> at all, so $* is fine.
>
> To construct the script, you can do this instead, which is easier to
> read and handles the 'chmod' for you:
>
> write_script print-args <<-\EOF
> echo $* >>args
> EOF
TIL. thanks.
>> + for frequency in hourly daily weekly
>> + do
>> + PLIST="$HOME/Library/LaunchAgents/org.git-scm.git.$frequency.plist" &&
>> + grep schedule=$frequency "$PLIST" &&
>> + echo "bootout gui/$UID $PLIST" >>expect &&
>> + echo "bootstrap gui/$UID $PLIST" >>expect || return 1
>> + done &&
>
> My gut feeling is that this would be more robust if you manually
> determine UID in the test script the same way as the git-maintenance
> command itself does using '/usr/bin/id -u' rather than relying upon
> inheriting UID from the user's environment.
Yeah, you're right. Thanks!
>> + # stop does not remove plist files, but boots them out
>
> Is this desirable? Should git-maintenance do a better job of cleaning
> up after itself?
Yes, let's clear up these .plist files.
Thanks!
-Stolee
