Ghostfolio Widget Broken

[brhahlen]

Description

Ghostfolio has changed their API for getting the portfolio data.
Since then, the widget is broken.

The code refers to currentGrossPerformancePercent (among others,

homepage/src/widgets/ghostfolio/component.jsx

Line 8 in d20ab84

return `${performanceRange.performance.currentGrossPerformancePercent > 0 ? "+" : ""}${t("common.percent", {

), but that has changed to the following:
grossPerformancePercentage

homepage version

v0.8.13 (986a181, May 6, 2024)

Installation method

Docker

Configuration

No response

Container Logs

[2024-01-15T13:46:54.240Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=1y
[2024-01-15T13:46:54.242Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=1d
[2024-01-15T13:46:54.246Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=max
[2024-01-15T13:49:26.089Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=1d
[2024-01-15T13:49:26.094Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=max
[2024-01-15T13:49:26.095Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=1y                                                                                                                                                                                                                     [2024-01-15T13:49:31.048Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=1d
[2024-01-15T13:49:31.079Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=1y                                                                                                                                                                                                                     [2024-01-15T13:49:31.086Z] error: <credentialedProxyHandler> HTTP Error 502 calling https://ghostfolio/api/v2/portfolio/performance?range=max

Browser Logs

No response

Troubleshooting

Not the real numbers :)

$ curl https://ghostfolio/api/v2/portfolio/performance?range=1y -H "Authorization: Bearer BLABLABLA" | jq -r .performance

{
  "currentNetWorth": 123,
  "currentValueInBaseCurrency": 123,
  "grossPerformance": 123,
  "grossPerformancePercentage": 0.10,
  "grossPerformancePercentageWithCurrencyEffect": 0.10,
  "grossPerformanceWithCurrencyEffect": 123.31,
  "netPerformance": 123.06,
  "netPerformancePercentage": 0.09,
  "netPerformancePercentageWithCurrencyEffect": 0.09,
  "netPerformanceWithCurrencyEffect": 123.58,
  "totalInvestment": 123.05
}

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

Based on the information provided, it appears that the Ghostfolio API has undergone changes that affect the data fields used by the homepage widget. Specifically, the field currentGrossPerformancePercent has been changed to grossPerformancePercentage. To resolve the issue with the widget, the code within the homepage application that references the old field name needs to be updated to use the new field name.

Given that you are using homepage version v0.8.13, you should check if there has been an update or patch provided by the homepage developers that addresses this API change. If such an update exists, you should apply it to your installation. If not, you may need to manually update the widget code or wait for an official update from the homepage team.

For the HTTP Error 502 you are encountering, this indicates a Bad Gateway error, which suggests that the homepage application is having trouble communicating with the Ghostfolio API. This could be due to the API endpoint changes or other network-related issues.

To troubleshoot further, you should:

1. Verify that the Ghostfolio API endpoint is correct and accessible from the homepage application.
2. Ensure that the Bearer token used for authentication is valid and has not expired.
3. Check the homepage application logs for more detailed error messages that could indicate the cause of the communication issue.
4. Review the homepage documentation and any recent changelogs for updates related to Ghostfolio widget integration.

If you are unable to resolve the issue on your own, consider reaching out to the homepage support community or filing an issue on the homepage GitHub repository to seek assistance from the developers.

This comment was generated by Glime.

[brhahlen]

Just to add: I've tried to fix this in the container, but I wasn't able to get the correct output, so I'm definitely doing something wrong there...

[shamoon]

Why projects love a breaking change idk. Do you have a link to documentation of this? I don’t see it mentioned in their recent releases

[brhahlen]

It was this commit: ghostfolio/ghostfolio@f2cb671
I think it was part of this release: https://github.com/ghostfolio/ghostfolio/releases/tag/2.79.0

[shamoon]

Thanks. IMHO an issue should be raised there. This is a major breaking change to the API with almost no mention and without a major version bump. I’m not sure they’ll be interested in mitigating it of course

[brhahlen]

Agreed, will drop something on their GH

[shamoon]

See #3471

A container with the fix should be built in ~20 minutes or so if you want to test it out

[brhahlen]

Thanks! Will test it out, not sure if I'll get around it today, but will let you know!

[brhahlen]

Tested and works! Thanks for the quick turnaround!

[github-actions[bot]]

This discussion has been automatically closed because it was marked as answered. See our contributing guidelines for more details.