1848414 - Make update specific changes necessary for channel-prefs.js to be removed on macOS

Status: RESOLVED FIXED

(Toolkit :: Application Update, task, P1)

Description

[Robin Steuber (they/them) [:bytesized]]

There are a number of update-specific things that need to be changed in order to get rid of channel-prefs.js on macOS, as we are doing in Bug 1799332. I plan to write the necessary code here and mark the patches as being dependent on the patches for that bug to make it easy to land all the code at the same time.

This is likely not comprehensive, but here are the changes that I currently know of that need to be made:

1. I believe that this test ought to be removed.
2. I think that we want this to not be present on macOS. I'm not entirely sure what the best way to do that is. Maybe remove it and add it back in if we aren't on macOS?
3. Currently, when we build MAR files, we have special handling for channel-prefs.js such that that file will be added to the installation only if it doesn't already exist. This mechanism should be removed on macOS and, I suspect, changed to handle the new mechanism added in D184711.

Comment 1

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/1b5ef137cebb
Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/7cd7ae05dbc9
Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/7673f4d7ec84
Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/48b37c9e3431
Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 5

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 6

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Remove verifyChannelPrefsFile test r=nalexander!

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/d116ef9bc280
Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/1229df3b7698
Make update-specific changes for removing channel-prefs on macOS r=nalexander,spohl

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/2fdc92f12d2a
Remove verifyChannelPrefsFile test r=nalexander
https://hg.mozilla.org/projects/pine/rev/41046d80466d
Add updater argument --channels-allowed r=nalexander!
https://hg.mozilla.org/projects/pine/rev/c4e09755c86f
On update, don't overwrite existing ChannelPrefs or UpdateSettings Frameworks r=bhearsum!,nalexander!
https://hg.mozilla.org/projects/pine/rev/a8767b27a588
Change updater-xpcshell to have the update channel xpcshell-test r=nalexander!,spohl!
https://hg.mozilla.org/projects/pine/rev/fd02bf143d9e
Change gTestFiles to accommodate the UpdateSettings and ChannelPrefs Frameworks r=nalexander!
https://hg.mozilla.org/projects/pine/rev/4cb58ab02a7a
Replace lookups of gTestFile entries with getTestFileByName r=nalexander!
https://hg.mozilla.org/projects/pine/rev/6a8ab703d775
Update macOS test MARs to contain the new Frameworks r=nalexander!

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/b1e89bbc7f72
Add an UpdateSettings Framework that intentionally has the wrong channel for testing r=spohl!
https://hg.mozilla.org/projects/pine/rev/26c10fe17fb5
Don't use update-settings.ini in tests on macOS r=nalexander!
https://hg.mozilla.org/projects/pine/rev/67197de01200
Remove verifyChannelPrefsFile test r=nalexander!
https://hg.mozilla.org/projects/pine/rev/cf071297b3d3
Add updater argument --channels-allowed r=nalexander!
https://hg.mozilla.org/projects/pine/rev/175fbfbadb80
On update, don't overwrite existing ChannelPrefs or UpdateSettings Frameworks r=bhearsum!,nalexander!
https://hg.mozilla.org/projects/pine/rev/aeefb60da53c
Change gTestFiles to accommodate the UpdateSettings and ChannelPrefs Frameworks r=nalexander!
https://hg.mozilla.org/projects/pine/rev/32448627bf1f
Replace lookups of gTestFile entries with getTestFileByName r=nalexander!
https://hg.mozilla.org/projects/pine/rev/025154c80e06
Update macOS test MARs to contain the new Frameworks r=nalexander!

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/projects/pine/rev/a46241f2ee5d
Add an UpdateSettings Framework that intentionally has the wrong channel for testing r=spohl!
https://hg.mozilla.org/projects/pine/rev/69a35ea8487d
Don't use update-settings.ini in tests on macOS r=nalexander!
https://hg.mozilla.org/projects/pine/rev/ef6d6828a74e
Remove verifyChannelPrefsFile test r=nalexander!
https://hg.mozilla.org/projects/pine/rev/4998f9f385fd
Add updater argument --channels-allowed r=nalexander!
https://hg.mozilla.org/projects/pine/rev/cd5ea111515c
On update, don't overwrite existing ChannelPrefs or UpdateSettings Frameworks r=bhearsum!,nalexander!
https://hg.mozilla.org/projects/pine/rev/2047e12a5a00
Change gTestFiles to accommodate the UpdateSettings and ChannelPrefs Frameworks r=nalexander!
https://hg.mozilla.org/projects/pine/rev/07d121df5b06
Replace lookups of gTestFile entries with getTestFileByName r=nalexander!
https://hg.mozilla.org/projects/pine/rev/d6cfd11ae520
Update macOS test MARs to contain the new Frameworks r=nalexander!

Comment 12

[Robin Steuber (they/them) [:bytesized]]

I'm having trouble making progress on the failed: 39 error that I'm getting, as mentioned on Slack. You asked me to needinfo to remind you about it.

Comment 13

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Add an UpdateSettings Framework that intentionally has the wrong channel for testing r=spohl!

Comment 14

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Don't use update-settings.ini in tests on macOS r=nalexander!

Since this file is no longer used on macOS, the tests do not need to copy it into place.

Depends on D198895

Comment 15

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Add updater argument --channels-allowed r=nalexander!

Given that (a) it is no longer possible to easily inspect the Update Settings file and (b) it is intentionally possible to swap out Update Settings frameworks, I anticipate that in the future we may want a way to determine what channels the updater will accept. Thus, I think it is a good idea to add an easy way to make the updater output this information.

Depends on D196626

Comment 16

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - On update, don't overwrite existing ChannelPrefs or UpdateSettings Frameworks r=bhearsum!,nalexander!

Depends on D198897

Comment 17

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Change gTestFiles to accommodate the UpdateSettings and ChannelPrefs Frameworks r=nalexander!

Those files are now in a different location and one of them (UpdateSettings) will already exist rather than needing to be created.

A few other changes are also made here:

• Currently, when we need to make changes to a gTestFiles entry, we access it by index, which is both unreadable (how is anyone supposed to know what gTestFiles[13] refers to?) and a maintenance nightmare (adding an item to the list in the wrong position potentially screws up all the indicies and now a bunch of the tests are making changes to the wrong gTestFiles entry). To improve this, I added getTestFileByName so that, for example, gTestFiles[gTestFiles.length - 1] can be replaced with getTestFileByName(FILE_CHANNEL_PREFS).
• Two extra (optional) properties added to gTestFiles entries: existingFile and removeOriginalFile. existingFile == true indicates that the file exists already and doesn't need to be created. removeOriginalFile is only relevant if existingFile == true, and it causes the file to be removed rather than retained. If existingFile && !removeOriginalFile, compareContents will be automatically set to the current file contents if it (and compareFile) is unset, as will comparePerms to ensure that the update process doesn't change the file.
• setUpdateSettingsUseWrongChannel was added to make it easier to set the wrong update channel either via the INI file (on non-Mac) or via the Framework (on Mac).

Depends on D198898

Comment 18

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Replace lookups of gTestFile entries with getTestFileByName r=nalexander!

Depends on D198899

Comment 19

[Robin Steuber (they/them) [:bytesized]]

Attachment: Bug 1848414 - Update macOS test MARs to contain the new Frameworks r=nalexander!

Depends on D198900

Comment 20

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/62ab286ed401
Add an UpdateSettings Framework that intentionally has the wrong channel for testing r=spohl
https://hg.mozilla.org/integration/autoland/rev/d711a830a93e
Don't use update-settings.ini in tests on macOS r=nalexander,application-update-reviewers
https://hg.mozilla.org/integration/autoland/rev/f81e80cf062f
Remove verifyChannelPrefsFile test r=nalexander,spohl,application-update-reviewers
https://hg.mozilla.org/integration/autoland/rev/ff5f23856542
Add updater argument --channels-allowed r=nalexander,application-update-reviewers
https://hg.mozilla.org/integration/autoland/rev/2f4044201b9a
On update, don't overwrite existing ChannelPrefs or UpdateSettings Frameworks r=bhearsum,nalexander
https://hg.mozilla.org/integration/autoland/rev/672c3f18cb8b
Change gTestFiles to accommodate the UpdateSettings and ChannelPrefs Frameworks r=nalexander,application-update-reviewers
https://hg.mozilla.org/integration/autoland/rev/5c6748ef5865
Replace lookups of gTestFile entries with getTestFileByName r=nalexander,application-update-reviewers
https://hg.mozilla.org/integration/autoland/rev/c676fc5d89bc
Update macOS test MARs to contain the new Frameworks r=nalexander,application-update-reviewers

Comment 21

[Cristina Horotan [:chorotan]]

https://hg.mozilla.org/mozilla-central/rev/62ab286ed401
https://hg.mozilla.org/mozilla-central/rev/d711a830a93e
https://hg.mozilla.org/mozilla-central/rev/f81e80cf062f
https://hg.mozilla.org/mozilla-central/rev/ff5f23856542
https://hg.mozilla.org/mozilla-central/rev/2f4044201b9a
https://hg.mozilla.org/mozilla-central/rev/672c3f18cb8b
https://hg.mozilla.org/mozilla-central/rev/5c6748ef5865
https://hg.mozilla.org/mozilla-central/rev/c676fc5d89bc