The NVDA API endpoint has not provide add-on store metadata and snapshot version

[cary-rowen]

Detailed description of the issue

This may be a work in progress for NV Access, however I open this issue for at least it can be used to track progress.

The reasons are as follows:

1. We noticed that PR Update updateCheck and addonStore URLs to use new NV Access endpoints #17680 has been merged.
2. I submitted the add-on on the weekend Although it has been automatically merged, I observed that the metadata of the add-on store did not provide updates.

• This more or less affects users of stable branches.

3. I am the maintainer of the Chinese community mirroring services. I hope to track the progress of NV Access's API so that we can adjust our mirroring services in a timely manner.

Why are the other templates not appropriate in this case?

This is an API endpoint-related issue

Have you asked for advice on how to report this issue via a community discussion? If so, please link to the discussion

n/a

Steps to reproduce or illustrate the issue (if applicable)

1. Check: https://addonstore.nvaccess.org/en/all/2024.4.2.json
2. Check: https://api.nvaccess.org//nvdaUpdateCheck?autoCheck=False&allowUsageStats=True&version=2024.4.2&versionType=snapshot%3Aalpha

Expected outcome or behaviour (if applicable)

1. Provide the latest add-on store metadata
2. Provide a snapshot version

Screenshots, logs, and other attachments (if applicable)

System configuration or software environment (if applicable)

Additional information (if applicable)

[seanbudd]

Can you please add more information on what the problem is that you are facing?
we had some server downtime over the weekend when deploying our new server infrastructure.
it's unclear what the issues you are raising are - please provide detailed steps to reproduce and include the expected vs actual outcome.

[cary-rowen]

Hi @seanbudd

reproduce Steps:

Checking the Add-on Store Metadata:

1. Visit https://addonstore.nvaccess.org/en/all/2024.4.2.json.
2. Examine the returned JSON data to confirm whether it includes the latest add-on store metadata. For example:

{
    "addonId": "NVDACNMirror",
    "displayName": "NVDA Chinese Community Update Mirror",
    "URL": "https://dl.nvdacn.com/NVDA-Addons/New/NVDACNMirror-0.6.3.nvda-addon",
    ...
    "sha256": "06fe14c721dce045cf75a5a55442efad6ee21c119eb07ec276b132dd9f82a66d",
    "addonVersionName": "0.6.3",
    ...
}

3. Check the latest version of this add-on: https://github.com/nvaccess/addon-datastore/blob/master/addons/NVDACNMirror/0.7.0.json.

Checking the Snapshot Version Information:

1. Visit https://api.nvaccess.org/nvdaUpdateCheck?autoCheck=False&allowUsageStats=True&version=2024.4.2&versionType=snapshot%3Aalpha.
2. Examine the returned data to confirm whether it includes snapshot version information (e.g., the latest snapshot version number, update links, etc.).
3. Alternatively, on NVDA 2024.4.2, use the updateChannel to switch to the alpha channel, go to the "Help" menu, and check for updates.

Expected Results:

• The add-on store metadata API should return the latest add-on information, such as version 0.7.0 of the NVDACN Mirror add-on.
• The snapshot version API should return the latest snapshot version information, including version numbers, update links, etc.
• From the stable version, it should be possible to switch to the Alpha channel using updateChannel and obtain the latest snapshot version.

Actual Results:

• The add-on store metadata API returns outdated data.
• The snapshot version API does not return any snapshot version information.
• From the stable version, it is not possible to switch to the Alpha channel using updateChannel and obtain the latest snapshot version.

[seanbudd]

You're correct - it seems like the add-on is not correctly returning the latest data.

However, update check is working fine for me, returning the latest alpha.
Are you certain the URL you are crafting is the same that comes from NVDA? It looks like a lot of information is missing that is required.
I can't tell you what's going wrong with the updateChannel add-on. We do not support it.

[cary-rowen]

Thanks @seanbudd

You're correct - it seems like the add-on is not correctly returning the latest data.

Could you update it here when this is fixed?

Are you certain the URL you are crafting is the same that comes from NVDA? It looks like a lot of information is missing that is required.

I don't actually know what are the minimum allowable parameters for this API?
I'll investigate it.

Sorry to bother @nvdaes Can you provide more information about updateChannel?

You can read my comments to get the context quickly.

Many thanks

[nvdaes]

@cary-rowen , I am Noelia (nvdaes on GitHub). I'm not the author of that add-on. An organization with a similar name was created on GitHub after the creation of my username, and perhaps this has confused you since the mentioned add-on is hosted on this organization.
cc: @jmdaweb

[cary-rowen]

Sorry @nvdaes I'm making a mistake.
Thank you for helping to cc the correct author.

[seanbudd]

@cary-rowen - the add-on store should be working correctly again. Closing this as fixed