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

Upgrade electron to v33 #2738

Merged
merged 1 commit into from
Dec 14, 2024
Merged

Upgrade electron to v33 #2738

merged 1 commit into from
Dec 14, 2024

Conversation

imolorhe
Copy link
Collaborator

@imolorhe imolorhe commented Dec 14, 2024

Fixes

Checks

  • Ran yarn test-build
  • Updated relevant documentations
  • Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Upgrade Electron to version 33.2.1 and update related dependencies. Add error logging for render and child process termination events in the Electron app. Refactor logging utility to include an error logging function.

New Features:

  • Add error logging for render and child process termination events in Electron app.

Enhancements:

  • Refactor logging utility to include an error logging function.

Copy link

sourcery-ai bot commented Dec 14, 2024

Reviewer's Guide by Sourcery

This PR upgrades Electron from v27 to v33.2.1 and includes related dependency updates and error handling improvements. The changes focus on better error logging for process crashes and CSP header handling.

Class diagram for updated logging in ElectronApp

classDiagram
    class ElectronApp {
        +ElectronApp()
        +initializeWindow()
        +handleOpenUrlEvent(url: string)
        +app.on('render-process-gone', event, webContents, details)
        +app.on('child-process-gone', event, details)
    }
    class WindowManager {
        +WindowManager()
        +registerProtocol()
        +instance.webContents.on('render-process-gone', e, details)
    }
    class LogUtils {
        +log(...args: unknown[])
        +error(...args: unknown[])
    }
    ElectronApp --> LogUtils
    WindowManager --> LogUtils
Loading

Class diagram for updated WindowManager

classDiagram
    class WindowManager {
        +WindowManager()
        +registerProtocol()
        +instance.webContents.on('render-process-gone', e, details)
        +validateAppSettings(data)
        +updateAltairSettingsOnFile(data)
    }
    class LogUtils {
        +log(...args: unknown[])
        +error(...args: unknown[])
    }
    WindowManager --> LogUtils
Loading

File-Level Changes

Change Details Files
Upgrade Electron to version 33.2.1
  • Update electron dependency from ^27.1.0 to ^33.2.1
  • Update related electron dependencies and lock file entries
packages/altair-electron/package.json
pnpm-lock.yaml
Enhance error handling and logging in electron app
  • Add error logging for render process crashes
  • Add error logging for child process crashes
  • Replace console.error with dedicated error logging function
  • Add new error utility function for consistent error logging
packages/altair-electron/src/app/window.ts
packages/altair-electron/src/app/index.ts
packages/altair-electron/src/utils/log.ts
Refactor CSP header handling logic
  • Improve resource type check using array includes
  • Clean up try-catch block with explicit comment
packages/altair-electron/src/app/window.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @imolorhe - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

Visit the preview URL for this PR (updated for commit db37370):

https://altair-gql--pr2738-imolorhe-upgrade-ele-30crf345.web.app

(expires Sat, 21 Dec 2024 23:18:07 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 02d6323d75a99e532a38922862e269d63351a6cf

@imolorhe imolorhe added this pull request to the merge queue Dec 14, 2024
Merged via the queue into master with commit c846579 Dec 14, 2024
15 checks passed
@imolorhe imolorhe deleted the imolorhe/upgrade-electron-v33-2 branch December 14, 2024 23:26
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.

1 participant