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.

Sign up for GitHub

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

Jump to bottom

Manifest Validation Fails on HighResolutionIconURL and IconURL Errors #590

Open
TCourtneyOwen opened this issue Dec 2, 2020 · 15 comments
Open

Manifest Validation Fails on HighResolutionIconURL and IconURL Errors #590

TCourtneyOwen opened this issue Dec 2, 2020 · 15 comments
Labels
needs triage

Comments

@TCourtneyOwen
Copy link
Collaborator

Expected behavior

manifest validation should pass

Please describe the behavior you were expecting

Current behavior

Running "npm run validate" on the default project manifest returns the following:

Error # 1:
High Resolution Icon URL Unreachable: Unable to retrieve an image from the high resolution icon URL.

Error # 2:
Icon URL Unreachable: Unable to retrieve an image from the icon URL.
@TCourtneyOwen
Copy link
Collaborator Author

I have contacted the team in Ireland that owns this validation service and let them know about the problem. Here's the gist of my mail:

I really think we need to make a fix here quickly to not fail on localhost icon urls. The validation service already allows localhost SourceLocation so it makes sense that we would allow localhost for the other manifest settings as well.

I will update this issue when I hear more.

-Courtney

@TCourtneyOwen TCourtneyOwen mentioned this issue Dec 2, 2020
Closed
@TCourtneyOwen
Copy link
Collaborator Author

@jfoclpf @RipkensLar @questicles Adding you to this issue thread as you commented on a thread about different validation issue, but were actually encountering this issue

TCourtneyOwen added a commit to TCourtneyOwen/Office-Addin-Scripts that referenced this issue Dec 2, 2020
@TCourtneyOwen
Disable manifest validation tests until validation issue fixed
8ad65ce 
- OfficeDev/generator-office#590 tracks an issue with manifest validation, which I believe is a bug. I have contacted OMEX about the behavior and suggested they fix it. Several customers have also contacted us about this issue so it's becoming a real problem
- Once the issue is fixed, we will re-enable the tests, but for now we should disable these tests because it will cause our CI loops to fail for all other changes made to Office-Addin-Scripts
- I will open a VSO bug to track re-enabling the tests once the validation issue is fixed
@TCourtneyOwen TCourtneyOwen mentioned this issue Dec 2, 2020
Merged
@jfoclpf
Copy link

jfoclpf commented Dec 3, 2020

Thanks @TCourtneyOwen but just to let you know that I am having the same error and I am not using localhost, but a normal host. So I suppose that this error is not related to the type of host.

@TCourtneyOwen
Copy link
Collaborator Author

TCourtneyOwen commented Dec 3, 2020 •
edited
Loading

I grabbed a couple image icons off the internet and the following worked for Excel, Word and PowerPoint add-ins:

image

Manifest validation passes with a 32x32 image for the IconUrl and a 64x64 image for the HighResolutionUrl, and I am subsequently able to upload to the add-in the to Admin Center.

For Outlook add-ins, however, the expected dimensions are different and requires image sizes of 64x64 for the IconUrl and 128x128 for the HighResolutionUrl

So it looks like we have multiple issues here:

  • localhost urls will never work, regardless of size - this is a bug in the validation service in my opinion
  • the project templates are providing incorrect asset image sizes and the manifests are citing incorrect image sizes based on the recent changes in the validation service - if the validation service is in fact correct, then we need to update the asset images to include a 64x64 image and a 128x128 image for Outlook (currently there are only 16x16, 32x32, and 80x80) and update the manifest to use the correct image size depending on the which host the project is intended for.

@jfoclpf I was in fact able to get validation to pass when using non-localhost images as long as I used the correct size as cited above

TCourtneyOwen added a commit to OfficeDev/Office-Addin-Scripts that referenced this issue Dec 3, 2020
@TCourtneyOwen
Disable manifest validation tests until validation issue fixed (#349)
99fc54e 
- OfficeDev/generator-office#590 tracks an issue with manifest validation, which I believe is a bug. I have contacted OMEX about the behavior and suggested they fix it. Several customers have also contacted us about this issue so it's becoming a real problem
- Once the issue is fixed, we will re-enable the tests, but for now we should disable these tests because it will cause our CI loops to fail for all other changes made to Office-Addin-Scripts
- I will open a VSO bug to track re-enabling the tests once the validation issue is fixed
@dimitri-bourreau dimitri-bourreau mentioned this issue Dec 3, 2020
Closed
3 tasks
@jfoclpf
Copy link

jfoclpf commented Dec 3, 2020

Thank you very much @TCourtneyOwen
I will check it tomorrow taking this into account:

Manifest validation passes with a 32x32 image for the IconUrl and a 64x64 image for the HighResolutionUrl

@aafvstam
Copy link
Contributor

aafvstam commented Dec 4, 2020

This is what the documentation mentions:
IconUrl

the image specified must be 32 x 32 pixels. For mail apps, the recommended image resolution is 64 x 64 pixels.

HighResolutionIconUrl

the recommended image resolution is 64 x 64 pixels. For mail apps, the image must be 128 x 128 pixels

I tested with (non localhost):
32x32
64x64
128x128

And indeed 'non mail' i.e. Outlook validates ok with 32 and 64:
<IconUrl DefaultValue="https://cdn4.iconfinder.com/data/icons/32x32-free-design-icons/32/Info.png"/>
<HighResolutionIconUrl DefaultValue="https://png-5.findicons.com/files/icons/201/batman/64/logo.png"/>

Mail app i.e. Outlook validates ok with 64 and 128:
<IconUrl DefaultValue="https://png-5.findicons.com/files/icons/201/batman/64/logo.png"/>
<HighResolutionIconUrl DefaultValue="https://icons.iconarchive.com/icons/oxygen-icons.org/oxygen/128/Apps-preferences-desktop-icons-icon.png"/>

  • For this the Outlook Template should get the missing 64 and 128 pixel images
  • To match the documentation above I'd recommend using the 64 for non mail vs 80

I am currently looking into editing the repo and testing the changes ...

@TCourtneyOwen
Copy link
Collaborator Author

We are updating the templates today with the new images and manifest updates. However, this will not address the fact that validation fails for localhost, as this is an issue with the validation service, which our templates simply call

-Courtney

@arttarawork
Copy link
Contributor

We have updated the package we use for manifest validation. Please try using it!

office-addin-manifest: next: 1.5.12

https://github.com/OfficeDev/Office-Addin-Scripts/tree/master/packages/office-addin-manifest

@neittien0110
Copy link

In my case, I have uploaded a manifest to Microsoft Partner Center but two similar errors are shown
image

However, when I validated that manifest at my laptop, it was successfully. So confused.
Please help me. Many thanks.

Below is the successful validation result

The manifest is valid.


Additional information: 
Package Type Identified: Package of your add-in was parsed successfully.

Correct Package: Your package matches the submission type.

Valid Manifest Schema: Your manifest does adhere to the current set of XML schema definitions for Add-in manifests.

Manifest Version Correct Structure: The manifest version number has the correct structure for the platform that it supports.

Manifest Version Correct Value: The manifest version number is greater or equal to 1.0.

Manifest ID Valid Prefix: The product ID in the manifest has a valid prefix
  - Details: 123411f0-9b74-47e5-a79a-7c31d844b2bf

Manifest ID Correct Structure: The structure of the product ID is correct.
  - Details: 123411f0-9b74-47e5-a79a-7c31d844b2bf

Desktop Source Location Present: A desktop or default source location URL is found.

Secure Desktop Source Location: The manifest desktop source location URLs use HTTPS.

Supported Office Identified: Supported Office products were successfully determined.

Support URL Present: The manifest support URL is present.
  - Details: https://users.soict.hust.edu.vn/sinno/projects/myexcel

Valid Support URL: The manifest support URL is valid.

High Resolution Icon Present: A high resolution icon element was expected and is present.
  - Details: https://users.soict.hust.edu.vn/sinno/projects/myexcel/assets/icon-64.png

Supported High Resolution Icon URL File Extension: The manifest high resolution icon URL has a valid image file extension.
  - Details: png

Secure High Resolution Icon URL: The manifest high resolution icon URL uses HTTPS.
  - Details: https://users.soict.hust.edu.vn/sinno/projects/myexcel/assets/icon-64.png

Correct High Resolution Icon Dimensions: The manifest high resolution icon dimensions are correct.

Icon Present: A icon element was expected and is present.
  - Details: https://users.soict.hust.edu.vn/sinno/projects/myexcel/assets/icon-32.png

Supported Icon URL File Extension: The manifest icon URL has a valid image file extension.
  - Details: png

The manifest icon URL uses HTTPS.: Secure Icon URL
  - Details: https://users.soict.hust.edu.vn/sinno/projects/myexcel/assets/icon-32.png

Correct Icon Dimensions: The manifest icon dimensions are correct.

@akrantz
Copy link
Collaborator

akrantz commented Jan 11, 2021

@neittien0110 The image is available so I believe that the manifest validation should succeed. I would suggest using the Partner Center to contact them about this.

@aafvstam
Copy link
Contributor

I created a PR to fix the documented recommended icon sizes for the Outlook generator template here: #596
There are several pointers from users running into this issue.

The issue is also avoided by changing the validator to avoid the proper resolution checks but in general that obviously is not really a solution as it still allowed not using the recommended icon resolutions.

@TCourtneyOwen
Copy link
Collaborator Author

@aafvstam I published a new version (1.7.8) of generator-office with the changes from the PR.

-Courtney

@LuceroAuris
Copy link

I had to put the images inside the public folder and from there reference it

@Tom-H2oThermo
Copy link

Tom-H2oThermo commented Apr 13, 2024 •
edited
Loading

I had this same problem with my Excel add-in. It said my icon urls were unreachable, even though I could ctrl click on the url in the manifest and they opened, no problem. I then put them up on an Azure blob, got the link, and tried it again. This time it worked. Also, this time, when it was unhappy with the size, it told me what it was looking for:
image

@servefast-cto
Copy link

servefast-cto commented Dec 20, 2024 •
edited
Loading

Has this been solved i am getting the same error ?

EDIT: actually after updating manifest version it passed. Maybe its a bug when you try to reupload same manifest

@Rick-Kirkham Rick-Kirkham reopened this Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs triage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
10 participants
@akrantz @arttarawork @jfoclpf @aafvstam @neittien0110 @Rick-Kirkham @Tom-H2oThermo @TCourtneyOwen @LuceroAuris @servefast-cto