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.

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

fix: Move function definitions from headers to sources #55

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

sitaowang1998
Copy link
Collaborator

@sitaowang1998 sitaowang1998 commented Jan 15, 2025

Description

FunctionNameManager.cpp only includes one function that is not called inside a task library, and thus symbols are optimized out when building task library outside of project. Move some function definitions into source file solves this issue.
Fixes #54.

Validation performed

  • GitHub workflows pass
  • Unit tests pass in dev container
  • Integration pass in dev container
  • Quick start example works in dev container

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced singleton access methods for FunctionManager and FunctionNameManager
    • Added module-level function aliases for retrieving singleton instances
  • Refactor

    • Updated method signatures for singleton instance retrieval
    • Restructured singleton pattern implementation across multiple files

The changes enhance the accessibility and management of core system components with improved singleton access mechanisms.

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

This pull request modifies the FunctionManager and FunctionNameManager classes in the Spider project to implement a consistent singleton pattern. The changes involve adding a get_instance() method to both classes in their respective .cpp files and updating the method signatures in the header files. A BOOST_DLL_ALIAS is introduced for each class to enable external symbol access, specifically addressing the undefined symbol issue in the task library.

Changes

File Change Summary
src/spider/worker/FunctionManager.{hpp,cpp} Added get_instance() method as a singleton accessor with BOOST_DLL_ALIAS
src/spider/worker/FunctionNameManager.{hpp,cpp} Added get_instance() method as a singleton accessor with BOOST_DLL_ALIAS

Assessment against linked issues

Objective Addressed Explanation
Resolve undefined symbol function_name_manager_get_instance [#54]

Possibly related PRs

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/spider/worker/FunctionManager.cpp (1)

105-108: LGTM! Thread-safe singleton implementation.

The implementation follows Meyer's singleton pattern, ensuring thread-safe initialization.

Consider adding a comment explaining the singleton pattern usage and its thread-safety guarantee:

+// Thread-safe singleton implementation using Meyer's pattern.
+// C++11 guarantees that the initialization of function-local static objects is thread-safe.
 auto FunctionManager::get_instance() -> FunctionManager& {
     static FunctionManager instance;
     return instance;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2ef1a48 and a4bbfd9.

📒 Files selected for processing (4)
  • src/spider/worker/FunctionManager.cpp (1 hunks)
  • src/spider/worker/FunctionManager.hpp (1 hunks)
  • src/spider/worker/FunctionNameManager.cpp (1 hunks)
  • src/spider/worker/FunctionNameManager.hpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: non-storage-unit-tests (ubuntu-24.04)
  • GitHub Check: non-storage-unit-tests (ubuntu-22.04)
  • GitHub Check: lint
🔇 Additional comments (4)
src/spider/worker/FunctionNameManager.cpp (2)

10-13: LGTM! Thread-safe singleton implementation.

The implementation follows Meyer's singleton pattern, ensuring thread-safe initialization through static local variable (C++11 guarantee).


Line range hint 22-26: Verify singleton access patterns across the codebase.

The BOOST_DLL_ALIAS enables external access to the singleton. Let's verify its usage pattern.

✅ Verification successful

Singleton access patterns verified and found consistent

The singleton implementation follows best practices with clear separation between internal direct access and external DLL-based access through the BOOST_DLL_ALIAS.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for direct singleton access vs. alias usage
echo "Direct singleton access:"
rg -p "FunctionNameManager::get_instance" --type cpp

echo -e "\nAlias usage:"
rg -p "function_name_manager_get_instance" --type cpp

Length of output: 1033

src/spider/worker/FunctionNameManager.hpp (1)

33-33: LGTM! Singleton declaration.

The declaration properly matches the implementation in the source file.

src/spider/worker/FunctionManager.hpp (1)

346-346: LGTM! Singleton declaration.

The declaration properly matches the implementation in the source file.

@sitaowang1998 sitaowang1998 merged commit becbf55 into y-scope:main Jan 15, 2025
6 checks passed
@sitaowang1998 sitaowang1998 deleted the function_manager branch January 15, 2025 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Task library undefined symbol function_name_manager_get_instance crashes task executor
1 participant