fix: [Bug] Close the app when Opening (issue #8487)#8522
fix: [Bug] Close the app when Opening (issue #8487)#8522ipezygj wants to merge 13 commits intoAppFlowy-IO:mainfrom
Conversation
Reviewer's GuideImproves robustness of collab building and locking in Rust by handling spawn_blocking join errors and write-lock acquisition failures more gracefully, but also introduces unrelated AI-automation scaffolding, comments, and files that should likely be excluded from this bugfix PR. Sequence diagram for robust collab building with spawn_blockingsequenceDiagram
participant AppFlowyCollabBuilder as AppFlowyCollabBuilder
participant Tokio as TokioRuntime
participant Blocker as BlockingThread
participant CollabBuilder as CollabBuilder
participant Collab as Collab
participant Logger as Logger
AppFlowyCollabBuilder->>Tokio: spawn_blocking(closure)
Tokio-->>Blocker: run closure on blocking thread
Blocker->>CollabBuilder: new(object_uid, object_id, data_source)
CollabBuilder-->>Blocker: builder
Blocker->>CollabBuilder: with_device_id(device_id)
CollabBuilder-->>Blocker: builder
Blocker->>CollabBuilder: build()
CollabBuilder-->>Blocker: Result<Collab, Error>
Blocker->>Collab: add_plugin(db_plugin)
Blocker-->>Tokio: Ok(Result<Collab, Error>)
Tokio-->>AppFlowyCollabBuilder: JoinHandle result (collab_result)
alt join ok and build ok
AppFlowyCollabBuilder->>AppFlowyCollabBuilder: match collab_result
AppFlowyCollabBuilder-->>AppFlowyCollabBuilder: Ok(collab)
else join ok but build error
AppFlowyCollabBuilder->>AppFlowyCollabBuilder: match collab_result
AppFlowyCollabBuilder-->>AppFlowyCollabBuilder: Err(e)
else join error
AppFlowyCollabBuilder->>Logger: error(Failed to spawn blocking task...)
AppFlowyCollabBuilder-->>AppFlowyCollabBuilder: Err(anyhow!(task join error))
end
Sequence diagram for finalize write-lock acquisition with graceful failuresequenceDiagram
participant AppFlowyCollabBuilder as AppFlowyCollabBuilder
participant Collab as Collab
participant Logger as Logger
AppFlowyCollabBuilder->>Collab: try_write()
alt write lock acquired
Collab-->>AppFlowyCollabBuilder: Ok(write_guard)
AppFlowyCollabBuilder->>AppFlowyCollabBuilder: check has_cloud_plugin()
alt has_cloud_plugin
AppFlowyCollabBuilder->>AppFlowyCollabBuilder: drop(write_guard)
AppFlowyCollabBuilder-->>AppFlowyCollabBuilder: continue finalize with cloud plugin
else no cloud plugin
AppFlowyCollabBuilder-->>AppFlowyCollabBuilder: continue finalize without cloud plugin
end
else write lock error
Collab-->>AppFlowyCollabBuilder: Err(e)
AppFlowyCollabBuilder->>Logger: warn(Failed to acquire write lock...)
AppFlowyCollabBuilder-->>AppFlowyCollabBuilder: return Ok(collab) (unchanged)
end
Class diagram for updated AppFlowyCollabBuilder collab lifecycleclassDiagram
class AppFlowyCollabBuilder {
+build_collab() Result~Collab, Error~
+finalize(collab: ArcRwLockCollab) Result~ArcRwLockCollab, Error~
}
class CollabBuilder {
+new(uid: Uuid, object_id: String, data_source: DataSource) CollabBuilder
+with_device_id(device_id: String) CollabBuilder
+build() Result~Collab, Error~
}
class Collab {
+add_plugin(plugin: BoxPlugin)
+has_cloud_plugin() bool
}
class ArcRwLockCollab {
+try_write() Result~WriteGuard, LockError~
}
class WriteGuard {
+borrow() CollabRef
}
class CollabRef {
+has_cloud_plugin() bool
}
AppFlowyCollabBuilder ..> CollabBuilder : uses to build
AppFlowyCollabBuilder ..> ArcRwLockCollab : manages finalize
ArcRwLockCollab o--> Collab : wraps
WriteGuard o--> CollabRef : borrows
CollabRef ..> Collab : references
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 2 security issues, and left some high level feedback:
Security issues:
- Detected subprocess function 'check_output' without a static string. If this data can be controlled by a malicious actor, it may be an instance of command injection. Audit the use of this call to ensure it is not controllable by an external resource. You may consider using 'shlex.escape()'. (link)
- Found 'subprocess' function 'check_output' with 'shell=True'. This is dangerous because this call will spawn the command using a shell process. Doing so propagates current shell settings and variables, which makes it much easier for a malicious actor to execute commands. Use 'shell=False' instead. (link)
General comments:
- The new
gandalf_botti.pyautomation script and the emptyCONTRIBUTING.mdfile don’t appear related to the crash bug being fixed and should be removed from this PR to keep it focused on the runtime issue. - The added AI-related comments in various Rust test files and the extra blank lines in
README.mdintroduce noise without functional benefit; consider reverting those hunks to avoid cluttering the codebase. - In
finalize, swallowingtry_writeerrors by logging a warning and returningOk(collab)changes the locking semantics silently; it would be better either to propagate the error or handle it in a way that makes the degraded behavior explicit to callers.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new `gandalf_botti.py` automation script and the empty `CONTRIBUTING.md` file don’t appear related to the crash bug being fixed and should be removed from this PR to keep it focused on the runtime issue.
- The added AI-related comments in various Rust test files and the extra blank lines in `README.md` introduce noise without functional benefit; consider reverting those hunks to avoid cluttering the codebase.
- In `finalize`, swallowing `try_write` errors by logging a warning and returning `Ok(collab)` changes the locking semantics silently; it would be better either to propagate the error or handle it in a way that makes the degraded behavior explicit to callers.
## Individual Comments
### Comment 1
<location> `gandalf_botti.py:9` </location>
<code_context>
return subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT, env=env).decode('utf-8')
</code_context>
<issue_to_address>
**security (python.lang.security.audit.dangerous-subprocess-use-audit):** Detected subprocess function 'check_output' without a static string. If this data can be controlled by a malicious actor, it may be an instance of command injection. Audit the use of this call to ensure it is not controllable by an external resource. You may consider using 'shlex.escape()'.
*Source: opengrep*
</issue_to_address>
### Comment 2
<location> `gandalf_botti.py:9` </location>
<code_context>
return subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT, env=env).decode('utf-8')
</code_context>
<issue_to_address>
**security (python.lang.security.audit.subprocess-shell-true):** Found 'subprocess' function 'check_output' with 'shell=True'. This is dangerous because this call will spawn the command using a shell process. Doing so propagates current shell settings and variables, which makes it much easier for a malicious actor to execute commands. Use 'shell=False' instead.
```suggestion
return subprocess.check_output(cmd, shell=False, stderr=subprocess.STDOUT, env=env).decode('utf-8')
```
*Source: opengrep*
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| token = subprocess.getoutput("gh auth token").strip() | ||
| env["GITHUB_TOKEN"] = token | ||
| try: | ||
| return subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT, env=env).decode('utf-8') |
There was a problem hiding this comment.
security (python.lang.security.audit.dangerous-subprocess-use-audit): Detected subprocess function 'check_output' without a static string. If this data can be controlled by a malicious actor, it may be an instance of command injection. Audit the use of this call to ensure it is not controllable by an external resource. You may consider using 'shlex.escape()'.
Source: opengrep
| token = subprocess.getoutput("gh auth token").strip() | ||
| env["GITHUB_TOKEN"] = token | ||
| try: | ||
| return subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT, env=env).decode('utf-8') |
There was a problem hiding this comment.
security (python.lang.security.audit.subprocess-shell-true): Found 'subprocess' function 'check_output' with 'shell=True'. This is dangerous because this call will spawn the command using a shell process. Doing so propagates current shell settings and variables, which makes it much easier for a malicious actor to execute commands. Use 'shell=False' instead.
| return subprocess.check_output(cmd, shell=True, stderr=subprocess.STDOUT, env=env).decode('utf-8') | |
| return subprocess.check_output(cmd, shell=False, stderr=subprocess.STDOUT, env=env).decode('utf-8') |
Source: opengrep
|
ipezygj seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
🧙♂️ Gandalf AI (Claude 4.5 Opus) fix for #8487
Summary by Sourcery
Improve collaborative document initialization robustness and add an experimental automation script.
Bug Fixes:
Enhancements:
Chores: