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

Improve setup checks API #41311

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Improve setup checks API #41311

merged 2 commits into from
Nov 7, 2023

Conversation

come-nc
Copy link
Contributor

@come-nc come-nc commented Nov 6, 2023

Summary

The idea here is to avoid using the name as a key in the array as the name of setup checks is translated.
Before:

{
    "dav": {
        "Checking for DAV system address book": {
            "severity": "success",
            "description": "No outstanding DAV system address book sync.",
            "linkToDoc": null
        }
    },
    "security": {
        "Checking for old user imported certificate": {
            "severity": "success",
            "description": null,
            "linkToDoc": null
        },
        "Code integrity": {
            "severity": "info",
            "description": "Integrity checker has been disabled. Integrity cannot be verified.",
            "linkToDoc": null
        },

After:

{
    "dav": {
        "OCA\\DAV\\SetupChecks\\NeedsSystemAddressBookSync": {
            "name": "Checking for DAV system address book",
            "severity": "success",
            "description": "No outstanding DAV system address book sync.",
            "linkToDoc": null
        }
    },
    "security": {
        "OCA\\Settings\\SetupChecks\\CheckUserCertificates": {
            "name": "Checking for old user imported certificate",
            "severity": "success",
            "description": null,
            "linkToDoc": null
        },
        "OCA\\Settings\\SetupChecks\\CodeIntegrity": {
            "name": "Code integrity",
            "severity": "info",
            "description": "Integrity checker has been disabled. Integrity cannot be verified.",
            "linkToDoc": null
        },

Checklist

@come-nc come-nc added the 2. developing Work in progress label Nov 6, 2023
@come-nc come-nc added this to the Nextcloud 28 milestone Nov 6, 2023
@come-nc come-nc self-assigned this Nov 6, 2023
@come-nc come-nc changed the base branch from master to feat/migrate-more-setup-checks November 6, 2023 15:25
@come-nc come-nc changed the title Fix/improve setup checks api Improve setup checks API Nov 6, 2023
@blizzz blizzz mentioned this pull request Nov 6, 2023
@come-nc come-nc force-pushed the feat/migrate-more-setup-checks branch 3 times, most recently from bd59ffc to 00d3856 Compare November 7, 2023 11:25
@come-nc come-nc force-pushed the fix/improve-setup-checks-api branch from e2691df to 2a12f0b Compare November 7, 2023 13:09
Keys for check results are not locale dependent anymore, the name of the
 setup check is instead stored in the setup result object.

Signed-off-by: Côme Chilliet <[email protected]>
@come-nc come-nc force-pushed the fix/improve-setup-checks-api branch from 2a12f0b to 86290dd Compare November 7, 2023 13:15
Base automatically changed from feat/migrate-more-setup-checks to master November 7, 2023 13:21
@come-nc come-nc marked this pull request as ready for review November 7, 2023 13:33
@come-nc come-nc added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Nov 7, 2023
@susnux susnux added the bug label Nov 7, 2023
@come-nc come-nc merged commit 3e6642a into master Nov 7, 2023
@come-nc come-nc deleted the fix/improve-setup-checks-api branch November 7, 2023 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review Waiting for reviews bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants