Sample CodemacOSReviewed 2026-07-21View on Apple Developer

Creating Safari Web Inspector extensions

At a glance

Item Summary
Purpose Learn how to make custom Safari Web Inspector extensions.
App architecture A JavaScript, Swift sample with the source-visible chain AppDelegateViewControllerSafariWebExtensionHandlerSafariServices APIs.
Main patterns Delegate or data-source callbacks
Project style 6 scanned source file(s) across JavaScript, Swift, organized around ranked entry, type, and file boundaries.
Execution model Source-visible boundaries: DispatchQueue.main.async; none alone proves a background thread.
State/event model No structured observation or publisher-scheduling marker indexed.
Key frameworks/packages Cocoa, SafariServices, os, WebKit; these are source dependencies, not architecture labels.

Project structure

Source bundle/
├── Open Graph/
│   ├── macOS (App)/
│   │   ├── AppDelegate.swift
│   │   ├── Base.lproj/
│   │   │   └── Main.storyboard
│   │   └── Open Graph.entitlements
│   ├── Shared (App)/
│   │   ├── ViewController.swift
│   │   └── Resources/
│   │       └── Script.js
│   ├── Shared (Extension)/
│   │   ├── SafariWebExtensionHandler.swift
│   │   └── Resources/
│   │       ├── devtools_background.js
│   │       └── devtools_tab.js
│   ├── Open Graph.xcodeproj/
│   │   ├── .xcodesamplecode.plist
│   │   └── project.pbxproj
│   └── macOS (Extension)/
│       └── Info.plist
└── Configuration/
    └── SampleCode.xcconfig

Structure observations

  • Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
  • Primary languages: JavaScript, Swift.
  • The verified tree contains 7 project/configuration file(s) and 3 source declaration(s).

Overall architecture

Reference code

Open Graph/macOS (App)/AppDelegate.swift:10 — architecture anchor

@main
class AppDelegate: NSObject, NSApplicationDelegate {

    func applicationDidFinishLaunching(_ notification: Notification) {

    }

    func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool {
        return true
    }

}

Interpretation

The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into Safari Services.

Ownership and state

Ownership evidence

Open Graph/Shared (App)/ViewController.swift:18 — stored dependency or nearest verified ownership anchor

class ViewController: PlatformViewController, WKNavigationDelegate, WKScriptMessageHandler {
    // ...
    @IBOutlet var webView: WKWebView!
    // ...
}
Owner Object or state Relationship Mutation authority
ViewController WKWebView (webView) stores or receives App/module collaborators

Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.

Concurrency, scheduling, and thread safety

Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.

Concern Source mechanism Verified placement or handoff Evidence
Queue scheduling DispatchQueue.main.async The source addresses the main dispatch queue. Open Graph/Shared (App)/ViewController.swift:39

@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.

Reference code

Open Graph/Shared (App)/ViewController.swift:39 — representative execution boundary

            DispatchQueue.main.async {
                webView.evaluateJavaScript("show('mac', \(state.isEnabled))")
            }

State propagation, frameworks, and dependencies

Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.

Category Mechanism or module Verified role Evidence
Source import Cocoa The cited file imports this module; runtime use and architectural role are not inferred. Open Graph/Shared (App)/ViewController.swift:10
Source import SafariServices The cited file imports this module; runtime use and architectural role are not inferred. Open Graph/Shared (App)/ViewController.swift:11
Source import os The cited file imports this module; runtime use and architectural role are not inferred. Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift:9
Source import WebKit The cited file imports this module; runtime use and architectural role are not inferred. Open Graph/Shared (App)/ViewController.swift:8

receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.

Class and protocol design

Open Graph/macOS (App)/AppDelegate.swift:11 — representative type boundary

@main
class AppDelegate: NSObject, NSApplicationDelegate {
    // ...
        return true
    // ...
}
Type Responsibility Depends on or conforms to
AppDelegate Receives callback-driven events NSObject, NSApplicationDelegate
ViewController View lifecycle, callbacks, and feature coordination PlatformViewController, WKNavigationDelegate, WKScriptMessageHandler
SafariWebExtensionHandler Handles callbacks or feature events NSObject, NSExtensionRequestHandling

No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.

Access control

Symbol Access Verified effect Likely rationale
AppDelegate (Open Graph/macOS (App)/AppDelegate.swift:11) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.
ViewController (Open Graph/Shared (App)/ViewController.swift:16) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.
SafariWebExtensionHandler (Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift:13) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.

Reference code

Open Graph/macOS (App)/AppDelegate.swift:11 — representative boundary

@main
class AppDelegate: NSObject, NSApplicationDelegate {
    // ...
        return true
    // ...
}

Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.

Logic ownership and placement

Logic Owning type or file Placement rationale
View lifecycle, callbacks, and feature coordination ViewController The source’s Controller suffix makes this role explicit.
Receives callback-driven events AppDelegate The source’s Delegate suffix makes this role explicit.
Handles callbacks or feature events SafariWebExtensionHandler The source’s Handler suffix makes this role explicit.

Design patterns

Pattern Source evidence Purpose or tradeoff
Delegate or data-source callbacks Open Graph/Shared (App)/ViewController.swift:16 Callback protocols invert event delivery back into the sample’s owner.

Naming conventions

  • Types: Controller: ViewController; Delegate: AppDelegate; Handler: SafariWebExtensionHandler.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: applicationDidFinishLaunching, applicationShouldTerminateAfterLastWindowClosed, viewDidLoad, webView, userContentController, beginRequest, show, openPreferences.
  • Files: Open Graph/macOS (App)/AppDelegate.swift, Open Graph/Shared (App)/ViewController.swift, Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift.

Architecture takeaways

  • AppDelegate is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches Cocoa, SafariServices, WebKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
  • Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
  • Access-control conclusions separate verified language visibility from the likely design rationale.
  • The source does not justify labeling the design protocol-oriented.

Source map

Source file Relevant symbols
Open Graph/macOS (App)/AppDelegate.swift Cited implementation, AppDelegate
Open Graph/Shared (App)/ViewController.swift Cited implementation, ViewController, DispatchQueue.main.async, Cocoa, SafariServices, WebKit
Open Graph/Shared (Extension)/SafariWebExtensionHandler.swift SafariWebExtensionHandler, os
Open Graph/Shared (App)/Resources/Script.js Feature implementation
Open Graph/Shared (Extension)/Resources/devtools_background.js Feature implementation
Open Graph/Shared (Extension)/Resources/devtools_tab.js Feature implementation