feat(rust): Redesigned agama logs command to have functionality in the backend and accessible via HTTP API #1720

mchf · 2024-11-01T08:55:24Z

Problem

Agama's CLI logs command used to be implemented with idea CLI running on same machine as real installation (the backend). As this is not true anymore and we have installer's backend and frontend separated with HTTP API, which makes remote access possible, the logs command had to be updated to support this idea.

Its trello card

Solution

the particular code which is in control of collecting logs was moved into agama-lib
agama's web server has contains http(s)://<server_ip>/api/logs piece in its public API
agama's CLI uses the above API for downloading the logs

Testing

Tested manually

coveralls · 2024-11-01T09:15:20Z

Pull Request Test Coverage Report for Build 11708505683

Details

0 of 171 (0.0%) changed or added relevant lines in 6 files are covered.
2 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.06%) to 71.429%

Changes Missing Coverage	Changed/Added Lines	%
rust/agama-cli/src/lib.rs	1	0.0%
rust/agama-lib/src/base_http_client.rs	5	0.0%
rust/agama-lib/src/manager/http_client.rs	16	0.0%
rust/agama-cli/src/logs.rs	23	0.0%
rust/agama-server/src/manager/web.rs	28	0.0%
rust/agama-lib/src/logs.rs	98	0.0%

Files with Coverage Reduction	New Missed Lines	%
rust/agama-cli/src/lib.rs	1	0.0%
rust/agama-cli/src/logs.rs	1	0.0%

Totals
Change from base Build 11707344472:	-0.06%
Covered Lines:	16895
Relevant Lines:	23653

💛 - Coveralls

imobachgs

Thanks! I have a few comments because it looks like there is some duplication.

rust/agama-server/src/web/http.rs

rust/agama-lib/src/base_http_client.rs

rust/agama-lib/src/logs/http_client.rs

rust/agama-cli/src/logs.rs

imobachgs

It looks better now, but I still have a few questions/comments.

rust/package/agama.changes

rust/agama-server/src/manager/web.rs

rust/agama-lib/src/logs.rs

imobachgs · 2024-11-05T07:10:46Z

rust/agama-lib/src/lib.rs

@@ -49,6 +49,7 @@ pub mod error;
 pub mod install_settings;
 pub mod jobs;
 pub mod localization;
+pub mod logs;


I don't know whether this module belongs to agama-cli or agama-server. We can leave it here by now, but I don't think it will be used anywhere else (except of the set_archive_permissions that might belong to agama-lib, but not as something specific to logs).

rust/agama-server/src/manager/web.rs

rust/agama-lib/src/logs.rs

imobachgs

It looks better know, but there is still an issue with the web UI client. Please, check.

web/src/api/manager.ts

imobachgs

It looks almost good. Please, update the agama-web-ui.changes file and that's it. Thanks!

imobachgs · 2024-11-05T23:43:10Z

rust/agama-server/src/manager/web.rs

-        .map_err(|e| ServiceError::CannotGenerateLogs(e.to_string()))?;
+                // See RFC2046, RFC2616 and
+                // https://www.iana.org/assignments/media-types/media-types.xhtml
+                // or /etc/mime.types


I do not now how "standard" is the mime.types (outside of Linux), but we can find it out later.

imobachgs · 2024-11-06T06:16:22Z

web/package/agama-web-ui.changes

+-------------------------------------------------------------------
+Wed Nov  6 06:06:51 UTC 2024 - Michal Filka <mfilka@suse.com>
+
+- url for downloading agama logs adapted to use new HTTP API


Suggested change

- url for downloading agama logs adapted to use new HTTP API

- URL for downloading Agama logs adapted to use new HTTP API

i tried but your eye is too sharp even in the morning ;-)

so http://.../api/logs is now http://.../api/manager/logs

Update to release version 11. * #1495 * #1564 * #1617 * #1618 * #1625 * #1626 * #1627 * #1628 * #1630 * #1631 * #1632 * #1633 * #1634 * #1635 * #1636 * #1639 * #1640 * #1641 * #1642 * #1643 * #1644 * #1645 * #1646 * #1647 * #1648 * #1649 * #1650 * #1651 * #1652 * #1654 * #1655 * #1656 * #1657 * #1660 * #1663 * #1666 * #1667 * #1668 * #1670 * #1671 * #1673 * #1674 * #1675 * #1676 * #1677 * #1681 * #1682 * #1683 * #1684 * #1687 * #1688 * #1689 * #1690 * #1691 * #1692 * #1693 * #1694 * #1695 * #1696 * #1698 * #1699 * #1702 * #1703 * #1704 * #1705 * #1707 * #1708 * #1709 * #1710 * #1711 * #1712 * #1713 * #1714 * #1715 * #1716 * #1717 * #1718 * #1720 * #1721 * #1722 * #1723 * #1727 * #1728 * #1729 * #1731 * #1732 * #1733 * #1734 * #1735 * #1736 * #1737 * #1740 * #1741 * #1743 * #1744 * #1745 * #1746 * #1751 * #1753 * #1754 * #1755 * #1757 * #1762 * #1763 * #1764 * #1765 * #1766 * #1767 * #1769 * #1771 * #1772 * #1773 * #1774 * #1777 * #1778 * #1785 * #1786 * #1787 * #1788 * #1789 * #1790 * #1791 * #1792 * #1793 * #1794 * #1795 * #1796 * #1797 * #1798 * #1799 * #1800 * #1802 * #1803 * #1804 * #1805 * #1807 * #1808 * #1809 * #1810 * #1811 * #1812 * #1814 * #1815 * #1821 * #1822 * #1823 * #1824 * #1825 * #1826 * #1827 * #1828 * #1830 * #1831 * #1832 * #1833 * #1834 * #1835 * #1836 * #1837 * #1838 * #1839 * #1840 * #1841 * #1842 * #1843 * #1844 * #1845 * #1847 * #1848 * #1849 * #1850 * #1851 * #1854 * #1855 * #1856 * #1857 * #1860 * #1861 * #1863 * #1864 * #1865 * #1866 * #1867 * #1871 * #1872 * #1873 * #1875 * #1876 * #1877 * #1878 * #1880 * #1881 * #1882 * #1883 * #1884 * #1885 * #1886 * #1888 * #1889 * #1890

mchf marked this pull request as draft November 1, 2024 08:55

mchf force-pushed the logs_api branch 2 times, most recently from 9f30650 to 991bc61 Compare November 4, 2024 07:48

mchf requested a review from imobachgs November 4, 2024 07:48

mchf marked this pull request as ready for review November 4, 2024 07:48

imobachgs changed the title ~~[CLI, LIB] Redesigned agama logs command to have functionality in the backend and accessible via HTTP API~~ feat(rust): Redesigned agama logs command to have functionality in the backend and accessible via HTTP API Nov 4, 2024

imobachgs requested changes Nov 4, 2024

View reviewed changes

rust/agama-server/src/web/http.rs Outdated Show resolved Hide resolved

rust/agama-lib/src/base_http_client.rs Outdated Show resolved Hide resolved

rust/agama-lib/src/logs/http_client.rs Outdated Show resolved Hide resolved

rust/agama-cli/src/logs.rs Outdated Show resolved Hide resolved

mchf force-pushed the logs_api branch from d23a278 to a116aba Compare November 4, 2024 12:25

mchf requested a review from imobachgs November 5, 2024 07:21

imobachgs requested changes Nov 5, 2024

View reviewed changes

web/src/api/manager.ts Show resolved Hide resolved

mchf force-pushed the logs_api branch from 85f205f to 2110e82 Compare November 5, 2024 19:26

imobachgs approved these changes Nov 5, 2024

View reviewed changes

imobachgs approved these changes Nov 6, 2024

View reviewed changes

mchf force-pushed the logs_api branch from 9c6aada to 6233b49 Compare November 6, 2024 06:27

imobachgs approved these changes Nov 6, 2024

View reviewed changes

mchf added 8 commits November 6, 2024 18:11

Introduced /logs HTTP API

ee654a5

Moved logs compression from CLI to lib, using it in HTTP logs API

af6bedc

Agama CLI uses new HTTP API for downloading logs

c5f5bf6

Cleanup, refactoring and error handling

1ed8573

Formatting

5e432ef

Cleanup, refactoring and error handling on CLI side

97029e2

Implemented HTTP API /logs/list endpoint and used in the CLI

6c1c8fa

Minor improvements.

d9251e1

mchf force-pushed the logs_api branch from 6233b49 to 73ffc9e Compare November 6, 2024 17:11

mchf added 4 commits November 6, 2024 18:11

Updated changelog

ffcb098

Removed unnecessary imports from Cargo

7a4c237

Minor stuff from the review (renaming, ...)

6ed7dfd

Moved new logs HTTP API under /manager

415fd5a

so http://.../api/logs is now http://.../api/manager/logs

mchf added 6 commits November 6, 2024 18:11

Merged logs http client into manager http client

5057ae7

Cleanup and reorganized the code a bit

a3b55db

Adapted logs store api references in web UI

4c9cef4

Fixed typo in changes

49fab1d

Setup correct content type for response carrying logs

3887cf3

Updated changelog

73ffc9e

mchf merged commit a714076 into master Nov 6, 2024
8 checks passed

mchf deleted the logs_api branch November 6, 2024 17:22

imobachgs mentioned this pull request Jan 10, 2025

Update to release 11 #1887

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rust): Redesigned agama logs command to have functionality in the backend and accessible via HTTP API #1720

feat(rust): Redesigned agama logs command to have functionality in the backend and accessible via HTTP API #1720

mchf commented Nov 1, 2024

coveralls commented Nov 1, 2024 •

edited

Loading

imobachgs left a comment

imobachgs left a comment

imobachgs Nov 5, 2024

imobachgs left a comment

imobachgs left a comment

imobachgs Nov 5, 2024

imobachgs Nov 6, 2024

mchf Nov 6, 2024

	- url for downloading agama logs adapted to use new HTTP API
	- URL for downloading Agama logs adapted to use new HTTP API

feat(rust): Redesigned agama logs command to have functionality in the backend and accessible via HTTP API #1720

feat(rust): Redesigned agama logs command to have functionality in the backend and accessible via HTTP API #1720

Conversation

mchf commented Nov 1, 2024

Problem

Solution

Testing

coveralls commented Nov 1, 2024 • edited Loading

Pull Request Test Coverage Report for Build 11708505683

Details

💛 - Coveralls

imobachgs left a comment

Choose a reason for hiding this comment

imobachgs left a comment

Choose a reason for hiding this comment

imobachgs Nov 5, 2024

Choose a reason for hiding this comment

imobachgs left a comment

Choose a reason for hiding this comment

imobachgs left a comment

Choose a reason for hiding this comment

imobachgs Nov 5, 2024

Choose a reason for hiding this comment

imobachgs Nov 6, 2024

Choose a reason for hiding this comment

mchf Nov 6, 2024

Choose a reason for hiding this comment

coveralls commented Nov 1, 2024 •

edited

Loading