Upgraded project version from 0.1.8 to 0.1.9 to reflect recent changes and improvements. This version update ensures proper tracking of these modifications and helps avoid confusion regarding the current state of the project.
Added functionality to mark messages as read after processing events to enhance usability and tracking. Also corrected formatting in help command documentation by fixing escape characters.
Modified the RSS feed error handling to send error messages to the chat room only in debug mode, reducing unnecessary messages for non-debug environments. Incremented project version to 0.1.8 to reflect these updates and improvements.
Enhanced the addfeed command to support an optional --backfill
parameter, allowing users to include all current entries when
bridging a new feed. This provides more flexibility in feed
management and ensures no entries are missed during the initial
setup.
Updated the project version in pyproject.toml to 0.1.7. This release includes minor updates and improvements to enhance stability and performance. No breaking changes were introduced.
Introduced a new 'operator' property to the RSSBot class that retrieves the bot operator's name from the configuration file. Defaults to "your Matrix administrator" if not specified. Enhances configuration clarity and accessibility by allowing easy retrieval of the bot operator information.
Updated the project version from 0.1.5 to 0.1.6 to reflect recent changes and improvements in the codebase. Ensures compatibility and clarity in the project's release management.
Sorted feed entries by published date first, falling back to
updated date if published date is unavailable. This ensures
RSS entries are processed in a consistent temporal order,
improving the accuracy of feed updates and user notifications.
Enhances user experience by adding confirmation messages after removing a feed, whether by index or URL. This improvement helps users quickly verify that their intended action was successfully completed and mitigates confusion about the state of their feeds list.
Added the ability to backfill messages from an RSS feed upon adding it to a room. Users can now add the `--backfill` flag when using the `addfeed` command to retrieve and post historical entries from the feed. This enhancement improves user experience by ensuring no important feed information is missed.
Introduced optional proxy configuration for fetching RSS feeds,
including support for using Tor SOCKS5 proxy for enhanced privacy.
Added properties to manage proxy settings and updated fetch
functionality to utilize the proxy when necessary. This helps route
requests through specified proxies, supporting privacy use cases
like accessing .onion URLs.
Updated the logging statement in the RSSBot class to display room IDs instead of room objects when processing feeds. This change ensures that log entries are more informative and easier to understand, especially when debugging issues related to specific rooms. The inclusion of room IDs aids in quick identification and resolution of problems by providing a clear reference to the affected chat room.
Introduces a GitHub Actions workflow specifically designed for continuous integration and continuous deployment (CI/CD) of Python packages. This workflow triggers on `workflow_dispatch` events and tag pushes, encapsulating processes for setup/testing and publishing the Python package to PyPI. It utilizes a Node 20 Bookworm container for both setup/tests and publication steps, ensuring a consistent environment. Notably, it prepares the Python environment, installs dependencies, builds the package, and then publishes it to PyPI using securely stored PyPI tokens.
This addition streamlines the release process, automating the testing and deployment phases, and thereby enhancing reliability and efficiency in package management and distribution.
Incremented the project version to 0.1.3 to prepare for the release of new functionalities and improvements. This version update signifies the addition of enhancements and possibly minor bug fixes, following our semantic versioning policy. This change is crucial for package management and distribution, ensuring users receive the latest updates and features promptly.
Introduce the ability for users to override the default event type on a per-room basis in the Matrix RSS bot. By adding a new `eventtype` command and updating the help menu to include this command, users can now specify whether messages in a particular room should be sent as "text" or "notice". This feature provides greater flexibility and customization for room administrators, catering to diverse notification preferences and use cases. The implementation does not validate the event type beyond checking for "text" or "notice", ensuring simplicity in usage while relying on user input accuracy.
This change enhances the bot's versatility in different Matrix environments, allowing for more refined control over how feed updates are communicated within rooms.
Added support for configurable event types for sending messages, enabling use of either "text" or "notice" message types as per user preference. Additionally, this update brings along improvements including code cleanup, updated dependencies to improve functionality and fix potential security issues, and reorganization of example configuration files into a more structured directory. Significant refactorings standardize async task creations and remove unused imports, streamlining the codebase for better maintainability and performance.
- Introduced `EventType` in `config.dist.ini` to allow users to specify the desired event type for outbound messages.
- Upgraded dependency versions in `pyproject.toml`, adding `future` for forward compatibility.
- Removed the deprecated `rssbot-pantalaimon.service` and unused image/file send functions in `bot.py`, focusing on core functionalities.
- Reorganized `pantalaimon.example.conf` into `contrib` directory for better project structure.
- Simplified logging and callback handling, removing redundant code paths and improving code readability.
- Bumped project version to 0.1.2, paving the way for new features and fixes.
This enhancement is aimed at providing users with greater flexibility in how messages are sent, accommodating different use cases and preferences.
Added a Dependabot configuration file to automate daily updates for Python packages. This change ensures the project dependencies are regularly checked for updates, encouraging the use of the latest, most secure versions of dependencies. Regular updates help to maintain the project's security posture and reduce the risk of vulnerabilities.
Reorganized the script's main execution logic into a `main` function for clearer entry point definition and better maintainability. Updated the project version to 0.1.1, reflecting these changes alongside minor fixes. Adjusted the script reference in `pyproject.toml` to align with the new entry point structure, ensuring proper package execution as a console script. This refactor enhances code readability and supports more flexible future updates.
- Added informative badges for versioning, Python versions, license, and the latest commit to enhance project visibility and credibility.
- Expanded documentation to include detailed installation, usage instructions, and added a comprehensive guide on configuring and running the bot, emphasizing the ease of set up and operation.
- Recommended the use of pantalaimon for E2E encryption support, catering to user security concerns.
- Included commands for adding, listing, and removing feeds, ensuring users have clear guidance on bot interaction.
This update makes the project more accessible and user-friendly, encouraging adoption and contribution by providing all necessary information upfront.
fix: ignore build directory in .gitignore
- The `build/` directory is now ignored, preventing compiled files or artifacts from being tracked in the repository, ensuring a cleaner project structure.
This commit adds error handling for feed processing errors in the RSS
bot's feed polling logic. The previous version was failing to handle
exceptions that were thrown during the feed parsing process, which could
lead to unpredictable behavior and potential data corruption. This new
version catches any exceptions that occur during the feed parsing step
and logs them, preventing the bot from becoming stuck in an infinite
loop due to these errors.
The changes include a try/except block around the feed parsing code,
where any exceptions are caught and logged using Python's logging
module. The bot's state is not modified when there is an error during
feed processing, which ensures that the bot does not become stuck in an
infinite loop due to errors. Additionally, the commit includes a new
logger method for logging exceptions, which helps identify any issues
with the feed parsing process and prevents them from affecting the bot's
overall performance.
This commit has several benefits:
* It improves the reliability of the RSS bot by handling errors that
could occur during feed processing and preventing the bot from becoming
stuck in an infinite loop due to these errors.
* It makes it easier for users to troubleshoot issues with the RSS bot,
since error messages are now being logged and can be easily identified.
* It helps to prevent data corruption by ensuring that the bot's state
is not modified when there is an error during feed processing.
This commit improves the handling of the feed list by removing
duplicate entries and ensuring that each feed is only listed once. This
change was made to improve the overall stability and performance of the
RSS bot, as well as to simplify the code and make it easier to maintain.
Additionally, this commit addresses a bug where the `listfeeds` command
would not work correctly if there were multiple feeds with the same URL.
This commit also includes an optimization that reduces the number of
network requests made by the RSS bot when fetching feed content. This
should improve the overall performance and reduce the load on servers
hosting RSS feeds.
support deleting feeds in the Matrix RSS Bot
This commit adds a new "removefeed" command to the Matrix RSS Bot,
which allows users to delete existing RSS feeds from the bot's list of
subscribed feeds. The "removefeed" command is added to the "__init__.py"
file in the "matrix_rssbot/classes/commands" directory.
This commit refactors the code handling bot state management to
improve readability and modularity. The new implementation uses a more
structured approach to handling different types of events, making it
easier to reason about and maintain. Additionally, it fixes an issue
where the bot was not properly handling errors when putting state in
rooms.
This change should improve the overall stability and performance of the
RSS bot, as well as make it easier for developers to understand and work
with the codebase.
Enhanced event processing in the bot's message retrieval logic to
improve message relevance and accuracy. Changes include accepting all
'gptbot' prefixed events, refining handling of 'ignoreolder' command
with exact match rather than starts with, and now passing through
'custom' commands that start with '!'. The default behavior now excludes
notices unless explicitly included. This update allows for more precise
command interactions and reduces clutter from irrelevant notices.
Standardize the passing of 'messages' argument across various calls to
generate_chat_response method to ensure consistency and prevent
potential bugs in the GPT bot's response generation. The 'model'
parameter in one instance has been corrected to 'original_model' for
proper context loading. These changes improve code clarity and maintain
the intended message flow within the bot's conversation handling.
Refactored initialization of OpenAI APIs to correct a redundancy and
enhance clarity. Improved content extraction logic for robust handling
of various message types. Enhanced logging and messaging by including
user and room context, facilitating better debugging and user
interaction. Extended `send_message` to support custom message types,
allowing for richer interaction within the chat ecosystem. Updated
hardcoded chat models to leverage newer versions for potentially more
accurate tool overrides. Fixed async method call in recursion handling
to ensure proper response generation. Finally, increased message history
retrieval limit based on the `max_messages` attribute for more effective
conversation context.
Resolves issues with message context and enhances user feedback during
operations.
Removed the '-dev' suffix from the project version indicating the transition from a development state to the official release of version 0.3.3. This version bump aligns with the completion of features and fixes slated for this iteration.
Update the README to specify that issues with file attachments primarily occur in non-encrypted rooms when the same user operates the bot in both encrypted and non-encrypted rooms. This detail aims to inform users of potential pitfalls more precisely when setting up the bot with end-to-end encryption enabled.
Improved the error handling in the OpenAI class to prevent infinite recursion issues by retaining the original chat model during recursive calls. Enhanced logging within the recursion depth check for better debugging and traceability. Ensured consistency in chat responses by passing the initial model reference throughout the entire call stack. This is crucial when fallbacks due to errors or tool usage occur.
Refactored code for clarity and readability, ensuring that any recursion retains the original model and tool parameters. Additionally, proper logging and condition checks now standardize the flow of execution, preventing unintended modifications to the model's state that could lead to incorrect bot behavior.
Introduced the ability to specify and retrieve different OpenAI models on a per-room basis, thereby allowing enhanced customization of the bot's response behavior according to the preferences for each room. Cleaned up code formatting across the bot implementation files for improved readability and maintainability. Additional logic now checks for model overrides when generating responses, ensuring the correct model is used as configured.
Refactors include streamlined database and API initializations and a refined method for processing message formatting to accommodate images, texts, and system messages consistently. This change differentiates default behavior from room-specific configurations, catering to diverse user needs without compromising on default settings.
Added a safety check to prevent infinite recursion within the response generation function. When `use_tools` is active, the code now inspects the call stack and terminates the process if a certain recursion depth is exceeded. This ensures that the code is robust against potential infinite loops that could block or crash the service. A default threshold is set with a TODO for revisiting the hard-coded limit, and the recursion detection logs the occurrence for easier debugging and maintenance.
Note: Recursion limit handling may require future adjustments to the `allow_override` parameter based on real-world feedback or testing.
Introduced a configuration option to emulate tool usage in models that do not natively support tools, facilitating the use of such functionality without direct model support. This should benefit users aiming to leverage tool-based features without relying on specific AI models. Additionally, enhanced error logging in the GPTBot class by including traceback details, aiding in debugging and incident resolution.
- Added `EmulateTools` option in the `config.dist.ini` for flexible tool handling.
- Enriched error logging with stack traces in `bot.py` for better insight during failures.
Introduced additional debug log entries in the `GPTBot` class to provide clarity on the initial sync and callback setup process. This helps with monitoring and troubleshooting during the early stages of bot deployment, making it easier to pinpoint issues around bot startup and room joining behavior.
Bumped project version to 0.3.3-dev to signal ongoing development.
Updated README to caution users about the current issues with end-to-end encryption, specifically that it can disrupt file uploads and downloads. The aim is to prevent user frustration and potential data loss until a fix is implemented.
Resolved an issue that prevented the bot from responding when files were uploaded to encrypted rooms by implementing a workaround. The bot now tries to generate text from uploaded files and logs errors without interrupting the message flow. Upgraded the Pantalaimon dependency to ensure compatibility. Also, refined the message processing logic to handle different message types correctly and made the download_file method asynchronous to match the matrix client's expected behavior. Additionally, updated the changelog and bumped the project version to reflect these fixes and improvements.
Known issues have been documented, including a limitation when using Pantalaimon where the bot cannot download/use files uploaded to encrypted rooms.
