Sample CodeiOS, iPadOS, Mac Catalyst, macOS, visionOSReviewed 2026-07-21View on Apple Developer

Building and testing a Safari web extension

At a glance

Item Summary
Purpose Get started with Safari web extensions by creating one from the ground up, using any code editor.
App architecture A JavaScript, Swift sample with the source-visible chain AppDelegateViewControllerSafariWebExtensionHandlerSafariServices APIs.
Main patterns View-controller organization, Delegate or data-source callbacks
Project style 22 scanned source file(s) across JavaScript, Swift, organized around ranked entry, type, and file boundaries.
Execution model Source-visible boundaries: DispatchQueue.main.async, Task, await suspension point; none alone proves a background thread.
State/event model No structured observation or publisher-scheduling marker indexed.
Key frameworks/packages UIKit, Cocoa, SafariServices, LocalAuthentication, os; these are source dependencies, not architecture labels.

Project structure

Source bundle/
└── ShinyOnTrack/
    ├── Xcode Project/
    │   ├── iOS (App)/
    │   │   ├── AppDelegate.swift
    │   │   └── SceneDelegate.swift
    │   ├── macOS (App)/
    │   │   └── AppDelegate.swift
    │   ├── Shared (App)/
    │   │   └── ViewController.swift
    │   └── Shared (Extension)/
    │       └── SafariWebExtensionHandler.swift
    └── Resources/
        ├── background.js
        ├── blocked.js
        ├── content.js
        ├── options.js
        └── utilities/
            ├── host.js
            ├── rules.js
            └── scripting.js

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 10 project/configuration file(s) and 5 source declaration(s).

Overall architecture

Reference code

ShinyOnTrack/Xcode Project/iOS (App)/AppDelegate.swift:10 — architecture anchor

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // The override point for customization after the app launches.
        return true
    }

    func application(
        _ application: UIApplication,
        configurationForConnecting connectingSceneSession: UISceneSession,
        options: UIScene.ConnectionOptions
    ) -> UISceneConfiguration {
        return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
    }

}

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

ShinyOnTrack/Xcode Project/iOS (App)/AppDelegate.swift:13 — stored dependency or nearest verified ownership anchor

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    // ...
    var window: UIWindow?
    // ...
}
Owner Object or state Relationship Mutation authority
AppDelegate UIWindow (window) stores or receives App/module collaborators
ViewController WKWebView (webView) stores or receives App/module collaborators
SceneDelegate UIWindow (window) 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. ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:51
Task creation Task The source creates an unstructured task; surrounding context determines inherited actor isolation. ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift:22
Suspension boundary await suspension point The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift:24

@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

ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:51 — representative execution boundary

#if os(iOS)
// ...
#elseif os(macOS)
            DispatchQueue.main.async {
              webView.evaluateJavaScript("show('mac', \(state.isEnabled))")
            }
#endif

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 UIKit The cited file imports this module; runtime use and architectural role are not inferred. ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:11
Source import Cocoa The cited file imports this module; runtime use and architectural role are not inferred. ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:14
Source import SafariServices The cited file imports this module; runtime use and architectural role are not inferred. ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:15
Source import LocalAuthentication The cited file imports this module; runtime use and architectural role are not inferred. ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift:8
Source import os The cited file imports this module; runtime use and architectural role are not inferred. ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift:10
Source import WebKit The cited file imports this module; runtime use and architectural role are not inferred. ShinyOnTrack/Xcode Project/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

ShinyOnTrack/Xcode Project/iOS (App)/AppDelegate.swift:11 — representative type boundary

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    // ...
    var window: UIWindow?
    // ...
}
Type Responsibility Depends on or conforms to
AppDelegate Receives callback-driven events UIResponder, UIApplicationDelegate
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
SceneDelegate Receives callback-driven events UIResponder, UIWindowSceneDelegate

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
reply (ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift:36) private Use is restricted to the lexical declaration and same-file extensions allowed by Swift. Inference: hide an implementation step that is not part of the collaboration surface.
AppDelegate (ShinyOnTrack/Xcode Project/macOS (App)/AppDelegate.swift:10) 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

ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift:36 — representative boundary

  private func reply(context: NSExtensionContext, success: Bool) {
    let response = NSExtensionItem()
    response.userInfo = [SFExtensionMessageKey: ["success": success]]
    context.completeRequest(returningItems: [response], completionHandler: nil)
  }

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, SceneDelegate 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
View-controller organization ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:21 A controller is the verified coordination boundary; this is MVC-style only where a separate model is present.
Delegate or data-source callbacks ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift:21 Callback protocols invert event delivery back into the sample’s owner.

Naming conventions

  • Types: Controller: ViewController; Delegate: AppDelegate, SceneDelegate; Handler: SafariWebExtensionHandler.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: application, applicationDidFinishLaunching, applicationShouldTerminateAfterLastWindowClosed, viewDidLoad, webView, userContentController, beginRequest, reply.
  • Files: ShinyOnTrack/Xcode Project/iOS (App)/AppDelegate.swift, ShinyOnTrack/Xcode Project/macOS (App)/AppDelegate.swift, ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift, ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift, ShinyOnTrack/Xcode Project/iOS (App)/SceneDelegate.swift.

Architecture takeaways

  • AppDelegate is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches UIKit, Cocoa, SafariServices, LocalAuthentication 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
ShinyOnTrack/Xcode Project/iOS (App)/AppDelegate.swift Cited implementation, AppDelegate
ShinyOnTrack/Xcode Project/Shared (Extension)/SafariWebExtensionHandler.swift Cited implementation, Task, await suspension point, LocalAuthentication, os, SafariWebExtensionHandler
ShinyOnTrack/Xcode Project/macOS (App)/AppDelegate.swift Cited implementation, AppDelegate
ShinyOnTrack/Xcode Project/Shared (App)/ViewController.swift ViewController, Cited implementation, DispatchQueue.main.async, UIKit, Cocoa, SafariServices, WebKit
ShinyOnTrack/Xcode Project/iOS (App)/SceneDelegate.swift SceneDelegate
ShinyOnTrack/Resources/background.js Feature implementation
ShinyOnTrack/Resources/blocked.js Feature implementation
ShinyOnTrack/Resources/content.js Feature implementation
ShinyOnTrack/Resources/options.js Feature implementation
ShinyOnTrack/Resources/utilities/host.js Feature implementation
ShinyOnTrack/Resources/utilities/rules.js Feature implementation
ShinyOnTrack/Resources/utilities/scripting.js Feature implementation
ShinyOnTrack/Resources/utilities/storage.js Feature implementation
ShinyOnTrack/Xcode Project/Shared (App)/Resources/Script.js Feature implementation
ShinyOnTrack/Xcode Project/Shared (Extension)/Resources/background.js Feature implementation
ShinyOnTrack/Xcode Project/Shared (Extension)/Resources/blocked.js Feature implementation